@usethrottle/catalog 0.1.1 → 1.1.0

package/dist/admin.d.cts

@@ -0,0 +1,660 @@
+export { C as CartLineError, a as CartLineProblem, b as CatalogError, c as CatalogErrorCode, d as CatalogErrorInit, e as CatalogErrorIssue, f as CatalogErrorSource, g as ClientErrorCode, h as CustomerTokenInvalidError, F as FeatureUnavailableError, N as NetworkError, O as OriginNotAllowedError, R as RateLimitedError, T as TimeoutError, i as isCatalogError } from './catalog-error-s1BINNkt.cjs';
+import './contract-types-DhiThMEr.cjs';
+
+type JobBatchAnswer = {
+    batchId: string;
+    sequence: number;
+    rowsAccepted: number;
+    rowsRefused: number;
+    issues: {
+        index: number;
+        code: 'INVALID_ROW' | 'INVALID_VALUE' | 'MISSING_SKU' | 'MISSING_PRODUCT_HANDLE' | 'UNKNOWN_SKU' | 'INVALID_GTIN_DROPPED' | 'DUPLICATE_SKU_REPLACED' | 'SCATTERED_PRODUCT_ROWS' | 'CONFLICTING_PRODUCT_VALUE' | 'PRODUCT_SPLIT_ACROSS_CHUNKS' | 'TOO_MANY_OPTIONS' | 'TOO_MANY_VARIANTS' | 'CATEGORY_TOO_DEEP' | 'INVALID_STATUS' | 'IMAGE_COPY_FAILED' | 'IMAGE_ONLY_ROW' | 'INVALID_CURRENCY' | 'PRICE_LIST_BASE_CURRENCY' | 'LIST_SALE_WITHOUT_PRICE' | 'LOCALE_NOT_ENABLED' | 'GROUP_NOT_FOUND' | 'GROUP_KIND_MISMATCH' | 'TRANSLATION_TOO_LONG' | 'TRANSLATION_CONFLICT' | 'UNKNOWN_PRODUCT_HANDLE' | 'INVALID_RATING' | 'REVIEW_DATE_IN_FUTURE' | 'REVIEW_TEXT_INVALID' | 'DUPLICATE_REVIEW' | 'REVIEW_ROW_LIMIT' | 'EXTERNAL_ID_REQUIRED' | 'SKU_CONFLICT' | 'FIELD_NOT_ALLOWED' | 'ATTRIBUTE_UNKNOWN' | 'HANDLE_TAKEN' | 'MERCHANT_HOLD' | 'QUANTITY_BELOW_ZERO' | 'QUANTITY_OUT_OF_RANGE' | 'STOCK_MODE_CONFLICT' | 'DUPLICATE_SKU_IN_BATCH' | 'QUANTITY_MODE_WITHOUT_QUANTITY';
+    }[];
+};
+type JobBatchRequest = {
+    rows: ((PushRow) | ({
+        [key: string]: JsonValue;
+    }))[];
+};
+type JsonValue = (string) | (number) | (boolean) | (JsonValue[]) | ({
+    [key: string]: JsonValue;
+}) | null;
+type OpenJobRequest = {
+    mode?: 'merge' | 'replace' | undefined;
+    fullSync?: boolean | undefined;
+};
+type PushAssignVendorRequest = {
+    vendorId: string | null;
+    products: PushProductRef[];
+};
+type PushErrorEnvelope = {
+    error: {
+        code: string;
+        message: string;
+        requestId: string;
+        issues?: {
+            path: string;
+            message: string;
+        }[] | undefined;
+    };
+    [key: string]: unknown;
+};
+type PushInventoryAnswer = {
+    results: {
+        sku: string | null;
+        status: 'updated' | 'unchanged' | 'not_found' | 'invalid';
+        code?: 'QUANTITY_BELOW_ZERO' | 'QUANTITY_OUT_OF_RANGE' | 'QUANTITY_MODE_WITHOUT_QUANTITY' | 'STOCK_MODE_CONFLICT' | 'DUPLICATE_SKU_IN_BATCH' | undefined;
+        message?: string | undefined;
+        quantity?: number | undefined;
+        sourceWins?: boolean | undefined;
+    }[];
+};
+type PushInventoryRequest = {
+    rows: (({
+        sku: string;
+        priceMinor?: number | undefined;
+        salePriceMinor?: number | null | undefined;
+        currency?: string | undefined;
+        availability?: 'in_stock' | 'out_of_stock' | 'preorder' | 'backorder' | undefined;
+        quantity?: number | undefined;
+        quantityMode?: 'set' | 'adjust' | undefined;
+    }) | ({
+        [key: string]: JsonValue;
+    }))[];
+};
+type PushJob = {
+    jobId: string;
+    state: 'open' | 'closed' | 'expired';
+    mode: 'merge' | 'replace';
+    fullSync: boolean;
+    vendorId: string | null;
+    openedAt: string;
+    expiresAt: string;
+    closedAt: string | null;
+    finishedAt: string | null;
+    failureCode: string | null;
+    batchesReceived: number;
+    rowsReceived: number;
+    rowsValidated: number;
+    rowsRefused: number;
+    batchesApplied?: number | undefined;
+    rowsApplied?: number | undefined;
+    rowsFailed?: number | undefined;
+    created?: number | undefined;
+    updated?: number | undefined;
+    unchanged?: number | undefined;
+    reportExpiresAt?: string | null | undefined;
+    batches?: {
+        batchId: string;
+        sequence: number;
+        rows: number;
+        rowsRefused: number;
+        status: 'staged' | 'applied' | 'discarded';
+    }[] | undefined;
+};
+type PushJobAnswer = {
+    job: PushJob;
+};
+type PushOpenApiDocument = {
+    openapi: string;
+    [key: string]: unknown;
+};
+type PushProduct = {
+    title?: string | null | undefined;
+    description?: string | null | undefined;
+    brand?: string | null | undefined;
+    productType?: string | null | undefined;
+    googleCategory?: string | null | undefined;
+    link?: string | null | undefined;
+    images?: {
+        url: string;
+        altText?: string | undefined;
+        mediaId?: string | undefined;
+        width?: number | undefined;
+        height?: number | undefined;
+    }[] | null | undefined;
+    shortDescription?: string | null | undefined;
+    seoTitle?: string | null | undefined;
+    seoDescription?: string | null | undefined;
+    tags?: string[] | null | undefined;
+    categories?: string[] | null | undefined;
+    featured?: boolean | null | undefined;
+    draft: boolean;
+    options?: {
+        name: string;
+        values: {
+            value: string;
+            code: string;
+        }[];
+    }[] | null | undefined;
+    skuPattern?: {
+        base: string;
+        separator: '-' | '_' | '.' | '';
+    } | null | undefined;
+    externalId: string | null;
+    handle: string;
+    status: 'draft' | 'active' | 'archived';
+    held: boolean;
+    apiArchived: boolean;
+    purgeAfter: string | null;
+    vendorId: string | null;
+    attributes: {
+        [key: string]: JsonValue;
+    };
+    variants: {
+        title?: string | null | undefined;
+        description?: string | null | undefined;
+        gtin?: string | null | undefined;
+        mpn?: string | null | undefined;
+        condition?: 'new' | 'refurbished' | 'used' | null | undefined;
+        priceMinor?: number | null | undefined;
+        salePriceMinor?: number | null | undefined;
+        currency?: string | null | undefined;
+        availability?: 'in_stock' | 'out_of_stock' | 'preorder' | 'backorder' | null | undefined;
+        quantity: number;
+        weightGrams?: number | null | undefined;
+        lengthMm?: number | null | undefined;
+        widthMm?: number | null | undefined;
+        heightMm?: number | null | undefined;
+        options?: Record<string, string> | null | undefined;
+        images?: {
+            url: string;
+            altText?: string | undefined;
+            mediaId?: string | undefined;
+            width?: number | undefined;
+            height?: number | undefined;
+        }[] | null | undefined;
+        compareAtPriceMinor?: number | null | undefined;
+        trackInventory?: boolean | null | undefined;
+        backorders?: 'deny' | 'allow' | null | undefined;
+        minOrderQuantity?: number | null | undefined;
+        maxOrderQuantity?: number | null | undefined;
+        image?: {
+            url: string;
+            altText?: string | undefined;
+            mediaId?: string | undefined;
+            width?: number | undefined;
+            height?: number | undefined;
+        } | null | undefined;
+        identifierExists?: boolean | null | undefined;
+        sku: string;
+        status: 'active' | 'archived';
+    }[];
+};
+type PushProductAnswer = {
+    product: PushProduct;
+};
+type PushProductOpsAnswer = {
+    results: {
+        index: number;
+        status: 'assigned' | 'done' | 'archived' | 'restored' | 'unchanged' | 'held' | 'not_found';
+    }[];
+};
+type PushProductRef = ({
+    externalId: string;
+}) | ({
+    handle: string;
+}) | ({
+    sku: string;
+});
+type PushProductsAnswer = (PushProductAnswer) | ({
+    products: PushProduct[];
+    nextCursor: string | null;
+});
+type PushProductsRequest = {
+    products: PushProductRef[];
+};
+type PushRenameRequest = {
+    product: PushProductRef;
+    handle: string;
+};
+type PushRow = {
+    sku: string;
+    productHandle?: string | undefined;
+    product?: {
+        title?: string | null | undefined;
+        description?: string | null | undefined;
+        brand?: string | null | undefined;
+        productType?: string | null | undefined;
+        googleCategory?: string | null | undefined;
+        link?: string | null | undefined;
+        images?: {
+            url: string;
+            altText?: string | undefined;
+            mediaId?: string | undefined;
+            width?: number | undefined;
+            height?: number | undefined;
+        }[] | null | undefined;
+        shortDescription?: string | null | undefined;
+        seoTitle?: string | null | undefined;
+        seoDescription?: string | null | undefined;
+        tags?: string[] | null | undefined;
+        categories?: ((string) | (string))[] | null | undefined;
+        featured?: boolean | null | undefined;
+        draft?: boolean | null | undefined;
+        options?: {
+            name: string;
+            values: {
+                value: string;
+                code: string;
+            }[];
+        }[] | null | undefined;
+        skuPattern?: {
+            base: string;
+            separator: '-' | '_' | '.' | '';
+        } | null | undefined;
+    } | undefined;
+    variant?: {
+        title?: string | null | undefined;
+        description?: string | null | undefined;
+        gtin?: string | null | undefined;
+        mpn?: string | null | undefined;
+        condition?: 'new' | 'refurbished' | 'used' | null | undefined;
+        priceMinor?: number | null | undefined;
+        salePriceMinor?: number | null | undefined;
+        currency?: string | null | undefined;
+        availability?: 'in_stock' | 'out_of_stock' | 'preorder' | 'backorder' | null | undefined;
+        quantity?: number | null | undefined;
+        weightGrams?: number | null | undefined;
+        lengthMm?: number | null | undefined;
+        widthMm?: number | null | undefined;
+        heightMm?: number | null | undefined;
+        options?: Record<string, string> | null | undefined;
+        images?: {
+            url: string;
+            altText?: string | undefined;
+            mediaId?: string | undefined;
+            width?: number | undefined;
+            height?: number | undefined;
+        }[] | null | undefined;
+        compareAtPriceMinor?: number | null | undefined;
+        trackInventory?: boolean | null | undefined;
+        backorders?: 'deny' | 'allow' | null | undefined;
+        minOrderQuantity?: number | null | undefined;
+        maxOrderQuantity?: number | null | undefined;
+        image?: {
+            url: string;
+            altText?: string | undefined;
+            mediaId?: string | undefined;
+            width?: number | undefined;
+            height?: number | undefined;
+        } | null | undefined;
+        identifierExists?: boolean | null | undefined;
+    } | undefined;
+    attributes?: Record<string, (string) | (number) | (boolean) | null> | undefined;
+    prices?: Record<string, {
+        priceMinor?: number | null | undefined;
+        salePriceMinor?: number | null | undefined;
+        compareAtPriceMinor?: number | null | undefined;
+    }> | undefined;
+    translations?: Record<string, {
+        title?: string | null | undefined;
+        description?: string | null | undefined;
+        shortDescription?: string | null | undefined;
+        seoTitle?: string | null | undefined;
+        seoDescription?: string | null | undefined;
+        options?: Record<string, {
+            name: string;
+            values: Record<string, string>;
+        }> | null | undefined;
+    }> | undefined;
+    groupPrices?: Record<string, Record<string, number | null>> | undefined;
+    externalId?: string | undefined;
+    status?: 'draft' | 'active' | undefined;
+    quantityMode?: 'set' | 'adjust' | undefined;
+};
+type PushRunAnswer = {
+    run: {
+        runId: string;
+        origin: 'upload' | 'api';
+        uploadId: string | null;
+        fileType: 'products' | 'fitment' | 'oem' | 'supersessions' | 'reviews';
+        mode: 'upsert' | 'full_sync';
+        sourceName: string;
+        status: 'pending' | 'running' | 'completed' | 'failed';
+        rowsRead: number;
+        rowsApplied: number;
+        rowsFailed: number;
+        rowsWarned: number;
+        created: number;
+        updated: number;
+        unchanged: number;
+        reportRows: number;
+        failureCode: string | null;
+        createdAt: string;
+        updatedAt: string;
+        finishedAt: string | null;
+        vendorId?: string | null | undefined;
+        pushMode?: 'merge' | 'replace' | undefined;
+        fullSync?: boolean | undefined;
+        reportExpiresAt?: string | null | undefined;
+    };
+};
+type PushRunStarted = {
+    runId: string;
+    status: 'pending' | 'running' | 'completed' | 'failed';
+};
+type PushStockPage = {
+    rows: PushStockResult[];
+    nextCursor: string | null;
+};
+type PushStockResult = {
+    sequence: number;
+    rowNumber: number;
+    sku: string;
+    externalId: string | null;
+    quantity: number;
+    sourceWins: boolean;
+};
+type PushVariantsRequest = {
+    rows: (({
+        sku: string;
+        productHandle: string;
+        product?: {
+            title?: string | null | undefined;
+            description?: string | null | undefined;
+            brand?: string | null | undefined;
+            productType?: string | null | undefined;
+            googleCategory?: string | null | undefined;
+            link?: string | null | undefined;
+            images?: {
+                url: string;
+                altText?: string | undefined;
+                mediaId?: string | undefined;
+                width?: number | undefined;
+                height?: number | undefined;
+            }[] | null | undefined;
+            shortDescription?: string | null | undefined;
+            seoTitle?: string | null | undefined;
+            seoDescription?: string | null | undefined;
+            tags?: string[] | null | undefined;
+            categories?: ((string) | (string))[] | null | undefined;
+            featured?: boolean | null | undefined;
+            draft?: boolean | null | undefined;
+            options?: {
+                name: string;
+                values: {
+                    value: string;
+                    code: string;
+                }[];
+            }[] | null | undefined;
+            skuPattern?: {
+                base: string;
+                separator: '-' | '_' | '.' | '';
+            } | null | undefined;
+        } | undefined;
+        variant?: {
+            title?: string | null | undefined;
+            description?: string | null | undefined;
+            gtin?: string | null | undefined;
+            mpn?: string | null | undefined;
+            condition?: 'new' | 'refurbished' | 'used' | null | undefined;
+            priceMinor?: number | null | undefined;
+            salePriceMinor?: number | null | undefined;
+            currency?: string | null | undefined;
+            availability?: 'in_stock' | 'out_of_stock' | 'preorder' | 'backorder' | null | undefined;
+            quantity?: number | null | undefined;
+            weightGrams?: number | null | undefined;
+            lengthMm?: number | null | undefined;
+            widthMm?: number | null | undefined;
+            heightMm?: number | null | undefined;
+            options?: Record<string, string> | null | undefined;
+            images?: {
+                url: string;
+                altText?: string | undefined;
+                mediaId?: string | undefined;
+                width?: number | undefined;
+                height?: number | undefined;
+            }[] | null | undefined;
+            compareAtPriceMinor?: number | null | undefined;
+            trackInventory?: boolean | null | undefined;
+            backorders?: 'deny' | 'allow' | null | undefined;
+            minOrderQuantity?: number | null | undefined;
+            maxOrderQuantity?: number | null | undefined;
+            image?: {
+                url: string;
+                altText?: string | undefined;
+                mediaId?: string | undefined;
+                width?: number | undefined;
+                height?: number | undefined;
+            } | null | undefined;
+            identifierExists?: boolean | null | undefined;
+        } | undefined;
+        attributes?: Record<string, (string) | (number) | (boolean) | null> | undefined;
+        prices?: Record<string, {
+            priceMinor?: number | null | undefined;
+            salePriceMinor?: number | null | undefined;
+            compareAtPriceMinor?: number | null | undefined;
+        }> | undefined;
+        translations?: Record<string, {
+            title?: string | null | undefined;
+            description?: string | null | undefined;
+            shortDescription?: string | null | undefined;
+            seoTitle?: string | null | undefined;
+            seoDescription?: string | null | undefined;
+            options?: Record<string, {
+                name: string;
+                values: Record<string, string>;
+            }> | null | undefined;
+        }> | undefined;
+        groupPrices?: Record<string, Record<string, number | null>> | undefined;
+    }) | ({
+        [key: string]: JsonValue;
+    }))[];
+};
+type PushWebhookEvent = {
+    id: string;
+    type: 'catalog.run.completed' | 'catalog.run.failed';
+    createdAt: string;
+    data: {
+        runId: string;
+        vendorId: string | null;
+        mode: 'merge' | 'replace';
+        fullSync: boolean;
+        failureCode: string | null;
+        received: number;
+        created: number;
+        updated: number;
+        unchanged: number;
+        rowsFailed: number;
+        rowsWarned: number;
+        finishedAt: string;
+        reportExpiresAt: string | null;
+    };
+};
+type CatalogPushErrorCode = 'AUTHENTICATION_FAILED' | 'VENDOR_PAUSED' | 'VENDOR_KEY_NOT_ALLOWED' | 'INVALID_REQUEST' | 'IDEMPOTENCY_KEY_REQUIRED' | 'NOT_FOUND' | 'PROFILE_NOT_FOUND' | 'VENDOR_NOT_FOUND' | 'IDEMPOTENCY_CONFLICT' | 'RUN_IN_PROGRESS' | 'JOB_CLOSED' | 'JOB_FULL' | 'TOO_MANY_OPEN_JOBS' | 'REPORT_TOO_LARGE' | 'HANDLE_TAKEN' | 'IDENTIFIER_LOCKED' | 'REPORT_EXPIRED' | 'REQUEST_BODY_TOO_LARGE' | 'MAPPING_INVALID' | 'RATE_LIMITED' | 'PUSH_QUEUE_FULL' | 'INTERNAL_ERROR' | 'INFRASTRUCTURE_UNAVAILABLE';
+
+type InventoryRows = PushInventoryRequest['rows'];
+/**
+ * @experimental The admin entry may change in a minor release.
+ */
+type AdminInventoryNamespace = {
+    /** `PATCH /v1/catalog/inventory`: each row replaces the stored quantity. */
+    set(rows: InventoryRows): Promise<PushInventoryAnswer>;
+    /**
+     * Each row's `quantity` is a signed amount added to the stored one (every
+     * row is sent with `quantityMode: 'adjust'`). A missing `idempotencyKey` is
+     * generated with `crypto.randomUUID()`, and a retry within the call reuses
+     * it, so a delta is never applied twice.
+     */
+    adjust(rows: InventoryRows, options?: {
+        idempotencyKey?: string;
+    }): Promise<PushInventoryAnswer>;
+};
+
+/**
+ * A page of products, with the cursor of the next one (`null` at the end).
+ * @experimental The admin entry may change in a minor release.
+ */
+type PushProductList = {
+    products: PushProduct[];
+    nextCursor: string | null;
+};
+/**
+ * @experimental The admin entry may change in a minor release.
+ */
+type AdminProductsNamespace = {
+    /** One product by exactly one of `externalId`, `sku` or `handle`. */
+    get(ref: PushProductRef): Promise<PushProduct>;
+    list(options?: {
+        cursor?: string;
+        limit?: number;
+    }): Promise<PushProductList>;
+    /** Takes the products off the storefront; each answer says what happened. */
+    archive(refs: PushProductsRequest['products']): Promise<PushProductOpsAnswer>;
+    restore(refs: PushProductsRequest['products']): Promise<PushProductOpsAnswer>;
+    rename(ref: PushProductRef, handle: string): Promise<PushProduct>;
+};
+
+type Row = JobBatchRequest['rows'][number];
+/**
+ * How `wait` polls.
+ * @experimental The admin entry may change in a minor release.
+ */
+type WaitOptions = {
+    /** Between polls. Defaults to 5000. */
+    intervalMs?: number;
+    /** In total. Defaults to 24 hours; then `TimeoutError`. */
+    timeoutMs?: number;
+    signal?: AbortSignal;
+};
+/**
+ * One sync job: send batches, close, then follow it to the end.
+ * @experimental The admin entry may change in a minor release.
+ */
+type PushJobHandle = {
+    readonly jobId: string;
+    /** A missing key is generated for this batch, so an adjust row always carries one. */
+    send(rows: JobBatchRequest['rows'], options?: {
+        idempotencyKey?: string;
+    }): Promise<JobBatchAnswer>;
+    /** Applies the staged batches together. */
+    close(): Promise<PushJob>;
+    get(options?: {
+        includeBatches?: boolean;
+    }): Promise<PushJob>;
+    /** Resolves with the job once it has finished or expired; read `failureCode`. */
+    wait(options?: WaitOptions): Promise<PushJob>;
+    /** The refused and failed rows. `409 REPORT_TOO_LARGE` for a very large report (row numbers are job-wide). */
+    errorsCsv(): Promise<string>;
+    /** The quantity each stock-writing row left, page by page. */
+    stockResults(): AsyncIterable<PushStockResult>;
+    stockCsv(): Promise<string>;
+};
+/**
+ * Options for `jobs.run`.
+ * @experimental The admin entry may change in a minor release.
+ */
+type JobRunOptions = {
+    mode?: 'merge' | 'replace';
+    fullSync?: boolean;
+    /** Rows per batch, 1 to 1,000. Defaults to 1,000. */
+    batchRows?: number;
+    /** Cancels the waits between queue-full retries. */
+    signal?: AbortSignal;
+};
+/**
+ * @experimental The admin entry may change in a minor release.
+ */
+type JobsNamespace = {
+    open(options?: {
+        mode?: 'merge' | 'replace';
+        fullSync?: boolean;
+    }): Promise<PushJobHandle>;
+    /** Checks the job exists (a `404` otherwise) and returns its handle. */
+    get(jobId: string): Promise<PushJobHandle>;
+    /** A handle for a job you opened earlier. Sends no request. */
+    resume(jobId: string): PushJobHandle;
+    /**
+     * Opens a job, sends the rows in batches of at most 1,000 rows and 5 MB,
+     * closes it and returns the handle. The rows of one product must be next to
+     * each other: they are never split across batches.
+     */
+    run(rows: Iterable<Row> | AsyncIterable<Row>, options?: JobRunOptions): Promise<PushJobHandle>;
+};
+/**
+ * @experimental The admin entry may change in a minor release.
+ */
+type BatchesNamespace = {
+    /**
+     * `POST /v1/catalog/variants`: one batch, answered with a run to follow.
+     * `mode` needs a vendor key (a store key's route ignores it: use `jobs.run`).
+     */
+    send(rows: PushVariantsRequest['rows'], options?: {
+        mode?: 'merge' | 'replace';
+        idempotencyKey?: string;
+    }): Promise<PushRunStarted>;
+};
+/**
+ * @experimental The admin entry may change in a minor release.
+ */
+type RunsNamespace = {
+    get(runId: string): Promise<PushRunAnswer['run']>;
+    /** Resolves with the run once it has completed or failed; read `status`. */
+    wait(runId: string, options?: WaitOptions): Promise<PushRunAnswer['run']>;
+    errorsCsv(runId: string): Promise<string>;
+    stockResults(runId: string): AsyncIterable<PushStockResult>;
+    stockCsv(runId: string): Promise<string>;
+};
+
+/**
+ * Options for `createCatalogAdmin`.
+ * @experimental The admin entry may change in a minor release.
+ */
+type CatalogAdminOptions = {
+    /** A secret (`pc_sk_`) or vendor (`pc_vk_`) key. Never put one in a browser. */
+    key: string;
+    /** Defaults to `https://catalog.usethrottle.dev`. */
+    baseUrl?: string;
+    /** Per request, in milliseconds. Defaults to 60 seconds. */
+    timeoutMs?: number;
+    fetch?: typeof fetch;
+};
+/**
+ * The server-only admin client for the catalog push API.
+ * @experimental The admin entry may change in a minor release.
+ */
+type CatalogAdmin = {
+    jobs: JobsNamespace;
+    batches: BatchesNamespace;
+    runs: RunsNamespace;
+    products: AdminProductsNamespace;
+    inventory: AdminInventoryNamespace;
+};
+/**
+ * Creates the admin client for the catalog push API: sync jobs, single
+ * batches, run and job polling, reports, product operations and stock writes.
+ * Server-only: it throws `CatalogError` `SERVER_ONLY` in a browser
+ * environment, and `INVALID_ADMIN_KEY` unless `key` is a `pc_sk_` or `pc_vk_`
+ * key. The key is never part of an error message.
+ * @experimental The admin entry may change in a minor release.
+ */
+declare function createCatalogAdmin(options: CatalogAdminOptions): CatalogAdmin;
+
+/**
+ * What `verifyCatalogWebhook` needs.
+ * @experimental The admin entry may change in a minor release.
+ */
+type VerifyCatalogWebhookInput = {
+    /** The request body exactly as received, before any JSON parsing. */
+    rawBody: string;
+    /** The `x-catalog-signature` header: `t=<seconds>,v1=<hex>[,v1=<hex>…]`. */
+    signature: string;
+    /** The webhook's signing secret. */
+    secret: string;
+    /** Unix seconds; defaults to the clock. */
+    now?: number;
+    /** Defaults to 300. */
+    toleranceSeconds?: number;
+};
+/**
+ * Checks a catalog webhook: exactly one `t` and 1 to 8 `v1` digests, any
+ * matching `v1` passes (secret rotation), HMAC-SHA256 over `<t>.<rawBody>`,
+ * compared in constant time, and `t` within the tolerance (300 s by default).
+ * Anything malformed, stale or unmatched is `false`; it never throws.
+ * @experimental The admin entry may change in a minor release.
+ */
+declare function verifyCatalogWebhook(input: VerifyCatalogWebhookInput): Promise<boolean>;
+
+export { createCatalogAdmin, verifyCatalogWebhook };
+export type { AdminInventoryNamespace, AdminProductsNamespace, BatchesNamespace, CatalogAdmin, CatalogAdminOptions, CatalogPushErrorCode, JobBatchAnswer, JobBatchRequest, JobRunOptions, JobsNamespace, JsonValue, OpenJobRequest, PushAssignVendorRequest, PushErrorEnvelope, PushInventoryAnswer, PushInventoryRequest, PushJob, PushJobAnswer, PushJobHandle, PushOpenApiDocument, PushProduct, PushProductAnswer, PushProductList, PushProductOpsAnswer, PushProductRef, PushProductsAnswer, PushProductsRequest, PushRenameRequest, PushRow, PushRunAnswer, PushRunStarted, PushStockPage, PushStockResult, PushVariantsRequest, PushWebhookEvent, RunsNamespace, VerifyCatalogWebhookInput, WaitOptions };