canvu-react 0.4.5 → 0.4.7

package/dist/{asset-hydration-B7yMDQE-.d.cts → asset-hydration-CWhld14A.d.cts}

@@ -1,5 +1,5 @@
 import { V as VectorSceneItem } from './types-BCCvY6ie.cjs';
-import { E as VectorViewportAssetStore } from './shape-builders-BAWu-PxX.cjs';
+import { a as VectorViewportAssetStore } from './link-item-D870_X6P.cjs';
 
 declare class IndexedDbImageStore {
     private dbPromise;

package/dist/{asset-hydration-CbwQVAwh.d.ts → asset-hydration-D35mHbUP.d.ts}

@@ -1,5 +1,5 @@
 import { V as VectorSceneItem } from './types-BCCvY6ie.js';
-import { E as VectorViewportAssetStore } from './shape-builders-ClKv9tz9.js';
+import { a as VectorViewportAssetStore } from './link-item-Bg5vj0RI.js';
 
 declare class IndexedDbImageStore {
     private dbPromise;

package/dist/chatbot.d.cts

@@ -1,9 +1,9 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import { C as CanvasPlugin } from './types-BC9Xgfu6.cjs';
+import { C as CanvasPlugin } from './types-Bw1SdC9v.cjs';
 import 'react';
 import './types-BCCvY6ie.cjs';
-import './camera-CVVG7z56.cjs';
-import './shape-builders-BAWu-PxX.cjs';
+import './shape-builders-CKEMjivV.cjs';
+import './link-item-D870_X6P.cjs';
 
 type ChatbotPluginPanelProps = {
     /**

package/dist/chatbot.d.ts

@@ -1,9 +1,9 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import { C as CanvasPlugin } from './types-DlSVGX0w.js';
+import { C as CanvasPlugin } from './types-DeXFfs7Y.js';
 import 'react';
 import './types-BCCvY6ie.js';
-import './camera-CoRYN_IV.js';
-import './shape-builders-ClKv9tz9.js';
+import './shape-builders-Cyh8zvDG.js';
+import './link-item-Bg5vj0RI.js';
 
 type ChatbotPluginPanelProps = {
     /**

package/dist/index.d.cts

@@ -1,9 +1,9 @@
-import { C as Camera2D } from './camera-CVVG7z56.cjs';
-export { a as Camera2DOptions } from './camera-CVVG7z56.cjs';
+import { C as Camera2D } from './shape-builders-CKEMjivV.cjs';
+export { a as Camera2DOptions, D as DEFAULT_STROKE_STYLE, F as FreehandSvgPayload, S as StrokeStyle, b as applyStrokeToItem, c as buildArchitecturalCloudPathD, d as buildArchitecturalCloudSvg, e as buildArrowSvg, f as buildDrawDotSvg, g as buildEllipseSvg, h as buildFreehandPathSvg, i as buildLineSvg, j as buildRectSvg, k as computeFreehandSvgPayload, l as createArchitecturalCloudItem, m as createDrawDotItem, n as createEllipseItem, o as createFreehandStrokeItem, p as createImageFromVectorTrace, q as createImageItem, r as createLineItem, s as createRectangleItem, t as createShapeId, u as createTextItem, v as lineEndpointsToLocal, w as rebuildItemSvg, x as resolveStrokeStyle } from './shape-builders-CKEMjivV.cjs';
 import { V as VectorSceneItem, A as ArrowEndpointBinding, R as Rect } from './types-BCCvY6ie.cjs';
 export { a as ArrowBindings, b as VectorPathPoint, n as normalizeRect, r as rectsIntersect } from './types-BCCvY6ie.cjs';
-export { H as HydratedSceneItemsWithAssetsResult, h as hydrateSceneItemsWithAssets } from './asset-hydration-B7yMDQE-.cjs';
-export { C as CanvuLinkData, D as DEFAULT_LINK_CARD_SIZE, a as DEFAULT_STROKE_STYLE, F as FreehandSvgPayload, L as LINK_PLUGIN_KEY, S as StrokeStyle, b as applyStrokeToItem, c as buildArchitecturalCloudPathD, d as buildArchitecturalCloudSvg, e as buildArrowSvg, f as buildDrawDotSvg, g as buildEllipseSvg, h as buildFreehandPathSvg, i as buildLineSvg, j as buildLinkCardSvg, k as buildRectSvg, l as computeFreehandSvgPayload, m as createArchitecturalCloudItem, n as createDrawDotItem, o as createEllipseItem, p as createFreehandStrokeItem, q as createImageFromVectorTrace, r as createImageItem, s as createLineItem, t as createLinkItem, u as createRectangleItem, v as createShapeId, w as createTextItem, x as getLinkData, y as isLinkItem, z as lineEndpointsToLocal, A as rebuildItemSvg, B as resolveStrokeStyle } from './shape-builders-BAWu-PxX.cjs';
+export { H as HydratedSceneItemsWithAssetsResult, h as hydrateSceneItemsWithAssets } from './asset-hydration-CWhld14A.cjs';
+export { C as CanvuLinkData, D as DEFAULT_LINK_CARD_SIZE, L as LINK_PLUGIN_KEY, b as buildLinkCardSvg, c as createLinkItem, g as getLinkData, i as isLinkItem } from './link-item-D870_X6P.cjs';
 
 type EncodeCanvasToBlobOptions = {
     mimeType?: string;

package/dist/index.d.ts

@@ -1,9 +1,9 @@
-import { C as Camera2D } from './camera-CoRYN_IV.js';
-export { a as Camera2DOptions } from './camera-CoRYN_IV.js';
+import { C as Camera2D } from './shape-builders-Cyh8zvDG.js';
+export { a as Camera2DOptions, D as DEFAULT_STROKE_STYLE, F as FreehandSvgPayload, S as StrokeStyle, b as applyStrokeToItem, c as buildArchitecturalCloudPathD, d as buildArchitecturalCloudSvg, e as buildArrowSvg, f as buildDrawDotSvg, g as buildEllipseSvg, h as buildFreehandPathSvg, i as buildLineSvg, j as buildRectSvg, k as computeFreehandSvgPayload, l as createArchitecturalCloudItem, m as createDrawDotItem, n as createEllipseItem, o as createFreehandStrokeItem, p as createImageFromVectorTrace, q as createImageItem, r as createLineItem, s as createRectangleItem, t as createShapeId, u as createTextItem, v as lineEndpointsToLocal, w as rebuildItemSvg, x as resolveStrokeStyle } from './shape-builders-Cyh8zvDG.js';
 import { V as VectorSceneItem, A as ArrowEndpointBinding, R as Rect } from './types-BCCvY6ie.js';
 export { a as ArrowBindings, b as VectorPathPoint, n as normalizeRect, r as rectsIntersect } from './types-BCCvY6ie.js';
-export { H as HydratedSceneItemsWithAssetsResult, h as hydrateSceneItemsWithAssets } from './asset-hydration-CbwQVAwh.js';
-export { C as CanvuLinkData, D as DEFAULT_LINK_CARD_SIZE, a as DEFAULT_STROKE_STYLE, F as FreehandSvgPayload, L as LINK_PLUGIN_KEY, S as StrokeStyle, b as applyStrokeToItem, c as buildArchitecturalCloudPathD, d as buildArchitecturalCloudSvg, e as buildArrowSvg, f as buildDrawDotSvg, g as buildEllipseSvg, h as buildFreehandPathSvg, i as buildLineSvg, j as buildLinkCardSvg, k as buildRectSvg, l as computeFreehandSvgPayload, m as createArchitecturalCloudItem, n as createDrawDotItem, o as createEllipseItem, p as createFreehandStrokeItem, q as createImageFromVectorTrace, r as createImageItem, s as createLineItem, t as createLinkItem, u as createRectangleItem, v as createShapeId, w as createTextItem, x as getLinkData, y as isLinkItem, z as lineEndpointsToLocal, A as rebuildItemSvg, B as resolveStrokeStyle } from './shape-builders-ClKv9tz9.js';
+export { H as HydratedSceneItemsWithAssetsResult, h as hydrateSceneItemsWithAssets } from './asset-hydration-D35mHbUP.js';
+export { C as CanvuLinkData, D as DEFAULT_LINK_CARD_SIZE, L as LINK_PLUGIN_KEY, b as buildLinkCardSvg, c as createLinkItem, g as getLinkData, i as isLinkItem } from './link-item-Bg5vj0RI.js';
 
 type EncodeCanvasToBlobOptions = {
     mimeType?: string;

package/dist/link-item-Bg5vj0RI.d.ts

@@ -0,0 +1,151 @@
+import { V as VectorSceneItem, R as Rect } from './types-BCCvY6ie.js';
+
+/**
+ * Kind of binary selected through the built-in canvu asset ingestion flow.
+ *
+ * Use this to branch your backend upload logic when images and PDFs should be
+ * stored differently.
+ */
+type VectorViewportAssetKind = "image" | "pdf";
+/**
+ * Original browser `File` intercepted from the built-in asset flow.
+ *
+ * This is the high-level hook for apps that want canvu to keep its native file
+ * UX while still uploading the raw binary to their backend or object storage.
+ *
+ * The same request shape is also reused by
+ * {@link ingestAssetFilesToSceneItems}, so custom import flows and the native
+ * viewport UX can share one backend contract.
+ */
+type VectorViewportAssetUploadRequest = {
+    /** Original browser file before canvu converts it into scene items. */
+    file: File;
+    /** High-level bucket for routing image vs PDF upload behavior. */
+    kind: VectorViewportAssetKind;
+};
+/**
+ * Persisted metadata returned by a custom asset upload.
+ *
+ * The returned `pluginData` is shallow-merged into every `VectorSceneItem`
+ * created from the uploaded file, making it available to custom persistence
+ * adapters and later hydration flows.
+ *
+ * @example
+ * ```ts
+ * const assetStore: VectorViewportAssetStore = {
+ *   async upload({ file, kind }) {
+ *     const form = new FormData();
+ *     form.append("file", file);
+ *     form.append("kind", kind);
+ *
+ *     const response = await fetch("/api/canvu/assets", {
+ *       method: "POST",
+ *       body: form,
+ *     });
+ *
+ *     const asset = await response.json();
+ *     return {
+ *       pluginData: {
+ *         assetId: asset.id,
+ *         assetKey: asset.key,
+ *         mimeType: file.type,
+ *       },
+ *     };
+ *   },
+ *   async resolve({ assetIds }) {
+ *     const response = await fetch("/api/canvu/assets/resolve", {
+ *       method: "POST",
+ *       headers: { "content-type": "application/json" },
+ *       body: JSON.stringify({ assetIds }),
+ *     });
+ *
+ *     return response.json();
+ *   },
+ * };
+ * ```
+ */
+type VectorViewportAssetUploadResult = {
+    /**
+     * Opaque persisted metadata attached to created items.
+     *
+     * Use this for asset ids, bucket keys, original file names, or any backend
+     * reference needed to rehydrate the binary later from your own persistence
+     * adapter.
+     */
+    pluginData?: VectorSceneItem["pluginData"];
+};
+/**
+ * Request to resolve persisted asset ids back into runtime URLs.
+ *
+ * This is useful inside custom persistence adapters when you want to rehydrate
+ * signed URLs or CDN URLs after loading a snapshot.
+ */
+type VectorViewportAssetResolveRequest = {
+    assetIds: string[];
+};
+/**
+ * Runtime URL payload returned by a custom asset resolver.
+ */
+type VectorViewportAssetResolveResult = Record<string, {
+    url: string;
+    thumbnailUrl?: string;
+}>;
+type VectorViewportAssetHydrationRequest = {
+    assetId: string;
+    kind: VectorViewportAssetKind;
+    pageNumber?: number;
+    scale?: number;
+};
+/**
+ * High-level hook for apps that want to persist raw binaries out-of-band while
+ * keeping canvu's built-in file UX.
+ *
+ * `upload` is used by the built-in file picker / drag-and-drop flow and by
+ * {@link ingestAssetFilesToSceneItems}. `resolve` is optional for custom
+ * persistence adapters and future hydration flows.
+ */
+type VectorViewportAssetStore = {
+    upload: (request: VectorViewportAssetUploadRequest) => Promise<VectorViewportAssetUploadResult | undefined>;
+    resolve?: (request: VectorViewportAssetResolveRequest) => Promise<VectorViewportAssetResolveResult>;
+    getHydrationRequest?: (item: VectorSceneItem) => VectorViewportAssetHydrationRequest | null;
+};
+
+/** Plugin key under which link metadata is stored on a link item's `pluginData`. */
+declare const LINK_PLUGIN_KEY = "canvuLink";
+/**
+ * Metadata describing a clickable link/bookmark item.
+ * `href` is required; the rest enrich the rendered card (unfurl result).
+ */
+type CanvuLinkData = {
+    /** Absolute URL the card points to. */
+    href: string;
+    /** Human readable title (falls back to the hostname). */
+    title?: string;
+    /** Short description shown under the title. */
+    description?: string;
+    /** Preview image URL (og:image). */
+    image?: string;
+    /** Favicon URL shown in the leading badge. */
+    favicon?: string;
+};
+/**
+ * Builds the inner SVG (no outer `<svg>`) for a link/bookmark card at the given box size.
+ * Uses fixed pixel bands so text never overlaps regardless of the card's aspect ratio.
+ */
+declare function buildLinkCardSvg(width: number, height: number, link: CanvuLinkData): string;
+/** Reads the link metadata from an item, or `null` when the item is not a link. */
+declare function getLinkData(item: VectorSceneItem): CanvuLinkData | null;
+/** True when the item carries link metadata (clickable card). */
+declare function isLinkItem(item: VectorSceneItem): boolean;
+/**
+ * Creates a clickable link/bookmark card item ready to append to the scene.
+ * The card resizes by scaling its authored SVG, like other custom shapes.
+ */
+declare function createLinkItem(id: string, bounds: Rect, link: CanvuLinkData): VectorSceneItem;
+/** Default card size used when placing a new link without explicit bounds. */
+declare const DEFAULT_LINK_CARD_SIZE: {
+    readonly width: 360;
+    readonly height: 132;
+};
+
+export { type CanvuLinkData as C, DEFAULT_LINK_CARD_SIZE as D, LINK_PLUGIN_KEY as L, type VectorViewportAssetKind as V, type VectorViewportAssetStore as a, buildLinkCardSvg as b, createLinkItem as c, type VectorViewportAssetHydrationRequest as d, type VectorViewportAssetResolveRequest as e, type VectorViewportAssetResolveResult as f, getLinkData as g, type VectorViewportAssetUploadRequest as h, isLinkItem as i, type VectorViewportAssetUploadResult as j };

package/dist/link-item-D870_X6P.d.cts

@@ -0,0 +1,151 @@
+import { V as VectorSceneItem, R as Rect } from './types-BCCvY6ie.cjs';
+
+/**
+ * Kind of binary selected through the built-in canvu asset ingestion flow.
+ *
+ * Use this to branch your backend upload logic when images and PDFs should be
+ * stored differently.
+ */
+type VectorViewportAssetKind = "image" | "pdf";
+/**
+ * Original browser `File` intercepted from the built-in asset flow.
+ *
+ * This is the high-level hook for apps that want canvu to keep its native file
+ * UX while still uploading the raw binary to their backend or object storage.
+ *
+ * The same request shape is also reused by
+ * {@link ingestAssetFilesToSceneItems}, so custom import flows and the native
+ * viewport UX can share one backend contract.
+ */
+type VectorViewportAssetUploadRequest = {
+    /** Original browser file before canvu converts it into scene items. */
+    file: File;
+    /** High-level bucket for routing image vs PDF upload behavior. */
+    kind: VectorViewportAssetKind;
+};
+/**
+ * Persisted metadata returned by a custom asset upload.
+ *
+ * The returned `pluginData` is shallow-merged into every `VectorSceneItem`
+ * created from the uploaded file, making it available to custom persistence
+ * adapters and later hydration flows.
+ *
+ * @example
+ * ```ts
+ * const assetStore: VectorViewportAssetStore = {
+ *   async upload({ file, kind }) {
+ *     const form = new FormData();
+ *     form.append("file", file);
+ *     form.append("kind", kind);
+ *
+ *     const response = await fetch("/api/canvu/assets", {
+ *       method: "POST",
+ *       body: form,
+ *     });
+ *
+ *     const asset = await response.json();
+ *     return {
+ *       pluginData: {
+ *         assetId: asset.id,
+ *         assetKey: asset.key,
+ *         mimeType: file.type,
+ *       },
+ *     };
+ *   },
+ *   async resolve({ assetIds }) {
+ *     const response = await fetch("/api/canvu/assets/resolve", {
+ *       method: "POST",
+ *       headers: { "content-type": "application/json" },
+ *       body: JSON.stringify({ assetIds }),
+ *     });
+ *
+ *     return response.json();
+ *   },
+ * };
+ * ```
+ */
+type VectorViewportAssetUploadResult = {
+    /**
+     * Opaque persisted metadata attached to created items.
+     *
+     * Use this for asset ids, bucket keys, original file names, or any backend
+     * reference needed to rehydrate the binary later from your own persistence
+     * adapter.
+     */
+    pluginData?: VectorSceneItem["pluginData"];
+};
+/**
+ * Request to resolve persisted asset ids back into runtime URLs.
+ *
+ * This is useful inside custom persistence adapters when you want to rehydrate
+ * signed URLs or CDN URLs after loading a snapshot.
+ */
+type VectorViewportAssetResolveRequest = {
+    assetIds: string[];
+};
+/**
+ * Runtime URL payload returned by a custom asset resolver.
+ */
+type VectorViewportAssetResolveResult = Record<string, {
+    url: string;
+    thumbnailUrl?: string;
+}>;
+type VectorViewportAssetHydrationRequest = {
+    assetId: string;
+    kind: VectorViewportAssetKind;
+    pageNumber?: number;
+    scale?: number;
+};
+/**
+ * High-level hook for apps that want to persist raw binaries out-of-band while
+ * keeping canvu's built-in file UX.
+ *
+ * `upload` is used by the built-in file picker / drag-and-drop flow and by
+ * {@link ingestAssetFilesToSceneItems}. `resolve` is optional for custom
+ * persistence adapters and future hydration flows.
+ */
+type VectorViewportAssetStore = {
+    upload: (request: VectorViewportAssetUploadRequest) => Promise<VectorViewportAssetUploadResult | undefined>;
+    resolve?: (request: VectorViewportAssetResolveRequest) => Promise<VectorViewportAssetResolveResult>;
+    getHydrationRequest?: (item: VectorSceneItem) => VectorViewportAssetHydrationRequest | null;
+};
+
+/** Plugin key under which link metadata is stored on a link item's `pluginData`. */
+declare const LINK_PLUGIN_KEY = "canvuLink";
+/**
+ * Metadata describing a clickable link/bookmark item.
+ * `href` is required; the rest enrich the rendered card (unfurl result).
+ */
+type CanvuLinkData = {
+    /** Absolute URL the card points to. */
+    href: string;
+    /** Human readable title (falls back to the hostname). */
+    title?: string;
+    /** Short description shown under the title. */
+    description?: string;
+    /** Preview image URL (og:image). */
+    image?: string;
+    /** Favicon URL shown in the leading badge. */
+    favicon?: string;
+};
+/**
+ * Builds the inner SVG (no outer `<svg>`) for a link/bookmark card at the given box size.
+ * Uses fixed pixel bands so text never overlaps regardless of the card's aspect ratio.
+ */
+declare function buildLinkCardSvg(width: number, height: number, link: CanvuLinkData): string;
+/** Reads the link metadata from an item, or `null` when the item is not a link. */
+declare function getLinkData(item: VectorSceneItem): CanvuLinkData | null;
+/** True when the item carries link metadata (clickable card). */
+declare function isLinkItem(item: VectorSceneItem): boolean;
+/**
+ * Creates a clickable link/bookmark card item ready to append to the scene.
+ * The card resizes by scaling its authored SVG, like other custom shapes.
+ */
+declare function createLinkItem(id: string, bounds: Rect, link: CanvuLinkData): VectorSceneItem;
+/** Default card size used when placing a new link without explicit bounds. */
+declare const DEFAULT_LINK_CARD_SIZE: {
+    readonly width: 360;
+    readonly height: 132;
+};
+
+export { type CanvuLinkData as C, DEFAULT_LINK_CARD_SIZE as D, LINK_PLUGIN_KEY as L, type VectorViewportAssetKind as V, type VectorViewportAssetStore as a, buildLinkCardSvg as b, createLinkItem as c, type VectorViewportAssetHydrationRequest as d, type VectorViewportAssetResolveRequest as e, type VectorViewportAssetResolveResult as f, getLinkData as g, type VectorViewportAssetUploadRequest as h, isLinkItem as i, type VectorViewportAssetUploadResult as j };