@ghentcdh/crouton-core 0.0.1-alpha.49 → 0.0.1-alpha.51

package/dist/index.cjs

@@ -97,6 +97,7 @@ __export(index_exports, {
   buildConditionSchema: () => buildConditionSchema,
   buildFilter: () => buildFilter,
   buildFormUiSchema: () => buildFormUiSchema,
+  buildResourceJsonSchema: () => buildResourceJsonSchema,
   buildRule: () => buildRule,
   buildSort: () => buildSort,
   buildSortKey: () => buildSortKey,
@@ -106,6 +107,7 @@ __export(index_exports, {
   buildViewsFromColumnTypes: () => buildViewsFromColumnTypes,
   buildViewsFromColumns: () => buildViewsFromColumns,
   buildViewsWithSource: () => buildViewsWithSource,
+  clearResourceExtensions: () => clearResourceExtensions,
   colPosition: () => colPosition,
   columnForContext: () => columnForContext,
   columnKey: () => columnKey,
@@ -124,6 +126,8 @@ __export(index_exports, {
   findColumnDef: () => findColumnDef,
   findProperty: () => findProperty,
   fromValueLabel: () => fromValueLabel,
+  generateResourceJsonSchema: () => generateResourceJsonSchema,
+  getResourceExtensions: () => getResourceExtensions,
   injectCalculatedColumns: () => injectCalculatedColumns,
   injectCalculatedColumnsToView: () => injectCalculatedColumnsToView,
   isArrayColumn: () => isArrayColumn,
@@ -146,6 +150,8 @@ __export(index_exports, {
   patchFilterProperties: () => patchFilterProperties,
   pickSharedCellOptions: () => pickSharedCellOptions,
   refineByKind: () => refineByKind,
+  registerResourceExtension: () => registerResourceExtension,
+  registerResourceExtensions: () => registerResourceExtensions,
   resolveDefaultSort: () => resolveDefaultSort,
   resolveFormField: () => resolveFormField,
   resolveLanguage: () => resolveLanguage,
@@ -1364,6 +1370,44 @@ var transformAction = (action) => {
 };
 var JsonActionSchema = import_zod17.z.union([JsonProcedureActionSchema, JsonLinkActionSchema]).transform(transformAction);
 
+// src/lib/resource/extensions.ts
+var CORE_RESOURCE_KEYS = /* @__PURE__ */ new Set([
+  "$schema",
+  "schemaVersion",
+  "draft",
+  "kind",
+  "id",
+  "name",
+  "route",
+  "model",
+  "tag",
+  "title",
+  "table",
+  "idType",
+  "database",
+  "parent",
+  "sidebar",
+  "display",
+  "security",
+  "operations",
+  "columns",
+  "calculatedColumns",
+  "actions",
+  "tableActions",
+  "modalSize",
+  "include",
+  "extensions"
+]);
+var registry = /* @__PURE__ */ new Map();
+var registerResourceExtension = (name, schema) => {
+  if (CORE_RESOURCE_KEYS.has(name))
+    throw new Error(`Extension "${name}" shadows a core resource key.`);
+  registry.set(name, schema);
+};
+var registerResourceExtensions = (map = {}) => Object.entries(map).forEach(([k, s]) => registerResourceExtension(k, s));
+var getResourceExtensions = () => registry;
+var clearResourceExtensions = () => registry.clear();
+
 // src/lib/resource/include.schema.ts
 var import_zod18 = require("zod");
 var JsonIncludeEntrySchema = import_zod18.z.lazy(
@@ -1427,15 +1471,17 @@ var ResourceJsonShape = import_zod19.z.object({
   kind: ResourceKindSchema,
   name: import_zod19.z.string(),
   // required — unique id, used as the frontend form id
-  route: import_zod19.z.string(),
-  // required — URL segment for generated endpoints
+  route: import_zod19.z.string().optional(),
+  //  URL segment for generated endpoints - default id is used
+  id: import_zod19.z.string().optional(),
+  //  URL segment for generated endpoints - default id is used
   /**
    * Prisma model name. Required when `kind` is `prisma` (enforced by the
    * refinement on `ResourceJsonSchema`), and must be absent when `kind` is
    * `custom` — there is no Prisma delegate to address.
    */
   model: import_zod19.z.string().optional(),
-  tag: import_zod19.z.string(),
+  tag: import_zod19.z.string().optional().default("Crouton"),
   // required — OpenAPI tag
   title: import_zod19.z.string().optional(),
   // no computed default — used as UI display title
@@ -1459,9 +1505,9 @@ var ResourceJsonShape = import_zod19.z.object({
   // default: { mode: 'modal', customComponent: null }
   /** Global security block — applies to every operation unless overridden per-operation. */
   security: SecuritySchema.optional(),
-  operations: JsonOperationsSchema,
-  // required key — but every sub-field defaults to enabled
-  columns: ColumnsSchema.default(ColumnsSchema.parse({})),
+  operations: JsonOperationsSchema.optional(),
+  // default applied in transform: custom → all false, prisma → all true
+  columns: ColumnsSchema.optional().default(ColumnsSchema.parse({})),
   //  id-keyed map; omit for a columnless resource
   calculatedColumns: import_zod19.z.array(CalculatedColumnSchema).default([]),
   actions: import_zod19.z.array(JsonActionSchema).default([]),
@@ -1477,7 +1523,12 @@ var ResourceJsonShape = import_zod19.z.object({
    * `{ "relation": "text_author", "include": ["author"] }` →
    *   `include: { text_author: { include: { author: true } } }`
    */
-  include: import_zod19.z.array(JsonIncludeEntrySchema).default([])
+  include: import_zod19.z.array(JsonIncludeEntrySchema).default([]),
+  /**
+   * Normalized extension blocks lifted from registered top-level keys.
+   * Authors never write this key directly — the transform fills it.
+   */
+  extensions: import_zod19.z.record(import_zod19.z.string(), import_zod19.z.unknown()).optional()
 });
 var refineByKind = (obj, ctx) => {
   if (obj.kind === "custom") {
@@ -1528,18 +1579,70 @@ var refineByKind = (obj, ctx) => {
     });
   }
 };
-var ResourceJsonSchema = ResourceJsonShape.superRefine(
-  refineByKind
-).transform((obj) => {
-  const title = obj.title ?? labelFromId(obj.name);
-  const schemaVersion = obj.schemaVersion ?? BASELINE_RESOURCE_VERSION;
-  return {
-    title,
-    ...obj,
-    schemaVersion,
-    columns: normalizeColumns(obj.columns)
-  };
-});
+var buildResourceJsonSchema = () => {
+  const ext = getResourceExtensions();
+  const extShape = Object.fromEntries(
+    [...ext].map(([name, schema]) => [name, schema.optional()])
+  );
+  const shape = ext.size ? ResourceJsonShape.extend(extShape) : ResourceJsonShape;
+  return import_zod19.z.preprocess(
+    (raw) => {
+      if (raw && typeof raw === "object" && !Array.isArray(raw)) {
+        const obj = raw;
+        if (obj["kind"] === void 0) {
+          return {
+            ...obj,
+            kind: obj["model"] !== void 0 ? "prisma" : "custom"
+          };
+        }
+      }
+      return raw;
+    },
+    shape.superRefine(refineByKind).transform((obj) => {
+      const title = obj.title ?? labelFromId(obj.name);
+      const schemaVersion = obj.schemaVersion ?? BASELINE_RESOURCE_VERSION;
+      const defaultOps = obj.kind === "custom" ? JsonOperationsSchema.parse({ findAll: false, findOne: false, create: false, update: false, patch: false, delete: false }) : JsonOperationsSchema.parse({});
+      const raw = obj;
+      const extensions = {};
+      for (const name of ext.keys()) {
+        if (raw[name] !== void 0) {
+          extensions[name] = raw[name];
+          delete raw[name];
+        }
+      }
+      return {
+        title,
+        ...obj,
+        route: obj.route ?? obj.id ?? obj.name ?? "",
+        schemaVersion,
+        columns: normalizeColumns(obj.columns),
+        operations: obj.operations ?? defaultOps,
+        ...Object.keys(extensions).length && { extensions }
+      };
+    })
+  );
+};
+var ResourceJsonSchema = buildResourceJsonSchema();
+var generateResourceJsonSchema = () => {
+  const ext = getResourceExtensions();
+  const extShape = Object.fromEntries(
+    [...ext].map(([name, schema]) => [name, schema.optional()])
+  );
+  const shape = ext.size ? ResourceJsonShape.extend(extShape) : ResourceJsonShape;
+  try {
+    return import_zod19.z.toJSONSchema(shape, {
+      target: "draft-7",
+      io: "input",
+      unrepresentable: "any"
+    });
+  } catch {
+    return import_zod19.z.toJSONSchema(ResourceJsonShape, {
+      target: "draft-7",
+      io: "input",
+      unrepresentable: "any"
+    });
+  }
+};
 
 // src/lib/resource/migrations/types.ts
 var MigrationPathError = class extends Error {
@@ -2524,6 +2627,7 @@ var resolveLanguage = (acceptLanguage, supported, defaultLanguage) => {
   buildConditionSchema,
   buildFilter,
   buildFormUiSchema,
+  buildResourceJsonSchema,
   buildRule,
   buildSort,
   buildSortKey,
@@ -2533,6 +2637,7 @@ var resolveLanguage = (acceptLanguage, supported, defaultLanguage) => {
   buildViewsFromColumnTypes,
   buildViewsFromColumns,
   buildViewsWithSource,
+  clearResourceExtensions,
   colPosition,
   columnForContext,
   columnKey,
@@ -2551,6 +2656,8 @@ var resolveLanguage = (acceptLanguage, supported, defaultLanguage) => {
   findColumnDef,
   findProperty,
   fromValueLabel,
+  generateResourceJsonSchema,
+  getResourceExtensions,
   injectCalculatedColumns,
   injectCalculatedColumnsToView,
   isArrayColumn,
@@ -2573,6 +2680,8 @@ var resolveLanguage = (acceptLanguage, supported, defaultLanguage) => {
   patchFilterProperties,
   pickSharedCellOptions,
   refineByKind,
+  registerResourceExtension,
+  registerResourceExtensions,
   resolveDefaultSort,
   resolveFormField,
   resolveLanguage,