@cookiemunch/sdk 0.1.1 → 0.3.0

package/README.md

@@ -9,7 +9,7 @@ import { createCookieMunch, CookieMunchApiError } from '@cookiemunch/sdk';
 
 const fc = createCookieMunch({
   apiKey: process.env.COOKIEMUNCH_API_KEY!, // "fck_…"
-  baseUrl: 'https://cmp.example.com',         // "/v1" is appended automatically
+  baseUrl: 'https://api.cookiemunch.net',     // "/v1" is appended automatically
 });
 
 const sites = await fc.sites.list();
@@ -30,11 +30,18 @@ runtimes; it defaults to the global `fetch`.
 
 - `me()`
 - `sites.list() / create(input) / get(cbid) / delete(cbid) / getConfig(cbid) / putConfig(cbid, config)`
+- `sites.lintConfig(cbid, config, { replace? })` — consent-button parity: is Accept all pushed harder than Reject all? Returns `designWarnings`, `score`, `suggestedReject`; nothing is saved. Every config read/write also carries `designWarnings`.
 - `consent.stats(cbid, {from?,to?}) / log(cbid, {from?,to?,limit?}) / export(cbid, {from?,to?}) / receipt(cbid, stamp)`
 - `dsar.list() / create(input) / advance(id, toStatus)`
 - `vendors.list() / create(input)`
 - `ropa.list() / create(input)`
 - `webhooks.list() / create(input)`
+- `rightsPage.get(cbid) / put(cbid, page, {baseUpdatedAt?}) / patch(cbid, patch, {baseUpdatedAt?}) / dryRun(cbid, page, {mode?}) / getPublished(cbid) / publish(cbid, {baseUpdatedAt?}) / versions(cbid) / rollback(cbid, version, {baseUpdatedAt?})` — pass the draft's `updatedAt` as `baseUpdatedAt` so a newer save is a 409 `draft_conflict`, never overwritten or published unseen; a rollback replaces the draft
+- `rightsPage.listDomains(cbid) / addDomain(cbid, hostname) / verifyDomain(cbid, hostname) / removeDomain(cbid, hostname)` — the rights page on your own hostname
+- `rightsLinks.create(cbid, { subject, rights?, ttlSeconds? })` — a signed, single-use rights-page link for a signed-in person
+- `org.mailProvider.get() / set(input) / test(to?) / remove()` — your own provider for rights-request mail
+
+These are the most used; the client covers every `/v1` operation (see the typed `CookieMunchClient`).
 
 `export()` returns the raw CSV string; all other methods return parsed JSON. Any
 non-2xx response throws a `CookieMunchApiError { status, code?, message }`. Error `code`

package/dist/index.cjs

