@ghentcdh/create-crouton 0.0.1-alpha.39 → 0.0.1-alpha.44

package/dist/index.js

@@ -18854,25 +18854,38 @@ var transformDataSource = (data) => {
 };
 var DataSourceSchema = DataSourceShape.transform(transformDataSource);
 
+// ../crouton-core/src/lib/data-source/Security.schema.ts
+var SecuritySchema = external_exports.union([
+  external_exports.object({ public: external_exports.literal(true) }),
+  external_exports.object({ guard: external_exports.union([external_exports.string(), external_exports.array(external_exports.string()).min(1)]) })
+]);
+
 // ../crouton-core/src/lib/data-source/Operations.schema.ts
+var OpEntry = external_exports.union([
+  external_exports.boolean(),
+  external_exports.object({ security: SecuritySchema.optional() })
+]);
 var BoolOrUpsertSchema = external_exports.union([
   external_exports.boolean(),
-  external_exports.object({ upsertOn: external_exports.union([external_exports.string(), external_exports.array(external_exports.string())]) })
+  external_exports.object({
+    upsertOn: external_exports.union([external_exports.string(), external_exports.array(external_exports.string())]),
+    security: SecuritySchema.optional()
+  })
 ]);
 var JsonOperationsSchema = external_exports.object({
-  findAll: external_exports.boolean().default(true),
+  findAll: OpEntry.default(true),
   // default: true — only explicit `false` disables it
-  findOne: external_exports.boolean().default(true),
+  findOne: OpEntry.default(true),
   // default: true
-  create: external_exports.boolean().default(true),
+  create: OpEntry.default(true),
   // default: true
-  update: external_exports.boolean().default(true),
+  update: OpEntry.default(true),
   // default: true
-  patch: external_exports.boolean().default(true),
+  patch: OpEntry.default(true),
   // default: true
   upsert: BoolOrUpsertSchema.default(false),
   // default: disabled; `true` throws at load time — must be `{ upsertOn }`
-  delete: external_exports.boolean().default(true)
+  delete: OpEntry.default(true)
   // default: true
 });
 
@@ -19002,6 +19015,57 @@ var CalculatedColumnSchema = external_exports.object({
   fieldInput: FieldInputSchema.optional()
 }).transform(normalizeLabel);
 
