@parseapi/sdk 1.10.0 → 1.10.2

package/dist/offline.d.cts

@@ -0,0 +1,239 @@
+/**
+ * Response types for the ParseAPI public API.
+ * Core answers the common task; optional deep reveals the reviewed detail.
+ * Every field inside a deep object is optional and nullable: the API ships
+ * `deep: {}` when deep was requested but is not unlocked on the plan.
+ */
+/** The `deep` key is omitted unless the request asked for it. */
+type Deep<T> = Partial<{
+    [K in keyof T]: T[K] | null;
+}>;
+interface EmojiSkin {
+    emoji: string;
+    tone: string;
+    unicode: string | null;
+    hex: string | null;
+}
+interface Emoji {
+    emoji: string;
+    name: string;
+    shortcodes: string[];
+    category: string | null;
+    deep?: Deep<EmojiDeep>;
+}
+interface EmojiSearch {
+    q: string;
+    emojis: Emoji[];
+    total?: number;
+    next_offset?: number | null;
+}
+interface EmojiBrowse {
+    emojis: Emoji[];
+    total: number;
+    next_offset: number | null;
+}
+interface EmojiVariant {
+    emoji: string;
+    tones: string[];
+}
+interface EmojiArtwork {
+    svg?: string;
+    png?: Record<string, string>;
+    /** Only present when this asset has different rights from its provider. */
+    license?: string;
+    license_url?: string;
+    attribution?: string;
+}
+interface EmojiSource {
+    id: string;
+    version: string | null;
+    source_url: string;
+    license: string;
+    license_url: string;
+}
+interface EmojiNotice {
+    id: string;
+    license: string;
+    notice: string;
+}
+interface EmojiArtworkSource {
+    style: string;
+    version: string | null;
+    unicode_version: string | null;
+    source_url: string;
+    license: string;
+    license_url: string;
+    attribution: string;
+    notices: string[];
+    loaded_coverage?: {
+        svg: number;
+        png: number;
+    };
+    flag_license?: {
+        license: string;
+        license_url: string;
+        description: string;
+    };
+}
+interface EmojiMetadata {
+    edition: string;
+    max_version: string | null;
+    source_version: string;
+    total: number;
+    sources: EmojiSource[];
+    artwork_sources: EmojiArtworkSource[];
+    notices: EmojiNotice[];
+    completeness: {
+        missing_count: number;
+        unexpected_count: number;
+    };
+    shortcode_sources?: Record<string, EmojiShortcodeSourceMetadata>;
+    [field: string]: unknown;
+}
+interface EmojiCatalogScope {
+    filters: Record<string, string>;
+    total: number;
+    complete_inventory: boolean;
+}
+interface EmojiNativeSearchFacts {
+    name: string | null;
+    keywords: string[];
+    order?: number | null;
+}
+interface EmojiCatalogSearchFacts {
+    native: Record<string, EmojiNativeSearchFacts>;
+    localized_keywords?: string[];
+}
+interface EmojiCatalogData {
+    profile?: 'full' | 'compact';
+    scope?: Omit<EmojiCatalogScope, 'total'>;
+    search?: EmojiCatalogSearchFacts;
+    localization?: EmojiCatalogLocalization;
+    metadata: EmojiMetadata;
+    total: number;
+    emojis: Emoji[];
+    forms: Record<string, string>;
+    shortcodes: Record<'cldr' | 'github' | 'slack' | 'discord', Record<string, string[]>>;
+    legacy: Record<string, string>;
+}
+interface EmojiCatalogLocalization {
+    requested_locale: string | null;
+    resolved_locale: string | null;
+    translated_names: number;
+    translated_keywords: number;
+    fallback_names: number;
+    fallback_keywords: number;
+}
+interface EmojiShortcodeSourceMetadata {
+    records: number;
+    missing_records: number;
+    ambiguous_aliases: number;
+}
+interface EmojiCategory {
+    category: string;
+    subcategories: string[];
+}
+interface EmojiCategories {
+    categories: EmojiCategory[];
+}
+/** UTF-16 code-unit positions. End is exclusive. */
+interface EmojiPosition {
+    start: number;
+    end: number;
+}
+/** Original input UTF-16 positions; end is exclusive. */
+interface EmojiUnresolved extends EmojiPosition {
+    emoji?: string;
+    shortcode?: string;
+    reason: 'unknown' | 'ambiguous' | 'unavailable';
+}
+interface EmojiDeep {
+    subcategory?: string | null;
+    base?: string | null;
+    variants?: EmojiVariant[];
+    codepoints: string[];
+    hex: string;
+    status: string | null;
+    version: string | null;
+    keywords: string[];
+    skins: EmojiSkin[];
+    artwork?: Record<string, EmojiArtwork>;
+}
+interface EmojiParse {
+    emojis: (Emoji & {
+        positions: EmojiPosition[];
+    })[];
+}
+interface EmojiConversion {
+    text: string;
+    unresolved: EmojiUnresolved[];
+}
+
+interface EmojiCatalogLookupOptions {
+    deep?: boolean;
+    shortcodeSource?: string;
+}
+interface EmojiCatalogSearchOptions {
+    deep?: boolean;
+    limit?: number;
+    offset?: number;
+    category?: string;
+    subcategory?: string;
+    version?: string;
+    maxVersion?: string;
+    includeSkinTones?: boolean;
+}
+interface EmojiCatalogParseOptions {
+    deep?: boolean;
+}
+interface EmojiCatalogConvertOptions {
+    direction: 'to_shortcodes' | 'to_emoji';
+    shortcodeSource: 'cldr' | 'github' | 'slack' | 'discord';
+}
+interface EmojiCatalogRegexOptions {
+    qualifiedOnly?: boolean;
+    components?: boolean;
+}
+/** A local validation or resolution failure. No HTTP request was made. */
+declare class EmojiCatalogError extends Error {
+    readonly code: 'validation_error' | 'not_found' | 'invalid_catalog';
+    constructor(code: 'validation_error' | 'not_found' | 'invalid_catalog', message: string);
+}
+/** Immutable local snapshot. All operations are synchronous and use no network. */
+declare class EmojiCatalog {
+    private readonly data;
+    private readonly byGlyph;
+    private readonly names;
+    private readonly aliases;
+    private readonly sourceAliases;
+    private readonly encodings;
+    private readonly searchFacts;
+    private readonly categoryKeys;
+    private readonly subcategoryKeys;
+    private readonly filterCache;
+    private searchReady;
+    private readonly compareNames;
+    private segmenter?;
+    constructor(data: EmojiCatalogData);
+    /** Build once on first search; shared normalized strings avoid repeated annotation copies. */
+    private ensureSearch;
+    private encoding;
+    /** Evidence for the full server inventory; scope() identifies this downloaded subset. */
+    metadata(): EmojiMetadata;
+    /** Filters, local record count and whether this download contains the full server inventory. */
+    scope(): EmojiCatalogScope;
+    lookup(input: string, options?: EmojiCatalogLookupOptions): Emoji;
+    search(query: string, options?: EmojiCatalogSearchOptions): EmojiSearch;
+    browse(options?: EmojiCatalogSearchOptions): EmojiBrowse;
+    /** Unknown and ambiguous inputs remain literal; positions refer to untouched input. */
+    convert(text: string, options: EmojiCatalogConvertOptions): EmojiConversion;
+    /** Whole-grapheme predicate. Use parse() to extract emoji from prose with positions. */
+    regex(options?: EmojiCatalogRegexOptions): RegExp;
+    categories(): EmojiCategories;
+    parse(text: string, options?: EmojiCatalogParseOptions): EmojiParse;
+    private project;
+    private page;
+    private filtered;
+}
+
+export { type Emoji, type EmojiBrowse, EmojiCatalog, type EmojiCatalogConvertOptions, type EmojiCatalogData, EmojiCatalogError, type EmojiCatalogLookupOptions, type EmojiCatalogParseOptions, type EmojiCatalogRegexOptions, type EmojiCatalogScope, type EmojiCatalogSearchOptions, type EmojiConversion, type EmojiDeep, type EmojiMetadata, type EmojiParse, type EmojiSearch };

