@adonis-agora/durable 0.24.2 → 0.24.3

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @adonis-agora/durable
 
+## 0.24.3
+
+### Patch Changes
+
+- [#72](https://github.com/DavideCarvalho/adonis-agora-durable/pull/72) [`fcd35eb`](https://github.com/DavideCarvalho/adonis-agora-durable/commit/fcd35eb02fbc0d66e7140f5c1375d7e51e3b3503) Thanks [@DavideCarvalho](https://github.com/DavideCarvalho)! - Restore the stub doc comments that `0.24.2` flattened.
+
+  `0.24.2` fixed `configure` throwing by removing the backticks from four stub bodies. Removal was not necessary: Tempura accepts an **escaped** backtick, and renders it to a real one. The prose is now restored verbatim and escaped instead, so the generated `config/durable.ts`, `config/durable_dashboard.ts` and both migrations come out byte-identical to what the stubs always intended — with `` `createDurableTables` ``, `` `lucid` `` and the rest reading as code again in an editor tooltip.
+
+  Those comments are load-bearing: they are what explain why the migration delegates instead of carrying its own DDL, and why `static disableTransactions = true` is required rather than a preference. No behaviour changes; the generated files differ from `0.24.2` only in that comment styling.
+
+  The `{{{ … }}}` header keeps its unescaped backticks, as it must — it is evaluated as JavaScript.
+
 ## 0.24.2
 
 ### Patch Changes

package/dist/src/dashboard/index.d.ts

@@ -1,5 +1,5 @@
 /** Keep in sync with this package's `version` in package.json. */
-export declare const VERSION = "0.24.2";
+export declare const VERSION = "0.24.3";
 export { defineConfig, defaultAuthorize, resolveConfig } from './define_config.js';
 export type { AuthorizeHook, DurableDashboardConfig, ResolvedDurableDashboardConfig, } from './define_config.js';
 export { listRuns, getRun, retryRun, retryWithInputRun, continueRun, redispatchPendingRun, cancelRun, bulkAction, health, workers, topology, ok, } from './handlers.js';

package/dist/src/dashboard/index.js

@@ -1,5 +1,5 @@
 /** Keep in sync with this package's `version` in package.json. */
-export const VERSION = '0.24.2';
+export const VERSION = '0.24.3';
 export { defineConfig, defaultAuthorize, resolveConfig } from './define_config.js';
 export { listRuns, getRun, retryRun, retryWithInputRun, continueRun, redispatchPendingRun, cancelRun, bulkAction, health, workers, topology, ok, } from './handlers.js';
 export { renderDashboard } from './html.js';

package/dist/src/index.d.ts

@@ -1,5 +1,5 @@
 /** Keep in sync with this package's `version` in package.json. */
-export declare const VERSION = "0.24.2";
+export declare const VERSION = "0.24.3";
 export * from './admission.js';
 export * from './control-flow-signal.js';
 export * from './duration.js';

package/dist/src/index.js

@@ -1,5 +1,5 @@
 /** Keep in sync with this package's `version` in package.json. */
-export const VERSION = '0.24.2';
+export const VERSION = '0.24.3';
 // --- engine + core primitives -----------------------------------------------
 export * from './admission.js';
 export * from './control-flow-signal.js';

package/dist/stubs/config/durable.stub

@@ -4,33 +4,35 @@
 import { defineConfig, transports } from '@adonis-agora/durable'
 
 /**
- * Configuration for @adonis-agora/durable. Pick a transport (and optionally a store) by name from the
+ * Configuration for @adonis-agora/durable. Pick a \`transport\` (and optionally a \`store\`) by name from the
  * maps below; each driver's peer dependency is imported lazily, only when selected. The default is
- * the in-process 'memory' transport + the in-memory store — single-process, no extra infrastructure.
+ * the in-process \`memory\` transport + the in-memory store — single-process, no extra infrastructure.
  *
- * For a single-process PRODUCTION app with NO external infra, select the 'event-emitter' transport:
+ * For a single-process PRODUCTION app with NO external infra, select the \`event-emitter\` transport:
  * step handlers run in this same process over a Node EventEmitter (no DB, no Redis, no broker). The
- * 'memory' transport is test-only.
+ * \`memory\` transport is test-only.
  *
- * For cross-process / production, select the 'queue' (@adonisjs/queue) or 'db' (@adonisjs/lucid)
- * transport, and the 'lucid' store, then run: node ace migration:run
+ * For cross-process / production, select the \`queue\` (@adonisjs/queue) or \`db\` (@adonisjs/lucid)
+ * transport, and the \`lucid\` store, then run \`node ace migration:run\`:
  *
- *     import { defineConfig, transports, stores } from '@adonis-agora/durable'
+ * \`\`\`ts
+ * import { defineConfig, transports, stores } from '@adonis-agora/durable'
  *
- *     export default defineConfig({
- *       transport: 'queue',
- *       transports: {
- *         // single-process production, no external infra:
- *         'event-emitter': transports.eventEmitter(),
- *         // connection names an adapter from config/queue.ts (configure @adonisjs/queue first):
- *         queue: transports.queue({ connection: 'redis', group: 'durable' }),
- *         db: transports.db(),
- *       },
- *       store: 'lucid',
- *       stores: {
- *         lucid: stores.lucid(),
- *       },
- *     })
+ * export default defineConfig({
+ *   transport: 'queue',
+ *   transports: {
+ *     // single-process production, no external infra:
+ *     'event-emitter': transports.eventEmitter(),
+ *     // \`connection\` names an adapter from config/queue.ts (configure @adonisjs/queue first):
+ *     queue: transports.queue({ connection: 'redis', group: 'durable' }),
+ *     db: transports.db(),
+ *   },
+ *   store: 'lucid',
+ *   stores: {
+ *     lucid: stores.lucid(),
+ *   },
+ * })
+ * \`\`\`
  */
 export default defineConfig({
   transport: 'memory',
@@ -41,18 +43,18 @@ export default defineConfig({
 
   /**
    * Opt-in self-heal net for a remote step whose dispatched job was LOST (worker crashed mid-step, or
-   * the transport dropped it) and has no per-step timeoutMs. Off by default — turn it on only once
-   * remoteRedispatchMs comfortably exceeds the longest legitimate run of any such step, and every
+   * the transport dropped it) and has no per-step \`timeoutMs\`. Off by default — turn it on only once
+   * \`remoteRedispatchMs\` comfortably exceeds the longest legitimate run of any such step, and every
    * step is idempotent (a re-dispatch can double-run a step whose original job was merely slow).
    */
   // remoteRedispatchMs: 5 * 60 * 1000,
   // remoteRedispatchMax: 10,
 
   /**
-   * Recurring workflows fired by the durable:work worker loop on every tick. Each window starts
+   * Recurring workflows fired by the \`durable:work\` worker loop on every tick. Each window starts
    * exactly once even with several worker instances racing (idempotent by the schedule's time-bucket
-   * run id). Use everyMs for a fixed interval, or cron + timezone for a calendar schedule (cron
-   * needs the optional cron-parser peer dependency). See docs/authoring/scheduling.
+   * run id). Use \`everyMs\` for a fixed interval, or \`cron\` + \`timezone\` for a calendar schedule (cron
+   * needs the optional \`cron-parser\` peer dependency). See docs/authoring/scheduling.
    */
   // schedules: [
   //   { key: 'nightly-report', workflow: 'daily-report', cron: '0 2 * * *', timezone: 'America/Sao_Paulo' },

package/dist/stubs/config/durable_dashboard.stub

@@ -7,14 +7,14 @@ import { defineConfig } from '@adonis-agora/durable/dashboard'
  * Configuration for the @adonis-agora/durable dashboard.
  *
  * By default the dashboard is open OUTSIDE production, and in production it
- * requires a bearer token equal to DURABLE_DASHBOARD_TOKEN (deny if unset).
- * Replace authorize with your own guard (session, role, IP allow-list, …).
+ * requires a bearer token equal to \`DURABLE_DASHBOARD_TOKEN\` (deny if unset).
+ * Replace \`authorize\` with your own guard (session, role, IP allow-list, …).
  *
- * dashboardAuth is an ADDITIVE, optional session gate on top of authorize —
- * a signed cookie minted via a built-in login page (Mode B: login) and/or a
- * "open the console from your app" endpoint (Mode A: session). At least one
- * of the two is required when dashboardAuth is set; either or both may be
- * configured. See docs/observability/dashboard-auth.mdx.
+ * \`dashboardAuth\` is an ADDITIVE, optional session gate on top of \`authorize\` —
+ * a signed cookie minted via a built-in login page (Mode B: \`login\`) and/or a
+ * "open the console from your app" endpoint (Mode A: \`session\`). At least one
+ * of the two is required when \`dashboardAuth\` is set; either or both may be
+ * configured. See \`docs/observability/dashboard-auth.mdx\`.
  */
 export default defineConfig({
   // enabled: true,

package/dist/stubs/database/migrations/create_durable_tables.stub

@@ -6,33 +6,33 @@ import db from '@adonisjs/lucid/services/db'
 import { createDurableTables, dropDurableTables } from '@adonis-agora/durable'
 
 /**
- * Durable workflow tables for the @adonis-agora/durable 'lucid' state store: runs, step checkpoints,
+ * Durable workflow tables for the @adonis-agora/durable \`lucid\` state store: runs, step checkpoints,
  * the search-attribute side-table, signal waiters, buffered signals and buffered events.
  *
  * This migration DELEGATES to the library instead of reproducing its DDL. The schema belongs to the
- * library — LucidStateStore decides what columns it reads and writes — so a hand-copied snapshot
+ * library — \`LucidStateStore\` decides what columns it reads and writes — so a hand-copied snapshot
  * here can only ever be right until the next release. It was wrong before: the stub shipped without
- * last_heartbeat_at / heartbeat_progress, which the store writes on every step beat, and nothing
- * failed only because the provider's boot-time ensureSchema() silently ALTERed them in. Calling
- * createDurableTables makes that drift impossible rather than merely tested for.
+ * \`last_heartbeat_at\` / \`heartbeat_progress\`, which the store writes on every step beat, and nothing
+ * failed only because the provider's boot-time \`ensureSchema()\` silently \`ALTER\`ed them in. Calling
+ * \`createDurableTables\` makes that drift impossible rather than merely tested for.
  *
- * createDurableTables is idempotent (hasTable / hasColumn guarded) and additive-only, so it is
+ * \`createDurableTables\` is idempotent (\`hasTable\` / \`hasColumn\` guarded) and additive-only, so it is
  * safe to run against a database that already has some or all of the tables.
  *
- * It takes db (the Database manager from @adonisjs/lucid/services/db) rather than this.db:
- * createDurableTables needs db.connection(name).schema, and the this.db a migration gets is a
- * QueryClientContract — one already-resolved client, with no .connection() of its own. this.db still
- * supplies the connection NAME, so "node ace migration:run --connection=x" provisions the tables on
- * connection x and not on the default.
+ * \`db\` (the \`Database\` manager from \`@adonisjs/lucid/services/db\`) rather than \`this.db\`:
+ * \`createDurableTables\` needs \`db.connection(name).schema\`, and the \`this.db\` a migration gets is a
+ * \`QueryClientContract\` — one already-resolved client, with no \`.connection()\`. \`this.db\` still
+ * supplies the connection NAME, so \`node ace migration:run --connection=x\` provisions the tables on
+ * connection \`x\` and not on the default.
  */
 export default class extends BaseSchema {
   /**
-   * REQUIRED, not a preference. The DDL below runs through the Database manager, which checks out
+   * REQUIRED, not a preference. The DDL below runs through the \`Database\` manager, which checks out
    * its OWN connection from the pool — it is not part of the transaction the migrator would otherwise
-   * open for this migration. With a pool capped at 1 connection (Adonis's own SQLite guidance) that
-   * transaction would hold the only connection while createDurableTables waited for a free one, and
-   * the migration would hang until the acquire timeout. Nothing is lost by opting out: the statements
-   * were never inside that transaction anyway, and re-running an interrupted createDurableTables is a
+   * open for this migration. With \`pool: { max: 1 }\` (Adonis's own SQLite guidance) that transaction
+   * would hold the only connection while \`createDurableTables\` waited for a free one, and the
+   * migration would hang until the acquire timeout. Nothing is lost by opting out: the statements were
+   * never inside that transaction anyway, and re-running an interrupted \`createDurableTables\` is a
    * no-op.
    */
   static disableTransactions = true

package/dist/stubs/database/migrations/create_durable_transport_tables.stub

@@ -4,11 +4,11 @@
 import { BaseSchema } from '@adonisjs/lucid/schema'
 
 /**
- * Transport tables for the @adonis-agora/durable 'db' transport: the point-to-point work channels
- * (tasks / results / heartbeats / control) that let durable remote steps run cross-process over the
- * database alone. JSON payloads are stored as TEXT (the transport (de)serializes them) and timestamps
- * as epoch-ms integers, so the schema is portable across SQLite / Postgres / MySQL. Only needed when
- * you select the 'db' transport in config/durable.ts.
+ * Transport tables for the @adonis-agora/durable \`db\` transport: the point-to-point work channels (tasks /
+ * results / heartbeats / control) that let durable remote steps run cross-process over the database
+ * alone. JSON payloads are stored as TEXT (the transport (de)serializes them) and timestamps as
+ * epoch-ms integers, so the schema is portable across SQLite / Postgres / MySQL. Only needed when you
+ * select the \`db\` transport in config/durable.ts.
  */
 export default class extends BaseSchema {
   async up() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adonis-agora/durable",
-  "version": "0.24.2",
+  "version": "0.24.3",
   "description": "Durable cross-app workflows for AdonisJS — deterministic replay engine, AdonisJS binding, ace commands, dashboard, OpenTelemetry, Telescope, testing harness and Redis admission, all in one package. Part of the Agora ecosystem.",
   "license": "MIT",
   "repository": {