@bluepic/embed 0.4.0-next.103 → 0.4.0-next.104

package/dist/components/AssetViewer/AssetViewer.vue.d.ts

@@ -0,0 +1,57 @@
+import '@zoompinch/vue/style.css';
+/**
+ * Brand Portal — the asset viewer.
+ *
+ * Renders inside the existing overlay API (usePopup / injectPortal), the same
+ * surface as the image cropper, rather than sending the visitor to a browser
+ * tab.
+ *
+ * Efficiency rules that are load-bearing, not polish:
+ *  - page rendering is INJECTED by the host (`renderPage`) rather than importing
+ *    @bluepic/raster here. Embed ships a UMD build, and raster's root entry
+ *    carries CommonJS interop that Rollup cannot express in UMD (it emits an
+ *    invalid `var main.commonjsGlobal`). Injection also keeps the heavy engines
+ *    out of embed entirely — the host loads them only if it has documents.
+ *    Without a `renderPage`, paged types degrade to the download-only panel;
+ *  - one page is rendered at a time, at a DPR clamped to 2;
+ *  - at most PAGE_CACHE_LIMIT rendered pages are retained, so a 400-page PDF
+ *    cannot hold 400 canvases;
+ *  - in-flight work is abandoned on close/page-change — an orphaned
+ *    Ghostscript-WASM job otherwise keeps a phone warm long after the user left.
+ */
+export type ViewerAsset = {
+    id: string;
+    title: string;
+    filename: string;
+    mime: string;
+    size: number;
+    kind: 'image' | 'file';
+    previewUrl: string | null;
+    description?: string | null;
+    width?: number;
+    height?: number;
+    pageCount?: number;
+    /** Gated URL. Used both to fetch bytes for rasterization and to display media. */
+    downloadUrl: string;
+};
+type __VLS_Props = {
+    asset: ViewerAsset;
+    /**
+     * Render one page of a document into the supplied canvas. Supplied by the
+     * host (bx-template passes @bluepic/raster). Absent → no paged preview.
+     */
+    renderPage?: (bytes: ArrayBuffer, canvas: HTMLCanvasElement, opts: {
+        page: number;
+        dpi: number;
+    }) => Promise<void>;
+    /** Page count for a paged document, when the host can determine it. */
+    getPageCount?: (bytes: ArrayBuffer) => Promise<number>;
+};
+declare const _default: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {} & {
+    close: () => any;
+    download: (asset: ViewerAsset) => any;
+}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{
+    onClose?: (() => any) | undefined;
+    onDownload?: ((asset: ViewerAsset) => any) | undefined;
+}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+export default _default;