@ghentcdh/crouton-api 0.0.1-alpha.44 → 0.0.1-alpha.46

package/dist/index.cjs

@@ -40,7 +40,7 @@ __export(index_exports, {
   ResourceConfigLoader: () => ResourceConfigLoader2,
   ResourceConfigRegistry: () => ResourceConfigRegistry,
   ResourceHooksSchema: () => ResourceHooksSchema,
-  SecurityGuardRegistry: () => SecurityGuardRegistry2,
+  SecurityGuardRegistry: () => SecurityGuardRegistry,
   WriteOpSchema: () => WriteOpSchema,
   buildFilterWhere: () => buildFilterWhere,
   buildViews: () => buildViews,
@@ -666,6 +666,48 @@ var JsonOperationsSchema = import_zod9.z.object({
   upsert: BoolOrUpsertSchema.default(false),
   delete: OpEntry.default(true)
 });
+var buildSubResourceOperations = /* @__PURE__ */ __name((ops, baseUri, idField = "id") => {
+  if (!ops) return {};
+  const idPlaceholder = `{${idField}}`;
+  return {
+    ...ops.findAll && {
+      findAll: {
+        uri: baseUri,
+        method: "get"
+      }
+    },
+    ...ops.findOne && {
+      findOne: {
+        uri: `${baseUri}/${idPlaceholder}`,
+        method: "get"
+      }
+    },
+    ...ops.create && {
+      create: {
+        uri: baseUri,
+        method: "post"
+      }
+    },
+    ...ops.update && {
+      update: {
+        uri: `${baseUri}/${idPlaceholder}`,
+        method: "put"
+      }
+    },
+    ...ops.patch && {
+      patch: {
+        uri: `${baseUri}/${idPlaceholder}`,
+        method: "patch"
+      }
+    },
+    ...ops.delete && {
+      delete: {
+        uri: `${baseUri}/${idPlaceholder}`,
+        method: "delete"
+      }
+    }
+  };
+}, "buildSubResourceOperations");
 
 // ../crouton-core/src/lib/resource/ResourceJson.schema.ts
 var import_zod19 = require("zod");
@@ -2187,11 +2229,21 @@ var ViewColumnConfigSchema = import_zod23.z.object({
   fieldInput: FieldInputSchema.optional()
 });
 var ViewConfigSchema = import_zod23.z.object({
-  json_schema: import_zod23.z.record(import_zod23.z.string(), import_zod23.z.unknown()),
-  ui_schema: import_zod23.z.record(import_zod23.z.string(), import_zod23.z.unknown()),
+  // TODO why we have both?
+  json_schema: import_zod23.z.record(import_zod23.z.string(), import_zod23.z.unknown()).optional(),
+  ui_schema: import_zod23.z.record(import_zod23.z.string(), import_zod23.z.unknown()).optional(),
+  // TODO why we have both?
+  ui: import_zod23.z.record(import_zod23.z.string(), import_zod23.z.unknown()).optional(),
+  data: import_zod23.z.record(import_zod23.z.string(), import_zod23.z.unknown()).optional(),
   columns: import_zod23.z.array(ViewColumnConfigSchema),
   defaultSort: import_zod23.z.string().optional()
 });
+var viewDefList = [
+  "table",
+  "view",
+  "form"
+];
+var ViewDefEnum = import_zod23.z.enum(viewDefList);
 
 // ../crouton-core/src/lib/i18n/Translations.schema.ts
 var import_zod24 = require("zod");
@@ -2297,7 +2349,7 @@ var resolveLanguage = /* @__PURE__ */ __name((acceptLanguage, supported, default
 
 // src/lib/crouton-api.module.ts
 var import_common24 = require("@nestjs/common");
-var import_core = require("@nestjs/core");
+var import_core2 = require("@nestjs/core");
 
 // src/lib/crud/app-layout/app-layout.types.ts
 var import_zod25 = require("zod");
@@ -2573,6 +2625,12 @@ var resolveColumnFieldVariants = /* @__PURE__ */ __name((cols) => cols?.map((col
 
 // src/lib/crud/translation/localize-resource.ts
 var clone = /* @__PURE__ */ __name((obj) => JSON.parse(JSON.stringify(obj)), "clone");
+var cloneResource = /* @__PURE__ */ __name((config) => {
+  const { definition, ...rest } = config;
+  const localized = clone(rest);
+  if (definition) localized.definition = definition;
+  return localized;
+}, "cloneResource");
 var translateEnumOptions = /* @__PURE__ */ __name((columns, t) => {
   if (!columns) return;
   for (const col of columns) {
@@ -2622,7 +2680,7 @@ var patchViewTitles = /* @__PURE__ */ __name((views, columnLabels) => {
 }, "patchViewTitles");
 var localizeResource = /* @__PURE__ */ __name((config, t) => {
   const name = config.name;
-  const localized = clone(config);
+  const localized = cloneResource(config);
   localized.title = t(resourceTitleKey(name), config.title ?? config.tag);
   if (localized.sidebar) {
     const sidebarTranslation = t(resourceSidebarKey(name), config.sidebar?.label);
@@ -4878,6 +4936,10 @@ var import_common12 = require("@nestjs/common");
 var import_swagger2 = require("@nestjs/swagger");
 
 // src/lib/crud/security/crouton-security.guard.ts
+var import_common11 = require("@nestjs/common");
+var import_core = require("@nestjs/core");
+
+// src/lib/crud/security/security-guard.registry.ts
 var import_common10 = require("@nestjs/common");
 function _ts_decorate6(decorators, target, key, desc2) {
   var c = arguments.length, r = c < 3 ? target : desc2 === null ? desc2 = Object.getOwnPropertyDescriptor(target, key) : desc2, d;
@@ -4899,48 +4961,32 @@ function _ts_metadata6(metadataKey, metadataValue) {
   }
 }
 __name(_ts_metadata6, "_ts_metadata");
-var CROUTON_SECURITY = "crouton:security";
-var CroutonSecurityGuard = class {
+var SecurityGuardRegistry = class {
   static {
-    __name(this, "CroutonSecurityGuard");
+    __name(this, "SecurityGuardRegistry");
   }
-  reflector;
-  registry;
-  moduleRef;
-  constructor(reflector, registry, moduleRef) {
-    this.reflector = reflector;
-    this.registry = registry;
-    this.moduleRef = moduleRef;
+  guards;
+  constructor(guards = {}) {
+    this.guards = guards;
   }
-  async canActivate(context) {
-    const sec = this.reflector.get(CROUTON_SECURITY, context.getHandler());
-    if (!sec || "public" in sec) return true;
-    const names = Array.isArray(sec.guard) ? sec.guard : [
-      sec.guard
-    ];
-    for (const name of names) {
-      const cls = this.registry.resolve(name);
-      const guard = this.moduleRef.get(cls, {
-        strict: false
-      });
-      const ok = await guard.canActivate(context);
-      if (!ok) return false;
-    }
-    return true;
+  resolve(name) {
+    const g = this.guards[name];
+    if (!g) throw new Error(`Unknown security guard "${name}". Register it in security.guards.`);
+    return g;
+  }
+  classes() {
+    return Object.values(this.guards);
   }
 };
-CroutonSecurityGuard = _ts_decorate6([
+SecurityGuardRegistry = _ts_decorate6([
   (0, import_common10.Injectable)(),
   _ts_metadata6("design:type", Function),
   _ts_metadata6("design:paramtypes", [
-    typeof Reflector === "undefined" ? Object : Reflector,
-    typeof SecurityGuardRegistry === "undefined" ? Object : SecurityGuardRegistry,
-    typeof ModuleRef === "undefined" ? Object : ModuleRef
+    typeof Record === "undefined" ? Object : Record
   ])
-], CroutonSecurityGuard);
+], SecurityGuardRegistry);
 
-// src/lib/crud/security/security-guard.registry.ts
-var import_common11 = require("@nestjs/common");
+// src/lib/crud/security/crouton-security.guard.ts
 function _ts_decorate7(decorators, target, key, desc2) {
   var c = arguments.length, r = c < 3 ? target : desc2 === null ? desc2 = Object.getOwnPropertyDescriptor(target, key) : desc2, d;
   if (typeof Reflect === "object" && typeof Reflect.decorate === "function") {
@@ -4961,30 +5007,45 @@ function _ts_metadata7(metadataKey, metadataValue) {
   }
 }
 __name(_ts_metadata7, "_ts_metadata");
-var SecurityGuardRegistry2 = class {
+var CROUTON_SECURITY = "crouton:security";
+var CroutonSecurityGuard = class {
   static {
-    __name(this, "SecurityGuardRegistry");
-  }
-  guards;
-  constructor(guards = {}) {
-    this.guards = guards;
+    __name(this, "CroutonSecurityGuard");
   }
-  resolve(name) {
-    const g = this.guards[name];
-    if (!g) throw new Error(`Unknown security guard "${name}". Register it in security.guards.`);
-    return g;
+  reflector;
+  registry;
+  moduleRef;
+  constructor(reflector, registry, moduleRef) {
+    this.reflector = reflector;
+    this.registry = registry;
+    this.moduleRef = moduleRef;
   }
-  classes() {
-    return Object.values(this.guards);
+  async canActivate(context) {
+    const sec = this.reflector.get(CROUTON_SECURITY, context.getHandler());
+    if (!sec || "public" in sec) return true;
+    const names = Array.isArray(sec.guard) ? sec.guard : [
+      sec.guard
+    ];
+    for (const name of names) {
+      const cls = this.registry.resolve(name);
+      const guard = this.moduleRef.get(cls, {
+        strict: false
+      });
+      const ok = await guard.canActivate(context);
+      if (!ok) return false;
+    }
+    return true;
   }
 };
-SecurityGuardRegistry2 = _ts_decorate7([
+CroutonSecurityGuard = _ts_decorate7([
   (0, import_common11.Injectable)(),
   _ts_metadata7("design:type", Function),
   _ts_metadata7("design:paramtypes", [
-    typeof Record === "undefined" ? Object : Record
+    typeof import_core.Reflector === "undefined" ? Object : import_core.Reflector,
+    typeof SecurityGuardRegistry === "undefined" ? Object : SecurityGuardRegistry,
+    typeof import_core.ModuleRef === "undefined" ? Object : import_core.ModuleRef
   ])
-], SecurityGuardRegistry2);
+], CroutonSecurityGuard);
 
 // src/lib/crud/operations/decorator.utils.ts
 var def = /* @__PURE__ */ __name((cls, method, fn) => {
@@ -5596,48 +5657,6 @@ var writeRawResourceJson = /* @__PURE__ */ __name((jsonPath, raw) => {
 
 // src/lib/crud/operations/payload-builders.ts
 var resolveEnvPlaceholders = /* @__PURE__ */ __name((value) => value.replace(/\{env\.([^}]+)\}/g, (match, varName) => process.env[varName] ?? match), "resolveEnvPlaceholders");
-var buildSubResourceOperations = /* @__PURE__ */ __name((ops, baseUri, idField = "id") => {
-  if (!ops) return {};
-  const idPlaceholder = `{${idField}}`;
-  return {
-    ...ops.findAll && {
-      findAll: {
-        uri: baseUri,
-        method: "get"
-      }
-    },
-    ...ops.findOne && {
-      findOne: {
-        uri: `${baseUri}/${idPlaceholder}`,
-        method: "get"
-      }
-    },
-    ...ops.create && {
-      create: {
-        uri: baseUri,
-        method: "post"
-      }
-    },
-    ...ops.update && {
-      update: {
-        uri: `${baseUri}/${idPlaceholder}`,
-        method: "put"
-      }
-    },
-    ...ops.patch && {
-      patch: {
-        uri: `${baseUri}/${idPlaceholder}`,
-        method: "patch"
-      }
-    },
-    ...ops.delete && {
-      delete: {
-        uri: `${baseUri}/${idPlaceholder}`,
-        method: "delete"
-      }
-    }
-  };
-}, "buildSubResourceOperations");
 var RESOURCE_OPS = [
   "findAll",
   "findOne",
@@ -6177,7 +6196,7 @@ var registerEndpoint = /* @__PURE__ */ __name((ctx, sub) => {
 }, "registerEndpoint");
 
 // src/lib/crud/crud-controller.factory.ts
-function createCrudController(config, baseUrl, moduleDefaultSecurity) {
+function createCrudController(config, baseUrl, moduleDefaultSecurity, securityEnabled = false) {
   const { route, name, tag, idType = "string" } = config;
   const definition = resolveDefinition(config);
   const listSchema = schemaFor(definition, "findAll");
@@ -6242,7 +6261,9 @@ function createCrudController(config, baseUrl, moduleDefaultSecurity) {
   };
   registerEndpoints(ctx);
   (0, import_common21.Controller)(resourceControllerPath(route, config.parent))(CrudControllerBase);
-  (0, import_common21.UseGuards)(CroutonSecurityGuard)(CrudControllerBase);
+  if (securityEnabled) {
+    (0, import_common21.UseGuards)(CroutonSecurityGuard)(CrudControllerBase);
+  }
   (0, import_swagger11.ApiTags)(tag)(CrudControllerBase);
   Object.defineProperty(CrudControllerBase, "name", {
     value: `${name.charAt(0).toUpperCase() + name.slice(1)}Controller`
@@ -7907,6 +7928,35 @@ var upsertOp = /* @__PURE__ */ __name((entry, schema) => {
   }
   return void 0;
 }, "upsertOp");
+var buildResourceDefinitions = /* @__PURE__ */ __name((schema, operations, enrichedColumns) => {
+  const picked = pickByColumns(schema, enrichedColumns);
+  const createSchema = pickByColumns(schema, enrichedColumns, (c) => !c.idField && c.createable !== false);
+  const updateSchema = pickByColumns(schema, enrichedColumns, (c) => !c.idField && c.updateable !== false);
+  const definition = {
+    ...opWithSchema(operations.findAll, picked) && {
+      findAll: opWithSchema(operations.findAll, picked)
+    },
+    ...opWithSchema(operations.findOne, picked) && {
+      findOne: opWithSchema(operations.findOne, picked)
+    },
+    ...opWithSchema(operations.create, createSchema) && {
+      create: opWithSchema(operations.create, createSchema)
+    },
+    ...opWithSchema(operations.update, updateSchema) && {
+      update: opWithSchema(operations.update, updateSchema)
+    },
+    ...upsertOp(operations.upsert, createSchema) && {
+      upsert: upsertOp(operations.upsert, createSchema)
+    },
+    ...operations.patch !== false && {
+      patch: true
+    },
+    ...operations.delete !== false && {
+      delete: true
+    }
+  };
+  return definition;
+}, "buildResourceDefinitions");
 
 // src/lib/crud/adapter/relation-type.ts
 var import_zod33 = require("zod");
@@ -8164,9 +8214,6 @@ var fromJson = /* @__PURE__ */ __name((json, schema, hooks, dirPath, baseUrl, ac
   const subResources = isCustom ? [] : buildSubResources(columns, json.route, json.model ?? "", dirPath, enums, baseUrl);
   const enrichedColumns = resolveColumnFieldVariants(enrichResourceRefColumns(enrichActionColumns(columns, json.route, subResources, baseUrl), dirPath, baseUrl) ?? columns);
   const calculatedColumns = json.calculatedColumns ?? [];
-  const picked = pickByColumns(schema, enrichedColumns);
-  const createSchema = pickByColumns(schema, enrichedColumns, (c) => !c.idField && c.createable !== false);
-  const updateSchema = pickByColumns(schema, enrichedColumns, (c) => !c.idField && c.updateable !== false);
   let views = isCustom ? buildViewsFromColumnTypes(enrichedColumns) : buildViews(schema, enrichedColumns);
   if (views && calculatedColumns.length) {
     views = {
@@ -8182,29 +8229,7 @@ var fromJson = /* @__PURE__ */ __name((json, schema, hooks, dirPath, baseUrl, ac
   }
   const lookup = buildLookup(enrichedColumns);
   const enrichedInclude = enrichIncludeWithSort(json.include, enrichedColumns);
-  const definition = {
-    ...opWithSchema(json.operations.findAll, picked) && {
-      findAll: opWithSchema(json.operations.findAll, picked)
-    },
-    ...opWithSchema(json.operations.findOne, picked) && {
-      findOne: opWithSchema(json.operations.findOne, picked)
-    },
-    ...opWithSchema(json.operations.create, createSchema) && {
-      create: opWithSchema(json.operations.create, createSchema)
-    },
-    ...opWithSchema(json.operations.update, updateSchema) && {
-      update: opWithSchema(json.operations.update, updateSchema)
-    },
-    ...upsertOp(json.operations.upsert, createSchema) && {
-      upsert: upsertOp(json.operations.upsert, createSchema)
-    },
-    ...json.operations.patch !== false && {
-      patch: true
-    },
-    ...json.operations.delete !== false && {
-      delete: true
-    }
-  };
+  const definition = buildResourceDefinitions(schema, json.operations, enrichedColumns);
   return {
     ...json,
     name: json.name,
@@ -8826,7 +8851,7 @@ var CroutonApiModule = class _CroutonApiModule {
   static forResources(configs, dataSources, loader, appConfig, config) {
     const { baseUrl, security } = appConfig;
     const dataSourceRegistry = new DataSourceRegistry(dataSources);
-    const guardRegistry = new SecurityGuardRegistry2(security?.guards ?? {});
+    const guardRegistry = new SecurityGuardRegistry(security?.guards ?? {});
     const moduleDefaultSecurity = security?.default;
     const startDir = typeof __dirname !== "undefined" ? __dirname : (0, import_node_path20.dirname)((0, import_node_url2.fileURLToPath)(importMetaUrl));
     const enumRegistry = loadEnumRegistry(startDir, config.enumsFile);
@@ -8885,7 +8910,7 @@ var CroutonApiModule = class _CroutonApiModule {
       configRegistry.setTranslationRegistry(translationRegistry);
     }
     const controllers = [
-      ...validConfigs.map((c) => createCrudController(c, baseUrl, moduleDefaultSecurity)),
+      ...validConfigs.map((c) => createCrudController(c, baseUrl, moduleDefaultSecurity, !!security)),
       createAppLayoutController(configs, config.sidebarGroups, config.title, config.autoSave ?? true, translationRegistry, config.i18n),
       // Only registered (and thus only visible in Swagger/routing) when the
       // visual resource builder is enabled — see dev-resources.controller.ts.
@@ -8899,7 +8924,7 @@ var CroutonApiModule = class _CroutonApiModule {
       controllers,
       providers: [
         {
-          provide: import_core.APP_FILTER,
+          provide: import_core2.APP_FILTER,
           useClass: CroutonValidationExceptionFilter
         },
         {
@@ -8910,19 +8935,23 @@ var CroutonApiModule = class _CroutonApiModule {
           provide: ResourceConfigRegistry,
           useValue: configRegistry
         },
-        {
-          provide: SecurityGuardRegistry2,
-          useValue: guardRegistry
-        },
-        CroutonSecurityGuard,
-        ...guardRegistry.classes(),
+        // Security providers only registered when security is configured;
+        // without guards the dispatching guard is never applied (see factory).
+        ...security ? [
+          {
+            provide: SecurityGuardRegistry,
+            useValue: guardRegistry
+          },
+          CroutonSecurityGuard,
+          ...guardRegistry.classes()
+        ] : [],
         ...translationRegistry ? [
           {
             provide: TranslationRegistry2,
             useValue: translationRegistry
           },
           {
-            provide: import_core.APP_INTERCEPTOR,
+            provide: import_core2.APP_INTERCEPTOR,
             useFactory: /* @__PURE__ */ __name(() => new LanguageInterceptor(translationRegistry), "useFactory")
           }
         ] : []