@canva/cli 1.10.0 → 1.12.0

package/templates/base/utils/backend/bearer_middleware/tests/bearer_middleware.tests.ts

@@ -1,192 +0,0 @@
-/* eslint-disable @typescript-eslint/no-require-imports */
-import type { NextFunction, Request, Response } from "express";
-import type {
-  createBearerMiddleware,
-  GetTokenFromRequest,
-} from "../bearer_middleware";
-
-type Middleware = (req: Request, res: Response, next: NextFunction) => void;
-
-describe("createBearerMiddleware", () => {
-  let fakeGetTokenFromRequest: jest.MockedFn<GetTokenFromRequest>;
-  let verify: jest.MockedFn<(token: string) => Promise<string | undefined>>;
-
-  let req: Request;
-  let res: Response;
-  let next: jest.MockedFn<() => void>;
-
-  let AuthorizationError: typeof Error;
-  let createBearerMiddlewareFn: typeof createBearerMiddleware;
-  let bearerMiddleware: Middleware;
-
-  beforeEach(() => {
-    jest.resetAllMocks();
-    jest.resetModules();
-
-    fakeGetTokenFromRequest = jest.fn();
-    verify = jest.fn();
-
-    const middlewareModule = require("../bearer_middleware");
-    createBearerMiddlewareFn = middlewareModule.createBearerMiddleware;
-    AuthorizationError = middlewareModule.AuthorizationError;
-  });
-
-  describe("When called", () => {
-    beforeEach(() => {
-      req = {
-        header: (_name: string) => undefined,
-      } as Request;
-
-      res = {
-        status: jest.fn().mockReturnThis(),
-        json: jest.fn().mockReturnThis(),
-        send: jest.fn().mockReturnThis(),
-      } as unknown as Response;
-
-      next = jest.fn();
-
-      bearerMiddleware = createBearerMiddlewareFn(
-        verify,
-        fakeGetTokenFromRequest,
-      );
-    });
-
-    describe("When `getTokenFromRequest` throws an exception ('Fake error')", () => {
-      beforeEach(() => {
-        fakeGetTokenFromRequest.mockRejectedValue(
-          new AuthorizationError("Fake error"),
-        );
-      });
-
-      it(`Does not call next() and returns HTTP 401 with error = "unauthorized" and message = "Fake error"`, async () => {
-        expect.assertions(8);
-
-        expect(fakeGetTokenFromRequest).not.toHaveBeenCalled();
-        await bearerMiddleware(req, res, next);
-
-        expect(fakeGetTokenFromRequest).toHaveBeenCalledTimes(1);
-        expect(fakeGetTokenFromRequest).toHaveBeenLastCalledWith(req);
-
-        expect(res.status).toHaveBeenCalledTimes(1);
-        expect(res.status).toHaveBeenLastCalledWith(401);
-
-        expect(res.json).toHaveBeenCalledTimes(1);
-        expect(res.json).toHaveBeenLastCalledWith({
-          error: "unauthorized",
-          message: "Fake error",
-        });
-
-        expect(next).not.toHaveBeenCalled();
-      });
-    });
-
-    describe("When the middleware cannot verify the token", () => {
-      beforeEach(() => {
-        fakeGetTokenFromRequest.mockReturnValue("TOKEN");
-
-        verify.mockImplementation(() => Promise.resolve(undefined));
-      });
-
-      it(`Does not call next() and returns HTTP 401 with error = "unauthorized" and message = "Token is invalid"`, async () => {
-        expect.assertions(5);
-
-        await bearerMiddleware(req, res, next);
-
-        expect(res.status).toHaveBeenCalledTimes(1);
-        expect(res.status).toHaveBeenLastCalledWith(401);
-
-        expect(res.json).toHaveBeenCalledTimes(1);
-        expect(res.json).toHaveBeenLastCalledWith({
-          error: "unauthorized",
-          message: "Token is invalid",
-        });
-
-        expect(next).not.toHaveBeenCalled();
-      });
-    });
-  });
-});
-
-describe("getTokenFromHttpHeader", () => {
-  let getHeader: jest.MockedFn<(name: string) => string | undefined>;
-  let req: Request;
-  let getTokenFromHttpHeader: (req: Request) => string;
-  let AuthorizationError: typeof Error;
-
-  beforeEach(() => {
-    getHeader = jest.fn();
-    req = {
-      header: (name: string) => getHeader(name),
-    } as Request;
-
-    const bearerMiddlewareModule = require("../bearer_middleware");
-    getTokenFromHttpHeader = bearerMiddlewareModule.getTokenFromHttpHeader;
-    AuthorizationError = bearerMiddlewareModule.AuthorizationError;
-  });
-
-  describe("When the 'Authorization' header is missing", () => {
-    beforeEach(() => {
-      getHeader.mockReturnValue(undefined);
-    });
-
-    it(`Throws a AuthorizationError with message = 'Missing the "Authorization" header'`, async () => {
-      expect.assertions(3);
-
-      expect(() => getTokenFromHttpHeader(req)).toThrow(
-        new AuthorizationError('Missing the "Authorization" header'),
-      );
-      expect(getHeader).toHaveBeenCalledTimes(1);
-      expect(getHeader).toHaveBeenLastCalledWith("Authorization");
-    });
-  });
-
-  describe("When the 'Authorization' header doesn't have a Bearer scheme", () => {
-    beforeEach(() => {
-      getHeader.mockReturnValue("Beerer FAKE_TOKEN");
-    });
-
-    it(`Throws a AuthorizationError with message = 'Missing a "Bearer" token in the "Authorization" header''`, async () => {
-      expect.assertions(3);
-
-      expect(() => getTokenFromHttpHeader(req)).toThrow(
-        new AuthorizationError(
-          'Missing a "Bearer" token in the "Authorization" header',
-        ),
-      );
-      expect(getHeader).toHaveBeenCalledTimes(1);
-      expect(getHeader).toHaveBeenLastCalledWith("Authorization");
-    });
-  });
-
-  describe("When the 'Authorization' Bearer scheme header doesn't have a token", () => {
-    beforeEach(() => {
-      getHeader.mockReturnValue("Bearer ");
-    });
-
-    it(`Throws a AuthorizationError with message = 'Missing a "Bearer" token in the "Authorization" header'`, async () => {
-      expect.assertions(3);
-
-      expect(() => getTokenFromHttpHeader(req)).toThrow(
-        new AuthorizationError(
-          'Missing a "Bearer" token in the "Authorization" header',
-        ),
-      );
-      expect(getHeader).toHaveBeenCalledTimes(1);
-      expect(getHeader).toHaveBeenLastCalledWith("Authorization");
-    });
-  });
-
-  describe("When the 'Authorization' Bearer scheme header has a token", () => {
-    beforeEach(() => {
-      getHeader.mockReturnValue("Bearer TOKEN");
-    });
-
-    it(`Returns the token`, async () => {
-      expect.assertions(3);
-
-      expect(getTokenFromHttpHeader(req)).toEqual("TOKEN");
-      expect(getHeader).toHaveBeenCalledTimes(1);
-      expect(getHeader).toHaveBeenLastCalledWith("Authorization");
-    });
-  });
-});

