@canva/intents 0.0.0-beta.2

package/LICENSE.md

@@ -0,0 +1,48 @@
+# A message from Canva
+
+By making these software components available to you, our goal is to give you
+the right to use the components to build your apps for Canva's ecosystem. See
+below for the specific licence terms that apply to your use.
+
+# Licence
+
+Canva Pty Ltd (ACN 158 929 938) ("Canva") owns the copyright in the software and
+associated documentation files to which this Licence relates (each a "Software
+Component"). Canva reserves all of its rights.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+the Software Components ("You"), to use the Software Components, but strictly
+subject to the following restrictions and conditions:
+
+1. You must only use the Software Components and any Derivative on the Canva
+   Platform.
+
+2. You must only use the Software Components and any Derivative for the purpose
+   of building or updating Permitted Apps, and for no other purpose.
+
+3. You must include a copy of this Licence in all copies of any Software
+   Component and Derivative.
+
+4. To the fullest extent permitted by law, the Software Components are provided
+   "as is", without warranty of any kind, express or implied, including but not
+   limited to the warranties of merchantability, fitness for a particular
+   purpose and non-infringement. To the fullest extent permitted by law, in no
+   event shall the authors or copyright holders be liable for any claim,
+   damages or other liability, whether in an action of contract, tort or
+   otherwise, arising from, out of or in connection with the Software Components
+   or any Derivative, or the use of or other dealings in the Software Components
+   or any Derivative.
+
+5. In this Licence:
+
+   (a) "Canva Platform" means the visual communications platform owned and
+   operated by Canva that is made available on Canva.com (as well as any
+   sub-domains and international versions) and via mobile applications, desktop
+   applications, and in other forms provided or made available by Canva;
+
+   (b) "Derivative" means any software, document or other material that: (i)
+   contains any Software Component; and/or (ii) comprises or contains a
+   derivative, adaptation or substantial part of any Software Component; and
+
+   (c) "Permitted App" means a software application that is solely offered to
+   end-users on the Canva Platform.

package/README.md

@@ -0,0 +1,119 @@
+# @canva/intents
+
+> **_⚠️ This package is currently in beta_**
+
+A package for Canva's Apps SDK that provides types and utilities for working with App Intents.
+
+![](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white)
+
+## Table of contents
+
+- [Introduction](#introduction)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Related packages](#related-packages)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Introduction
+
+`@canva/intents` is an npm package for Canva's [Apps SDK](https://www.canva.dev/docs/apps).
+It provides intent-specific types and helpers that allow apps to integrate with specific surfaces within the Canva editor — such as the data connector panel or the design editor.
+
+An "intent" represents a specific user workflow an app can support. For example:
+
+- Users can select and import data from an app which implements the **Data Connector** intent.
+- An app is able to present interactive and creative tooling alongside the Canva design surface by implementing the **Design Editor** intent.
+
+The `@canva/intents` package encompasses **all available intents**, exporting each intent's type information and prepare function, grouped by domain.
+This allows your app to prepare one or more intents while keeping each intent's implementation modular and type-safe.
+
+Currently supported intents:
+
+- [`Data Connector`](#data-connector-example)
+- [`Design Editor`](#design-editor-example)
+
+New intents will be added to this package in the future.
+
+**Note:** To get up and running with the Apps SDK, check out [the quick start guide](https://www.canva.dev/docs/apps/quick-start).
+
+## Installation
+
+```bash
+npm install @canva/intents
+```
+
+## Usage
+
+### Preparing an intent
+
+Each intent type has a corresponding `prepare` function in the `@canva/intents` package. You can implement any intent in your app code by calling the appropriate `prepare` function with the particular parameters it requires.
+
+### Data Connector example
+
+Here’s a full example of preparing a `data_connector` intent, which allows users to import tabular data from an app:
+
+```ts
+import { createRoot } from 'react-dom/client';
+import { AppUiProvider } from '@canva/app-ui-kit';
+import { prepareDataConnector } from '@canva/intents/data';
+import { DataSelectionUI } from './data_selection_ui';
+import { fetchData } from './fetch_data';
+
+prepareDataConnector({
+  fetchDataTable: async (params) => {
+    try {
+      const dataTable = await fetchData(params); // your data fetching logic here
+      return {
+        status: 'completed',
+        dataTable,
+      };
+    } catch {
+      return {
+        status: 'app_error',
+        message: 'Failed to fetch data',
+      };
+    }
+  },
+
+  renderSelectionUi: (params) => {
+    const root = createRoot(document.getElementById('root') as Element);
+    root.render(
+      <AppUiProvider>
+        <DataSelectionUI {...params} />
+      </AppUiProvider>
+    );
+  },
+});
+```
+
+### Design Editor example
+
+```ts
+import { prepareDesignEditor } from '@canva/intents/design';
+
+prepareDesignEditor({
+  render() {
+    // render logic
+  },
+});
+```
+
+## Related packages
+
+The Apps SDK is made up of the following packages:
+
+- [`@canva/app-ui-kit`](https://www.npmjs.com/package/@canva/app-ui-kit) - React-based component library for creating apps that mimic the look and feel of Canva.
+- [`@canva/asset`](https://www.npmjs.com/package/@canva/asset) - Provides methods for working with assets, such as image and video files.
+- [`@canva/design`](https://www.npmjs.com/package/@canva/design) - Provides methods for interacting with the user's design, such as creating elements.
+- [`@canva/error`](https://www.npmjs.com/package/@canva/error) - Provides a `CanvaError` class for handling errors.
+- [`@canva/platform`](https://www.npmjs.com/package/@canva/platform) - Provides utility methods, such as a method for opening external links.
+- [`@canva/user`](https://www.npmjs.com/package/@canva/user) - Provides methods for accessing user data and authenticating users.
+
+## Contributing
+
+We're actively developing this package but are not currently accepting third-party contributions. If you'd like to request any changes or additions to the package, submit a feature request via the [Canva Developers Community](https://community.canva.dev/).
+
+## License
+
+See the `LICENSE.md` file.

package/asset/beta.d.ts

@@ -0,0 +1 @@
+export {};