+// ../crouton-core/src/lib/resource/ColumnType.schema.ts
+var ColumnTypeShorthandSchema = external_exports.enum([
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "date",
+  "date-time",
+  "object",
+  "array"
+]);
+var JsonSchemaFragmentSchema = external_exports.lazy(
+  () => external_exports.object({
+    type: external_exports.union([external_exports.string(), external_exports.array(external_exports.string())]).optional(),
+    format: external_exports.string().optional(),
+    enum: external_exports.array(external_exports.unknown()).optional(),
+    const: external_exports.unknown().optional(),
+    nullable: external_exports.boolean().optional(),
+    properties: external_exports.record(external_exports.string(), JsonSchemaFragmentSchema).optional(),
+    required: external_exports.array(external_exports.string()).optional(),
+    items: JsonSchemaFragmentSchema.optional(),
+    additionalProperties: external_exports.union([external_exports.boolean(), JsonSchemaFragmentSchema]).optional(),
+    title: external_exports.string().optional(),
+    description: external_exports.string().optional(),
+    default: external_exports.unknown().optional(),
+    minimum: external_exports.number().optional(),
+    maximum: external_exports.number().optional(),
+    minLength: external_exports.number().optional(),
+    maxLength: external_exports.number().optional(),
+    pattern: external_exports.string().optional()
+  }).catchall(external_exports.unknown())
+);
+var ColumnTypeSchema = external_exports.union([
+  ColumnTypeShorthandSchema,
+  JsonSchemaFragmentSchema
+]);
+var SHORTHAND_FRAGMENTS = {
+  string: { type: "string" },
+  number: { type: "number" },
+  integer: { type: "integer" },
+  boolean: { type: "boolean" },
+  date: { type: "string", format: "date" },
+  "date-time": { type: "string", format: "date-time" },
+  object: { type: "object" },
+  array: { type: "array" }
+};
+var NESTED_SHORTHANDS = {
+  date: SHORTHAND_FRAGMENTS.date,
+  "date-time": SHORTHAND_FRAGMENTS["date-time"]
+};
+
 // ../crouton-core/src/lib/resource/Column.ts
 var WhenConditionSchema = external_exports.object({
   field: external_exports.string(),
@@ -19056,6 +19120,41 @@ var JsonColumnSchema = external_exports.object({
   // default: false — exactly one column should set this
   showInLookup: external_exports.boolean().default(false),
   // default: false
+  /**
+   * Data type of the column, as a shorthand name (`"string"`, `"integer"`, …)
+   * or a full JSON Schema fragment:
+   *
+   * ```json
+   * "type": {
+   *   "type": "object",
+   *   "properties": { "id": { "type": "string" }, "name": { "type": "string" } }
+   * }
+   * ```
+   *
+   * Required on every column of a `kind: "custom"` resource, where it is the
+   * only source of the resource's json_schema. Optional on a `prisma`
+   * resource, whose schema is derived from the Zod model.
+   */
+  type: ColumnTypeSchema.optional(),
+  /**
+   * Whether the form requires a value.
+   *
+   * A prisma resource derives `required` from its Zod model, so this is an
+   * override in either direction: `true` adds the column to the form schema's
+   * `required` array, `false` removes it, and omitting it leaves the model's
+   * answer alone. A `kind: "custom"` resource has no model, so this is the only
+   * way to mark one of its fields required.
+   *
+   * Applies to the **form** view only — a required filter input would make the
+   * filter panel unsubmittable, and the table and view schemas are read-only.
+   * Ignored on the id column and on columns that are neither createable nor
+   * updateable, since the form cannot supply a value for those.
+   */
+  required: external_exports.boolean().optional(),
+  /**
+   * @deprecated Use `type` instead. Retained because it is still consumed by
+   * the boolean predicate and the schema-less sub-resource view builder.
+   */
   columnType: external_exports.string().default("string"),
   // default: 'string'
   fieldInput: FieldInputSchema.optional(),
@@ -19092,6 +19191,22 @@ var JsonColumnSchema = external_exports.object({
   // per-sub-column overrides, only used with `extend`
 });
 
+// ../crouton-core/src/lib/resource/ParentRef.schema.ts
+var ParentRefSchema = external_exports.object({
+  /** Route segment of the parent, e.g. `"group"`. */
+  route: external_exports.string(),
+  /**
+   * Name of the path parameter carrying the parent id, e.g. `"groupId"`.
+   * Avoid `"id"` — that is the child's own id in `/:id` routes.
+   */
+  param: external_exports.string().default("parentId"),
+  /** Type of the parent id, used to coerce the path param. Defaults to `'string'`. */
+  idType: external_exports.enum(["string", "number"]).optional()
+});
+
+// ../crouton-core/src/lib/resource/ResourceKind.ts
+var ResourceKindSchema = external_exports.enum(["prisma", "custom"]).default("prisma");
+
 // ../crouton-core/src/lib/resource/Sidebar.schema.ts
 var SidebarGroupSchema = zod_default.object({
   /** Human-readable heading shown in the sidebar. Defaults to a title-cased version of the slug. */
@@ -19234,24 +19349,46 @@ var ResourceJsonShape = external_exports.object({
   schemaVersion: external_exports.number().int().positive().optional(),
   /** When `true`, the resource lives in the repo but is NOT loaded/served (work in progress). */
   draft: external_exports.boolean().optional().default(false),
+  /**
+   * Where the data comes from. `prisma` (the default) is backed by a Prisma
+   * model plus a `schema.ts`; `custom` is configuration only and the developer
+   * supplies a `repository.ts`. See `./ResourceKind`.
+   */
+  kind: ResourceKindSchema,
   name: external_exports.string(),
   // required — unique id, used as the frontend form id
   route: external_exports.string(),
   // required — URL segment for generated endpoints
-  model: external_exports.string(),
-  // required — Prisma model name
+  /**
+   * 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: external_exports.string().optional(),
   tag: external_exports.string(),
   // required — OpenAPI tag
   title: external_exports.string().optional(),
   // no computed default — used as UI display title
   table: external_exports.string().optional(),
   // default: same as `model`
+  /**
+   * Type of the resource's primary key, used to coerce `:id` route params.
+   * Written by codegen from the Prisma model; defaults to `'string'`.
+   */
+  idType: external_exports.enum(["string", "number"]).optional(),
   database: external_exports.string().optional(),
   // default: project's default data source
+  /**
+   * Mount this resource under a parent route instead of at the top level —
+   * see `./ParentRef.schema`. Only valid on a `kind: "custom"` resource.
+   */
+  parent: ParentRefSchema.optional(),
   sidebar: SidebarSchema.default(SidebarSchema.parse({})),
   // default: shown, alphabetically ordered, ungrouped
   display: JsonDisplaySchema.default(JsonDisplaySchema.parse({})),
   // 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({})),
@@ -19272,7 +19409,58 @@ var ResourceJsonShape = external_exports.object({
    */
   include: external_exports.array(JsonIncludeEntrySchema).default([])
 });
-var ResourceJsonSchema = ResourceJsonShape.transform((obj) => {
+var refineByKind = (obj, ctx) => {
+  if (obj.kind === "custom") {
+    if (obj.model !== void 0) {
+      ctx.addIssue({
+        code: "custom",
+        path: ["model"],
+        message: 'A custom resource has no Prisma model. Remove "model" \u2014 data access comes from repository.ts.'
+      });
+    }
+    if (obj.calculatedColumns?.length) {
+      ctx.addIssue({
+        code: "custom",
+        path: ["calculatedColumns"],
+        message: "calculatedColumns run raw SQL against a database table and are not supported on a custom resource. Compute the value in repository.ts instead."
+      });
+    }
+    for (const [id, col] of Object.entries(obj.columns ?? {})) {
+      if (col.fieldInput?.format === "relation" || col.fieldInput?.type === "autocomplete") {
+        continue;
+      }
+      if (col.type === void 0) {
+        ctx.addIssue({
+          code: "custom",
+          path: ["columns", id, "type"],
+          message: `Column "${id}" needs a "type": a custom resource has no schema.ts, so its json_schema is built from the column types.`
+        });
+      }
+    }
+    if (obj.parent && obj.parent.param === "id") {
+      ctx.addIssue({
+        code: "custom",
+        path: ["parent", "param"],
+        message: `parent.param cannot be "id" \u2014 that is the child's own id in /:id routes. Use something like "groupId".`
+      });
+    }
+  } else if (obj.parent !== void 0) {
+    ctx.addIssue({
+      code: "custom",
+      path: ["parent"],
+      message: '"parent" is only supported on a custom resource. A prisma resource is nested by declaring a relation column on its parent.'
+    });
+  } else if (obj.model === void 0) {
+    ctx.addIssue({
+      code: "custom",
+      path: ["model"],
+      message: '"model" is required for a prisma-backed resource. Set "kind": "custom" for a resource with no Prisma model.'
+    });
+  }
+};
+var ResourceJsonSchema = ResourceJsonShape.superRefine(
+  refineByKind
+).transform((obj) => {
   const title = obj.title ?? labelFromId(obj.name);
   const schemaVersion = obj.schemaVersion ?? BASELINE_RESOURCE_VERSION;
   return {
@@ -19290,7 +19478,7 @@ var RulesetSchema = external_exports.object({
   hideIdInView: external_exports.boolean().default(true),
   hideTimestamps: external_exports.boolean().default(true),
   hideForeignKeys: external_exports.boolean().default(true),
-  includeRelations: external_exports.boolean().default(false),
+  includeRelations: external_exports.boolean().default(true),
   hideRelationsInTable: external_exports.boolean().default(true),
   showRelationsInForm: external_exports.boolean().default(true),
   enumValueLabel: external_exports.boolean().default(true),
@@ -19299,6 +19487,14 @@ var RulesetSchema = external_exports.object({
     JsonOperationsSchema.parse({})
   )
 });
+var I18nConfigSchema = external_exports.object({
+  /** Default / fallback language. */
+  defaultLanguage: external_exports.string().default("en"),
+  /** All supported language codes. */
+  languages: external_exports.array(external_exports.string()).min(1),
+  /** Directory containing `<lang>.json` bundles, relative to project root. */
+  translationsDir: external_exports.string().default("translations")
+});
 var CroutonConfigSchema = external_exports.object({
   /**
    * Application title served to the frontend via `GET /_app/layout`.
@@ -19328,7 +19524,9 @@ var CroutonConfigSchema = external_exports.object({
    * Whether form fields are saved automatically as the user edits them.
    * @default true
    */
-  autoSave: external_exports.boolean().default(true)
+  autoSave: external_exports.boolean().default(true),
+  /** Optional i18n / translation configuration. */
+  i18n: I18nConfigSchema.optional()
 });
 
 // ../crouton-core/src/lib/view/view.schema.ts
@@ -19346,6 +19544,36 @@ var ViewConfigSchema = external_exports.object({
   defaultSort: external_exports.string().optional()
 });
 
+// ../crouton-core/src/lib/i18n/Translations.schema.ts
+var NestedStringRecord = external_exports.lazy(
+  () => external_exports.record(external_exports.string(), external_exports.union([external_exports.string(), NestedStringRecord]))
+);
+var TranslationBundleSchema = external_exports.object({
+  app: external_exports.object({
+    title: external_exports.string().optional()
+  }).optional(),
+  sidebarGroups: external_exports.record(external_exports.string(), external_exports.string()).optional(),
+  resources: external_exports.record(
+    external_exports.string(),
+    external_exports.object({
+      title: external_exports.string().optional(),
+      sidebar: external_exports.string().optional(),
+      columns: external_exports.record(external_exports.string(), external_exports.string()).optional(),
+      actions: external_exports.record(external_exports.string(), external_exports.string()).optional(),
+      subResources: external_exports.record(
+        external_exports.string(),
+        external_exports.object({
+          title: external_exports.string().optional(),
+          columns: external_exports.record(external_exports.string(), external_exports.string()).optional()
+        }).optional()
+      ).optional()
+    }).optional()
+  ).optional(),
+  enums: external_exports.record(external_exports.string(), external_exports.record(external_exports.string(), external_exports.string())).optional(),
+  ui: NestedStringRecord.optional(),
+  validation: external_exports.record(external_exports.string(), external_exports.string()).optional()
+}).passthrough();
+
 // ../crouton-codegen/src/util.ts
 import { access } from "fs/promises";
 
@@ -19603,21 +19831,30 @@ var runCreate = async (name, opts) => {
       M2.info(`Using pnpm ${pnpmVersion}`);
     }
     const dbUrl = await resolveDbUrl(opts);
+    const postgres = opts.docker !== false ? await resolvePostgres(opts) : false;
     const dbName = name.replace(/[^a-zA-Z0-9]/g, "_");
+    const appName = prefix || name;
     const tokens = {
       name,
       Name: toTitle(name),
-      version: true ? "0.0.1-alpha.39" : "latest",
+      version: true ? "0.0.1-alpha.44" : "latest",
       year: String((/* @__PURE__ */ new Date()).getFullYear()),
       pmRun: pm === "npm" ? "npm run" : pm,
       urlEnv: "DATABASE_URL",
       dbUrl: dbUrl || `postgresql://crouton:crouton@localhost:5432/${dbName}?schema=public`,
-      dbName
+      dbName,
+      appName,
+      frontendPort: "4200",
+      backendPort: "3000"
     };
     if (layout === "nx") {
       tokens["nx"] = "true";
-      tokens["backendApp"] = "backend";
-      tokens["frontendApp"] = "frontend";
+      tokens["backendApp"] = `${appName}-backend`;
+      tokens["frontendApp"] = `${appName}-frontend`;
+      tokens["workspaceRoot"] = prefix || ".";
+      tokens["dockerfileDev"] = prefix ? `${prefix}/Dockerfile.dev` : "Dockerfile.dev";
+      tokens["envFile"] = prefix ? `${prefix}/.env` : ".env";
+      tokens["generatedGlob"] = prefix ? `${prefix}/generated/default` : "generated/default";
       if (prefix) {
         tokens["prefix"] = prefix;
         tokens["appsRoot"] = `${prefix}/apps`;
@@ -19633,10 +19870,23 @@ var runCreate = async (name, opts) => {
         tokens["generatedTypesPath"] = "generated/default/types/src";
         tokens["generatedClientPath"] = "generated/default/client";
       }
+    } else {
+      tokens["regular"] = "true";
+      tokens["dockerfileDev"] = "Dockerfile.dev";
+      tokens["envFile"] = ".env";
     }
     if (frontend) {
       tokens["frontend"] = "true";
     }
+    if (layout === "nx" && frontend) {
+      tokens["nxFrontend"] = "true";
+    }
+    if (layout === "nx" && !frontend) {
+      tokens["nxBackendOnly"] = "true";
+    }
+    if (postgres) {
+      tokens["postgres"] = "true";
+    }
     const templateRoot = resolveTemplateDir();
     const skipPaths = !frontend ? ["apps/frontend"] : [];
     if (layout === "nx") {
@@ -19659,12 +19909,12 @@ var runCreate = async (name, opts) => {
       );
       files.push(...workspaceFiles);
       if (opts.docker !== false) {
-        const dockerDir = resolve2(templateRoot, "docker");
-        const dockerFiles = await loadAndRenderTemplates(
-          dockerDir,
-          "",
+        const dockerFiles = await renderDockerTemplates(
+          templateRoot,
           tokens,
-          targetDir
+          targetDir,
+          workspaceTarget,
+          { postgres }
         );
         files.push(...dockerFiles);
       }
@@ -19701,13 +19951,12 @@ var runCreate = async (name, opts) => {
         skipPaths
       );
       if (opts.docker !== false) {
-        const dockerTokens = { ...tokens, regular: "true" };
-        const dockerDir = resolve2(templateRoot, "docker");
-        const dockerFiles = await loadAndRenderTemplates(
-          dockerDir,
-          "",
-          dockerTokens,
-          targetDir
+        const dockerFiles = await renderDockerTemplates(
+          templateRoot,
+          tokens,
+          targetDir,
+          targetDir,
+          { postgres }
         );
         files.push(...dockerFiles);
       }
@@ -19736,7 +19985,7 @@ var runCreate = async (name, opts) => {
     const prefixFlag = prefix ? ` --prefix ${prefix}` : "";
     Me(
       [
-        opts.docker !== false ? "docker compose up -d          # start postgres" : null,
+        opts.docker !== false && postgres ? "docker compose up -d          # start postgres" : null,
         `${pmRun} prisma:migrate          # create initial migration`,
         `crouton update resources${prefixFlag}        # generate resource CRUD`,
         `${pmRun} dev                     # start dev server`
@@ -19752,6 +20001,78 @@ var runCreate = async (name, opts) => {
     throw err;
   }
 };
+var renderDockerTemplates = async (templateRoot, tokens, targetDir, workspaceTarget, opts) => {
+  const dockerDir = resolve2(templateRoot, "docker");
+  const files = [];
+  const composeYml = render(
+    await loadTemplate(dockerDir, "compose.yml.tmpl"),
+    tokens
+  );
+  files.push({ path: resolve2(targetDir, "compose.yml"), contents: composeYml });
+  const composeApp = render(
+    await loadTemplate(dockerDir, "compose.app.tmpl"),
+    tokens
+  );
+  files.push({
+    path: resolve2(targetDir, `compose.app.${tokens["appName"]}.yml`),
+    contents: composeApp
+  });
+  if (opts.postgres) {
+    const composeInfra = render(
+      await loadTemplate(dockerDir, "compose.infra.yml.tmpl"),
+      tokens
+    );
+    files.push({
+      path: resolve2(targetDir, "compose.infra.yml"),
+      contents: composeInfra
+    });
+    const envInfra = render(
+      await loadTemplate(dockerDir, ".env.infra.tmpl"),
+      tokens
+    );
+    files.push({
+      path: resolve2(targetDir, ".env.infra"),
+      contents: envInfra
+    });
+    const envInfraExample = render(
+      await loadTemplate(dockerDir, ".env.infra.example.tmpl"),
+      tokens
+    );
+    files.push({
+      path: resolve2(targetDir, ".env.infra.example"),
+      contents: envInfraExample
+    });
+    files.push({
+      path: resolve2(targetDir, "docker/init-data/.gitkeep"),
+      contents: ""
+    });
+  }
+  const dockerfileDev = render(
+    await loadTemplate(dockerDir, "Dockerfile.dev.tmpl"),
+    tokens
+  );
+  files.push({
+    path: resolve2(workspaceTarget, "Dockerfile.dev"),
+    contents: dockerfileDev
+  });
+  const dockerfileProd = render(
+    await loadTemplate(dockerDir, "Dockerfile.prod.tmpl"),
+    tokens
+  );
+  files.push({
+    path: resolve2(workspaceTarget, "Dockerfile.prod"),
+    contents: dockerfileProd
+  });
+  const dockerignore = render(
+    await loadTemplate(dockerDir, ".dockerignore.tmpl"),
+    tokens
+  );
+  files.push({
+    path: resolve2(targetDir, ".dockerignore"),
+    contents: dockerignore
+  });
+  return files;
+};
 var postScaffold = async (opts, targetDir, pm, dbUrl, prefix) => {
   if (opts.git !== false) {
     const s = Y2();
@@ -19864,6 +20185,16 @@ var resolveDbUrl = async (opts) => {
   );
   return url2.trim();
 };
+var resolvePostgres = async (opts) => {
+  if (opts.yes) return opts.postgres;
+  if (!opts.postgres) return false;
+  return assertNotCancel(
+    await ye({
+      message: "Run PostgreSQL in Docker?",
+      initialValue: true
+    })
+  );
+};
 var loadAndRenderTemplates = async (templateDir, subPath, tokens, targetDir, skipPaths = []) => {
   const files = [];
   const dir = subPath ? resolve2(templateDir, subPath) : templateDir;
@@ -19892,7 +20223,7 @@ var loadAndRenderTemplates = async (templateDir, subPath, tokens, targetDir, ski
 };
 
 // src/index.ts
-var program2 = new Command("create-crouton").description("Scaffold a new crouton project").version("0.0.1").argument("[name]", "project name", "my-crouton-app").option("--nx", "use Nx monorepo layout").option("--no-nx", "use regular (non-Nx) layout").option("--no-frontend", "skip frontend app generation").option("--sample", "include sample resource").option("--pm <manager>", "package manager (pnpm | npm | yarn | bun)").option("--no-install", "skip dependency installation").option("--no-git", "skip git init").option("--prefix <name>", "nest apps/config under a subfolder (Nx only)").option("--no-docker", "skip Docker file generation").option("-y, --yes", "accept all defaults (non-interactive)").option("--force", "overwrite existing files").option("--db-url <url>", "database connection URL (e.g. postgresql://user:pass@localhost:5432/db)").action(async (name, opts) => {
+var program2 = new Command("create-crouton").description("Scaffold a new crouton project").version("0.0.1").argument("[name]", "project name", "my-crouton-app").option("--nx", "use Nx monorepo layout").option("--no-nx", "use regular (non-Nx) layout").option("--no-frontend", "skip frontend app generation").option("--sample", "include sample resource").option("--pm <manager>", "package manager (pnpm | npm | yarn | bun)").option("--no-install", "skip dependency installation").option("--no-git", "skip git init").option("--prefix <name>", "nest apps/config under a subfolder (Nx only)").option("--no-docker", "skip Docker file generation").option("--no-postgres", "skip PostgreSQL in Docker (use external DB)").option("-y, --yes", "accept all defaults (non-interactive)").option("--force", "overwrite existing files").option("--db-url <url>", "database connection URL (e.g. postgresql://user:pass@localhost:5432/db)").action(async (name, opts) => {
   try {
     await runCreate(name, opts);
   } catch (err) {