@canva/cli 1.10.0 → 1.11.0

package/templates/data_connector/src/components/header.tsx

@@ -7,7 +7,7 @@ import {
   Title,
 } from "@canva/app-ui-kit";
 import { useNavigate } from "react-router-dom";
-import { Paths } from "src/paths";
+import { Paths } from "src/routes/paths";
 
 export const Header = ({
   title,

package/templates/data_connector/src/index.tsx

@@ -1,68 +1,4 @@
-import { Alert, AppUiProvider } from "@canva/app-ui-kit";
-import type {
-  GetDataTableRequest,
-  GetDataTableResponse,
-  RenderSelectionUiRequest,
-} from "@canva/intents/data";
 import { prepareDataConnector } from "@canva/intents/data";
-import { auth } from "@canva/user";
-import { createRoot } from "react-dom/client";
-import { buildDataTableResult, scope } from "./api";
-import { App } from "./app";
-import "@canva/app-ui-kit/styles.css";
+import dataConnector from "./intents/data_connector";
 
-const root = createRoot(document.getElementById("root") as Element);
-prepareDataConnector({
-  /**
-   * Fetches structured data from an external source.
-   *
-   * This action is called in two scenarios:
-   *
-   * - During data selection to preview data before import (when {@link RenderSelectionUiRequest.updateDataRef} is called).
-   * - When refreshing previously imported data (when the user requests an update).
-   *
-   * @param params - Parameters for the data fetching operation.
-   * @returns A promise resolving to either a successful result with data or an error.
-   */
-  getDataTable: async (
-    params: GetDataTableRequest,
-  ): Promise<GetDataTableResponse> => {
-    const oauth = auth.initOauth();
-    const token = await oauth.getAccessToken({ scope });
-    return buildDataTableResult(params, token?.token);
-  },
-
-  /**
-   * Renders a UI component for selecting and configuring data from external sources.
-   * This UI should allow users to browse data sources, apply filters, and select data.
-   * When selection is complete, the implementation must call the `updateDataRef`
-   * callback provided in the params to preview and confirm the data selection.
-   *
-   * @param request - parameters that provide context and configuration for the data selection UI.
-   * Contains invocation context, size limits, and the updateDataRef callback
-   */
-  renderSelectionUi: async (request: RenderSelectionUiRequest) => {
-    function render() {
-      root.render(<App request={request} />);
-    }
-
-    render();
-
-    if (module.hot) {
-      module.hot.accept("./app", render);
-      module.hot.accept("./api", render);
-    }
-  },
-});
-
-// TODO: Fallback message if you have not turned on the data connector intent.
-// You can remove this once your app is correctly configured.
-root.render(
-  <AppUiProvider>
-    {/* eslint-disable-next-line formatjs/no-literal-string-in-jsx */}
-    <Alert tone="critical">
-      If you're seeing this, you need to turn on the data connector intent in
-      the Developer Portal for this app.
-    </Alert>
-  </AppUiProvider>,
-);
+prepareDataConnector(dataConnector);

package/templates/data_connector/src/{app.tsx → intents/data_connector/app.tsx}

@@ -3,9 +3,9 @@ import { AppUiProvider } from "@canva/app-ui-kit";
 import type { RenderSelectionUiRequest } from "@canva/intents/data";
 import { ErrorBoundary } from "react-error-boundary";
 import { createHashRouter, RouterProvider } from "react-router-dom";
-import { ContextProvider } from "./context";
-import { ErrorPage } from "./pages";
-import { routes } from "./routes";
+import { ContextProvider } from "../../context";
+import { ErrorPage } from "../../pages";
+import { routes } from "../../routes";
 
 export const App = ({ request }: { request: RenderSelectionUiRequest }) => (
   <AppI18nProvider>

package/templates/data_connector/src/{entrypoint.tsx → intents/data_connector/entrypoint.tsx}

@@ -5,15 +5,15 @@ import type {
   APIResponseItem,
   DataSourceConfig,
   DataSourceHandler,
-} from "./api";
-import { DATA_SOURCES } from "./api/data_sources";
-import { useAppContext } from "./context";
-import { Paths } from "./paths";
+} from "../../api";
+import { DATA_SOURCES } from "../../api/data_sources";
+import { useAppContext } from "../../context";
+import { Paths } from "../../routes/paths";
 import {
   isDataRefEmpty,
   isLaunchedWithError,
   isOutdatedSource,
-} from "./utils/data_params";
+} from "../../utils/data_params";
 
 const parseDataSource = (source: string) => {
   try {

package/templates/data_connector/src/{home.tsx → intents/data_connector/home.tsx}

@@ -1,7 +1,7 @@
 import { Box, Rows } from "@canva/app-ui-kit";
 import { Outlet } from "react-router-dom";
 import * as styles from "styles/components.css";
-import { AppError } from "./components";
+import { AppError } from "../../components";
 
 export const Home = () => (
   <div className={styles.scrollContainer}>

package/templates/data_connector/src/intents/data_connector/index.tsx

@@ -0,0 +1,56 @@
+import "@canva/app-ui-kit/styles.css";
+import type {
+  DataConnectorIntent,
+  GetDataTableRequest,
+  GetDataTableResponse,
+  RenderSelectionUiRequest,
+} from "@canva/intents/data";
+import { auth } from "@canva/user";
+import { createRoot } from "react-dom/client";
+import { buildDataTableResult, scope } from "../../api";
+import { App } from "./app";
+
+const dataConnector: DataConnectorIntent = {
+  /**
+   * Fetches structured data from an external source.
+   *
+   * This action is called in two scenarios:
+   *
+   * - During data selection to preview data before import (when {@link RenderSelectionUiRequest.updateDataRef} is called).
+   * - When refreshing previously imported data (when the user requests an update).
+   *
+   * @param params - Parameters for the data fetching operation.
+   * @returns A promise resolving to either a successful result with data or an error.
+   */
+  getDataTable: async (
+    params: GetDataTableRequest,
+  ): Promise<GetDataTableResponse> => {
+    const oauth = auth.initOauth();
+    const token = await oauth.getAccessToken({ scope });
+    return buildDataTableResult(params, token?.token);
+  },
+
+  /**
+   * Renders a UI component for selecting and configuring data from external sources.
+   * This UI should allow users to browse data sources, apply filters, and select data.
+   * When selection is complete, the implementation must call the `updateDataRef`
+   * callback provided in the params to preview and confirm the data selection.
+   *
+   * @param request - parameters that provide context and configuration for the data selection UI.
+   * Contains invocation context, size limits, and the updateDataRef callback
+   */
+  renderSelectionUi: async (request: RenderSelectionUiRequest) => {
+    function render() {
+      const root = createRoot(document.getElementById("root") as Element);
+      root.render(<App request={request} />);
+    }
+
+    render();
+
+    if (module.hot) {
+      module.hot.accept("./app", render);
+      module.hot.accept("../../api", render);
+    }
+  },
+};
+export default dataConnector;

package/templates/data_connector/src/pages/error.tsx

@@ -1,7 +1,7 @@
 import { Button, Rows, Text } from "@canva/app-ui-kit";
 import { FormattedMessage, useIntl } from "react-intl";
 import { useNavigate } from "react-router-dom";
-import { Paths } from "src/paths";
+import { Paths } from "src/routes/paths";
 import * as styles from "styles/components.css";
 
 /**

package/templates/data_connector/src/pages/login.tsx

@@ -11,7 +11,7 @@ import { defineMessages, FormattedMessage, useIntl } from "react-intl";
 import { useNavigate } from "react-router-dom";
 import { scope } from "src/api";
 import { Header } from "src/components";
-import { Paths } from "src/paths";
+import { Paths } from "src/routes/paths";
 import * as styles from "styles/components.css";
 import { useAppContext } from "../context";
 

package/templates/data_connector/src/routes/protected_route.tsx

@@ -1,7 +1,7 @@
 import type { ReactNode } from "react";
 import { useEffect } from "react";
 import { useNavigate } from "react-router-dom";
-import { Paths } from "src/paths";
+import { Paths } from "src/routes/paths";
 import { useAppContext } from "../context";
 
 interface ProtectedRouteProps {

package/templates/data_connector/src/routes/routes.tsx

@@ -1,10 +1,10 @@
-import { Entrypoint } from "src/entrypoint";
-import { Home } from "src/home";
+import { Entrypoint } from "src/intents/data_connector/entrypoint";
+import { Home } from "src/intents/data_connector/home";
 import { DataSourceConfig } from "src/pages/data_source_config";
 import { ErrorPage } from "src/pages/error";
 import { Login } from "src/pages/login";
 import { SelectSource } from "src/pages/select_source";
-import { Paths } from "src/paths";
+import { Paths } from "src/routes/paths";
 import { ProtectedRoute } from "./protected_route";
 
 export const routes = [

package/templates/data_connector/styles/components.css

@@ -36,3 +36,21 @@
 .scrollContainer:focus-within::-webkit-scrollbar-thumb {
   visibility: visible;
 }
+
+/* Main container for the content publisher preview UI */
+.previewContainer {
+  display: flex;
+  align-items: center;
+  justify-content: center;
+  flex-direction: column;
+  width: 100%;
+  height: 100%;
+}
+
+/* Wrapper for the content publisher post preview */
+.previewWrapper {
+  display: flex;
+  align-items: center;
+  justify-content: center;
+  width: calc(400px + 32px + 2px); /* Image width + padding + border */
+}

package/templates/gen_ai/canva-app.json

@@ -16,5 +16,10 @@
         "type": "mandatory"
       }
     ]
+  },
+  "intent": {
+    "design_editor": {
+      "enrolled": true
+    }
   }
 }

