@c9up/bay 0.1.13 → 0.2.0

package/dist/adapters.d.ts

@@ -0,0 +1,68 @@
+/**
+ * The queue adapter factories a config file names — `{ default, adapters }`.
+ *
+ * The shape the framework gives a package with several backends and one
+ * selected: a `drivers` namespace imported beside `defineConfig`, each entry
+ * that namespace's result, and the selection read from the environment. Bay had
+ * a single `driver: "memory"` and told everyone else to build the manager by
+ * hand, which meant Redis could not be reached from a config file at all.
+ *
+ *   import { defineConfig, drivers } from '@c9up/bay'
+ *
+ *   export default defineConfig({
+ *     default: env.get('QUEUE_DRIVER'),
+ *     adapters: {
+ *       memory: drivers.memory(),
+ *       redis:  drivers.redis({ connection: 'main' }),
+ *     },
+ *   })
+ *
+ * The names are upstream's: `@adonisjs/queue` reads `default` + `adapters` out
+ * of `config/queue.ts`, fills them from a `drivers` namespace, and takes the
+ * selection from `QUEUE_DRIVER`. Bay said `stores` / `QUEUE_STORE`, which is
+ * the vocabulary of a different package. Both still work — see `stores` below.
+ *
+ * Factories are lazy: only the adapter an application actually uses is built,
+ * so naming a Redis queue in a config that runs in memory opens no connection.
+ */
+import type { RedisClientSource } from "./drivers/RedisDriver.js";
+import type { QueueDriver } from "./QueueManager.js";
+/** A driver, built on first use. */
+export type AdapterFactory = () => QueueDriver;
+/**
+ * The older name for {@link AdapterFactory}, kept for configs typed against it.
+ */
+export type QueueStoreFactory = AdapterFactory;
+export declare const drivers: {
+    /** In memory. Jobs do not survive a restart — for tests and dev. */
+    memory(): AdapterFactory;
+    /**
+     * Redis. `connection` takes an ioredis-shaped client, a function answering
+     * one, or the NAME of a `@c9up/quasar` connection — the last resolved at
+     * first use, without bay importing quasar, which stays an optional peer.
+     */
+    redis(options: {
+        connection: RedisClientSource | string;
+        prefix?: string;
+        visibilityTimeoutMs?: number;
+    }): AdapterFactory;
+};
+/**
+ * The older name for {@link drivers}, kept for configs written against it. The
+ * same object: `stores.redis(...)` and `drivers.redis(...)` are one call.
+ */
+export declare const stores: {
+    /** In memory. Jobs do not survive a restart — for tests and dev. */
+    memory(): AdapterFactory;
+    /**
+     * Redis. `connection` takes an ioredis-shaped client, a function answering
+     * one, or the NAME of a `@c9up/quasar` connection — the last resolved at
+     * first use, without bay importing quasar, which stays an optional peer.
+     */
+    redis(options: {
+        connection: RedisClientSource | string;
+        prefix?: string;
+        visibilityTimeoutMs?: number;
+    }): AdapterFactory;
+};
+//# sourceMappingURL=adapters.d.ts.map

package/dist/adapters.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"adapters.d.ts","sourceRoot":"","sources":["../src/adapters.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAGH,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAElE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAGrD,oCAAoC;AACpC,MAAM,MAAM,cAAc,GAAG,MAAM,WAAW,CAAC;AAE/C;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,cAAc,CAAC;AAE/C,eAAO,MAAM,OAAO;IACnB,oEAAoE;cAC1D,cAAc;IAIxB;;;;OAIG;mBACY;QACd,UAAU,EAAE,iBAAiB,GAAG,MAAM,CAAC;QACvC,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,mBAAmB,CAAC,EAAE,MAAM,CAAC;KAC7B,GAAG,cAAc;CAWlB,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,MAAM;IA/BlB,oEAAoE;cAC1D,cAAc;IAIxB;;;;OAIG;mBACY;QACd,UAAU,EAAE,iBAAiB,GAAG,MAAM,CAAC;QACvC,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,mBAAmB,CAAC,EAAE,MAAM,CAAC;KAC7B,GAAG,cAAc;CAiBU,CAAC"}

package/dist/adapters.js

