@objectstack/spec 0.3.0 → 0.3.1

package/dist/system/manifest.zod.d.ts

@@ -283,6 +283,11 @@ export declare const ManifestSchema: z.ZodObject<{
     version: string;
     description?: string | undefined;
     objects?: string[] | undefined;
+    data?: {
+        object: string;
+        mode: "upsert" | "insert" | "ignore";
+        records: Record<string, any>[];
+    }[] | undefined;
     permissions?: string[] | undefined;
     datasources?: string[] | undefined;
     dependencies?: Record<string, string> | undefined;
@@ -326,11 +331,6 @@ export declare const ManifestSchema: z.ZodObject<{
             locale: string;
         }[] | undefined;
     } | undefined;
-    data?: {
-        object: string;
-        mode: "upsert" | "insert" | "ignore";
-        records: Record<string, any>[];
-    }[] | undefined;
     extensions?: Record<string, any> | undefined;
 }, {
     type: "app" | "plugin" | "driver" | "module";
@@ -339,6 +339,11 @@ export declare const ManifestSchema: z.ZodObject<{
     version: string;
     description?: string | undefined;
     objects?: string[] | undefined;
+    data?: {
+        object: string;
+        records: Record<string, any>[];
+        mode?: "upsert" | "insert" | "ignore" | undefined;
+    }[] | undefined;
     permissions?: string[] | undefined;
     datasources?: string[] | undefined;
     dependencies?: Record<string, string> | undefined;
@@ -382,11 +387,6 @@ export declare const ManifestSchema: z.ZodObject<{
             locale: string;
         }[] | undefined;
     } | undefined;
-    data?: {
-        object: string;
-        records: Record<string, any>[];
-        mode?: "upsert" | "insert" | "ignore" | undefined;
-    }[] | undefined;
     extensions?: Record<string, any> | undefined;
 }>;
 /**

package/dist/system/realtime.zod.d.ts

@@ -0,0 +1,135 @@
+import { z } from 'zod';
+/**
+ * Transport Protocol Enum
+ * Defines the communication protocol for realtime data synchronization
+ */
+export declare const TransportProtocol: z.ZodEnum<["websocket", "sse", "polling"]>;
+export type TransportProtocol = z.infer<typeof TransportProtocol>;
+/**
+ * Event Type Enum
+ * Types of realtime events that can be subscribed to
+ */
+export declare const RealtimeEventType: z.ZodEnum<["record.created", "record.updated", "record.deleted", "field.changed"]>;
+export type RealtimeEventType = z.infer<typeof RealtimeEventType>;
+/**
+ * Subscription Event Configuration
+ * Defines what events to subscribe to with optional filtering
+ */
+export declare const SubscriptionEventSchema: z.ZodObject<{
+    type: z.ZodEnum<["record.created", "record.updated", "record.deleted", "field.changed"]>;
+    object: z.ZodOptional<z.ZodString>;
+    filters: z.ZodOptional<z.ZodAny>;
+}, "strip", z.ZodTypeAny, {
+    type: "record.created" | "record.updated" | "record.deleted" | "field.changed";
+    object?: string | undefined;
+    filters?: any;
+}, {
+    type: "record.created" | "record.updated" | "record.deleted" | "field.changed";
+    object?: string | undefined;
+    filters?: any;
+}>;
+/**
+ * Subscription Schema
+ * Configuration for subscribing to realtime events
+ */
+export declare const SubscriptionSchema: z.ZodObject<{
+    id: z.ZodString;
+    events: z.ZodArray<z.ZodObject<{
+        type: z.ZodEnum<["record.created", "record.updated", "record.deleted", "field.changed"]>;
+        object: z.ZodOptional<z.ZodString>;
+        filters: z.ZodOptional<z.ZodAny>;
+    }, "strip", z.ZodTypeAny, {
+        type: "record.created" | "record.updated" | "record.deleted" | "field.changed";
+        object?: string | undefined;
+        filters?: any;
+    }, {
+        type: "record.created" | "record.updated" | "record.deleted" | "field.changed";
+        object?: string | undefined;
+        filters?: any;
+    }>, "many">;
+    transport: z.ZodEnum<["websocket", "sse", "polling"]>;
+    channel: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    events: {
+        type: "record.created" | "record.updated" | "record.deleted" | "field.changed";
+        object?: string | undefined;
+        filters?: any;
+    }[];
+    transport: "websocket" | "sse" | "polling";
+    channel?: string | undefined;
+}, {
+    id: string;
+    events: {
+        type: "record.created" | "record.updated" | "record.deleted" | "field.changed";
+        object?: string | undefined;
+        filters?: any;
+    }[];
+    transport: "websocket" | "sse" | "polling";
+    channel?: string | undefined;
+}>;
+export type Subscription = z.infer<typeof SubscriptionSchema>;
+/**
+ * Presence Status Enum
+ * User online/offline status
+ */
+export declare const PresenceStatus: z.ZodEnum<["online", "away", "offline"]>;
+export type PresenceStatus = z.infer<typeof PresenceStatus>;
+/**
+ * Presence Schema
+ * Tracks user online status and metadata
+ */
+export declare const PresenceSchema: z.ZodObject<{
+    userId: z.ZodString;
+    status: z.ZodEnum<["online", "away", "offline"]>;
+    lastSeen: z.ZodString;
+    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+}, "strip", z.ZodTypeAny, {
+    status: "online" | "away" | "offline";
+    userId: string;
+    lastSeen: string;
+    metadata?: Record<string, any> | undefined;
+}, {
+    status: "online" | "away" | "offline";
+    userId: string;
+    lastSeen: string;
+    metadata?: Record<string, any> | undefined;
+}>;
+export type Presence = z.infer<typeof PresenceSchema>;
+/**
+ * Realtime Action Enum
+ * Actions that can occur on records
+ */
+export declare const RealtimeAction: z.ZodEnum<["created", "updated", "deleted"]>;
+export type RealtimeAction = z.infer<typeof RealtimeAction>;
+/**
+ * Realtime Event Schema
+ * Represents a realtime synchronization event
+ */
+export declare const RealtimeEventSchema: z.ZodObject<{
+    id: z.ZodString;
+    type: z.ZodString;
+    object: z.ZodOptional<z.ZodString>;
+    action: z.ZodOptional<z.ZodEnum<["created", "updated", "deleted"]>>;
+    payload: z.ZodAny;
+    timestamp: z.ZodString;
+    userId: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    type: string;
+    id: string;
+    timestamp: string;
+    object?: string | undefined;
+    payload?: any;
+    action?: "created" | "updated" | "deleted" | undefined;
+    userId?: string | undefined;
+}, {
+    type: string;
+    id: string;
+    timestamp: string;
+    object?: string | undefined;
+    payload?: any;
+    action?: "created" | "updated" | "deleted" | undefined;
+    userId?: string | undefined;
+}>;
+export type RealtimeEvent = z.infer<typeof RealtimeEventSchema>;
+//# sourceMappingURL=realtime.zod.d.ts.map

