@cookiemunch/sdk 0.3.0 → 0.4.1

package/CHANGELOG.md

@@ -0,0 +1,44 @@
+# Changelog: @cookiemunch/sdk
+
+Every published release, newest first. Dates are the day the version was cut.
+
+## 0.4.1 (2026-10-22)
+
+- Added: the `referally` cookie preset (`cookieDomain`, `cookieDays`, `category` parameters on `applyCookiePreset`).
+- Added: every request sends `User-Agent: cookiemunch-js/<version>`; set your own with the `userAgent` option.
+
+## 0.4.0 (2026-10-19)
+
+- Added: site PATCH (rename or move a site, keeping its cbid), integration health, `provision` and partner links.
+- Added: the executor presets and canary health checks for connected systems; `connectExecutor` takes a `preset`.
+- Added: declaration presets for the platforms a site is built on, observed-cookie removal and storage types on declarations.
+- Added: opt-in strict writes and API key hygiene (`X-14`, `X-15`).
+
+## 0.3.0 (2026-10-15)
+
+- Added: `retireCookie` and `unretireCookie`.
+- Added: `scan` can wait for the result, and `waitForScan`.
+
+## 0.2.0 (2026-10-15)
+
+- Added: executor webhook test and delivery log, with dry runs.
+- Added: `purposes` (per-language text) and `dryRun` on declared cookies; `?lang=` on the public cookie feed.
+- Added: document verification on rights-request intake answers (`trustEmailClaim`, `oidc_jwt`).
+- Added: rights-page identity configuration.
+- Fixed: design warnings say what happened and notices are not blamed on Accept.
+
+## 0.1.2 (2026-10-15)
+
+- Changed: the package builds standalone from its public repository and is published with npm provenance.
+
+## 0.1.1 (2026-10-14)
+
+- Added: `declareCookie`, bulk declare, `undeclareCookie` and applying a scan import.
+- Added: `PUT ?keep=unspecified` and `null` in a PATCH removes the key.
+- Added: `dryRunConfig`, and `lintConfig` with `designWarnings` on every config read and write.
+- Added: `client.rightsPage`: draft, dry run, publish, versions, rollback (with `baseUpdatedAt` conflicts), custom domains, mail provider and account-linked rights links.
+- Fixed: per-claim CNAME targets; a hostname already pointing at us is proven with the TXT token.
+
+## 0.1.0 (2026-10-14)
+
+- First release: a typed client for the Cookie Munch Developer API (`/v1`): sites, config, consent log and stats, DSAR, vendors and RoPA.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Cookie Munch
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.cjs

