@objectstack/spec 0.1.0 → 0.1.2

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

@@ -0,0 +1,233 @@
+import { z } from 'zod';
+/**
+ * Report Type Enum
+ */
+export declare const ReportType: z.ZodEnum<["tabular", "summary", "matrix", "joined"]>;
+/**
+ * Report Column Schema
+ */
+export declare const ReportColumnSchema: z.ZodObject<{
+    field: z.ZodString;
+    label: z.ZodOptional<z.ZodString>;
+    aggregate: z.ZodOptional<z.ZodEnum<["sum", "avg", "max", "min", "count", "unique"]>>;
+}, "strip", z.ZodTypeAny, {
+    field: string;
+    label?: string | undefined;
+    aggregate?: "unique" | "min" | "max" | "count" | "sum" | "avg" | undefined;
+}, {
+    field: string;
+    label?: string | undefined;
+    aggregate?: "unique" | "min" | "max" | "count" | "sum" | "avg" | undefined;
+}>;
+/**
+ * Report Grouping Schema
+ */
+export declare const ReportGroupingSchema: z.ZodObject<{
+    field: z.ZodString;
+    sortOrder: z.ZodDefault<z.ZodEnum<["asc", "desc"]>>;
+    dateGranularity: z.ZodOptional<z.ZodEnum<["day", "week", "month", "quarter", "year"]>>;
+}, "strip", z.ZodTypeAny, {
+    field: string;
+    sortOrder: "asc" | "desc";
+    dateGranularity?: "day" | "week" | "month" | "quarter" | "year" | undefined;
+}, {
+    field: string;
+    sortOrder?: "asc" | "desc" | undefined;
+    dateGranularity?: "day" | "week" | "month" | "quarter" | "year" | undefined;
+}>;
+/**
+ * Report Chart Schema
+ * Embedded visualization configuration.
+ */
+export declare const ReportChartSchema: z.ZodObject<{
+    type: z.ZodEnum<["bar", "column", "line", "pie", "donut", "scatter", "funnel"]>;
+    title: z.ZodOptional<z.ZodString>;
+    showLegend: z.ZodDefault<z.ZodBoolean>;
+    xAxis: z.ZodString;
+    yAxis: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: "bar" | "line" | "pie" | "donut" | "funnel" | "column" | "scatter";
+    showLegend: boolean;
+    xAxis: string;
+    yAxis: string;
+    title?: string | undefined;
+}, {
+    type: "bar" | "line" | "pie" | "donut" | "funnel" | "column" | "scatter";
+    xAxis: string;
+    yAxis: string;
+    title?: string | undefined;
+    showLegend?: boolean | undefined;
+}>;
+/**
+ * Report Schema
+ * Deep data analysis definition.
+ */
+export declare const ReportSchema: z.ZodObject<{
+    /** Identity */
+    name: z.ZodString;
+    label: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    /** Data Source */
+    objectName: z.ZodString;
+    /** Report Configuration */
+    type: z.ZodDefault<z.ZodEnum<["tabular", "summary", "matrix", "joined"]>>;
+    columns: z.ZodArray<z.ZodObject<{
+        field: z.ZodString;
+        label: z.ZodOptional<z.ZodString>;
+        aggregate: z.ZodOptional<z.ZodEnum<["sum", "avg", "max", "min", "count", "unique"]>>;
+    }, "strip", z.ZodTypeAny, {
+        field: string;
+        label?: string | undefined;
+        aggregate?: "unique" | "min" | "max" | "count" | "sum" | "avg" | undefined;
+    }, {
+        field: string;
+        label?: string | undefined;
+        aggregate?: "unique" | "min" | "max" | "count" | "sum" | "avg" | undefined;
+    }>, "many">;
+    /** Grouping (for Summary/Matrix) */
+    groupingsDown: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        field: z.ZodString;
+        sortOrder: z.ZodDefault<z.ZodEnum<["asc", "desc"]>>;
+        dateGranularity: z.ZodOptional<z.ZodEnum<["day", "week", "month", "quarter", "year"]>>;
+    }, "strip", z.ZodTypeAny, {
+        field: string;
+        sortOrder: "asc" | "desc";
+        dateGranularity?: "day" | "week" | "month" | "quarter" | "year" | undefined;
+    }, {
+        field: string;
+        sortOrder?: "asc" | "desc" | undefined;
+        dateGranularity?: "day" | "week" | "month" | "quarter" | "year" | undefined;
+    }>, "many">>;
+    groupingsAcross: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        field: z.ZodString;
+        sortOrder: z.ZodDefault<z.ZodEnum<["asc", "desc"]>>;
+        dateGranularity: z.ZodOptional<z.ZodEnum<["day", "week", "month", "quarter", "year"]>>;
+    }, "strip", z.ZodTypeAny, {
+        field: string;
+        sortOrder: "asc" | "desc";
+        dateGranularity?: "day" | "week" | "month" | "quarter" | "year" | undefined;
+    }, {
+        field: string;
+        sortOrder?: "asc" | "desc" | undefined;
+        dateGranularity?: "day" | "week" | "month" | "quarter" | "year" | undefined;
+    }>, "many">>;
+    /** Filtering */
+    filter: z.ZodOptional<z.ZodString>;
+    filterItems: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        id: z.ZodNumber;
+        field: z.ZodString;
+        operator: z.ZodString;
+        value: z.ZodAny;
+    }, "strip", z.ZodTypeAny, {
+        field: string;
+        id: number;
+        operator: string;
+        value?: any;
+    }, {
+        field: string;
+        id: number;
+        operator: string;
+        value?: any;
+    }>, "many">>;
+    /** Visualization */
+    chart: z.ZodOptional<z.ZodObject<{
+        type: z.ZodEnum<["bar", "column", "line", "pie", "donut", "scatter", "funnel"]>;
+        title: z.ZodOptional<z.ZodString>;
+        showLegend: z.ZodDefault<z.ZodBoolean>;
+        xAxis: z.ZodString;
+        yAxis: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        type: "bar" | "line" | "pie" | "donut" | "funnel" | "column" | "scatter";
+        showLegend: boolean;
+        xAxis: string;
+        yAxis: string;
+        title?: string | undefined;
+    }, {
+        type: "bar" | "line" | "pie" | "donut" | "funnel" | "column" | "scatter";
+        xAxis: string;
+        yAxis: string;
+        title?: string | undefined;
+        showLegend?: boolean | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    type: "summary" | "tabular" | "matrix" | "joined";
+    label: string;
+    name: string;
+    objectName: string;
+    columns: {
+        field: string;
+        label?: string | undefined;
+        aggregate?: "unique" | "min" | "max" | "count" | "sum" | "avg" | undefined;
+    }[];
+    filter?: string | undefined;
+    description?: string | undefined;
+    groupingsDown?: {
+        field: string;
+        sortOrder: "asc" | "desc";
+        dateGranularity?: "day" | "week" | "month" | "quarter" | "year" | undefined;
+    }[] | undefined;
+    groupingsAcross?: {
+        field: string;
+        sortOrder: "asc" | "desc";
+        dateGranularity?: "day" | "week" | "month" | "quarter" | "year" | undefined;
+    }[] | undefined;
+    filterItems?: {
+        field: string;
+        id: number;
+        operator: string;
+        value?: any;
+    }[] | undefined;
+    chart?: {
+        type: "bar" | "line" | "pie" | "donut" | "funnel" | "column" | "scatter";
+        showLegend: boolean;
+        xAxis: string;
+        yAxis: string;
+        title?: string | undefined;
+    } | undefined;
+}, {
+    label: string;
+    name: string;
+    objectName: string;
+    columns: {
+        field: string;
+        label?: string | undefined;
+        aggregate?: "unique" | "min" | "max" | "count" | "sum" | "avg" | undefined;
+    }[];
+    filter?: string | undefined;
+    type?: "summary" | "tabular" | "matrix" | "joined" | undefined;
+    description?: string | undefined;
+    groupingsDown?: {
+        field: string;
+        sortOrder?: "asc" | "desc" | undefined;
+        dateGranularity?: "day" | "week" | "month" | "quarter" | "year" | undefined;
+    }[] | undefined;
+    groupingsAcross?: {
+        field: string;
+        sortOrder?: "asc" | "desc" | undefined;
+        dateGranularity?: "day" | "week" | "month" | "quarter" | "year" | undefined;
+    }[] | undefined;
+    filterItems?: {
+        field: string;
+        id: number;
+        operator: string;
+        value?: any;
+    }[] | undefined;
+    chart?: {
+        type: "bar" | "line" | "pie" | "donut" | "funnel" | "column" | "scatter";
+        xAxis: string;
+        yAxis: string;
+        title?: string | undefined;
+        showLegend?: boolean | undefined;
+    } | undefined;
+}>;
+export type Report = z.infer<typeof ReportSchema>;
+export type ReportColumn = z.infer<typeof ReportColumnSchema>;
+export type ReportGrouping = z.infer<typeof ReportGroupingSchema>;
+export type ReportChart = z.infer<typeof ReportChartSchema>;
+/**
+ * Report Factory Helper
+ */
+export declare const Report: {
+    readonly create: (config: z.input<typeof ReportSchema>) => Report;
+};
+//# sourceMappingURL=report.zod.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"report.zod.d.ts","sourceRoot":"","sources":["../../src/ui/report.zod.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;GAEG;AACH,eAAO,MAAM,UAAU,uDAKrB,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;EAI7B,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;EAI/B,CAAC;AAEH;;;GAGG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;EAM5B,CAAC;AAEH;;;GAGG;AACH,eAAO,MAAM,YAAY;IACvB,eAAe;;;;IAKf,kBAAkB;;IAGlB,2BAA2B;;;;;;;;;;;;;;;IAK3B,oCAAoC;;;;;;;;;;;;;;;;;;;;;;;;;;;IAIpC,gBAAgB;;;;;;;;;;;;;;;;;;IAShB,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAEpB,CAAC;AAEH,MAAM,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAC;AAClD,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAC9D,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAClE,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAE5D;;GAEG;AACH,eAAO,MAAM,MAAM;8BACA,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,KAAG,MAAM;CAC9C,CAAC"}

