@cedarjs/cli-helpers 8.0.0-canary.3315 → 8.0.0-canary.3317

package/dist/auth/authTasks.d.ts

@@ -1,4 +1,5 @@
 import type { ListrRenderer, ListrTask, ListrTaskWrapper } from 'listr2';
+import type { ExistingFiles } from '../lib/index.js';
 export declare const getWebAppPath: () => string;
 export declare const addApiConfig: ({ replaceExistingImport, authDecoderImport, }: {
     replaceExistingImport: boolean;
@@ -32,6 +33,14 @@ export declare const addConfigToRoutes: () => {
  * @returns Listr task
  */
 export declare const generateAuthApiFiles: <Renderer extends typeof ListrRenderer>(basedir: string, webAuthn: boolean, oauth?: boolean) => ListrTask<AuthGeneratorCtx, Renderer>;
+/**
+ * Exported for testing
+ *
+ * @returns `true` if writing `filesRecord` with the given `existingFiles`
+ *   strategy writes `api/src/lib/auth.{ts,js}`, which is where the auth
+ *   provider's `requireAuth` function lives
+ */
+export declare function writesApiAuthLib(filesRecord: Record<string, string>, existingFiles: ExistingFiles): boolean;
 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;
@@ -41,9 +50,36 @@ export interface AuthGeneratorCtx {
     setupMode: AuthSetupMode;
     provider: string;
     force: boolean;
+    /**
+     * Set by `generateAuthApiFiles`. `true` when setup writes the auth
+     * provider's `api/src/lib/auth.{ts,js}` file, replacing any existing
+     * `requireAuth` implementation
+     */
+    apiAuthLibWritten?: 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>;
 };
+/**
+ * Exported for testing
+ *
+ * @param content - The contents of requireAuth.test.{ts,js}
+ * @returns The content with the stub test case replaced, or `undefined` if
+ *   the unmodified stub test case isn't part of the content
+ */
+export declare const replaceStubRequireAuthTestCase: (content: string) => string | undefined;
+/**
+ * New Cedar apps ship with a test for the `requireAuth` directive that
+ * asserts the behavior of the stub `requireAuth` function. Setting up auth
+ * replaces that stub, so this task replaces the stub test case with test
+ * cases matching the real implementation. The test is only updated when
+ * setup writes `api/src/lib/auth.{ts,js}` (for example, not when the user
+ * declines overwriting existing files). Test files that don't contain the
+ * unmodified stub test case are left as they are.
+ */
+export declare const updateRequireAuthTest: <Renderer extends typeof ListrRenderer, FallbackRenderer extends typeof ListrRenderer>() => {
+    title: string;
+    task: (ctx: AuthGeneratorCtx, task: ListrTaskWrapper<AuthGeneratorCtx, Renderer, FallbackRenderer>) => void;
+};
 //# sourceMappingURL=authTasks.d.ts.map

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

@@ -1 +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;AA2BxE,eAAO,MAAM,aAAa,cAA2B,CAAA;AAwDrD,eAAO,MAAM,YAAY,GAAI,+CAG1B;IACD,qBAAqB,EAAE,OAAO,CAAA;IAC9B,iBAAiB,CAAC,EAAE,MAAM,CAAA;CAC3B,SAgDA,CAAA;AAmCD,eAAO,MAAM,eAAe,GAAI,SAAS,MAAM,YAE9C,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB,GAAI,SAAS,MAAM,WA6CjD,CAAA;AAuED;;;GAGG;AACH,eAAO,MAAM,iBAAiB,GAC5B,QAAQ,SAAS,OAAO,aAAa,OAClC,SAAS,CAAC,gBAAgB,EAAE,QAAQ,CA8CxC,CAAA;AAED,eAAO,MAAM,aAAa,GAAI,SAAS,MAAM,EAAE,UAAU,OAAO;;gBAgC1C,gBAAgB;CA0CrC,CAAA;AAED,eAAO,MAAM,iBAAiB;;;CAmB7B,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB,GAAI,QAAQ,SAAS,OAAO,aAAa,EACxE,SAAS,MAAM,EACf,UAAU,OAAO,EACjB,eAAa,KACZ,SAAS,CAAC,gBAAgB,EAAE,QAAQ,CAgDtC,CAAA;AASD,eAAO,MAAM,qBAAqB,GAChC,QAAQ,SAAS,OAAO,aAAa,EACrC,gBAAgB,SAAS,OAAO,aAAa,EAE7C,oBAAoB,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,EAE7C,OAAO,OAAO;;gBAKL,gBAAgB,QACf,gBAAgB,CAAC,gBAAgB,EAAE,QAAQ,EAAE,gBAAgB,CAAC;CA2CzE,CAAA"}
+{"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;AAKxE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAsBpD,eAAO,MAAM,aAAa,cAA2B,CAAA;AAwDrD,eAAO,MAAM,YAAY,GAAI,+CAG1B;IACD,qBAAqB,EAAE,OAAO,CAAA;IAC9B,iBAAiB,CAAC,EAAE,MAAM,CAAA;CAC3B,SAgDA,CAAA;AAmCD,eAAO,MAAM,eAAe,GAAI,SAAS,MAAM,YAE9C,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB,GAAI,SAAS,MAAM,WA6CjD,CAAA;AAuED;;;GAGG;AACH,eAAO,MAAM,iBAAiB,GAC5B,QAAQ,SAAS,OAAO,aAAa,OAClC,SAAS,CAAC,gBAAgB,EAAE,QAAQ,CA8CxC,CAAA;AAED,eAAO,MAAM,aAAa,GAAI,SAAS,MAAM,EAAE,UAAU,OAAO;;gBAgC1C,gBAAgB;CA0CrC,CAAA;AAED,eAAO,MAAM,iBAAiB;;;CAmB7B,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB,GAAI,QAAQ,SAAS,OAAO,aAAa,EACxE,SAAS,MAAM,EACf,UAAU,OAAO,EACjB,eAAa,KACZ,SAAS,CAAC,gBAAgB,EAAE,QAAQ,CAkDtC,CAAA;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAC9B,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EACnC,aAAa,EAAE,aAAa,WAW7B;AASD,eAAO,MAAM,qBAAqB,GAChC,QAAQ,SAAS,OAAO,aAAa,EACrC,gBAAgB,SAAS,OAAO,aAAa,EAE7C,oBAAoB,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;IACd;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAA;CAC5B;AAED,eAAO,MAAM,gBAAgB,GAC3B,QAAQ,SAAS,OAAO,aAAa,EACrC,gBAAgB,SAAS,OAAO,aAAa,EAE7C,OAAO,OAAO;;gBAKL,gBAAgB,QACf,gBAAgB,CAAC,gBAAgB,EAAE,QAAQ,EAAE,gBAAgB,CAAC;CA2CzE,CAAA;AAmCD;;;;;;GAMG;AACH,eAAO,MAAM,8BAA8B,GAAI,SAAS,MAAM,uBAW7D,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,qBAAqB,GAChC,QAAQ,SAAS,OAAO,aAAa,EACrC,gBAAgB,SAAS,OAAO,aAAa;;gBAItC,gBAAgB,QACf,gBAAgB,CAAC,gBAAgB,EAAE,QAAQ,EAAE,gBAAgB,CAAC;CAmCtE,CAAA"}

package/dist/auth/authTasks.js

@@ -294,12 +294,21 @@ const generateAuthApiFiles = (basedir, webAuthn, oauth = false) => {
         filesRecord = uniqueFilesRecord;
         existingFiles = "FAIL";
       }
+      ctx.apiAuthLibWritten = writesApiAuthLib(filesRecord, existingFiles);
       return writeFilesTask(filesRecord, {
         existingFiles
       });
     }
   };
 };
