@tryghost/cache-purge 0.3.7 → 1.0.0

package/README.md

@@ -14,6 +14,26 @@ or
 
 ## Usage
 
+The package ships TypeScript types and both ESM and CommonJS builds.
+
+### ESM / TypeScript
+
+```ts
+import cachePurge from '@tryghost/cache-purge';
+
+await cachePurge(hmacKey, 'cache.example.com', {
+    domain: 'example.com',
+    type: 'site',
+    source: 'admin',
+});
+```
+
+The module's single export is a callable function (it uses `export =`), so the
+default import above requires `esModuleInterop` (or `allowSyntheticDefaultImports`).
+Without those flags, import it with `import cachePurge = require('@tryghost/cache-purge')`.
+
+### CommonJS
+
 ```js
 const cachePurge = require('@tryghost/cache-purge');
 

package/cjs/index.js

@@ -0,0 +1,39 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var signedRequest = __toESM(require("@tryghost/signed-request"));
+function exec(hmac, server, options) {
+  if (!options.protocol) {
+    options.protocol = "https://";
+  }
+  const useId = Boolean(options.id);
+  const identifier = useId ? options.id : options.domain;
+  if (!identifier) {
+    throw new Error('A "domain" or "id" is required to purge the cache');
+  }
+  const target = `${useId ? "id" : "domain"}=${encodeURIComponent(identifier)}`;
+  const path = `/cache?${target}&type=${encodeURIComponent(options.type)}`;
+  return signedRequest.exec(hmac, server, path, options);
+}
+exec.exec = exec;
+module.exports = exec;

package/es/index.js

@@ -0,0 +1,29 @@
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __commonJS = (cb, mod) => function __require() {
+  try {
+    return mod || (0, cb[__getOwnPropNames(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports;
+  } catch (e) {
+    throw mod = 0, e;
+  }
+};
+import * as signedRequest from "@tryghost/signed-request";
+var require_index = __commonJS({
+  "src/index.ts"(exports, module) {
+    function exec(hmac, server, options) {
+      if (!options.protocol) {
+        options.protocol = "https://";
+      }
+      const useId = Boolean(options.id);
+      const identifier = useId ? options.id : options.domain;
+      if (!identifier) {
+        throw new Error('A "domain" or "id" is required to purge the cache');
+      }
+      const target = `${useId ? "id" : "domain"}=${encodeURIComponent(identifier)}`;
+      const path = `/cache?${target}&type=${encodeURIComponent(options.type)}`;
+      return signedRequest.exec(hmac, server, path, options);
+    }
+    exec.exec = exec;
+    module.exports = exec;
+  }
+});
+export default require_index();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tryghost/cache-purge",
-  "version": "0.3.7",
+  "version": "1.0.0",
   "license": "MIT",
   "author": "Ghost Foundation",
   "repository": {
@@ -8,28 +8,50 @@
     "url": "ssh://git@github.com/TryGhost/Pro-Packages",
     "directory": "packages/cache-purge"
   },
+  "source": "src/index.ts",
   "files": [
-    "index.js",
-    "lib"
+    "cjs",
+    "es",
+    "types",
+    "src"
   ],
-  "main": "./lib/cache-purge.js",
+  "main": "cjs/index.js",
+  "module": "es/index.js",
+  "types": "types/index.d.ts",
   "publishConfig": {
     "access": "public"
   },
   "dependencies": {
-    "@tryghost/signed-request": "^0.3.7"
+    "@tryghost/signed-request": "^1.0.0"
   },
   "devDependencies": {
-    "should": "13.2.3",
-    "sinon": "22.0.0"
+    "@types/node": "25.9.4",
+    "esbuild": "0.28.1",
+    "typescript": "6.0.3"
   },
   "engines": {
     "node": ">=20.20.0"
   },
+  "nx": {
+    "targets": {
+      "build": {
+        "outputs": [
+          "{projectRoot}/cjs",
+          "{projectRoot}/es",
+          "{projectRoot}/types"
+        ]
+      }
+    }
+  },
   "scripts": {
     "dev": "echo \"Implement me!\"",
+    "pretest": "NODE_ENV=production pnpm run build",
+    "build": "pnpm run build:cjs && pnpm run build:es && pnpm run build:types",
+    "build:cjs": "esbuild src/index.ts --target=es2020 --outdir=cjs --format=cjs",
+    "build:es": "esbuild src/index.ts --target=es2020 --outdir=es --format=esm",
+    "build:types": "tsc --emitDeclarationOnly --declaration --declarationMap --outDir types",
     "test": "NODE_ENV=testing vitest run --coverage",
     "lint": "oxlint -c ../../.oxlintrc.json .",
-    "posttest": "pnpm lint"
+    "posttest": "pnpm run lint"
   }
 }

package/src/index.ts

@@ -0,0 +1,38 @@
+import * as signedRequest from '@tryghost/signed-request';
+import type { Response, SignedRequestOptions } from '@tryghost/signed-request';
+
+interface CachePurgeOptions extends Omit<SignedRequestOptions, 'protocol'> {
+    /** Request protocol. Defaults to `https://` when omitted. */
+    protocol?: string;
+    /** Cache type to purge, e.g. `all`, `page`, or `site`. */
+    type: string;
+    /** Site id to purge. Takes precedence over `domain` when set. */
+    id?: string;
+    /** Domain to purge. Used when no `id` is provided. */
+    domain?: string;
+}
+
+function exec<T = unknown>(
+    hmac: string,
+    server: string,
+    options: CachePurgeOptions,
+): Promise<Response<T>> {
+    if (!options.protocol) {
+        options.protocol = 'https://';
+    }
+
+    const useId = Boolean(options.id);
+    const identifier = useId ? options.id : options.domain;
+    if (!identifier) {
+        throw new Error('A "domain" or "id" is required to purge the cache');
+    }
+
+    const target = `${useId ? 'id' : 'domain'}=${encodeURIComponent(identifier)}`;
+    const path = `/cache?${target}&type=${encodeURIComponent(options.type)}`;
+
+    return signedRequest.exec<T>(hmac, server, path, options);
+}
+
+exec.exec = exec;
+
+export = exec;