package/templates/base/utils/use_add_element.ts

@@ -1,58 +0,0 @@
-import type {
-  EmbedElement,
-  ImageElement,
-  RichtextElement,
-  TableElement,
-  TextElement,
-  VideoElement,
-} from "@canva/design";
-import { addElementAtCursor, addElementAtPoint } from "@canva/design";
-import { features } from "@canva/platform";
-import { useEffect, useState } from "react";
-import { useFeatureSupport } from "./use_feature_support";
-
-type AddElementParams =
-  | ImageElement
-  | VideoElement
-  | EmbedElement
-  | TextElement
-  | RichtextElement
-  | TableElement;
-
-export const useAddElement = () => {
-  const isSupported = useFeatureSupport();
-
-  // Store a wrapped addElement function that checks feature support
-  const [addElement, setAddElement] = useState(() => {
-    return (element: AddElementParams) => {
-      if (features.isSupported(addElementAtPoint)) {
-        return addElementAtPoint(element);
-      } else if (features.isSupported(addElementAtCursor)) {
-        return addElementAtCursor(element);
-      }
-      // eslint-disable-next-line no-console
-      console.warn(
-        "Neither addElementAtPoint nor addElementAtCursor are supported",
-      );
-      return Promise.resolve();
-    };
-  });
-
-  useEffect(() => {
-    const addElement = (element: AddElementParams) => {
-      if (isSupported(addElementAtPoint)) {
-        return addElementAtPoint(element);
-      } else if (isSupported(addElementAtCursor)) {
-        return addElementAtCursor(element);
-      }
-      // eslint-disable-next-line no-console
-      console.warn(
-        "Neither addElementAtPoint nor addElementAtCursor are supported",
-      );
-      return Promise.resolve();
-    };
-    setAddElement(() => addElement);
-  }, [isSupported]);
-
-  return addElement;
-};

