@objectstack/spec 0.3.1 → 0.3.3

package/dist/api/router.zod.d.ts

@@ -0,0 +1,182 @@
+import { z } from 'zod';
+/**
+ * HTTP Method Enum
+ */
+export declare const HttpMethod: z.ZodEnum<["GET", "POST", "PUT", "DELETE", "PATCH", "HEAD", "OPTIONS"]>;
+export type HttpMethod = z.infer<typeof HttpMethod>;
+/**
+ * Route Category Enum
+ * Classifies routes for middleware application and security policies.
+ */
+export declare const RouteCategory: z.ZodEnum<["system", "api", "auth", "static", "webhook", "plugin"]>;
+export type RouteCategory = z.infer<typeof RouteCategory>;
+/**
+ * Route Definition Schema
+ * Describes a single routable endpoint in the Kernel.
+ */
+export declare const RouteDefinitionSchema: z.ZodObject<{
+    /**
+     * HTTP Method
+     */
+    method: z.ZodEnum<["GET", "POST", "PUT", "DELETE", "PATCH", "HEAD", "OPTIONS"]>;
+    /**
+     * URL Path Pattern (supports parameters like /user/:id)
+     */
+    path: z.ZodString;
+    /**
+     * Route Type/Category
+     */
+    category: z.ZodDefault<z.ZodEnum<["system", "api", "auth", "static", "webhook", "plugin"]>>;
+    /**
+     * Handler Identifier
+     * References an internal function or plugin action ID.
+     */
+    handler: z.ZodString;
+    /**
+     * Route specific metadata
+     */
+    summary: z.ZodOptional<z.ZodString>;
+    description: z.ZodOptional<z.ZodString>;
+    /**
+     * Security constraints
+     */
+    public: z.ZodDefault<z.ZodBoolean>;
+    permissions: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    /**
+     * Performance hints
+     */
+    timeout: z.ZodOptional<z.ZodNumber>;
+    rateLimit: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    path: string;
+    method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "HEAD" | "OPTIONS";
+    handler: string;
+    public: boolean;
+    category: "api" | "system" | "webhook" | "plugin" | "auth" | "static";
+    summary?: string | undefined;
+    description?: string | undefined;
+    timeout?: number | undefined;
+    rateLimit?: string | undefined;
+    permissions?: string[] | undefined;
+}, {
+    path: string;
+    method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "HEAD" | "OPTIONS";
+    handler: string;
+    summary?: string | undefined;
+    description?: string | undefined;
+    timeout?: number | undefined;
+    public?: boolean | undefined;
+    rateLimit?: string | undefined;
+    permissions?: string[] | undefined;
+    category?: "api" | "system" | "webhook" | "plugin" | "auth" | "static" | undefined;
+}>;
+export type RouteDefinition = z.infer<typeof RouteDefinitionSchema>;
+/**
+ * Router Configuration Schema
+ * Global routing table configuration.
+ */
+export declare const RouterConfigSchema: z.ZodObject<{
+    /**
+     * URL Prefix for all kernel routes
+     */
+    basePath: z.ZodDefault<z.ZodString>;
+    /**
+     * Standard Protocol Mounts (Relative to basePath)
+     */
+    mounts: z.ZodDefault<z.ZodObject<{
+        data: z.ZodDefault<z.ZodString>;
+        metadata: z.ZodDefault<z.ZodString>;
+        auth: z.ZodDefault<z.ZodString>;
+        automation: z.ZodDefault<z.ZodString>;
+        storage: z.ZodDefault<z.ZodString>;
+        graphql: z.ZodDefault<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        data: string;
+        metadata: string;
+        storage: string;
+        auth: string;
+        automation: string;
+        graphql: string;
+    }, {
+        data?: string | undefined;
+        metadata?: string | undefined;
+        storage?: string | undefined;
+        auth?: string | undefined;
+        automation?: string | undefined;
+        graphql?: string | undefined;
+    }>>;
+    /**
+     * Cross-Origin Resource Sharing
+     */
+    cors: z.ZodOptional<z.ZodObject<{
+        enabled: z.ZodDefault<z.ZodBoolean>;
+        origin: z.ZodDefault<z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>>;
+        methods: z.ZodOptional<z.ZodArray<z.ZodEnum<["GET", "POST", "PUT", "DELETE", "PATCH", "HEAD", "OPTIONS"]>, "many">>;
+    }, "strip", z.ZodTypeAny, {
+        enabled: boolean;
+        origin: string | string[];
+        methods?: ("GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "HEAD" | "OPTIONS")[] | undefined;
+    }, {
+        enabled?: boolean | undefined;
+        origin?: string | string[] | undefined;
+        methods?: ("GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "HEAD" | "OPTIONS")[] | undefined;
+    }>>;
+    /**
+     * Static asset mounts
+     */
+    staticMounts: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        path: z.ZodString;
+        dir: z.ZodString;
+        cacheControl: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        path: string;
+        dir: string;
+        cacheControl?: string | undefined;
+    }, {
+        path: string;
+        dir: string;
+        cacheControl?: string | undefined;
+    }>, "many">>;
+}, "strip", z.ZodTypeAny, {
+    basePath: string;
+    mounts: {
+        data: string;
+        metadata: string;
+        storage: string;
+        auth: string;
+        automation: string;
+        graphql: string;
+    };
+    cors?: {
+        enabled: boolean;
+        origin: string | string[];
+        methods?: ("GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "HEAD" | "OPTIONS")[] | undefined;
+    } | undefined;
+    staticMounts?: {
+        path: string;
+        dir: string;
+        cacheControl?: string | undefined;
+    }[] | undefined;
+}, {
+    basePath?: string | undefined;
+    mounts?: {
+        data?: string | undefined;
+        metadata?: string | undefined;
+        storage?: string | undefined;
+        auth?: string | undefined;
+        automation?: string | undefined;
+        graphql?: string | undefined;
+    } | undefined;
+    cors?: {
+        enabled?: boolean | undefined;
+        origin?: string | string[] | undefined;
+        methods?: ("GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "HEAD" | "OPTIONS")[] | undefined;
+    } | undefined;
+    staticMounts?: {
+        path: string;
+        dir: string;
+        cacheControl?: string | undefined;
+    }[] | undefined;
+}>;
+export type RouterConfig = z.infer<typeof RouterConfigSchema>;
+//# sourceMappingURL=router.zod.d.ts.map

package/dist/api/router.zod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"router.zod.d.ts","sourceRoot":"","sources":["../../src/api/router.zod.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;GAEG;AACH,eAAO,MAAM,UAAU,yEAQrB,CAAC;AAEH,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,UAAU,CAAC,CAAC;AAEpD;;;GAGG;AACH,eAAO,MAAM,aAAa,qEAOxB,CAAC;AAEH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAC;AAE1D;;;GAGG;AACH,eAAO,MAAM,qBAAqB;IAChC;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;;OAGG;;IAGH;;OAEG;;;IAIH;;OAEG;;;IAIH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;;EAGH,CAAC;AAEH,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAEpE;;;GAGG;AACH,eAAO,MAAM,kBAAkB;IAC7B;;OAEG;;IAGH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;IAUH;;OAEG;;;;;;;;;;;;;;IAOH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAMH,CAAC;AAEH,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC"}

package/dist/api/router.zod.js

@@ -0,0 +1,103 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RouterConfigSchema = exports.RouteDefinitionSchema = exports.RouteCategory = exports.HttpMethod = void 0;
+const zod_1 = require("zod");
+/**
+ * HTTP Method Enum
+ */
+exports.HttpMethod = zod_1.z.enum([
+    'GET',
+    'POST',
+    'PUT',
+    'DELETE',
+    'PATCH',
+    'HEAD',
+    'OPTIONS'
+]);
+/**
+ * Route Category Enum
+ * Classifies routes for middleware application and security policies.
+ */
+exports.RouteCategory = zod_1.z.enum([
+    'system', // Health, Metrics, Info (No Auth usually)
+    'api', // Business Logic API (Auth required)
+    'auth', // Login/Callback endpoints
+    'static', // Asset serving
+    'webhook', // External callbacks
+    'plugin' // Plugin extensions
+]);
+/**
+ * Route Definition Schema
+ * Describes a single routable endpoint in the Kernel.
+ */
+exports.RouteDefinitionSchema = zod_1.z.object({
+    /**
+     * HTTP Method
+     */
+    method: exports.HttpMethod,
+    /**
+     * URL Path Pattern (supports parameters like /user/:id)
+     */
+    path: zod_1.z.string().describe('URL Path pattern'),
+    /**
+     * Route Type/Category
+     */
+    category: exports.RouteCategory.default('api'),
+    /**
+     * Handler Identifier
+     * References an internal function or plugin action ID.
+     */
+    handler: zod_1.z.string().describe('Unique handler identifier'),
+    /**
+     * Route specific metadata
+     */
+    summary: zod_1.z.string().optional().describe('OpenAPI summary'),
+    description: zod_1.z.string().optional().describe('OpenAPI description'),
+    /**
+     * Security constraints
+     */
+    public: zod_1.z.boolean().default(false).describe('Is publicly accessible'),
+    permissions: zod_1.z.array(zod_1.z.string()).optional().describe('Required permissions'),
+    /**
+     * Performance hints
+     */
+    timeout: zod_1.z.number().int().optional().describe('Execution timeout in ms'),
+    rateLimit: zod_1.z.string().optional().describe('Rate limit policy name'),
+});
+/**
+ * Router Configuration Schema
+ * Global routing table configuration.
+ */
+exports.RouterConfigSchema = zod_1.z.object({
+    /**
+     * URL Prefix for all kernel routes
+     */
+    basePath: zod_1.z.string().default('/api').describe('Global API prefix'),
+    /**
+     * Standard Protocol Mounts (Relative to basePath)
+     */
+    mounts: zod_1.z.object({
+        data: zod_1.z.string().default('/data').describe('Data Protocol (CRUD)'),
+        metadata: zod_1.z.string().default('/meta').describe('Metadata Protocol (Schemas)'),
+        auth: zod_1.z.string().default('/auth').describe('Auth Protocol'),
+        automation: zod_1.z.string().default('/automation').describe('Automation Protocol'),
+        storage: zod_1.z.string().default('/storage').describe('Storage Protocol'),
+        graphql: zod_1.z.string().default('/graphql').describe('GraphQL Endpoint'),
+    }).default({}), // Defaults match standardized spec
+    /**
+     * Cross-Origin Resource Sharing
+     */
+    cors: zod_1.z.object({
+        enabled: zod_1.z.boolean().default(true),
+        origin: zod_1.z.union([zod_1.z.string(), zod_1.z.array(zod_1.z.string())]).default('*'),
+        methods: zod_1.z.array(exports.HttpMethod).optional(),
+    }).optional(),
+    /**
+     * Static asset mounts
+     */
+    staticMounts: zod_1.z.array(zod_1.z.object({
+        path: zod_1.z.string().describe('URL mount path'),
+        dir: zod_1.z.string().describe('Physical directory path'),
+        cacheControl: zod_1.z.string().optional()
+    })).optional(),
+});