@cookiemunch/sdk 0.2.0 → 0.3.0

package/dist/index.d.cts

@@ -296,8 +296,34 @@ interface CategorizedCookie {
     declared?: boolean;
     /** A declared `prefix*` wildcard row that no observed cookie matched yet. */
     pattern?: boolean;
-    /** Why a person should look at it. Visitors see such cookies under "Unclassified". */
-    review?: 'unclassified' | 'category_disabled' | 'category_unknown';
+    /**
+     * Why a person should look at it. Visitors see unclassified and category ones under
+     * "Unclassified"; `retired_but_seen` = retired, but a crawl or a visit saw it since, so the
+     * site still sets it and it is listed again.
+     */
+    review?: 'unclassified' | 'category_disabled' | 'category_unknown' | 'retired_but_seen';
+    /** Epoch-ms a crawl or a real visit last saw it. Absent on older rows. */
+    lastSeenAt?: number;
+    /** Owner views only: the site owner retired this cookie (see `sites.retireCookie`). */
+    retired?: {
+        at: number;
+        renamedTo?: string;
+        note?: string;
+        by?: string;
+        pattern?: string;
+    };
+}
+/** A cookie the site owner retired: the site renamed or stopped setting it. */
+interface RetiredCookie {
+    /** Exact name, or a `prefix*` wildcard. */
+    name: string;
+    /** Epoch-ms it was retired; anything seen after this brings it back. */
+    at: number;
+    renamedTo?: string;
+    note?: string;
+    /** `apikey:<prefix>` or a dashboard user id. */
+    by?: string;
+    pattern?: boolean;
 }
 /** A site's cookie declaration: the latest scan and observed visits with the site's own
  *  declarations on top. This is what GET /v1/sites/:cbid/cookies returns. */