package/dist/system/realtime.zod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"realtime.zod.d.ts","sourceRoot":"","sources":["../../src/system/realtime.zod.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;GAGG;AACH,eAAO,MAAM,iBAAiB,4CAI5B,CAAC;AAEH,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAElE;;;GAGG;AACH,eAAO,MAAM,iBAAiB,oFAK5B,CAAC;AAEH,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAElE;;;GAGG;AACH,eAAO,MAAM,uBAAuB;;;;;;;;;;;;EAIlC,CAAC;AAEH;;;GAGG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAK7B,CAAC;AAEH,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAE9D;;;GAGG;AACH,eAAO,MAAM,cAAc,0CAIzB,CAAC;AAEH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAC;AAE5D;;;GAGG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;EAKzB,CAAC;AAEH,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAC;AAEtD;;;GAGG;AACH,eAAO,MAAM,cAAc,8CAIzB,CAAC;AAEH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAC;AAE5D;;;GAGG;AACH,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;EAQ9B,CAAC;AAEH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC"}

package/dist/system/realtime.zod.js

@@ -0,0 +1,83 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RealtimeEventSchema = exports.RealtimeAction = exports.PresenceSchema = exports.PresenceStatus = exports.SubscriptionSchema = exports.SubscriptionEventSchema = exports.RealtimeEventType = exports.TransportProtocol = void 0;
+const zod_1 = require("zod");
+/**
+ * Transport Protocol Enum
+ * Defines the communication protocol for realtime data synchronization
+ */
+exports.TransportProtocol = zod_1.z.enum([
+    'websocket', // Full-duplex, low latency communication
+    'sse', // Server-Sent Events, unidirectional push
+    'polling', // Short polling, best compatibility
+]);
+/**
+ * Event Type Enum
+ * Types of realtime events that can be subscribed to
+ */
+exports.RealtimeEventType = zod_1.z.enum([
+    'record.created',
+    'record.updated',
+    'record.deleted',
+    'field.changed',
+]);
+/**
+ * Subscription Event Configuration
+ * Defines what events to subscribe to with optional filtering
+ */
+exports.SubscriptionEventSchema = zod_1.z.object({
+    type: exports.RealtimeEventType.describe('Type of event to subscribe to'),
+    object: zod_1.z.string().optional().describe('Object name to subscribe to'),
+    filters: zod_1.z.any().optional().describe('Filter conditions'),
+});
+/**
+ * Subscription Schema
+ * Configuration for subscribing to realtime events
+ */
+exports.SubscriptionSchema = zod_1.z.object({
+    id: zod_1.z.string().uuid().describe('Unique subscription identifier'),
+    events: zod_1.z.array(exports.SubscriptionEventSchema).describe('Array of events to subscribe to'),
+    transport: exports.TransportProtocol.describe('Transport protocol to use'),
+    channel: zod_1.z.string().optional().describe('Optional channel name for grouping subscriptions'),
+});
+/**
+ * Presence Status Enum
+ * User online/offline status
+ */
+exports.PresenceStatus = zod_1.z.enum([
+    'online',
+    'away',
+    'offline',
+]);
+/**
+ * Presence Schema
+ * Tracks user online status and metadata
+ */
+exports.PresenceSchema = zod_1.z.object({
+    userId: zod_1.z.string().describe('User identifier'),
+    status: exports.PresenceStatus.describe('Current presence status'),
+    lastSeen: zod_1.z.string().datetime().describe('ISO 8601 datetime of last activity'),
+    metadata: zod_1.z.record(zod_1.z.any()).optional().describe('Custom presence data (e.g., current page, custom status)'),
+});
+/**
+ * Realtime Action Enum
+ * Actions that can occur on records
+ */
+exports.RealtimeAction = zod_1.z.enum([
+    'created',
+    'updated',
+    'deleted',
+]);
+/**
+ * Realtime Event Schema
+ * Represents a realtime synchronization event
+ */
+exports.RealtimeEventSchema = zod_1.z.object({
+    id: zod_1.z.string().uuid().describe('Unique event identifier'),
+    type: zod_1.z.string().describe('Event type (e.g., record.created, record.updated)'),
+    object: zod_1.z.string().optional().describe('Object name the event relates to'),
+    action: exports.RealtimeAction.optional().describe('Action performed'),
+    payload: zod_1.z.any().describe('Event payload data'),
+    timestamp: zod_1.z.string().datetime().describe('ISO 8601 datetime when event occurred'),
+    userId: zod_1.z.string().optional().describe('User who triggered the event'),
+});