package/dist/ui/report.zod.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Report = exports.ReportSchema = exports.ReportChartSchema = exports.ReportGroupingSchema = exports.ReportColumnSchema = exports.ReportType = void 0;
+const zod_1 = require("zod");
+/**
+ * Report Type Enum
+ */
+exports.ReportType = zod_1.z.enum([
+    'tabular', // Simple list
+    'summary', // Grouped by row
+    'matrix', // Grouped by row and column
+    'joined' // Joined multiple blocks
+]);
+/**
+ * Report Column Schema
+ */
+exports.ReportColumnSchema = zod_1.z.object({
+    field: zod_1.z.string().describe('Field name'),
+    label: zod_1.z.string().optional().describe('Override label'),
+    aggregate: zod_1.z.enum(['sum', 'avg', 'max', 'min', 'count', 'unique']).optional().describe('Aggregation function'),
+});
+/**
+ * Report Grouping Schema
+ */
+exports.ReportGroupingSchema = zod_1.z.object({
+    field: zod_1.z.string().describe('Field to group by'),
+    sortOrder: zod_1.z.enum(['asc', 'desc']).default('asc'),
+    dateGranularity: zod_1.z.enum(['day', 'week', 'month', 'quarter', 'year']).optional().describe('For date fields'),
+});
+/**
+ * Report Chart Schema
+ * Embedded visualization configuration.
+ */
+exports.ReportChartSchema = zod_1.z.object({
+    type: zod_1.z.enum(['bar', 'column', 'line', 'pie', 'donut', 'scatter', 'funnel']).describe('Chart type'),
+    title: zod_1.z.string().optional(),
+    showLegend: zod_1.z.boolean().default(true),
+    xAxis: zod_1.z.string().describe('Grouping field for X-Axis'),
+    yAxis: zod_1.z.string().describe('Summary field for Y-Axis'),
+});
+/**
+ * Report Schema
+ * Deep data analysis definition.
+ */
+exports.ReportSchema = zod_1.z.object({
+    /** Identity */
+    name: zod_1.z.string().regex(/^[a-z_][a-z0-9_]*$/).describe('Report unique name'),
+    label: zod_1.z.string().describe('Report label'),
+    description: zod_1.z.string().optional(),
+    /** Data Source */
+    objectName: zod_1.z.string().describe('Primary object'),
+    /** Report Configuration */
+    type: exports.ReportType.default('tabular').describe('Report format type'),
+    columns: zod_1.z.array(exports.ReportColumnSchema).describe('Columns to display'),
+    /** Grouping (for Summary/Matrix) */
+    groupingsDown: zod_1.z.array(exports.ReportGroupingSchema).optional().describe('Row groupings'),
+    groupingsAcross: zod_1.z.array(exports.ReportGroupingSchema).optional().describe('Column groupings (Matrix only)'),
+    /** Filtering */
+    filter: zod_1.z.string().optional().describe('Filter logic (e.g. "1 AND (2 OR 3)")'),
+    filterItems: zod_1.z.array(zod_1.z.object({
+        id: zod_1.z.number(),
+        field: zod_1.z.string(),
+        operator: zod_1.z.string(),
+        value: zod_1.z.any()
+    })).optional().describe('Filter criteria lines'),
+    /** Visualization */
+    chart: exports.ReportChartSchema.optional().describe('Embedded chart configuration'),
+});
+/**
+ * Report Factory Helper
+ */
+exports.Report = {
+    create: (config) => exports.ReportSchema.parse(config),
+};