@cedarjs/cli-helpers 0.0.4

package/dist/auth/setupHelpers.js

@@ -0,0 +1,127 @@
+import { Listr } from "listr2";
+import terminalLink from "terminal-link";
+import { errorTelemetry } from "@cedarjs/telemetry";
+import { colors } from "../lib/colors.js";
+import {
+  addApiPackages,
+  addWebPackages,
+  installPackages
+} from "../lib/installHelpers.js";
+import {
+  addAuthConfigToGqlApi,
+  addConfigToRoutes,
+  addConfigToWebApp,
+  setAuthSetupMode,
+  createWebAuth,
+  generateAuthApiFiles
+} from "./authTasks.js";
+const standardAuthBuilder = (yargs) => {
+  return yargs.option("force", {
+    alias: "f",
+    default: false,
+    description: "Overwrite existing auth configuration",
+    type: "boolean"
+  }).option("verbose", {
+    alias: "v",
+    default: false,
+    description: "Log setup output",
+    type: "boolean"
+  }).epilogue(
+    `Also see the ${terminalLink(
+      "Redwood CLI Reference",
+      "https://redwoodjs.com/docs/cli-commands#setup-auth"
+    )}`
+  );
+};
+function truthy(value) {
+  return !!value;
+}
+const standardAuthHandler = async ({
+  basedir,
+  forceArg,
+  provider,
+  authDecoderImport,
+  webAuthn = false,
+  webPackages = [],
+  apiPackages = [],
+  extraTasks,
+  notes,
+  verbose
+}) => {
+  const tasks = new Listr(
+    [
+      setAuthSetupMode(forceArg),
+      generateAuthApiFiles(basedir, webAuthn),
+      addConfigToWebApp(),
+      createWebAuth(basedir, webAuthn),
+      addConfigToRoutes(),
+      addAuthConfigToGqlApi(authDecoderImport),
+      webPackages.length && addWebPackages(webPackages),
+      apiPackages.length && addApiPackages(apiPackages),
+      (webPackages.length || apiPackages.length) && installPackages,
+      ...(extraTasks || []).filter(truthy),
+      notes && {
+        title: "One more thing...",
+        task: (ctx) => {
+          if (ctx.setupMode === "REPLACE") {
+            notes.push(
+              ...[
+                "",
+                `${colors.warning(
+                  "Your existing auth provider has been replaced!"
+                )}`,
+                "You'll still need to manually remove your old auth provider's config,",
+                "functions, and dependencies (in your web and api package.json's)."
+              ]
+            );
+          }
+          if (ctx.setupMode === "COMBINE") {
+            notes.push(
+              colors.warning(
+                `To avoid overwriting existing files we've generated new file names for the newly generated files. This probably means ${ctx.provider} auth doesn't work out of the box. You'll most likely have to manually merge some of the generated files with your existing auth files`
+              )
+            );
+          }
+        }
+      }
+    ].filter(truthy),
+    {
+      rendererOptions: { collapseSubtasks: false },
+      renderer: verbose ? "verbose" : "default",
+      ctx: {
+        setupMode: "UNKNOWN",
+        provider,
+        // provider name passed from CLI
+        force: forceArg
+      }
+    }
+  );
+  try {
+    await tasks.run();
+    if (notes) {
+      console.log(`
+   ${notes.join("\n   ")}
+`);
+    }
+  } catch (e) {
+    if (isErrorWithMessage(e)) {
+      errorTelemetry(process.argv, e.message);
+      console.error(colors.error(e.message));
+    }
+    if (isErrorWithErrorCode(e)) {
+      process.exit(e.exitCode || 1);
+    } else {
+      process.exit(1);
+    }
+  }
+};
+function isErrorWithMessage(e) {
+  return !!e.message;
+}
+function isErrorWithErrorCode(e) {
+  return !isNaN(e.exitCode);
+}
+export {
+  standardAuthBuilder,
+  standardAuthHandler
+};

package/dist/build.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=build.d.ts.map

