@btst/stack 1.5.2 → 1.7.0

package/dist/plugins/form-builder/query-keys.d.ts

@@ -0,0 +1,74 @@
+import * as _tanstack_react_query from '@tanstack/react-query';
+import { createApiClient } from '@btst/stack/plugins/client';
+import { P as PaginatedForms, S as SerializedForm, c as PaginatedFormSubmissions, b as SerializedFormSubmissionWithData } from '../../shared/stack.DzH_wcvr.js';
+import { FormBuilderApiRouter } from './api/index.js';
+import '@btst/stack/plugins/api';
+import 'better-call';
+import 'zod';
+
+interface FormListParams {
+    status?: "active" | "inactive" | "archived";
+    limit?: number;
+    offset?: number;
+}
+interface SubmissionListParams {
+    formId: string;
+    limit?: number;
+    offset?: number;
+}
+/**
+ * Create Form Builder query keys for React Query
+ * Used by consumers to fetch forms and submissions
+ */
+declare function createFormBuilderQueryKeys(client: ReturnType<typeof createApiClient<FormBuilderApiRouter>>, headers?: HeadersInit): {
+    forms: {
+        _def: readonly ["forms"];
+    } & {
+        list: ((params?: FormListParams | undefined) => Omit<{
+            queryKey: readonly ["forms", "list", string, FormListParams];
+            queryFn: _tanstack_react_query.QueryFunction<PaginatedForms, readonly ["forms", "list", string, FormListParams]>;
+        } & {
+            _def: readonly ["forms", "list"];
+        }, "_def">) & {
+            _def: readonly ["forms", "list"];
+        };
+        bySlug: ((slug: string) => Omit<{
+            queryKey: readonly ["forms", "bySlug", string, string];
+            queryFn: _tanstack_react_query.QueryFunction<SerializedForm | null, readonly ["forms", "bySlug", string, string]>;
+        } & {
+            _def: readonly ["forms", "bySlug"];
+        }, "_def">) & {
+            _def: readonly ["forms", "bySlug"];
+        };
+        byId: ((id: string) => Omit<{
+            queryKey: readonly ["forms", "byId", string, string];
+            queryFn: _tanstack_react_query.QueryFunction<SerializedForm | null, readonly ["forms", "byId", string, string]>;
+        } & {
+            _def: readonly ["forms", "byId"];
+        }, "_def">) & {
+            _def: readonly ["forms", "byId"];
+        };
+    };
+    formSubmissions: {
+        _def: readonly ["formSubmissions"];
+    } & {
+        list: ((params: SubmissionListParams) => Omit<{
+            queryKey: readonly ["formSubmissions", "list", SubmissionListParams];
+            queryFn: _tanstack_react_query.QueryFunction<PaginatedFormSubmissions<Record<string, unknown>>, readonly ["formSubmissions", "list", SubmissionListParams]>;
+        } & {
+            _def: readonly ["formSubmissions", "list"];
+        }, "_def">) & {
+            _def: readonly ["formSubmissions", "list"];
+        };
+        detail: ((formId: string, subId: string) => Omit<{
+            queryKey: readonly ["formSubmissions", "detail", string, string];
+            queryFn: _tanstack_react_query.QueryFunction<SerializedFormSubmissionWithData<Record<string, unknown>> | null, readonly ["formSubmissions", "detail", string, string]>;
+        } & {
+            _def: readonly ["formSubmissions", "detail"];
+        }, "_def">) & {
+            _def: readonly ["formSubmissions", "detail"];
+        };
+    };
+};
+
+export { createFormBuilderQueryKeys };

package/dist/plugins/form-builder/query-keys.mjs

