npm - @saga-bus/nextjs - Versions diffs - 0.1.0 - Mend

@saga-bus/nextjs 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (23) hide show

package/LICENSE +21 -0
package/README.md +140 -0
package/dist/api/index.cjs +91 -0
package/dist/api/index.d.cts +43 -0
package/dist/api/index.d.ts +43 -0
package/dist/api/index.js +6 -0
package/dist/chunk-4PDKHF26.js +65 -0
package/dist/chunk-SYXWECVX.js +51 -0
package/dist/client/index.cjs +130 -0
package/dist/client/index.d.cts +93 -0
package/dist/client/index.d.ts +93 -0
package/dist/client/index.js +100 -0
package/dist/createSagaBus-DvszRb3a.d.cts +78 -0
package/dist/createSagaBus-DvszRb3a.d.ts +78 -0
package/dist/index.cjs +143 -0
package/dist/index.d.cts +4 -0
package/dist/index.d.ts +4 -0
package/dist/index.js +14 -0
package/dist/server/index.cjs +79 -0
package/dist/server/index.d.cts +36 -0
package/dist/server/index.d.ts +36 -0
package/dist/server/index.js +10 -0
package/package.json +77 -0

package/dist/client/index.d.ts ADDED Viewed

@@ -0,0 +1,93 @@
+import { ReactNode } from 'react';
+import { SagaState } from '@saga-bus/core';
+/**
+ * Client-side saga bus configuration.
+ */
+interface SagaBusClientConfig {
+    /**
+     * API endpoint for saga operations.
+     * @default "/api/saga"
+     */
+    apiEndpoint: string;
+}
+/**
+ * Provider for saga bus client configuration.
+ *
+ * @example
+ * ```tsx
+ * // app/layout.tsx
+ * import { SagaBusProvider } from "@saga-bus/nextjs/client";
+ *
+ * export default function RootLayout({ children }) {
+ *   return (
+ *     <html>
+ *       <body>
+ *         <SagaBusProvider apiEndpoint="/api/saga">
+ *           {children}
+ *         </SagaBusProvider>
+ *       </body>
+ *     </html>
+ *   );
+ * }
+ * ```
+ */
+declare function SagaBusProvider({ children, apiEndpoint, }: {
+    children: ReactNode;
+    apiEndpoint?: string;
+}): ReactNode;
+declare function useSagaBusConfig(): SagaBusClientConfig;
+/**
+ * Hook result for saga state.
+ */
+interface UseSagaStateResult<T extends SagaState> {
+    /**
+     * Current saga state.
+     */
+    state: T | null;
+    /**
+     * Whether the state is loading.
+     */
+    isLoading: boolean;
+    /**
+     * Error if fetch failed.
+     */
+    error: Error | null;
+    /**
+     * Refresh the saga state.
+     */
+    refresh: () => Promise<void>;
+    /**
+     * Publish a message to the saga.
+     */
+    publish: (type: string, payload: unknown) => Promise<void>;
+}
+/**
+ * Hook for interacting with saga state from client components.
+ *
+ * @example
+ * ```tsx
+ * function OrderStatus({ orderId }: { orderId: string }) {
+ *   const { state, isLoading, publish } = useSagaState<OrderState>("OrderSaga", orderId);
+ *
+ *   if (isLoading) return <div>Loading...</div>;
+ *
+ *   return (
+ *     <div>
+ *       <p>Status: {state?.status}</p>
+ *       <button onClick={() => publish("OrderCancelled", { orderId })}>
+ *         Cancel
+ *       </button>
+ *     </div>
+ *   );
+ * }
+ * ```
+ */
+declare function useSagaState<T extends SagaState>(sagaName: string, sagaId: string): UseSagaStateResult<T>;
+/**
+ * Hook for publishing messages without fetching state.
+ */
+declare function usePublish(): (type: string, payload: unknown, correlationId?: string) => Promise<string>;
+export { type SagaBusClientConfig, SagaBusProvider, type UseSagaStateResult, usePublish, useSagaBusConfig, useSagaState };

package/dist/client/index.js ADDED Viewed

