svelte-tenor/raw-api.d.ts

Tenor GIF components, implemented in Svelte.

/**
 * A direct implementation of Tenor's API.
 *
 * @module
 */
export interface GifObject<Formats extends string = GifFormat> {
    /** Tenor result identifier. */
    id: string;
    /** The title of the post. */
    title: string;
    /** **Not documented**. Description of the GIF content. */
    content_description: string;
    /** An array of tags for the post. */
    tags: string[];
    /** The full URL to view the post on tenor.com. */
    itemurl: string;
    /** A short URL to view the post on tenor.com. */
    url: string;
    /** A unix timestamp representing when this post was created. */
    created: number;
    /**
     * True if this post contains audio (only video formats support audio, the gif
     * image file format can not contain audio information).
     */
    hasaudio: boolean;
    /** True if this post contains captions. */
    hascaption: boolean;
    /**
     * An array of dictionaries with {@link GifFormat} as the key and
     * {@link MediaObject} as the value.
     *
     * @remarks
     *   It looks like the array only contains one element.
     */
    media: {
        0: Record<Formats, MediaObject>;
    };
}
export interface MediaObject {
    /** A url to a preview image of the media source. */
    preview: string;
    /** A url to the media source. */
    url: string;
    /** Width and height in pixels. */
    dims: [number, number];
    /** Size of file in bytes. */
    size: number;
}
export declare type GifFormat = 'gif' | 'mediumgif' | 'tinygif' | 'nanogif' | 'mp4' | 'loopedmp4' | 'tinymp4' | 'nanomp4' | 'webm' | 'tinywebm' | 'nanowebm';
export interface ApiError {
    /** An optional numeric code. */
    code: number;
    /** A string message describing the error. */
    error: string;
}
export interface CommonOptions {
    /** Client key. You may use `LIVDSRZULELA` for testing. */
    key: string;
    /**
     * Default language to interpret search string.
     *
     * @default `en_US`
     */
    locale?: string;
    /**
     * Specify the content safety filter level. Possible values:
     *
     * - **High** - G
     * - **Medium** - G and PG
     * - **Low** - G, PG, and PG-13
     * - **Off** - G, PG, PG-13, and R (no nudity)
     *
     * @default `off`
     * @see https://tenor.com/gifapi/documentation#contentfilter
     */
    contentfilter?: 'off' | 'low' | 'medium' | 'high';
    /**
     * Filter the response GIF_OBJECT list to only include GIFs with aspect ratios
     * that fit with in the selected range.
     *
     * - **All** - no constraints
     * - **Wide** - 0.42 <= aspect ratio <= 2.36
     * - **Standard** - 0.56 <= aspect ratio <= 1.78
     *
     * @default `all`
     */
    ar_range?: 'all' | 'wide' | 'standard';
    /**
     * Fetch up to a specified number of results (max: 50).
     *
     * @default 20
     */
    limit?: number;
    /**
     * GGt results starting at position "value". Use a non-zero "next" value
     * returned by API results to get the next set of results.
     */
    pos?: string;
    /** Specify the anonymous_id tied to the given user. */
    anon_id?: string;
}
export interface CommonSearchOptions extends CommonOptions {
    /** Search string. */
    q: string;
}
export interface CommonResults<Formats extends string = GifFormat> {
    next: string;
    results: Array<GifObject<Formats>>;
}
export declare type MinimalResults = CommonResults<'gif' | 'tinygif' | 'mp4'>;
export declare type BasicResults = CommonResults<'gif' | 'tinygif' | 'nanogif' | 'mp4' | 'tinymp4' | 'nanomp4'>;
/** Creates an endpoint. */
export declare const endpoint: <Input, Output>(name: string) => (options: Input) => Promise<Output>;
/** All endpoints, untyped. */
export declare const endpoints: {
    gifs: (options: unknown) => Promise<unknown>;
    search: (options: unknown) => Promise<unknown>;
    trending: (options: unknown) => Promise<unknown>;
    random: (options: unknown) => Promise<unknown>;
    searchSuggestions: (options: unknown) => Promise<unknown>;
    autocomplete: (options: unknown) => Promise<unknown>;
    trendingTerms: (options: unknown) => Promise<unknown>;
    categories: (options: unknown) => Promise<unknown>;
    registerShare: (options: unknown) => Promise<unknown>;
    anonid: (options: unknown) => Promise<unknown>;
};
/** Searches for GIFs. */
export declare function search(options: CommonSearchOptions): Promise<CommonResults>;
export declare function search(options: CommonSearchOptions & {
    /** Reduces the list of GIFs returned to tinygif, gif, and mp4. */
    media_filter: 'minimal';
}): Promise<MinimalResults>;
export declare function search(options: CommonSearchOptions & {
    /**
     * Reduces the list of GIFs returned to nanomp4, tinygif, tinymp4, gif, mp4,
     * and nanogif.
     */
    media_filter: 'basic';
}): Promise<BasicResults>;
/** Gets the current global trending GIFs. */
export declare function trending(options: CommonOptions): Promise<CommonResults>;
export declare function trending(options: CommonOptions & {
    /** Reduces the list of GIFs returned to tinygif, gif, and mp4. */
    media_filter: 'minimal';
}): Promise<MinimalResults>;
export declare function trending(options: CommonOptions & {
    /**
     * Reduces the list of GIFs returned to nanomp4, tinygif, tinymp4, gif, mp4,
     * and nanogif.
     */
    media_filter: 'basic';
}): Promise<BasicResults>;
/** Gets a list of GIF categories. */
export declare function categories(options: {
    key: string;
    locale?: string;
    type?: 'featured' | 'trending';
    contentfilter?: 'off' | 'low' | 'medium' | 'high';
    anon_id?: string;
}): Promise<{
    tags: Array<{
        /** The search term that corresponds to the category. */
        searchterm: string;
        /** The search url to request if the user selects the category. */
        path: string;
        /** A url to the media source for the category's example GIF. */
        image: string;
        /**
         * Category name to overlay over the image. The name will be translated to
         * match the locale of the corresponding request.
         */
        name: string;
    }>;
}>;
export declare function categories(options: {
    key: string;
    locale?: string;
    type: 'emoji';
    contentfilter?: 'off' | 'low' | 'medium' | 'high';
    anon_id?: string;
}): Promise<{
    tags: Array<{
        /** The search term that corresponds to the category. */
        searchterm: string;
        /** The search url to request if the user selects the category. */
        path: string;
        /**
         * Category name to overlay over the image. The name will be translated to
         * match the locale of the corresponding request.
         */
        name: string;
        /** Emoji. */
        character: string;
    }>;
}>;
/** Gets related search terms to find a more precise GIF. */
export declare function searchSuggestions(options: {
    key: string;
    q: string;
    locale?: string;
    limit?: number;
    anon_id?: string;
}): Promise<{
    results: string[];
}>;
/** Gets a list of completed search terms given a partial search term. */
export declare function autocomplete(options: {
    key: string;
    q: string;
    locale?: string;
    limit?: number;
    anon_id?: string;
}): Promise<{
    results: string[];
}>;
/** Gets current trending search terms. */
export declare function trendingTerms(options: {
    key: string;
    locale?: string;
    limit?: number;
    anon_id?: string;
}): Promise<{
    results: string[];
}>;
/** Registers a user’s sharing of a GIF. */
export declare function registerShare(options: {
    key: string;
    id: string;
    locale?: string;
    q?: string;
    anon_id?: string;
}): Promise<{
    status: 'ok';
}>;
export declare type GifDetailsOptions = {
    /** Comma separated list of GIF identifiers. */
    ids: string;
    key: string;
    limit?: number;
    pos?: string;
    anon_id?: string;
};
/** Gets details about the GIFs given. */
export declare function gifs(options: GifDetailsOptions): Promise<CommonResults>;
export declare function gifs(options: GifDetailsOptions & {
    media_filter: 'basic';
}): Promise<BasicResults>;
export declare function gifs(options: GifDetailsOptions & {
    media_filter: 'minimal';
}): Promise<MinimalResults>;
/** Searches for GIFs, but does not rank them by popularity. */
export declare function random(options: CommonSearchOptions): Promise<CommonResults>;
export declare function random(options: CommonSearchOptions & {
    /** Reduces the list of GIFs returned to tinygif, gif, and mp4. */
    media_filter: 'minimal';
}): Promise<MinimalResults>;
export declare function random(options: CommonSearchOptions & {
    /**
     * Reduces the list of GIFs returned to nanomp4, tinygif, tinymp4, gif, mp4,
     * and nanogif.
     */
    media_filter: 'basic';
}): Promise<BasicResults>;
/**
 * Creates an anonymous id.
 *
 * @remarks
 *   This API requires custom development from Tenor.
 */
export declare function anonId(options: {
    key: string;
}): Promise<{
    anon_id: string;
}>;