@objectstack/spec 0.3.1 → 0.3.3

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

@@ -0,0 +1,383 @@
+import { z } from 'zod';
+/**
+ * # Space Protocol
+ *
+ * Defines the SaaS-side representation of a Space (formerly Project).
+ * A Space is a logical container for business apps, data, and logic.
+ * Corresponds to an entry in the Hub's database.
+ */
+/**
+ * Subscription Status Enum
+ */
+export declare const SubscriptionStatus: z.ZodEnum<["active", "past_due", "canceled", "trialing", "incomplete"]>;
+/**
+ * Space Subscription Info
+ */
+export declare const SpaceSubscriptionSchema: z.ZodObject<{
+    planId: z.ZodString;
+    status: z.ZodEnum<["active", "past_due", "canceled", "trialing", "incomplete"]>;
+    currentPeriodEnd: z.ZodOptional<z.ZodString>;
+    stripeCustomerId: z.ZodOptional<z.ZodString>;
+    stripeSubscriptionId: z.ZodOptional<z.ZodString>;
+    /**
+     * Purchased Add-ons from Marketplace
+     */
+    addons: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        pluginId: z.ZodString;
+        quantity: z.ZodDefault<z.ZodNumber>;
+        status: z.ZodDefault<z.ZodEnum<["active", "past_due", "canceled", "trialing", "incomplete"]>>;
+    }, "strip", z.ZodTypeAny, {
+        status: "active" | "past_due" | "canceled" | "trialing" | "incomplete";
+        pluginId: string;
+        quantity: number;
+    }, {
+        pluginId: string;
+        status?: "active" | "past_due" | "canceled" | "trialing" | "incomplete" | undefined;
+        quantity?: number | undefined;
+    }>, "many">>;
+    /**
+     * Quota Usage Snapshot
+     * Cached usage metrics for quick display/validation.
+     */
+    usage: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodNumber>>;
+}, "strip", z.ZodTypeAny, {
+    status: "active" | "past_due" | "canceled" | "trialing" | "incomplete";
+    planId: string;
+    currentPeriodEnd?: string | undefined;
+    stripeCustomerId?: string | undefined;
+    stripeSubscriptionId?: string | undefined;
+    addons?: {
+        status: "active" | "past_due" | "canceled" | "trialing" | "incomplete";
+        pluginId: string;
+        quantity: number;
+    }[] | undefined;
+    usage?: Record<string, number> | undefined;
+}, {
+    status: "active" | "past_due" | "canceled" | "trialing" | "incomplete";
+    planId: string;
+    currentPeriodEnd?: string | undefined;
+    stripeCustomerId?: string | undefined;
+    stripeSubscriptionId?: string | undefined;
+    addons?: {
+        pluginId: string;
+        status?: "active" | "past_due" | "canceled" | "trialing" | "incomplete" | undefined;
+        quantity?: number | undefined;
+    }[] | undefined;
+    usage?: Record<string, number> | undefined;
+}>;
+/**
+ * Deployment Target
+ * Vercel or Container configuration.
+ */
+export declare const DeploymentTargetSchema: z.ZodObject<{
+    provider: z.ZodEnum<["vercel", "docker", "kubernetes"]>;
+    region: z.ZodOptional<z.ZodString>;
+    url: z.ZodOptional<z.ZodString>;
+    env: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    provider: "vercel" | "docker" | "kubernetes";
+    url?: string | undefined;
+    env?: Record<string, string> | undefined;
+    region?: string | undefined;
+}, {
+    provider: "vercel" | "docker" | "kubernetes";
+    url?: string | undefined;
+    env?: Record<string, string> | undefined;
+    region?: string | undefined;
+}>;
+/**
+ * Hub Space Schema
+ */
+export declare const HubSpaceSchema: z.ZodObject<{
+    id: z.ZodString;
+    /**
+     * Display Name
+     */
+    name: z.ZodString;
+    slug: z.ZodString;
+    /**
+     * Owner (User or Org ID in Hub)
+     */
+    ownerId: z.ZodString;
+    /**
+     * The Runtime Instance Definition
+     * Defines the technical execution environment.
+     */
+    runtime: z.ZodOptional<z.ZodObject<{
+        isolation: z.ZodEnum<["shared_schema", "isolated_schema", "isolated_db"]>;
+        quotas: z.ZodOptional<z.ZodObject<{
+            maxUsers: z.ZodOptional<z.ZodNumber>;
+            maxStorage: z.ZodOptional<z.ZodNumber>;
+            apiRateLimit: z.ZodOptional<z.ZodNumber>;
+        }, "strip", z.ZodTypeAny, {
+            maxUsers?: number | undefined;
+            maxStorage?: number | undefined;
+            apiRateLimit?: number | undefined;
+        }, {
+            maxUsers?: number | undefined;
+            maxStorage?: number | undefined;
+            apiRateLimit?: number | undefined;
+        }>>;
+    }, "strip", z.ZodTypeAny, {
+        isolation: "shared_schema" | "isolated_schema" | "isolated_db";
+        quotas?: {
+            maxUsers?: number | undefined;
+            maxStorage?: number | undefined;
+            apiRateLimit?: number | undefined;
+        } | undefined;
+    }, {
+        isolation: "shared_schema" | "isolated_schema" | "isolated_db";
+        quotas?: {
+            maxUsers?: number | undefined;
+            maxStorage?: number | undefined;
+            apiRateLimit?: number | undefined;
+        } | undefined;
+    }>>;
+    /**
+     * The Desired State (Bill of Materials)
+     * This is what the user configures in the UI.
+     */
+    bom: z.ZodObject<{
+        tenantId: z.ZodString;
+        dependencies: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            version: z.ZodDefault<z.ZodString>;
+            configuration: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+            features: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodBoolean>>;
+        }, "strip", z.ZodTypeAny, {
+            id: string;
+            version: string;
+            configuration?: Record<string, any> | undefined;
+            features?: Record<string, boolean> | undefined;
+        }, {
+            id: string;
+            version?: string | undefined;
+            configuration?: Record<string, any> | undefined;
+            features?: Record<string, boolean> | undefined;
+        }>, "many">;
+        environment: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+        resolutionStrategy: z.ZodDefault<z.ZodEnum<["strict", "override", "merge"]>>;
+    }, "strip", z.ZodTypeAny, {
+        tenantId: string;
+        dependencies: {
+            id: string;
+            version: string;
+            configuration?: Record<string, any> | undefined;
+            features?: Record<string, boolean> | undefined;
+        }[];
+        resolutionStrategy: "strict" | "merge" | "override";
+        environment?: Record<string, string> | undefined;
+    }, {
+        tenantId: string;
+        dependencies: {
+            id: string;
+            version?: string | undefined;
+            configuration?: Record<string, any> | undefined;
+            features?: Record<string, boolean> | undefined;
+        }[];
+        environment?: Record<string, string> | undefined;
+        resolutionStrategy?: "strict" | "merge" | "override" | undefined;
+    }>;
+    /**
+     * The Current Actual State (Last Successful Build)
+     */
+    lastBuild: z.ZodOptional<z.ZodObject<{
+        id: z.ZodString;
+        timestamp: z.ZodString;
+        manifestUrl: z.ZodOptional<z.ZodString>;
+        status: z.ZodEnum<["pending", "success", "failed"]>;
+    }, "strip", z.ZodTypeAny, {
+        status: "success" | "failed" | "pending";
+        id: string;
+        timestamp: string;
+        manifestUrl?: string | undefined;
+    }, {
+        status: "success" | "failed" | "pending";
+        id: string;
+        timestamp: string;
+        manifestUrl?: string | undefined;
+    }>>;
+    /**
+     * Commercial / Billing Info
+     */
+    subscription: z.ZodOptional<z.ZodObject<{
+        planId: z.ZodString;
+        status: z.ZodEnum<["active", "past_due", "canceled", "trialing", "incomplete"]>;
+        currentPeriodEnd: z.ZodOptional<z.ZodString>;
+        stripeCustomerId: z.ZodOptional<z.ZodString>;
+        stripeSubscriptionId: z.ZodOptional<z.ZodString>;
+        /**
+         * Purchased Add-ons from Marketplace
+         */
+        addons: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            pluginId: z.ZodString;
+            quantity: z.ZodDefault<z.ZodNumber>;
+            status: z.ZodDefault<z.ZodEnum<["active", "past_due", "canceled", "trialing", "incomplete"]>>;
+        }, "strip", z.ZodTypeAny, {
+            status: "active" | "past_due" | "canceled" | "trialing" | "incomplete";
+            pluginId: string;
+            quantity: number;
+        }, {
+            pluginId: string;
+            status?: "active" | "past_due" | "canceled" | "trialing" | "incomplete" | undefined;
+            quantity?: number | undefined;
+        }>, "many">>;
+        /**
+         * Quota Usage Snapshot
+         * Cached usage metrics for quick display/validation.
+         */
+        usage: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodNumber>>;
+    }, "strip", z.ZodTypeAny, {
+        status: "active" | "past_due" | "canceled" | "trialing" | "incomplete";
+        planId: string;
+        currentPeriodEnd?: string | undefined;
+        stripeCustomerId?: string | undefined;
+        stripeSubscriptionId?: string | undefined;
+        addons?: {
+            status: "active" | "past_due" | "canceled" | "trialing" | "incomplete";
+            pluginId: string;
+            quantity: number;
+        }[] | undefined;
+        usage?: Record<string, number> | undefined;
+    }, {
+        status: "active" | "past_due" | "canceled" | "trialing" | "incomplete";
+        planId: string;
+        currentPeriodEnd?: string | undefined;
+        stripeCustomerId?: string | undefined;
+        stripeSubscriptionId?: string | undefined;
+        addons?: {
+            pluginId: string;
+            status?: "active" | "past_due" | "canceled" | "trialing" | "incomplete" | undefined;
+            quantity?: number | undefined;
+        }[] | undefined;
+        usage?: Record<string, number> | undefined;
+    }>>;
+    /**
+     * Infrastructure Settings
+     */
+    deployment: z.ZodOptional<z.ZodObject<{
+        provider: z.ZodEnum<["vercel", "docker", "kubernetes"]>;
+        region: z.ZodOptional<z.ZodString>;
+        url: z.ZodOptional<z.ZodString>;
+        env: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    }, "strip", z.ZodTypeAny, {
+        provider: "vercel" | "docker" | "kubernetes";
+        url?: string | undefined;
+        env?: Record<string, string> | undefined;
+        region?: string | undefined;
+    }, {
+        provider: "vercel" | "docker" | "kubernetes";
+        url?: string | undefined;
+        env?: Record<string, string> | undefined;
+        region?: string | undefined;
+    }>>;
+    createdAt: z.ZodString;
+    updatedAt: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    slug: string;
+    bom: {
+        tenantId: string;
+        dependencies: {
+            id: string;
+            version: string;
+            configuration?: Record<string, any> | undefined;
+            features?: Record<string, boolean> | undefined;
+        }[];
+        resolutionStrategy: "strict" | "merge" | "override";
+        environment?: Record<string, string> | undefined;
+    };
+    ownerId: string;
+    runtime?: {
+        isolation: "shared_schema" | "isolated_schema" | "isolated_db";
+        quotas?: {
+            maxUsers?: number | undefined;
+            maxStorage?: number | undefined;
+            apiRateLimit?: number | undefined;
+        } | undefined;
+    } | undefined;
+    lastBuild?: {
+        status: "success" | "failed" | "pending";
+        id: string;
+        timestamp: string;
+        manifestUrl?: string | undefined;
+    } | undefined;
+    subscription?: {
+        status: "active" | "past_due" | "canceled" | "trialing" | "incomplete";
+        planId: string;
+        currentPeriodEnd?: string | undefined;
+        stripeCustomerId?: string | undefined;
+        stripeSubscriptionId?: string | undefined;
+        addons?: {
+            status: "active" | "past_due" | "canceled" | "trialing" | "incomplete";
+            pluginId: string;
+            quantity: number;
+        }[] | undefined;
+        usage?: Record<string, number> | undefined;
+    } | undefined;
+    deployment?: {
+        provider: "vercel" | "docker" | "kubernetes";
+        url?: string | undefined;
+        env?: Record<string, string> | undefined;
+        region?: string | undefined;
+    } | undefined;
+}, {
+    name: string;
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    slug: string;
+    bom: {
+        tenantId: string;
+        dependencies: {
+            id: string;
+            version?: string | undefined;
+            configuration?: Record<string, any> | undefined;
+            features?: Record<string, boolean> | undefined;
+        }[];
+        environment?: Record<string, string> | undefined;
+        resolutionStrategy?: "strict" | "merge" | "override" | undefined;
+    };
+    ownerId: string;
+    runtime?: {
+        isolation: "shared_schema" | "isolated_schema" | "isolated_db";
+        quotas?: {
+            maxUsers?: number | undefined;
+            maxStorage?: number | undefined;
+            apiRateLimit?: number | undefined;
+        } | undefined;
+    } | undefined;
+    lastBuild?: {
+        status: "success" | "failed" | "pending";
+        id: string;
+        timestamp: string;
+        manifestUrl?: string | undefined;
+    } | undefined;
+    subscription?: {
+        status: "active" | "past_due" | "canceled" | "trialing" | "incomplete";
+        planId: string;
+        currentPeriodEnd?: string | undefined;
+        stripeCustomerId?: string | undefined;
+        stripeSubscriptionId?: string | undefined;
+        addons?: {
+            pluginId: string;
+            status?: "active" | "past_due" | "canceled" | "trialing" | "incomplete" | undefined;
+            quantity?: number | undefined;
+        }[] | undefined;
+        usage?: Record<string, number> | undefined;
+    } | undefined;
+    deployment?: {
+        provider: "vercel" | "docker" | "kubernetes";
+        url?: string | undefined;
+        env?: Record<string, string> | undefined;
+        region?: string | undefined;
+    } | undefined;
+}>;
+export type SubscriptionStatus = z.infer<typeof SubscriptionStatus>;
+export type SpaceSubscription = z.infer<typeof SpaceSubscriptionSchema>;
+export type DeploymentTarget = z.infer<typeof DeploymentTargetSchema>;
+export type HubSpace = z.infer<typeof HubSpaceSchema>;
+//# sourceMappingURL=space.zod.d.ts.map

