nuxt-cf-jobs 0.0.2 → 0.1.0

package/dist/module.d.mts

@@ -69,5 +69,8 @@ declare module '@nuxt/schema' {
 }
 declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, ModuleOptions, false>;
 
-export { _default as default };
+declare function generateRegistryTemplate(options: ModuleOptions, rootDir: string, templateDir: string): Promise<string>;
+declare function generateRegistryTypesTemplate(options: ModuleOptions, rootDir: string, templateDir: string): Promise<string>;
+
+export { _default as default, generateRegistryTemplate, generateRegistryTypesTemplate };
 export type { ModuleOptions };

package/dist/module.json

@@ -1,7 +1,7 @@
 {
   "name": "nuxt-cf-jobs",
   "configKey": "cfJobs",
-  "version": "0.0.2",
+  "version": "0.1.0",
   "builder": {
     "@nuxt/module-builder": "1.0.2",
     "unbuild": "3.6.1"

package/dist/module.mjs

@@ -174,6 +174,11 @@ const module$1 = defineNuxtModule({
       write: true,
       getContents: async () => generateRegistryTemplate(options, nuxt.options.rootDir, resolve(nuxt.options.buildDir, "cf-jobs"))
     });
+    addTemplate({
+      filename: "cf-jobs/registry.d.ts",
+      write: true,
+      getContents: async () => generateRegistryTypesTemplate(options, nuxt.options.rootDir, resolve(nuxt.options.buildDir, "cf-jobs"))
+    });
     nuxt.options.alias[options.registryAlias ?? "#cf-jobs/app"] = registryTemplate.dst;
     nuxt.hooks.hook("builder:watch", (async (_event, path) => {
       if (!isWatchedJobPath(path, options, nuxt.options.rootDir))
@@ -283,38 +288,21 @@ async function generateRegistryTemplate(options, rootDir, templateDir) {
   const files = await resolveJobFiles(options, rootDir);
   assertUniqueGeneratedJobNames(files, options, rootDir);
   const imports = files.map((file, index) => {
-    return `import job${index} from ${JSON.stringify(toImportPath(templateDir, file))}`;
-  });
-  const loaders = files.map((file) => {
-    return `  ${JSON.stringify(toJobName(file, options, rootDir))}: () => import(${JSON.stringify(toImportPath(templateDir, file))}).then(m => m.default),`;
+    return `import job${index} from ${JSON.stringify(toImportPath(templateDir, file).replace(/\.ts$/, ""))}`;
   });
   const jobItems = files.map((_, index) => `job${index}`).join(", ");
   return [
     "/* This file is generated by nuxt-cf-jobs. Do not edit directly. */",
-    `import { createCfJobsApp } from '#cf-jobs/server'`,
-    `import { useRuntimeConfig } from '#imports'`,
-    `import type { JobDefinitionsByNameOfLoaders, JobMessageByName, JobMessageByQueue, JobNameOf, JobPayloadByName, JobPayloadOf, JobQueueByName, QueueNameOf } from '#cf-jobs/server'`,
-    `export type { QueueConsumerOptions } from '#cf-jobs/server'`,
+    `// @ts-expect-error - nitropack/runtime is resolved at build time inside Nuxt`,
+    `import { useRuntimeConfig } from 'nitropack/runtime'`,
+    `import { createCfJobsApp } from 'nuxt-cf-jobs/server'`,
     ...imports,
     "",
-    "export const jobLoaders = {",
-    ...loaders,
-    "} as const",
     `export const jobs = [${jobItems}] as const`,
-    `export const app = createCfJobsApp(jobs, useRuntimeConfig as never, { defaultQueue: ${options.defaultQueue ? JSON.stringify(options.defaultQueue) : "undefined"} })`,
-    "export const jobRegistry = app.jobRegistry",
-    "",
-    "export type Jobs = typeof jobs",
-    "export type JobsByName = JobDefinitionsByNameOfLoaders<typeof jobLoaders>",
-    "export type JobName = keyof JobsByName & JobNameOf<Jobs>",
-    "export type JobDefinitionOf<Name extends JobName> = JobsByName[Name]",
-    "export type QueueName = QueueNameOf<Jobs>",
-    "export type JobPayload<Name extends JobName> = JobPayloadOf<JobDefinitionOf<Name>>",
-    "export type JobQueue<Name extends JobName> = JobQueueByName<Jobs, Name>",
-    "export type JobMessage<Name extends JobName> = JobMessageByName<Jobs, Name>",
-    "export type QueueMessage<Queue extends QueueName> = JobMessageByQueue<Jobs, Queue>",
+    `export const app = createCfJobsApp(jobs, { useRuntimeConfig, defaultQueue: ${options.defaultQueue ? JSON.stringify(options.defaultQueue) : "undefined"} })`,
     "",
     "export const {",
+    "  jobRegistry,",
     "  getHandler,",
     "  getJobDefinition,",
     "  getJobQueue,",
@@ -330,6 +318,47 @@ async function generateRegistryTemplate(options, rootDir, templateDir) {
     ""
   ].join("\n");
 }
+async function generateRegistryTypesTemplate(options, rootDir, templateDir) {
+  const files = await resolveJobFiles(options, rootDir);
+  assertUniqueGeneratedJobNames(files, options, rootDir);
+  const jobTypeLines = files.map((file) => {
+    return `  typeof import(${JSON.stringify(toImportPath(templateDir, file).replace(/\.ts$/, ""))})['default'],`;
+  });
+  return [
+    "/* This file is generated by nuxt-cf-jobs. Do not edit directly. */",
+    `import type { JobMessageByName, JobMessageByQueue, JobNameOf, JobPayloadByName, JobPayloadOf, JobQueueByName, QueueNameOf, QueueConsumerOptions } from 'nuxt-cf-jobs/server'`,
+    `export type { QueueConsumerOptions }`,
+    "",
+    "export declare const jobs: readonly [",
+    ...jobTypeLines,
+    "]",
+    "export declare const app: ReturnType<typeof import('nuxt-cf-jobs/server').createCfJobsApp<typeof jobs>>",
+    "",
+    "export type Jobs = typeof jobs",
+    "export type JobsByName = { readonly [Job in Jobs[number] as Job['name']]: Job }",
+    "export type JobName = keyof JobsByName & JobNameOf<Jobs>",
+    "export type JobDefinitionOf<Name extends JobName> = JobsByName[Name]",
+    "export type QueueName = QueueNameOf<Jobs>",
+    "export type JobPayload<Name extends JobName> = JobPayloadOf<JobDefinitionOf<Name>>",
+    "export type JobQueue<Name extends JobName> = JobQueueByName<Jobs, Name>",
+    "export type JobMessage<Name extends JobName> = JobMessageByName<Jobs, Name>",
+    "export type QueueMessage<Queue extends QueueName> = JobMessageByQueue<Jobs, Queue>",
+    "",
+    "export declare const jobRegistry: typeof app.jobRegistry",
+    "export declare const getHandler: typeof app.getHandler",
+    "export declare const getJobDefinition: typeof app.getJobDefinition",
+    "export declare const getJobQueue: typeof app.getJobQueue",
+    "export declare const getJobRoute: typeof app.getJobRoute",
+    "export declare const validateRegistry: typeof app.validateRegistry",
+    "export declare const validateQueueBindings: typeof app.validateQueueBindings",
+    "export declare const assertQueueBindings: typeof app.assertQueueBindings",
+    "export declare const getQueue: typeof app.getQueue",
+    "export declare const buildJobPayload: typeof app.buildJobPayload",
+    "export declare const prepareJob: typeof app.prepareJob",
+    "export declare const registerQueueConsumer: typeof app.registerQueueConsumer",
+    ""
+  ].join("\n");
+}
 async function resolveJobFiles(options, rootDir) {
   const dirs = toArray(options.jobsDir ?? "server/jobs");
   const pattern = options.jobsPattern ?? "**/*.ts";
@@ -365,7 +394,7 @@ function toArray(value) {
   return Array.isArray(value) ? value : [value];
 }
 function toImportPath(fromDir, file) {
-  const path = relative(fromDir, file).replace(/\\/g, "/").replace(/\.[cm]?tsx?$/, "");
+  const path = relative(fromDir, file).replace(/\\/g, "/");
   return path.startsWith(".") ? path : `./${path}`;
 }
 function toJobName(file, options, rootDir) {
@@ -377,4 +406,4 @@ function toJobName(file, options, rootDir) {
   return path.replace(/\/index$/, "");
 }
 
-export { module$1 as default };
+export { module$1 as default, generateRegistryTemplate, generateRegistryTypesTemplate };

package/dist/runtime/server/app.d.ts

@@ -1,4 +1,4 @@
-import type { AnyJobDefinition, JobNameOf, JobPayloadByName, JobQueueByName } from './registry.js';
+import type { AnyJobDefinition, JobNameOf, JobPayloadByName } from './registry.js';
 import type { PrepareRegisteredDurableJobOptions } from './outbox.js';
 import type { QueueSource, RegisterRegisteredQueueConsumerOptions } from './queue.js';
 import type { QueueBindingsConfig } from './types.js';
@@ -9,11 +9,24 @@ export interface CfJobsRuntimeConfig {
     };
 }
 export type CfJobsQueueConsumerOptions<Env extends Record<string, unknown>, Db, Logger> = Omit<RegisterRegisteredQueueConsumerOptions<Env, Db, Logger>, 'registry' | 'queues'>;
+export type UseRuntimeConfigFn = (event?: unknown) => CfJobsRuntimeConfig;
 export interface CreateCfJobsAppOptions {
+    /** Bundled nitro's `useRuntimeConfig`. Required — tests can pass a stub. */
+    useRuntimeConfig: UseRuntimeConfigFn;
     /** Fallback queue applied to jobs whose `defineJob` omits `queue`. */
     defaultQueue?: string;
 }
-export declare function createCfJobsApp<const Jobs extends readonly AnyJobDefinition[]>(jobs: Jobs, useRuntimeConfig: (event?: unknown) => CfJobsRuntimeConfig, appOpts?: CreateCfJobsAppOptions): {
+/**
+ * Builds the registry + helpers around a statically-known array of jobs. The
+ * generated `#cf-jobs/app` template imports each job source file directly and
+ * passes the resulting array in — rollup resolves nuxt `#aliases` and
+ * extensionless paths inside the bundle.
+ *
+ * `useRuntimeConfig` is injected so this module never imports `nitropack/runtime`
+ * itself; that keeps `app.ts` usable from unit tests / non-nitro consumers and
+ * avoids `#nitro-internal-virtual/*` pulling into anything that isn't bundled.
+ */
+export declare function createCfJobsApp<const Jobs extends readonly AnyJobDefinition[]>(jobs: Jobs, { useRuntimeConfig, defaultQueue }: CreateCfJobsAppOptions): {
     jobs: Jobs;
     jobRegistry: {
         jobs: Jobs;
@@ -26,7 +39,7 @@ export declare function createCfJobsApp<const Jobs extends readonly AnyJobDefini
             (name: string): AnyJobDefinition | undefined;
         };
         getJobQueue: {
-            <Name extends JobNameOf<Jobs>>(name: Name): JobQueueByName<Jobs, Name> | undefined;
+            <Name extends JobNameOf<Jobs>>(name: Name): import("./registry.js").JobQueueByName<Jobs, Name> | undefined;
             (name: string): string | undefined;
         };
         buildPayload<Name extends JobNameOf<Jobs>>(name: Name, payload: JobPayloadByName<Jobs, Name>): {
@@ -49,7 +62,7 @@ export declare function createCfJobsApp<const Jobs extends readonly AnyJobDefini
         (name: string): AnyJobDefinition | undefined;
     };
     getJobQueue: {
-        <Name extends JobNameOf<Jobs>>(name: Name): JobQueueByName<Jobs, Name> | undefined;
+        <Name extends JobNameOf<Jobs>>(name: Name): import("./registry.js").JobQueueByName<Jobs, Name> | undefined;
         (name: string): string | undefined;
     };
     getJobRoute: (name: string) => {
@@ -69,7 +82,7 @@ export declare function createCfJobsApp<const Jobs extends readonly AnyJobDefini
     buildJobPayload: <Name extends JobNameOf<Jobs>>(name: Name, payload: JobPayloadByName<Jobs, Name>) => {
         _task: Name;
     } & JobPayloadByName<Jobs, Name>;
-    prepareJob: <Name extends JobNameOf<Jobs>>(opts: PrepareRegisteredDurableJobOptions<Jobs, Name>) => Promise<import("./outbox.js").DurableJobRecord<JobQueueByName<Jobs, Name>>>;
+    prepareJob: <Name extends JobNameOf<Jobs>>(opts: PrepareRegisteredDurableJobOptions<Jobs, Name>) => Promise<import("./outbox.js").DurableJobRecord<import("./registry.js").JobQueueByName<Jobs, Name>>>;
     registerQueueConsumer: <Env extends Record<string, unknown>, Db, Logger>(nitroApp: {
         hooks: {
             hook: (name: any, handler: any) => void;

package/dist/runtime/server/app.js

@@ -3,16 +3,21 @@ import { prepareRegisteredDurableJob } from "./outbox.js";
 import {
   assertJobQueueBindings,
   createJobQueue,
-  registerRegisteredQueueConsumer,
+  processRegisteredQueueBatch,
   resolveNitroTaskEnv,
   validateJobQueueBindings,
   validateQueueBindingShape,
   validateQueueConsumerConfig
 } from "./queue.js";
 import { validateJobDefinitions } from "./registry.js";
-export function createCfJobsApp(jobs, useRuntimeConfig, appOpts = {}) {
-  const effectiveJobs = appOpts.defaultQueue ? jobs.map((job) => job.queue ? job : { ...job, queue: appOpts.defaultQueue }) : jobs;
-  const jobRegistry = defineJobRegistry(effectiveJobs);
+export function createCfJobsApp(jobs, { useRuntimeConfig, defaultQueue }) {
+  const materialized = defaultQueue ? jobs.map((j) => j.queue ? j : { ...j, queue: defaultQueue }) : jobs.slice();
+  const jobRegistry = defineJobRegistry(materialized);
+  const jobIssues = validateJobDefinitions(materialized);
+  if (jobIssues.length > 0) {
+    console.warn(`[nuxt-cf-jobs] job definition warnings:
+${jobIssues.map((i) => `  - [job:${i.name}] ${i.reason}`).join("\n")}`);
+  }
   function getQueue(sourceOrJob, maybeJob) {
     const isJobOnly = maybeJob === void 0 && isJobDefinition(sourceOrJob);
     const job = isJobOnly ? sourceOrJob : maybeJob;
@@ -30,38 +35,38 @@ export function createCfJobsApp(jobs, useRuntimeConfig, appOpts = {}) {
   function prepareJob(opts) {
     return prepareRegisteredDurableJob(jobRegistry, opts);
   }
-  let startupLogged = false;
-  function logStartupWarnings(queues) {
-    if (startupLogged)
-      return;
-    startupLogged = true;
+  function logQueueWarnings(queues) {
     const issues = [];
-    for (const issue of validateJobDefinitions(effectiveJobs))
-      issues.push(`[job:${issue.name}] ${issue.reason}`);
     for (const issue of validateQueueBindingShape(queues))
       issues.push(`[queue:${issue.queue}] ${issue.reason}: ${issue.detail}`);
-    for (const issue of validateJobQueueBindings(queues, effectiveJobs))
+    for (const issue of validateJobQueueBindings(queues, materialized))
       issues.push(`[job:${issue.jobName}] missing binding for queue "${issue.queue}"`);
-    for (const issue of validateQueueConsumerConfig(queues, effectiveJobs))
+    for (const issue of validateQueueConsumerConfig(queues, materialized))
       issues.push(`[job:${issue.jobName ?? "?"}@${issue.queue}] ${issue.reason}: ${issue.detail}`);
     if (issues.length === 0)
       return;
-    console.warn(`[nuxt-cf-jobs] configuration warnings:
+    console.warn(`[nuxt-cf-jobs] queue config warnings:
 ${issues.map((i) => `  - ${i}`).join("\n")}`);
   }
   function registerQueueConsumer(nitroApp, opts) {
-    const queues = useRuntimeConfig().cfJobs.queues;
-    logStartupWarnings(queues);
-    return registerRegisteredQueueConsumer(nitroApp, {
+    const ready = {
       ...opts,
       registry: jobRegistry,
       queues: () => useRuntimeConfig().cfJobs.queues
+    };
+    let warned = false;
+    nitroApp.hooks.hook("cloudflare:queue", async (payload) => {
+      if (!warned) {
+        warned = true;
+        logQueueWarnings(useRuntimeConfig().cfJobs.queues);
+      }
+      await processRegisteredQueueBatch(payload, ready);
     });
   }
-  const validateQueueBindings = (queues = useRuntimeConfig().cfJobs.queues) => validateJobQueueBindings(queues, effectiveJobs);
-  const assertQueueBindings = (queues = useRuntimeConfig().cfJobs.queues) => assertJobQueueBindings(queues, effectiveJobs);
+  const validateQueueBindings = (queues = useRuntimeConfig().cfJobs.queues) => validateJobQueueBindings(queues, materialized);
+  const assertQueueBindings = (queues = useRuntimeConfig().cfJobs.queues) => assertJobQueueBindings(queues, materialized);
   return {
-    jobs: effectiveJobs,
+    jobs: materialized,
     jobRegistry,
     getHandler: jobRegistry.getHandler,
     getJobDefinition: jobRegistry.getJobDefinition,

package/dist/runtime/server/registry.d.ts

@@ -1,12 +1,6 @@
 import type { JobBackoff, JobDefinition, JobFailedHandler, JobHandler, JobMiddleware, JobPayloadSchema } from './types.js';
 export type JobPayloadMap = Record<string, unknown>;
 export type AnyJobDefinition = JobDefinition<string, any, string, any, any, any>;
-export type JobDefinitionLoader<Job extends AnyJobDefinition = AnyJobDefinition> = () => Promise<Job>;
-export type JobDefinitionLoaderMap = Record<string, JobDefinitionLoader>;
-export type JobDefinitionOfLoader<Loader extends JobDefinitionLoader> = Awaited<ReturnType<Loader>>;
-export type JobDefinitionsByNameOfLoaders<Loaders extends JobDefinitionLoaderMap> = {
-    readonly [Name in keyof Loaders]: Loaders[Name] extends JobDefinitionLoader<infer Job> ? Job : never;
-};
 export type JobPayloadOf<Job extends AnyJobDefinition> = Job extends JobDefinition<string, infer Payload, string, any, any, any> ? Payload extends object ? Payload : never : never;
 export type JobMessageOf<Job extends AnyJobDefinition> = Job extends JobDefinition<infer Name, any, string, any, any, any> ? {
     _task: Name;

package/dist/types.d.mts

@@ -1,3 +1,3 @@
-export { default } from './module.mjs'
+export { default, type generateRegistryTemplate, type generateRegistryTypesTemplate } from './module.mjs'
 
 export { type ModuleOptions } from './module.mjs'

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "nuxt-cf-jobs",
   "type": "module",
-  "version": "0.0.2",
+  "version": "0.1.0",
   "description": "Nuxt module for typed Cloudflare queue jobs.",
   "author": {
     "name": "Harlan Wilton",