@cedarjs/cli 9.0.0-canary.1784 → 9.0.0-canary.3124

package/dist/commands/generate/scaffold/scaffoldHandler.js

@@ -2,22 +2,25 @@ import fs from "node:fs";
 import path from "path";
 import camelcase from "camelcase";
 import { paramCase } from "change-case";
-import execa from "execa";
 import humanize from "humanize-string";
 import { Listr } from "listr2";
 import pascalcase from "pascalcase";
-import { recordTelemetryAttributes } from "@cedarjs/cli-helpers";
+import { colors as c } from "@cedarjs/cli-helpers/colors";
+import { formatCedarCommand } from "@cedarjs/cli-helpers/packageManager/display";
+import {
+  addWorkspacePackages,
+  removeWorkspacePackages
+} from "@cedarjs/cli-helpers/packageManager/packages";
+import { recordTelemetryAttributes } from "@cedarjs/cli-helpers/telemetry";
 import { generate as generateTypes } from "@cedarjs/internal/dist/generate/generate";
 import { getConfig } from "@cedarjs/project-config";
-import { pluralize, singularize } from "../../../lib/cedarPluralize.js";
-import c from "../../../lib/colors.js";
+import { pluralize, singularize } from "@cedarjs/utils/cedarPluralize";
 import {
   generateTemplate,
   readFile,
   writeFile,
   getDefaultArgs,
   getPaths,
-  writeFilesTask,
   addRoutesToRouterTask,
   addScaffoldImport,
   transformTSToJS,
@@ -29,17 +32,28 @@ import {
 } from "../../../lib/rollback.js";
 import { getSchema, verifyModelName } from "../../../lib/schemaHelpers.js";
 import {
+  redactedModelFields,
   relationsForModel,
   intForeignKeysForModel,
   mapPrismaScalarToPagePropTsType
 } from "../helpers.js";
 import { builder as sdlBuilder } from "../sdl/sdl.js";
-import { files as sdlFiles } from "../sdl/sdlHandler.js";
+import {
+  files as sdlFiles,
+  stubFiles as sdlStubFiles,
+  printRedactedFieldsNote,
+  redactedSensitiveFields
+} from "../sdl/sdlHandler.js";
+import {
+  missingRelatedModels,
+  writeFilesWithStubsTask
+} from "../sdl/stubFiles.js";
 import { builder as serviceBuilder } from "../service/service.js";
 import { files as serviceFiles } from "../service/serviceHandler.js";
 import { customOrDefaultTemplatePath } from "../yargsHandlerHelpers.js";
 const SKIPPABLE_ASSETS = ["scaffold.css"];
 const PACKAGE_SET = "Set";
+const PACKAGE_PRIVATE_SET = "PrivateSet";
 const getIdType = (model) => {
   return model.fields.find((field) => field.isId)?.type;
 };
@@ -48,7 +62,7 @@ const getIdName = (model) => {
 };
 const isAutoGeneratedColumnForScaffold = (column) => {
   const autoGeneratedFunctions = ["now", "autoincrement"];
-  const columnDefaultFunction = typeof column.default === "object" && "name" in column.default ? column.default?.name : "";
+  const columnDefaultFunction = typeof column.default === "object" && column.default !== null && "name" in column.default ? column.default.name : "";
   return column.isId || column.isUpdatedAt || column.name === "createdAt" || autoGeneratedFunctions.includes(columnDefaultFunction);
 };
 const getImportComponentNames = (name, scaffoldPath, nestScaffoldByModel = true) => {
@@ -147,7 +161,7 @@ const files = async ({
   };
 };
 const assetFiles = async (name, tailwind) => {
-  let fileList = {};
+  const fileList = {};
   const assets = fs.readdirSync(
     customOrDefaultTemplatePath({
       side: "web",
@@ -269,17 +283,22 @@ const modelRelatedVariables = (model) => {
       listDisplayFunction: "truncate"
     }
   };
-  const relations = relationsForModel(model).map((relation) => relation);
-  const columns = model.fields.filter((field) => field.kind !== "object").map((column) => {
+  const relations = relationsForModel(model)?.map((relation) => relation);
+  const redactedFields = redactedModelFields(
+    model.fields.map((field) => field.name)
+  );
+  const columns = model.fields.filter((field) => field.kind !== "object").filter((field) => !redactedFields.includes(field.name)).map((column) => {
     let validation;
-    if (componentMetadata[column.type]?.validation) {
-      validation = componentMetadata[column.type]?.validation(
-        column?.isRequired
-      );
+    const meta = componentMetadata[column.type];
+    const validationDef = meta?.validation;
+    if (typeof validationDef === "function") {
+      validation = validationDef(column.isRequired);
+    } else if (validationDef !== void 0) {
+      validation = column.isRequired ? validationDef : null;
     } else {
-      validation = column?.isRequired ? componentMetadata.default.validation : null;
+      validation = column.isRequired ? componentMetadata.default.validation : null;
     }
-    const isRelationalField = column.name.endsWith("Id") && relations.some((relation) => column.name.includes(relation));
+    const isRelationalField = column.name.endsWith("Id") && relations?.some((relation) => column.name.includes(relation));
     const isRequired = column.isRequired;
     const isEnum = column.kind === "enum";
     const isList = column.isList;
@@ -306,7 +325,9 @@ const modelRelatedVariables = (model) => {
   );
   const fieldsToImport = Object.keys(
     editableColumns.reduce((accumulator, column) => {
-      accumulator[column.component] = true;
+      if (column.component) {
+        accumulator[column.component] = true;
+      }
       return accumulator;
     }, {})
   );
@@ -324,7 +345,7 @@ const modelRelatedVariables = (model) => {
   };
 };
 const layoutFiles = async (name, force, generateTypescript, templateStrings) => {
-  let fileList = {};
+  const fileList = {};
   const layouts = fs.readdirSync(
     customOrDefaultTemplatePath({
       side: "web",
@@ -367,7 +388,7 @@ const pageFiles = async (name, pascalScaffoldPath = "", generateTypescript, nest
   const idType = getIdType(model);
   const idTsType = mapPrismaScalarToPagePropTsType(idType);
   const idName = getIdName(model);
-  let fileList = {};
+  const fileList = {};
   const pages = fs.readdirSync(
     customOrDefaultTemplatePath({
       side: "web",
@@ -409,9 +430,9 @@ const componentFiles = async (name, pascalScaffoldPath = "", generateTypescript,
   const model = await getSchema(singularName);
   const idType = getIdType(model);
   const idName = getIdName(model);
-  const pascalIdName = pascalcase(idName);
+  const pascalIdName = pascalcase(idName ?? "");
   const intForeignKeys = intForeignKeysForModel(model);
-  let fileList = {};
+  const fileList = {};
   const components = fs.readdirSync(
     customOrDefaultTemplatePath({
       side: "web",
@@ -501,45 +522,110 @@ const addHelperPackages = async (task) => {
   if (packageJson.default.dependencies["humanize-string"]) {
     return task.skip("Skipping. Already installed");
   }
-  await execa("yarn", ["workspace", "web", "add", "humanize-string@2.1.0"]);
+  await addWorkspacePackages("web", ["humanize-string@2.1.0"]);
   addFunctionToRollback(async () => {
-    await execa("yarn", ["workspace", "web", "remove", "humanize-string"]);
+    await removeWorkspacePackages("web", ["humanize-string"]);
   });
 };
+const isAuthSetup = () => {
+  const extensions = ["ts", "js", "tsx", "jsx"];
+  return extensions.some(
+    (ext) => fs.existsSync(path.join(getPaths().web.src, "auth." + ext))
+  );
+};
+const ROUTE_TAG_RE = /<Route\s+([^>]*?)\/?>/g;
+const extractRouteAttr = (tagAttrs, attrName) => tagAttrs.match(new RegExp(`\\b${attrName}=["']([^"']+)["']`))?.[1];
+const getRoutesFileContent = () => {
+  const routesPath = getPaths().web.routes;
+  if (!fs.existsSync(routesPath)) {
+    return void 0;
+  }
+  return readFile(routesPath).toString();
+};
+const hasLoginRoute = () => {
+  const content = getRoutesFileContent();
+  if (!content) {
+    return false;
+  }
+  return Array.from(content.matchAll(ROUTE_TAG_RE)).some(
+    ([, attrs]) => extractRouteAttr(attrs, "name") === "login"
+  );
+};
+const findUnprotectedLandingPageRouteName = () => {
+  const content = getRoutesFileContent();
+  if (!content) {
+    return void 0;
+  }
+  const privateSetRanges = Array.from(
+    content.matchAll(/<PrivateSet\b[^>]*>([\s\S]*?)<\/PrivateSet>/g)
+  ).map((match) => ({
+    start: match.index ?? 0,
+    end: (match.index ?? 0) + match[0].length
+  }));
+  for (const match of content.matchAll(ROUTE_TAG_RE)) {
+    const [, attrs] = match;
+    if (extractRouteAttr(attrs, "path") !== "/") {
+      continue;
+    }
+    const tagStart = match.index ?? 0;
+    const isProtected = privateSetRanges.some(
+      (range) => tagStart >= range.start && tagStart < range.end
+    );
+    if (!isProtected) {
+      return extractRouteAttr(attrs, "name");
+    }
+  }
+  return void 0;
+};
+const getUnauthenticatedRedirectRoute = () => {
+  if (!isAuthSetup()) {
+    return void 0;
+  }
+  if (hasLoginRoute()) {
+    return "login";
+  }
+  return findUnprotectedLandingPageRouteName();
+};
 const addSetImport = (task) => {
   const routesPath = getPaths().web.routes;
   const routesContent = readFile(routesPath).toString();
-  const [redwoodRouterImport, importStart, spacing, importContent, importEnd] = routesContent.match(
+  const [cedarRouterImport, importStart, spacing, importContent, importEnd] = routesContent.match(
     /(import {)(\s*)([^]*)(} from ['"]@cedarjs\/router['"])/
   ) || [];
-  if (!redwoodRouterImport) {
+  if (!cedarRouterImport) {
     task.skip(
       "Couldn't add Set import from @cedarjs/router to Routes.{jsx,tsx}"
     );
     return void 0;
   }
   const routerImports = importContent.replace(/\s/g, "").split(",");
-  if (routerImports.includes(PACKAGE_SET)) {
+  const namesToImport = [
+    PACKAGE_SET,
+    ...getUnauthenticatedRedirectRoute() ? [PACKAGE_PRIVATE_SET] : []
+  ].filter((name) => !routerImports.includes(name));
+  if (!namesToImport.length) {
     return "Skipping Set import";
   }
   const newRoutesContent = routesContent.replace(
-    redwoodRouterImport,
-    importStart + spacing + PACKAGE_SET + `,` + spacing + importContent + importEnd
+    cedarRouterImport,
+    importStart + spacing + namesToImport.join("," + spacing) + `,` + spacing + importContent + importEnd
   );
   writeFile(routesPath, newRoutesContent, { overwriteExisting: true });
-  return "Added Set import to Routes.{jsx,tsx}";
+  return `Added ${namesToImport.join(", ")} import to Routes.{jsx,tsx}`;
 };
-const addScaffoldSetToRouter = async (model, path2) => {
-  const templateNames = getTemplateStrings(model, path2);
+const addScaffoldSetToRouter = async (model, scaffoldPath) => {
+  const templateNames = getTemplateStrings(model, scaffoldPath);
   const nameVars = nameVariants(model);
   const title = nameVars.pluralPascalName;
   const titleTo = templateNames.pluralRouteName;
   const buttonLabel = `New ${nameVars.singularPascalName}`;
   const buttonTo = templateNames.newRouteName;
+  const unauthenticatedRoute = getUnauthenticatedRedirectRoute();
   return addRoutesToRouterTask(
-    await routes({ model, path: path2 }),
+    await routes({ model, path: scaffoldPath }),
     "ScaffoldLayout",
-    { title, titleTo, buttonLabel, buttonTo }
+    { title, titleTo, buttonLabel, buttonTo },
+    unauthenticatedRoute ? { unauthenticated: unauthenticatedRoute } : void 0
   );
 };
 const tasks = ({
@@ -549,25 +635,28 @@ const tasks = ({
   force,
   tests,
   typescript,
-  javascript,
-  tailwind
+  javascript: _javascript,
+  tailwind,
+  missingModels
 }) => {
   return new Listr(
     [
       {
         title: "Generating scaffold files...",
         task: async () => {
-          const f = await files({
-            docs,
-            model,
-            path: path2,
-            tests,
-            typescript,
-            javascript,
-            tailwind,
-            force
-          });
-          return writeFilesTask(f, { overwriteExisting: force });
+          const f = {
+            ...await files({
+              docs,
+              model,
+              path: path2,
+              tests,
+              typescript,
+              tailwind,
+              force
+            }),
+            ...await sdlStubFiles(missingModels, model, { docs, typescript })
+          };
+          return writeFilesWithStubsTask(f, { overwriteExisting: force });
         }
       },
       {
@@ -632,6 +721,7 @@ const handler = async ({
   tailwind = shouldUseTailwindCSS(tailwind);
   try {
     const { name } = await verifyModelName({ name: model });
+    const missingModels = await missingRelatedModels(name);
     const t = tasks({
       docs,
       model: name,
@@ -639,15 +729,49 @@ const handler = async ({
       force,
       tests,
       typescript,
-      tailwind
+      tailwind,
+      missingModels
     });
     if (rollback && !force) {
       prepareForRollback(t);
     }
     await t.run();
+    if (missingModels.length > 0) {
+      console.log();
+      console.log(
+        c.info(
+          `${name} has relations to models that don't have SDL files of their own yet: ${missingModels.join(", ")}`
+        )
+      );
+      console.log(
+        c.info(
+          "Read-only SDL stubs were generated for them, since GraphQL type generation fails otherwise."
+        )
+      );
+      console.log(
+        c.info("To replace a stub, run one of the following for each model:")
+      );
+      for (const stubModel of missingModels) {
+        console.log(
+          c.info(
+            `  ${formatCedarCommand(["generate", "sdl", stubModel])} (SDL + service only)`
+          )
+        );
+        console.log(
+          c.info(
+            `  ${formatCedarCommand(["generate", "scaffold", stubModel])} (adds pages, cells, and forms too)`
+          )
+        );
+      }
+    }
+    printRedactedFieldsNote(
+      await redactedSensitiveFields([name, ...missingModels])
+    );
   } catch (e) {
-    console.log(c.error(e.message));
-    process.exit(e?.existCode || 1);
+    const message = e instanceof Error ? e.message : String(e);
+    const exitCode = e instanceof Error && "exitCode" in e ? e.exitCode ?? 1 : 1;
+    console.log(c.error(message));
+    process.exit(exitCode);
   }
 };
 const splitPathAndModel = (pathSlashModel) => {
@@ -657,7 +781,10 @@ const splitPathAndModel = (pathSlashModel) => {
 };
 export {
   files,
+  getUnauthenticatedRedirectRoute,
   handler,
+  hasLoginRoute,
+  isAuthSetup,
   routes,
   shouldUseTailwindCSS,
   splitPathAndModel,

package/dist/commands/generate/scaffold/templates/lib/formatters.tsx.template

@@ -40,7 +40,7 @@ export const jsonTruncate = (obj: unknown) => {
 }
 
 export const timeTag = (dateTime?: string) => {
-  let output: string | JSX.Element = ''
+  let output: string | React.JSX.Element = ''
 
   if (dateTime) {
     output = (

package/dist/commands/generate/script/script.js

@@ -19,6 +19,7 @@ const builder = (yargs) => {
   Object.entries(getYargsDefaults()).forEach(([option, config]) => {
     yargs.option(option, config);
   });
+  return yargs;
 };
 const handler = createHandler("script");
 export {

package/dist/commands/generate/script/scriptHandler.js

@@ -1,9 +1,9 @@
 import fs from "node:fs";
 import path from "node:path";
 import { Listr } from "listr2";
-import { recordTelemetryAttributes } from "@cedarjs/cli-helpers";
+import { colors as c } from "@cedarjs/cli-helpers/colors";
+import { recordTelemetryAttributes } from "@cedarjs/cli-helpers/telemetry";
 import { errorTelemetry } from "@cedarjs/telemetry";
-import c from "../../../lib/colors.js";
 import {
   getPaths,
   writeFilesTask,
@@ -35,7 +35,10 @@ const files = async ({ name, typescript = false }) => {
     }
   };
 };
-const handler = async ({ force, ...args }) => {
+const handler = async ({
+  force,
+  ...args
+}) => {
   recordTelemetryAttributes({
     command: "generate script",
     force,
@@ -74,9 +77,10 @@ const handler = async ({ force, ...args }) => {
       prepareForRollback(tasks);
     }
     await tasks.run();
-  } catch (e) {
-    errorTelemetry(process.argv, e.message);
-    console.log(c.error(e.message));
+  } catch (error) {
+    const message = error instanceof Error ? error.message : String(error);
+    errorTelemetry(process.argv, message);
+    console.log(c.error(message));
     process.exit(1);
   }
 };

package/dist/commands/generate/script/templates/script.ts.template

@@ -3,12 +3,17 @@
 // To access your database uncomment the line below
 // import { db } from 'api/src/lib/db'
 
-interface Args {
-  _: string[]
-  [key: string]: unknown
+interface ScriptArgs {
+  args: {
+    // positional args, e.g. `yarn cedar exec myScript foo 123` -> ['foo', 123]
+    // numeric-looking args are parsed as numbers, others as strings
+    _: Array<string | number>
+    // named flags, e.g. `--force` -> { force: true }
+    [flag: string]: unknown
+  }
 }
 
-export default async ({ args }: Args) => {
+export default async ({ args }: ScriptArgs) => {
   // Your script here...
   console.log(':: Executing script with args ::')
   console.log(args)

package/dist/commands/generate/script/templates/tsconfig.json.template

@@ -4,6 +4,12 @@
     "allowJs": true,
     "esModuleInterop": true,
     "baseUrl": "./",
+    "rootDirs": [
+      "../api/src",
+      "../.cedar/types/mirror/api/src",
+      "../web/src",
+      "../.cedar/types/mirror/web/src"
+    ],
     "paths": {
       "$api/*": [
         "../api/*",
@@ -11,6 +17,14 @@
       "api/*": [
         "../api/*",
       ],
+      "$api/src/*": [
+        "../api/src/*",
+        "../.cedar/types/mirror/api/src/*"
+      ],
+      "api/src/*": [
+        "../api/src/*",
+        "../.cedar/types/mirror/api/src/*"
+      ],
       "$web/*": [
         "../web/*",
       ],
@@ -19,11 +33,11 @@
       ],
       "$web/src/*": [
         "../web/src/*",
-        "../.redwood/types/mirror/web/src/*"
+        "../.cedar/types/mirror/web/src/*"
       ],
       "web/src/*": [
         "../web/src/*",
-        "../.redwood/types/mirror/web/src/*"
+        "../.cedar/types/mirror/web/src/*"
       ],
       "types/*": ["../types/*", "../web/types/*", "../api/types/*"],
     },

package/dist/commands/generate/sdl/sdl.js

@@ -1,6 +1,6 @@
 import { terminalLink } from "termi-link";
 import { createHandler, getYargsDefaults } from "../yargsCommandHelpers.js";
-const getDefaults = () => {
+const getDefaultOptions = () => {
   return {
     ...getYargsDefaults(),
     crud: {
@@ -34,15 +34,16 @@ const builder = (yargs) => {
       "https://cedarjs.com/docs/cli-commands#generate-sdl"
     )}`
   );
-  Object.entries(getDefaults()).forEach(([option, config]) => {
+  Object.entries(getDefaultOptions()).forEach(([option, config]) => {
     yargs.option(option, config);
   });
+  return yargs;
 };
 const handler = createHandler("sdl");
 export {
   builder,
   command,
   description,
-  getDefaults,
+  getDefaultOptions,
   handler
 };