@emeryld/rrroutes-openapi 2.3.1 → 2.3.3

package/dist/web/app.d.ts

@@ -1,8 +1 @@
-import type { SerializablePreset } from '../docs/presets.js';
-import type { SerializableLeaf } from '../docs/serializer.js';
-export declare function DocsApp({ initialLeaves, presets, basePath, baseUrlSuffix, }: {
-    initialLeaves: SerializableLeaf[];
-    presets: SerializablePreset[];
-    basePath?: string;
-    baseUrlSuffix?: string;
-}): import("react/jsx-runtime").JSX.Element;
+export declare function DocsApp(): import("react/jsx-runtime").JSX.Element;

package/dist/web/main.d.ts

@@ -1 +1 @@
-import './styles/docs.css';
+import './main.css';

package/dist/web/utils/grouping.d.ts

@@ -1,10 +1,4 @@
-import type { SerializableLeaf } from '../../docs/serializer.js';
-export declare function groupLeaves(leaves: {
-    leaf: SerializableLeaf;
-    idx: number;
-}[]): Record<string, {
-    leaf: SerializableLeaf;
-    idx: number;
-}[]>;
+import type { SerializedLeaf } from '../../docs/serializer.js';
+export declare function groupLeaves(leaves: SerializedLeaf[]): Record<string, SerializedLeaf[]>;
 export declare function sortGroups(groups: string[]): string[];
 export declare function sortRoutes(aPath?: string, bPath?: string): number;

package/dist/web/utils/security.d.ts

@@ -0,0 +1,21 @@
+import type { RequestHandler, Response } from 'express';
+/**
+ * HTTP Basic password guard.
+ */
+export declare function createPasswordGuard(password: string, realm: string): RequestHandler;
+/**
+ * Cookie-based guard. Requires `req.cookies` to be populated
+ * (e.g. via `cookie-parser`).
+ */
+export declare function createCookieGuard(cookieName: string, cookieSecret?: string): RequestHandler;
+/**
+ * When auth is enabled but no password/cookie/custom guard is provided,
+ * fail closed.
+ */
+export declare function createMissingPasswordGuard(): RequestHandler;
+/**
+ * Simple IP allow-list guard. For accurate client IPs behind proxies,
+ * configure `app.set('trust proxy', true)` in your Express app.
+ */
+export declare function createIpAllowListGuard(allowed: string[]): RequestHandler;
+export declare function applyDocsSecurityHeaders(res: Response): void;

package/dist/web/utils/types.d.ts

@@ -0,0 +1,17 @@
+import { AnyLeafLowProfile, AugmentLeaves, FinalizedRegistry } from '@emeryld/rrroutes-contract';
+import { cacheLeaves } from '../v2/types/types.cacheLog';
+import { endpointLeaves } from '../v2/types/types.endpoint';
+import { logLeaves } from '../v2/types/types.log';
+import { presetLeaves } from '../v2/types/types.preset';
+import { requestLogLeaves } from '../v2/types/types.requestLog';
+type MountedLeaves<Leaves extends readonly AnyLeafLowProfile[]> = AugmentLeaves<'/__rrroutes', undefined, Leaves>;
+type AllLeaves = readonly [
+    ...MountedLeaves<typeof endpointLeaves>,
+    ...MountedLeaves<typeof requestLogLeaves>,
+    ...MountedLeaves<typeof logLeaves>,
+    ...MountedLeaves<typeof cacheLeaves>,
+    ...MountedLeaves<typeof presetLeaves>
+];
+declare const allLeaves: AllLeaves;
+export declare const leaves: FinalizedRegistry<typeof allLeaves>;
+export {};

package/dist/web/v2/AppShell.d.ts