@@ -0,0 +1,141 @@
+import { mergeQueryKeys, createQueryKeys } from '@lukemorales/query-key-factory';
+
+function isErrorResponse(response) {
+  if (typeof response !== "object" || response === null) {
+    return false;
+  }
+  const obj = response;
+  return "error" in obj && obj.error !== null && obj.error !== void 0;
+}
+function toError(error) {
+  if (error instanceof Error) {
+    return error;
+  }
+  if (typeof error === "object" && error !== null) {
+    const errorObj = error;
+    const message = (typeof errorObj.message === "string" ? errorObj.message : null) || (typeof errorObj.error === "string" ? errorObj.error : null) || JSON.stringify(error);
+    const err = new Error(message);
+    Object.assign(err, error);
+    return err;
+  }
+  return new Error(String(error));
+}
+function createFormBuilderQueryKeys(client, headers) {
+  const forms = createFormsQueries(client, headers);
+  const submissions = createSubmissionsQueries(client, headers);
+  return mergeQueryKeys(forms, submissions);
+}
+function createFormsQueries(client, headers) {
+  return createQueryKeys("forms", {
+    list: (params = {}) => ({
+      queryKey: ["list", params],
+      queryFn: async () => {
+        try {
+          const response = await client("/forms", {
+            method: "GET",
+            query: {
+              status: params.status,
+              limit: params.limit ?? 20,
+              offset: params.offset ?? 0
+            },
+            headers
+          });
+          if (isErrorResponse(response)) {
+            throw toError(response.error);
+          }
+          return response.data;
+        } catch (error) {
+          throw error;
+        }
+      }
+    }),
+    bySlug: (slug) => ({
+      queryKey: ["bySlug", slug],
+      queryFn: async () => {
+        if (!slug) return null;
+        try {
+          const response = await client("/forms/:slug", {
+            method: "GET",
+            params: { slug },
+            headers
+          });
+          if (isErrorResponse(response)) {
+            throw toError(response.error);
+          }
+          return response.data;
+        } catch (error) {
+          throw error;
+        }
+      }
+    }),
+    byId: (id) => ({
+      queryKey: ["byId", id],
+      queryFn: async () => {
+        if (!id) return null;
+        try {
+          const response = await client("/forms/id/:id", {
+            method: "GET",
+            params: { id },
+            headers
+          });
+          if (isErrorResponse(response)) {
+            throw toError(response.error);
+          }
+          return response.data;
+        } catch (error) {
+          throw error;
+        }
+      }
+    })
+  });
+}
+function createSubmissionsQueries(client, headers) {
+  return createQueryKeys("formSubmissions", {
+    list: (params) => ({
+      queryKey: [params],
+      queryFn: async () => {
+        try {
+          const response = await client("/forms/:formId/submissions", {
+            method: "GET",
+            params: { formId: params.formId },
+            query: {
+              limit: params.limit ?? 20,
+              offset: params.offset ?? 0
+            },
+            headers
+          });
+          if (isErrorResponse(response)) {
+            throw toError(response.error);
+          }
+          return response.data;
+        } catch (error) {
+          throw error;
+        }
+      }
+    }),
+    detail: (formId, subId) => ({
+      queryKey: [formId, subId],
+      queryFn: async () => {
+        if (!formId || !subId) return null;
+        try {
+          const response = await client(
+            "/forms/:formId/submissions/:subId",
+            {
+              method: "GET",
+              params: { formId, subId },
+              headers
+            }
+          );
+          if (isErrorResponse(response)) {
+            throw toError(response.error);
+          }
+          return response.data;
+        } catch (error) {
+          throw error;
+        }
+      }
+    })
+  });
+}
+
+export { createFormBuilderQueryKeys };

package/dist/plugins/form-builder/style.css

@@ -0,0 +1,19 @@
+@import "./client.css";
+
+/*
+ * Form Builder Plugin CSS - Includes Tailwind class scanning
+ * 
+ * When consumed from npm, Tailwind v4 will automatically scan this package's
+ * source files for Tailwind classes. Consumers only need:
+ *   @import "@btst/stack/plugins/form-builder/css";
+ */
+
+/* Scan this package's source files for Tailwind classes */
+@source "../../../src/**/*.{ts,tsx}";
+
+/* Scan UI package components (when installed as npm package the UI package will be in this dir) */
+@source "../../packages/ui/src";
+
+/*
+* alternatively consumer can use @source "../node_modules/@btst/stack/src/**\/*.{ts,tsx}";
+*/

package/dist/plugins/open-api/api/index.cjs

@@ -0,0 +1,9 @@
+'use strict';
+
+const plugin = require('../../../packages/better-stack/src/plugins/open-api/api/plugin.cjs');
+const generator = require('../../../packages/better-stack/src/plugins/open-api/api/generator.cjs');
+
+
+
+exports.openApiBackendPlugin = plugin.openApiBackendPlugin;
+exports.generateOpenAPISchema = generator.generateOpenAPISchema;

package/dist/plugins/open-api/api/index.d.cts

