@tryghost/adapter-base-scheduling 0.1.0 → 0.1.1

package/CHANGELOG.md

@@ -0,0 +1,9 @@
+# @tryghost/adapter-base-scheduling
+
+## 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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tryghost/adapter-base-scheduling",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "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",