@beignet/provider-inngest 0.0.3 → 0.0.4

package/CHANGELOG.md

@@ -1,5 +1,33 @@
 # @beignet/provider-inngest
 
+## 0.0.4
+
+### Patch Changes
+
+- 8bcb31f: Mark package READMEs with Beignet's experimental alpha status and 0.0.x stability expectations.
+- d137044: Declare `@beignet/core` as a peer dependency with a lockstep version range in
+  every integration and provider package instead of a regular `"*"` dependency.
+  Installs now always resolve a single shared copy of core, so `instanceof`
+  checks such as `isContractError` and upload error identity keep working, and
+  mixed Beignet versions fail loudly at install time instead of at runtime.
+
+  If your package manager does not install peer dependencies automatically, add
+  `@beignet/core` to your app alongside these packages. `@beignet/nuqs` now also
+  declares `@beignet/react-query` as a peer dependency, and
+  `@beignet/provider-storage-s3` now expects you to install
+  `@aws-sdk/client-s3` and `@aws-sdk/s3-request-presigner` yourself, matching
+  how other providers treat their SDKs.
+
+- 603478f: Align package documentation with the canonical route registry and AppContext conventions.
+- 1a79090: Emit Node-compatible ESM: all relative imports in published packages now carry explicit .js extensions, fixing ERR_MODULE_NOT_FOUND when running the CLI or importing package dist files under plain Node.
+- 5a51869: Add schedule run attempt metadata and align durable workflow retry, backoff, terminal failure, and dead-letter documentation.
+- 69b8c35: Stop declaring `INNGEST_APP_NAME` as required provider env metadata. The provider defaults the app name to `"beignet-app"`, so `beignet doctor` no longer warns when `INNGEST_APP_NAME` is absent from app env files.
+- 44f1192: Move first-party provider diagnostics to package-owned `beignet.provider`
+  manifest metadata and have doctor read installed provider package manifests.
+- 2aa77ca: Add static provider metadata and provider wiring diagnostics for generated apps.
+- 03b1743: Document durable workflow provider conventions for retries, backoff, dead-letter state, and unsupported provider semantics.
+- 8063d38: Rename the contract front door to `defineContract`/`defineContractGroup`, rename operational commands to tasks (`@beignet/core/tasks`, `defineTasks`, `runTask`, `beignet task run`, `beignet make task`, `server/tasks.ts`, `features/<feature>/tasks/`, `paths.tasks`), and standardize context binding: context-free declarations stay top-level (`defineEvent`), while context-bound definitions come from per-capability factories (`createListeners`, `createJobs`, `createSchedules`, `createNotifications`, `createTasks`) called once in `lib/`. Top-level context-generic `defineListener`, `defineJob`, `defineSchedule`, and `defineNotification` are removed.
+
 ## 0.0.3
 
 ### Patch Changes

package/README.md

@@ -1,5 +1,9 @@
 # @beignet/provider-inngest
 
+> [!CAUTION]
+> Beignet is experimental alpha software. The `0.0.x` package line is for early
+> evaluation, and APIs may change between releases while the framework settles.
+
 Inngest-backed `JobDispatcherPort` provider for Beignet applications.
 
 The provider installs the app-facing `ctx.ports.jobs` dispatcher for durable