package/dist/hub/space.zod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"space.zod.d.ts","sourceRoot":"","sources":["../../src/hub/space.zod.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB;;;;;;GAMG;AAEH;;GAEG;AACH,eAAO,MAAM,kBAAkB,yEAM7B,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,uBAAuB;;;;;;IAOlC;;OAEG;;;;;;;;;;;;;;IAOH;;;OAGG;;;;;;;;;;;;;;;;;;;;;;;;;;EAEH,CAAC;AAEH;;;GAGG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;EAKjC,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,cAAc;;IAGzB;;OAEG;;;IAIH;;OAEG;;IAGH;;;OAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAMH;;;OAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAGH;;OAEG;;;;;;;;;;;;;;;;;IAQH;;OAEG;;;;;;;QAvEH;;WAEG;;;;;;;;;;;;;;QAOH;;;WAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;IA8DH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAKH,CAAC;AAEH,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AACpE,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AACxE,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AACtE,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAC"}

package/dist/hub/space.zod.js

@@ -0,0 +1,103 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HubSpaceSchema = exports.DeploymentTargetSchema = exports.SpaceSubscriptionSchema = exports.SubscriptionStatus = void 0;
+const zod_1 = require("zod");
+const composer_zod_1 = require("./composer.zod");
+const tenant_zod_1 = require("./tenant.zod");
+/**
+ * # Space Protocol
+ *
+ * Defines the SaaS-side representation of a Space (formerly Project).
+ * A Space is a logical container for business apps, data, and logic.
+ * Corresponds to an entry in the Hub's database.
+ */
+/**
+ * Subscription Status Enum
+ */
+exports.SubscriptionStatus = zod_1.z.enum([
+    'active',
+    'past_due',
+    'canceled',
+    'trialing',
+    'incomplete'
+]);
+/**
+ * Space Subscription Info
+ */
+exports.SpaceSubscriptionSchema = zod_1.z.object({
+    planId: zod_1.z.string().describe('Reference to Plan Code'),
+    status: exports.SubscriptionStatus,
+    currentPeriodEnd: zod_1.z.string().datetime().optional(),
+    stripeCustomerId: zod_1.z.string().optional(),
+    stripeSubscriptionId: zod_1.z.string().optional(),
+    /**
+     * Purchased Add-ons from Marketplace
+     */
+    addons: zod_1.z.array(zod_1.z.object({
+        pluginId: zod_1.z.string().describe('Marketplace Plugin ID (NPM package name)'),
+        quantity: zod_1.z.number().default(1),
+        status: exports.SubscriptionStatus.default('active'),
+    })).optional(),
+    /**
+     * Quota Usage Snapshot
+     * Cached usage metrics for quick display/validation.
+     */
+    usage: zod_1.z.record(zod_1.z.number()).optional(),
+});
+/**
+ * Deployment Target
+ * Vercel or Container configuration.
+ */
+exports.DeploymentTargetSchema = zod_1.z.object({
+    provider: zod_1.z.enum(['vercel', 'docker', 'kubernetes']),
+    region: zod_1.z.string().optional(),
+    url: zod_1.z.string().url().optional().describe('Public Access URL'),
+    env: zod_1.z.record(zod_1.z.string()).optional().describe('Runtime Environment Variables'),
+});
+/**
+ * Hub Space Schema
+ */
+exports.HubSpaceSchema = zod_1.z.object({
+    id: zod_1.z.string().uuid(),
+    /**
+     * Display Name
+     */
+    name: zod_1.z.string(),
+    slug: zod_1.z.string().describe('URL friendly identifier'),
+    /**
+     * Owner (User or Org ID in Hub)
+     */
+    ownerId: zod_1.z.string(),
+    /**
+     * The Runtime Instance Definition
+     * Defines the technical execution environment.
+     */
+    runtime: zod_1.z.object({
+        isolation: tenant_zod_1.TenantIsolationLevel.describe('Data isolation strategy'),
+        quotas: tenant_zod_1.TenantQuotaSchema.optional().describe('Resource quotas'),
+    }).optional().describe('Runtime instance configuration'),
+    /**
+     * The Desired State (Bill of Materials)
+     * This is what the user configures in the UI.
+     */
+    bom: composer_zod_1.BillOfMaterialsSchema,
+    /**
+     * The Current Actual State (Last Successful Build)
+     */
+    lastBuild: zod_1.z.object({
+        id: zod_1.z.string(),
+        timestamp: zod_1.z.string().datetime(),
+        manifestUrl: zod_1.z.string().url().optional(),
+        status: zod_1.z.enum(['pending', 'success', 'failed']),
+    }).optional(),
+    /**
+     * Commercial / Billing Info
+     */
+    subscription: exports.SpaceSubscriptionSchema.optional(),
+    /**
+     * Infrastructure Settings
+     */
+    deployment: exports.DeploymentTargetSchema.optional(),
+    createdAt: zod_1.z.string(),
+    updatedAt: zod_1.z.string(),
+});