@tryghost/cache-purge 0.3.3 → 0.3.5

package/README.md

@@ -1,32 +1,46 @@
 # Cache Purge
 
+Purge Fastly cache entries through Ghost(Pro)'s signed cache purge endpoint.
+Pass an HMAC key, the purge service host, and either an `id` or `domain` plus a
+cache `type`; the package signs the request with `@tryghost/signed-request`.
+
 ## Install
 
 `npm install @tryghost/cache-purge --save`
 
 or
 
-`yarn add @tryghost/cache-purge`
+`pnpm add @tryghost/cache-purge`
 
 ## Usage
 
+```js
+const cachePurge = require('@tryghost/cache-purge');
+
+await cachePurge(hmacKey, 'cache.example.com', {
+    domain: 'example.com',
+    type: 'site',
+    source: 'admin',
+});
+```
+
 ## Develop
 
-This is a mono repository, managed with [lerna](https://lernajs.io/).
+This is a monorepo package, managed from the repo root.
 
 Follow the instructions for the top-level repo.
 
 1. `git clone` this repo & `cd` into it as usual
-2. Run `yarn` to install top-level dependencies.
+2. Run `pnpm install` to install top-level dependencies.
 
 ## Run
 
-- `yarn dev`
+- `pnpm --filter @tryghost/cache-purge dev`
 
 ## Test
 
-- `yarn lint` run just eslint
-- `yarn test` run lint and tests
+- `pnpm --filter @tryghost/cache-purge lint` runs lint
+- `pnpm --filter @tryghost/cache-purge test` runs lint and tests
 
 # Copyright & License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tryghost/cache-purge",
-  "version": "0.3.3",
+  "version": "0.3.5",
   "license": "MIT",
   "author": "Ghost Foundation",
   "repository": {
@@ -14,16 +14,18 @@
   ],
   "main": "./lib/cache-purge.js",
   "dependencies": {
-    "@tryghost/signed-request": "^0.3.3"
+    "@tryghost/signed-request": "^0.3.5"
   },
   "devDependencies": {
-    "mocha": "11.7.5",
     "should": "13.2.3",
-    "sinon": "21.0.3"
+    "sinon": "22.0.0"
+  },
+  "engines": {
+    "node": ">=20.20.0"
   },
   "scripts": {
     "dev": "echo \"Implement me!\"",
-    "test": "NODE_ENV=testing mocha './test/**/*.test.js'",
+    "test": "NODE_ENV=testing vitest run --coverage",
     "lint": "oxlint -c ../../.oxlintrc.json .",
     "posttest": "pnpm lint"
   }