@@ -0,0 +1,95 @@
+import * as _btst_stack_plugins_api from '@btst/stack/plugins/api';
+import * as better_call from 'better-call';
+import { a as BetterStackContext } from '../../../shared/stack.CSce37mX.cjs';
+import '@btst/yar';
+import '@btst/db';
+
+/**
+ * Scalar API Reference themes
+ */
+type ScalarTheme = "alternate" | "default" | "moon" | "purple" | "solarized" | "bluePlanet" | "saturn" | "kepler" | "mars" | "deepSpace" | "laserwave" | "none";
+/**
+ * OpenAPI plugin configuration options
+ */
+interface OpenAPIOptions {
+    /**
+     * The path to the OpenAPI reference page
+     * This path is relative to the API base path
+     * @default "/reference"
+     */
+    path?: string;
+    /**
+     * Disable the default HTML reference page
+     * Only the JSON schema endpoint will be available
+     * @default false
+     */
+    disableDefaultReference?: boolean;
+    /**
+     * Theme for the Scalar API Reference page
+     * @default "default"
+     */
+    theme?: ScalarTheme;
+    /**
+     * CSP nonce for inline scripts
+     * Required for strict Content Security Policy
+     */
+    nonce?: string;
+    /**
+     * Custom title for the API documentation
+     * @default "Better Stack API"
+     */
+    title?: string;
+    /**
+     * Custom description for the API documentation
+     */
+    description?: string;
+    /**
+     * API version string
+     * @default "1.0.0"
+     */
+    version?: string;
+}
+/**
+ * OpenAPI plugin for Better Stack
+ *
+ * Automatically generates OpenAPI 3.1 documentation for all registered plugins.
+ * Provides both a JSON schema endpoint and an interactive Scalar UI reference page.
+ *
+ * @example
+ * ```ts
+ * const { handler } = betterStack({
+ *   basePath: "/api/data",
+ *   plugins: {
+ *     blog: blogBackendPlugin(),
+ *     cms: cmsBackendPlugin({ ... }),
+ *     openApi: openApiBackendPlugin({ theme: "moon" }),
+ *   },
+ *   adapter: (db) => createMemoryAdapter(db)({}),
+ * });
+ *
+ * // Access:
+ * // - GET /api/data/open-api/schema - JSON schema
+ * // - GET /api/data/reference - Interactive Scalar UI
+ * ```
+ */
+declare const openApiBackendPlugin: (options?: OpenAPIOptions) => _btst_stack_plugins_api.BackendPlugin<{
+    readonly generateSchema: better_call.StrictEndpoint<"/open-api/schema", {
+        method: "GET";
+    }, Record<string, any>>;
+    readonly reference: better_call.StrictEndpoint<string, {
+        method: "GET";
+    }, Response>;
+}>;
+type OpenApiRouter = ReturnType<ReturnType<typeof openApiBackendPlugin>["routes"]>;
+
+/**
+ * Generate OpenAPI 3.1 schema from Better Stack context
+ */
+declare function generateOpenAPISchema(context: BetterStackContext, options?: {
+    title?: string;
+    description?: string;
+    version?: string;
+}): Record<string, any>;
+
+export { generateOpenAPISchema, openApiBackendPlugin };
+export type { OpenAPIOptions, OpenApiRouter, ScalarTheme };

package/dist/plugins/open-api/api/index.d.mts