@@ -22,6 +22,7 @@ var src_exports = {};
 __export(src_exports, {
   CONSENT_COOKIE_NAME: () => CONSENT_COOKIE_NAME,
   CookieMunchApiError: () => CookieMunchApiError,
+  SDK_VERSION: () => SDK_VERSION,
   createCookieMunch: () => createCookieMunch,
   getConsent: () => getConsent,
   isAllowed: () => isAllowed,
@@ -148,6 +149,7 @@ function verifyWebhookSignature(input) {
 }
 
 // src/index.ts
+var SDK_VERSION = "0.4.1";
 var CookieMunchApiError = class extends Error {
   constructor(status, message, code, body) {
     super(message);
@@ -174,7 +176,8 @@ function createCookieMunch(opts) {
   const doFetch = opts.fetch ?? globalThis.fetch;
   if (!doFetch) throw new Error("No fetch available; pass { fetch } in CookieMunchOptions.");
   async function request(method, path, body, raw = false) {
-    const headers = { Authorization: `Bearer ${opts.apiKey}` };
+    const headers = { Authorization: `Bearer ${opts.apiKey}`, "User-Agent": opts.userAgent ?? `cookiemunch-js/${SDK_VERSION}` };
+    if (opts.strictUnknownFields && method !== "GET") headers["Prefer"] = "strict-unknown-fields";
     const init = { method, headers };
     if (body !== void 0) {
       headers["Content-Type"] = "application/json";
@@ -212,9 +215,13 @@ function createCookieMunch(opts) {
       list: () => get("/sites"),
       create: (input) => request("POST", "/sites", input),
       get: (cbid) => get(`/sites/${enc(cbid)}`),
+      update: (cbid, patch, o) => request("PATCH", `/sites/${enc(cbid)}${qs({ dryRun: o?.dryRun ? "1" : void 0 })}`, patch),
       delete: async (cbid) => {
         await request("DELETE", `/sites/${enc(cbid)}`);
       },
+      listPartners: (cbid) => get(`/sites/${enc(cbid)}/partners`),
+      linkPartner: (cbid, input, o) => request("POST", `/sites/${enc(cbid)}/partners${qs({ dryRun: o?.dryRun ? "1" : void 0 })}`, input),
+      unlinkPartner: (cbid, linkId) => request("DELETE", `/sites/${enc(cbid)}/partners/${enc(linkId)}`),
       getConfig: (cbid) => get(`/sites/${enc(cbid)}/config`),
       putConfig: (cbid, config, opts2) => request("PUT", `/sites/${enc(cbid)}/config${qs({ keep: opts2?.keep })}`, config),
       patchConfig: (cbid, config) => request("PATCH", `/sites/${enc(cbid)}/config`, config),
@@ -258,6 +265,14 @@ function createCookieMunch(opts) {
         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;
       }),
+      cookiePresets: (cbid) => get(`/sites/${enc(cbid)}/cookies/presets`),
+      applyCookiePreset: (cbid, vendor, params, o) => request("PUT", `/sites/${enc(cbid)}/cookies/presets/${enc(vendor)}${qs({ dryRun: o?.dryRun ? "1" : void 0 })}`, params ?? {}),
+      removeCookiePreset: (cbid, vendor, o) => request("DELETE", `/sites/${enc(cbid)}/cookies/presets/${enc(vendor)}${qs({ dryRun: o?.dryRun ? "1" : void 0 })}`),
+      deleteObservedCookie: (async (cbid, name, o) => {
+        const out = await request("DELETE", `/sites/${enc(cbid)}/observed-cookies/${enc(name)}${qs({ dryRun: o?.dryRun ? "1" : void 0 })}`);
+        return o?.dryRun ? out : void 0;
+      }),
+      purgeObservedCookies: (cbid, input, o) => request("POST", `/sites/${enc(cbid)}/observed-cookies/purge${qs({ dryRun: o?.dryRun ? "1" : void 0 })}`, input),
       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;
@@ -304,7 +319,7 @@ function createCookieMunch(opts) {
       list: () => get("/dsar"),
       get: (id) => get(`/dsar/${enc(id)}`),
       create: (input) => request("POST", "/dsar", input),
-      advance: (id, toStatus) => request("POST", `/dsar/${enc(id)}/advance`, { toStatus }),
+      advance: (id, toStatus, opts2) => request("POST", `/dsar/${enc(id)}/advance`, { toStatus, ...opts2?.messageToSubject !== void 0 ? { messageToSubject: opts2.messageToSubject } : {} }),
       response: (id) => request("GET", `/dsar/${enc(id)}/response`, void 0, true),
       erase: (id, cbid, stamp) => request("POST", `/dsar/${enc(id)}/erase`, { cbid, stamp }),
       export: (id, cbid, stamp) => request("POST", `/dsar/${enc(id)}/export`, { cbid, stamp }),
@@ -418,6 +433,9 @@ function createCookieMunch(opts) {
       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),
+      executorPresets: () => get("/dsar/executors/presets"),
+      upgradeExecutorPreset: (id, input = {}) => request("POST", `/dsar/executors/${enc(id)}/upgrade-preset`, input),
+      dryRunUpgradeExecutorPreset: (id, input = {}) => request("POST", `/dsar/executors/${enc(id)}/upgrade-preset?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`),
@@ -446,9 +464,12 @@ function createCookieMunch(opts) {
         await request("DELETE", `/keys/${enc(prefix)}`);
       },
       roll: (prefix) => request("POST", `/keys/${enc(prefix)}/roll`),
-      update: (prefix, patch) => request("PATCH", `/keys/${enc(prefix)}`, patch)
+      update: (prefix, patch) => request("PATCH", `/keys/${enc(prefix)}`, patch),
+      report: (o) => get(`/keys/report${qs({ unusedDays: o?.unusedDays, expiringDays: o?.expiringDays })}`)
     },
     usage: () => get("/usage"),
+    integrationHealth: (cbid) => get(`/integration-health${qs({ cbid })}`),
+    provision: (input, o) => request("POST", `/provision${qs({ dryRun: o?.dryRun ? "1" : void 0 })}`, input),
     org: {
       get: () => get("/org"),
       update: (patch) => request("PATCH", "/org", patch),
@@ -539,6 +560,7 @@ function createCookieMunch(opts) {
 0 && (module.exports = {
   CONSENT_COOKIE_NAME,
   CookieMunchApiError,
+  SDK_VERSION,
   createCookieMunch,
   getConsent,
   isAllowed,