@@ -0,0 +1,56 @@
+/**
+ * The queue adapter factories a config file names — `{ default, adapters }`.
+ *
+ * The shape the framework gives a package with several backends and one
+ * selected: a `drivers` namespace imported beside `defineConfig`, each entry
+ * that namespace's result, and the selection read from the environment. Bay had
+ * a single `driver: "memory"` and told everyone else to build the manager by
+ * hand, which meant Redis could not be reached from a config file at all.
+ *
+ *   import { defineConfig, drivers } from '@c9up/bay'
+ *
+ *   export default defineConfig({
+ *     default: env.get('QUEUE_DRIVER'),
+ *     adapters: {
+ *       memory: drivers.memory(),
+ *       redis:  drivers.redis({ connection: 'main' }),
+ *     },
+ *   })
+ *
+ * The names are upstream's: `@adonisjs/queue` reads `default` + `adapters` out
+ * of `config/queue.ts`, fills them from a `drivers` namespace, and takes the
+ * selection from `QUEUE_DRIVER`. Bay said `stores` / `QUEUE_STORE`, which is
+ * the vocabulary of a different package. Both still work — see `stores` below.
+ *
+ * Factories are lazy: only the adapter an application actually uses is built,
+ * so naming a Redis queue in a config that runs in memory opens no connection.
+ */
+import { MemoryDriver } from "./drivers/MemoryDriver.js";
+import { RedisDriver } from "./drivers/RedisDriver.js";
+import { quasarConnection } from "./quasar.js";
+export const drivers = {
+    /** In memory. Jobs do not survive a restart — for tests and dev. */
+    memory() {
+        return () => new MemoryDriver();
+    },
+    /**
+     * Redis. `connection` takes an ioredis-shaped client, a function answering
+     * one, or the NAME of a `@c9up/quasar` connection — the last resolved at
+     * first use, without bay importing quasar, which stays an optional peer.
+     */
+    redis(options) {
+        const source = typeof options.connection === "string"
+            ? quasarConnection(options.connection)
+            : options.connection;
+        return () => new RedisDriver(source, {
+            prefix: options.prefix,
+            visibilityTimeoutMs: options.visibilityTimeoutMs,
+        });
+    },
+};
+/**
+ * The older name for {@link drivers}, kept for configs written against it. The
+ * same object: `stores.redis(...)` and `drivers.redis(...)` are one call.
+ */
+export const stores = drivers;
+//# sourceMappingURL=adapters.js.map

package/dist/adapters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"adapters.js","sourceRoot":"","sources":["../src/adapters.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAEzD,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAEvD,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAU/C,MAAM,CAAC,MAAM,OAAO,GAAG;IACtB,oEAAoE;IACpE,MAAM;QACL,OAAO,GAAG,EAAE,CAAC,IAAI,YAAY,EAAE,CAAC;IACjC,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,OAIL;QACA,MAAM,MAAM,GACX,OAAO,OAAO,CAAC,UAAU,KAAK,QAAQ;YACrC,CAAC,CAAC,gBAAgB,CAAC,OAAO,CAAC,UAAU,CAAC;YACtC,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC;QACvB,OAAO,GAAG,EAAE,CACX,IAAI,WAAW,CAAC,MAAM,EAAE;YACvB,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,mBAAmB,EAAE,OAAO,CAAC,mBAAmB;SAChD,CAAC,CAAC;IACL,CAAC;CACD,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,OAAO,CAAC"}

package/dist/augmentations.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Teach ream's `ContainerBindings` what `container.make('queue')` returns.
+ *
+ * ream declares that interface open on purpose: it registers its own entries
+ * and expects each package to contribute the one it owns. Nothing filled this
+ * one in, so resolving by the string token answered `unknown` and every call
+ * site had to assert a type it could not prove.
+ *
+ * Loaded from the package barrel and from the provider, so registering bay is
+ * enough — an application writes no `declare module` of its own.
+ *
+ * Type-only, and ream stays an OPTIONAL peer: nothing here reaches a runtime
+ * import, and a `declare module` for a specifier that does not resolve is
+ * simply inert.
+ */
+import type { QueueManager } from "./QueueManager.js";
+declare module "@c9up/ream/types" {
+    interface ContainerBindings {
+        /** The job queue, bound by `BayProvider`. */
+        "bay.queue": QueueManager;
+        /**
+         * The same binding under the name it had before the token carried its
+         * package. Kept bound so an existing `container.make(...)` resolves.
+         */
+        queue: QueueManager;
+    }
+}
+//# sourceMappingURL=augmentations.d.ts.map

package/dist/augmentations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"augmentations.d.ts","sourceRoot":"","sources":["../src/augmentations.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAIH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEtD,OAAO,QAAQ,kBAAkB,CAAC;IACjC,UAAU,iBAAiB;QAC1B,6CAA6C;QAC7C,WAAW,EAAE,YAAY,CAAC;QAC1B;;;WAGG;QACH,KAAK,EAAE,YAAY,CAAC;KACpB;CACD"}

package/dist/augmentations.js