package/types/index.d.ts

@@ -0,0 +1,17 @@
+import type { Response, SignedRequestOptions } from '@tryghost/signed-request';
+interface CachePurgeOptions extends Omit<SignedRequestOptions, 'protocol'> {
+    /** Request protocol. Defaults to `https://` when omitted. */
+    protocol?: string;
+    /** Cache type to purge, e.g. `all`, `page`, or `site`. */
+    type: string;
+    /** Site id to purge. Takes precedence over `domain` when set. */
+    id?: string;
+    /** Domain to purge. Used when no `id` is provided. */
+    domain?: string;
+}
+declare function exec<T = unknown>(hmac: string, server: string, options: CachePurgeOptions): Promise<Response<T>>;
+declare namespace exec {
+    var exec: typeof import(".");
+}
+export = exec;
+//# sourceMappingURL=index.d.ts.map

package/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAE/E,UAAU,iBAAkB,SAAQ,IAAI,CAAC,oBAAoB,EAAE,UAAU,CAAC;IACtE,6DAA6D;IAC7D,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,0DAA0D;IAC1D,IAAI,EAAE,MAAM,CAAC;IACb,iEAAiE;IACjE,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,sDAAsD;IACtD,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,iBAAS,IAAI,CAAC,CAAC,GAAG,OAAO,EACrB,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,iBAAiB,GAC3B,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAetB;kBAnBQ,IAAI;;;AAuBb,SAAS,IAAI,CAAC"}

package/lib/cache-purge.js

@@ -1,13 +0,0 @@
-const signedRequest = require('@tryghost/signed-request');
-const exec = function (hmac, server, options) {
-    if (!options.protocol) {
-        options.protocol = 'https://';
-    }
-    let path = '/cache?';
-    path += options.id ? 'id=' + options.id : 'domain=' + options.domain;
-    path += '&type=' + options.type;
-
-    return signedRequest.exec(hmac, server, path, options);
-};
-module.exports = exec;
-module.exports.exec = exec;