@@ -0,0 +1,7 @@
+import { ReactNode } from 'react';
+type AppShellProps = {
+    children: ReactNode;
+    title?: string;
+};
+export declare function AppShell({ children, title }: AppShellProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/web/v2/components/JsonInput.d.ts

@@ -0,0 +1,10 @@
+export declare function JsonInput({ value, onChange, placeholder, }: {
+    value?: string;
+    onChange?: (next: string) => void;
+    placeholder?: string;
+}): import("react/jsx-runtime").JSX.Element;
+export declare function KeyValueList({ label, data, emptyLabel, }: {
+    label: string;
+    data: Record<string, string>;
+    emptyLabel: string;
+}): import("react/jsx-runtime").JSX.Element;

package/dist/web/v2/components/JsonViewer.d.ts

@@ -0,0 +1,12 @@
+export type JsonViewerProps = {
+    label: string;
+    value: unknown;
+    emptyLabel?: string;
+    collapsedLines?: number;
+};
+export declare const formatResponse: (data: unknown) => string;
+export declare const truncateLines: (text: string, maxLines: number) => string;
+/**
+ * Read-only JSON/text viewer with truncation + copy.
+ */
+export declare function JsonViewer({ label, value, emptyLabel, collapsedLines, }: JsonViewerProps): import("react/jsx-runtime").JSX.Element;

package/dist/web/v2/components/MethodBadge.d.ts

@@ -0,0 +1,4 @@
+export type MethodBadgeProps = {
+    method: string;
+};
+export declare function MethodBadge({ method }: MethodBadgeProps): import("react/jsx-runtime").JSX.Element;

package/dist/web/v2/components/New/HttpMethodChip.d.ts

@@ -0,0 +1,7 @@
+import { MethodType } from '../../types/types.base';
+type Props = {
+    method: MethodType;
+    size?: 'small' | 'medium';
+};
+export declare function HttpMethodChip({ method, size }: Props): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/web/v2/components/New/ListToolBar.d.ts

@@ -0,0 +1,11 @@
+import { ReactNode } from 'react';
+type ListToolbarProps = {
+    title?: string;
+    searchPlaceholder?: string;
+    searchValue?: string;
+    onSearchChange: (value: string) => void;
+    filtersSlot?: ReactNode;
+    actionsSlot?: ReactNode;
+};
+export declare function ListToolbar({ title, searchPlaceholder, searchValue, onSearchChange, filtersSlot, actionsSlot, }: ListToolbarProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/web/v2/components/New/MethodFiltersChips.d.ts

@@ -0,0 +1,7 @@
+import { MethodType } from '../../types/types.base.js';
+type MethodFilterChipsProps = {
+    value: MethodType[] | undefined;
+    onChange: (value: MethodType[] | undefined) => void;
+};
+export declare function MethodFilterChips({ value, onChange }: MethodFilterChipsProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/web/v2/components/New/RequestStatusChip.d.ts

@@ -0,0 +1,6 @@
+type Props = {
+    status: number;
+    size?: 'small' | 'medium';
+};
+export declare function RequestStatusChip({ status, size }: Props): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/web/v2/components/New/SplitPageLayout.d.ts

@@ -0,0 +1,7 @@
+import { ReactNode } from 'react';
+type Props = {
+    list: ReactNode;
+    detail: ReactNode;
+};
+export declare function SplitPageLayout({ list, detail }: Props): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/web/v2/components/New/StabilityChip.d.ts

@@ -0,0 +1,7 @@
+import { Endpoint } from '../../types/types.endpoint';
+type Props = {
+    value: Endpoint['stability'];
+    size?: 'small' | 'medium';
+};
+export declare function StabilityChip({ value, size }: Props): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/web/v2/components/New/StatusRangeFilter.d.ts

@@ -0,0 +1,8 @@
+export type StatusRange = 'any' | '2xx' | '3xx' | '4xx' | '5xx';
+type Props = {
+    value: StatusRange;
+    onChange: (value: StatusRange) => void;
+    size?: 'small' | 'medium';
+};
+export declare function StatusRangeFilter({ value, onChange, size }: Props): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/web/v2/components/RecordItem.d.ts

@@ -0,0 +1,34 @@
+export type RecordItem = {
+    key: string;
+    value?: string;
+    enabled: boolean;
+};
+export type RecordInput = RecordItem[];
+export type RecordInputUpdate = {
+    operation: 'add';
+    value: RecordItem;
+} | {
+    operation: 'change';
+    idx: number;
+    value: RecordItem;
+} | {
+    operation: 'remove';
+    idx: number;
+};
+type RecodItemSectionProps = {
+    title: string;
+    rows: RecordInput;
+    onUpdateRow?: (index: number, next: RecordInputUpdate) => void;
+    onAddRow?: () => void;
+    onRemoveRow?: (index: number) => void;
+    defaultOpen?: boolean;
+    showToggle?: boolean;
+    disableKey?: boolean;
+    placeholder?: {
+        key?: string;
+        value?: string;
+    };
+    gridClassName?: string;
+};
+export declare function RecordItemSection({ title, rows, onUpdateRow, onAddRow, onRemoveRow, defaultOpen, showToggle, disableKey, placeholder, }: RecodItemSectionProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/web/v2/components/ResizableSidePanel.d.ts

@@ -0,0 +1,12 @@
+import { ReactNode } from 'react';
+type ResizableSidePanelProps = {
+    children: ReactNode;
+    isVisible: boolean;
+    resizable?: boolean;
+    minWidth?: number;
+    maxWidth?: number;
+    initialWidth?: number;
+    onClose?: () => void;
+};
+declare const ResizableSidePanel: ({ children, isVisible, resizable, minWidth, maxWidth, initialWidth, onClose, }: ResizableSidePanelProps) => import("react/jsx-runtime").JSX.Element | null;
+export default ResizableSidePanel;

package/dist/web/v2/components/SchemaTable.d.ts

@@ -0,0 +1,5 @@
+import { SerializableSchemaNode } from '../../../docs/schemaIntrospection';
+export declare function SchemaTable({ node, title, }: {
+    title?: string;
+    node?: SerializableSchemaNode;
+}): import("react/jsx-runtime").JSX.Element | null;

package/dist/web/v2/components/SectionHeader.d.ts

@@ -0,0 +1,9 @@
+type Props = {
+    title: string;
+    hasRows: boolean;
+    open: boolean;
+    setOpen: (updater: (prev: boolean) => boolean) => void;
+    onAddRow?: () => void;
+};
+export declare function SectionHeader({ title, hasRows, open, setOpen, onAddRow, }: Props): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/web/v2/endpoints/EndpointDetailsPanel.d.ts

@@ -0,0 +1,5 @@
+type Props = {
+    endpointId: string;
+};
+export declare function EndpointDetailsPanel({ endpointId }: Props): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/web/v2/endpoints/EndpointList.d.ts

@@ -0,0 +1,12 @@
+import { Endpoint } from '../types/types.endpoint';
+import { EndpointFilterType } from './EndpointsPage';
+type Props = {
+    endpoints: Endpoint[];
+    total?: number;
+    filters: EndpointFilterType;
+    onFiltersChange: (next: EndpointFilterType) => void;
+    selectedEndpointId?: string;
+    onSelectEndpoint: (id: string) => void;
+};
+export declare function EndpointList({ endpoints, total, filters, onFiltersChange, selectedEndpointId, onSelectEndpoint, }: Props): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/web/v2/endpoints/EndpointsPage.d.ts

@@ -0,0 +1,4 @@
+import z from 'zod';
+import { endpointFilterSchema } from '../types/types.endpoint.js';
+export type EndpointFilterType = z.infer<typeof endpointFilterSchema>;
+export default function EndpointsPage(): import("react/jsx-runtime").JSX.Element;

package/dist/web/v2/endpoints/endpoints.utils.d.ts

@@ -0,0 +1,3 @@
+import { Endpoint } from '../types/types.endpoint';
+export type EndpointStability = Endpoint['stability'];
+export declare function buildEndpointId(endpoint: Endpoint): string;

package/dist/web/v2/stores/clientStore.d.ts

@@ -0,0 +1,48 @@
+import { RouteClient } from '@emeryld/rrroutes-client';
+import { QueryClient } from '@tanstack/react-query';
+import { ReactNode } from 'react';
+import { MethodType } from '../types/types.base';
+import { RequestLogType } from '../types/types.requestLog';
+export type EndpointRun = {
+    logs?: any;
+    error?: {
+        message: string;
+        stack?: string;
+        name?: string;
+    };
+    id: string;
+    log: RequestLogType;
+};
+export type PlaygroundInputs = {
+    query: {
+        key: string;
+        value: string;
+        enabled: boolean;
+    }[];
+    params: {
+        key: string;
+        value: string;
+        enabled: boolean;
+    }[];
+    body: string;
+};
+type ClientContextValue = {
+    client: RouteClient<string>;
+    queryClient: QueryClient;
+    baseUrl: string;
+    headers: Record<string, string>;
+    setBaseUrl: (url: string) => void;
+    getLastRun: (args: {
+        id?: string;
+        method: MethodType;
+        path: string;
+    }) => EndpointRun | undefined;
+    fetch: (method: MethodType, path: string, input: PlaygroundInputs, id: string) => Promise<EndpointRun>;
+    runs: EndpointRun[];
+};
+export declare function ClientProvider({ children, initialBaseUrl, }: {
+    children: ReactNode;
+    initialBaseUrl: string;
+}): import("react/jsx-runtime").JSX.Element;
+export declare function useClientContext(): ClientContextValue;
+export {};

package/dist/web/v2/theme.d.ts

@@ -0,0 +1,21 @@
+declare module '@mui/material/styles' {
+    interface Palette {
+        http: {
+            get: string;
+            post: string;
+            put: string;
+            patch: string;
+            delete: string;
+        };
+        status: {
+            success: string;
+            warning: string;
+            error: string;
+        };
+    }
+    interface PaletteOptions {
+        http?: Palette['http'];
+        status?: Palette['status'];
+    }
+}
+export declare const docsTheme: import("@mui/material").Theme;

package/dist/web/v2/types/types.base.d.ts

@@ -0,0 +1,30 @@
+import z from 'zod';
+export declare const METHODS: readonly ["get", "post", "put", "patch", "delete"];
+export type MethodType = (typeof METHODS)[number];
+export declare const baseEntitySchema: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    groupId: z.ZodOptional<z.ZodString>;
+    tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    createdAt: z.ZodNumber;
+    updatedAt: z.ZodNumber;
+}, z.core.$strip>;
+export declare const baseQuerySchema: z.ZodObject<{
+    beforeDate: z.ZodOptional<z.ZodString>;
+    afterDate: z.ZodOptional<z.ZodString>;
+    orderBy: z.ZodDefault<z.ZodEnum<{
+        timestamp: "timestamp";
+        duration: "duration";
+        level: "level";
+        path: "path";
+    }>>;
+    orderDirection: z.ZodDefault<z.ZodEnum<{
+        asc: "asc";
+        desc: "desc";
+    }>>;
+    searchQuery: z.ZodOptional<z.ZodString>;
+    groups: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    cursor: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;

package/dist/web/v2/types/types.cacheLog.d.ts

@@ -0,0 +1,165 @@
+import z from 'zod';
+export declare const cacheLogSchema: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    groupId: z.ZodOptional<z.ZodString>;
+    tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    createdAt: z.ZodNumber;
+    updatedAt: z.ZodNumber;
+    operation: z.ZodEnum<{
+        delete: "delete";
+        hit: "hit";
+        miss: "miss";
+        set: "set";
+    }>;
+    value: z.ZodNullable<z.ZodAny>;
+    size: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+export declare const cacheLogQuerySchema: z.ZodObject<{
+    beforeDate: z.ZodOptional<z.ZodString>;
+    afterDate: z.ZodOptional<z.ZodString>;
+    orderBy: z.ZodDefault<z.ZodEnum<{
+        timestamp: "timestamp";
+        duration: "duration";
+        level: "level";
+        path: "path";
+    }>>;
+    orderDirection: z.ZodDefault<z.ZodEnum<{
+        asc: "asc";
+        desc: "desc";
+    }>>;
+    searchQuery: z.ZodOptional<z.ZodString>;
+    groups: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    cursor: z.ZodOptional<z.ZodString>;
+    operations: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+        delete: "delete";
+        hit: "hit";
+        miss: "miss";
+        set: "set";
+    }>>>;
+}, z.core.$strip>;
+export declare const cacheLeaves: readonly [{
+    readonly method: "get";
+    readonly path: "cache";
+    readonly cfg: Readonly<{
+        description?: string | undefined;
+        tags?: string[] | undefined;
+        deprecated?: boolean | undefined;
+        queryExtensionSchema: undefined;
+        bodyFiles?: import("@emeryld/rrroutes-contract").FileField[] | undefined;
+        feed: true;
+        summary?: string | undefined;
+        docsGroup?: string | undefined;
+        stability?: "experimental" | "beta" | "stable" | "deprecated" | undefined;
+        docsHidden?: boolean | undefined;
+        docsMeta?: Record<string, unknown> | undefined;
+        bodySchema: import("@emeryld/rrroutes-contract").RouteSchema<unknown, unknown> | undefined;
+        querySchema: import("@emeryld/rrroutes-contract").RouteSchema<{
+            orderBy: "timestamp" | "duration" | "level" | "path";
+            orderDirection: "asc" | "desc";
+            beforeDate?: string | undefined;
+            afterDate?: string | undefined;
+            searchQuery?: string | undefined;
+            groups?: string[] | undefined;
+            tags?: string[] | undefined;
+            cursor?: string | undefined;
+            operations?: ("delete" | "hit" | "miss" | "set")[] | undefined;
+        }, {
+            beforeDate?: string | undefined;
+            afterDate?: string | undefined;
+            orderBy?: "timestamp" | "duration" | "level" | "path" | undefined;
+            orderDirection?: "asc" | "desc" | undefined;
+            searchQuery?: string | undefined;
+            groups?: string[] | undefined;
+            tags?: string[] | undefined;
+            cursor?: string | undefined;
+            operations?: ("delete" | "hit" | "miss" | "set")[] | undefined;
+        }>;
+        paramsSchema: undefined;
+        outputSchema: import("@emeryld/rrroutes-contract").RouteSchema<{
+            out: {
+                id: string;
+                name: string;
+                createdAt: number;
+                updatedAt: number;
+                operation: "delete" | "hit" | "miss" | "set";
+                value: any;
+                description?: string | undefined;
+                groupId?: string | undefined;
+                tags?: string[] | undefined;
+                size?: number | undefined;
+            }[];
+            meta: {
+                totalCount?: number | undefined;
+            };
+        }, {
+            out: {
+                id: string;
+                name: string;
+                createdAt: number;
+                updatedAt: number;
+                operation: "delete" | "hit" | "miss" | "set";
+                value: any;
+                description?: string | undefined;
+                groupId?: string | undefined;
+                tags?: string[] | undefined;
+                size?: number | undefined;
+            }[];
+            meta: {
+                totalCount?: number | undefined;
+            };
+        }>;
+        outputMetaSchema: import("@emeryld/rrroutes-contract").RouteSchema<{
+            totalCount?: number | undefined;
+        }, {
+            totalCount?: number | undefined;
+        }>;
+    }>;
+}, {
+    readonly method: "post";
+    readonly path: "cache";
+    readonly cfg: Readonly<{
+        description?: string | undefined;
+        tags?: string[] | undefined;
+        deprecated?: boolean | undefined;
+        queryExtensionSchema: undefined;
+        bodyFiles?: import("@emeryld/rrroutes-contract").FileField[] | undefined;
+        feed?: boolean | undefined;
+        summary?: string | undefined;
+        docsGroup?: string | undefined;
+        stability?: "experimental" | "beta" | "stable" | "deprecated" | undefined;
+        docsHidden?: boolean | undefined;
+        docsMeta?: Record<string, unknown> | undefined;
+        bodySchema: import("@emeryld/rrroutes-contract").RouteSchema<unknown, unknown> | undefined;
+        querySchema: import("@emeryld/rrroutes-contract").RouteSchema<{
+            orderBy: "timestamp" | "duration" | "level" | "path";
+            orderDirection: "asc" | "desc";
+            beforeDate?: string | undefined;
+            afterDate?: string | undefined;
+            searchQuery?: string | undefined;
+            groups?: string[] | undefined;
+            tags?: string[] | undefined;
+            cursor?: string | undefined;
+            operations?: ("delete" | "hit" | "miss" | "set")[] | undefined;
+        }, {
+            beforeDate?: string | undefined;
+            afterDate?: string | undefined;
+            orderBy?: "timestamp" | "duration" | "level" | "path" | undefined;
+            orderDirection?: "asc" | "desc" | undefined;
+            searchQuery?: string | undefined;
+            groups?: string[] | undefined;
+            tags?: string[] | undefined;
+            cursor?: string | undefined;
+            operations?: ("delete" | "hit" | "miss" | "set")[] | undefined;
+        }>;
+        paramsSchema: undefined;
+        outputSchema: import("@emeryld/rrroutes-contract").RouteSchema<{
+            meta?: string | undefined;
+        }, {
+            meta?: string | undefined;
+        }>;
+        outputMetaSchema: undefined;
+    }>;
+}];