package/dist/build.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"build.d.ts","sourceRoot":"","sources":["../build.ts"],"names":[],"mappings":""}

package/dist/cjs/auth/authFiles.d.ts

@@ -0,0 +1,44 @@
+interface FilesArgs {
+    basedir: string;
+    webAuthn: boolean;
+}
+/**
+ * Get the api side file paths and file contents to write
+ *
+ * Example return value:
+ * ```json
+ * {
+ *   "/Users/tobbe/dev/rw-app/api/src/lib/auth.ts": "<file content>",
+ *   "/Users/tobbe/dev/rw-app/api/src/lib/helperFunctions.ts": "<file content>",
+ *   "/Users/tobbe/dev/rw-app/api/src/functions/auth.ts": "<file content>"
+ * }
+ * ```
+ */
+export declare const apiSideFiles: ({ basedir, webAuthn }: FilesArgs) => Promise<Record<string, string>>;
+/**
+ * Loops through the keys in `filesRecord` and generates unique file paths if
+ * they conflict with existing files
+ *
+ * Given this input:
+ * ```json
+ * {
+ *   "/Users/tobbe/dev/rw-app/api/src/lib/auth.ts": "<file content>",
+ *   "/Users/tobbe/dev/rw-app/api/src/lib/helperFunctions.ts": "<file content>",
+ *   "/Users/tobbe/dev/rw-app/api/src/lib/supertokens.ts": "<file content>",
+ *   "/Users/tobbe/dev/rw-app/api/src/functions/auth.ts": "<file content>"
+ * }
+ * ```
+ *
+ * You could get this output, depending on what existing files there are
+ * ```json
+ * {
+ *   "/Users/tobbe/dev/rw-app/api/src/lib/supertokensAuth3.ts": "<file content>",
+ *   "/Users/tobbe/dev/rw-app/api/src/lib/supertokensHelperFunctions.ts": "<file content>",
+ *   "/Users/tobbe/dev/rw-app/api/src/lib/supertokens2.ts": "<file content>",
+ *   "/Users/tobbe/dev/rw-app/api/src/functions/auth.ts": "<file content>"
+ * }
+ * ```
+ */
+export declare function generateUniqueFileNames(filesRecord: Record<string, string>, provider: string): Record<string, string>;
+export {};
+//# sourceMappingURL=authFiles.d.ts.map

package/dist/cjs/auth/authFiles.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"authFiles.d.ts","sourceRoot":"","sources":["../../../src/auth/authFiles.ts"],"names":[],"mappings":"AASA,UAAU,SAAS;IACjB,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,OAAO,CAAA;CAClB;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,YAAY,0BAAiC,SAAS,oCAmElE,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,uBAAuB,CACrC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EACnC,QAAQ,EAAE,MAAM,0BAwCjB"}

package/dist/cjs/auth/authFiles.js