@@ -0,0 +1,100 @@
+// src/client/SagaBusProvider.tsx
+import { createContext, useContext } from "react";
+import { jsx } from "react/jsx-runtime";
+var SagaBusContext = createContext({
+  apiEndpoint: "/api/saga"
+});
+function SagaBusProvider({
+  children,
+  apiEndpoint = "/api/saga"
+}) {
+  return /* @__PURE__ */ jsx(SagaBusContext.Provider, { value: { apiEndpoint }, children });
+}
+function useSagaBusConfig() {
+  return useContext(SagaBusContext);
+}
+// src/client/useSaga.ts
+import { useState, useCallback, useEffect } from "react";
+function useSagaState(sagaName, sagaId) {
+  const { apiEndpoint } = useSagaBusConfig();
+  const [state, setState] = useState(null);
+  const [isLoading, setIsLoading] = useState(true);
+  const [error, setError] = useState(null);
+  const refresh = useCallback(async () => {
+    setIsLoading(true);
+    setError(null);
+    try {
+      const response = await fetch(apiEndpoint, {
+        method: "POST",
+        headers: { "Content-Type": "application/json" },
+        body: JSON.stringify({
+          action: "getState",
+          sagaName,
+          id: sagaId
+        })
+      });
+      if (!response.ok) {
+        throw new Error(`Failed to fetch saga state: ${response.statusText}`);
+      }
+      const data = await response.json();
+      setState(data.state);
+    } catch (err) {
+      setError(err instanceof Error ? err : new Error("Unknown error"));
+    } finally {
+      setIsLoading(false);
+    }
+  }, [apiEndpoint, sagaName, sagaId]);
+  const publish = useCallback(
+    async (type, payload) => {
+      const response = await fetch(apiEndpoint, {
+        method: "POST",
+        headers: { "Content-Type": "application/json" },
+        body: JSON.stringify({
+          action: "publish",
+          message: {
+            type,
+            payload,
+            correlationId: sagaId
+          }
+        })
+      });
+      if (!response.ok) {
+        throw new Error(`Failed to publish message: ${response.statusText}`);
+      }
+      await refresh();
+    },
+    [apiEndpoint, sagaId, refresh]
+  );
+  useEffect(() => {
+    void refresh();
+  }, [refresh]);
+  return { state, isLoading, error, refresh, publish };
+}
+function usePublish() {
+  const { apiEndpoint } = useSagaBusConfig();
+  return useCallback(
+    async (type, payload, correlationId) => {
+      const response = await fetch(apiEndpoint, {
+        method: "POST",
+        headers: { "Content-Type": "application/json" },
+        body: JSON.stringify({
+          action: "publish",
+          message: { type, payload, correlationId }
+        })
+      });
+      if (!response.ok) {
+        throw new Error(`Failed to publish message: ${response.statusText}`);
+      }
+      const data = await response.json();
+      return data.messageId;
+    },
+    [apiEndpoint]
+  );
+}
+export {
+  SagaBusProvider,
+  usePublish,
+  useSagaBusConfig,
+  useSagaState
+};

package/dist/createSagaBus-DvszRb3a.d.cts ADDED Viewed

@@ -0,0 +1,78 @@
+import { Transport, SagaStore, SagaState, SagaMiddleware, BaseMessage, TransportPublishOptions } from '@saga-bus/core';
+/**
+ * Saga bus configuration options.
+ */
+interface SagaBusConfig {
+    /**
+     * Transport implementation.
+     */
+    transport: Transport;
+    /**
+     * Saga store implementation.
+     */
+    store: SagaStore<SagaState>;
+    /**
+     * Middleware pipeline.
+     */
+    middleware?: SagaMiddleware[];
+    /**
+     * Default endpoint for publishing messages.
+     * @default "saga-bus"
+     */
+    defaultEndpoint?: string;
+}
+/**
+ * Saga bus instance for Next.js.
+ */
+interface SagaBus {
+    /**
+     * Publish a message.
+     */
+    publish<TMessage extends BaseMessage>(message: TMessage, options?: Partial<TransportPublishOptions>): Promise<void>;
+    /**
+     * Get saga state by ID.
+     */
+    getState<T extends SagaState>(sagaName: string, sagaId: string): Promise<T | null>;
+    /**
+     * Get saga state by correlation ID.
+     */
+    getStateByCorrelation<T extends SagaState>(sagaName: string, correlationId: string): Promise<T | null>;
+    /**
+     * Start the transport.
+     */
+    start(): Promise<void>;
+    /**
+     * Stop the transport.
+     */
+    stop(): Promise<void>;
+    /**
+     * Get the underlying transport.
+     */
+    getTransport(): Transport;
+    /**
+     * Get the underlying store.
+     */
+    getStore(): SagaStore<SagaState>;
+}
+/**
+ * Create a saga bus instance for Next.js.
+ *
+ * @example
+ * ```typescript
+ * // lib/saga-bus.ts
+ * import { createSagaBus } from "@saga-bus/nextjs/server";
+ *
+ * export const sagaBus = createSagaBus({
+ *   transport: new InMemoryTransport(),
+ *   store: new InMemorySagaStore(),
+ * });
+ * ```
+ */
+declare function createSagaBus(config: SagaBusConfig): SagaBus;
+/**
+ * Get saga state helper for server components.
+ */
+declare function getSagaState<T extends SagaState>(bus: SagaBus, sagaName: string, sagaId: string): Promise<T | null>;
+export { type SagaBusConfig as S, type SagaBus as a, createSagaBus as c, getSagaState as g };

