@objectstack/spec 0.8.2 → 0.9.0

package/dist/api/index.d.ts

@@ -7,6 +7,7 @@
  * - OData v4 compatibility
  * - Batch operations
  * - Metadata caching
+ * - Hub Management APIs
  */
 export * from './contract.zod';
 export * from './endpoint.zod';
@@ -21,4 +22,7 @@ export * from './http-cache.zod';
 export * from './errors.zod';
 export * from './protocol.zod';
 export * from './rest-server.zod';
+export * from './hub.zod';
+export * from './registry.zod';
+export * from './documentation.zod';
 //# sourceMappingURL=index.d.ts.map

package/dist/api/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAC5B,cAAc,kBAAkB,CAAC;AACjC,cAAc,cAAc,CAAC;AAC7B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAC5B,cAAc,kBAAkB,CAAC;AACjC,cAAc,cAAc,CAAC;AAC7B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,WAAW,CAAC;AAC1B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,qBAAqB,CAAC"}

package/dist/api/index.js

@@ -8,6 +8,7 @@
  * - OData v4 compatibility
  * - Batch operations
  * - Metadata caching
+ * - Hub Management APIs
  */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
@@ -37,5 +38,8 @@ __exportStar(require("./http-cache.zod"), exports);
 __exportStar(require("./errors.zod"), exports);
 __exportStar(require("./protocol.zod"), exports);
 __exportStar(require("./rest-server.zod"), exports);
+__exportStar(require("./hub.zod"), exports);
+__exportStar(require("./registry.zod"), exports);
+__exportStar(require("./documentation.zod"), exports);
 // Legacy interface export (deprecated)
 // export type { IObjectStackProtocol } from './protocol';

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

