@kozou/core 0.0.1 → 0.1.1

package/dist/types/ui-hints.d.ts

@@ -0,0 +1,139 @@
+import { z } from 'zod';
+declare const relationHintsSchema: z.ZodObject<{
+    labelField: z.ZodOptional<z.ZodString>;
+    searchFields: z.ZodOptional<z.ZodArray<z.ZodString>>;
+}, z.core.$strip>;
+declare const columnHintsSchema: z.ZodObject<{
+    label: z.ZodOptional<z.ZodString>;
+    widget: z.ZodOptional<z.ZodEnum<{
+        number: "number";
+        boolean: "boolean";
+        text: "text";
+        textarea: "textarea";
+        date: "date";
+        datetime: "datetime";
+        "enum-select": "enum-select";
+        "relation-select": "relation-select";
+        json: "json";
+        "image-url": "image-url";
+        uuid: "uuid";
+        currency: "currency";
+    }>>;
+    readonly: z.ZodOptional<z.ZodBoolean>;
+    relation: z.ZodOptional<z.ZodObject<{
+        labelField: z.ZodOptional<z.ZodString>;
+        searchFields: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+declare const tableHintsSchema: z.ZodObject<{
+    label: z.ZodOptional<z.ZodString>;
+    displayField: z.ZodOptional<z.ZodString>;
+    columns: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+        label: z.ZodOptional<z.ZodString>;
+        widget: z.ZodOptional<z.ZodEnum<{
+            number: "number";
+            boolean: "boolean";
+            text: "text";
+            textarea: "textarea";
+            date: "date";
+            datetime: "datetime";
+            "enum-select": "enum-select";
+            "relation-select": "relation-select";
+            json: "json";
+            "image-url": "image-url";
+            uuid: "uuid";
+            currency: "currency";
+        }>>;
+        readonly: z.ZodOptional<z.ZodBoolean>;
+        relation: z.ZodOptional<z.ZodObject<{
+            labelField: z.ZodOptional<z.ZodString>;
+            searchFields: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+declare const viewHintsSchema: z.ZodObject<{
+    label: z.ZodOptional<z.ZodString>;
+    columns: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+        label: z.ZodOptional<z.ZodString>;
+        widget: z.ZodOptional<z.ZodEnum<{
+            number: "number";
+            boolean: "boolean";
+            text: "text";
+            textarea: "textarea";
+            date: "date";
+            datetime: "datetime";
+            "enum-select": "enum-select";
+            "relation-select": "relation-select";
+            json: "json";
+            "image-url": "image-url";
+            uuid: "uuid";
+            currency: "currency";
+        }>>;
+        readonly: z.ZodOptional<z.ZodBoolean>;
+        relation: z.ZodOptional<z.ZodObject<{
+            labelField: z.ZodOptional<z.ZodString>;
+            searchFields: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+/** Top-level zod schema for UIHints YAML. Used by loadUIHints. */
+export declare const uiHintsSchema: z.ZodObject<{
+    tables: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+        label: z.ZodOptional<z.ZodString>;
+        displayField: z.ZodOptional<z.ZodString>;
+        columns: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+            label: z.ZodOptional<z.ZodString>;
+            widget: z.ZodOptional<z.ZodEnum<{
+                number: "number";
+                boolean: "boolean";
+                text: "text";
+                textarea: "textarea";
+                date: "date";
+                datetime: "datetime";
+                "enum-select": "enum-select";
+                "relation-select": "relation-select";
+                json: "json";
+                "image-url": "image-url";
+                uuid: "uuid";
+                currency: "currency";
+            }>>;
+            readonly: z.ZodOptional<z.ZodBoolean>;
+            relation: z.ZodOptional<z.ZodObject<{
+                labelField: z.ZodOptional<z.ZodString>;
+                searchFields: z.ZodOptional<z.ZodArray<z.ZodString>>;
+            }, z.core.$strip>>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>>>;
+    views: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+        label: z.ZodOptional<z.ZodString>;
+        columns: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+            label: z.ZodOptional<z.ZodString>;
+            widget: z.ZodOptional<z.ZodEnum<{
+                number: "number";
+                boolean: "boolean";
+                text: "text";
+                textarea: "textarea";
+                date: "date";
+                datetime: "datetime";
+                "enum-select": "enum-select";
+                "relation-select": "relation-select";
+                json: "json";
+                "image-url": "image-url";
+                uuid: "uuid";
+                currency: "currency";
+            }>>;
+            readonly: z.ZodOptional<z.ZodBoolean>;
+            relation: z.ZodOptional<z.ZodObject<{
+                labelField: z.ZodOptional<z.ZodString>;
+                searchFields: z.ZodOptional<z.ZodArray<z.ZodString>>;
+            }, z.core.$strip>>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+export type UIHints = z.infer<typeof uiHintsSchema>;
+export type TableHints = z.infer<typeof tableHintsSchema>;
+export type ColumnHints = z.infer<typeof columnHintsSchema>;
+export type ViewHints = z.infer<typeof viewHintsSchema>;
+export type RelationHints = z.infer<typeof relationHintsSchema>;
+export {};
+//# sourceMappingURL=ui-hints.d.ts.map

package/dist/types/ui-hints.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ui-hints.d.ts","sourceRoot":"","sources":["../../src/types/ui-hints.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAmBxB,QAAA,MAAM,mBAAmB;;;iBAGvB,CAAC;AAEH,QAAA,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;iBAMrB,CAAC;AAEH,QAAA,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;iBAIpB,CAAC;AAEH,QAAA,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;iBAGnB,CAAC;AAEH,kEAAkE;AAClE,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAGxB,CAAC;AAEH,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAC;AACpD,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAC1D,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAC5D,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC;AACxD,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC"}

package/dist/types/ui-hints.js

@@ -0,0 +1,50 @@
+// UIHints type definitions + zod schema per Kozou v0.1 spec §4.3.
+//
+// Kozou v0.1 spec §16.1 leaves the final YAML grammar intentionally open
+// ("finalised during implementation"). In v0.1 we treat the TypeScript
+// shape in spec §4.3 as the minimal source of truth and validate the
+// parsed YAML with zod from loadUIHints.
+//
+// Extension surface: when v0.2 adds relations or validation rules, extend
+// this schema and update Kozou v0.1 spec §4.3 in the same PR (§0 rule).
+import { z } from 'zod';
+const widgetTypeSchema = z.enum([
+    'text',
+    'textarea',
+    'number',
+    'boolean',
+    'date',
+    'datetime',
+    'enum-select',
+    'relation-select',
+    'json',
+    'image-url',
+    'uuid',
+    'currency',
+]);
+const relationHintsSchema = z.object({
+    labelField: z.string().min(1).optional(),
+    searchFields: z.array(z.string().min(1)).optional(),
+});
+const columnHintsSchema = z.object({
+    label: z.string().min(1).optional(),
+    widget: widgetTypeSchema.optional(),
+    readonly: z.boolean().optional(),
+    /** Used for relation rendering; only meaningful when widget = relation-select */
+    relation: relationHintsSchema.optional(),
+});
+const tableHintsSchema = z.object({
+    label: z.string().min(1).optional(),
+    displayField: z.string().min(1).optional(),
+    columns: z.record(z.string(), columnHintsSchema).optional(),
+});
+const viewHintsSchema = z.object({
+    label: z.string().min(1).optional(),
+    columns: z.record(z.string(), columnHintsSchema).optional(),
+});
+/** Top-level zod schema for UIHints YAML. Used by loadUIHints. */
+export const uiHintsSchema = z.object({
+    tables: z.record(z.string(), tableHintsSchema).optional(),
+    views: z.record(z.string(), viewHintsSchema).optional(),
+});
+//# sourceMappingURL=ui-hints.js.map

package/dist/types/ui-hints.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ui-hints.js","sourceRoot":"","sources":["../../src/types/ui-hints.ts"],"names":[],"mappings":"AAAA,kEAAkE;AAClE,EAAE;AACF,yEAAyE;AACzE,uEAAuE;AACvE,qEAAqE;AACrE,yCAAyC;AACzC,EAAE;AACF,0EAA0E;AAC1E,wEAAwE;AAExE,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB,MAAM,gBAAgB,GAAG,CAAC,CAAC,IAAI,CAAC;IAC9B,MAAM;IACN,UAAU;IACV,QAAQ;IACR,SAAS;IACT,MAAM;IACN,UAAU;IACV,aAAa;IACb,iBAAiB;IACjB,MAAM;IACN,WAAW;IACX,MAAM;IACN,UAAU;CACX,CAAiC,CAAC;AAEnC,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC;IACnC,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IACxC,YAAY,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;CACpD,CAAC,CAAC;AAEH,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,CAAC;IACjC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IACnC,MAAM,EAAE,gBAAgB,CAAC,QAAQ,EAAE;IACnC,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAChC,iFAAiF;IACjF,QAAQ,EAAE,mBAAmB,CAAC,QAAQ,EAAE;CACzC,CAAC,CAAC;AAEH,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC;IAChC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IACnC,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IAC1C,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,iBAAiB,CAAC,CAAC,QAAQ,EAAE;CAC5D,CAAC,CAAC;AAEH,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC;IAC/B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IACnC,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,iBAAiB,CAAC,CAAC,QAAQ,EAAE;CAC5D,CAAC,CAAC;AAEH,kEAAkE;AAClE,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,CAAC,MAAM,CAAC;IACpC,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,gBAAgB,CAAC,CAAC,QAAQ,EAAE;IACzD,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,eAAe,CAAC,CAAC,QAAQ,EAAE;CACxD,CAAC,CAAC"}

package/dist/widget.d.ts

@@ -0,0 +1,11 @@
+import type { RawColumn } from './types/raw.js';
+import type { WidgetType } from './types/context.js';
+export type InferWidgetInput = {
+    column: RawColumn;
+    isForeignKey: boolean;
+    enumValues: string[] | null;
+    /** parseCommentTags(column.comment).body */
+    commentBody: string;
+};
+export declare function inferWidget(input: InferWidgetInput): WidgetType;
+//# sourceMappingURL=widget.d.ts.map

package/dist/widget.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"widget.d.ts","sourceRoot":"","sources":["../src/widget.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AASrD,MAAM,MAAM,gBAAgB,GAAG;IAC7B,MAAM,EAAE,SAAS,CAAC;IAClB,YAAY,EAAE,OAAO,CAAC;IACtB,UAAU,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAC5B,4CAA4C;IAC5C,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,wBAAgB,WAAW,CAAC,KAAK,EAAE,gBAAgB,GAAG,UAAU,CAe/D"}

package/dist/widget.js

@@ -0,0 +1,31 @@
+const NUMERIC_UDT = new Set(['int2', 'int4', 'int8', 'numeric', 'float4', 'float8']);
+const DATETIME_UDT = new Set(['timestamp', 'timestamptz', 'time', 'timetz']);
+const JSON_UDT = new Set(['json', 'jsonb']);
+const URL_HINT_RE = /(?:^|_)url\b|image/i;
+const TEXTAREA_HINT_RE = /html|markdown|body|content/i;
+export function inferWidget(input) {
+    const { column, isForeignKey, enumValues, commentBody } = input;
+    const udt = column.udtName;
+    if (isForeignKey)
+        return 'relation-select';
+    if (enumValues !== null && enumValues.length > 0)
+        return 'enum-select';
+    if (udt === 'uuid')
+        return 'uuid';
+    if (udt === 'bool')
+        return 'boolean';
+    if (NUMERIC_UDT.has(udt))
+        return 'number';
+    if (udt === 'date')
+        return 'date';
+    if (DATETIME_UDT.has(udt))
+        return 'datetime';
+    if (JSON_UDT.has(udt))
+        return 'json';
+    if (udt === 'text' && URL_HINT_RE.test(column.name))
+        return 'image-url';
+    if (udt === 'text' && TEXTAREA_HINT_RE.test(commentBody))
+        return 'textarea';
+    return 'text';
+}
+//# sourceMappingURL=widget.js.map

package/dist/widget.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"widget.js","sourceRoot":"","sources":["../src/widget.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,GAAG,IAAI,GAAG,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC;AACrF,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,CAAC,WAAW,EAAE,aAAa,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;AAC7E,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;AAE5C,MAAM,WAAW,GAAG,qBAAqB,CAAC;AAC1C,MAAM,gBAAgB,GAAG,6BAA6B,CAAC;AAUvD,MAAM,UAAU,WAAW,CAAC,KAAuB;IACjD,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,KAAK,CAAC;IAChE,MAAM,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC;IAE3B,IAAI,YAAY;QAAE,OAAO,iBAAiB,CAAC;IAC3C,IAAI,UAAU,KAAK,IAAI,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,aAAa,CAAC;IACvE,IAAI,GAAG,KAAK,MAAM;QAAE,OAAO,MAAM,CAAC;IAClC,IAAI,GAAG,KAAK,MAAM;QAAE,OAAO,SAAS,CAAC;IACrC,IAAI,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC;QAAE,OAAO,QAAQ,CAAC;IAC1C,IAAI,GAAG,KAAK,MAAM;QAAE,OAAO,MAAM,CAAC;IAClC,IAAI,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC;QAAE,OAAO,UAAU,CAAC;IAC7C,IAAI,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC;QAAE,OAAO,MAAM,CAAC;IACrC,IAAI,GAAG,KAAK,MAAM,IAAI,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;QAAE,OAAO,WAAW,CAAC;IACxE,IAAI,GAAG,KAAK,MAAM,IAAI,gBAAgB,CAAC,IAAI,CAAC,WAAW,CAAC;QAAE,OAAO,UAAU,CAAC;IAC5E,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/package.json

@@ -1,7 +1,45 @@
 {
   "name": "@kozou/core",
-  "version": "0.0.1",
-  "description": "Placeholder; v0.1.0 release lands via CI shortly.",
+  "version": "0.1.1",
+  "description": "Kozou core: Schema Context, type definitions, UI Hints zod schema, DataAdapter interface.",
   "license": "Apache-2.0",
-  "publishConfig": { "access": "public" }
-}
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kozou-dev/kozou.git",
+    "directory": "packages/core"
+  },
+  "homepage": "https://kozou.org",
+  "bugs": {
+    "url": "https://github.com/kozou-dev/kozou/issues"
+  },
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "dependencies": {
+    "yaml": "^2.6.0",
+    "zod": "^4.4.3"
+  },
+  "devDependencies": {
+    "@types/pg": "^8.11.0",
+    "pg": "^8.13.0"
+  },
+  "scripts": {
+    "typecheck": "tsc --noEmit",
+    "build": "tsc",
+    "test": "vitest run --coverage"
+  }
+}

package/README.md

@@ -1,3 +0,0 @@
-# @kozou/core
-
-Placeholder publish. The real v0.1.0 release lands via CI shortly. See https://github.com/kozou-dev/kozou for the source.