package/templates/gen_ai/package.json

@@ -18,11 +18,13 @@
     "postinstall": "ts-node ./scripts/copy_env.ts"
   },
   "dependencies": {
+    "@canva/app-hooks": "^0.0.0-beta.4",
     "@canva/app-i18n-kit": "^1.1.1",
     "@canva/app-ui-kit": "^5.2.1",
     "@canva/asset": "^2.2.1",
     "@canva/design": "^2.7.3",
     "@canva/error": "^2.1.0",
+    "@canva/intents": "^2.0.0",
     "@canva/platform": "^2.2.0",
     "@canva/user": "^2.1.1",
     "cookie-parser": "1.4.7",
@@ -66,7 +68,7 @@
     "debug": "4.4.1",
     "dotenv": "16.6.0",
     "exponential-backoff": "3.1.2",
-    "express": "4.21.2",
+    "express": "4.22.1",
     "express-basic-auth": "1.2.1",
     "jest": "29.7.0",
     "jest-css-modules-transform": "4.4.2",
@@ -75,7 +77,7 @@
     "jwks-rsa": "3.2.0",
     "mini-css-extract-plugin": "2.9.4",
     "node-fetch": "3.3.2",
-    "node-forge": "1.3.1",
+    "node-forge": "1.3.2",
     "nodemon": "3.0.1",
     "open": "8.4.2",
     "postcss-loader": "8.1.1",

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

@@ -6,7 +6,7 @@ import { purchaseCredits, queueImageGeneration } from "src/api";
 import { RemainingCredits } from "src/components";
 import { NUMBER_OF_IMAGES_TO_GENERATE } from "src/config";
 import { useAppContext } from "src/context";
-import { Paths } from "src/paths";
+import { Paths } from "src/routes/paths";
 import { getObsceneWords } from "src/utils";
 import { FooterMessages as Messages } from "./footer.messages";
 

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

@@ -12,7 +12,7 @@ import { FormattedMessage, useIntl } from "react-intl";
 import { useNavigate } from "react-router-dom";
 import { cancelImageGenerationJob, getImageGenerationJobStatus } from "src/api";
 import { useAppContext } from "src/context";
-import { Paths } from "src/paths";
+import { Paths } from "src/routes/paths";
 
 const INTERVAL_DURATION_IN_MS = 100;
 const TOTAL_PROGRESS_PERCENTAGE = 100;

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

@@ -9,7 +9,7 @@ import { useState } from "react";
 import { useIntl } from "react-intl";
 import { useLocation } from "react-router-dom";
 import { useAppContext } from "src/context";
-import { Paths } from "src/paths";
+import { Paths } from "src/routes/paths";
 import { PromptInputMessages as Messages } from "./prompt_input.messages";
 
 // @TODO: Adjust according to your specific requirements.

package/templates/gen_ai/src/index.tsx

@@ -1,15 +1,4 @@
-import { createRoot } from "react-dom/client";
-import "@canva/app-ui-kit/styles.css";
-import { App } from "./app";
+import { prepareDesignEditor } from "@canva/intents/design";
+import designEditor from "./intents/design_editor";
 
-const root = createRoot(document.getElementById("root") as Element);
-
-function render() {
-  root.render(<App />);
-}
-
-render();
-
-if (module.hot) {
-  module.hot.accept("./app", render);
-}
+prepareDesignEditor(designEditor);

package/templates/gen_ai/src/{app.tsx → intents/design_editor/app.tsx}

@@ -2,9 +2,9 @@ import { AppI18nProvider } from "@canva/app-i18n-kit";
 import { AppUiProvider } from "@canva/app-ui-kit";
 import { ErrorBoundary } from "react-error-boundary";
 import { createHashRouter, RouterProvider } from "react-router-dom";
-import { ContextProvider } from "./context";
-import { ErrorPage } from "./pages";
-import { routes } from "./routes";
+import { ContextProvider } from "../../context";
+import { ErrorPage } from "../../pages";
+import { routes } from "../../routes";
 
 export const App = () => (
   <AppI18nProvider>

package/templates/gen_ai/src/{home.tsx → intents/design_editor/home.tsx}

@@ -1,7 +1,7 @@
 import { Rows } from "@canva/app-ui-kit";
 import { Outlet } from "react-router-dom";
 import * as styles from "styles/components.css";
-import { Footer } from "./components";
+import { Footer } from "../../components";
 
 export const Home = () => (
   <div className={styles.scrollContainer}>

package/templates/gen_ai/src/intents/design_editor/index.tsx

@@ -0,0 +1,17 @@
+import "@canva/app-ui-kit/styles.css";
+import type { DesignEditorIntent } from "@canva/intents/design";
+import { createRoot } from "react-dom/client";
+import { App } from "./app";
+
+async function render() {
+  const root = createRoot(document.getElementById("root") as Element);
+
+  root.render(<App />);
+}
+
+const designEditor: DesignEditorIntent = { render };
+export default designEditor;
+
+if (module.hot) {
+  module.hot.accept("./app", render);
+}

package/templates/gen_ai/src/pages/error.tsx

@@ -2,7 +2,7 @@ import { Button, Rows, Text } from "@canva/app-ui-kit";
 import { FormattedMessage, useIntl } from "react-intl";
 import { useNavigate } from "react-router-dom";
 import { useAppContext } from "src/context";
-import { Paths } from "src/paths";
+import { Paths } from "src/routes/paths";
 import * as styles from "styles/components.css";
 
 /**

package/templates/gen_ai/src/routes/routes.tsx

@@ -1,8 +1,8 @@
-import { Home } from "src/home";
+import { Home } from "src/intents/design_editor/home";
 import { ErrorPage } from "src/pages/error";
 import { GeneratePage } from "src/pages/generate";
 import { ResultsPage } from "src/pages/results";
-import { Paths } from "src/paths";
+import { Paths } from "src/routes/paths";
 
 export const routes = [
   {

package/templates/gen_ai/styles/components.css

@@ -36,3 +36,21 @@
 .scrollContainer:focus-within::-webkit-scrollbar-thumb {
   visibility: visible;
 }
+
+/* Main container for the content publisher preview UI */
+.previewContainer {
+  display: flex;
+  align-items: center;
+  justify-content: center;
+  flex-direction: column;
+  width: 100%;
+  height: 100%;
+}
+
+/* Wrapper for the content publisher post preview */
+.previewWrapper {
+  display: flex;
+  align-items: center;
+  justify-content: center;
+  width: calc(400px + 32px + 2px); /* Image width + padding + border */
+}

package/templates/hello_world/canva-app.json

@@ -12,5 +12,10 @@
         "type": "mandatory"
       }
     ]
+  },
+  "intent": {
+    "design_editor": {
+      "enrolled": true
+    }
   }
 }