@@ -307,6 +333,8 @@ interface CookieDeclaration {
     cookies: CategorizedCookie[];
     /** The site owner's declarations, as stored. */
     declared?: DeclaredCookie[];
+    /** The site's retirements, as stored (owner views only). */
+    retired?: RetiredCookie[];
 }
 /** What the site owner says a cookie is (PUT /v1/sites/:cbid/cookies/:name). */
 interface DeclaredCookieInput {
@@ -374,11 +402,24 @@ interface SiteCookie {
 }
 /** Cookie-scan status, from GET /v1/sites/:cbid/scan. */
 interface ScanStatus {
+    /** `scanning` while the last scan is queued or crawling. Kept for older clients; read `state`. */
     status: 'idle' | 'scanning';
     /** Epoch-ms of the last completed scan, or null. */
     lastScannedAt: number | null;
     /** What the last scan saw of the live banner's Accept all / Reject all. Absent until measured. */
     buttonParity?: ButtonParityScan;
+    /** Where the last scan is. Absent when the site was never scanned. */
+    state?: 'queued' | 'scanning' | 'done' | 'failed';
+    scanId?: string;
+    startedAt?: number;
+    finishedAt?: number;
+    durationMs?: number;
+    /** Cookies this crawl saw (the stored list also keeps earlier finds: `keptFromEarlier`). */
+    cookieCount?: number;
+    keptFromEarlier?: number;
+    pagesVisited?: number;
+    /** Why it failed. */
+    error?: string;
 }
 /** Consent-button parity of the banner a real browser saw on the site (see ScanStatus). */
 interface ButtonParityScan {
@@ -539,6 +580,18 @@ interface ButtonParityLint {
     score: number;
     suggestedReject: SuggestedRejectStyle[];
 }
+/**
+ * Scrollbars on the surfaces Cookie Munch renders — the same shape on the banner theme (`theme.scrollbar`)
+ * and the rights-page theme. Colours are #hex, rgb() or hsl(); width is clamped to 4–16, radius to 0–999.
+ */
+interface ScrollbarTheme {
+    style: 'themed' | 'thin' | 'native' | 'hidden';
+    thumb?: string;
+    thumbHover?: string;
+    track?: string;
+    width?: number;
+    radius?: number;
+}
 /** The hosted rights page document. See docs/rights-page for each section type's props. */
 interface RightsPageDocument {
     v: 1;
@@ -547,6 +600,7 @@ interface RightsPageDocument {
         width: 'narrow' | 'normal' | 'wide' | 'full';
         density: 'compact' | 'comfortable' | 'spacious';
         colorScheme: 'light' | 'dark' | 'auto';
+        scrollbar?: ScrollbarTheme;
         [k: string]: unknown;
     };
     sections: Array<{
@@ -1526,8 +1580,9 @@ interface DsarExecutorInput {
     secretKey: string;
     /**
      * The signing secret of its webhook endpoint. Optional — polling closes tasks without it.
-     * A `whsec_<base64>` secret verifies a delivery signed with either the base64-decoded bytes
-     * or the literal string; anything else only with its UTF-8 bytes.
+     * A `whsec_<base64>` secret (standard base64 or base64url, padded or not) verifies a delivery
+     * signed with either the base64-decoded bytes or the literal string; anything else only with
+     * its UTF-8 bytes.
      */
     webhookSecret?: string;
     auto?: boolean;
@@ -1714,8 +1769,24 @@ interface CookieMunchClient {
             replace?: boolean;
         }): Promise<ButtonParityLint>;
         cookies(cbid: string): Promise<CookieDeclaration>;
-        scan(cbid: string): Promise<ScanStatus>;
-        scanStatus(cbid: string): Promise<ScanStatus>;
+        /**
+         * Start a cookie crawl. Answers at once with `scanId` and `state: 'queued'`; `wait`
+         * (seconds, ≤60) holds the request until the scan is done or failed.
+         */
+        scan(cbid: string, opts?: {
+            wait?: number;
+        }): Promise<ScanStatus>;
+        /** The last scan's state. `wait` (seconds, ≤60) holds the request until a running scan settles. */
+        scanStatus(cbid: string, opts?: {
+            wait?: number;
+        }): Promise<ScanStatus>;
+        /**
+         * Resolve once the site's scan is done or failed (read `state` and `error`), long-polling
+         * the server. At `timeoutMs` (default 120 000) it resolves with the still-running state.
+         */
+        waitForScan(cbid: string, opts?: {
+            timeoutMs?: number;
+        }): Promise<ScanStatus>;
         ab(cbid: string): Promise<AbResult[]>;
         /** Generate the site's privacy and cookie policy, as Markdown. */
         policy(cbid: string, opts?: PolicyOptions): Promise<string>;
@@ -1761,6 +1832,32 @@ interface CookieMunchClient {
             cookie: DeclaredCookie;
             warnings?: DeclarationWarning[];
         } & Partial<DeclarationDryRun>>;
+        /**
+         * Retire a cookie the site renamed or stopped setting: it leaves the banner's list,
+         * `data-cc="declaration"` and the public feed, and stays listed for you with `retired`.
+         * A name ending in `*` retires every cookie with that prefix. If a crawl or a visit sees
+         * it again afterwards it is listed again, flagged `review: 'retired_but_seen'`.
+         */
+        retireCookie(cbid: string, name: string, input?: {
+            renamedTo?: string;
+            note?: string;
+        }, opts?: {
+            dryRun?: boolean;
+        }): Promise<{
+            cookie: RetiredCookie;
+            matched: string[];
+            dryRun?: true;
+            retired?: RetiredCookie[];
+        }>;
+        /** Un-retire a cookie: it is listed again everywhere. */
+        unretireCookie(cbid: string, name: string): Promise<void>;
+        /** What un-retiring would leave; nothing is removed. */
+        unretireCookie(cbid: string, name: string, opts: {
+            dryRun: true;
+        }): Promise<{
+            dryRun: true;
+            retired: RetiredCookie[];
+        }>;
         /** Remove a declaration; the scanned classification applies again. */
         undeclareCookie(cbid: string, name: string): Promise<void>;
         /** What removing a declaration would leave; nothing is removed. */
@@ -2352,4 +2449,4 @@ interface CookieMunchClient {
 }
 declare function createCookieMunch(opts: CookieMunchOptions): CookieMunchClient;
 
-export { type AbResult, type AccountOrg, type AccountOrgs, type AdPersonalizationInput, type AiInspectInput, type AiInspectResult, type ApiKey, type ApiKeyIssueInput, type ApiKeyIssued, type ApiKeyPrefix, type ApiKeyUpdate, type AppliedImport, type AssetUpload, type AuditEntry, type BannerRecord, type BannerSummary, type BlockedReport, type BrandExtractionResult, type BrandKit, type BrandKitCreate, type BrandSuggestion, type BulkSiteInput, type BulkSiteResult, type ButtonParityFinding, type ButtonParityLint, type ButtonParityScan, type CategorizedCookie, type ChildKeyInput, type ConfigChange, type ConfigDryRun, type ConfigWarning, type ConsentDay, type ConsentDecisionInput, type ConsentIngestInput, type ConsentLogRow, type CookieDeclaration, CookieMunchApiError, type CookieMunchClient, type CookieMunchOptions, type CspSources, type DeclarationDiff, type DeclarationDryRun, type DeclarationWarning, type DeclaredCookie, type DeclaredCookieInput, type DnsRecordInstruction, type DsarCreate, type DsarEraseResult, type DsarExecutor, type DsarExecutorCreated, type DsarExecutorDryRun, type DsarExecutorInput, type DsarExecutorPatch, type DsarExportResult, type DsarRequest, type DsarStatus, type DsarTask, type DsarTaskEvent, type DsarTaskExport, type DsarTaskLogEntry, type DsarTaskOutcome, type DsarType, type EnforcementRuleInput, type ExecutorProfile, type ExecutorTestInput, type ExecutorTestResult, type ExecutorWebhookDelivery, type ExecutorWebhookTestResult, type FlowIssue, type FlowOp, type FlowOpResponse, type FulfillmentOp, type Identifier, type Identity, type ImportedCookie, type ImportedDeclaration, type InstallSnippet, type LegalBasis, type LogQuery, type MailProvider, type MailProviderInput, type MailProviderKind, type MailProviderTestResult, type Member, type OptInMethod, type Org, type OrgUpdate, type ParityControlSummary, type PlanSource, type PolicyOptions, type PreferenceItem, type PreferenceRecord, type PreviewToken, type PreviewTokenOptions, type ProfileAttributeInput, type PublicDsarFiled, type PublicDsarPending, type PublicVerification, type PutConfigOptions, type RangeQuery, type Regulation, type RegulationSummary, type RegulatoryFeedResult, type ResellerChild, type ResellerChildCreate, type ResellerChildList, type ResellerChildPatch, type RightKind, type RightsCaptcha, type RightsCaptchaInput, type RightsCaptchaProvider, type RightsIdentity, type RightsIdentityInput, type RightsIdentityType, type RightsLink, type RightsLinkInput, type RightsPageDocument, type RightsPageDomain, type RightsPageDomainList, type RightsPageDraft, type RightsPageDraftConflict, type RightsPageDryRun, type RightsPageIssue, type RightsPagePublishResult, type RightsPagePublished, type RightsPagePublisher, type RightsPageVersions, type RightsPageWriteOptions, type RiskScore, type RopaEntry, type RopaInput, type ScanResult, type ScanStatus, type ScoredVendor, type SessionAnalysisInput, type SignedReceipt, type Site, type SiteConfig, type SiteCookie, type SiteCreate, type SiteFlow, type SnippetOptions, type SubscriptionTopicInput, type SuggestedRejectStyle, type SupportedLanguage, type Usage, type VendorInput, type VendorRecord, type VerifyResult, type VerifyWebhookInput, type WebhookCreate, type WebhookDeadLetter, type WebhookKeyForm, type WebhookStage, type WebhookSubscription, type WebhookTestResult, type WebhookUpdate, createCookieMunch, verifyWebhookSignature };
+export { type AbResult, type AccountOrg, type AccountOrgs, type AdPersonalizationInput, type AiInspectInput, type AiInspectResult, type ApiKey, type ApiKeyIssueInput, type ApiKeyIssued, type ApiKeyPrefix, type ApiKeyUpdate, type AppliedImport, type AssetUpload, type AuditEntry, type BannerRecord, type BannerSummary, type BlockedReport, type BrandExtractionResult, type BrandKit, type BrandKitCreate, type BrandSuggestion, type BulkSiteInput, type BulkSiteResult, type ButtonParityFinding, type ButtonParityLint, type ButtonParityScan, type CategorizedCookie, type ChildKeyInput, type ConfigChange, type ConfigDryRun, type ConfigWarning, type ConsentDay, type ConsentDecisionInput, type ConsentIngestInput, type ConsentLogRow, type CookieDeclaration, CookieMunchApiError, type CookieMunchClient, type CookieMunchOptions, type CspSources, type DeclarationDiff, type DeclarationDryRun, type DeclarationWarning, type DeclaredCookie, type DeclaredCookieInput, type DnsRecordInstruction, type DsarCreate, type DsarEraseResult, type DsarExecutor, type DsarExecutorCreated, type DsarExecutorDryRun, type DsarExecutorInput, type DsarExecutorPatch, type DsarExportResult, type DsarRequest, type DsarStatus, type DsarTask, type DsarTaskEvent, type DsarTaskExport, type DsarTaskLogEntry, type DsarTaskOutcome, type DsarType, type EnforcementRuleInput, type ExecutorProfile, type ExecutorTestInput, type ExecutorTestResult, type ExecutorWebhookDelivery, type ExecutorWebhookTestResult, type FlowIssue, type FlowOp, type FlowOpResponse, type FulfillmentOp, type Identifier, type Identity, type ImportedCookie, type ImportedDeclaration, type InstallSnippet, type LegalBasis, type LogQuery, type MailProvider, type MailProviderInput, type MailProviderKind, type MailProviderTestResult, type Member, type OptInMethod, type Org, type OrgUpdate, type ParityControlSummary, type PlanSource, type PolicyOptions, type PreferenceItem, type PreferenceRecord, type PreviewToken, type PreviewTokenOptions, type ProfileAttributeInput, type PublicDsarFiled, type PublicDsarPending, type PublicVerification, type PutConfigOptions, type RangeQuery, type Regulation, type RegulationSummary, type RegulatoryFeedResult, type ResellerChild, type ResellerChildCreate, type ResellerChildList, type ResellerChildPatch, type RetiredCookie, type RightKind, type RightsCaptcha, type RightsCaptchaInput, type RightsCaptchaProvider, type RightsIdentity, type RightsIdentityInput, type RightsIdentityType, type RightsLink, type RightsLinkInput, type RightsPageDocument, type RightsPageDomain, type RightsPageDomainList, type RightsPageDraft, type RightsPageDraftConflict, type RightsPageDryRun, type RightsPageIssue, type RightsPagePublishResult, type RightsPagePublished, type RightsPagePublisher, type RightsPageVersions, type RightsPageWriteOptions, type RiskScore, type RopaEntry, type RopaInput, type ScanResult, type ScanStatus, type ScoredVendor, type ScrollbarTheme, type SessionAnalysisInput, type SignedReceipt, type Site, type SiteConfig, type SiteCookie, type SiteCreate, type SiteFlow, type SnippetOptions, type SubscriptionTopicInput, type SuggestedRejectStyle, type SupportedLanguage, type Usage, type VendorInput, type VendorRecord, type VerifyResult, type VerifyWebhookInput, type WebhookCreate, type WebhookDeadLetter, type WebhookKeyForm, type WebhookStage, type WebhookSubscription, type WebhookTestResult, type WebhookUpdate, createCookieMunch, verifyWebhookSignature };

package/dist/index.d.ts

@@ -296,8 +296,34 @@ interface CategorizedCookie {
     declared?: boolean;
     /** A declared `prefix*` wildcard row that no observed cookie matched yet. */
     pattern?: boolean;
-    /** Why a person should look at it. Visitors see such cookies under "Unclassified". */
-    review?: 'unclassified' | 'category_disabled' | 'category_unknown';
+    /**
+     * Why a person should look at it. Visitors see unclassified and category ones under
+     * "Unclassified"; `retired_but_seen` = retired, but a crawl or a visit saw it since, so the
+     * site still sets it and it is listed again.
+     */
+    review?: 'unclassified' | 'category_disabled' | 'category_unknown' | 'retired_but_seen';
+    /** Epoch-ms a crawl or a real visit last saw it. Absent on older rows. */
+    lastSeenAt?: number;
+    /** Owner views only: the site owner retired this cookie (see `sites.retireCookie`). */
+    retired?: {
+        at: number;
+        renamedTo?: string;
+        note?: string;
+        by?: string;
+        pattern?: string;
+    };
+}
+/** A cookie the site owner retired: the site renamed or stopped setting it. */
+interface RetiredCookie {
+    /** Exact name, or a `prefix*` wildcard. */
+    name: string;
+    /** Epoch-ms it was retired; anything seen after this brings it back. */
+    at: number;
+    renamedTo?: string;
+    note?: string;
+    /** `apikey:<prefix>` or a dashboard user id. */
+    by?: string;
+    pattern?: boolean;
 }
 /** A site's cookie declaration: the latest scan and observed visits with the site's own
  *  declarations on top. This is what GET /v1/sites/:cbid/cookies returns. */
@@ -307,6 +333,8 @@ interface CookieDeclaration {
     cookies: CategorizedCookie[];
     /** The site owner's declarations, as stored. */
     declared?: DeclaredCookie[];
+    /** The site's retirements, as stored (owner views only). */
+    retired?: RetiredCookie[];
 }
 /** What the site owner says a cookie is (PUT /v1/sites/:cbid/cookies/:name). */
 interface DeclaredCookieInput {
@@ -374,11 +402,24 @@ interface SiteCookie {
 }
 /** Cookie-scan status, from GET /v1/sites/:cbid/scan. */
 interface ScanStatus {
+    /** `scanning` while the last scan is queued or crawling. Kept for older clients; read `state`. */
     status: 'idle' | 'scanning';
     /** Epoch-ms of the last completed scan, or null. */
     lastScannedAt: number | null;
     /** What the last scan saw of the live banner's Accept all / Reject all. Absent until measured. */
     buttonParity?: ButtonParityScan;
+    /** Where the last scan is. Absent when the site was never scanned. */
+    state?: 'queued' | 'scanning' | 'done' | 'failed';
+    scanId?: string;
+    startedAt?: number;
+    finishedAt?: number;
+    durationMs?: number;
+    /** Cookies this crawl saw (the stored list also keeps earlier finds: `keptFromEarlier`). */
+    cookieCount?: number;
+    keptFromEarlier?: number;
+    pagesVisited?: number;
+    /** Why it failed. */
+    error?: string;
 }
 /** Consent-button parity of the banner a real browser saw on the site (see ScanStatus). */
 interface ButtonParityScan {
@@ -539,6 +580,18 @@ interface ButtonParityLint {
     score: number;
     suggestedReject: SuggestedRejectStyle[];
 }
+/**
+ * Scrollbars on the surfaces Cookie Munch renders — the same shape on the banner theme (`theme.scrollbar`)
+ * and the rights-page theme. Colours are #hex, rgb() or hsl(); width is clamped to 4–16, radius to 0–999.
+ */
+interface ScrollbarTheme {
+    style: 'themed' | 'thin' | 'native' | 'hidden';
+    thumb?: string;
+    thumbHover?: string;
+    track?: string;
+    width?: number;
+    radius?: number;
+}
 /** The hosted rights page document. See docs/rights-page for each section type's props. */
 interface RightsPageDocument {
     v: 1;
@@ -547,6 +600,7 @@ interface RightsPageDocument {
         width: 'narrow' | 'normal' | 'wide' | 'full';
         density: 'compact' | 'comfortable' | 'spacious';
         colorScheme: 'light' | 'dark' | 'auto';
+        scrollbar?: ScrollbarTheme;
         [k: string]: unknown;
     };
     sections: Array<{
@@ -1526,8 +1580,9 @@ interface DsarExecutorInput {
     secretKey: string;
     /**
      * The signing secret of its webhook endpoint. Optional — polling closes tasks without it.
-     * A `whsec_<base64>` secret verifies a delivery signed with either the base64-decoded bytes
-     * or the literal string; anything else only with its UTF-8 bytes.
+     * A `whsec_<base64>` secret (standard base64 or base64url, padded or not) verifies a delivery
+     * signed with either the base64-decoded bytes or the literal string; anything else only with
+     * its UTF-8 bytes.
      */
     webhookSecret?: string;
     auto?: boolean;
@@ -1714,8 +1769,24 @@ interface CookieMunchClient {
             replace?: boolean;
         }): Promise<ButtonParityLint>;
         cookies(cbid: string): Promise<CookieDeclaration>;
-        scan(cbid: string): Promise<ScanStatus>;
-        scanStatus(cbid: string): Promise<ScanStatus>;
+        /**
+         * Start a cookie crawl. Answers at once with `scanId` and `state: 'queued'`; `wait`
+         * (seconds, ≤60) holds the request until the scan is done or failed.
+         */
+        scan(cbid: string, opts?: {
+            wait?: number;
+        }): Promise<ScanStatus>;
+        /** The last scan's state. `wait` (seconds, ≤60) holds the request until a running scan settles. */
+        scanStatus(cbid: string, opts?: {
+            wait?: number;
+        }): Promise<ScanStatus>;
+        /**
+         * Resolve once the site's scan is done or failed (read `state` and `error`), long-polling
+         * the server. At `timeoutMs` (default 120 000) it resolves with the still-running state.
+         */
+        waitForScan(cbid: string, opts?: {
+            timeoutMs?: number;
+        }): Promise<ScanStatus>;
         ab(cbid: string): Promise<AbResult[]>;
         /** Generate the site's privacy and cookie policy, as Markdown. */
         policy(cbid: string, opts?: PolicyOptions): Promise<string>;
@@ -1761,6 +1832,32 @@ interface CookieMunchClient {
             cookie: DeclaredCookie;
             warnings?: DeclarationWarning[];
         } & Partial<DeclarationDryRun>>;
+        /**
+         * Retire a cookie the site renamed or stopped setting: it leaves the banner's list,
+         * `data-cc="declaration"` and the public feed, and stays listed for you with `retired`.
+         * A name ending in `*` retires every cookie with that prefix. If a crawl or a visit sees
+         * it again afterwards it is listed again, flagged `review: 'retired_but_seen'`.
+         */
+        retireCookie(cbid: string, name: string, input?: {
+            renamedTo?: string;
+            note?: string;
+        }, opts?: {
+            dryRun?: boolean;
+        }): Promise<{
+            cookie: RetiredCookie;
+            matched: string[];
+            dryRun?: true;
+            retired?: RetiredCookie[];
+        }>;
+        /** Un-retire a cookie: it is listed again everywhere. */
+        unretireCookie(cbid: string, name: string): Promise<void>;
+        /** What un-retiring would leave; nothing is removed. */
+        unretireCookie(cbid: string, name: string, opts: {
+            dryRun: true;
+        }): Promise<{
+            dryRun: true;
+            retired: RetiredCookie[];
+        }>;
         /** Remove a declaration; the scanned classification applies again. */
         undeclareCookie(cbid: string, name: string): Promise<void>;
         /** What removing a declaration would leave; nothing is removed. */
@@ -2352,4 +2449,4 @@ interface CookieMunchClient {
 }
 declare function createCookieMunch(opts: CookieMunchOptions): CookieMunchClient;
 
-export { type AbResult, type AccountOrg, type AccountOrgs, type AdPersonalizationInput, type AiInspectInput, type AiInspectResult, type ApiKey, type ApiKeyIssueInput, type ApiKeyIssued, type ApiKeyPrefix, type ApiKeyUpdate, type AppliedImport, type AssetUpload, type AuditEntry, type BannerRecord, type BannerSummary, type BlockedReport, type BrandExtractionResult, type BrandKit, type BrandKitCreate, type BrandSuggestion, type BulkSiteInput, type BulkSiteResult, type ButtonParityFinding, type ButtonParityLint, type ButtonParityScan, type CategorizedCookie, type ChildKeyInput, type ConfigChange, type ConfigDryRun, type ConfigWarning, type ConsentDay, type ConsentDecisionInput, type ConsentIngestInput, type ConsentLogRow, type CookieDeclaration, CookieMunchApiError, type CookieMunchClient, type CookieMunchOptions, type CspSources, type DeclarationDiff, type DeclarationDryRun, type DeclarationWarning, type DeclaredCookie, type DeclaredCookieInput, type DnsRecordInstruction, type DsarCreate, type DsarEraseResult, type DsarExecutor, type DsarExecutorCreated, type DsarExecutorDryRun, type DsarExecutorInput, type DsarExecutorPatch, type DsarExportResult, type DsarRequest, type DsarStatus, type DsarTask, type DsarTaskEvent, type DsarTaskExport, type DsarTaskLogEntry, type DsarTaskOutcome, type DsarType, type EnforcementRuleInput, type ExecutorProfile, type ExecutorTestInput, type ExecutorTestResult, type ExecutorWebhookDelivery, type ExecutorWebhookTestResult, type FlowIssue, type FlowOp, type FlowOpResponse, type FulfillmentOp, type Identifier, type Identity, type ImportedCookie, type ImportedDeclaration, type InstallSnippet, type LegalBasis, type LogQuery, type MailProvider, type MailProviderInput, type MailProviderKind, type MailProviderTestResult, type Member, type OptInMethod, type Org, type OrgUpdate, type ParityControlSummary, type PlanSource, type PolicyOptions, type PreferenceItem, type PreferenceRecord, type PreviewToken, type PreviewTokenOptions, type ProfileAttributeInput, type PublicDsarFiled, type PublicDsarPending, type PublicVerification, type PutConfigOptions, type RangeQuery, type Regulation, type RegulationSummary, type RegulatoryFeedResult, type ResellerChild, type ResellerChildCreate, type ResellerChildList, type ResellerChildPatch, type RightKind, type RightsCaptcha, type RightsCaptchaInput, type RightsCaptchaProvider, type RightsIdentity, type RightsIdentityInput, type RightsIdentityType, type RightsLink, type RightsLinkInput, type RightsPageDocument, type RightsPageDomain, type RightsPageDomainList, type RightsPageDraft, type RightsPageDraftConflict, type RightsPageDryRun, type RightsPageIssue, type RightsPagePublishResult, type RightsPagePublished, type RightsPagePublisher, type RightsPageVersions, type RightsPageWriteOptions, type RiskScore, type RopaEntry, type RopaInput, type ScanResult, type ScanStatus, type ScoredVendor, type SessionAnalysisInput, type SignedReceipt, type Site, type SiteConfig, type SiteCookie, type SiteCreate, type SiteFlow, type SnippetOptions, type SubscriptionTopicInput, type SuggestedRejectStyle, type SupportedLanguage, type Usage, type VendorInput, type VendorRecord, type VerifyResult, type VerifyWebhookInput, type WebhookCreate, type WebhookDeadLetter, type WebhookKeyForm, type WebhookStage, type WebhookSubscription, type WebhookTestResult, type WebhookUpdate, createCookieMunch, verifyWebhookSignature };
+export { type AbResult, type AccountOrg, type AccountOrgs, type AdPersonalizationInput, type AiInspectInput, type AiInspectResult, type ApiKey, type ApiKeyIssueInput, type ApiKeyIssued, type ApiKeyPrefix, type ApiKeyUpdate, type AppliedImport, type AssetUpload, type AuditEntry, type BannerRecord, type BannerSummary, type BlockedReport, type BrandExtractionResult, type BrandKit, type BrandKitCreate, type BrandSuggestion, type BulkSiteInput, type BulkSiteResult, type ButtonParityFinding, type ButtonParityLint, type ButtonParityScan, type CategorizedCookie, type ChildKeyInput, type ConfigChange, type ConfigDryRun, type ConfigWarning, type ConsentDay, type ConsentDecisionInput, type ConsentIngestInput, type ConsentLogRow, type CookieDeclaration, CookieMunchApiError, type CookieMunchClient, type CookieMunchOptions, type CspSources, type DeclarationDiff, type DeclarationDryRun, type DeclarationWarning, type DeclaredCookie, type DeclaredCookieInput, type DnsRecordInstruction, type DsarCreate, type DsarEraseResult, type DsarExecutor, type DsarExecutorCreated, type DsarExecutorDryRun, type DsarExecutorInput, type DsarExecutorPatch, type DsarExportResult, type DsarRequest, type DsarStatus, type DsarTask, type DsarTaskEvent, type DsarTaskExport, type DsarTaskLogEntry, type DsarTaskOutcome, type DsarType, type EnforcementRuleInput, type ExecutorProfile, type ExecutorTestInput, type ExecutorTestResult, type ExecutorWebhookDelivery, type ExecutorWebhookTestResult, type FlowIssue, type FlowOp, type FlowOpResponse, type FulfillmentOp, type Identifier, type Identity, type ImportedCookie, type ImportedDeclaration, type InstallSnippet, type LegalBasis, type LogQuery, type MailProvider, type MailProviderInput, type MailProviderKind, type MailProviderTestResult, type Member, type OptInMethod, type Org, type OrgUpdate, type ParityControlSummary, type PlanSource, type PolicyOptions, type PreferenceItem, type PreferenceRecord, type PreviewToken, type PreviewTokenOptions, type ProfileAttributeInput, type PublicDsarFiled, type PublicDsarPending, type PublicVerification, type PutConfigOptions, type RangeQuery, type Regulation, type RegulationSummary, type RegulatoryFeedResult, type ResellerChild, type ResellerChildCreate, type ResellerChildList, type ResellerChildPatch, type RetiredCookie, type RightKind, type RightsCaptcha, type RightsCaptchaInput, type RightsCaptchaProvider, type RightsIdentity, type RightsIdentityInput, type RightsIdentityType, type RightsLink, type RightsLinkInput, type RightsPageDocument, type RightsPageDomain, type RightsPageDomainList, type RightsPageDraft, type RightsPageDraftConflict, type RightsPageDryRun, type RightsPageIssue, type RightsPagePublishResult, type RightsPagePublished, type RightsPagePublisher, type RightsPageVersions, type RightsPageWriteOptions, type RiskScore, type RopaEntry, type RopaInput, type ScanResult, type ScanStatus, type ScoredVendor, type ScrollbarTheme, type SessionAnalysisInput, type SignedReceipt, type Site, type SiteConfig, type SiteCookie, type SiteCreate, type SiteFlow, type SnippetOptions, type SubscriptionTopicInput, type SuggestedRejectStyle, type SupportedLanguage, type Usage, type VendorInput, type VendorRecord, type VerifyResult, type VerifyWebhookInput, type WebhookCreate, type WebhookDeadLetter, type WebhookKeyForm, type WebhookStage, type WebhookSubscription, type WebhookTestResult, type WebhookUpdate, createCookieMunch, verifyWebhookSignature };

package/dist/index.js

@@ -104,8 +104,20 @@ function createCookieMunch(opts) {
       ),
       lintConfig: (cbid, config, opts2) => request("POST", `/sites/${enc(cbid)}/config/lint${qs({ replace: opts2?.replace ? 1 : void 0 })}`, config),
       cookies: (cbid) => get(`/sites/${enc(cbid)}/cookies`),
-      scan: (cbid) => request("POST", `/sites/${enc(cbid)}/scan`),
-      scanStatus: (cbid) => get(`/sites/${enc(cbid)}/scan`),
+      scan: (cbid, o) => request("POST", `/sites/${enc(cbid)}/scan${qs({ wait: o?.wait })}`),
+      scanStatus: (cbid, o) => get(`/sites/${enc(cbid)}/scan${qs({ wait: o?.wait })}`),
+      waitForScan: async (cbid, o) => {
+        const until = Date.now() + (o?.timeoutMs ?? 12e4);
+        for (; ; ) {
+          const left = until - Date.now();
+          const asked = Math.max(0, Math.min(6e4, left));
+          const t0 = Date.now();
+          const s = await get(`/sites/${enc(cbid)}/scan${qs({ wait: asked / 1e3 })}`);
+          if (s.status !== "scanning" || until - Date.now() <= 0) return s;
+          const early = Math.min(1e3, until - Date.now()) - (Date.now() - t0);
+          if (early > 0) await new Promise((r) => setTimeout(r, early));
+        }
+      },
       ab: (cbid) => get(`/sites/${enc(cbid)}/ab`),
       policy: (cbid, o) => request(
         "GET",
@@ -120,6 +132,11 @@ function createCookieMunch(opts) {
       importDeclaration: (cbid, data) => request("POST", `/sites/${enc(cbid)}/import`, { data }),
       applyImport: (cbid, data, o) => request("POST", `/sites/${enc(cbid)}/import${qs({ apply: "1", overwrite: o?.overwrite ? "1" : void 0 })}`, { data }),
       declareCookie: (cbid, name, input, o) => request("PUT", `/sites/${enc(cbid)}/cookies/${enc(name)}${qs({ dryRun: o?.dryRun ? "1" : void 0 })}`, input),
+      retireCookie: (cbid, name, input, o) => request("POST", `/sites/${enc(cbid)}/cookies/${enc(name)}/retire${qs({ dryRun: o?.dryRun ? "1" : void 0 })}`, input ?? {}),
+      unretireCookie: (async (cbid, name, o) => {
+        const out = await request("DELETE", `/sites/${enc(cbid)}/cookies/${enc(name)}/retire${qs({ dryRun: o?.dryRun ? "1" : void 0 })}`);
+        return o?.dryRun ? out : void 0;
+      }),
       undeclareCookie: (async (cbid, name, o) => {
         const out = await request("DELETE", `/sites/${enc(cbid)}/cookies/${enc(name)}${qs({ dryRun: o?.dryRun ? "1" : void 0 })}`);
         return o?.dryRun ? out : void 0;