package/dist/createSagaBus-DvszRb3a.d.ts ADDED Viewed

@@ -0,0 +1,78 @@
+import { Transport, SagaStore, SagaState, SagaMiddleware, BaseMessage, TransportPublishOptions } from '@saga-bus/core';
+/**
+ * Saga bus configuration options.
+ */
+interface SagaBusConfig {
+    /**
+     * Transport implementation.
+     */
+    transport: Transport;
+    /**
+     * Saga store implementation.
+     */
+    store: SagaStore<SagaState>;
+    /**
+     * Middleware pipeline.
+     */
+    middleware?: SagaMiddleware[];
+    /**
+     * Default endpoint for publishing messages.
+     * @default "saga-bus"
+     */
+    defaultEndpoint?: string;
+}
+/**
+ * Saga bus instance for Next.js.
+ */
+interface SagaBus {
+    /**
+     * Publish a message.
+     */
+    publish<TMessage extends BaseMessage>(message: TMessage, options?: Partial<TransportPublishOptions>): Promise<void>;
+    /**
+     * Get saga state by ID.
+     */
+    getState<T extends SagaState>(sagaName: string, sagaId: string): Promise<T | null>;
+    /**
+     * Get saga state by correlation ID.
+     */
+    getStateByCorrelation<T extends SagaState>(sagaName: string, correlationId: string): Promise<T | null>;
+    /**
+     * Start the transport.
+     */
+    start(): Promise<void>;
+    /**
+     * Stop the transport.
+     */
+    stop(): Promise<void>;
+    /**
+     * Get the underlying transport.
+     */
+    getTransport(): Transport;
+    /**
+     * Get the underlying store.
+     */
+    getStore(): SagaStore<SagaState>;
+}
+/**
+ * Create a saga bus instance for Next.js.
+ *
+ * @example
+ * ```typescript
+ * // lib/saga-bus.ts
+ * import { createSagaBus } from "@saga-bus/nextjs/server";
+ *
+ * export const sagaBus = createSagaBus({
+ *   transport: new InMemoryTransport(),
+ *   store: new InMemorySagaStore(),
+ * });
+ * ```
+ */
+declare function createSagaBus(config: SagaBusConfig): SagaBus;
+/**
+ * Get saga state helper for server components.
+ */
+declare function getSagaState<T extends SagaState>(bus: SagaBus, sagaName: string, sagaId: string): Promise<T | null>;
+export { type SagaBusConfig as S, type SagaBus as a, createSagaBus as c, getSagaState as g };

package/dist/index.cjs ADDED Viewed