@@ -0,0 +1,109 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var authFiles_exports = {};
+__export(authFiles_exports, {
+  apiSideFiles: () => apiSideFiles,
+  generateUniqueFileNames: () => generateUniqueFileNames
+});
+module.exports = __toCommonJS(authFiles_exports);
+var import_fs = __toESM(require("fs"), 1);
+var import_path = __toESM(require("path"), 1);
+var import_pascalcase = __toESM(require("pascalcase"), 1);
+var import_lib = require("../lib/index.js");
+var import_paths = require("../lib/paths.js");
+var import_project = require("../lib/project.js");
+const apiSideFiles = async ({ basedir, webAuthn }) => {
+  const apiSrcPath = (0, import_paths.getPaths)().api.src;
+  const apiBaseTemplatePath = import_path.default.join(basedir, "templates", "api");
+  const templateDirectories = import_fs.default.readdirSync(apiBaseTemplatePath);
+  let filesRecord = {};
+  for (const dir of templateDirectories) {
+    const templateFiles = import_fs.default.readdirSync(import_path.default.join(apiBaseTemplatePath, dir));
+    const filePaths = templateFiles.filter((fileName) => {
+      const fileNameParts = fileName.split(".");
+      return fileNameParts.length <= 3 || fileNameParts.at(-3) !== "webAuthn";
+    }).map((fileName) => {
+      let outputFileName = fileName.replace(/\.template$/, "");
+      if (!(0, import_project.isTypeScriptProject)()) {
+        outputFileName = outputFileName.replace(/\.ts(x?)$/, ".js$1");
+      }
+      if (!webAuthn) {
+        return { templateFileName: fileName, outputFileName };
+      }
+      const webAuthnFileName = fileName.split(".").reverse().map((part, i) => i === 1 ? "webAuthn." + part : part).reverse().join(".");
+      if (templateFiles.includes(webAuthnFileName)) {
+        return { templateFileName: webAuthnFileName, outputFileName };
+      } else {
+        return { templateFileName: fileName, outputFileName };
+      }
+    }).map((f) => {
+      const templateFilePath = import_path.default.join(
+        apiBaseTemplatePath,
+        dir,
+        f.templateFileName
+      );
+      const outputFilePath = import_path.default.join(apiSrcPath, dir, f.outputFileName);
+      return { templateFilePath, outputFilePath };
+    });
+    for (const paths of filePaths) {
+      const content = import_fs.default.readFileSync(paths.templateFilePath, "utf8");
+      filesRecord = {
+        ...filesRecord,
+        [paths.outputFilePath]: (0, import_project.isTypeScriptProject)() ? content : await (0, import_lib.transformTSToJS)(paths.outputFilePath, content)
+      };
+    }
+  }
+  return filesRecord;
+};
+function generateUniqueFileNames(filesRecord, provider) {
+  const newFilesRecord = {};
+  Object.keys(filesRecord).forEach((fullPath) => {
+    let newFullPath = fullPath;
+    let i = 1;
+    while (import_fs.default.existsSync(newFullPath)) {
+      const nameParts = import_path.default.basename(fullPath).split(".");
+      if (nameParts[0] === provider) {
+        const newFileName = provider + (i + 1) + "." + nameParts.slice(1).join(".");
+        newFullPath = import_path.default.join(import_path.default.dirname(fullPath), newFileName);
+      } else {
+        const count = i > 1 ? i : "";
+        const newFileName = provider + (0, import_pascalcase.default)(nameParts[0]) + count + "." + nameParts.slice(1).join(".");
+        newFullPath = import_path.default.join(import_path.default.dirname(fullPath), newFileName);
+      }
+      i++;
+    }
+    newFilesRecord[newFullPath] = filesRecord[fullPath];
+  });
+  return newFilesRecord;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  apiSideFiles,
+  generateUniqueFileNames
+});

package/dist/cjs/auth/authTasks.d.ts