+function writesApiAuthLib(filesRecord, existingFiles) {
+  const authLibPaths = ["ts", "js"].map(
+    (ext) => path.join(getPaths().api.src, "lib", `auth.${ext}`)
+  );
+  return Object.keys(filesRecord).some(
+    (filePath) => authLibPaths.includes(filePath) && (existingFiles === "OVERWRITE" || !fs.existsSync(filePath))
+  );
+}
 function findExistingFiles(filesMap) {
   return Object.keys(filesMap).filter((filePath) => fs.existsSync(filePath)).map((filePath) => filePath.replace(getPaths().base, ""));
 }
@@ -338,6 +347,65 @@ const setAuthSetupMode = (force) => {
     }
   };
 };
+const STUB_REQUIRE_AUTH_TEST_CASE = `  it('requireAuth has stub implementation. Should not throw when current user', () => {
+    // If you want to set values in context, pass it through e.g.
+    // mockRedwoodDirective(requireAuth, { context: { currentUser: { id: 1, name: 'Lebron McGretzky' } }})
+    const mockExecution = mockRedwoodDirective(requireAuth, { context: {} })
+
+    expect(mockExecution).not.toThrowError()
+  })`;
+const REQUIRE_AUTH_TEST_CASES = `  it('throws when there is no current user', () => {
+    const mockExecution = mockRedwoodDirective(requireAuth, { context: {} })
+
+    expect(mockExecution).toThrowError("You don't have permission to do that.")
+  })
+
+  it('does not throw when there is a current user', () => {
+    // The mocked user should have the same shape as what getCurrentUser()
+    // in api/src/lib/auth returns
+    const mockExecution = mockRedwoodDirective(requireAuth, {
+      context: { currentUser: { id: 1 } },
+    })
+
+    expect(mockExecution).not.toThrowError()
+  })`;
+const replaceStubRequireAuthTestCase = (content) => {
+  const eol = content.includes("\r\n") ? "\r\n" : "\n";
+  const normalizedContent = content.replaceAll("\r\n", "\n");
+  if (!normalizedContent.includes(STUB_REQUIRE_AUTH_TEST_CASE)) {
+    return void 0;
+  }
+  return normalizedContent.replace(STUB_REQUIRE_AUTH_TEST_CASE, REQUIRE_AUTH_TEST_CASES).replaceAll("\n", eol);
+};
+const updateRequireAuthTest = () => ({
+  title: "Updating requireAuth directive test...",
+  task: (ctx, task) => {
+    if (!ctx.apiAuthLibWritten) {
+      task.skip(
+        "Keeping the requireAuth directive test as is, because the existing requireAuth implementation is kept"
+      );
+      return;
+    }
+    const testFilePath = ["ts", "js"].map(
+      (ext) => path.join(
+        getPaths().api.directives,
+        "requireAuth",
+        `requireAuth.test.${ext}`
+      )
+    ).find((filePath) => fs.existsSync(filePath));
+    if (!testFilePath) {
+      task.skip("No requireAuth directive test found");
+      return;
+    }
+    const content = fs.readFileSync(testFilePath, "utf-8");
+    const newContent = replaceStubRequireAuthTestCase(content);
+    if (newContent === void 0) {
+      task.skip("Keeping the customized requireAuth directive test as is");
+      return;
+    }
+    fs.writeFileSync(testFilePath, newContent);
+  }
+});
 export {
   addApiConfig,
   addAuthConfigToGqlApi,
@@ -348,5 +416,8 @@ export {
   getWebAppPath,
   hasAuthProvider,
   removeAuthProvider,
-  setAuthSetupMode
+  replaceStubRequireAuthTestCase,
+  setAuthSetupMode,
+  updateRequireAuthTest,
+  writesApiAuthLib
 };

package/dist/auth/setupHelpers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"setupHelpers.d.ts","sourceRoot":"","sources":["../../src/auth/setupHelpers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAA;AAGvC,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,OAAO,CAAA;AAWjC,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AAUtD,YAAY,EAAE,gBAAgB,EAAE,CAAA;AAEhC,eAAO,MAAM,mBAAmB,GAAI,OAAO,IAAI;;;;EAoB9C,CAAA;AAED,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,OAAO,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAA;IAChB,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;IACtB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;IACtB,UAAU,CAAC,EAAE,CAAC,SAAS,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,EAAE,CAAA;IACxD,KAAK,CAAC,EAAE,MAAM,EAAE,CAAA;IAChB,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB;AASD;;;GAGG;AACH,eAAO,MAAM,mBAAmB,GAAU,4HAYvC,eAAe,kBAiFjB,CAAA"}
+{"version":3,"file":"setupHelpers.d.ts","sourceRoot":"","sources":["../../src/auth/setupHelpers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAA;AAGvC,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,OAAO,CAAA;AAWjC,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AAWtD,YAAY,EAAE,gBAAgB,EAAE,CAAA;AAEhC,eAAO,MAAM,mBAAmB,GAAI,OAAO,IAAI;;;;EAoB9C,CAAA;AAED,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,OAAO,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAA;IAChB,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;IACtB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;IACtB,UAAU,CAAC,EAAE,CAAC,SAAS,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,EAAE,CAAA;IACxD,KAAK,CAAC,EAAE,MAAM,EAAE,CAAA;IAChB,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB;AASD;;;GAGG;AACH,eAAO,MAAM,mBAAmB,GAAU,4HAYvC,eAAe,kBAkFjB,CAAA"}

package/dist/auth/setupHelpers.js

@@ -13,7 +13,8 @@ import {
   addConfigToWebApp,
   setAuthSetupMode,
   createWebAuth,
-  generateAuthApiFiles
+  generateAuthApiFiles,
+  updateRequireAuthTest
 } from "./authTasks.js";
 const standardAuthBuilder = (yargs) => {
   return yargs.option("force", {
@@ -53,6 +54,7 @@ const standardAuthHandler = async ({
     [
       setAuthSetupMode(forceArg),
       generateAuthApiFiles(basedir, webAuthn, oauth),
+      updateRequireAuthTest(),
       addConfigToWebApp(),
       createWebAuth(basedir, webAuthn),
       addConfigToRoutes(),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cedarjs/cli-helpers",
-  "version": "8.0.0-canary.3315",
+  "version": "8.0.0-canary.3317",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/cedarjs/cedar.git",
@@ -125,8 +125,8 @@
     "test:watch": "vitest watch"
   },
   "dependencies": {
-    "@cedarjs/project-config": "8.0.0-canary.3315",
-    "@cedarjs/telemetry": "8.0.0-canary.3315",
+    "@cedarjs/project-config": "8.0.0-canary.3317",
+    "@cedarjs/telemetry": "8.0.0-canary.3317",
     "@listr2/prompt-adapter-enquirer": "4.3.2",
     "@opentelemetry/api": "1.9.1",
     "ansis": "4.4.0",
@@ -146,7 +146,7 @@
     "yargs-parser": "21.1.1"
   },
   "devDependencies": {
-    "@cedarjs/framework-tools": "8.0.0-canary.3315",
+    "@cedarjs/framework-tools": "8.0.0-canary.3317",
     "@types/dotenv-defaults": "^5.0.0",
     "@types/lodash": "4.17.25",
     "@types/pascalcase": "1.0.3",