@@ -0,0 +1,95 @@
+import * as _btst_stack_plugins_api from '@btst/stack/plugins/api';
+import * as better_call from 'better-call';
+import { a as BetterStackContext } from '../../../shared/stack.CSce37mX.mjs';
+import '@btst/yar';
+import '@btst/db';
+
+/**
+ * Scalar API Reference themes
+ */
+type ScalarTheme = "alternate" | "default" | "moon" | "purple" | "solarized" | "bluePlanet" | "saturn" | "kepler" | "mars" | "deepSpace" | "laserwave" | "none";
+/**
+ * OpenAPI plugin configuration options
+ */
+interface OpenAPIOptions {
+    /**
+     * The path to the OpenAPI reference page
+     * This path is relative to the API base path
+     * @default "/reference"
+     */
+    path?: string;
+    /**
+     * Disable the default HTML reference page
+     * Only the JSON schema endpoint will be available
+     * @default false
+     */
+    disableDefaultReference?: boolean;
+    /**
+     * Theme for the Scalar API Reference page
+     * @default "default"
+     */
+    theme?: ScalarTheme;
+    /**
+     * CSP nonce for inline scripts
+     * Required for strict Content Security Policy
+     */
+    nonce?: string;
+    /**
+     * Custom title for the API documentation
+     * @default "Better Stack API"
+     */
+    title?: string;
+    /**
+     * Custom description for the API documentation
+     */
+    description?: string;
+    /**
+     * API version string
+     * @default "1.0.0"
+     */
+    version?: string;
+}
+/**
+ * OpenAPI plugin for Better Stack
+ *
+ * Automatically generates OpenAPI 3.1 documentation for all registered plugins.
+ * Provides both a JSON schema endpoint and an interactive Scalar UI reference page.
+ *
+ * @example
+ * ```ts
+ * const { handler } = betterStack({
+ *   basePath: "/api/data",
+ *   plugins: {
+ *     blog: blogBackendPlugin(),
+ *     cms: cmsBackendPlugin({ ... }),
+ *     openApi: openApiBackendPlugin({ theme: "moon" }),
+ *   },
+ *   adapter: (db) => createMemoryAdapter(db)({}),
+ * });
+ *
+ * // Access:
+ * // - GET /api/data/open-api/schema - JSON schema
+ * // - GET /api/data/reference - Interactive Scalar UI
+ * ```
+ */
+declare const openApiBackendPlugin: (options?: OpenAPIOptions) => _btst_stack_plugins_api.BackendPlugin<{
+    readonly generateSchema: better_call.StrictEndpoint<"/open-api/schema", {
+        method: "GET";
+    }, Record<string, any>>;
+    readonly reference: better_call.StrictEndpoint<string, {
+        method: "GET";
+    }, Response>;
+}>;
+type OpenApiRouter = ReturnType<ReturnType<typeof openApiBackendPlugin>["routes"]>;
+
+/**
+ * Generate OpenAPI 3.1 schema from Better Stack context
+ */
+declare function generateOpenAPISchema(context: BetterStackContext, options?: {
+    title?: string;
+    description?: string;
+    version?: string;
+}): Record<string, any>;
+
+export { generateOpenAPISchema, openApiBackendPlugin };
+export type { OpenAPIOptions, OpenApiRouter, ScalarTheme };

package/dist/plugins/open-api/api/index.d.ts

@@ -0,0 +1,95 @@
+import * as _btst_stack_plugins_api from '@btst/stack/plugins/api';
+import * as better_call from 'better-call';
+import { a as BetterStackContext } from '../../../shared/stack.CSce37mX.js';
+import '@btst/yar';
+import '@btst/db';
+
+/**
+ * Scalar API Reference themes
+ */
+type ScalarTheme = "alternate" | "default" | "moon" | "purple" | "solarized" | "bluePlanet" | "saturn" | "kepler" | "mars" | "deepSpace" | "laserwave" | "none";
+/**
+ * OpenAPI plugin configuration options
+ */
+interface OpenAPIOptions {
+    /**
+     * The path to the OpenAPI reference page
+     * This path is relative to the API base path
+     * @default "/reference"
+     */
+    path?: string;
+    /**
+     * Disable the default HTML reference page
+     * Only the JSON schema endpoint will be available
+     * @default false
+     */
+    disableDefaultReference?: boolean;
+    /**
+     * Theme for the Scalar API Reference page
+     * @default "default"
+     */
+    theme?: ScalarTheme;
+    /**
+     * CSP nonce for inline scripts
+     * Required for strict Content Security Policy
+     */
+    nonce?: string;
+    /**
+     * Custom title for the API documentation
+     * @default "Better Stack API"
+     */
+    title?: string;
+    /**
+     * Custom description for the API documentation
+     */
+    description?: string;
+    /**
+     * API version string
+     * @default "1.0.0"
+     */
+    version?: string;
+}
+/**
+ * OpenAPI plugin for Better Stack
+ *
+ * Automatically generates OpenAPI 3.1 documentation for all registered plugins.
+ * Provides both a JSON schema endpoint and an interactive Scalar UI reference page.
+ *
+ * @example
+ * ```ts
+ * const { handler } = betterStack({
+ *   basePath: "/api/data",
+ *   plugins: {
+ *     blog: blogBackendPlugin(),
+ *     cms: cmsBackendPlugin({ ... }),
+ *     openApi: openApiBackendPlugin({ theme: "moon" }),
+ *   },
+ *   adapter: (db) => createMemoryAdapter(db)({}),
+ * });
+ *
+ * // Access:
+ * // - GET /api/data/open-api/schema - JSON schema
+ * // - GET /api/data/reference - Interactive Scalar UI
+ * ```
+ */
+declare const openApiBackendPlugin: (options?: OpenAPIOptions) => _btst_stack_plugins_api.BackendPlugin<{
+    readonly generateSchema: better_call.StrictEndpoint<"/open-api/schema", {
+        method: "GET";
+    }, Record<string, any>>;
+    readonly reference: better_call.StrictEndpoint<string, {
+        method: "GET";
+    }, Response>;
+}>;
+type OpenApiRouter = ReturnType<ReturnType<typeof openApiBackendPlugin>["routes"]>;
+
+/**
+ * Generate OpenAPI 3.1 schema from Better Stack context
+ */
+declare function generateOpenAPISchema(context: BetterStackContext, options?: {
+    title?: string;
+    description?: string;
+    version?: string;
+}): Record<string, any>;
+
+export { generateOpenAPISchema, openApiBackendPlugin };
+export type { OpenAPIOptions, OpenApiRouter, ScalarTheme };