@@ -0,0 +1,143 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  createSagaBus: () => createSagaBus,
+  createSagaHandler: () => createSagaHandler,
+  getSagaState: () => getSagaState,
+  withSagaBus: () => withSagaBus
+});
+module.exports = __toCommonJS(src_exports);
+// src/server/createSagaBus.ts
+var initialized = false;
+function createSagaBus(config) {
+  const { transport, store, defaultEndpoint = "saga-bus" } = config;
+  if (typeof globalThis !== "undefined" && !("EdgeRuntime" in globalThis) && !initialized) {
+    initialized = true;
+    transport.start().catch(console.error);
+  }
+  return {
+    async publish(message, options) {
+      await transport.publish(message, {
+        endpoint: defaultEndpoint,
+        ...options
+      });
+    },
+    async getState(sagaName, sagaId) {
+      return store.getById(sagaName, sagaId);
+    },
+    async getStateByCorrelation(sagaName, correlationId) {
+      return store.getByCorrelationId(sagaName, correlationId);
+    },
+    async start() {
+      await transport.start();
+    },
+    async stop() {
+      await transport.stop();
+    },
+    getTransport() {
+      return transport;
+    },
+    getStore() {
+      return store;
+    }
+  };
+}
+async function getSagaState(bus, sagaName, sagaId) {
+  return bus.getState(sagaName, sagaId);
+}
+// src/server/withSagaBus.ts
+function withSagaBus(bus, handler) {
+  return async (request) => {
+    return handler(request, { sagaBus: bus });
+  };
+}
+// src/api/createHandler.ts
+function createSagaHandler(bus) {
+  return async (request) => {
+    try {
+      const body = await request.json();
+      switch (body.action) {
+        case "publish": {
+          if (!body.message) {
+            return Response.json(
+              { error: "Message is required for publish action" },
+              { status: 400 }
+            );
+          }
+          const messageId = crypto.randomUUID();
+          const message = {
+            type: body.message.type,
+            ...body.message.payload
+          };
+          await bus.publish(message, {
+            endpoint: "saga-bus",
+            headers: body.message.correlationId ? { "x-correlation-id": body.message.correlationId } : void 0
+          });
+          return Response.json({ success: true, messageId });
+        }
+        case "getState": {
+          if (!body.sagaName || !body.id) {
+            return Response.json(
+              { error: "sagaName and id are required for getState action" },
+              { status: 400 }
+            );
+          }
+          const state = await bus.getState(body.sagaName, body.id);
+          return Response.json({ state });
+        }
+        case "getStateByCorrelation": {
+          if (!body.sagaName || !body.id) {
+            return Response.json(
+              {
+                error: "sagaName and id are required for getStateByCorrelation action"
+              },
+              { status: 400 }
+            );
+          }
+          const state = await bus.getStateByCorrelation(body.sagaName, body.id);
+          return Response.json({ state });
+        }
+        default:
+          return Response.json(
+            { error: `Unknown action: ${body.action}` },
+            { status: 400 }
+          );
+      }
+    } catch (error) {
+      console.error("Saga API error:", error);
+      return Response.json(
+        { error: error instanceof Error ? error.message : "Unknown error" },
+        { status: 500 }
+      );
+    }
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  createSagaBus,
+  createSagaHandler,
+  getSagaState,
+  withSagaBus
+});

package/dist/index.d.cts ADDED Viewed

@@ -0,0 +1,4 @@
+export { a as SagaBus, S as SagaBusConfig, c as createSagaBus, g as getSagaState } from './createSagaBus-DvszRb3a.cjs';
+export { SagaBusContext, SagaBusHandler, withSagaBus } from './server/index.cjs';
+export { SagaApiRequest, createSagaHandler } from './api/index.cjs';
+import '@saga-bus/core';

package/dist/index.d.ts ADDED Viewed

@@ -0,0 +1,4 @@
+export { a as SagaBus, S as SagaBusConfig, c as createSagaBus, g as getSagaState } from './createSagaBus-DvszRb3a.js';
+export { SagaBusContext, SagaBusHandler, withSagaBus } from './server/index.js';
+export { SagaApiRequest, createSagaHandler } from './api/index.js';
+import '@saga-bus/core';

package/dist/index.js ADDED Viewed

@@ -0,0 +1,14 @@
+import {
+  createSagaBus,
+  getSagaState,
+  withSagaBus
+} from "./chunk-SYXWECVX.js";
+import {
+  createSagaHandler
+} from "./chunk-4PDKHF26.js";
+export {
+  createSagaBus,
+  createSagaHandler,
+  getSagaState,
+  withSagaBus
+};

package/dist/server/index.cjs ADDED Viewed

