@canva/cli 0.0.1-beta.3 → 0.0.1-beta.5

package/templates/gen_ai/src/api/api.ts

@@ -1,4 +1,3 @@
-import type { Oauth } from "@canva/user";
 import { POLLING_INTERVAL_IN_SECONDS } from "src/config";
 
 /**
@@ -41,22 +40,12 @@ interface RemainingCreditsResult {
   credits: number;
 }
 
-/**
- * Represents the result of retrieving the logged in status of the user.
- */
-export type LoggedInState =
-  | "authenticated"
-  | "not_authenticated"
-  | "checking"
-  | "error";
-
 const endpoints = {
   queueImageGeneration: "/api/queue-image-generation",
   getImageGenerationJobStatus: "/api/job-status",
   cancelImageGenerationJob: "/api/job-status/cancel",
   getRemainingCredits: "/api/credits",
   purchaseCredits: "/api/purchase-credits",
-  getLoggedInStatus: "/api/authentication/status",
 };
 
 /**
@@ -66,21 +55,18 @@ const endpoints = {
  * @param {number} options.numberOfImages - The number of images to generate.
  * @returns {Promise<QueueImageGenerationResponse>} A promise that resolves to the created job ID.
  */
-export const queueImageGeneration = async (
-  {
-    prompt,
-    numberOfImages,
-  }: {
-    prompt: string;
-    numberOfImages: number;
-  },
-  oauth: Oauth,
-): Promise<QueueImageGenerationResponse> => {
+export const queueImageGeneration = async ({
+  prompt,
+  numberOfImages,
+}: {
+  prompt: string;
+  numberOfImages: number;
+}): Promise<QueueImageGenerationResponse> => {
   const url = new URL(endpoints.queueImageGeneration, BACKEND_HOST);
   url.searchParams.append("count", numberOfImages.toString());
   url.searchParams.append("prompt", prompt);
 
-  const result: QueueImageGenerationResponse = await sendRequest(url, oauth);
+  const result: QueueImageGenerationResponse = await sendRequest(url);
 
   return result;
 };
@@ -90,14 +76,11 @@ export const queueImageGeneration = async (
  * @param {string} jobId - The ID of the job to retrieve status for.
  * @returns {Promise<ImageGenerationResult>} A promise that resolves to the image generation result.
  */
-export const getImageGenerationJobStatus = async (
-  {
-    jobId,
-  }: {
-    jobId: string;
-  },
-  oauth: Oauth,
-): Promise<ImageGenerationResult> => {
+export const getImageGenerationJobStatus = async ({
+  jobId,
+}: {
+  jobId: string;
+}): Promise<ImageGenerationResult> => {
   const url = new URL(endpoints.getImageGenerationJobStatus, BACKEND_HOST);
   url.searchParams.append("jobId", jobId);
 
@@ -109,7 +92,6 @@ export const getImageGenerationJobStatus = async (
     try {
       const response = (await sendRequest(
         url,
-        oauth,
       )) as ImageGenerationJobStatusResponse;
       if (response.status === "completed") {
         return { images: response.images, credits: response.credits };
@@ -138,13 +120,12 @@ export const getImageGenerationJobStatus = async (
  */
 export const cancelImageGenerationJob = async (
   jobId: string,
-  oauth: Oauth,
 ): Promise<void> => {
   const url = new URL(endpoints.cancelImageGenerationJob, BACKEND_HOST);
   url.searchParams.append("jobId", jobId);
 
   try {
-    await sendRequest(url, oauth, {
+    await sendRequest(url, {
       method: "POST",
     });
   } catch {
@@ -156,26 +137,23 @@ export const cancelImageGenerationJob = async (
  * Retrieves the remaining credits.
  * @returns {Promise<RemainingCreditsResult>} - A promise that resolves to the remaining credits.
  */
-export const getRemainingCredits = async (
-  oauth: Oauth,
-): Promise<RemainingCreditsResult> => {
-  const url = new URL(endpoints.getRemainingCredits, BACKEND_HOST);
+export const getRemainingCredits =
+  async (): Promise<RemainingCreditsResult> => {
+    const url = new URL(endpoints.getRemainingCredits, BACKEND_HOST);
 
-  const result: RemainingCreditsResult = await sendRequest(url, oauth);
+    const result: RemainingCreditsResult = await sendRequest(url);
 
-  return result;
-};
+    return result;
+  };
 
 /**
  * Purchases credits for the user.
  * @returns {Promise<RemainingCreditsResult>} - A promise that resolves to the remaining credits after purchasing.
  */
-export const purchaseCredits = async (
-  oauth: Oauth,
-): Promise<RemainingCreditsResult> => {
+export const purchaseCredits = async (): Promise<RemainingCreditsResult> => {
   const url = new URL(endpoints.purchaseCredits, BACKEND_HOST);
 
-  const result: RemainingCreditsResult = await sendRequest(url, oauth, {
+  const result: RemainingCreditsResult = await sendRequest(url, {
     method: "POST",
   });
 
@@ -183,48 +161,15 @@ export const purchaseCredits = async (
 };
 
 /**
- * Send a request to an endpoint that checks if the user is authenticated.
- * This is example code, intended to convey the basic idea. When implementing this in your app, you might want more advanced checks.
- *
- * Note: You must register the provided endpoint via the Developer Portal.
- */
-export const checkAuthenticationStatus = async (
-  oauth: Oauth,
-): Promise<LoggedInState> => {
-  try {
-    const url = new URL(endpoints.getLoggedInStatus, BACKEND_HOST);
-    const result: { isAuthenticated: string } = await sendRequest(url, oauth, {
-      method: "POST",
-    });
-
-    if (result?.isAuthenticated) {
-      return "authenticated";
-    } else {
-      return "not_authenticated";
-    }
-  } catch (error) {
-    // eslint-disable-next-line no-console
-    console.error(error);
-    return "error";
-  }
-};
-
-/**
- * Sends a request to the specified URL with authorization headers.
+ * Sends a request to the specified URL.
  * @param {URL} url - The URL to send the request to.
  * @param {RequestInit} [options] - Optional fetch options to be passed to the fetch function.
  * @returns {Promise<Object>} - A promise that resolves to the response body.
  */
-const sendRequest = async <T>(
-  url: URL,
-  oauth: Oauth,
-  options?: RequestInit,
-): Promise<T> => {
-  const token = (await oauth.getAccessToken())?.token;
+const sendRequest = async <T>(url: URL, options?: RequestInit): Promise<T> => {
   const res = await fetch(url, {
     headers: {
       ...options?.headers,
-      Authorization: `Bearer ${token}`,
     },
     ...options,
   });

package/templates/gen_ai/src/components/footer.messages.ts

@@ -11,11 +11,6 @@ export const FooterMessages = defineMessages({
     defaultMessage: "Generate image",
     description: "A button label to generate an image from a prompt",
   },
-  signUpOrLogin: {
-    defaultMessage: "Sign up or log in to generate",
-    description:
-      "A button label to sign up or log in, before the user is able to generate an image",
-  },
   purchaseMoreCredits: {
     defaultMessage: "Purchase more credits",
     description:

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

@@ -1,11 +1,10 @@
 import { useNavigate, useLocation } from "react-router-dom";
 import { Rows, Button } from "@canva/app-ui-kit";
 import { queueImageGeneration, purchaseCredits } from "src/api";
-import { LoggedInStatus, RemainingCredits } from "src/components";
+import { RemainingCredits } from "src/components";
 import { NUMBER_OF_IMAGES_TO_GENERATE } from "src/config";
 import { useAppContext } from "src/context";
 import { Paths } from "src/routes";
-import { useAuth } from "src/services";
 import { getObsceneWords } from "src/utils";
 import { useIntl } from "react-intl";
 import { FooterMessages as Messages } from "./footer.messages";
@@ -13,10 +12,8 @@ import { FooterMessages as Messages } from "./footer.messages";
 export const Footer = () => {
   const navigate = useNavigate();
   const { pathname } = useLocation();
-  const { requestAuthentication } = useAuth();
   const isRootRoute = pathname === Paths.HOME;
   const {
-    loggedInState,
     setAppError,
     promptInput,
     setPromptInput,
@@ -27,7 +24,6 @@ export const Footer = () => {
     setIsLoadingImages,
     remainingCredits,
     setRemainingCredits,
-    oauth,
   } = useAppContext();
   const intl = useIntl();
 
@@ -75,13 +71,10 @@ export const Footer = () => {
 
     setIsLoadingImages(true);
     try {
-      const { jobId } = await queueImageGeneration(
-        {
-          prompt: promptInput,
-          numberOfImages: NUMBER_OF_IMAGES_TO_GENERATE,
-        },
-        oauth,
-      );
+      const { jobId } = await queueImageGeneration({
+        prompt: promptInput,
+        numberOfImages: NUMBER_OF_IMAGES_TO_GENERATE,
+      });
 
       setJobId(jobId);
     } catch {
@@ -90,12 +83,8 @@ export const Footer = () => {
     navigate(Paths.RESULTS);
   };
 
-  const onSignUpOrLogInClick = async () => {
-    await requestAuthentication();
-  };
-
   const onPurchaseMoreCredits = async () => {
-    const { credits } = await purchaseCredits(oauth);
+    const { credits } = await purchaseCredits();
 
     setRemainingCredits(credits);
   };
@@ -114,17 +103,11 @@ export const Footer = () => {
         : intl.formatMessage(Messages.generateAgain),
       visible: hasRemainingCredits,
     },
-    {
-      variant: "primary" as const,
-      onClick: onSignUpOrLogInClick,
-      value: intl.formatMessage(Messages.signUpOrLogin),
-      visible: loggedInState === "not_authenticated" && !hasRemainingCredits,
-    },
     {
       variant: "primary" as const,
       onClick: onPurchaseMoreCredits,
       value: intl.formatMessage(Messages.purchaseMoreCredits),
-      visible: loggedInState === "authenticated" && !hasRemainingCredits,
+      visible: !hasRemainingCredits,
     },
     {
       variant: "secondary" as const,
@@ -155,7 +138,6 @@ export const Footer = () => {
           ),
       )}
       <RemainingCredits />
-      <LoggedInStatus />
     </Rows>
   );
 };

package/templates/gen_ai/src/components/index.ts

@@ -2,7 +2,6 @@ export * from "./app_error";
 export * from "./footer";
 export * from "./image_grid";
 export * from "./loading_results";
-export * from "./logged_in_status";
 export * from "./prompt_input";
 export * from "./report_box";
 export * from "./remaining_credits";

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

@@ -70,7 +70,6 @@ export const LoadingResults = ({
     promptInput,
     setGeneratedImages,
     setRemainingCredits,
-    oauth,
   } = useAppContext();
 
   useEffect(() => {
@@ -83,12 +82,9 @@ export const LoadingResults = ({
     const pollJobStatus = async () => {
       if (jobId) {
         try {
-          const { images, credits } = await getImageGenerationJobStatus(
-            {
-              jobId,
-            },
-            oauth,
-          );
+          const { images, credits } = await getImageGenerationJobStatus({
+            jobId,
+          });
           setGeneratedImages(images);
           setRemainingCredits(credits);
           // Clear the jobId after fetching images
@@ -121,7 +117,7 @@ export const LoadingResults = ({
   ]);
 
   const onCancelClick = async () => {
-    await cancelImageGenerationJob(jobId, oauth);
+    await cancelImageGenerationJob(jobId);
     setIsLoadingImages(false);
     navigate(Paths.HOME);
   };

package/templates/gen_ai/src/context/app_context.tsx

@@ -1,14 +1,10 @@
 import { createContext, useEffect, useState } from "react";
 import { useIntl } from "react-intl";
-import type { ImageType, LoggedInState } from "src/api";
-import { checkAuthenticationStatus, getRemainingCredits } from "src/api";
+import type { ImageType } from "src/api";
+import { getRemainingCredits } from "src/api";
 import { ContextMessages as Messages } from "./context.messages";
-import type { Oauth } from "@canva/user";
-import { auth } from "@canva/user";
 
 export interface AppContextType {
-  loggedInState: LoggedInState;
-  setLoggedInState: (value: LoggedInState) => void;
   appError: string;
   setAppError: (value: string) => void;
   creditsError: string;
@@ -27,12 +23,9 @@ export interface AppContextType {
   setPromptInputError: (value: string) => void;
   generatedImages: ImageType[];
   setGeneratedImages: (value: ImageType[]) => void;
-  oauth: Oauth;
 }
 
 export const AppContext = createContext<AppContextType>({
-  loggedInState: "not_authenticated",
-  setLoggedInState: () => {},
   appError: "",
   setAppError: () => {},
   creditsError: "",
@@ -51,7 +44,6 @@ export const AppContext = createContext<AppContextType>({
   setPromptInputError: () => {},
   generatedImages: [] as ImageType[],
   setGeneratedImages: () => {},
-  oauth: {} as Oauth,
 });
 
 /**
@@ -69,8 +61,6 @@ export const ContextProvider = ({
 }: {
   children: React.ReactNode;
 }): JSX.Element => {
-  const [loggedInState, setLoggedInState] =
-    useState<LoggedInState>("not_authenticated");
   const [appError, setAppError] = useState<string>("");
   const [loadingApp, setLoadingApp] = useState<boolean>(true); // set to true to prevent ui flash on load
   const [isLoadingImages, setIsLoadingImages] = useState<boolean>(false);
@@ -81,7 +71,6 @@ export const ContextProvider = ({
   const [generatedImages, setGeneratedImages] = useState<ImageType[]>([]);
   const [creditsError, setCreditsError] = useState<string>("");
   const intl = useIntl();
-  const oauth = auth.initOauth();
 
   // Fetches initial data on component mount
   useEffect(() => {
@@ -91,7 +80,7 @@ export const ContextProvider = ({
 
         // Fetch remaining credits
         try {
-          const { credits } = await getRemainingCredits(oauth);
+          const { credits } = await getRemainingCredits();
           setRemainingCredits(credits);
         } catch (error) {
           setAppError(
@@ -100,17 +89,6 @@ export const ContextProvider = ({
           // eslint-disable-next-line no-console
           console.error("Error fetching remaining credits:", error);
         }
-
-        // Fetch login status
-        try {
-          checkAuthenticationStatus(oauth);
-        } catch (error) {
-          setAppError(
-            intl.formatMessage(Messages.appErrorGetLoggedInStatusFailed),
-          );
-          // eslint-disable-next-line no-console
-          console.error("Error fetching login status:", error);
-        }
       } catch (error) {
         setAppError(intl.formatMessage(Messages.appErrorGeneral));
         // eslint-disable-next-line no-console
@@ -130,13 +108,10 @@ export const ContextProvider = ({
       return;
     }
 
-    const errorMessage =
-      loggedInState === "authenticated"
-        ? intl.formatMessage(Messages.alertNotEnoughCreditsLoggedIn)
-        : intl.formatMessage(Messages.alertNotEnoughCreditsLoggedOut);
+    const errorMessage = intl.formatMessage(Messages.alertNotEnoughCredits);
 
     setCreditsError(errorMessage);
-  }, [loadingApp, remainingCredits, loggedInState]);
+  }, [loadingApp, remainingCredits]);
 
   const setPromptInputHandler = (value: string) => {
     if (
@@ -153,8 +128,6 @@ export const ContextProvider = ({
   };
 
   const value: AppContextType = {
-    loggedInState,
-    setLoggedInState,
     appError,
     setAppError,
     creditsError,
@@ -173,7 +146,6 @@ export const ContextProvider = ({
     setPromptInputError,
     generatedImages,
     setGeneratedImages,
-    oauth,
   };
 
   return <AppContext.Provider value={value}>{children}</AppContext.Provider>;

package/templates/gen_ai/src/context/context.messages.ts

@@ -12,11 +12,6 @@ export const ContextMessages = defineMessages({
     description:
       "A message to indicate that there was a failure to get the number of credits the user has",
   },
-  appErrorGetLoggedInStatusFailed: {
-    defaultMessage: "Retrieving logged in status has failed.",
-    description:
-      "A message to indicate that due to an unexpected problem, the app was unable to determine if the user is logged in",
-  },
 
   /** Messages related to prompts and user input validation. */
   promptMissingErrorMessage: {
@@ -26,16 +21,10 @@ export const ContextMessages = defineMessages({
   },
 
   /** Messages related to credits, including their availability and purchasing options. */
-  alertNotEnoughCreditsLoggedIn: {
+  alertNotEnoughCredits: {
     defaultMessage:
       "You don’t have enough credits left to generate an image. Please purchase more.",
     description:
       "A message to indicate that the user doesn't have enough credits to generate an image, and will need to buy more to continue",
   },
-  alertNotEnoughCreditsLoggedOut: {
-    defaultMessage:
-      "You don’t have enough credits left to generate an image. Please sign up or log in to purchase more.",
-    description:
-      "A message to indicate that the user doesn't have enough credits to generate an image, and will need to sign up or log in to buy more",
-  },
 });

package/templates/hello_world/eslint.config.mjs

@@ -20,8 +20,6 @@ export default [
       "**/dist",
       "**/*.d.ts",
       "**/*.d.tsx",
-      "**/sdk",
-      "**/internal",
       "**/*.config.*",
     ],
   },

package/templates/hello_world/package.json

@@ -3,7 +3,7 @@
   "name": "empty-template",
   "description": "An empty Canva App",
   "scripts": {
-    "extract": "formatjs extract 'src/**/*.{ts,tsx}' --out-file dist/messages_en.json",
+    "extract": "formatjs extract src/**/*.{ts,tsx} --out-file dist/messages_en.json",
     "build": "webpack --config webpack.config.cjs --mode production && npm run extract",
     "format": "prettier '**/*.{css,ts,tsx}' --no-config --write",
     "format:check": "prettier '**/*.{css,ts,tsx}' --no-config --check --ignore-path",
@@ -16,8 +16,8 @@
     "test:watch": "jest --watchAll"
   },
   "dependencies": {
-    "@canva/app-ui-kit": "^4.0.0",
-    "@canva/app-i18n-kit": "^0.0.1-beta.5",
+    "@canva/app-ui-kit": "^4.2.0",
+    "@canva/app-i18n-kit": "^1.0.0",
     "@canva/design": "^2.1.0",
     "@canva/platform": "^2.0.0",
     "@canva/error": "^2.0.0",
@@ -27,32 +27,32 @@
   },
   "devDependencies": {
     "@eslint/eslintrc": "3.1.0",
-    "@eslint/js": "9.9.0",
+    "@eslint/js": "9.12.0",
     "@formatjs/cli": "6.2.12",
     "@formatjs/ts-transformer": "3.13.14",
     "@ngrok/ngrok": "1.4.1",
     "@svgr/webpack": "8.1.0",
-    "@types/jest": "29.5.12",
+    "@types/jest": "29.5.13",
     "@types/node": "20.10.0",
     "@types/node-fetch": "2.6.11",
     "@types/node-forge": "1.3.11",
     "@types/nodemon": "1.19.6",
-    "@types/react": "18.3.4",
-    "@types/react-dom": "18.3.0",
+    "@types/react": "18.3.11",
+    "@types/react-dom": "18.3.1",
     "@types/webpack-env": "1.18.5",
-    "@typescript-eslint/eslint-plugin": "8.2.0",
-    "@typescript-eslint/parser": "8.2.0",
+    "@typescript-eslint/eslint-plugin": "8.9.0",
+    "@typescript-eslint/parser": "8.9.0",
     "chalk": "4.1.2",
     "cli-table3": "0.6.5",
     "css-loader": "7.1.2",
     "css-modules-typescript-loader": "4.0.1",
-    "cssnano": "7.0.5",
-    "debug": "4.3.6",
+    "cssnano": "7.0.6",
+    "debug": "4.3.7",
     "dotenv": "16.4.5",
-    "eslint": "8.57.1",
-    "eslint-plugin-formatjs": "4.13.3",
-    "eslint-plugin-jest": "28.8.0",
-    "eslint-plugin-react": "7.35.0",
+    "eslint": "9.12.0",
+    "eslint-plugin-formatjs": "5.0.0",
+    "eslint-plugin-jest": "28.8.3",
+    "eslint-plugin-react": "7.37.1",
     "jest": "29.7.0",
     "mini-css-extract-plugin": "2.9.1",
     "node-fetch": "3.3.2",
@@ -62,14 +62,14 @@
     "prettier": "3.3.3",
     "style-loader": "4.0.0",
     "terser-webpack-plugin": "5.3.10",
-    "ts-jest": "29.2.4",
+    "ts-jest": "29.2.5",
     "ts-loader": "9.5.1",
     "ts-node": "10.9.2",
     "typescript": "5.5.4",
     "url-loader": "4.1.1",
-    "webpack": "5.94.0",
+    "webpack": "5.95.0",
     "webpack-cli": "5.1.4",
-    "webpack-dev-server": "5.0.4",
+    "webpack-dev-server": "5.1.0",
     "yargs": "17.7.2"
   }
 }