package/dist/plugins/open-api/api/index.mjs

@@ -0,0 +1,2 @@
+export { openApiBackendPlugin } from '../../../packages/better-stack/src/plugins/open-api/api/plugin.mjs';
+export { generateOpenAPISchema } from '../../../packages/better-stack/src/plugins/open-api/api/generator.mjs';

package/dist/shared/stack.AX5nZ6A3.d.cts

@@ -0,0 +1,86 @@
+import { z } from 'zod';
+
+/**
+ * Unified Schema Converter Module
+ *
+ * Provides consistent bidirectional conversion between Zod schemas and JSON Schema,
+ * handling all edge cases in one place:
+ *
+ * 1. Date handling: z.date() ↔ { type: "string", format: "date-time" }
+ * 2. Steps metadata: Preserves multi-step form configuration
+ * 3. Step group mapping: Tracks which fields belong to which step
+ * 4. Date constraints: Preserves min/max date validations
+ *
+ * Usage:
+ * ```ts
+ * // Zod → JSON Schema (for storage/transport)
+ * const jsonSchema = zodToFormSchema(myZodSchema);
+ *
+ * // JSON Schema → Zod (for validation)
+ * const zodSchema = formSchemaToZod(jsonSchema);
+ * ```
+ */
+
+interface FormStep {
+    id: string;
+    title: string;
+}
+interface FormSchemaMetadata {
+    /** Multi-step form step definitions */
+    steps?: FormStep[];
+    /** Map of field names to their step indices */
+    stepGroupMap?: Record<string, number>;
+}
+interface JsonSchemaProperty {
+    type?: string;
+    format?: string;
+    formatMinimum?: string;
+    formatMaximum?: string;
+    stepGroup?: number;
+    properties?: Record<string, JsonSchemaProperty>;
+    [key: string]: unknown;
+}
+interface FormJsonSchema {
+    type?: string;
+    properties?: Record<string, JsonSchemaProperty>;
+    required?: string[];
+    steps?: FormStep[];
+    stepGroupMap?: Record<string, number>;
+    [key: string]: unknown;
+}
+/**
+ * Convert a Zod schema to JSON Schema with proper handling for:
+ * - z.date() → { type: "string", format: "date-time" }
+ * - Date min/max constraints → formatMinimum/formatMaximum
+ * - Steps metadata (if provided via schema.meta() or explicit metadata param)
+ *
+ * @param schema - The Zod schema to convert
+ * @param metadata - Optional explicit metadata to include (overrides schema meta)
+ */
+declare function zodToFormSchema<T extends z.ZodType>(schema: T, metadata?: FormSchemaMetadata): FormJsonSchema;
+/**
+ * Convert JSON Schema to Zod schema with proper handling for:
+ * - { type: "string", format: "date-time" } → date field (with constraints)
+ * - Steps metadata re-attachment (preserved via .meta())
+ * - Step group mapping
+ *
+ * @param jsonSchema - The JSON Schema to convert
+ * @returns A Zod schema ready for validation, with all metadata preserved
+ */
+declare function formSchemaToZod(jsonSchema: FormJsonSchema): z.ZodType;
+/**
+ * Check if a JSON Schema has multi-step configuration.
+ */
+declare function hasSteps(jsonSchema: FormJsonSchema): boolean;
+/**
+ * Get steps from a JSON Schema.
+ */
+declare function getSteps(jsonSchema: FormJsonSchema): FormStep[];
+/**
+ * Get the step group map from a JSON Schema.
+ * Returns a map of field names to step indices.
+ */
+declare function getStepGroupMap(jsonSchema: FormJsonSchema): Record<string, number>;
+
+export { getStepGroupMap as a, formSchemaToZod as f, getSteps as g, hasSteps as h, zodToFormSchema as z };
+export type { FormStep as F, FormSchemaMetadata as b };