@objectstack/spec 0.2.0 → 0.3.1

package/dist/system/organization.zod.js

@@ -0,0 +1,129 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InvitationSchema = exports.InvitationStatus = exports.MemberSchema = exports.OrganizationSchema = void 0;
+const zod_1 = require("zod");
+/**
+ * Organization Schema (Multi-Tenant Architecture)
+ *
+ * Defines the standard organization/workspace model for ObjectStack.
+ * Supports B2B SaaS scenarios where users belong to multiple teams/workspaces.
+ *
+ * This aligns with better-auth's organization plugin capabilities.
+ */
+/**
+ * Organization Schema
+ * Represents a team, workspace, or tenant in a multi-tenant application
+ */
+exports.OrganizationSchema = zod_1.z.object({
+    /**
+     * Unique organization identifier
+     */
+    id: zod_1.z.string().describe('Unique organization identifier'),
+    /**
+     * Organization name (display name)
+     */
+    name: zod_1.z.string().describe('Organization display name'),
+    /**
+     * Organization slug (URL-friendly identifier)
+     * Must be unique across all organizations
+     */
+    slug: zod_1.z.string()
+        .regex(/^[a-z0-9_-]+$/)
+        .describe('Unique URL-friendly slug (lowercase alphanumeric, hyphens, underscores)'),
+    /**
+     * Organization logo URL
+     */
+    logo: zod_1.z.string().url().optional().describe('Organization logo URL'),
+    /**
+     * Custom metadata for the organization
+     * Can store additional configuration, settings, or custom fields
+     */
+    metadata: zod_1.z.record(zod_1.z.any()).optional().describe('Custom metadata'),
+    /**
+     * Organization creation timestamp
+     */
+    createdAt: zod_1.z.date().describe('Organization creation timestamp'),
+    /**
+     * Last update timestamp
+     */
+    updatedAt: zod_1.z.date().describe('Last update timestamp'),
+});
+/**
+ * Organization Member Schema
+ * Links users to organizations with specific roles
+ */
+exports.MemberSchema = zod_1.z.object({
+    /**
+     * Unique member identifier
+     */
+    id: zod_1.z.string().describe('Unique member identifier'),
+    /**
+     * Organization ID this membership belongs to
+     */
+    organizationId: zod_1.z.string().describe('Organization ID'),
+    /**
+     * User ID of the member
+     */
+    userId: zod_1.z.string().describe('User ID'),
+    /**
+     * Member's role within the organization
+     * Common roles: 'owner', 'admin', 'member', 'guest'
+     * Can be customized per application
+     */
+    role: zod_1.z.string().describe('Member role (e.g., owner, admin, member, guest)'),
+    /**
+     * Member creation timestamp
+     */
+    createdAt: zod_1.z.date().describe('Member creation timestamp'),
+    /**
+     * Last update timestamp
+     */
+    updatedAt: zod_1.z.date().describe('Last update timestamp'),
+});
+/**
+ * Invitation Status Enum
+ */
+exports.InvitationStatus = zod_1.z.enum(['pending', 'accepted', 'rejected', 'expired']);
+/**
+ * Organization Invitation Schema
+ * Represents an invitation to join an organization
+ */
+exports.InvitationSchema = zod_1.z.object({
+    /**
+     * Unique invitation identifier
+     */
+    id: zod_1.z.string().describe('Unique invitation identifier'),
+    /**
+     * Organization ID the invitation is for
+     */
+    organizationId: zod_1.z.string().describe('Organization ID'),
+    /**
+     * Email address of the invitee
+     */
+    email: zod_1.z.string().email().describe('Invitee email address'),
+    /**
+     * Role the invitee will receive upon accepting
+     * Common roles: 'admin', 'member', 'guest'
+     */
+    role: zod_1.z.string().describe('Role to assign upon acceptance'),
+    /**
+     * Invitation status
+     */
+    status: exports.InvitationStatus.default('pending').describe('Invitation status'),
+    /**
+     * Invitation expiration timestamp
+     */
+    expiresAt: zod_1.z.date().describe('Invitation expiry timestamp'),
+    /**
+     * User ID of the person who sent the invitation
+     */
+    inviterId: zod_1.z.string().describe('User ID of the inviter'),
+    /**
+     * Invitation creation timestamp
+     */
+    createdAt: zod_1.z.date().describe('Invitation creation timestamp'),
+    /**
+     * Last update timestamp
+     */
+    updatedAt: zod_1.z.date().describe('Last update timestamp'),
+});

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'),
+});