package/templates/base/utils/use_feature_support.ts

@@ -1,28 +0,0 @@
-import { features } from "@canva/platform";
-import type { Feature } from "@canva/platform";
-import { useEffect, useState } from "react";
-
-/**
- * This hook allows re-rendering of a React component whenever
- * the state of feature support changes in Canva.
- *
- * @returns isSupported - callback to inspect a Canva SDK method.
- **/
-export function useFeatureSupport() {
-  // Store a wrapped function that checks feature support
-  const [isSupported, setIsSupported] = useState(() => {
-    return (...args: Feature[]) => features.isSupported(...args);
-  });
-
-  useEffect(() => {
-    // create new function ref when feature support changes to trigger
-    // re-render
-    return features.registerOnSupportChange(() => {
-      setIsSupported(() => {
-        return (...args: Feature[]) => features.isSupported(...args);
-      });
-    });
-  }, []);
-
-  return isSupported;
-}

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

@@ -1,104 +0,0 @@
-/* eslint-disable no-console */
-import debug from "debug";
-import express from "express";
-import type { NextFunction, Request, Response } from "express";
-import fs from "fs";
-import http from "http";
-import https from "https";
-
-const serverDebug = debug("server");
-
-interface BaseServer {
-  app: express.Express;
-
-  /**
-   * Starts the server on the address or port provided
-   * @param address port number or string address or if left undefined express defaults to port 3000
-   */
-  start: (address: number | string | undefined) => void;
-}
-
-/**
- * createBaseServer instantiates a customised express server with:
- * - json body handling
- * - health check endpoint
- * - catchall endpoint
- * - error handler catch route
- * - process termination handling
- * - debug logging - prefix starting your server with `DEBUG=server npm run XXX`
- *
- * @returns BaseServer object containing the express app and a start function
- */
-export function createBaseServer(router: express.Router): BaseServer {
-  const SHOULD_ENABLE_HTTPS = process.env?.SHOULD_ENABLE_HTTPS === "true";
-  const HTTPS_CERT_FILE = process.env?.HTTPS_CERT_FILE;
-  const HTTPS_KEY_FILE = process.env?.HTTPS_KEY_FILE;
-
-  const app = express();
-  app.use(express.json());
-
-  // It can help to provide an extra layer of obsecurity to reduce server fingerprinting.
-  app.disable("x-powered-by");
-
-  // Health check endpoint
-  app.get("/healthz", (req, res) => {
-    res.sendStatus(200);
-  });
-
-  // logging middleware
-  app.use((req, _res, next) => {
-    serverDebug(`${new Date().toISOString()}: ${req.method} ${req.url}`);
-    next();
-  });
-
-  // Custom routes router
-  app.use(router);
-
-  // catch all router
-  app.all("*", (req, res) => {
-    res.status(404).send({
-      error: `unhandled '${req.method}' on '${req.url}'`,
-    });
-  });
-
-  // default error handler
-  app.use((err: Error, _req: Request, res: Response, _next: NextFunction) => {
-    console.error(err.stack);
-    res.status(500).send({
-      error: "something went wrong",
-    });
-  });
-
-  let server;
-  if (SHOULD_ENABLE_HTTPS) {
-    if (!HTTPS_CERT_FILE || !HTTPS_KEY_FILE) {
-      throw new Error(
-        "Looks like you're running the example with --use-https flag, but SSL certificates haven't been generated. Please remove the .ssl/ folder and re-run the command again.",
-      );
-    }
-
-    server = https.createServer(
-      {
-        key: fs.readFileSync(HTTPS_KEY_FILE),
-        cert: fs.readFileSync(HTTPS_CERT_FILE),
-      },
-      app,
-    );
-  } else {
-    server = http.createServer(app);
-  }
-
-  return {
-    app,
-    start: (address: number | string | undefined) => {
-      console.log(`Listening on '${address}'`);
-      server.listen(address);
-      process.on("SIGTERM", () => {
-        serverDebug("SIGTERM signal received: closing HTTP server");
-        server.close(() => {
-          serverDebug("HTTP server closed");
-        });
-      });
-    },
-  };
-}