@objectstack/spec 0.4.1 → 0.6.0

package/dist/api/index.d.ts

@@ -12,4 +12,5 @@ export * from './discovery.zod';
 export * from './realtime.zod';
 export * from './router.zod';
 export * from './odata.zod';
+export * from './protocol';
 //# 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;;;;;;;GAOG;AAEH,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAE5B,cAAc,YAAY,CAAC"}

package/dist/api/index.js

@@ -28,3 +28,4 @@ __exportStar(require("./discovery.zod"), exports);
 __exportStar(require("./realtime.zod"), exports);
 __exportStar(require("./router.zod"), exports);
 __exportStar(require("./odata.zod"), exports);
+__exportStar(require("./protocol"), exports);

package/dist/api/protocol.d.ts

@@ -0,0 +1,65 @@
+/**
+ * ObjectStack Protocol Interface
+ *
+ * Defines the high-level contract for interacting with the ObjectStack metadata and data.
+ * Used by API adapters (HTTP, WebSocket, etc) to fetch data/metadata without knowing the engine internals.
+ */
+export interface IObjectStackProtocol {
+    /**
+     * Get API discovery information (versions, capabilities)
+     */
+    getDiscovery(): any;
+    /**
+     * Get available metadata types (object, plugin, etc)
+     */
+    getMetaTypes(): string[];
+    /**
+     * Get all items of a specific metadata type
+     * @param type - Metadata type name
+     */
+    getMetaItems(type: string): any[];
+    /**
+     * Get a specific metadata item
+     * @param type - Metadata type name
+     * @param name - Item name
+     */
+    getMetaItem(type: string, name: string): any;
+    /**
+     * Get UI view definition
+     * @param object - Object name
+     * @param type - View type
+     */
+    getUiView(object: string, type: 'list' | 'form'): any;
+    /**
+     * Find data records
+     * @param object - Object name
+     * @param query - Query parameters (filter, sort, select, etc)
+     */
+    findData(object: string, query: any): Promise<any>;
+    /**
+     * Get single data record by ID
+     * @param object - Object name
+     * @param id - Record ID
+     */
+    getData(object: string, id: string): Promise<any>;
+    /**
+     * Create a data record
+     * @param object - Object name
+     * @param data - Record data
+     */
+    createData(object: string, data: any): Promise<any>;
+    /**
+     * Update a data record
+     * @param object - Object name
+     * @param id - Record ID
+     * @param data - Update data
+     */
+    updateData(object: string, id: string, data: any): Promise<any>;
+    /**
+     * Delete a data record
+     * @param object - Object name
+     * @param id - Record ID
+     */
+    deleteData(object: string, id: string): Promise<any>;
+}
+//# sourceMappingURL=protocol.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"protocol.d.ts","sourceRoot":"","sources":["../../src/api/protocol.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,WAAW,oBAAoB;IACjC;;OAEG;IACH,YAAY,IAAI,GAAG,CAAC;IAEpB;;OAEG;IACH,YAAY,IAAI,MAAM,EAAE,CAAC;IAEzB;;;OAGG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,GAAG,EAAE,CAAC;IAElC;;;;OAIG;IACH,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,GAAG,CAAC;IAE7C;;;;OAIG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,GAAG,CAAC;IAEtD;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAEnD;;;;OAIG;IACH,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAElD;;;;OAIG;IACH,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAEpD;;;;;OAKG;IACH,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAEhE;;;;OAIG;IACH,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;CACxD"}

package/dist/api/protocol.js