@@ -29,7 +33,7 @@ const appPorts = definePorts({});
 export const server = await createNextServer({
   ports: appPorts,
   providers: [inngestProvider],
-  createContext: ({ ports }) => ({
+  context: ({ ports }) => ({
     ports,
   }),
   routes,
@@ -47,12 +51,12 @@ Define jobs with `@beignet/core/jobs`, then dispatch them through
 `ctx.ports.jobs`:
 
 ```typescript
-import { createJobHandlers, retry } from "@beignet/core/jobs";
+import { createJobs, retry } from "@beignet/core/jobs";
 import { z } from "zod";
 
-const jobs = createJobHandlers<AppCtx>();
+const { defineJob } = createJobs<AppContext>();
 
-export const SendInviteEmailJob = jobs.defineJob("mail.invite.send", {
+export const SendInviteEmailJob = defineJob("mail.invite.send", {
   payload: z.object({
     inviteId: z.string(),
     inviteeEmail: z.string().email(),
@@ -69,7 +73,7 @@ export const SendInviteEmailJob = jobs.defineJob("mail.invite.send", {
   },
 });
 
-async function inviteUser(ctx: AppCtx, input: InviteUserInput) {
+async function inviteUser(ctx: AppContext, input: InviteUserInput) {
   const invite = await ctx.ports.db.invites.create({
     inviterId: ctx.actor.id,
     inviteeEmail: input.email,
@@ -194,14 +198,14 @@ and dispatch the job from the listener:
 
 ```typescript
 // features/users/listeners.ts
-import { createEventHandlers } from "@beignet/core/events";
+import { createListeners } from "@beignet/core/events";
 import { UserInvited } from "@/features/users/domain/events";
 import { SendInviteEmailJob } from "@/features/users/jobs";
-import type { AppCtx } from "@/app-context";
+import type { AppContext } from "@/app-context";
 
-const events = createEventHandlers<AppCtx>();
+const { defineListener } = createListeners<AppContext>();
 
-export const sendInviteEmail = events.defineListener(UserInvited, {
+export const sendInviteEmail = defineListener(UserInvited, {
   name: "mail.send-invite-email",
   async handle({ payload, ctx }) {
     await ctx.ports.jobs.dispatch(SendInviteEmailJob, {
@@ -232,6 +236,16 @@ backoff fields, jitter, and `retryIf` classification are outbox-worker
 semantics; `createInngestJobFunction(...)` fails fast if a job policy includes
 retry behavior that the adapter cannot honor.
 
+The Beignet terms still apply: `attempts` is the maximum total attempts,
+including the first try, while Inngest's `retries` setting is the number of
+retries after the first try. Inngest owns backoff and terminal failure handling
+for direct Inngest jobs. Use the Beignet outbox when the app needs Beignet-owned
+backoff, retry classification, or dead-letter state.
+
+This is the provider convention for external job systems: map the Beignet
+semantics the provider can actually honor, document the mapping, and fail fast
+for retry fields that would otherwise be silently ignored.
+
 Define functions separately from your Beignet server, usually in a
 serverless function or route handler:
 

package/dist/index.d.ts

@@ -177,6 +177,6 @@ export declare const inngestProvider: import("@beignet/core/providers").ServiceP
 }, z.core.$strip>, {
     inngest: InngestPort;
     jobs: JobDispatcherPort;
-}>;
+}, unknown, void>;
 export {};
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEH,OAAO,KAAK,EAEV,MAAM,EACN,YAAY,EACZ,cAAc,EACf,MAAM,oBAAoB,CAAC;AAE5B,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAC7D,OAAO,EAGL,KAAK,6BAA6B,EACnC,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,OAAO,EAAE,KAAK,eAAe,EAAE,MAAM,SAAS,CAAC;AACxD,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;GAGG;AACH,QAAA,MAAM,mBAAmB;;;iBAYvB,CAAC;AAEH;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAEhE;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B;;;OAGG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,KAAK,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACjE;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,eAAe,CAAC,EAAE,6BAA6B,CAAC;CACjD;AAED;;GAEG;AACH,MAAM,MAAM,4BAA4B,GACpC,CAAC,GACD,CAAC,GACD,CAAC,GACD,CAAC,GACD,CAAC,GACD,CAAC,GACD,CAAC,GACD,CAAC,GACD,CAAC,GACD,CAAC,GACD,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,CAAC;AAEP;;GAEG;AACH,MAAM,MAAM,yBAAyB,CAAC,GAAG,IACrC,GAAG,GACH,CAAC,CAAC,IAAI,EAAE,6BAA6B,KAAK,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC;AAEjE;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,KAAK,EAAE;QACL,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,OAAO,CAAC;KACf,CAAC;IACF;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;CACf;AAED;;GAEG;AACH,MAAM,MAAM,iCAAiC,GAAG,6BAA6B,CAAC;AAE9E;;GAEG;AACH,MAAM,WAAW,+BAA+B,CAC9C,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,cAAc,EAAE,GAAG,CAAC,EAC7C,GAAG;IAEH;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAChB;;OAEG;IACH,GAAG,EAAE,CAAC,CAAC;IACP;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,GAAG,CAAC,EAAE,yBAAyB,CAAC,GAAG,CAAC,CAAC;IACrC;;OAEG;IACH,eAAe,CAAC,EAAE,iCAAiC,CAAC;CACrD;AAgED;;GAEG;AACH,wBAAgB,0BAA0B,CACxC,MAAM,EAAE,OAAO,EACf,OAAO,GAAE,2BAAgC,GACxC,iBAAiB,CAoCnB;AAED;;;;;;GAMG;AACH,wBAAgB,wBAAwB,CACtC,GAAG,EACH,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,cAAc,EAAE,GAAG,CAAC,EAC7C,OAAO,EAAE,+BAA+B,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,eAAe,CAAC,GAAG,CAyDvE;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,eAAe;;;;;;EA4D1B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEH,OAAO,KAAK,EAEV,MAAM,EACN,YAAY,EACZ,cAAc,EACf,MAAM,oBAAoB,CAAC;AAE5B,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAC7D,OAAO,EAGL,KAAK,6BAA6B,EACnC,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,OAAO,EAAE,KAAK,eAAe,EAAE,MAAM,SAAS,CAAC;AACxD,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;GAGG;AACH,QAAA,MAAM,mBAAmB;;;iBAYvB,CAAC;AAEH;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAEhE;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B;;;OAGG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,KAAK,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACjE;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,eAAe,CAAC,EAAE,6BAA6B,CAAC;CACjD;AAED;;GAEG;AACH,MAAM,MAAM,4BAA4B,GACpC,CAAC,GACD,CAAC,GACD,CAAC,GACD,CAAC,GACD,CAAC,GACD,CAAC,GACD,CAAC,GACD,CAAC,GACD,CAAC,GACD,CAAC,GACD,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,GACF,EAAE,CAAC;AAEP;;GAEG;AACH,MAAM,MAAM,yBAAyB,CAAC,GAAG,IACrC,GAAG,GACH,CAAC,CAAC,IAAI,EAAE,6BAA6B,KAAK,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC;AAEjE;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,KAAK,EAAE;QACL,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,OAAO,CAAC;KACf,CAAC;IACF;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;CACf;AAED;;GAEG;AACH,MAAM,MAAM,iCAAiC,GAAG,6BAA6B,CAAC;AAE9E;;GAEG;AACH,MAAM,WAAW,+BAA+B,CAC9C,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,cAAc,EAAE,GAAG,CAAC,EAC7C,GAAG;IAEH;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAChB;;OAEG;IACH,GAAG,EAAE,CAAC,CAAC;IACP;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,GAAG,CAAC,EAAE,yBAAyB,CAAC,GAAG,CAAC,CAAC;IACrC;;OAEG;IACH,eAAe,CAAC,EAAE,iCAAiC,CAAC;CACrD;AAgED;;GAEG;AACH,wBAAgB,0BAA0B,CACxC,MAAM,EAAE,OAAO,EACf,OAAO,GAAE,2BAAgC,GACxC,iBAAiB,CAoCnB;AAED;;;;;;GAMG;AACH,wBAAgB,wBAAwB,CACtC,GAAG,EACH,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,cAAc,EAAE,GAAG,CAAC,EAC7C,OAAO,EAAE,+BAA+B,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,eAAe,CAAC,GAAG,CAyDvE;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,eAAe;;;;;;iBA4D1B,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@beignet/provider-inngest",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "type": "module",
   "description": "Inngest provider for Beignet - adds inngest port for background jobs and events",
   "main": "./dist/index.js",
@@ -54,11 +54,11 @@
     "node": ">=18.0.0"
   },
   "peerDependencies": {
+    "@beignet/core": ">=0.0.3 <1.0.0",
     "inngest": "^3.0.0"
   },
   "dependencies": {
-    "zod": "^4.0.0",
-    "@beignet/core": "*"
+    "zod": "^4.0.0"
   },
   "devDependencies": {
     "@beignet/devtools": "*",
@@ -66,5 +66,33 @@
     "@types/node": "^20.10.0",
     "inngest": "^3.0.0",
     "typescript": "^5.3.0"
+  },
+  "beignet": {
+    "provider": {
+      "displayName": "Inngest provider",
+      "ports": [
+        "inngest",
+        "jobs"
+      ],
+      "appPorts": [
+        {
+          "name": "jobs",
+          "type": "JobDispatcherPort"
+        }
+      ],
+      "env": [
+        "INNGEST_APP_NAME",
+        "INNGEST_EVENT_KEY"
+      ],
+      "watchers": [
+        "jobs"
+      ],
+      "registration": {
+        "required": true,
+        "tokens": [
+          "inngestProvider"
+        ]
+      }
+    }
   }
 }