package/dist/offline.d.ts

@@ -0,0 +1,239 @@
+/**
+ * Response types for the ParseAPI public API.
+ * Core answers the common task; optional deep reveals the reviewed detail.
+ * Every field inside a deep object is optional and nullable: the API ships
+ * `deep: {}` when deep was requested but is not unlocked on the plan.
+ */
+/** The `deep` key is omitted unless the request asked for it. */
+type Deep<T> = Partial<{
+    [K in keyof T]: T[K] | null;
+}>;
+interface EmojiSkin {
+    emoji: string;
+    tone: string;
+    unicode: string | null;
+    hex: string | null;
+}
+interface Emoji {
+    emoji: string;
+    name: string;
+    shortcodes: string[];
+    category: string | null;
+    deep?: Deep<EmojiDeep>;
+}
+interface EmojiSearch {
+    q: string;
+    emojis: Emoji[];
+    total?: number;
+    next_offset?: number | null;
+}
+interface EmojiBrowse {
+    emojis: Emoji[];
+    total: number;
+    next_offset: number | null;
+}
+interface EmojiVariant {
+    emoji: string;
+    tones: string[];
+}
+interface EmojiArtwork {
+    svg?: string;
+    png?: Record<string, string>;
+    /** Only present when this asset has different rights from its provider. */
+    license?: string;
+    license_url?: string;
+    attribution?: string;
+}
+interface EmojiSource {
+    id: string;
+    version: string | null;
+    source_url: string;
+    license: string;
+    license_url: string;
+}
+interface EmojiNotice {
+    id: string;
+    license: string;
+    notice: string;
+}
+interface EmojiArtworkSource {
+    style: string;
+    version: string | null;
+    unicode_version: string | null;
+    source_url: string;
+    license: string;
+    license_url: string;
+    attribution: string;
+    notices: string[];
+    loaded_coverage?: {
+        svg: number;
+        png: number;
+    };
+    flag_license?: {
+        license: string;
+        license_url: string;
+        description: string;
+    };
+}
+interface EmojiMetadata {
+    edition: string;
+    max_version: string | null;
+    source_version: string;
+    total: number;
+    sources: EmojiSource[];
+    artwork_sources: EmojiArtworkSource[];
+    notices: EmojiNotice[];
+    completeness: {
+        missing_count: number;
+        unexpected_count: number;
+    };
+    shortcode_sources?: Record<string, EmojiShortcodeSourceMetadata>;
+    [field: string]: unknown;
+}
+interface EmojiCatalogScope {
+    filters: Record<string, string>;
+    total: number;
+    complete_inventory: boolean;
+}
+interface EmojiNativeSearchFacts {
+    name: string | null;
+    keywords: string[];
+    order?: number | null;
+}
+interface EmojiCatalogSearchFacts {
+    native: Record<string, EmojiNativeSearchFacts>;
+    localized_keywords?: string[];
+}
+interface EmojiCatalogData {
+    profile?: 'full' | 'compact';
+    scope?: Omit<EmojiCatalogScope, 'total'>;
+    search?: EmojiCatalogSearchFacts;
+    localization?: EmojiCatalogLocalization;
+    metadata: EmojiMetadata;
+    total: number;
+    emojis: Emoji[];
+    forms: Record<string, string>;
+    shortcodes: Record<'cldr' | 'github' | 'slack' | 'discord', Record<string, string[]>>;
+    legacy: Record<string, string>;
+}
+interface EmojiCatalogLocalization {
+    requested_locale: string | null;
+    resolved_locale: string | null;
+    translated_names: number;
+    translated_keywords: number;
+    fallback_names: number;
+    fallback_keywords: number;
+}
+interface EmojiShortcodeSourceMetadata {
+    records: number;
+    missing_records: number;
+    ambiguous_aliases: number;
+}
+interface EmojiCategory {
+    category: string;
+    subcategories: string[];
+}
+interface EmojiCategories {
+    categories: EmojiCategory[];
+}
+/** UTF-16 code-unit positions. End is exclusive. */
+interface EmojiPosition {
+    start: number;
+    end: number;
+}
+/** Original input UTF-16 positions; end is exclusive. */
+interface EmojiUnresolved extends EmojiPosition {
+    emoji?: string;
+    shortcode?: string;
+    reason: 'unknown' | 'ambiguous' | 'unavailable';
+}
+interface EmojiDeep {
+    subcategory?: string | null;
+    base?: string | null;
+    variants?: EmojiVariant[];
+    codepoints: string[];
+    hex: string;
+    status: string | null;
+    version: string | null;
+    keywords: string[];
+    skins: EmojiSkin[];
+    artwork?: Record<string, EmojiArtwork>;
+}
+interface EmojiParse {
+    emojis: (Emoji & {
+        positions: EmojiPosition[];
+    })[];
+}
+interface EmojiConversion {
+    text: string;
+    unresolved: EmojiUnresolved[];
+}
+
+interface EmojiCatalogLookupOptions {
+    deep?: boolean;
+    shortcodeSource?: string;
+}
+interface EmojiCatalogSearchOptions {
+    deep?: boolean;
+    limit?: number;
+    offset?: number;
+    category?: string;
+    subcategory?: string;
+    version?: string;
+    maxVersion?: string;
+    includeSkinTones?: boolean;
+}
+interface EmojiCatalogParseOptions {
+    deep?: boolean;
+}
+interface EmojiCatalogConvertOptions {
+    direction: 'to_shortcodes' | 'to_emoji';
+    shortcodeSource: 'cldr' | 'github' | 'slack' | 'discord';
+}
+interface EmojiCatalogRegexOptions {
+    qualifiedOnly?: boolean;
+    components?: boolean;
+}
+/** A local validation or resolution failure. No HTTP request was made. */
+declare class EmojiCatalogError extends Error {
+    readonly code: 'validation_error' | 'not_found' | 'invalid_catalog';
+    constructor(code: 'validation_error' | 'not_found' | 'invalid_catalog', message: string);
+}
+/** Immutable local snapshot. All operations are synchronous and use no network. */
+declare class EmojiCatalog {
+    private readonly data;
+    private readonly byGlyph;
+    private readonly names;
+    private readonly aliases;
+    private readonly sourceAliases;
+    private readonly encodings;
+    private readonly searchFacts;
+    private readonly categoryKeys;
+    private readonly subcategoryKeys;
+    private readonly filterCache;
+    private searchReady;
+    private readonly compareNames;
+    private segmenter?;
+    constructor(data: EmojiCatalogData);
+    /** Build once on first search; shared normalized strings avoid repeated annotation copies. */
+    private ensureSearch;
+    private encoding;
+    /** Evidence for the full server inventory; scope() identifies this downloaded subset. */
+    metadata(): EmojiMetadata;
+    /** Filters, local record count and whether this download contains the full server inventory. */
+    scope(): EmojiCatalogScope;
+    lookup(input: string, options?: EmojiCatalogLookupOptions): Emoji;
+    search(query: string, options?: EmojiCatalogSearchOptions): EmojiSearch;
+    browse(options?: EmojiCatalogSearchOptions): EmojiBrowse;
+    /** Unknown and ambiguous inputs remain literal; positions refer to untouched input. */
+    convert(text: string, options: EmojiCatalogConvertOptions): EmojiConversion;
+    /** Whole-grapheme predicate. Use parse() to extract emoji from prose with positions. */
+    regex(options?: EmojiCatalogRegexOptions): RegExp;
+    categories(): EmojiCategories;
+    parse(text: string, options?: EmojiCatalogParseOptions): EmojiParse;
+    private project;
+    private page;
+    private filtered;
+}
+
+export { type Emoji, type EmojiBrowse, EmojiCatalog, type EmojiCatalogConvertOptions, type EmojiCatalogData, EmojiCatalogError, type EmojiCatalogLookupOptions, type EmojiCatalogParseOptions, type EmojiCatalogRegexOptions, type EmojiCatalogScope, type EmojiCatalogSearchOptions, type EmojiConversion, type EmojiDeep, type EmojiMetadata, type EmojiParse, type EmojiSearch };