package/templates/hello_world/package.json

@@ -19,11 +19,13 @@
     "postinstall": "ts-node ./scripts/copy_env.ts"
   },
   "dependencies": {
+    "@canva/app-hooks": "^0.0.0-beta.4",
     "@canva/app-i18n-kit": "^1.1.1",
     "@canva/app-ui-kit": "^5.2.1",
     "@canva/asset": "^2.2.1",
     "@canva/design": "^2.7.3",
     "@canva/error": "^2.1.0",
+    "@canva/intents": "^2.0.0",
     "@canva/platform": "^2.2.0",
     "@canva/user": "^2.1.1",
     "react": "^19.2.0",
@@ -57,7 +59,7 @@
     "cssnano": "7.1.1",
     "debug": "4.4.1",
     "dotenv": "16.6.0",
-    "express": "4.21.2",
+    "express": "4.22.1",
     "express-basic-auth": "1.2.1",
     "jest": "29.7.0",
     "jest-css-modules-transform": "4.4.2",
@@ -66,7 +68,7 @@
     "jwks-rsa": "3.2.0",
     "mini-css-extract-plugin": "2.9.4",
     "node-fetch": "3.3.2",
-    "node-forge": "1.3.1",
+    "node-forge": "1.3.2",
     "nodemon": "3.0.1",
     "open": "8.4.2",
     "postcss-loader": "8.1.1",

package/templates/hello_world/src/index.tsx

@@ -1,22 +1,4 @@
-import { AppI18nProvider } from "@canva/app-i18n-kit";
-import { AppUiProvider } from "@canva/app-ui-kit";
-import { createRoot } from "react-dom/client";
-import { App } from "./app";
-import "@canva/app-ui-kit/styles.css";
+import { prepareDesignEditor } from "@canva/intents/design";
+import designEditor from "./intents/design_editor";
 
-const root = createRoot(document.getElementById("root") as Element);
-function render() {
-  root.render(
-    <AppI18nProvider>
-      <AppUiProvider>
-        <App />
-      </AppUiProvider>
-    </AppI18nProvider>,
-  );
-}
-
-render();
-
-if (module.hot) {
-  module.hot.accept("./app", render);
-}
+prepareDesignEditor(designEditor);

package/templates/hello_world/src/{app.tsx → intents/design_editor/app.tsx}

@@ -1,15 +1,23 @@
+import { useFeatureSupport } from "@canva/app-hooks";
 import { Button, Rows, Text } from "@canva/app-ui-kit";
+import { addElementAtCursor, addElementAtPoint } from "@canva/design";
 import { requestOpenExternalUrl } from "@canva/platform";
 import { FormattedMessage, useIntl } from "react-intl";
-import { useAddElement } from "utils/use_add_element";
 import * as styles from "styles/components.css";
 
 export const DOCS_URL = "https://www.canva.dev/docs/apps/";
 
 export const App = () => {
-  const addElement = useAddElement();
+  const isSupported = useFeatureSupport();
+  const addElement = [addElementAtPoint, addElementAtCursor].find((fn) =>
+    isSupported(fn),
+  );
 
   const onClick = () => {
+    if (!addElement) {
+      return;
+    }
+
     addElement({
       type: "text",
       children: ["Hello world!"],
@@ -43,7 +51,22 @@ export const App = () => {
             }}
           />
         </Text>
-        <Button variant="primary" onClick={onClick} stretch>
+        <Button
+          variant="primary"
+          onClick={onClick}
+          disabled={!addElement}
+          tooltipLabel={
+            !addElement
+              ? intl.formatMessage({
+                  defaultMessage:
+                    "This feature is not supported in the current page",
+                  description:
+                    "Tooltip label for when a feature is not supported in the current design",
+                })
+              : undefined
+          }
+          stretch
+        >
           {intl.formatMessage({
             defaultMessage: "Do something cool",
             description:

package/templates/hello_world/src/intents/design_editor/index.tsx

@@ -0,0 +1,25 @@
+import "@canva/app-ui-kit/styles.css";
+import { AppI18nProvider } from "@canva/app-i18n-kit";
+import { AppUiProvider } from "@canva/app-ui-kit";
+import type { DesignEditorIntent } from "@canva/intents/design";
+import { createRoot } from "react-dom/client";
+import { App } from "./app";
+
+async function render() {
+  const root = createRoot(document.getElementById("root") as Element);
+
+  root.render(
+    <AppI18nProvider>
+      <AppUiProvider>
+        <App />
+      </AppUiProvider>
+    </AppI18nProvider>,
+  );
+}
+
+const designEditor: DesignEditorIntent = { render };
+export default designEditor;
+
+if (module.hot) {
+  module.hot.accept("./app", render);
+}

package/templates/hello_world/src/{tests → intents/design_editor/tests}/app.tests.tsx

@@ -1,11 +1,13 @@
 /* eslint-disable formatjs/no-literal-string-in-jsx */
+import { useFeatureSupport } from "@canva/app-hooks";
 import { TestAppI18nProvider } from "@canva/app-i18n-kit";
 import { TestAppUiProvider } from "@canva/app-ui-kit";
+import { addElementAtCursor, addElementAtPoint } from "@canva/design";
+import type { Feature } from "@canva/platform";
 import { requestOpenExternalUrl } from "@canva/platform";
 import { fireEvent, render } from "@testing-library/react";
 import type { RenderResult } from "@testing-library/react";
 import type { ReactNode } from "react";
-import { useAddElement } from "utils/use_add_element";
 import { App, DOCS_URL } from "../app";
 
 function renderInTestProvider(node: ReactNode): RenderResult {
@@ -17,33 +19,35 @@ function renderInTestProvider(node: ReactNode): RenderResult {
   );
 }
 
-jest.mock("utils/use_add_element");
+jest.mock("@canva/app-hooks");
 
 // This test demonstrates how to test code that uses functions from the Canva Apps SDK
 // For more information on testing with the Canva Apps SDK, see https://www.canva.dev/docs/apps/testing/
 describe("Hello World Tests", () => {
-  // Mocking the useAddElement hook
-  const mockAddElement = jest.fn();
-  const mockAddUseElement = jest.mocked(useAddElement);
+  const mockIsSupported = jest.fn();
+  const mockUseFeatureSupport = jest.mocked(useFeatureSupport);
   const mockRequestOpenExternalUrl = jest.mocked(requestOpenExternalUrl);
 
   beforeEach(() => {
     jest.resetAllMocks();
-    mockAddUseElement.mockReturnValue(mockAddElement);
+    mockIsSupported.mockImplementation(
+      (fn: Feature) => fn === addElementAtPoint,
+    );
+    mockUseFeatureSupport.mockReturnValue(mockIsSupported);
     mockRequestOpenExternalUrl.mockResolvedValue({ status: "completed" });
   });
 
-  // this test uses a mock in place of the useAddElement hook
+  // this test uses a mock in place of the useFeatureSupport hook
   it("should add a text element when the button is clicked", () => {
     // assert that the mocks are in the expected clean state
-    expect(mockAddUseElement).not.toHaveBeenCalled();
-    expect(mockAddElement).not.toHaveBeenCalled();
+    expect(mockUseFeatureSupport).not.toHaveBeenCalled();
+    expect(addElementAtPoint).not.toHaveBeenCalled();
 
     const result = renderInTestProvider(<App />);
 
     // the hook should have been called in the render process but not the callback
-    expect(mockAddUseElement).toHaveBeenCalled();
-    expect(mockAddElement).not.toHaveBeenCalled();
+    expect(mockUseFeatureSupport).toHaveBeenCalled();
+    expect(addElementAtPoint).not.toHaveBeenCalled();
 
     // get a reference to the do something cool button element
     const doSomethingCoolBtn = result.getByRole("button", {
@@ -53,8 +57,10 @@ describe("Hello World Tests", () => {
     // programmatically simulate clicking the button
     fireEvent.click(doSomethingCoolBtn);
 
-    // we expect that addElement has been called by the button's click handler
-    expect(mockAddElement).toHaveBeenCalled();
+    // we expect that addElementAtPoint has been called by the button's click handler
+    expect(mockIsSupported).toHaveBeenCalledWith(addElementAtPoint);
+    expect(mockIsSupported).not.toHaveBeenCalledWith(addElementAtCursor);
+    expect(addElementAtPoint).toHaveBeenCalled();
   });
 
   // this test uses a mock in place of the @canva/platform requestOpenExternalUrl function