@cedarjs/cli 7.0.0-canary.3106 → 7.0.0-canary.3108

package/dist/commands/setup/tenancy/preflight.js

@@ -1,23 +1,26 @@
 import fs from "node:fs";
 import path from "node:path";
+import { formatCedarCommand } from "@cedarjs/cli-helpers/packageManager/display";
 const WEB_AUTH_EXTENSIONS = ["ts", "tsx", "js", "jsx"];
 function hasWebAuthFile(webSrcPath) {
   return WEB_AUTH_EXTENSIONS.some(
     (extension) => fs.existsSync(path.join(webSrcPath, `auth.${extension}`))
   );
 }
-const AUTH_NOT_SET_UP_MESSAGE = [
-  "Auth is not set up in this project.",
-  "",
-  "Tenancy builds on your app's auth: it adds memberships to",
-  "`getCurrentUser`, and resolves the current organization from the",
-  "signed-in user's memberships. Set up auth first, then run this command",
-  "again:",
-  "",
-  "  yarn cedar setup auth dbAuth",
-  "",
-  "Any provider works. See https://cedarjs.com/docs/authentication"
-].join("\n");
+function authNotSetUpMessage() {
+  return [
+    "Auth is not set up in this project.",
+    "",
+    "Tenancy builds on your app's auth: it adds memberships to",
+    "`getCurrentUser`, and resolves the current organization from the",
+    "signed-in user's memberships. Set up auth first, then run this command",
+    "again:",
+    "",
+    `  ${formatCedarCommand(["setup", "auth", "dbAuth"])}`,
+    "",
+    "Any provider works. See https://cedarjs.com/docs/authentication"
+  ].join("\n");
+}
 function noUserModelMessage(schemaPath) {
   return [
     `No \`User\` model found in ${schemaPath}.`,
@@ -30,7 +33,7 @@ function noUserModelMessage(schemaPath) {
     "provider's id in a column beside it, so memberships keep working if you",
     "switch providers or add a second one.",
     "",
-    "Add a model like this one, run `yarn cedar prisma migrate dev`, then",
+    `Add a model like this one, run \`${formatCedarCommand(["prisma", "migrate", "dev"])}\`, then`,
     "run this command again:",
     "",
     "  model User {",
@@ -40,7 +43,7 @@ function noUserModelMessage(schemaPath) {
   ].join("\n");
 }
 export {
-  AUTH_NOT_SET_UP_MESSAGE,
+  authNotSetUpMessage,
   hasWebAuthFile,
   noUserModelMessage
 };

package/dist/commands/setup/tenancy/schemaPrisma.js

@@ -58,13 +58,17 @@ function editSchema(schema, options) {
   if (!hasModel(schema, "User")) {
     throw new Error("CEDAR_TENANCY_ERR_NO_USER_MODEL");
   }
-  const modelsExist = hasModel(schema, "Organization") || hasModel(schema, "Membership");
-  const modelsAreThisCommands = schema.includes(ORGANIZATION_MODEL) && schema.includes(MEMBERSHIP_MODEL);
-  if (modelsExist && !modelsAreThisCommands && !options.force) {
-    throw new Error("CEDAR_TENANCY_ERR_MODELS_EXIST");
+  const organizationIsCustomized = hasModel(schema, "Organization") && !schema.includes(ORGANIZATION_MODEL);
+  const membershipIsCustomized = hasModel(schema, "Membership") && !schema.includes(MEMBERSHIP_MODEL);
+  const modelsCustomized = organizationIsCustomized || membershipIsCustomized;
+  if (modelsCustomized && !options.force) {
+    return { schema: addDataMigrationModel(schema), outcome: "skipped" };
   }
   const withTenancyModels = addTenancyModels(schema);
-  return addDataMigrationModel(withTenancyModels);
+  return {
+    schema: addDataMigrationModel(withTenancyModels),
+    outcome: modelsCustomized ? "forced" : "added"
+  };
 }
 export {
   MEMBERSHIP_MODEL,

package/dist/commands/setup/tenancy/templates/ensureDefaultOrganizations.dataMigration.ts.template

@@ -10,8 +10,9 @@ const BATCH_SIZE = 100
  * dbAuth, the signup handler). Every user without a membership gets one, in
  * batches, using the same `ensureDefaultOrganization` new signups use.
  *
- * Run with `yarn cedar data-migrate up`, after `yarn cedar prisma migrate dev`
- * has applied the `Organization`/`Membership` migration.
+ * Run with `__DATA_MIGRATE_UP_COMMAND__`, after
+ * `__PRISMA_MIGRATE_DEV_COMMAND__` has applied the
+ * `Organization`/`Membership` migration.
  */
 export default async ({ db }: { db: PrismaClient }) => {
   let cursor: string | undefined

package/dist/commands/setup/tenancy/tenancyHandler.js

@@ -18,11 +18,16 @@ import { getPaths, transformTSToJS, writeFile } from "../../../lib/index.js";
 import { isTypeScriptProject } from "../../../lib/project.js";
 import { runTransform } from "../../../lib/runTransform.js";
 import {
-  AUTH_NOT_SET_UP_MESSAGE,
+  authNotSetUpMessage,
   hasWebAuthFile,
   noUserModelMessage
 } from "./preflight.js";
-import { editSchema, hasModel } from "./schemaPrisma.js";
+import {
+  editSchema,
+  hasModel,
+  MEMBERSHIP_MODEL,
+  ORGANIZATION_MODEL
+} from "./schemaPrisma.js";
 const DEFAULT_TENANT_FIELD = "organizationId";
 const AUTH_SNIPPET = `
   export const getCurrentUser = async (session) => {
@@ -61,7 +66,7 @@ const SIGNUP_SNIPPET = `
 const handler = async ({ tenantField, force }) => {
   const paths = getPaths();
   if (!hasWebAuthFile(paths.web.src)) {
-    console.error(c.error(AUTH_NOT_SET_UP_MESSAGE));
+    console.error(c.error(authNotSetUpMessage()));
     process.exit(1);
   }
   const preflightSchemaPath = await getSchemaPath(paths.api.prismaConfig);
@@ -82,16 +87,13 @@ const handler = async ({ tenantField, force }) => {
   const graphqlPath = path.join(paths.api.functions, `graphql.${ext}`);
   const functionsAuthPath = path.join(paths.api.functions, `auth.${ext}`);
   const isDbAuthProject = fs.existsSync(functionsAuthPath) && fs.readFileSync(functionsAuthPath, "utf-8").includes("DbAuthHandler");
-  const writeTemplateFile = async (templateFile, outputPath) => {
-    const templatePath = path.resolve(
-      import.meta.dirname,
-      "templates",
-      templateFile
-    );
-    const templateContent = fs.readFileSync(templatePath, {
-      encoding: "utf8",
-      flag: "r"
-    });
+  const writeTemplateFile = async (templateFile, outputPath, replacements = {}) => {
+    const dirname = import.meta.dirname;
+    const templatePath = path.resolve(dirname, "templates", templateFile);
+    let templateContent = fs.readFileSync(templatePath, "utf-8");
+    for (const [token, value] of Object.entries(replacements)) {
+      templateContent = templateContent.replaceAll(token, value);
+    }
     const content = projectIsTypescript ? templateContent : await transformTSToJS(outputPath, templateContent);
     return writeFile(outputPath, content, { overwriteExisting: force });
   };
@@ -107,27 +109,35 @@ const handler = async ({ tenantField, force }) => {
       },
       {
         title: "Adding Organization and Membership models to schema.prisma...",
-        task: async () => {
+        task: async (ctx, task) => {
           const schemaPath = await getSchemaPath(paths.api.prismaConfig);
           const schema = fs.readFileSync(schemaPath, "utf-8");
-          let updatedSchema;
+          let editResult;
           try {
-            updatedSchema = editSchema(schema, { force });
+            editResult = editSchema(schema, { force });
           } catch (e) {
             const message = e instanceof Error ? e.message : String(e);
             if (message === "CEDAR_TENANCY_ERR_NO_USER_MODEL") {
+              const authSetup = formatCedarCommand(["setup", "auth", "dbAuth"]);
+              const tenancySetup = formatCedarCommand(["setup", "tenancy"]);
               throw new Error(
-                "No `User` model found in schema.prisma. Set up authentication first (e.g. `yarn cedar setup auth dbAuth`) before running `yarn cedar setup tenancy`."
-              );
-            }
-            if (message === "CEDAR_TENANCY_ERR_MODELS_EXIST") {
-              throw new Error(
-                "`Organization` and/or `Membership` models already exist in schema.prisma. Re-run with --force to keep them as-is and continue with the rest of the setup."
+                `No \`User\` model found in schema.prisma. Set up authentication first (e.g. \`${authSetup}\`) before running \`${tenancySetup}\`.`
               );
             }
             throw e;
           }
-          fs.writeFileSync(schemaPath, updatedSchema);
+          ctx.modelsExistOutcome = editResult.outcome;
+          fs.writeFileSync(schemaPath, editResult.schema);
+          if (editResult.outcome === "skipped") {
+            task.output = `\`Organization\` and/or \`Membership\` models already exist in schema.prisma and were left as-is. Add these fields and relations by hand so tenancy can use them:
+
+${ORGANIZATION_MODEL}
+
+${MEMBERSHIP_MODEL}
+
+Re-run with --force to have this command append its own versions beside them instead, so you can diff and merge rather than retype.`;
+            return;
+          }
           try {
             await runTransitiveBin(
               "prisma",
@@ -135,13 +145,21 @@ const handler = async ({ tenantField, force }) => {
               { cwd: paths.base }
             );
           } catch {
+            if (editResult.outcome === "forced") {
+              task.output = '`prisma format` failed because the appended Organization/Membership clash with your existing ones, as requested by --force. Continuing with the rest of the setup; see "Next steps" for how to merge them.';
+              return;
+            }
             throw new Error(
               "`prisma format` failed, so the `memberships` relation was not added to the `User` model. Add it by hand: `memberships Membership[]` as the last field of `model User { ... }`, then re-run this command."
             );
           }
           const membershipsOccurrences = (schema2) => (schema2.match(/memberships\s+Membership\[\]/g) ?? []).length;
           const formattedSchema = fs.readFileSync(schemaPath, "utf-8");
-          if (membershipsOccurrences(formattedSchema) <= membershipsOccurrences(updatedSchema)) {
+          if (membershipsOccurrences(formattedSchema) <= membershipsOccurrences(editResult.schema)) {
+            if (editResult.outcome === "forced") {
+              task.output = 'The `memberships` relation was not added to the `User` model, likely because of the clash from --force. Continuing with the rest of the setup; see "Next steps" for how to merge the appended models by hand.';
+              return;
+            }
             throw new Error(
               "`prisma format` did not add the `memberships` relation to the `User` model. Add it by hand: `memberships Membership[]` as the last field of `model User { ... }`, then re-run this command."
             );
@@ -159,12 +177,13 @@ const handler = async ({ tenantField, force }) => {
           });
           if (transformResult.error) {
             if (transformResult.error === "CEDAR_CODEMOD_ERR_OLD_FORMAT") {
+              const tenancySetup = formatCedarCommand(["setup", "tenancy"]);
               throw new Error(
-                "It looks like your api/src/lib/db file is using the old format. Please update it as per the v8 upgrade guide, then run `yarn cedar setup tenancy` again."
+                `It looks like your api/src/lib/db file is using the old format. Please update it as per the v8 upgrade guide, then run \`${tenancySetup}\` again.`
               );
             }
             throw new Error(
-              "Could not add the tenancy Prisma extension. Please modify api/src/lib/db by hand: wrap the `db` export in `.$extends(createTenancyExtension({ models: { allExcept: ['user', 'organization', 'membership'] } }))`."
+              "Could not add the tenancy Prisma extension. Please modify `api/src/lib/db` by hand: wrap the `db` export in `.$extends(createTenancyExtension({ models: { allExcept: ['user', 'organization', 'membership'] } }))`."
             );
           }
         }
@@ -271,7 +290,18 @@ ${SIGNUP_SNIPPET}`;
             path.join(
               dataMigrationsPath,
               `${timestamp}-ensure-default-organizations.${ext}`
-            )
+            ),
+            {
+              __DATA_MIGRATE_UP_COMMAND__: formatCedarCommand([
+                "data-migrate",
+                "up"
+              ]),
+              __PRISMA_MIGRATE_DEV_COMMAND__: formatCedarCommand([
+                "prisma",
+                "migrate",
+                "dev"
+              ])
+            }
           );
         }
       },
@@ -329,17 +359,22 @@ ${SIGNUP_SNIPPET}`;
       },
       {
         title: "Next steps...",
-        task: (_ctx, task) => {
+        task: (ctx, task) => {
           const migrateCommand = formatCedarCommand([
             "prisma",
             "migrate",
             "dev"
           ]);
           const dataMigrateCommand = formatCedarCommand(["data-migrate", "up"]);
+          const modelsExistWarning = ctx.modelsExistOutcome === "forced" ? c.error(
+            "\nschema.prisma is currently invalid (as requested by --force): merge the appended Organization/Membership blocks with your existing ones, then run `prisma format`.\n"
+          ) : ctx.modelsExistOutcome === "skipped" ? c.warning(
+            "\nOrganization/Membership already existed and were left as-is: add the fields and relations printed above by hand before continuing.\n"
+          ) : "";
           task.title = `Next steps...
 
           ${c.success("\nMulti-tenancy configured!\n")}
-
+          ${modelsExistWarning}
           1. Run ${c.highlight(migrateCommand)} to create the Organization/Membership
              tables, then ${c.highlight(dataMigrateCommand)} to give every existing
              user a default organization.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cedarjs/cli",
-  "version": "7.0.0-canary.3106",
+  "version": "7.0.0-canary.3108",
   "description": "The CedarJS Command Line",
   "repository": {
     "type": "git",
@@ -36,17 +36,17 @@
     "@babel/preset-typescript": "7.29.7",
     "@babel/traverse": "7.29.8",
     "@babel/types": "7.29.8",
-    "@cedarjs/api-server": "7.0.0-canary.3106",
-    "@cedarjs/babel-config": "7.0.0-canary.3106",
-    "@cedarjs/cli-helpers": "7.0.0-canary.3106",
-    "@cedarjs/internal": "7.0.0-canary.3106",
-    "@cedarjs/prerender": "7.0.0-canary.3106",
-    "@cedarjs/project-config": "7.0.0-canary.3106",
-    "@cedarjs/structure": "7.0.0-canary.3106",
-    "@cedarjs/telemetry": "7.0.0-canary.3106",
-    "@cedarjs/utils": "7.0.0-canary.3106",
-    "@cedarjs/vite": "7.0.0-canary.3106",
-    "@cedarjs/web-server": "7.0.0-canary.3106",
+    "@cedarjs/api-server": "7.0.0-canary.3108",
+    "@cedarjs/babel-config": "7.0.0-canary.3108",
+    "@cedarjs/cli-helpers": "7.0.0-canary.3108",
+    "@cedarjs/internal": "7.0.0-canary.3108",
+    "@cedarjs/prerender": "7.0.0-canary.3108",
+    "@cedarjs/project-config": "7.0.0-canary.3108",
+    "@cedarjs/structure": "7.0.0-canary.3108",
+    "@cedarjs/telemetry": "7.0.0-canary.3108",
+    "@cedarjs/utils": "7.0.0-canary.3108",
+    "@cedarjs/vite": "7.0.0-canary.3108",
+    "@cedarjs/web-server": "7.0.0-canary.3108",
     "@listr2/prompt-adapter-enquirer": "4.3.1",
     "@opentelemetry/api": "1.9.1",
     "@opentelemetry/core": "1.30.1",
@@ -94,7 +94,7 @@
     "yargs": "17.7.3"
   },
   "devDependencies": {
-    "@cedarjs/framework-tools": "7.0.0-canary.3106",
+    "@cedarjs/framework-tools": "7.0.0-canary.3108",
     "@prisma/dmmf": "7.10.0",
     "@types/archiver": "^7.0.0",
     "memfs": "4.68.2",