@demokit-ai/remix 0.0.1

package/dist/fixtures-BP3SzTkj.d.cts

@@ -0,0 +1,355 @@
+import { MatchResult } from '@demokit-ai/core';
+import { LoaderFunctionArgs, ActionFunctionArgs, TypedResponse } from '@remix-run/node';
+
+/**
+ * Context passed to loader fixture handlers
+ */
+interface LoaderFixtureContext {
+    /** Route params extracted from the URL */
+    params: Record<string, string | undefined>;
+    /** The original request object */
+    request: Request;
+    /** Matched route path pattern */
+    path: string;
+}
+/**
+ * Context passed to action fixture handlers
+ */
+interface ActionFixtureContext {
+    /** Route params extracted from the URL */
+    params: Record<string, string | undefined>;
+    /** The original request object */
+    request: Request;
+    /** Matched route path pattern */
+    path: string;
+    /** Parsed form data (convenience method result) */
+    formData?: FormData;
+}
+/**
+ * Loader fixture handler function or static value
+ */
+type LoaderFixtureHandler<T = unknown> = T | ((context: LoaderFixtureContext) => T | Promise<T>);
+/**
+ * Action fixture handler function or static value
+ */
+type ActionFixtureHandler<T = unknown> = T | ((context: ActionFixtureContext) => T | Promise<T>);
+/**
+ * Map of route paths to loader fixtures
+ *
+ * Keys are route path patterns like '/users/:id' or '/projects'
+ */
+type LoaderFixtureMap = Map<string, LoaderFixtureHandler>;
+/**
+ * Object-based loader fixture map for easier definition
+ */
+type LoaderFixtureMapObject = Record<string, LoaderFixtureHandler>;
+/**
+ * Map of route paths to action fixtures
+ *
+ * Keys are route path patterns like '/users/:id' or '/projects'
+ * Values can be keyed by HTTP method: { POST: handler, PUT: handler }
+ */
+type ActionFixtureMap = Map<string, ActionFixtureHandler | MethodActionHandlers>;
+/**
+ * Object-based action fixture map for easier definition
+ */
+type ActionFixtureMapObject = Record<string, ActionFixtureHandler | MethodActionHandlers>;
+/**
+ * Action handlers organized by HTTP method
+ */
+interface MethodActionHandlers {
+    POST?: ActionFixtureHandler;
+    PUT?: ActionFixtureHandler;
+    PATCH?: ActionFixtureHandler;
+    DELETE?: ActionFixtureHandler;
+}
+/**
+ * Options for creating a demo-aware loader
+ */
+interface CreateDemoLoaderOptions<T = unknown> {
+    /**
+     * The real loader function to use when demo mode is disabled
+     */
+    loader: (args: LoaderFunctionArgs) => T | Promise<T>;
+    /**
+     * Function to check if demo mode is enabled
+     * Can check cookies, headers, or environment variables
+     * @default () => false
+     */
+    isEnabled?: (request: Request) => boolean | Promise<boolean>;
+    /**
+     * Demo fixture to return when demo mode is enabled
+     * Can be a static value or a function
+     */
+    fixture?: LoaderFixtureHandler<T>;
+    /**
+     * Simulated delay in milliseconds
+     * @default 0
+     */
+    delay?: number;
+    /**
+     * Callback when demo mode is used
+     */
+    onDemo?: (context: LoaderFixtureContext) => void;
+}
+/**
+ * Options for creating a demo-aware action
+ */
+interface CreateDemoActionOptions<T = unknown> {
+    /**
+     * The real action function to use when demo mode is disabled
+     */
+    action: (args: ActionFunctionArgs) => T | Promise<T>;
+    /**
+     * Function to check if demo mode is enabled
+     * Can check cookies, headers, or environment variables
+     * @default () => false
+     */
+    isEnabled?: (request: Request) => boolean | Promise<boolean>;
+    /**
+     * Demo fixture to return when demo mode is enabled
+     * Can be a static value, a function, or organized by HTTP method
+     */
+    fixture?: ActionFixtureHandler<T> | MethodActionHandlers;
+    /**
+     * Simulated delay in milliseconds
+     * @default 0
+     */
+    delay?: number;
+    /**
+     * Callback when demo mode is used
+     */
+    onDemo?: (context: ActionFixtureContext) => void;
+}
+/**
+ * Options for the demo route wrapper
+ */
+interface DemoRouteOptions {
+    /**
+     * Function to check if demo mode is enabled
+     */
+    isEnabled?: (request: Request) => boolean | Promise<boolean>;
+    /**
+     * Default delay for all fixtures
+     */
+    delay?: number;
+    /**
+     * Loader fixtures by path
+     */
+    loaders?: LoaderFixtureMapObject;
+    /**
+     * Action fixtures by path
+     */
+    actions?: ActionFixtureMapObject;
+    /**
+     * Callback when no fixture is found
+     */
+    onMissing?: (type: 'loader' | 'action', path: string) => void;
+}
+/**
+ * State for the demo remix context
+ */
+interface DemoRemixState {
+    /** Whether demo mode is enabled */
+    enabled: boolean;
+    /** Current loader fixtures */
+    loaders: LoaderFixtureMap;
+    /** Current action fixtures */
+    actions: ActionFixtureMap;
+}
+/**
+ * Provider configuration
+ */
+interface DemoRemixProviderConfig {
+    /**
+     * Whether demo mode is enabled
+     * @default false
+     */
+    enabled?: boolean;
+    /**
+     * Loader fixtures
+     */
+    loaders?: LoaderFixtureMapObject;
+    /**
+     * Action fixtures
+     */
+    actions?: ActionFixtureMapObject;
+    /**
+     * Simulated delay in milliseconds
+     * @default 0
+     */
+    delay?: number;
+}
+/**
+ * Props for DemoRemixProvider
+ */
+interface DemoRemixProviderProps extends DemoRemixProviderConfig {
+    children: React.ReactNode;
+}
+/**
+ * Demo mode detection options
+ */
+interface DemoModeOptions {
+    /**
+     * Cookie name to check for demo mode
+     * @default 'demokit-demo-mode'
+     */
+    cookieName?: string;
+    /**
+     * Header name to check for demo mode
+     * @default 'x-demokit-demo-mode'
+     */
+    headerName?: string;
+    /**
+     * Environment variable to check for demo mode
+     * @default 'DEMOKIT_DEMO_MODE'
+     */
+    envVar?: string;
+    /**
+     * Query parameter to check for demo mode
+     * @default 'demo'
+     */
+    queryParam?: string;
+}
+/**
+ * Server-side fixture store configuration
+ */
+interface FixtureStoreConfig {
+    /**
+     * Loader fixtures by route path
+     */
+    loaders?: LoaderFixtureMapObject;
+    /**
+     * Action fixtures by route path
+     */
+    actions?: ActionFixtureMapObject;
+}
+/**
+ * Result type from Remix loaders/actions (supports json, defer, redirect)
+ */
+type RemixResponse<T> = T | TypedResponse<T>;
+
+/**
+ * Server-side fixture store for managing demo data
+ *
+ * Use this to centralize fixture definitions for your Remix app.
+ * Works with the demo mode detection utilities.
+ */
+declare class FixtureStore {
+    private loaders;
+    private actions;
+    constructor(config?: FixtureStoreConfig);
+    /**
+     * Register a loader fixture
+     */
+    setLoader(path: string, handler: LoaderFixtureHandler): this;
+    /**
+     * Register an action fixture
+     */
+    setAction(path: string, handler: ActionFixtureHandler | MethodActionHandlers): this;
+    /**
+     * Get a loader fixture for a path
+     */
+    getLoader(path: string): LoaderFixtureHandler | undefined;
+    /**
+     * Get an action fixture for a path and method
+     */
+    getAction(path: string, method: string): ActionFixtureHandler | undefined;
+    /**
+     * Find loader fixture with match info
+     */
+    findLoader(path: string): {
+        handler: LoaderFixtureHandler;
+        match: MatchResult;
+    } | null;
+    /**
+     * Find action fixture with match info
+     */
+    findAction(path: string, method: string): {
+        handler: ActionFixtureHandler;
+        match: MatchResult;
+    } | null;
+    /**
+     * Get all loader fixtures
+     */
+    getLoaders(): LoaderFixtureMapObject;
+    /**
+     * Get all action fixtures
+     */
+    getActions(): ActionFixtureMapObject;
+    /**
+     * Clear all fixtures
+     */
+    clear(): void;
+}
+/**
+ * Create a fixture store with initial fixtures
+ *
+ * @example
+ * import { createFixtureStore } from '@demokit-ai/remix/server'
+ *
+ * export const fixtures = createFixtureStore({
+ *   loaders: {
+ *     '/users': [{ id: '1', name: 'Demo User' }],
+ *     '/users/:id': ({ params }) => ({ id: params.id, name: 'Demo User' }),
+ *   },
+ *   actions: {
+ *     '/users': {
+ *       POST: ({ formData }) => ({ id: crypto.randomUUID(), name: formData?.get('name') }),
+ *     },
+ *     '/users/:id': {
+ *       PUT: ({ formData }) => ({ updated: true }),
+ *       DELETE: ({ params }) => ({ deleted: true, id: params.id }),
+ *     },
+ *   },
+ * })
+ */
+declare function createFixtureStore(config?: FixtureStoreConfig): FixtureStore;
+/**
+ * Define loader fixtures with type inference
+ *
+ * @example
+ * const loaders = defineRemixLoaderFixtures({
+ *   '/users': [{ id: '1', name: 'Demo User' }],
+ *   '/users/:id': ({ params }) => ({ id: params.id, name: 'Demo User' }),
+ *   '/projects': async () => fetchDemoProjects(),
+ * })
+ */
+declare function defineRemixLoaderFixtures<T extends LoaderFixtureMapObject>(fixtures: T): T;
+/**
+ * Define action fixtures with type inference
+ *
+ * @example
+ * const actions = defineRemixActionFixtures({
+ *   '/users': {
+ *     POST: ({ formData }) => ({ id: crypto.randomUUID(), name: formData?.get('name') }),
+ *   },
+ *   '/users/:id': {
+ *     PUT: ({ formData }) => ({ updated: true }),
+ *     DELETE: ({ params }) => ({ deleted: true, id: params.id }),
+ *   },
+ * })
+ */
+declare function defineRemixActionFixtures<T extends ActionFixtureMapObject>(fixtures: T): T;
+/**
+ * Define complete Remix fixtures (loaders + actions)
+ *
+ * @example
+ * const { loaders, actions } = defineRemixFixtures({
+ *   loaders: {
+ *     '/users': [{ id: '1', name: 'Demo User' }],
+ *   },
+ *   actions: {
+ *     '/users': ({ formData }) => ({ created: true }),
+ *   },
+ * })
+ */
+declare function defineRemixFixtures<L extends LoaderFixtureMapObject, A extends ActionFixtureMapObject>(config: {
+    loaders?: L;
+    actions?: A;
+}): {
+    loaders: L;
+    actions: A;
+};
+
+export { type ActionFixtureHandler as A, type CreateDemoLoaderOptions as C, type DemoRemixProviderProps as D, FixtureStore as F, type LoaderFixtureHandler as L, type MethodActionHandlers as M, type RemixResponse as R, type CreateDemoActionOptions as a, type DemoRemixState as b, createFixtureStore as c, defineRemixLoaderFixtures as d, defineRemixActionFixtures as e, defineRemixFixtures as f, type LoaderFixtureContext as g, type ActionFixtureContext as h, type LoaderFixtureMap as i, type LoaderFixtureMapObject as j, type ActionFixtureMap as k, type ActionFixtureMapObject as l, type DemoRouteOptions as m, type DemoRemixProviderConfig as n, type DemoModeOptions as o, type FixtureStoreConfig as p };