@@ -0,0 +1,49 @@
+import type { ListrRenderer, ListrTask, ListrTaskWrapper } from 'listr2';
+export declare const getWebAppPath: () => string;
+export declare const addApiConfig: ({ replaceExistingImport, authDecoderImport, }: {
+    replaceExistingImport: boolean;
+    authDecoderImport?: string;
+}) => void;
+export declare const hasAuthProvider: (content: string) => boolean;
+/**
+ * Removes <AuthProvider ...> and </AuthProvider> if they exist, and un-indents
+ * the content.
+ *
+ * Exported for testing
+ */
+export declare const removeAuthProvider: (content: string) => string;
+/**
+ * Actually inserts the required config lines into App.{jsx,tsx}
+ * Exported for testing
+ */
+export declare const addConfigToWebApp: <Renderer extends typeof ListrRenderer>() => ListrTask<AuthGeneratorCtx, Renderer>;
+export declare const createWebAuth: (basedir: string, webAuthn: boolean) => {
+    title: string;
+    task: (ctx: AuthGeneratorCtx) => Promise<void>;
+};
+export declare const addConfigToRoutes: () => {
+    title: string;
+    task: () => void;
+};
+/**
+ * Will find the templates inside `${basedir}/templates/api`,
+ * and write these files to disk with unique names if they are clashing.
+ *
+ * @returns Listr task
+ */
+export declare const generateAuthApiFiles: <Renderer extends typeof ListrRenderer>(basedir: string, webAuthn: boolean) => ListrTask<AuthGeneratorCtx, Renderer>;
+export declare const addAuthConfigToGqlApi: <Renderer extends typeof ListrRenderer, FallbackRenderer extends typeof ListrRenderer>(authDecoderImport?: string) => {
+    title: string;
+    task: (ctx: AuthGeneratorCtx, _task: ListrTaskWrapper<AuthGeneratorCtx, Renderer, FallbackRenderer>) => void;
+};
+export type AuthSetupMode = 'FORCE' | 'REPLACE' | 'COMBINE' | 'UNKNOWN';
+export interface AuthGeneratorCtx {
+    setupMode: AuthSetupMode;
+    provider: string;
+    force: boolean;
+}
+export declare const setAuthSetupMode: <Renderer extends typeof ListrRenderer, FallbackRenderer extends typeof ListrRenderer>(force: boolean) => {
+    title: string;
+    task: (ctx: AuthGeneratorCtx, task: ListrTaskWrapper<AuthGeneratorCtx, Renderer, FallbackRenderer>) => Promise<void>;
+};
+//# sourceMappingURL=authTasks.d.ts.map

package/dist/cjs/auth/authTasks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"authTasks.d.ts","sourceRoot":"","sources":["../../../src/auth/authTasks.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,aAAa,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,QAAQ,CAAA;AAmBxE,eAAO,MAAM,aAAa,cAA2B,CAAA;AAwDrD,eAAO,MAAM,YAAY,kDAGtB;IACD,qBAAqB,EAAE,OAAO,CAAA;IAC9B,iBAAiB,CAAC,EAAE,MAAM,CAAA;CAC3B,SAgDA,CAAA;AAmCD,eAAO,MAAM,eAAe,YAAa,MAAM,YAE9C,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB,YAAa,MAAM,WA6CjD,CAAA;AAoED;;;GAGG;AACH,eAAO,MAAM,iBAAiB,GAC5B,QAAQ,SAAS,OAAO,aAAa,OAClC,SAAS,CAAC,gBAAgB,EAAE,QAAQ,CA0CxC,CAAA;AAED,eAAO,MAAM,aAAa,YAAa,MAAM,YAAY,OAAO;;gBAgC1C,gBAAgB;CA0CrC,CAAA;AAED,eAAO,MAAM,iBAAiB;;;CAmB7B,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB,GAAI,QAAQ,SAAS,OAAO,aAAa,WAC/D,MAAM,YACL,OAAO,KAChB,SAAS,CAAC,gBAAgB,EAAE,QAAQ,CAgDtC,CAAA;AASD,eAAO,MAAM,qBAAqB,GAChC,QAAQ,SAAS,OAAO,aAAa,EACrC,gBAAgB,SAAS,OAAO,aAAa,sBAEzB,MAAM;;gBAInB,gBAAgB,SACd,gBAAgB,CAAC,gBAAgB,EAAE,QAAQ,EAAE,gBAAgB,CAAC;CAcvE,CAAA;AAEF,MAAM,MAAM,aAAa,GACrB,OAAO,GACP,SAAS,GACT,SAAS,GACT,SAAS,CAAA;AAEb,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,aAAa,CAAA;IACxB,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,OAAO,CAAA;CACf;AAED,eAAO,MAAM,gBAAgB,GAC3B,QAAQ,SAAS,OAAO,aAAa,EACrC,gBAAgB,SAAS,OAAO,aAAa,SAEtC,OAAO;;gBAKL,gBAAgB,QACf,gBAAgB,CAAC,gBAAgB,EAAE,QAAQ,EAAE,gBAAgB,CAAC;CA2CzE,CAAA"}