@@ -0,0 +1,17 @@
+/**
+ * Teach ream's `ContainerBindings` what `container.make('queue')` returns.
+ *
+ * ream declares that interface open on purpose: it registers its own entries
+ * and expects each package to contribute the one it owns. Nothing filled this
+ * one in, so resolving by the string token answered `unknown` and every call
+ * site had to assert a type it could not prove.
+ *
+ * Loaded from the package barrel and from the provider, so registering bay is
+ * enough — an application writes no `declare module` of its own.
+ *
+ * Type-only, and ream stays an OPTIONAL peer: nothing here reaches a runtime
+ * import, and a `declare module` for a specifier that does not resolve is
+ * simply inert.
+ */
+export {};
+//# sourceMappingURL=augmentations.js.map

package/dist/augmentations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"augmentations.js","sourceRoot":"","sources":["../src/augmentations.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG"}

package/dist/configure.d.ts

@@ -8,6 +8,7 @@
  */
 interface Codemods {
     addProvider(importPath: string): Promise<void>;
+    registerCommand(importPath: string): Promise<void>;
     addEnvVars(vars: Record<string, string>): Promise<void>;
     writeFile(filePath: string, content: string, options?: {
         force?: boolean;

package/dist/configure.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"configure.d.ts","sourceRoot":"","sources":["../src/configure.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,UAAU,QAAQ;IACjB,WAAW,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/C,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACxD,SAAS,CACR,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,OAAO,CAAA;KAAE,GAC3B,OAAO,CAAC,IAAI,CAAC,CAAC;CACjB;AAED,wBAAsB,SAAS,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,CAyBjE"}
+{"version":3,"file":"configure.d.ts","sourceRoot":"","sources":["../src/configure.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,UAAU,QAAQ;IACjB,WAAW,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/C,eAAe,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACnD,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACxD,SAAS,CACR,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,OAAO,CAAA;KAAE,GAC3B,OAAO,CAAC,IAAI,CAAC,CAAC;CACjB;AAED,wBAAsB,SAAS,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,CA0CjE"}

package/dist/configure.js

@@ -11,21 +11,38 @@ export async function configure(codemods) {
     // without them leaves an application whose config asks the environment for
     // something nothing ever put there.
     await codemods.addEnvVars({
-        QUEUE_STORE: "memory",
+        QUEUE_DRIVER: "memory",
     });
     await codemods.addProvider("@c9up/bay/provider");
-    await codemods.writeFile("config/queue.ts", `import { defineConfig, stores } from '@c9up/bay'
+    // `queue:work` and `make:job` are the package's, not the binary's: a
+    // project reaches them by listing the module, never by upgrading `ream`.
+    await codemods.registerCommand("@c9up/bay/commands");
+    await codemods.writeFile("config/queue.ts", `import { defineConfig, drivers } from '@c9up/bay'
 import env from '#start/env'
 
 export default defineConfig({
-  // Which store to run on. Memory forgets everything on restart, which is
+  // Which adapter to run on. Memory forgets everything on restart, which is
   // what a single process in development wants and nothing else does.
-  default: env.get('QUEUE_STORE', 'memory'),
+  default: env.get('QUEUE_DRIVER', 'memory'),
 
-  stores: {
-    memory: stores.memory(),
-    redis: stores.redis({ connection: 'main' }),
+  adapters: {
+    memory: drivers.memory(),
+    redis: drivers.redis({ connection: 'main' }),
   },
+
+  // What the worker does between jobs: how long it waits after finding
+  // nothing, how often it reclaims jobs a crashed worker left behind, how many
+  // it runs at once, and which named queues it serves.
+  worker: {
+    idleDelay: 2_000,
+    stalledInterval: 30_000,
+    concurrency: 1,
+    // queues: ['critical', 'default'],
+  },
+
+  // Where the job classes live. Every module under here is imported at boot,
+  // so a worker resolves a queued record by the class's own name.
+  locations: ['app/jobs'],
 })`);
 }
 //# sourceMappingURL=configure.js.map

package/dist/configure.js.map

@@ -1 +1 @@
-{"version":3,"file":"configure.js","sourceRoot":"","sources":["../src/configure.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAYH,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,QAAkB;IACjD,4EAA4E;IAC5E,2EAA2E;IAC3E,oCAAoC;IACpC,MAAM,QAAQ,CAAC,UAAU,CAAC;QACzB,WAAW,EAAE,QAAQ;KACrB,CAAC,CAAC;IAEH,MAAM,QAAQ,CAAC,WAAW,CAAC,oBAAoB,CAAC,CAAC;IACjD,MAAM,QAAQ,CAAC,SAAS,CACvB,iBAAiB,EACjB;;;;;;;;;;;;GAYC,CACD,CAAC;AACH,CAAC"}
+{"version":3,"file":"configure.js","sourceRoot":"","sources":["../src/configure.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAaH,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,QAAkB;IACjD,4EAA4E;IAC5E,2EAA2E;IAC3E,oCAAoC;IACpC,MAAM,QAAQ,CAAC,UAAU,CAAC;QACzB,YAAY,EAAE,QAAQ;KACtB,CAAC,CAAC;IAEH,MAAM,QAAQ,CAAC,WAAW,CAAC,oBAAoB,CAAC,CAAC;IACjD,qEAAqE;IACrE,yEAAyE;IACzE,MAAM,QAAQ,CAAC,eAAe,CAAC,oBAAoB,CAAC,CAAC;IACrD,MAAM,QAAQ,CAAC,SAAS,CACvB,iBAAiB,EACjB;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BC,CACD,CAAC;AACH,CAAC"}

package/dist/console/contract.d.ts

@@ -0,0 +1,60 @@
+/**
+ * The console command contract, declared locally.
+ *
+ * Bay stays framework-agnostic: it must not import `@c9up/ream`, so it
+ * describes the shape Ream's console kernel dispatches against rather than
+ * importing it.
+ *
+ * Ream's decorators (`@args` / `@flags`) live in the framework, so the helpers
+ * below build the same metadata without them.
+ */
+export interface CommandOptions {
+    /** Boot the application before `run()`. Off by default. */
+    startApp?: boolean;
+    staysAlive?: boolean;
+    allowUnknownFlags?: boolean;
+}
+export interface ArgumentMetaData {
+    type: "string" | "spread";
+    propertyName: string;
+    argumentName: string;
+    description?: string;
+    required: boolean;
+    default?: string | string[];
+}
+export interface FlagMetaData {
+    type: "string" | "boolean" | "number" | "array";
+    propertyName: string;
+    flagName: string;
+    description?: string;
+    alias: string[];
+    default?: string | string[] | number | boolean;
+    required: boolean;
+}
+/** The static side the kernel reads. */
+export interface BayCommandClass {
+    new (): {
+        run(): Promise<void> | void;
+    };
+    commandName: string;
+    description: string;
+    options?: CommandOptions;
+    args?: readonly ArgumentMetaData[];
+    flags?: readonly FlagMetaData[];
+    help?: string | string[];
+}
+export declare function flag(propertyName: string, type: FlagMetaData["type"], options?: {
+    flagName?: string;
+    description?: string;
+    alias?: string[];
+    default?: FlagMetaData["default"];
+    required?: boolean;
+}): FlagMetaData;
+export declare function argument(propertyName: string, options?: {
+    type?: ArgumentMetaData["type"];
+    argumentName?: string;
+    description?: string;
+    required?: boolean;
+    default?: ArgumentMetaData["default"];
+}): ArgumentMetaData;
+//# sourceMappingURL=contract.d.ts.map

package/dist/console/contract.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"contract.d.ts","sourceRoot":"","sources":["../../src/console/contract.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,MAAM,WAAW,cAAc;IAC9B,2DAA2D;IAC3D,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED,MAAM,WAAW,gBAAgB;IAChC,IAAI,EAAE,QAAQ,GAAG,QAAQ,CAAC;IAC1B,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,OAAO,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;CAC5B;AAED,MAAM,WAAW,YAAY;IAC5B,IAAI,EAAE,QAAQ,GAAG,SAAS,GAAG,QAAQ,GAAG,OAAO,CAAC;IAChD,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,MAAM,GAAG,OAAO,CAAC;IAC/C,QAAQ,EAAE,OAAO,CAAC;CAClB;AAED,wCAAwC;AACxC,MAAM,WAAW,eAAe;IAC/B,QAAQ;QAAE,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAA;KAAE,CAAC;IACxC,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,cAAc,CAAC;IACzB,IAAI,CAAC,EAAE,SAAS,gBAAgB,EAAE,CAAC;IACnC,KAAK,CAAC,EAAE,SAAS,YAAY,EAAE,CAAC;IAChC,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;CACzB;AAOD,wBAAgB,IAAI,CACnB,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,YAAY,CAAC,MAAM,CAAC,EAC1B,OAAO,GAAE;IACR,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,OAAO,CAAC,EAAE,YAAY,CAAC,SAAS,CAAC,CAAC;IAClC,QAAQ,CAAC,EAAE,OAAO,CAAC;CACd,GACJ,YAAY,CAUd;AAED,wBAAgB,QAAQ,CACvB,YAAY,EAAE,MAAM,EACpB,OAAO,GAAE;IACR,IAAI,CAAC,EAAE,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAChC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,OAAO,CAAC,EAAE,gBAAgB,CAAC,SAAS,CAAC,CAAC;CACjC,GACJ,gBAAgB,CASlB"}

package/dist/console/contract.js

@@ -0,0 +1,36 @@
+/**
+ * The console command contract, declared locally.
+ *
+ * Bay stays framework-agnostic: it must not import `@c9up/ream`, so it
+ * describes the shape Ream's console kernel dispatches against rather than
+ * importing it.
+ *
+ * Ream's decorators (`@args` / `@flags`) live in the framework, so the helpers
+ * below build the same metadata without them.
+ */
+/** `startServer` → `start-server`, matching the framework's decorators. */
+function dashCase(value) {
+    return value.replace(/([a-z0-9])([A-Z])/g, "$1-$2").toLowerCase();
+}
+export function flag(propertyName, type, options = {}) {
+    return {
+        type,
+        propertyName,
+        flagName: options.flagName ?? dashCase(propertyName),
+        description: options.description,
+        alias: options.alias ?? [],
+        default: options.default,
+        required: options.required ?? false,
+    };
+}
+export function argument(propertyName, options = {}) {
+    return {
+        type: options.type ?? "string",
+        propertyName,
+        argumentName: options.argumentName ?? dashCase(propertyName),
+        description: options.description,
+        required: options.required ?? options.default === undefined,
+        default: options.default,
+    };
+}
+//# sourceMappingURL=contract.js.map

package/dist/console/contract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contract.js","sourceRoot":"","sources":["../../src/console/contract.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAuCH,2EAA2E;AAC3E,SAAS,QAAQ,CAAC,KAAa;IAC9B,OAAO,KAAK,CAAC,OAAO,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAC,WAAW,EAAE,CAAC;AACnE,CAAC;AAED,MAAM,UAAU,IAAI,CACnB,YAAoB,EACpB,IAA0B,EAC1B,UAMI,EAAE;IAEN,OAAO;QACN,IAAI;QACJ,YAAY;QACZ,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,QAAQ,CAAC,YAAY,CAAC;QACpD,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,EAAE;QAC1B,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,KAAK;KACnC,CAAC;AACH,CAAC;AAED,MAAM,UAAU,QAAQ,CACvB,YAAoB,EACpB,UAMI,EAAE;IAEN,OAAO;QACN,IAAI,EAAE,OAAO,CAAC,IAAI,IAAI,QAAQ;QAC9B,YAAY;QACZ,YAAY,EAAE,OAAO,CAAC,YAAY,IAAI,QAAQ,CAAC,YAAY,CAAC;QAC5D,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS;QAC3D,OAAO,EAAE,OAAO,CAAC,OAAO;KACxB,CAAC;AACH,CAAC"}

package/dist/console/index.d.ts

@@ -0,0 +1,29 @@
+/**
+ * `@c9up/bay/commands` — the commands bay ships.
+ *
+ *   // reamrc.ts, written by `configure()`
+ *   commands: [() => import('@c9up/bay/commands')]
+ *
+ * A module answering `getMetaData()` / `getCommand()`, which is how a package
+ * adds commands: by shipping them, never by a change to the `ream` binary.
+ *
+ * `jobsDir` is read through a getter, not captured: these classes are built
+ * when the module is imported — before the application boots — while `run()`
+ * happens after it, when the config exists.
+ */
+import type { BayCommandClass } from "./contract.js";
+/** What the kernel reads to list a command without importing it. */
+interface CommandMetaData {
+    commandName: string;
+    namespace: string | null;
+    description: string;
+    help?: string | string[];
+    aliases: string[];
+    options: Record<string, unknown>;
+    args: readonly unknown[];
+    flags: readonly unknown[];
+}
+export declare function getMetaData(): Promise<CommandMetaData[]>;
+export declare function getCommand(metadata: CommandMetaData): Promise<BayCommandClass | null>;
+export type { BayCommandClass } from "./contract.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/console/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/console/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAGH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAarD,oEAAoE;AACpE,UAAU,eAAe;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IACzB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjC,IAAI,EAAE,SAAS,OAAO,EAAE,CAAC;IACzB,KAAK,EAAE,SAAS,OAAO,EAAE,CAAC;CAC1B;AAgBD,wBAAsB,WAAW,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC,CAE9D;AAED,wBAAsB,UAAU,CAC/B,QAAQ,EAAE,eAAe,GACvB,OAAO,CAAC,eAAe,GAAG,IAAI,CAAC,CAKjC;AAED,YAAY,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC"}

package/dist/console/index.js

@@ -0,0 +1,45 @@
+/**
+ * `@c9up/bay/commands` — the commands bay ships.
+ *
+ *   // reamrc.ts, written by `configure()`
+ *   commands: [() => import('@c9up/bay/commands')]
+ *
+ * A module answering `getMetaData()` / `getCommand()`, which is how a package
+ * adds commands: by shipping them, never by a change to the `ream` binary.
+ *
+ * `jobsDir` is read through a getter, not captured: these classes are built
+ * when the module is imported — before the application boots — while `run()`
+ * happens after it, when the config exists.
+ */
+import { getJobsDir } from "../jobs.js";
+import { makeJobCommand } from "./makeJob.js";
+import { queueWorkCommand } from "./queueWork.js";
+const COMMANDS = [
+    queueWorkCommand(),
+    makeJobCommand({
+        get jobsDir() {
+            return getJobsDir();
+        },
+    }),
+];
+function serialize(command) {
+    const colon = command.commandName.indexOf(":");
+    return {
+        commandName: command.commandName,
+        namespace: colon === -1 ? null : command.commandName.slice(0, colon),
+        description: command.description,
+        help: command.help,
+        aliases: [],
+        options: { ...command.options },
+        args: command.args ?? [],
+        flags: command.flags ?? [],
+    };
+}
+export async function getMetaData() {
+    return COMMANDS.map(serialize);
+}
+export async function getCommand(metadata) {
+    return (COMMANDS.find((command) => command.commandName === metadata.commandName) ??
+        null);
+}
+//# sourceMappingURL=index.js.map

package/dist/console/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/console/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAExC,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAElD,MAAM,QAAQ,GAA+B;IAC5C,gBAAgB,EAAE;IAClB,cAAc,CAAC;QACd,IAAI,OAAO;YACV,OAAO,UAAU,EAAE,CAAC;QACrB,CAAC;KACD,CAAC;CACF,CAAC;AAcF,SAAS,SAAS,CAAC,OAAwB;IAC1C,MAAM,KAAK,GAAG,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAC/C,OAAO;QACN,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,SAAS,EAAE,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC;QACpE,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,IAAI,EAAE,OAAO,CAAC,IAAI;QAClB,OAAO,EAAE,EAAE;QACX,OAAO,EAAE,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE;QAC/B,IAAI,EAAE,OAAO,CAAC,IAAI,IAAI,EAAE;QACxB,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,EAAE;KAC1B,CAAC;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,WAAW;IAChC,OAAO,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;AAChC,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,UAAU,CAC/B,QAAyB;IAEzB,OAAO,CACN,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,WAAW,KAAK,QAAQ,CAAC,WAAW,CAAC;QACxE,IAAI,CACJ,CAAC;AACH,CAAC"}

package/dist/console/makeJob.d.ts

@@ -0,0 +1,32 @@
+/**
+ * `make:job` — scaffold a job class.
+ *
+ *     ream make:job SendWelcomeEmail        → app/jobs/send_welcome_email.ts
+ *     ream make:job emails/SendWelcomeEmail → app/jobs/emails/send_welcome_email.ts
+ *
+ * A subdirectory is allowed and is the only reason the name is not a plain
+ * identifier: `..` and every other way out of the jobs directory is refused
+ * before anything is written.
+ */
+import { type BayCommandClass } from "./contract.js";
+export interface MakeJobOptions {
+    /** Directory the job files are scaffolded into. */
+    jobsDir: string;
+}
+/** `SendWelcomeEmail` → `send_welcome_email`, `HTTPPing` → `http_ping`. */
+export declare function toSnakeCase(name: string): string;
+/** `send_welcome_email` / `sendWelcomeEmail` → `SendWelcomeEmail`. */
+export declare function toPascalCase(name: string): string;
+/**
+ * Split `emails/SendWelcomeEmail` into the directory it goes in and the class
+ * it declares, refusing anything that would leave the jobs directory.
+ */
+export declare function resolveJobName(input: string): {
+    dir: string;
+    className: string;
+    fileName: string;
+};
+/** The file a fresh job starts as. */
+export declare function jobStub(className: string): string;
+export declare function makeJobCommand(options: MakeJobOptions): BayCommandClass;
+//# sourceMappingURL=makeJob.d.ts.map

package/dist/console/makeJob.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"makeJob.d.ts","sourceRoot":"","sources":["../../src/console/makeJob.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAIH,OAAO,EAAY,KAAK,eAAe,EAAE,MAAM,eAAe,CAAC;AAE/D,MAAM,WAAW,cAAc;IAC9B,mDAAmD;IACnD,OAAO,EAAE,MAAM,CAAC;CAChB;AAED,2EAA2E;AAC3E,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAMhD;AAED,sEAAsE;AACtE,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAMjD;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG;IAC9C,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;CACjB,CAwBA;AAED,sCAAsC;AACtC,wBAAgB,OAAO,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CA2BjD;AAED,wBAAgB,cAAc,CAAC,OAAO,EAAE,cAAc,GAAG,eAAe,CAoCvE"}

package/dist/console/makeJob.js

@@ -0,0 +1,118 @@
+/**
+ * `make:job` — scaffold a job class.
+ *
+ *     ream make:job SendWelcomeEmail        → app/jobs/send_welcome_email.ts
+ *     ream make:job emails/SendWelcomeEmail → app/jobs/emails/send_welcome_email.ts
+ *
+ * A subdirectory is allowed and is the only reason the name is not a plain
+ * identifier: `..` and every other way out of the jobs directory is refused
+ * before anything is written.
+ */
+import * as fsp from "node:fs/promises";
+import * as path from "node:path";
+import { argument } from "./contract.js";
+/** `SendWelcomeEmail` → `send_welcome_email`, `HTTPPing` → `http_ping`. */
+export function toSnakeCase(name) {
+    return name
+        .replace(/([a-z0-9])([A-Z])/g, "$1_$2")
+        .replace(/([A-Z]+)([A-Z][a-z])/g, "$1_$2")
+        .replace(/[-\s]+/g, "_")
+        .toLowerCase();
+}
+/** `send_welcome_email` / `sendWelcomeEmail` → `SendWelcomeEmail`. */
+export function toPascalCase(name) {
+    return name
+        .split(/[_\-\s]+/)
+        .filter((part) => part.length > 0)
+        .map((part) => part.charAt(0).toUpperCase() + part.slice(1))
+        .join("");
+}
+/**
+ * Split `emails/SendWelcomeEmail` into the directory it goes in and the class
+ * it declares, refusing anything that would leave the jobs directory.
+ */
+export function resolveJobName(input) {
+    const parts = input.split("/").filter((part) => part.length > 0);
+    const last = parts.pop();
+    if (last === undefined || last.length === 0) {
+        throw new Error(`Invalid job name: '${input}'`);
+    }
+    for (const part of [...parts, last]) {
+        // `..` is the traversal; the rest are characters a filename has no
+        // business carrying and a shell has opinions about.
+        if (part === ".." || /[\\'";`]/.test(part)) {
+            throw new Error(`Invalid job name: '${input}'`);
+        }
+    }
+    const className = toPascalCase(last);
+    if (!/^[A-Za-z][A-Za-z0-9]*$/.test(className)) {
+        throw new Error(`Invalid job name: '${input}' — a job's name becomes a class name`);
+    }
+    return {
+        dir: parts.join("/"),
+        className,
+        fileName: `${toSnakeCase(last)}.ts`,
+    };
+}
+/** The file a fresh job starts as. */
+export function jobStub(className) {
+    return `import { Job } from '@c9up/bay'
+import type { JobOptions } from '@c9up/bay'
+
+interface ${className}Payload {
+  // What \`dispatch(${className}, …)\` must be given.
+}
+
+export default class ${className} extends Job<${className}Payload> {
+  static options: JobOptions = {
+    // queue: 'default',
+    // maxRetries: 3,
+    // delay: '10s',
+    // timeout: '1m',
+  }
+
+  async execute(): Promise<void> {
+    // The work. Throwing is what makes the attempt fail.
+    void this.payload
+  }
+
+  async failed(error: Error): Promise<void> {
+    // Once the last attempt has failed — the alert or the cleanup.
+    void error
+  }
+}
+`;
+}
+export function makeJobCommand(options) {
+    return class MakeJob {
+        static commandName = "make:job";
+        static description = "Scaffold a background job class";
+        // Pure filesystem work: no reason to boot the app and open a connection.
+        static options = { startApp: false };
+        static args = [
+            argument("name", {
+                description: "Job class name, optionally under a subdirectory",
+            }),
+        ];
+        async run() {
+            let resolved;
+            try {
+                resolved = resolveJobName(this.name);
+            }
+            catch (err) {
+                console.error(`[bay] ${err instanceof Error ? err.message : String(err)}`);
+                process.exitCode = 1;
+                return;
+            }
+            const dir = path.join(options.jobsDir, resolved.dir);
+            const filePath = path.join(dir, resolved.fileName);
+            await fsp.mkdir(dir, { recursive: true });
+            // `wx`: an existing job is never clobbered, and the error says so.
+            await fsp.writeFile(filePath, jobStub(resolved.className), {
+                flag: "wx",
+            });
+            console.log(`Created ${filePath}`);
+        }
+    };
+}
+//# sourceMappingURL=makeJob.js.map

package/dist/console/makeJob.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"makeJob.js","sourceRoot":"","sources":["../../src/console/makeJob.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,KAAK,GAAG,MAAM,kBAAkB,CAAC;AACxC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAClC,OAAO,EAAE,QAAQ,EAAwB,MAAM,eAAe,CAAC;AAO/D,2EAA2E;AAC3E,MAAM,UAAU,WAAW,CAAC,IAAY;IACvC,OAAO,IAAI;SACT,OAAO,CAAC,oBAAoB,EAAE,OAAO,CAAC;SACtC,OAAO,CAAC,uBAAuB,EAAE,OAAO,CAAC;SACzC,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC;SACvB,WAAW,EAAE,CAAC;AACjB,CAAC;AAED,sEAAsE;AACtE,MAAM,UAAU,YAAY,CAAC,IAAY;IACxC,OAAO,IAAI;SACT,KAAK,CAAC,UAAU,CAAC;SACjB,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;SACjC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;SAC3D,IAAI,CAAC,EAAE,CAAC,CAAC;AACZ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,cAAc,CAAC,KAAa;IAK3C,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IACjE,MAAM,IAAI,GAAG,KAAK,CAAC,GAAG,EAAE,CAAC;IACzB,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC7C,MAAM,IAAI,KAAK,CAAC,sBAAsB,KAAK,GAAG,CAAC,CAAC;IACjD,CAAC;IACD,KAAK,MAAM,IAAI,IAAI,CAAC,GAAG,KAAK,EAAE,IAAI,CAAC,EAAE,CAAC;QACrC,mEAAmE;QACnE,oDAAoD;QACpD,IAAI,IAAI,KAAK,IAAI,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YAC5C,MAAM,IAAI,KAAK,CAAC,sBAAsB,KAAK,GAAG,CAAC,CAAC;QACjD,CAAC;IACF,CAAC;IACD,MAAM,SAAS,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;IACrC,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;QAC/C,MAAM,IAAI,KAAK,CACd,sBAAsB,KAAK,uCAAuC,CAClE,CAAC;IACH,CAAC;IACD,OAAO;QACN,GAAG,EAAE,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC;QACpB,SAAS;QACT,QAAQ,EAAE,GAAG,WAAW,CAAC,IAAI,CAAC,KAAK;KACnC,CAAC;AACH,CAAC;AAED,sCAAsC;AACtC,MAAM,UAAU,OAAO,CAAC,SAAiB;IACxC,OAAO;;;YAGI,SAAS;uBACE,SAAS;;;uBAGT,SAAS,gBAAgB,SAAS;;;;;;;;;;;;;;;;;;CAkBxD,CAAC;AACF,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,OAAuB;IACrD,OAAO,MAAM,OAAO;QACnB,MAAM,CAAC,WAAW,GAAG,UAAU,CAAC;QAChC,MAAM,CAAC,WAAW,GAAG,iCAAiC,CAAC;QACvD,yEAAyE;QACzE,MAAM,CAAC,OAAO,GAAG,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;QACrC,MAAM,CAAC,IAAI,GAAG;YACb,QAAQ,CAAC,MAAM,EAAE;gBAChB,WAAW,EAAE,iDAAiD;aAC9D,CAAC;SACF,CAAC;QAIF,KAAK,CAAC,GAAG;YACR,IAAI,QAA2C,CAAC;YAChD,IAAI,CAAC;gBACJ,QAAQ,GAAG,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACtC,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACd,OAAO,CAAC,KAAK,CACZ,SAAS,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAC3D,CAAC;gBACF,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;gBACrB,OAAO;YACR,CAAC;YAED,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC;YACrD,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC;YACnD,MAAM,GAAG,CAAC,KAAK,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YAC1C,mEAAmE;YACnE,MAAM,GAAG,CAAC,SAAS,CAAC,QAAQ,EAAE,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE;gBAC1D,IAAI,EAAE,IAAI;aACV,CAAC,CAAC;YACH,OAAO,CAAC,GAAG,CAAC,WAAW,QAAQ,EAAE,CAAC,CAAC;QACpC,CAAC;KACD,CAAC;AACH,CAAC"}

package/dist/console/queueWork.d.ts

@@ -0,0 +1,18 @@
+/**
+ * `queue:work` — run the worker that takes jobs off the queue.
+ *
+ * The command a deployment runs as its own process, beside the HTTP one:
+ *
+ *     ream queue:work
+ *     ream queue:work --queue=emails,notifications
+ *     ream queue:work --concurrency=10
+ *
+ * It stays alive on purpose — `staysAlive` — and the loop it starts is the
+ * application's, so a SIGTERM reaches `BayProvider.shutdown()`, which stops the
+ * worker and lets the job in flight finish rather than dropping it.
+ */
+import { type BayCommandClass } from "./contract.js";
+/** Split `--queue=a,b` into names, dropping the empties a trailing comma makes. */
+export declare function parseQueues(value: string | undefined): string[] | undefined;
+export declare function queueWorkCommand(): BayCommandClass;
+//# sourceMappingURL=queueWork.d.ts.map

package/dist/console/queueWork.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"queueWork.d.ts","sourceRoot":"","sources":["../../src/console/queueWork.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAGH,OAAO,EAAE,KAAK,eAAe,EAAQ,MAAM,eAAe,CAAC;AAE3D,mFAAmF;AACnF,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,EAAE,GAAG,SAAS,CAO3E;AAED,wBAAgB,gBAAgB,IAAI,eAAe,CA0ClD"}