@canva/cli 1.8.0 → 1.10.0

package/templates/dam/scripts/copy_env.ts

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 /* eslint-disable no-console */
-import * as fs from "fs";
-import * as path from "path";
+import fs from "fs";
+import path from "path";
 
 const envPath = path.resolve(__dirname, "..", ".env");
 const templatePath = path.resolve(__dirname, "..", ".env.template");

package/templates/dam/scripts/ssl/ssl.ts

@@ -1,7 +1,7 @@
-import * as crypto from "crypto";
-import * as fs from "fs/promises";
+import crypto from "crypto";
+import fs from "fs/promises";
 import { pki } from "node-forge";
-import * as path from "path";
+import path from "path";
 
 const SSL_CERT_DIR = path.resolve(process.cwd(), "..", "..", ".ssl");
 const CERT_FILE = path.resolve(SSL_CERT_DIR, "certificate.pem");

package/templates/dam/scripts/start/app_runner.ts

@@ -1,12 +1,13 @@
 /* eslint-disable no-console */
 import { generatePreviewUrl } from "@canva/cli";
-import * as ngrok from "@ngrok/ngrok";
-import * as chalk from "chalk";
-import * as Table from "cli-table3";
-import * as nodemon from "nodemon";
+import ngrok from "@ngrok/ngrok";
+import chalk from "chalk";
+import Table from "cli-table3";
+import nodemon from "nodemon";
 import open from "open";
-import * as webpack from "webpack";
-import * as WebpackDevServer from "webpack-dev-server";
+import os from "os";
+import webpack from "webpack";
+import WebpackDevServer from "webpack-dev-server";
 import { buildConfig } from "../../webpack.config";
 import type { Certificate } from "../ssl/ssl";
 import { createOrRetrieveCertificate } from "../ssl/ssl";
@@ -18,6 +19,22 @@ export const errorChalk = chalk.bgRed.bold;
 export const highlightChalk = chalk.greenBright.bold;
 export const linkChalk = chalk.cyan;
 
