@objectstack/spec 0.3.3 → 0.4.2

package/dist/ui/page.zod.d.ts

@@ -8,7 +8,7 @@ export declare const PageRegionSchema: z.ZodObject<{
     width: z.ZodOptional<z.ZodEnum<["small", "medium", "large", "full"]>>;
     components: z.ZodArray<z.ZodLazy<z.ZodObject<{
         /** Definition */
-        type: z.ZodString;
+        type: z.ZodUnion<[z.ZodEnum<["page:header", "page:footer", "page:sidebar", "page:tabs", "page:accordion", "page:card", "page:section", "record:details", "record:highlights", "record:related_list", "record:activity", "record:chatter", "record:path", "app:launcher", "nav:menu", "nav:breadcrumb", "global:search", "global:notifications", "user:profile", "ai:chat_window", "ai:suggestion"]>, z.ZodString]>;
         id: z.ZodOptional<z.ZodString>;
         /** Configuration */
         label: z.ZodOptional<z.ZodString>;
@@ -49,13 +49,17 @@ export declare const PageRegionSchema: z.ZodObject<{
     }[];
     width?: "full" | "small" | "medium" | "large" | undefined;
 }>;
+/**
+ * Standard Page Component Types
+ */
+export declare const PageComponentType: z.ZodEnum<["page:header", "page:footer", "page:sidebar", "page:tabs", "page:accordion", "page:card", "page:section", "record:details", "record:highlights", "record:related_list", "record:activity", "record:chatter", "record:path", "app:launcher", "nav:menu", "nav:breadcrumb", "global:search", "global:notifications", "user:profile", "ai:chat_window", "ai:suggestion"]>;
 /**
  * Page Component Schema
  * A configured instance of a UI component.
  */
 export declare const PageComponentSchema: z.ZodObject<{
     /** Definition */
-    type: z.ZodString;
+    type: z.ZodUnion<[z.ZodEnum<["page:header", "page:footer", "page:sidebar", "page:tabs", "page:accordion", "page:card", "page:section", "record:details", "record:highlights", "record:related_list", "record:activity", "record:chatter", "record:path", "app:launcher", "nav:menu", "nav:breadcrumb", "global:search", "global:notifications", "user:profile", "ai:chat_window", "ai:suggestion"]>, z.ZodString]>;
     id: z.ZodOptional<z.ZodString>;
     /** Configuration */
     label: z.ZodOptional<z.ZodString>;
@@ -79,6 +83,20 @@ export declare const PageComponentSchema: z.ZodObject<{
  * Page Schema
  * Defines a composition of components for a specific context (Record, Home, App).
  * Compare to Salesforce FlexiPage.
+ *
+ * **NAMING CONVENTION:**
+ * Page names are used in routing and must be lowercase snake_case.
+ * Prefix with 'page_' is recommended for clarity.
+ *
+ * @example Good page names
+ * - 'page_dashboard'
+ * - 'page_settings'
+ * - 'home_page'
+ * - 'record_detail'
+ *
+ * @example Bad page names (will be rejected)
+ * - 'PageDashboard' (PascalCase)
+ * - 'Settings Page' (spaces)
  */
 export declare const PageSchema: z.ZodObject<{
     name: z.ZodString;
@@ -96,7 +114,7 @@ export declare const PageSchema: z.ZodObject<{
         width: z.ZodOptional<z.ZodEnum<["small", "medium", "large", "full"]>>;
         components: z.ZodArray<z.ZodLazy<z.ZodObject<{
             /** Definition */
-            type: z.ZodString;
+            type: z.ZodUnion<[z.ZodEnum<["page:header", "page:footer", "page:sidebar", "page:tabs", "page:accordion", "page:card", "page:section", "record:details", "record:highlights", "record:related_list", "record:activity", "record:chatter", "record:path", "app:launcher", "nav:menu", "nav:breadcrumb", "global:search", "global:notifications", "user:profile", "ai:chat_window", "ai:suggestion"]>, z.ZodString]>;
             id: z.ZodOptional<z.ZodString>;
             /** Configuration */
             label: z.ZodOptional<z.ZodString>;

package/dist/ui/page.zod.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"page.zod.d.ts","sourceRoot":"","sources":["../../src/ui/page.zod.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;GAGG;AACH,eAAO,MAAM,gBAAgB;;;;QAW3B,iBAAiB;;;QAIjB,oBAAoB;;;QAIpB,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAftB,CAAC;AAEH;;;GAGG;AACH,eAAO,MAAM,mBAAmB;IAC9B,iBAAiB;;;IAIjB,oBAAoB;;;IAIpB,sBAAsB;;;;;;;;;;;;;;EAEtB,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,UAAU;;;;IAKrB,gBAAgB;;IAGhB,cAAc;;IAGd,sBAAsB;;IAGtB,wBAAwB;;;;;YA/BxB,iBAAiB;;;YAIjB,oBAAoB;;;YAIpB,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IA0BtB,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAGjB,CAAC;AAEH,MAAM,MAAM,IAAI,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,UAAU,CAAC,CAAC;AAC9C,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAChE,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC"}
+{"version":3,"file":"page.zod.d.ts","sourceRoot":"","sources":["../../src/ui/page.zod.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB;;;GAGG;AACH,eAAO,MAAM,gBAAgB;;;;QA2B3B,iBAAiB;;;QAOjB,oBAAoB;;;QAIpB,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAlCtB,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,iBAAiB,mXAW5B,CAAC;AAEH;;;GAGG;AACH,eAAO,MAAM,mBAAmB;IAC9B,iBAAiB;;;IAOjB,oBAAoB;;;IAIpB,sBAAsB;;;;;;;;;;;;;;EAEtB,CAAC;AAEH;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,UAAU;;;;IAKrB,gBAAgB;;IAGhB,cAAc;;IAGd,sBAAsB;;IAGtB,wBAAwB;;;;;YAhDxB,iBAAiB;;;YAOjB,oBAAoB;;;YAIpB,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAwCtB,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAGjB,CAAC;AAEH,MAAM,MAAM,IAAI,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,UAAU,CAAC,CAAC;AAC9C,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAChE,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC"}

package/dist/ui/page.zod.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PageSchema = exports.PageComponentSchema = exports.PageRegionSchema = void 0;
+exports.PageSchema = exports.PageComponentSchema = exports.PageComponentType = exports.PageRegionSchema = void 0;
 const zod_1 = require("zod");
+const identifiers_zod_1 = require("../shared/identifiers.zod");
 /**
  * Page Region Schema
  * A named region in the template where components are dropped.
@@ -11,17 +12,35 @@ exports.PageRegionSchema = zod_1.z.object({
     width: zod_1.z.enum(['small', 'medium', 'large', 'full']).optional(),
     components: zod_1.z.array(zod_1.z.lazy(() => exports.PageComponentSchema)).describe('Components in this region')
 });
+/**
+ * Standard Page Component Types
+ */
+exports.PageComponentType = zod_1.z.enum([
+    // Structure
+    'page:header', 'page:footer', 'page:sidebar', 'page:tabs', 'page:accordion', 'page:card', 'page:section',
+    // Record Context
+    'record:details', 'record:highlights', 'record:related_list', 'record:activity', 'record:chatter', 'record:path',
+    // Navigation
+    'app:launcher', 'nav:menu', 'nav:breadcrumb',
+    // Utility
+    'global:search', 'global:notifications', 'user:profile',
+    // AI
+    'ai:chat_window', 'ai:suggestion'
+]);
 /**
  * Page Component Schema
  * A configured instance of a UI component.
  */
 exports.PageComponentSchema = zod_1.z.object({
     /** Definition */
-    type: zod_1.z.string().describe('Component Type (e.g. "steedos-labs.related-list")'),
+    type: zod_1.z.union([
+        exports.PageComponentType,
+        zod_1.z.string()
+    ]).describe('Component Type (Standard enum or custom string)'),
     id: zod_1.z.string().optional().describe('Unique instance ID'),
     /** Configuration */
     label: zod_1.z.string().optional(),
-    properties: zod_1.z.record(zod_1.z.any()).describe('Component props passed to the widget'),
+    properties: zod_1.z.record(zod_1.z.any()).describe('Component props passed to the widget. See block.zod.ts for schemas.'),
     /** Visibility Rule */
     visibility: zod_1.z.string().optional().describe('Visibility filter/formula')
 });
@@ -29,9 +48,23 @@ exports.PageComponentSchema = zod_1.z.object({
  * Page Schema
  * Defines a composition of components for a specific context (Record, Home, App).
  * Compare to Salesforce FlexiPage.
+ *
+ * **NAMING CONVENTION:**
+ * Page names are used in routing and must be lowercase snake_case.
+ * Prefix with 'page_' is recommended for clarity.
+ *
+ * @example Good page names
+ * - 'page_dashboard'
+ * - 'page_settings'
+ * - 'home_page'
+ * - 'record_detail'
+ *
+ * @example Bad page names (will be rejected)
+ * - 'PageDashboard' (PascalCase)
+ * - 'Settings Page' (spaces)
  */
 exports.PageSchema = zod_1.z.object({
-    name: zod_1.z.string().regex(/^[a-z_][a-z0-9_]*$/),
+    name: identifiers_zod_1.SnakeCaseIdentifierSchema.describe('Page unique name (lowercase snake_case)'),
     label: zod_1.z.string(),
     description: zod_1.z.string().optional(),
     /** Page Type */

package/dist/ui/report.zod.d.ts

@@ -46,13 +46,13 @@ export declare const ReportChartSchema: z.ZodObject<{
     xAxis: z.ZodString;
     yAxis: z.ZodString;
 }, "strip", z.ZodTypeAny, {
-    type: "bar" | "line" | "pie" | "donut" | "funnel" | "column" | "scatter";
+    type: "bar" | "line" | "pie" | "donut" | "funnel" | "scatter" | "column";
     showLegend: boolean;
     xAxis: string;
     yAxis: string;
     title?: string | undefined;
 }, {
-    type: "bar" | "line" | "pie" | "donut" | "funnel" | "column" | "scatter";
+    type: "bar" | "line" | "pie" | "donut" | "funnel" | "scatter" | "column";
     xAxis: string;
     yAxis: string;
     title?: string | undefined;
@@ -121,13 +121,13 @@ export declare const ReportSchema: z.ZodObject<{
         xAxis: z.ZodString;
         yAxis: z.ZodString;
     }, "strip", z.ZodTypeAny, {
-        type: "bar" | "line" | "pie" | "donut" | "funnel" | "column" | "scatter";
+        type: "bar" | "line" | "pie" | "donut" | "funnel" | "scatter" | "column";
         showLegend: boolean;
         xAxis: string;
         yAxis: string;
         title?: string | undefined;
     }, {
-        type: "bar" | "line" | "pie" | "donut" | "funnel" | "column" | "scatter";
+        type: "bar" | "line" | "pie" | "donut" | "funnel" | "scatter" | "column";
         xAxis: string;
         yAxis: string;
         title?: string | undefined;
@@ -156,7 +156,7 @@ export declare const ReportSchema: z.ZodObject<{
         dateGranularity?: "day" | "week" | "month" | "quarter" | "year" | undefined;
     }[] | undefined;
     chart?: {
-        type: "bar" | "line" | "pie" | "donut" | "funnel" | "column" | "scatter";
+        type: "bar" | "line" | "pie" | "donut" | "funnel" | "scatter" | "column";
         showLegend: boolean;
         xAxis: string;
         yAxis: string;
@@ -171,8 +171,8 @@ export declare const ReportSchema: z.ZodObject<{
         label?: string | undefined;
         aggregate?: "count" | "sum" | "avg" | "min" | "max" | "unique" | undefined;
     }[];
-    type?: "summary" | "tabular" | "matrix" | "joined" | undefined;
     filter?: import("../data/filter.zod").FilterCondition | undefined;
+    type?: "summary" | "tabular" | "matrix" | "joined" | undefined;
     description?: string | undefined;
     groupingsDown?: {
         field: string;
@@ -185,7 +185,7 @@ export declare const ReportSchema: z.ZodObject<{
         dateGranularity?: "day" | "week" | "month" | "quarter" | "year" | undefined;
     }[] | undefined;
     chart?: {
-        type: "bar" | "line" | "pie" | "donut" | "funnel" | "column" | "scatter";
+        type: "bar" | "line" | "pie" | "donut" | "funnel" | "scatter" | "column";
         xAxis: string;
         yAxis: string;
         title?: string | undefined;