@@ -0,0 +1,79 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+// src/server/index.ts
+var server_exports = {};
+__export(server_exports, {
+  createSagaBus: () => createSagaBus,
+  getSagaState: () => getSagaState,
+  withSagaBus: () => withSagaBus
+});
+module.exports = __toCommonJS(server_exports);
+// src/server/createSagaBus.ts
+var initialized = false;
+function createSagaBus(config) {
+  const { transport, store, defaultEndpoint = "saga-bus" } = config;
+  if (typeof globalThis !== "undefined" && !("EdgeRuntime" in globalThis) && !initialized) {
+    initialized = true;
+    transport.start().catch(console.error);
+  }
+  return {
+    async publish(message, options) {
+      await transport.publish(message, {
+        endpoint: defaultEndpoint,
+        ...options
+      });
+    },
+    async getState(sagaName, sagaId) {
+      return store.getById(sagaName, sagaId);
+    },
+    async getStateByCorrelation(sagaName, correlationId) {
+      return store.getByCorrelationId(sagaName, correlationId);
+    },
+    async start() {
+      await transport.start();
+    },
+    async stop() {
+      await transport.stop();
+    },
+    getTransport() {
+      return transport;
+    },
+    getStore() {
+      return store;
+    }
+  };
+}
+async function getSagaState(bus, sagaName, sagaId) {
+  return bus.getState(sagaName, sagaId);
+}
+// src/server/withSagaBus.ts
+function withSagaBus(bus, handler) {
+  return async (request) => {
+    return handler(request, { sagaBus: bus });
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  createSagaBus,
+  getSagaState,
+  withSagaBus
+});

package/dist/server/index.d.cts ADDED Viewed

@@ -0,0 +1,36 @@
+import { a as SagaBus } from '../createSagaBus-DvszRb3a.cjs';
+export { S as SagaBusConfig, c as createSagaBus, g as getSagaState } from '../createSagaBus-DvszRb3a.cjs';
+import '@saga-bus/core';
+/**
+ * Context provided to saga-enabled API handlers.
+ */
+interface SagaBusContext {
+    sagaBus: SagaBus;
+}
+/**
+ * Handler function with saga bus context.
+ */
+type SagaBusHandler = (request: Request, context: SagaBusContext) => Promise<Response>;
+/**
+ * Wrap an API handler with saga bus context.
+ *
+ * @example
+ * ```typescript
+ * // app/api/orders/route.ts
+ * import { withSagaBus } from "@saga-bus/nextjs/server";
+ * import { sagaBus } from "@/lib/saga-bus";
+ *
+ * export const POST = withSagaBus(sagaBus, async (req, { sagaBus }) => {
+ *   const body = await req.json();
+ *   await sagaBus.publish({
+ *     type: "OrderCreated",
+ *     ...body,
+ *   });
+ *   return new Response("OK");
+ * });
+ * ```
+ */
+declare function withSagaBus(bus: SagaBus, handler: SagaBusHandler): (request: Request) => Promise<Response>;
+export { SagaBus, type SagaBusContext, type SagaBusHandler, withSagaBus };

package/dist/server/index.d.ts ADDED Viewed

@@ -0,0 +1,36 @@
+import { a as SagaBus } from '../createSagaBus-DvszRb3a.js';
+export { S as SagaBusConfig, c as createSagaBus, g as getSagaState } from '../createSagaBus-DvszRb3a.js';
+import '@saga-bus/core';
+/**
+ * Context provided to saga-enabled API handlers.
+ */
+interface SagaBusContext {
+    sagaBus: SagaBus;
+}
+/**
+ * Handler function with saga bus context.
+ */
+type SagaBusHandler = (request: Request, context: SagaBusContext) => Promise<Response>;
+/**
+ * Wrap an API handler with saga bus context.
+ *
+ * @example
+ * ```typescript
+ * // app/api/orders/route.ts
+ * import { withSagaBus } from "@saga-bus/nextjs/server";
+ * import { sagaBus } from "@/lib/saga-bus";
+ *
+ * export const POST = withSagaBus(sagaBus, async (req, { sagaBus }) => {
+ *   const body = await req.json();
+ *   await sagaBus.publish({
+ *     type: "OrderCreated",
+ *     ...body,
+ *   });
+ *   return new Response("OK");
+ * });
+ * ```
+ */
+declare function withSagaBus(bus: SagaBus, handler: SagaBusHandler): (request: Request) => Promise<Response>;
+export { SagaBus, type SagaBusContext, type SagaBusHandler, withSagaBus };

package/dist/server/index.js ADDED Viewed

@@ -0,0 +1,10 @@
+import {
+  createSagaBus,
+  getSagaState,
+  withSagaBus
+} from "../chunk-SYXWECVX.js";
+export {
+  createSagaBus,
+  getSagaState,
+  withSagaBus
+};