@tryghost/adapter-base-scheduling 0.1.0 → 0.2.0

package/CHANGELOG.md

@@ -0,0 +1,15 @@
+# @tryghost/adapter-base-scheduling
+
+## 0.2.0
+
+### Minor Changes
+
+- Added support for idempotency key in scheduling adapter interface
+
+## 0.1.1
+
+### Patch Changes
+
+- Updated README documentation
+
+- Update @tryghost deps to latest

package/README.md

@@ -1,6 +1,65 @@
 # @tryghost/adapter-base-scheduling
 
-The adapter-base-scheduling package for Ghost.
+Base class for Ghost scheduling adapters. A scheduling adapter is responsible
+for firing Ghost's time-based jobs — publishing scheduled posts, sending
+scheduled newsletters, automations, gift reminders — by calling back into
+Ghost's API at the requested time.
+
+See the [Ghost adapters documentation](https://docs.ghost.org/config#adapters)
+for how adapters are configured and loaded.
+
+## Usage
+
+Install the base class alongside your adapter:
+
+```bash
+npm install @tryghost/adapter-base-scheduling
+```
+
+Extend `SchedulingBase` and implement every method listed in `requiredFns`:
+`run`, `schedule`, and `unschedule`. `register` and `rescheduleAll` are
+inherited from the base class.
+
+Each job has a `time` (unix timestamp), a `url` to call back (carrying a
+JWT-signed admin token), and an `extra` object holding the `httpMethod` to use.
+At `time`, the adapter fires the HTTP request described by the job.
+
+```js
+const {SchedulingBase} = require('@tryghost/adapter-base-scheduling');
+
+class MyScheduler extends SchedulingBase {
+    constructor(options) {
+        super();
+        // `options` is the settings block from your Ghost config
+    }
+
+    // Called on boot. Fire any jobs whose time has already passed and start
+    // watching for upcoming ones.
+    run() { /* ... */ }
+
+    // Queue `job` to fire at job.time via job.extra.httpMethod against job.url.
+    schedule(job) { /* ... */ }
+
+    // Remove a previously-scheduled job.
+    unschedule(job, options) { /* ... */ }
+}
+
+module.exports = MyScheduler;
+```
+
+### Installing and activating
+
+Place the adapter at `content/adapters/scheduling/MyScheduler/index.js` and
+activate it in your Ghost config:
+
+```json
+{
+    "scheduling": {
+        "active": "MyScheduler",
+        "MyScheduler": {}
+    }
+}
+```
 
 ## Develop
 
@@ -12,18 +71,11 @@ pnpm --filter @tryghost/adapter-base-scheduling test    # type-check + unit test
 pnpm --filter @tryghost/adapter-base-scheduling dev     # rebuild on change
 ```
 
-In-monorepo consumers resolve this package via the `source` export condition
-(raw `src/*.ts`, no build needed in dev/test). Production and any published
-tarball use the compiled `build/` output.
-
 This package is ESM-only and compiled with `tsc` (`module: nodenext`). Relative
 imports in `src/` must carry an explicit extension; write the real `.ts` one —
 `import {x} from './x.ts'` — and `tsc` rewrites it to `.js` on emit
 (`rewriteRelativeImportExtensions`).
 
-`ghost/core` is CommonJS but consumes this package via `require()`, which works
-on Ghost's Node version (22.13+/24) through Node's `require(esm)` support. That
-support has one hard constraint: **no top-level `await`** anywhere in this
-package's module graph — it makes the graph async and `require()` of it throws
-`ERR_REQUIRE_ASYNC_MODULE`. Keep module-level initialization synchronous. (An
-ESLint rule enforces this.)
+# Copyright & License
+
+Copyright (c) 2013-2026 Ghost Foundation - Released under the [MIT license](LICENSE). Ghost and the Ghost Logo are trademarks of Ghost Foundation Ltd. Please see our [trademark policy](https://ghost.org/trademark/) for info on acceptable usage.

package/build/base.d.ts

@@ -8,6 +8,7 @@ export interface SchedulerJob {
     url: string;
     extra: {
         httpMethod: string;
+        idempotencyKey?: string;
         oldTime?: number | null;
     };
 }

package/build/base.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../src/base.ts"],"names":[],"mappings":"AAGA;;;;GAIG;AACH,MAAM,WAAW,YAAY;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE;QACH,UAAU,EAAE,MAAM,CAAC;QACnB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC3B,CAAC;CACL;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC3B,WAAW,CAAC,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAC,CAAC;CAC/C;AAED;;;;;GAKG;AACH,MAAM,WAAW,WAAW;IACxB,aAAa,CAAC,IAAI,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACvD;AAED;;;;;GAKG;AACH,MAAM,WAAW,gBAAgB;IAC7B,GAAG,IAAI,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5B,QAAQ,CAAC,GAAG,EAAE,YAAY,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAClD,UAAU,CAAC,GAAG,EAAE,YAAY,EAAE,IAAI,CAAC,EAAE;QAAC,SAAS,CAAC,EAAE,OAAO,CAAA;KAAC,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAClF,QAAQ,CAAC,WAAW,EAAE,WAAW,GAAG,IAAI,CAAC;CAC5C;AAED,8BAAsB,cAAe,YAAW,gBAAgB;;IAC5D,SAAiB,WAAW,EAAE,SAAS,CAAC,KAAK,EAAE,UAAU,EAAE,YAAY,CAAC,CAAC;IAIzE,cAKC;IAED,QAAQ,CAAC,WAAW,EAAE,WAAW,QAEhC;IAED;;;OAGG;IACG,aAAa,CAAC,IAAI,CAAC,EAAE,cAAc,yCAiBxC;IAED,QAAQ,CAAC,GAAG,IAAI,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACrC,QAAQ,CAAC,QAAQ,CAAC,GAAG,EAAE,YAAY,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAC1D,QAAQ,CAAC,UAAU,CAAC,GAAG,EAAE,YAAY,EAAE,IAAI,CAAC,EAAE;QAAC,SAAS,CAAC,EAAE,OAAO,CAAA;KAAC,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CAC7F"}
+{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../src/base.ts"],"names":[],"mappings":"AAGA;;;;GAIG;AACH,MAAM,WAAW,YAAY;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE;QACH,UAAU,EAAE,MAAM,CAAC;QACnB,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC3B,CAAC;CACL;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC3B,WAAW,CAAC,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAC,CAAC;CAC/C;AAED;;;;;GAKG;AACH,MAAM,WAAW,WAAW;IACxB,aAAa,CAAC,IAAI,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACvD;AAED;;;;;GAKG;AACH,MAAM,WAAW,gBAAgB;IAC7B,GAAG,IAAI,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5B,QAAQ,CAAC,GAAG,EAAE,YAAY,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAClD,UAAU,CAAC,GAAG,EAAE,YAAY,EAAE,IAAI,CAAC,EAAE;QAAC,SAAS,CAAC,EAAE,OAAO,CAAA;KAAC,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAClF,QAAQ,CAAC,WAAW,EAAE,WAAW,GAAG,IAAI,CAAC;CAC5C;AAED,8BAAsB,cAAe,YAAW,gBAAgB;;IAC5D,SAAiB,WAAW,EAAE,SAAS,CAAC,KAAK,EAAE,UAAU,EAAE,YAAY,CAAC,CAAC;IAIzE,cAKC;IAED,QAAQ,CAAC,WAAW,EAAE,WAAW,QAEhC;IAED;;;OAGG;IACG,aAAa,CAAC,IAAI,CAAC,EAAE,cAAc,yCAiBxC;IAED,QAAQ,CAAC,GAAG,IAAI,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACrC,QAAQ,CAAC,QAAQ,CAAC,GAAG,EAAE,YAAY,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAC1D,QAAQ,CAAC,UAAU,CAAC,GAAG,EAAE,YAAY,EAAE,IAAI,CAAC,EAAE;QAAC,SAAS,CAAC,EAAE,OAAO,CAAA;KAAC,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CAC7F"}

package/build/base.js.map

@@ -1 +1 @@
-{"version":3,"file":"base.js","sourceRoot":"","sources":["../src/base.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,mBAAmB,CAAC;AAiDxC,MAAM,OAAgB,cAAc;IAGhC,aAAa,GAAG,IAAI,GAAG,EAAe,CAAC;IAEvC;QACI,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,aAAa,EAAE;YACvC,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,UAAU,EAAE,YAAY,CAAC,CAAC;YACvD,QAAQ,EAAE,KAAK;SAClB,CAAC,CAAA;IACN,CAAC;IAED,QAAQ,CAAC,WAAwB;QAC7B,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IACxC,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,aAAa,CAAC,IAAqB;QACrC,MAAM,YAAY,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACpD,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,UAAU,CACpC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAC/C,CAAC;QAEF,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YAC1B,IAAI,MAAM,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;gBAC/B,OAAO,CAAC,KAAK,CAAC;oBACV,KAAK,EAAE,EAAC,IAAI,EAAE,iCAAiC,EAAC;oBAChD,GAAG,EAAE,MAAM,CAAC,MAAM;oBAClB,WAAW,EAAE,YAAY,CAAC,CAAC,CAAE,CAAC,WAAW,EAAE,IAAI,IAAI,SAAS;iBAC/D,EAAE,oBAAoB,CAAC,CAAC;YAC7B,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,OAAO,OAAO,CAAC;IACnB,CAAC;CAKJ"}
+{"version":3,"file":"base.js","sourceRoot":"","sources":["../src/base.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,mBAAmB,CAAC;AAkDxC,MAAM,OAAgB,cAAc;IAGhC,aAAa,GAAG,IAAI,GAAG,EAAe,CAAC;IAEvC;QACI,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,aAAa,EAAE;YACvC,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,UAAU,EAAE,YAAY,CAAC,CAAC;YACvD,QAAQ,EAAE,KAAK;SAClB,CAAC,CAAA;IACN,CAAC;IAED,QAAQ,CAAC,WAAwB;QAC7B,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IACxC,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,aAAa,CAAC,IAAqB;QACrC,MAAM,YAAY,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACpD,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,UAAU,CACpC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAC/C,CAAC;QAEF,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YAC1B,IAAI,MAAM,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;gBAC/B,OAAO,CAAC,KAAK,CAAC;oBACV,KAAK,EAAE,EAAC,IAAI,EAAE,iCAAiC,EAAC;oBAChD,GAAG,EAAE,MAAM,CAAC,MAAM;oBAClB,WAAW,EAAE,YAAY,CAAC,CAAC,CAAE,CAAC,WAAW,EAAE,IAAI,IAAI,SAAS;iBAC/D,EAAE,oBAAoB,CAAC,CAAC;YAC7B,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,OAAO,OAAO,CAAC;IACnB,CAAC;CAKJ"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tryghost/adapter-base-scheduling",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "The adapter-base-scheduling package for Ghost.",
   "type": "module",
   "repository": {
@@ -22,7 +22,7 @@
     "build"
   ],
   "dependencies": {
-    "@tryghost/logging": "4.2.1"
+    "@tryghost/logging": "5.3.0"
   },
   "scripts": {
     "build": "tsc",