@@ -125,9 +125,9 @@ export declare const ODataFilterFunctionSchema: z.ZodEnum<{
     day: "day";
     month: "month";
     year: "year";
+    contains: "contains";
     second: "second";
     hour: "hour";
-    contains: "contains";
     startswith: "startswith";
     endswith: "endswith";
     indexof: "indexof";

package/dist/api/registry.example.d.ts

@@ -0,0 +1,411 @@
+/**
+ * API Registry Enhancement Examples
+ *
+ * This file demonstrates all the enhancements made to the Unified API Registry:
+ * 1. RBAC Integration
+ * 2. Dynamic Schema Linking (ObjectQL References)
+ * 3. Protocol Extensibility
+ * 4. Route Conflict Detection
+ */
+import { type ConflictResolutionStrategy } from './registry.zod';
+/**
+ * Example: Endpoint with RBAC Permission Requirements
+ *
+ * The gateway automatically validates these permissions before
+ * allowing the request to proceed.
+ */
+declare const endpointWithRBAC: {
+    id: string;
+    method: "GET";
+    path: string;
+    summary: string;
+    description: string;
+    requiredPermissions: string[];
+    parameters: {
+        name: string;
+        in: "path";
+        required: true;
+        schema: {
+            type: "string";
+            format: string;
+        };
+    }[];
+    responses: {
+        statusCode: number;
+        description: string;
+    }[];
+};
+/**
+ * Example: Admin Endpoint with Multiple Permissions
+ *
+ * All listed permissions must be satisfied (AND logic).
+ */
+declare const adminEndpoint: {
+    id: string;
+    method: "POST";
+    path: string;
+    summary: string;
+    requiredPermissions: string[];
+    responses: never[];
+};
+/**
+ * Example: Response with ObjectQL Reference
+ *
+ * Instead of duplicating the customer schema, we reference
+ * the ObjectQL object definition. When the object schema changes,
+ * the API documentation automatically updates.
+ */
+declare const endpointWithDynamicSchema: {
+    id: string;
+    method: "GET";
+    path: string;
+    summary: string;
+    parameters: {
+        name: string;
+        in: "path";
+        required: true;
+        schema: {
+            type: "string";
+        };
+    }[];
+    responses: {
+        statusCode: number;
+        description: string;
+        schema: {
+            $ref: {
+                objectId: string;
+                excludeFields: string[];
+            };
+        };
+    }[];
+};
+/**
+ * Example: Request Body with ObjectQL Reference
+ *
+ * The request body schema references the customer object,
+ * but only includes specific fields allowed for creation.
+ */
+declare const createEndpointWithDynamicSchema: {
+    id: string;
+    method: "POST";
+    path: string;
+    summary: string;
+    requestBody: {
+        description: string;
+        required: true;
+        schema: {
+            $ref: {
+                objectId: string;
+                includeFields: string[];
+            };
+        };
+    };
+    responses: {
+        statusCode: number;
+        description: string;
+        schema: {
+            $ref: {
+                objectId: string;
+                excludeFields: string[];
+            };
+        };
+    }[];
+};
+/**
+ * Example: Complex Schema with Related Objects
+ *
+ * Include related objects via lookup fields for a complete response.
+ */
+declare const orderWithRelations: {
+    id: string;
+    method: "GET";
+    path: string;
+    summary: string;
+    parameters: {
+        name: string;
+        in: "path";
+        required: true;
+        schema: {
+            type: "string";
+        };
+    }[];
+    responses: {
+        statusCode: number;
+        description: string;
+        schema: {
+            $ref: {
+                objectId: string;
+                includeRelated: string[];
+            };
+        };
+    }[];
+};
+/**
+ * Example: gRPC Service Endpoint
+ *
+ * Plugin-registered gRPC service with protocol-specific configuration.
+ */
+declare const grpcEndpoint: {
+    id: string;
+    path: string;
+    summary: string;
+    protocolConfig: {
+        subProtocol: string;
+        serviceName: string;
+        methodName: string;
+        streaming: boolean;
+        packageName: string;
+    };
+    responses: never[];
+};
+/**
+ * Example: tRPC Procedure
+ *
+ * tRPC query with procedure-specific metadata.
+ */
+declare const trpcEndpoint: {
+    id: string;
+    path: string;
+    summary: string;
+    protocolConfig: {
+        subProtocol: string;
+        procedureType: string;
+        router: string;
+        procedureName: string;
+    };
+    responses: never[];
+};
+/**
+ * Example: WebSocket Event
+ *
+ * Real-time event with WebSocket-specific metadata.
+ */
+declare const websocketEndpoint: {
+    id: string;
+    path: string;
+    summary: string;
+    protocolConfig: {
+        subProtocol: string;
+        eventName: string;
+        direction: string;
+        requiresAuth: boolean;
+        room: string;
+    };
+    responses: never[];
+};
+/**
+ * Example: High Priority Core Endpoint
+ *
+ * Core system endpoints should have high priority (900-1000)
+ * to ensure they're registered before plugin endpoints.
+ */
+declare const coreEndpoint: {
+    id: string;
+    method: "GET";
+    path: string;
+    summary: string;
+    priority: number;
+    responses: never[];
+};
+/**
+ * Example: Medium Priority Plugin Endpoint
+ *
+ * Plugin endpoints should have medium priority (100-500).
+ */
+declare const pluginEndpoint: {
+    id: string;
+    method: "POST";
+    path: string;
+    summary: string;
+    priority: number;
+    protocolConfig: {
+        pluginId: string;
+    };
+    responses: never[];
+};
+/**
+ * Example: Low Priority Fallback Endpoint
+ *
+ * Fallback or catch-all endpoints should have low priority (0-100).
+ */
+declare const fallbackEndpoint: {
+    id: string;
+    method: "GET";
+    path: string;
+    summary: string;
+    priority: number;
+    responses: {
+        statusCode: number;
+        description: string;
+    }[];
+};
+/**
+ * Example: Complete Registry with Priority-based Conflict Resolution
+ *
+ * When multiple endpoints have overlapping routes, the priority field
+ * determines which endpoint wins.
+ */
+declare const completeRegistry: {
+    version: string;
+    conflictResolution: ConflictResolutionStrategy;
+    apis: ({
+        id: string;
+        name: string;
+        type: "rest";
+        version: string;
+        basePath: string;
+        description: string;
+        endpoints: {
+            id: string;
+            method: "GET";
+            path: string;
+            summary: string;
+            priority: number;
+            responses: never[];
+        }[];
+        metadata: {
+            owner: string;
+            status: "active";
+        };
+    } | {
+        id: string;
+        name: string;
+        type: "plugin";
+        version: string;
+        basePath: string;
+        description: string;
+        endpoints: {
+            id: string;
+            method: "POST";
+            path: string;
+            summary: string;
+            priority: number;
+            protocolConfig: {
+                pluginId: string;
+            };
+            responses: never[];
+        }[];
+        metadata: {
+            owner: string;
+            status: "active";
+            pluginSource: string;
+        };
+    } | {
+        id: string;
+        name: string;
+        type: "plugin";
+        version: string;
+        basePath: string;
+        description: string;
+        endpoints: {
+            id: string;
+            path: string;
+            summary: string;
+            protocolConfig: {
+                subProtocol: string;
+                serviceName: string;
+                methodName: string;
+                streaming: boolean;
+                packageName: string;
+            };
+            responses: never[];
+        }[];
+        config: {
+            grpcVersion: string;
+            reflection: boolean;
+        };
+        metadata: {
+            status: "beta";
+        };
+    })[];
+    totalApis: number;
+    totalEndpoints: number;
+};
+/**
+ * Example: Production-ready Endpoint with All Enhancements
+ *
+ * This example combines all four enhancements:
+ * - RBAC permissions
+ * - Dynamic schema linking
+ * - Protocol configuration
+ * - Route priority
+ */
+declare const productionEndpoint: {
+    id: string;
+    method: "GET";
+    path: string;
+    summary: string;
+    description: string;
+    operationId: string;
+    tags: string[];
+    requiredPermissions: string[];
+    priority: number;
+    protocolConfig: {
+        cacheEnabled: boolean;
+        cacheTtl: number;
+        rateLimitPerMinute: number;
+    };
+    security: {
+        type: "http";
+        scheme: string;
+    }[];
+    parameters: ({
+        name: string;
+        in: "path";
+        description: string;
+        required: true;
+        schema: {
+            type: "string";
+            format: string;
+            items?: undefined;
+            enum?: undefined;
+        };
+        example: string;
+    } | {
+        name: string;
+        in: "query";
+        description: string;
+        required: false;
+        schema: {
+            type: "array";
+            items: {
+                type: string;
+            };
+            enum: string[];
+            format?: undefined;
+        };
+        example?: undefined;
+    })[];
+    responses: ({
+        statusCode: number;
+        description: string;
+        schema: {
+            $ref: {
+                objectId: string;
+                excludeFields: string[];
+                includeRelated: string[];
+            };
+        };
+        example: {
+            id: string;
+            name: string;
+            email: string;
+            phone: string;
+            account: {
+                id: string;
+                name: string;
+            };
+        };
+    } | {
+        statusCode: number;
+        description: string;
+        schema?: undefined;
+        example?: undefined;
+    })[];
+    externalDocs: {
+        description: string;
+        url: string;
+    };
+};
+export { endpointWithRBAC, adminEndpoint, endpointWithDynamicSchema, createEndpointWithDynamicSchema, orderWithRelations, grpcEndpoint, trpcEndpoint, websocketEndpoint, coreEndpoint, pluginEndpoint, fallbackEndpoint, completeRegistry, productionEndpoint, };
+//# sourceMappingURL=registry.example.d.ts.map

package/dist/api/registry.example.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"registry.example.d.ts","sourceRoot":"","sources":["../../src/api/registry.example.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAIL,KAAK,0BAA0B,EAChC,MAAM,gBAAgB,CAAC;AAMxB;;;;;GAKG;AACH,QAAA,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;CA+BpB,CAAC;AAEH;;;;GAIG;AACH,QAAA,MAAM,aAAa;;;;;;;CAajB,CAAC;AAMH;;;;;;GAMG;AACH,QAAA,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;CA+B7B,CAAC;AAEH;;;;;GAKG;AACH,QAAA,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;;CA8BnC,CAAC;AAEH;;;;GAIG;AACH,QAAA,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;CA4BtB,CAAC;AAMH;;;;GAIG;AACH,QAAA,MAAM,YAAY;;;;;;;;;;;;CAehB,CAAC;AAEH;;;;GAIG;AACH,QAAA,MAAM,YAAY;;;;;;;;;;;CAchB,CAAC;AAEH;;;;GAIG;AACH,QAAA,MAAM,iBAAiB;;;;;;;;;;;;CAerB,CAAC;AAMH;;;;;GAKG;AACH,QAAA,MAAM,YAAY;;;;;;;CAUhB,CAAC;AAEH;;;;GAIG;AACH,QAAA,MAAM,cAAc;;;;;;;;;;CAclB,CAAC;AAEH;;;;GAIG;AACH,QAAA,MAAM,gBAAgB;;;;;;;;;;CAepB,CAAC;AAMH;;;;;GAKG;AACH,QAAA,MAAM,gBAAgB;;wBAIc,0BAA0B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA6D5D,CAAC;AAMH;;;;;;;;GAQG;AACH,QAAA,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA4FtB,CAAC;AAGH,OAAO,EACL,gBAAgB,EAChB,aAAa,EACb,yBAAyB,EACzB,+BAA+B,EAC/B,kBAAkB,EAClB,YAAY,EACZ,YAAY,EACZ,iBAAiB,EACjB,YAAY,EACZ,cAAc,EACd,gBAAgB,EAChB,gBAAgB,EAChB,kBAAkB,GACnB,CAAC"}