@@ -0,0 +1,8 @@
+"use strict";
+/**
+ * ObjectStack Protocol Interface
+ *
+ * Defines the high-level contract for interacting with the ObjectStack metadata and data.
+ * Used by API adapters (HTTP, WebSocket, etc) to fetch data/metadata without knowing the engine internals.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/automation/connector.zod.d.ts

@@ -1071,13 +1071,13 @@ export declare const ConnectorSchema: z.ZodObject<{
     documentation?: string | undefined;
     license?: string | undefined;
     metadata?: Record<string, any> | undefined;
+    homepage?: string | undefined;
     baseUrl?: string | undefined;
     rateLimit?: {
         requestsPerMinute?: number | undefined;
         requestsPerSecond?: number | undefined;
         requestsPerHour?: number | undefined;
     } | undefined;
-    homepage?: string | undefined;
     operations?: {
         type: "delete" | "search" | "read" | "write" | "action" | "trigger";
         name: string;
@@ -1146,13 +1146,13 @@ export declare const ConnectorSchema: z.ZodObject<{
     documentation?: string | undefined;
     license?: string | undefined;
     metadata?: Record<string, any> | undefined;
+    homepage?: string | undefined;
     baseUrl?: string | undefined;
     rateLimit?: {
         requestsPerMinute?: number | undefined;
         requestsPerSecond?: number | undefined;
         requestsPerHour?: number | undefined;
     } | undefined;
-    homepage?: string | undefined;
     verified?: boolean | undefined;
     operations?: {
         type: "delete" | "search" | "read" | "write" | "action" | "trigger";

package/dist/automation/sync.zod.d.ts

@@ -502,11 +502,11 @@ export declare const DataSyncConfigSchema: z.ZodObject<{
         notifyOnError: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
     }, "strip", z.ZodTypeAny, {
         onValidationError: "log" | "skip" | "fail";
-        onSyncError: "retry" | "skip" | "fail";
+        onSyncError: "skip" | "retry" | "fail";
         notifyOnError?: string[] | undefined;
     }, {
         onValidationError?: "log" | "skip" | "fail" | undefined;
-        onSyncError?: "retry" | "skip" | "fail" | undefined;
+        onSyncError?: "skip" | "retry" | "fail" | undefined;
         notifyOnError?: string[] | undefined;
     }>>;
     /**
@@ -603,7 +603,7 @@ export declare const DataSyncConfigSchema: z.ZodObject<{
     changeTrackingField?: string | undefined;
     errorHandling?: {
         onValidationError: "log" | "skip" | "fail";
-        onSyncError: "retry" | "skip" | "fail";
+        onSyncError: "skip" | "retry" | "fail";
         notifyOnError?: string[] | undefined;
     } | undefined;
     optimization?: {
@@ -665,7 +665,7 @@ export declare const DataSyncConfigSchema: z.ZodObject<{
     changeTrackingField?: string | undefined;
     errorHandling?: {
         onValidationError?: "log" | "skip" | "fail" | undefined;
-        onSyncError?: "retry" | "skip" | "fail" | undefined;
+        onSyncError?: "skip" | "retry" | "fail" | undefined;
         notifyOnError?: string[] | undefined;
     } | undefined;
     optimization?: {

package/dist/data/mapping.zod.d.ts

@@ -382,7 +382,7 @@ export declare const MappingSchema: z.ZodObject<{
             separator?: string | undefined;
         } | undefined;
     }[];
-    errorPolicy: "abort" | "retry" | "skip";
+    errorPolicy: "abort" | "skip" | "retry";
     label?: string | undefined;
     upsertKey?: string[] | undefined;
     extractQuery?: {
@@ -487,7 +487,7 @@ export declare const MappingSchema: z.ZodObject<{
             field?: string | undefined;
         }[] | undefined;
     } | undefined;
-    errorPolicy?: "abort" | "retry" | "skip" | undefined;
+    errorPolicy?: "abort" | "skip" | "retry" | undefined;
 }>;
 export type Mapping = z.infer<typeof MappingSchema>;
 export type FieldMapping = z.infer<typeof FieldMappingSchema>;

package/dist/hub/composer.zod.d.ts

@@ -244,7 +244,7 @@ export declare const ComposerResponseSchema: z.ZodObject<{
     manifest: z.ZodOptional<z.ZodObject<{
         id: z.ZodString;
         version: z.ZodString;
-        type: z.ZodEnum<["app", "plugin", "driver", "module"]>;
+        type: z.ZodEnum<["app", "plugin", "driver", "module", "objectql", "gateway", "adapter"]>;
         name: z.ZodString;
         description: z.ZodOptional<z.ZodString>;
         permissions: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
@@ -512,7 +512,7 @@ export declare const ComposerResponseSchema: z.ZodObject<{
         }>, "many">>;
         extensions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
     }, "strip", z.ZodTypeAny, {
-        type: "app" | "module" | "plugin" | "driver";
+        type: "app" | "module" | "plugin" | "driver" | "objectql" | "gateway" | "adapter";
         name: string;
         id: string;
         version: string;
@@ -584,7 +584,7 @@ export declare const ComposerResponseSchema: z.ZodObject<{
         } | undefined;
         extensions?: Record<string, any> | undefined;
     }, {
-        type: "app" | "module" | "plugin" | "driver";
+        type: "app" | "module" | "plugin" | "driver" | "objectql" | "gateway" | "adapter";
         name: string;
         id: string;
         version: string;
@@ -696,7 +696,7 @@ export declare const ComposerResponseSchema: z.ZodObject<{
     timestamp: string;
     buildId: string;
     manifest?: {
-        type: "app" | "module" | "plugin" | "driver";
+        type: "app" | "module" | "plugin" | "driver" | "objectql" | "gateway" | "adapter";
         name: string;
         id: string;
         version: string;
@@ -783,7 +783,7 @@ export declare const ComposerResponseSchema: z.ZodObject<{
     timestamp: string;
     buildId: string;
     manifest?: {
-        type: "app" | "module" | "plugin" | "driver";
+        type: "app" | "module" | "plugin" | "driver" | "objectql" | "gateway" | "adapter";
         name: string;
         id: string;
         version: string;

package/dist/hub/marketplace.zod.d.ts

@@ -145,8 +145,8 @@ export declare const MarketplacePluginSchema: z.ZodObject<{
         url?: string | undefined;
     } | undefined;
     screenshots?: string[] | undefined;
-    readme?: string | undefined;
     homepage?: string | undefined;
+    readme?: string | undefined;
     repository?: string | undefined;
     bugs?: string | undefined;
     downloads?: number | undefined;
@@ -172,8 +172,8 @@ export declare const MarketplacePluginSchema: z.ZodObject<{
         url?: string | undefined;
     } | undefined;
     screenshots?: string[] | undefined;
-    readme?: string | undefined;
     homepage?: string | undefined;
+    readme?: string | undefined;
     repository?: string | undefined;
     bugs?: string | undefined;
     downloads?: number | undefined;