@sorisdk/matcher 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,145 @@
+declare enum AudioFingerprintType {
+    Livestream = 1,
+    ArchiveCf = 2,
+    ArchivePg = 4
+}
+interface MatchConfig {
+    maxResults?: number;
+    scoreThreshold?: number;
+    gapThreshold?: number;
+}
+interface MatchResult {
+    name: string;
+    score: number;
+    position: number;
+    afpType: AudioFingerprintType;
+}
+type PackSource = Uint8Array | ArrayBuffer | Blob | Response | Request | string | URL;
+type MatcherSessionEventMap = {
+    ready: {
+        createdAt: number;
+    };
+    packloadstart: {
+        sourceType: string;
+    };
+    packload: {
+        sourceType: string;
+        byteLength: number;
+    };
+    querystart: {
+        queryByteLength: number;
+    };
+    match: {
+        results: MatchResult[];
+        best: MatchResult | null;
+    };
+    nomatch: {
+        queryByteLength: number;
+    };
+    error: {
+        phase: string;
+        error: Error;
+    };
+    destroy: {
+        destroyedAt: number;
+    };
+};
+type MatcherSessionEventName = keyof MatcherSessionEventMap;
+type MatcherSessionListener<T extends MatcherSessionEventName> = (payload: MatcherSessionEventMap[T]) => void;
+
+type FetchLike = (input: string | URL | Request, init?: RequestInit) => Promise<Response>;
+
+interface MatcherEphemeralKeyExchangeOptions {
+    endpoint: string | URL;
+    fetch?: FetchLike;
+}
+interface MatcherEphemeralAuthOptions {
+    endpoint: string | URL;
+    appId: string;
+    ephemeralKey?: string;
+    secretKey?: string;
+    exchange?: MatcherEphemeralKeyExchangeOptions;
+    sessionId: string;
+    version: string;
+    fetch?: FetchLike;
+}
+interface MatcherExchangeResponsePayload {
+    ephemeral_key?: unknown;
+    ephemeralKey?: unknown;
+    secret_key?: unknown;
+    secretKey?: unknown;
+    expires_at?: unknown;
+    expiresAt?: unknown;
+    ttl_seconds?: unknown;
+    ttlSeconds?: unknown;
+}
+interface MatcherAuthResponsePayload {
+    success?: boolean;
+    token?: unknown;
+    token_expires_at?: unknown;
+    tokenExpiresAt?: unknown;
+    updated?: unknown;
+    url?: unknown;
+    force_update?: unknown;
+}
+interface MatcherEphemeralAuthResult {
+    token: string;
+    tokenExpiresAt: string | null;
+    packUrl: string | null;
+    updated: number;
+    forceUpdate: boolean;
+    exchange: MatcherEphemeralKeyExchangeMetadata | null;
+    raw: MatcherAuthResponsePayload;
+}
+interface MatcherEphemeralKeyExchangeMetadata {
+    expiresAt: string | null;
+    ttlSeconds: number | null;
+    raw: MatcherExchangeResponsePayload;
+}
+
+interface InitMatcherOptions {
+    loader?: () => Promise<unknown>;
+    wasmModule?: unknown;
+    wasmInitInput?: unknown;
+    auth?: MatcherEphemeralAuthOptions;
+}
+interface MatcherSessionOptions extends InitMatcherOptions {
+    fetch?: FetchLike;
+}
+type InitMatcherResult = MatcherEphemeralAuthResult;
+declare function initMatcher(options?: InitMatcherOptions): Promise<InitMatcherResult | void>;
+declare class MatcherSession {
+    private readonly events;
+    private readonly fetcher?;
+    private readonly initOptions;
+    private readyPromise;
+    private bindings;
+    private database;
+    private matcher;
+    private destroyed;
+    private readonly distinctMatchDeduper;
+    constructor(options?: MatcherSessionOptions);
+    on<T extends MatcherSessionEventName>(eventName: T, listener: MatcherSessionListener<T>): this;
+    off<T extends MatcherSessionEventName>(eventName: T, listener: MatcherSessionListener<T>): this;
+    once<T extends MatcherSessionEventName>(eventName: T, listener: MatcherSessionListener<T>): this;
+    ready(): Promise<void>;
+    loadPack(source: PackSource): Promise<void>;
+    addEntry(name: string, afpType: AudioFingerprintType, fingerprint: Uint8Array): Promise<void>;
+    addOrReplace(name: string, afpType: AudioFingerprintType, fingerprint: Uint8Array): Promise<void>;
+    removeEntry(name: string): Promise<void>;
+    clear(): Promise<void>;
+    match(query: Uint8Array, config?: MatchConfig): Promise<MatchResult[]>;
+    bestMatch(query: Uint8Array, config?: MatchConfig): Promise<MatchResult | null>;
+    destroy(): void;
+    private bootstrap;
+    private ensureLiveReady;
+    private ensureNotDestroyed;
+    private matcherOrThrow;
+    private databaseOrThrow;
+    private emitDistinctMatchEvent;
+}
+declare function __setMatcherWasmModuleForTests(moduleLike: unknown): void;
+declare function __setMatcherEmbeddedPackForTests(bytes: Uint8Array): void;
+declare function __resetMatcherWasmForTests(): void;
+
+export { AudioFingerprintType, type InitMatcherOptions, type InitMatcherResult, type MatchConfig, type MatchResult, type MatcherEphemeralAuthOptions, type MatcherEphemeralAuthResult, type MatcherEphemeralKeyExchangeMetadata, type MatcherEphemeralKeyExchangeOptions, MatcherSession, type MatcherSessionEventMap, type MatcherSessionEventName, type MatcherSessionListener, type MatcherSessionOptions, type PackSource, __resetMatcherWasmForTests, __setMatcherEmbeddedPackForTests, __setMatcherWasmModuleForTests, initMatcher };