package/dist/fixtures-BP3SzTkj.d.ts

@@ -0,0 +1,355 @@
+import { MatchResult } from '@demokit-ai/core';
+import { LoaderFunctionArgs, ActionFunctionArgs, TypedResponse } from '@remix-run/node';
+
+/**
+ * Context passed to loader fixture handlers
+ */
+interface LoaderFixtureContext {
+    /** Route params extracted from the URL */
+    params: Record<string, string | undefined>;
+    /** The original request object */
+    request: Request;
+    /** Matched route path pattern */
+    path: string;
+}
+/**
+ * Context passed to action fixture handlers
+ */
+interface ActionFixtureContext {
+    /** Route params extracted from the URL */
+    params: Record<string, string | undefined>;
+    /** The original request object */
+    request: Request;
+    /** Matched route path pattern */
+    path: string;
+    /** Parsed form data (convenience method result) */
+    formData?: FormData;
+}
+/**
+ * Loader fixture handler function or static value
+ */
+type LoaderFixtureHandler<T = unknown> = T | ((context: LoaderFixtureContext) => T | Promise<T>);
+/**
+ * Action fixture handler function or static value
+ */
+type ActionFixtureHandler<T = unknown> = T | ((context: ActionFixtureContext) => T | Promise<T>);
+/**
+ * Map of route paths to loader fixtures
+ *
+ * Keys are route path patterns like '/users/:id' or '/projects'
+ */
+type LoaderFixtureMap = Map<string, LoaderFixtureHandler>;
+/**
+ * Object-based loader fixture map for easier definition
+ */
+type LoaderFixtureMapObject = Record<string, LoaderFixtureHandler>;
+/**
+ * Map of route paths to action fixtures
+ *
+ * Keys are route path patterns like '/users/:id' or '/projects'
+ * Values can be keyed by HTTP method: { POST: handler, PUT: handler }
+ */
+type ActionFixtureMap = Map<string, ActionFixtureHandler | MethodActionHandlers>;
+/**
+ * Object-based action fixture map for easier definition
+ */
+type ActionFixtureMapObject = Record<string, ActionFixtureHandler | MethodActionHandlers>;
+/**
+ * Action handlers organized by HTTP method
+ */
+interface MethodActionHandlers {
+    POST?: ActionFixtureHandler;
+    PUT?: ActionFixtureHandler;
+    PATCH?: ActionFixtureHandler;
+    DELETE?: ActionFixtureHandler;
+}
+/**
+ * Options for creating a demo-aware loader
+ */
+interface CreateDemoLoaderOptions<T = unknown> {
+    /**
+     * The real loader function to use when demo mode is disabled
+     */
+    loader: (args: LoaderFunctionArgs) => T | Promise<T>;
+    /**
+     * Function to check if demo mode is enabled
+     * Can check cookies, headers, or environment variables
+     * @default () => false
+     */
+    isEnabled?: (request: Request) => boolean | Promise<boolean>;
+    /**
+     * Demo fixture to return when demo mode is enabled
+     * Can be a static value or a function
+     */
+    fixture?: LoaderFixtureHandler<T>;
+    /**
+     * Simulated delay in milliseconds
+     * @default 0
+     */
+    delay?: number;
+    /**
+     * Callback when demo mode is used
+     */
+    onDemo?: (context: LoaderFixtureContext) => void;
+}
+/**
+ * Options for creating a demo-aware action
+ */
+interface CreateDemoActionOptions<T = unknown> {
+    /**
+     * The real action function to use when demo mode is disabled
+     */
+    action: (args: ActionFunctionArgs) => T | Promise<T>;
+    /**
+     * Function to check if demo mode is enabled
+     * Can check cookies, headers, or environment variables
+     * @default () => false
+     */
+    isEnabled?: (request: Request) => boolean | Promise<boolean>;
+    /**
+     * Demo fixture to return when demo mode is enabled
+     * Can be a static value, a function, or organized by HTTP method
+     */
+    fixture?: ActionFixtureHandler<T> | MethodActionHandlers;
+    /**
+     * Simulated delay in milliseconds
+     * @default 0
+     */
+    delay?: number;
+    /**
+     * Callback when demo mode is used
+     */
+    onDemo?: (context: ActionFixtureContext) => void;
+}
+/**
+ * Options for the demo route wrapper
+ */
+interface DemoRouteOptions {
+    /**
+     * Function to check if demo mode is enabled
+     */
+    isEnabled?: (request: Request) => boolean | Promise<boolean>;
+    /**
+     * Default delay for all fixtures
+     */
+    delay?: number;
+    /**
+     * Loader fixtures by path
+     */
+    loaders?: LoaderFixtureMapObject;
+    /**
+     * Action fixtures by path
+     */
+    actions?: ActionFixtureMapObject;
+    /**
+     * Callback when no fixture is found
+     */
+    onMissing?: (type: 'loader' | 'action', path: string) => void;
+}
+/**
+ * State for the demo remix context
+ */
+interface DemoRemixState {
+    /** Whether demo mode is enabled */
+    enabled: boolean;
+    /** Current loader fixtures */
+    loaders: LoaderFixtureMap;
+    /** Current action fixtures */
+    actions: ActionFixtureMap;
+}
+/**
+ * Provider configuration
+ */
+interface DemoRemixProviderConfig {
+    /**
+     * Whether demo mode is enabled
+     * @default false
+     */
+    enabled?: boolean;
+    /**
+     * Loader fixtures
+     */
+    loaders?: LoaderFixtureMapObject;
+    /**
+     * Action fixtures
+     */
+    actions?: ActionFixtureMapObject;
+    /**
+     * Simulated delay in milliseconds
+     * @default 0
+     */
+    delay?: number;
+}
+/**
+ * Props for DemoRemixProvider
+ */
+interface DemoRemixProviderProps extends DemoRemixProviderConfig {
+    children: React.ReactNode;
+}
+/**
+ * Demo mode detection options
+ */
+interface DemoModeOptions {
+    /**
+     * Cookie name to check for demo mode
+     * @default 'demokit-demo-mode'
+     */
+    cookieName?: string;
+    /**
+     * Header name to check for demo mode
+     * @default 'x-demokit-demo-mode'
+     */
+    headerName?: string;
+    /**
+     * Environment variable to check for demo mode
+     * @default 'DEMOKIT_DEMO_MODE'
+     */
+    envVar?: string;
+    /**
+     * Query parameter to check for demo mode
+     * @default 'demo'
+     */
+    queryParam?: string;
+}
+/**
+ * Server-side fixture store configuration
+ */
+interface FixtureStoreConfig {
+    /**
+     * Loader fixtures by route path
+     */
+    loaders?: LoaderFixtureMapObject;
+    /**
+     * Action fixtures by route path
+     */
+    actions?: ActionFixtureMapObject;
+}
+/**
+ * Result type from Remix loaders/actions (supports json, defer, redirect)
+ */
+type RemixResponse<T> = T | TypedResponse<T>;
+
+/**
+ * Server-side fixture store for managing demo data
+ *
+ * Use this to centralize fixture definitions for your Remix app.
+ * Works with the demo mode detection utilities.
+ */
+declare class FixtureStore {
+    private loaders;
+    private actions;
+    constructor(config?: FixtureStoreConfig);
+    /**
+     * Register a loader fixture
+     */
+    setLoader(path: string, handler: LoaderFixtureHandler): this;
+    /**
+     * Register an action fixture
+     */
+    setAction(path: string, handler: ActionFixtureHandler | MethodActionHandlers): this;
+    /**
+     * Get a loader fixture for a path
+     */
+    getLoader(path: string): LoaderFixtureHandler | undefined;
+    /**
+     * Get an action fixture for a path and method
+     */
+    getAction(path: string, method: string): ActionFixtureHandler | undefined;
+    /**
+     * Find loader fixture with match info
+     */
+    findLoader(path: string): {
+        handler: LoaderFixtureHandler;
+        match: MatchResult;
+    } | null;
+    /**
+     * Find action fixture with match info
+     */
+    findAction(path: string, method: string): {
+        handler: ActionFixtureHandler;
+        match: MatchResult;
+    } | null;
+    /**
+     * Get all loader fixtures
+     */
+    getLoaders(): LoaderFixtureMapObject;
+    /**
+     * Get all action fixtures
+     */
+    getActions(): ActionFixtureMapObject;
+    /**
+     * Clear all fixtures
+     */
+    clear(): void;
+}
+/**
+ * Create a fixture store with initial fixtures
+ *
+ * @example
+ * import { createFixtureStore } from '@demokit-ai/remix/server'
+ *
+ * export const fixtures = createFixtureStore({
+ *   loaders: {
+ *     '/users': [{ id: '1', name: 'Demo User' }],
+ *     '/users/:id': ({ params }) => ({ id: params.id, name: 'Demo User' }),
+ *   },
+ *   actions: {
+ *     '/users': {
+ *       POST: ({ formData }) => ({ id: crypto.randomUUID(), name: formData?.get('name') }),
+ *     },
+ *     '/users/:id': {
+ *       PUT: ({ formData }) => ({ updated: true }),
+ *       DELETE: ({ params }) => ({ deleted: true, id: params.id }),
+ *     },
+ *   },
+ * })
+ */
+declare function createFixtureStore(config?: FixtureStoreConfig): FixtureStore;
+/**
+ * Define loader fixtures with type inference
+ *
+ * @example
+ * const loaders = defineRemixLoaderFixtures({
+ *   '/users': [{ id: '1', name: 'Demo User' }],
+ *   '/users/:id': ({ params }) => ({ id: params.id, name: 'Demo User' }),
+ *   '/projects': async () => fetchDemoProjects(),
+ * })
+ */
+declare function defineRemixLoaderFixtures<T extends LoaderFixtureMapObject>(fixtures: T): T;
+/**
+ * Define action fixtures with type inference
+ *
+ * @example
+ * const actions = defineRemixActionFixtures({
+ *   '/users': {
+ *     POST: ({ formData }) => ({ id: crypto.randomUUID(), name: formData?.get('name') }),
+ *   },
+ *   '/users/:id': {
+ *     PUT: ({ formData }) => ({ updated: true }),
+ *     DELETE: ({ params }) => ({ deleted: true, id: params.id }),
+ *   },
+ * })
+ */
+declare function defineRemixActionFixtures<T extends ActionFixtureMapObject>(fixtures: T): T;
+/**
+ * Define complete Remix fixtures (loaders + actions)
+ *
+ * @example
+ * const { loaders, actions } = defineRemixFixtures({
+ *   loaders: {
+ *     '/users': [{ id: '1', name: 'Demo User' }],
+ *   },
+ *   actions: {
+ *     '/users': ({ formData }) => ({ created: true }),
+ *   },
+ * })
+ */
+declare function defineRemixFixtures<L extends LoaderFixtureMapObject, A extends ActionFixtureMapObject>(config: {
+    loaders?: L;
+    actions?: A;
+}): {
+    loaders: L;
+    actions: A;
+};
+
+export { type ActionFixtureHandler as A, type CreateDemoLoaderOptions as C, type DemoRemixProviderProps as D, FixtureStore as F, type LoaderFixtureHandler as L, type MethodActionHandlers as M, type RemixResponse as R, type CreateDemoActionOptions as a, type DemoRemixState as b, createFixtureStore as c, defineRemixLoaderFixtures as d, defineRemixActionFixtures as e, defineRemixFixtures as f, type LoaderFixtureContext as g, type ActionFixtureContext as h, type LoaderFixtureMap as i, type LoaderFixtureMapObject as j, type ActionFixtureMap as k, type ActionFixtureMapObject as l, type DemoRouteOptions as m, type DemoRemixProviderConfig as n, type DemoModeOptions as o, type FixtureStoreConfig as p };