@beignet/provider-auth-better-auth 0.0.11 → 0.0.13

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @beignet/provider-auth-better-auth
 
+## 0.0.13
+
+### Patch Changes
+
+- cac3d61: Align shared-domain, server context, and workflow-builder docs with current app conventions.
+
+## 0.0.12
+
 ## 0.0.11
 
 ## 0.0.10

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Taylor Bryant
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -65,7 +65,10 @@ application's ports type:
 
 ```ts
 // ports/auth.ts
-import type { AuthPort as BeignetAuthPort } from "@beignet/core/ports";
+import type {
+  AuthPort as BeignetAuthPort,
+  AuthSession as BeignetAuthSession,
+} from "@beignet/core/ports";
 
 export type AuthUser = {
   id: string;
@@ -77,14 +80,21 @@ export type AuthUser = {
 export type AuthSessionMetadata = unknown;
 
 export type AuthPort = BeignetAuthPort<AuthUser, AuthSessionMetadata>;
+export type AuthSession = BeignetAuthSession<AuthUser, AuthSessionMetadata>;
 ```
 
 ```ts
 // ports/index.ts
+import type { ActivityActor, GatePort } from "@beignet/core/ports";
 import type { AuthPort } from "./auth";
 
+export type AppAuthorizationContext = {
+  actor: ActivityActor;
+};
+
 export type AppPorts = {
   auth: AuthPort;
+  gate: GatePort<AppAuthorizationContext, []>;
   // ...other ports (db, mailer, eventBus, etc.)
 };
 ```
@@ -105,42 +115,72 @@ export const providers = [
 ```
 
 ```ts
-// server/index.ts
-import { createNextServer } from "@beignet/next";
-import {
-  createAnonymousActor,
-  createGate,
-  createUserActor,
-  definePorts,
-} from "@beignet/core/ports";
-import type { AppContext } from "@/app-context";
-import { routes } from "@/server/routes";
-import { providers } from "./providers";
+// app-context.ts
+import type { ActivityActor, BoundGate } from "@beignet/core/ports";
+import type { InferProviderPorts } from "@beignet/core/providers";
+import type { TraceContext } from "@beignet/core/tracing";
+import type { AppPorts } from "@/ports";
+import type { AuthSession } from "@/ports/auth";
+import type { providers } from "@/server/providers";
+
+export type AppRuntimePorts = AppPorts & InferProviderPorts<typeof providers>;
+
+export type AppContext = {
+  actor: ActivityActor;
+  auth: AuthSession | null;
+  gate: BoundGate<[]>;
+  requestId: string;
+  ports: AppRuntimePorts;
+} & Partial<TraceContext>;
+```
+
+```ts
+// infra/app-ports.ts
+import { createGate, definePorts } from "@beignet/core/ports";
+import type { AppPorts } from "@/ports";
 
-// App-owned authorization gate. Register feature policies here.
 const gate = createGate({ policies: [] });
 
-const appPorts = definePorts({
-  gate,
-  // add your app's other ports here
+export const appPorts = definePorts<AppPorts>()({
+  bound: { gate },
+  deferred: ["auth"],
 });
+```
+
+```ts
+// server/context.ts
+import { createAnonymousActor, createUserActor } from "@beignet/core/ports";
+import { defineServerContext } from "@beignet/core/server";
+import type { AppContext, AppRuntimePorts } from "@/app-context";
+
+export const appContext = defineServerContext<AppContext, AppRuntimePorts>()({
+  gate: (ports) => ports.gate,
+  request: async ({ req, ports, requestId, trace }) => {
+    const auth = await ports.auth.getSession(req);
 
-export const server = await createNextServer<AppContext>({
+    return {
+      actor: auth ? createUserActor(auth.user.id) : createAnonymousActor(),
+      auth,
+      requestId,
+      ...trace,
+      ports,
+    };
+  },
+});
+```
+
+```ts
+// server/index.ts
+import { createNextServer } from "@beignet/next";
+import { appPorts } from "@/infra/app-ports";
+import { appContext } from "@/server/context";
+import { routes } from "@/server/routes";
+import { providers } from "./providers";
+
+export const server = await createNextServer({
   ports: appPorts,
   providers,
-  context: {
-    gate: (ports) => ports.gate,
-    request: async ({ req, ports }) => {
-      const auth = await ports.auth.getSession(req);
-
-      return {
-        actor: auth ? createUserActor(auth.user.id) : createAnonymousActor(),
-        auth,
-        requestId: req.headers.get("x-request-id") ?? crypto.randomUUID(),
-        ports,
-      };
-    },
-  },
+  context: appContext,
   routes,
 });
 ```
@@ -396,39 +436,17 @@ See the [Better Auth documentation](https://better-auth.com) for details on rout
 ```ts
 import { betterAuth } from "better-auth";
 import { createNextServer } from "@beignet/next";
-import {
-  createAnonymousActor,
-  createGate,
-  createUserActor,
-  definePorts,
-} from "@beignet/core/ports";
 import { createAuthBetterAuthProvider } from "@beignet/provider-auth-better-auth";
-import type { AppContext } from "@/app-context";
+import { appPorts } from "@/infra/app-ports";
+import { appContext } from "@/server/context";
 import { routes } from "@/server/routes";
 
 const auth = betterAuth({ database: db });
 
-// App-owned authorization gate. Register feature policies here.
-const gate = createGate({ policies: [] });
-
-const appPorts = definePorts({ gate });
-
-const server = await createNextServer<AppContext>({
+const server = await createNextServer({
   ports: appPorts,
   providers: [createAuthBetterAuthProvider(auth)],
-  context: {
-    gate: (ports) => ports.gate,
-    request: async ({ req, ports }) => {
-      const auth = await ports.auth.getSession(req);
-
-      return {
-        actor: auth ? createUserActor(auth.user.id) : createAnonymousActor(),
-        auth,
-        requestId: req.headers.get("x-request-id") ?? crypto.randomUUID(),
-        ports,
-      };
-    },
-  },
+  context: appContext,
   routes,
 });
 ```
@@ -449,23 +467,11 @@ const authHook = {
   },
 };
 
-const server = await createNextServer<AppContext>({
+const server = await createNextServer({
   ports: appPorts,
   providers: [createAuthBetterAuthProvider(auth)],
   hooks: [authHook],
-  context: {
-    gate: (ports) => ports.gate,
-    request: async ({ req, ports }) => {
-      const auth = await ports.auth.getSession(req);
-
-      return {
-        actor: auth ? createUserActor(auth.user.id) : createAnonymousActor(),
-        auth,
-        requestId: req.headers.get("x-request-id") ?? crypto.randomUUID(),
-        ports,
-      };
-    },
-  },
+  context: appContext,
   routes,
 });
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@beignet/provider-auth-better-auth",
-  "version": "0.0.11",
+  "version": "0.0.13",
   "type": "module",
   "description": "Better Auth provider for Beignet - adds auth port for authentication and session management",
   "main": "./dist/index.js",