+/**
+ * Returns the appropriate modifier key text based on the user's operating system.
+ * @returns "cmd" for macOS, "ctrl" for Windows and Linux
+ */
+export function getModifierKey(): string {
+  const platform = os.platform();
+  switch (platform) {
+    case "darwin": // macOS
+      return "cmd";
+    case "win32": // Windows
+      return "ctrl";
+    default: // Linux and others
+      return "ctrl";
+  }
+}
+
 export class AppRunner {
   async run(ctx: Context) {
     console.log(
@@ -189,9 +206,14 @@ export class AppRunner {
       return;
     }
 
+    const modifierKey = getModifierKey();
+
     table.push([
       previewCellHeader,
-      { content: "Preview URL", href: generatePreviewResult.data },
+      {
+        content: `Preview URL (${modifierKey} + click)`,
+        href: generatePreviewResult.data,
+      },
     ]);
 
     if (openPreview) {

package/templates/dam/scripts/start/context.ts

@@ -1,5 +1,5 @@
-import * as fs from "fs";
-import * as path from "path";
+import fs from "fs";
+import path from "path";
 
 interface CliArgs {
   example?: string;

package/templates/dam/scripts/start/start.ts

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import * as yargs from "yargs";
+import yargs from "yargs";
 import { hideBin } from "yargs/helpers";
 import { AppRunner } from "./app_runner";
 import { Context } from "./context";

package/templates/dam/tsconfig.json

@@ -18,7 +18,8 @@
     "experimentalDecorators": true,
     "importHelpers": true,
     "noImplicitOverride": true,
-    "moduleResolution": "node",
+    "moduleResolution": "bundler",
+    "esModuleInterop": true,
     "rootDir": ".",
     "outDir": "dist",
     "strict": true,
@@ -27,7 +28,10 @@
     "sourceMap": true,
     "inlineSources": true,
     "module": "ESNext",
-    "noImplicitAny": false,
+    "noImplicitAny": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUncheckedIndexedAccess": true,
     "removeComments": true,
     "preserveConstEnums": true,
     "allowSyntheticDefaultImports": true,
@@ -43,8 +47,7 @@
     "./utils/**/*",
     "./scripts/**/*",
     "./declarations/declarations.d.ts",
-    "./styles/**/*",
-    "./node_modules/@types/**/*"
+    "./styles/**/*"
   ],
   "ts-node": {
     "compilerOptions": {

package/templates/dam/utils/backend/base_backend/create.ts

@@ -1,10 +1,10 @@
 /* eslint-disable no-console */
 import debug from "debug";
-import * as express from "express";
+import express from "express";
 import type { NextFunction, Request, Response } from "express";
-import * as fs from "fs";
-import * as http from "http";
-import * as https from "https";
+import fs from "fs";
+import http from "http";
+import https from "https";
 
 const serverDebug = debug("server");
 
@@ -41,12 +41,12 @@ export function createBaseServer(router: express.Router): BaseServer {
   app.disable("x-powered-by");
 
   // Health check endpoint
-  app.get("/healthz", (req, res: Response) => {
+  app.get("/healthz", (req, res) => {
     res.sendStatus(200);
   });
 
   // logging middleware
-  app.use((req: Request, res: Response, next: NextFunction) => {
+  app.use((req, _res, next) => {
     serverDebug(`${new Date().toISOString()}: ${req.method} ${req.url}`);
     next();
   });
@@ -62,7 +62,7 @@ export function createBaseServer(router: express.Router): BaseServer {
   });
 
   // default error handler
-  app.use((err, req, res, next) => {
+  app.use((err: Error, _req: Request, res: Response, _next: NextFunction) => {
     console.error(err.stack);
     res.status(500).send({
       error: "something went wrong",

package/templates/dam/utils/backend/jwt_middleware/jwt_middleware.ts

@@ -1,10 +1,7 @@
 /* eslint-disable no-console */
-import * as chalk from "chalk";
-import * as debug from "debug";
+import debug from "debug";
 import type { NextFunction, Request, Response } from "express";
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-import Express from "express-serve-static-core";
-import * as jwt from "jsonwebtoken";
+import jwt from "jsonwebtoken";
 import { JwksClient, SigningKeyNotFoundError } from "jwks-rsa";
 
 /**
@@ -116,7 +113,7 @@ export function createJwtMiddleware(
         userId: payload.userId,
       };
 
-      next();
+      return next();
     } catch (e) {
       if (e instanceof JWTAuthorizationError) {
         return sendUnauthorizedResponse(res, e.message);
@@ -125,9 +122,7 @@ export function createJwtMiddleware(
       if (e instanceof SigningKeyNotFoundError) {
         return sendUnauthorizedResponse(
           res,
-          `Public key not found. ${chalk.bgRedBright(
-            "Ensure you have the correct App_ID set",
-          )}.`,
+          `Public key not found. Ensure you have the correct App_ID set`,
         );
       }
 
@@ -139,7 +134,7 @@ export function createJwtMiddleware(
         return sendUnauthorizedResponse(res, "Token expired");
       }
 
-      next(e);
+      return next(e);
     }
   };
 }

package/templates/dam/webpack.config.ts

@@ -1,9 +1,9 @@
 import type { Configuration } from "webpack";
 import { DefinePlugin, optimize } from "webpack";
-import * as path from "path";
-import * as TerserPlugin from "terser-webpack-plugin";
+import path from "path";
+import TerserPlugin from "terser-webpack-plugin";
 import { transform } from "@formatjs/ts-transformer";
-import * as chalk from "chalk";
+import chalk from "chalk";
 import { config } from "dotenv";
 import { Configuration as DevServerConfiguration } from "webpack-dev-server";
 
@@ -196,7 +196,7 @@ function buildDevConfig(options?: DevConfig): {
     return {};
   }
 
-  const { port, enableHmr, appOrigin, appId, enableHttps, certFile, keyFile } =
+  const { port, enableHmr, appOrigin, enableHttps, certFile, keyFile } =
     options;
   const host = "localhost";
 

package/templates/data_connector/package.json

@@ -20,7 +20,7 @@
   },
   "dependencies": {
     "@canva/app-i18n-kit": "^1.1.1",
-    "@canva/app-ui-kit": "^5.2.0",
+    "@canva/app-ui-kit": "^5.2.1",
     "@canva/asset": "^2.2.1",
     "@canva/design": "^2.7.3",
     "@canva/error": "^2.1.0",
@@ -42,8 +42,8 @@
     "@pmmmwh/react-refresh-webpack-plugin": "0.6.1",
     "@svgr/webpack": "8.1.0",
     "@testing-library/react": "16.3.0",
+    "@types/debug": "4.1.12",
     "@types/express": "4.17.21",
-    "@types/express-serve-static-core": "5.0.7",
     "@types/jest": "29.5.14",
     "@types/jsonwebtoken": "9.0.10",
     "@types/node": "20.19.2",

package/templates/data_connector/scripts/copy_env.ts

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 /* eslint-disable no-console */
-import * as fs from "fs";
-import * as path from "path";
+import fs from "fs";
+import path from "path";
 
 const envPath = path.resolve(__dirname, "..", ".env");
 const templatePath = path.resolve(__dirname, "..", ".env.template");

package/templates/data_connector/scripts/ssl/ssl.ts

@@ -1,7 +1,7 @@
-import * as crypto from "crypto";
-import * as fs from "fs/promises";
+import crypto from "crypto";
+import fs from "fs/promises";
 import { pki } from "node-forge";
-import * as path from "path";
+import path from "path";
 
 const SSL_CERT_DIR = path.resolve(process.cwd(), "..", "..", ".ssl");
 const CERT_FILE = path.resolve(SSL_CERT_DIR, "certificate.pem");

package/templates/data_connector/scripts/start/app_runner.ts

@@ -1,12 +1,13 @@
 /* eslint-disable no-console */
 import { generatePreviewUrl } from "@canva/cli";
-import * as ngrok from "@ngrok/ngrok";
-import * as chalk from "chalk";
-import * as Table from "cli-table3";
-import * as nodemon from "nodemon";
+import ngrok from "@ngrok/ngrok";
+import chalk from "chalk";
+import Table from "cli-table3";
+import nodemon from "nodemon";
 import open from "open";
-import * as webpack from "webpack";
-import * as WebpackDevServer from "webpack-dev-server";
+import os from "os";
+import webpack from "webpack";
+import WebpackDevServer from "webpack-dev-server";
 import { buildConfig } from "../../webpack.config";
 import type { Certificate } from "../ssl/ssl";
 import { createOrRetrieveCertificate } from "../ssl/ssl";
@@ -18,6 +19,22 @@ export const errorChalk = chalk.bgRed.bold;
 export const highlightChalk = chalk.greenBright.bold;
 export const linkChalk = chalk.cyan;
 
+/**
+ * Returns the appropriate modifier key text based on the user's operating system.
+ * @returns "cmd" for macOS, "ctrl" for Windows and Linux
+ */
+export function getModifierKey(): string {
+  const platform = os.platform();
+  switch (platform) {
+    case "darwin": // macOS
+      return "cmd";
+    case "win32": // Windows
+      return "ctrl";
+    default: // Linux and others
+      return "ctrl";
+  }
+}
+
 export class AppRunner {
   async run(ctx: Context) {
     console.log(
@@ -189,9 +206,14 @@ export class AppRunner {
       return;
     }
 
+    const modifierKey = getModifierKey();
+
     table.push([
       previewCellHeader,
-      { content: "Preview URL", href: generatePreviewResult.data },
+      {
+        content: `Preview URL (${modifierKey} + click)`,
+        href: generatePreviewResult.data,
+      },
     ]);
 
     if (openPreview) {

package/templates/data_connector/scripts/start/context.ts

@@ -1,5 +1,5 @@
-import * as fs from "fs";
-import * as path from "path";
+import fs from "fs";
+import path from "path";
 
 interface CliArgs {
   example?: string;

package/templates/data_connector/scripts/start/start.ts

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import * as yargs from "yargs";
+import yargs from "yargs";
 import { hideBin } from "yargs/helpers";
 import { AppRunner } from "./app_runner";
 import { Context } from "./context";

package/templates/data_connector/src/utils/data_table.ts

@@ -12,7 +12,8 @@ import type { APIResponseItem } from "src/api";
 export interface DataTableColumn<T extends APIResponseItem> {
   label: string;
   getValue: keyof T | ((result: T) => boolean | string | number | Date);
-  toCell: (value) => DataTableCell;
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  toCell: (value: any) => DataTableCell;
 }
 
 export function toDataTable<T extends APIResponseItem>(

package/templates/data_connector/src/utils/tests/data_table.test.ts

@@ -92,8 +92,8 @@ describe("data table utils", () => {
     const result = toDataTable(testItems, columns, 10);
 
     // Check the custom column values
-    expect(result.rows[0].cells[5].value).toBe("Test Item 1 (42)");
-    expect(result.rows[1].cells[5].value).toBe("Test Item 2 (0)");
+    expect(result.rows[0]?.cells[5]?.value).toBe("Test Item 1 (42)");
+    expect(result.rows[1]?.cells[5]?.value).toBe("Test Item 2 (0)");
   });
 
   test("cell formatter functions create correct cell structures", () => {

package/templates/data_connector/tsconfig.json

@@ -18,7 +18,8 @@
     "experimentalDecorators": true,
     "importHelpers": true,
     "noImplicitOverride": true,
-    "moduleResolution": "node",
+    "moduleResolution": "bundler",
+    "esModuleInterop": true,
     "rootDir": ".",
     "outDir": "dist",
     "strict": true,
@@ -27,7 +28,10 @@
     "sourceMap": true,
     "inlineSources": true,
     "module": "ESNext",
-    "noImplicitAny": false,
+    "noImplicitAny": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUncheckedIndexedAccess": true,
     "removeComments": true,
     "preserveConstEnums": true,
     "allowSyntheticDefaultImports": true,
@@ -43,8 +47,7 @@
     "./utils/**/*",
     "./scripts/**/*",
     "./declarations/declarations.d.ts",
-    "./styles/**/*",
-    "./node_modules/@types/**/*"
+    "./styles/**/*"
   ],
   "ts-node": {
     "compilerOptions": {

package/templates/data_connector/webpack.config.ts

@@ -1,9 +1,9 @@
 import type { Configuration } from "webpack";
 import { DefinePlugin, optimize } from "webpack";
-import * as path from "path";
-import * as TerserPlugin from "terser-webpack-plugin";
+import path from "path";
+import TerserPlugin from "terser-webpack-plugin";
 import { transform } from "@formatjs/ts-transformer";
-import * as chalk from "chalk";
+import chalk from "chalk";
 import { config } from "dotenv";
 import { Configuration as DevServerConfiguration } from "webpack-dev-server";
 
@@ -196,7 +196,7 @@ function buildDevConfig(options?: DevConfig): {
     return {};
   }
 
-  const { port, enableHmr, appOrigin, appId, enableHttps, certFile, keyFile } =
+  const { port, enableHmr, appOrigin, enableHttps, certFile, keyFile } =
     options;
   const host = "localhost";
 

package/templates/gen_ai/backend/database/database.ts

@@ -1,5 +1,5 @@
-import * as fs from "fs/promises";
-import * as path from "path";
+import fs from "fs/promises";
+import path from "path";
 
 /**
  * This file creates a "database" out of a JSON file. It's only for

package/templates/gen_ai/backend/routers/image.ts

@@ -8,7 +8,7 @@
  * Use this code as a learning resource, but do not deploy it in a real backend without significant modifications
  * to ensure reliability, security, and scalability.
  */
-import * as express from "express";
+import express from "express";
 
 interface ImageResponse {
   fullsize: { width: number; height: number; url: string };
@@ -151,7 +151,7 @@ export const createImageRouter = () => {
     // Add the job to the jobQueue along with the timeoutId
     jobQueue.push({ jobId, prompt, timeoutId });
 
-    res.status(200).send({
+    return res.status(200).send({
       jobId,
     });
   });
@@ -208,15 +208,13 @@ export const createImageRouter = () => {
     }
 
     const index = jobQueue.findIndex((job) => job.jobId === jobId);
-    if (index !== -1) {
+    const job = jobQueue[index];
+    if (index !== -1 && job) {
       cancelledJobs.push({ jobId });
       // If the job is found, remove it from the jobQueue
-      const { timeoutId } = jobQueue[index];
       jobQueue.splice(index, 1);
       // Also clear the timeout associated with this job if it exists
-      if (timeoutId) {
-        clearTimeout(timeoutId);
-      }
+      clearTimeout(job.timeoutId);
       return res.status(200).send("Job successfully cancelled.");
     }
 

package/templates/gen_ai/backend/server.ts

@@ -1,5 +1,5 @@
-import * as cors from "cors";
-import * as express from "express";
+import cors from "cors";
+import express from "express";
 import { createBaseServer } from "../utils/backend/base_backend/create";
 import { createImageRouter } from "./routers/image";
 

package/templates/gen_ai/package.json

@@ -19,7 +19,7 @@
   },
   "dependencies": {
     "@canva/app-i18n-kit": "^1.1.1",
-    "@canva/app-ui-kit": "^5.2.0",
+    "@canva/app-ui-kit": "^5.2.1",
     "@canva/asset": "^2.2.1",
     "@canva/design": "^2.7.3",
     "@canva/error": "^2.1.0",
@@ -44,9 +44,9 @@
     "@pmmmwh/react-refresh-webpack-plugin": "0.6.1",
     "@svgr/webpack": "8.1.0",
     "@testing-library/react": "16.3.0",
+    "@types/cors": "2.8.19",
     "@types/debug": "4.1.12",
     "@types/express": "4.17.21",
-    "@types/express-serve-static-core": "5.0.7",
     "@types/jest": "29.5.14",
     "@types/jsonwebtoken": "9.0.10",
     "@types/node": "20.19.2",

package/templates/gen_ai/scripts/copy_env.ts

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 /* eslint-disable no-console */
-import * as fs from "fs";
-import * as path from "path";
+import fs from "fs";
+import path from "path";
 
 const envPath = path.resolve(__dirname, "..", ".env");
 const templatePath = path.resolve(__dirname, "..", ".env.template");

package/templates/gen_ai/scripts/ssl/ssl.ts

@@ -1,7 +1,7 @@
-import * as crypto from "crypto";
-import * as fs from "fs/promises";
+import crypto from "crypto";
+import fs from "fs/promises";
 import { pki } from "node-forge";
-import * as path from "path";
+import path from "path";
 
 const SSL_CERT_DIR = path.resolve(process.cwd(), "..", "..", ".ssl");
 const CERT_FILE = path.resolve(SSL_CERT_DIR, "certificate.pem");

package/templates/gen_ai/scripts/start/app_runner.ts

@@ -1,12 +1,13 @@
 /* eslint-disable no-console */
 import { generatePreviewUrl } from "@canva/cli";
-import * as ngrok from "@ngrok/ngrok";
-import * as chalk from "chalk";
-import * as Table from "cli-table3";
-import * as nodemon from "nodemon";
+import ngrok from "@ngrok/ngrok";
+import chalk from "chalk";
+import Table from "cli-table3";
+import nodemon from "nodemon";
 import open from "open";
-import * as webpack from "webpack";
-import * as WebpackDevServer from "webpack-dev-server";
+import os from "os";
+import webpack from "webpack";
+import WebpackDevServer from "webpack-dev-server";
 import { buildConfig } from "../../webpack.config";
 import type { Certificate } from "../ssl/ssl";
 import { createOrRetrieveCertificate } from "../ssl/ssl";
@@ -18,6 +19,22 @@ export const errorChalk = chalk.bgRed.bold;
 export const highlightChalk = chalk.greenBright.bold;
 export const linkChalk = chalk.cyan;
 
+/**
+ * Returns the appropriate modifier key text based on the user's operating system.
+ * @returns "cmd" for macOS, "ctrl" for Windows and Linux
+ */
+export function getModifierKey(): string {
+  const platform = os.platform();
+  switch (platform) {
+    case "darwin": // macOS
+      return "cmd";
+    case "win32": // Windows
+      return "ctrl";
+    default: // Linux and others
+      return "ctrl";
+  }
+}
+
 export class AppRunner {
   async run(ctx: Context) {
     console.log(
@@ -189,9 +206,14 @@ export class AppRunner {
       return;
     }
 
+    const modifierKey = getModifierKey();
+
     table.push([
       previewCellHeader,
-      { content: "Preview URL", href: generatePreviewResult.data },
+      {
+        content: `Preview URL (${modifierKey} + click)`,
+        href: generatePreviewResult.data,
+      },
     ]);
 
     if (openPreview) {

package/templates/gen_ai/scripts/start/context.ts

@@ -1,5 +1,5 @@
-import * as fs from "fs";
-import * as path from "path";
+import fs from "fs";
+import path from "path";
 
 interface CliArgs {
   example?: string;

package/templates/gen_ai/scripts/start/start.ts

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import * as yargs from "yargs";
+import yargs from "yargs";
 import { hideBin } from "yargs/helpers";
 import { AppRunner } from "./app_runner";
 import { Context } from "./context";

package/templates/gen_ai/src/components/image_grid.tsx

@@ -34,7 +34,9 @@ export const ImageGrid = () => {
   ) => {
     const parentNode = event.currentTarget.parentElement;
     try {
-      parentNode?.classList.add(styles.hidden);
+      if (styles.hidden) {
+        parentNode?.classList.add(styles.hidden);
+      }
 
       await ui.startDragToPoint(event, {
         type: "image",
@@ -50,7 +52,9 @@ export const ImageGrid = () => {
         },
       });
     } finally {
-      parentNode?.classList.remove(styles.hidden);
+      if (styles.hidden) {
+        parentNode?.classList.remove(styles.hidden);
+      }
     }
   };
 

package/templates/gen_ai/src/components/prompt_input.tsx

@@ -59,8 +59,11 @@ const generateExamplePrompt = (currentPrompt: string): string => {
   const MAX_ATTEMPTS = 3;
 
   while (currentPrompt === newPrompt && attempts < MAX_ATTEMPTS) {
-    newPrompt =
+    const randomPrompt =
       examplePrompts[Math.floor(Math.random() * examplePrompts.length)];
+    if (randomPrompt) {
+      newPrompt = randomPrompt;
+    }
     attempts++;
   }