@@ -149,13 +149,15 @@ function verifyWebhookSignature(input) {
 
 // src/index.ts
 var CookieMunchApiError = class extends Error {
-  constructor(status, message, code) {
+  constructor(status, message, code, body) {
     super(message);
     this.name = "CookieMunchApiError";
     this.status = status;
     if (code !== void 0) this.code = code;
+    if (body !== void 0) this.body = body;
   }
 };
+var withBase = (doc, opts) => opts?.baseUpdatedAt !== void 0 ? { ...doc, baseUpdatedAt: opts.baseUpdatedAt } : doc;
 function qs(query) {
   if (!query) return "";
   const parts = [];
@@ -182,13 +184,15 @@ function createCookieMunch(opts) {
     if (!res.ok) {
       let message = `request failed with status ${res.status}`;
       let code;
+      let parsed;
       try {
         const data = await res.json();
+        parsed = data;
         if (typeof data.error === "string") message = data.error;
         if (typeof data.code === "string") code = data.code;
       } catch {
       }
-      throw new CookieMunchApiError(res.status, message, code);
+      throw new CookieMunchApiError(res.status, message, code, parsed);
     }
     if (res.status === 204) return void 0;
     if (raw) return res.text();
@@ -219,9 +223,22 @@ function createCookieMunch(opts) {
         `/sites/${enc(cbid)}/config${qs({ dryRun: 1, keep: opts2?.mode === "put" ? opts2.keep : void 0 })}`,
         config
       ),
+      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",
@@ -235,11 +252,17 @@ function createCookieMunch(opts) {
       blocked: (cbid) => get(`/sites/${enc(cbid)}/blocked`),
       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) => request("PUT", `/sites/${enc(cbid)}/cookies/${enc(name)}`, input),
-      undeclareCookie: async (cbid, name) => {
-        await request("DELETE", `/sites/${enc(cbid)}/cookies/${enc(name)}`);
-      },
-      declareCookies: (cbid, cookies, o) => request("PUT", `/sites/${enc(cbid)}/cookies`, { cookies, ...o?.replace ? { replace: true } : {} }),
+      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;
+      }),
+      declareCookies: (cbid, cookies, o) => request("PUT", `/sites/${enc(cbid)}/cookies${qs({ dryRun: o?.dryRun ? "1" : void 0 })}`, { cookies, ...o?.replace ? { replace: true } : {} }),
       snippet: (cbid, opts2) => get(`/sites/${enc(cbid)}/snippet${qs({ blockingmode: opts2?.blockingMode, culture: opts2?.culture })}`),
       previewToken: (cbid, o) => request("POST", `/sites/${enc(cbid)}/preview-token`, o ?? {}),
       verify: (cbid, method) => request("POST", `/sites/${enc(cbid)}/verify`, { method }),
@@ -306,6 +329,22 @@ function createCookieMunch(opts) {
         await request("DELETE", `/brand-kits/${enc(id)}`);
       }
     },
+    rightsPage: {
+      get: (cbid) => get(`/sites/${enc(cbid)}/rights-page`),
+      put: (cbid, page, opts2) => request("PUT", `/sites/${enc(cbid)}/rights-page`, withBase(page, opts2)),
+      patch: (cbid, patch, opts2) => request("PATCH", `/sites/${enc(cbid)}/rights-page`, withBase(patch, opts2)),
+      dryRun: (cbid, page, opts2) => request(opts2?.mode === "put" ? "PUT" : "PATCH", `/sites/${enc(cbid)}/rights-page?dryRun=1`, page),
+      getPublished: (cbid) => get(`/sites/${enc(cbid)}/rights-page/published`),
+      publish: (cbid, opts2) => request("POST", `/sites/${enc(cbid)}/rights-page/publish`, withBase({}, opts2)),
+      versions: (cbid) => get(`/sites/${enc(cbid)}/rights-page/versions`),
+      rollback: (cbid, version, opts2) => request("POST", `/sites/${enc(cbid)}/rights-page/rollback`, withBase({ version }, opts2)),
+      listDomains: (cbid) => get(`/sites/${enc(cbid)}/rights-page/domains`),
+      addDomain: (cbid, hostname) => request("POST", `/sites/${enc(cbid)}/rights-page/domains`, { hostname }),
+      verifyDomain: (cbid, hostname) => request("POST", `/sites/${enc(cbid)}/rights-page/domains/${enc(hostname)}/verify`),
+      removeDomain: async (cbid, hostname) => {
+        await request("DELETE", `/sites/${enc(cbid)}/rights-page/domains/${enc(hostname)}`);
+      }
+    },
     identity: {
       resolve: (identifiers) => request("POST", "/identity/resolve", { identifiers }),
       link: (identifiers) => request("POST", "/identity/link", { identifiers }),
@@ -378,6 +417,10 @@ function createCookieMunch(opts) {
       executors: () => get("/dsar/executors"),
       connectExecutor: (input) => request("POST", "/dsar/executors", input),
       updateExecutor: (id, patch) => request("PATCH", `/dsar/executors/${enc(id)}`, patch),
+      dryRunConnectExecutor: (input) => request("POST", "/dsar/executors?dryRun=1", input),
+      dryRunUpdateExecutor: (id, patch) => request("PATCH", `/dsar/executors/${enc(id)}?dryRun=1`, patch),
+      testExecutorWebhook: (id, delivery) => request("POST", `/dsar/executors/${enc(id)}/webhook/test`, delivery),
+      executorWebhookDeliveries: (id) => get(`/dsar/executors/${enc(id)}/webhook/deliveries`),
       disconnectExecutor: async (id) => {
         await request("DELETE", `/dsar/executors/${enc(id)}`);
       },
@@ -408,7 +451,25 @@ function createCookieMunch(opts) {
     usage: () => get("/usage"),
     org: {
       get: () => get("/org"),
-      update: (patch) => request("PATCH", "/org", patch)
+      update: (patch) => request("PATCH", "/org", patch),
+      mailProvider: {
+        get: () => get("/org/mail-provider"),
+        set: (input) => request("PUT", "/org/mail-provider", input),
+        remove: async () => {
+          await request("DELETE", "/org/mail-provider");
+        },
+        test: (to) => request("POST", "/org/mail-provider/test", to ? { to } : {})
+      },
+      rightsCaptcha: {
+        get: () => get("/org/rights-captcha"),
+        set: (input) => request("PUT", "/org/rights-captcha", input),
+        remove: () => request("DELETE", "/org/rights-captcha")
+      },
+      rightsIdentity: {
+        get: () => get("/org/rights-identity"),
+        set: (input) => request("PUT", "/org/rights-identity", input),
+        remove: () => request("DELETE", "/org/rights-identity")
+      }
     },
     audit: (limit) => get(`/audit${qs({ limit })}`),
     assets: {
@@ -444,6 +505,19 @@ function createCookieMunch(opts) {
       deadLetters: () => get("/webhooks/dead-letters"),
       replayDeadLetter: (id) => request("POST", `/webhooks/dead-letters/${enc(id)}/replay`)
     },
+    rightsLinks: {
+      create: (cbid, input) => request("POST", `/sites/${enc(cbid)}/rights-links`, input)
+    },
+    rightsCaptcha: {
+      get: (cbid) => get(`/sites/${enc(cbid)}/rights-captcha`),
+      set: (cbid, input) => request("PUT", `/sites/${enc(cbid)}/rights-captcha`, input),
+      remove: (cbid) => request("DELETE", `/sites/${enc(cbid)}/rights-captcha`)
+    },
+    rightsIdentity: {
+      get: (cbid) => get(`/sites/${enc(cbid)}/rights-identity`),
+      set: (cbid, input) => request("PUT", `/sites/${enc(cbid)}/rights-identity`, input),
+      remove: (cbid) => request("DELETE", `/sites/${enc(cbid)}/rights-identity`)
+    },
     subjects: {
       consent: (subjectId) => get(`/subjects/${enc(subjectId)}/consent`)
     },