@rasterex/viewer 1.1.2 → 2.0.0

package/README.md

@@ -131,6 +131,73 @@ by your self-hosted Rasterex Canvas deployment.
 not the display name. It lets the server reuse already processed content for the
 same file, which can make repeat opens faster.
 
+### Document Loading Lifecycle
+
+Subscribe to document events before opening a file when your UI needs a loading
+indicator or error message. `opening` starts the loading state. `fileReady`
+confirms that Canvas has opened and activated the file; `fileLoadFailed` reports
+a Canvas-side open failure. The SDK also emits `failed` for setup, readiness,
+or timeout errors.
+
+Canvas does not provide a documented numeric document-progress callback through
+`viewer.documents`. Show an indeterminate loading indicator from `opening` until
+one of the terminal events arrives.
+
+```ts
+import { createViewer } from "@rasterex/viewer";
+
+const viewer = createViewer({ container: "#rx-viewer" });
+
+viewer.documents.on("opening", () => {
+  showLoadingIndicator();
+  clearOpenError();
+});
+
+viewer.documents.on("fileReady", (event) => {
+  hideLoadingIndicator();
+  console.log("File ready:", event.fileName);
+});
+
+viewer.documents.on("fileLoadFailed", (event) => {
+  console.error("Canvas could not open the file:", event.reason);
+});
+
+viewer.documents.on("failed", (event) => {
+  hideLoadingIndicator();
+  showOpenError(event.error.message);
+});
+
+await viewer.mount();
+await viewer.ready();
+
+try {
+  await viewer.documents.open({
+    url: "https://files.example.com/sample.pdf",
+    displayName: "sample.pdf"
+  });
+} catch {
+  // The `failed` event above has already updated the UI.
+}
+```
+
+For a browser-local file selected by the user, call `openFile(...)` after the
+same initialization and event setup:
+
+```ts
+const fileInput = document.querySelector<HTMLInputElement>("#file-input");
+const file = fileInput?.files?.[0];
+
+if (file) {
+  try {
+    await viewer.documents.openFile(file, {
+      cacheId: "file_7f3a9c2_sample_pdf"
+    });
+  } catch {
+    // The `failed` event above has already updated the UI.
+  }
+}
+```
+
 ### Create, Mount, And Open In One Call
 
 Use `createDocumentViewer` when the first action should be opening a document:
@@ -247,7 +314,7 @@ Hosted presets are exported from a separate entrypoint:
 
 ```ts
 import { createViewer } from "@rasterex/viewer";
-import { sandboxCanvas, takeoffDemo } from "@rasterex/viewer/demo-presets";
+import { sandboxCanvas } from "@rasterex/viewer/demo-presets";
 
 const viewer = createViewer({
   container: "#rx-viewer",
@@ -256,9 +323,6 @@ const viewer = createViewer({
 });
 ```
 
-Takeoff is not loaded by default. Use `takeoffDemo` only when your application
-explicitly selects that preset.
-
 ## Cleanup
 
 Destroy the viewer when the page, route, or component no longer needs it:

package/dist/constants.d.ts

@@ -1,4 +1,4 @@
-export declare const SDK_VERSION = "1.1.2";
+export declare const SDK_VERSION = "2.0.0";
 export declare const DEFAULT_VIEWER_URL = "https://sandbox.rasterex.com";
 export declare const DEFAULT_TARGET_ORIGIN = "https://sandbox.rasterex.com";
 export declare const DEFAULT_IFRAME_TITLE = "Rasterex Viewer";

package/dist/constants.js

@@ -1,4 +1,4 @@
-export const SDK_VERSION = "1.1.2";
+export const SDK_VERSION = "2.0.0";
 export const DEFAULT_VIEWER_URL = "https://sandbox.rasterex.com";
 export const DEFAULT_TARGET_ORIGIN = "https://sandbox.rasterex.com";
 export const DEFAULT_IFRAME_TITLE = "Rasterex Viewer";

package/dist/demo-presets.d.ts

@@ -12,13 +12,6 @@ export declare const betaViewerDemo: {
     targetOrigin: string;
     capabilities: readonly ["iframe"];
 };
-export declare const takeoffDemo: {
-    id: string;
-    label: string;
-    viewerUrl: string;
-    targetOrigin: string;
-    capabilities: readonly ["iframe"];
-};
 export declare const DEMO_VIEWER_PRESETS: {
     sandboxCanvas: {
         id: string;
@@ -34,12 +27,5 @@ export declare const DEMO_VIEWER_PRESETS: {
         targetOrigin: string;
         capabilities: readonly ["iframe"];
     };
-    takeoff: {
-        id: string;
-        label: string;
-        viewerUrl: string;
-        targetOrigin: string;
-        capabilities: readonly ["iframe"];
-    };
 };
 //# sourceMappingURL=demo-presets.d.ts.map

package/dist/demo-presets.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"demo-presets.d.ts","sourceRoot":"","sources":["../src/demo-presets.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,aAAa;;;;;;CAMzB,CAAC;AAEF,eAAO,MAAM,cAAc;;;;;;CAAgB,CAAC;AAE5C,eAAO,MAAM,WAAW;;;;;;CAMvB,CAAC;AAEF,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;CAI/B,CAAC"}
+{"version":3,"file":"demo-presets.d.ts","sourceRoot":"","sources":["../src/demo-presets.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,aAAa;;;;;;CAMzB,CAAC;AAEF,eAAO,MAAM,cAAc;;;;;;CAAgB,CAAC;AAE5C,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;CAG/B,CAAC"}

package/dist/demo-presets.js

@@ -7,16 +7,8 @@ export const sandboxCanvas = {
     capabilities: ["iframe"]
 };
 export const betaViewerDemo = sandboxCanvas;
-export const takeoffDemo = {
-    id: "takeoff",
-    label: "Takeoff Demo",
-    viewerUrl: "https://takeoff.viewsoft.com",
-    targetOrigin: "https://takeoff.viewsoft.com",
-    capabilities: ["iframe"]
-};
 export const DEMO_VIEWER_PRESETS = {
     sandboxCanvas,
-    betaViewer: sandboxCanvas,
-    takeoff: takeoffDemo
+    betaViewer: sandboxCanvas
 };
 //# sourceMappingURL=demo-presets.js.map

package/dist/demo-presets.js.map

@@ -1 +1 @@
-{"version":3,"file":"demo-presets.js","sourceRoot":"","sources":["../src/demo-presets.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EACrB,kBAAkB,EACnB,MAAM,gBAAgB,CAAC;AAExB,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,EAAE,EAAE,gBAAgB;IACpB,KAAK,EAAE,gBAAgB;IACvB,SAAS,EAAE,kBAAkB;IAC7B,YAAY,EAAE,qBAAqB;IACnC,YAAY,EAAE,CAAC,QAAQ,CAAU;CAClC,CAAC;AAEF,MAAM,CAAC,MAAM,cAAc,GAAG,aAAa,CAAC;AAE5C,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,EAAE,EAAE,SAAS;IACb,KAAK,EAAE,cAAc;IACrB,SAAS,EAAE,8BAA8B;IACzC,YAAY,EAAE,8BAA8B;IAC5C,YAAY,EAAE,CAAC,QAAQ,CAAU;CAClC,CAAC;AAEF,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC,aAAa;IACb,UAAU,EAAE,aAAa;IACzB,OAAO,EAAE,WAAW;CACrB,CAAC"}
+{"version":3,"file":"demo-presets.js","sourceRoot":"","sources":["../src/demo-presets.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EACrB,kBAAkB,EACnB,MAAM,gBAAgB,CAAC;AAExB,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,EAAE,EAAE,gBAAgB;IACpB,KAAK,EAAE,gBAAgB;IACvB,SAAS,EAAE,kBAAkB;IAC7B,YAAY,EAAE,qBAAqB;IACnC,YAAY,EAAE,CAAC,QAAQ,CAAU;CAClC,CAAC;AAEF,MAAM,CAAC,MAAM,cAAc,GAAG,aAAa,CAAC;AAE5C,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC,aAAa;IACb,UAAU,EAAE,aAAa;CAC1B,CAAC"}

package/dist/demoPresets.d.ts

@@ -1,2 +1,2 @@
-export { DEMO_VIEWER_PRESETS, betaViewerDemo, sandboxCanvas, takeoffDemo } from "./demo-presets.js";
+export { DEMO_VIEWER_PRESETS, betaViewerDemo, sandboxCanvas } from "./demo-presets.js";
 //# sourceMappingURL=demoPresets.d.ts.map

package/dist/demoPresets.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"demoPresets.d.ts","sourceRoot":"","sources":["../src/demoPresets.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,mBAAmB,EACnB,cAAc,EACd,aAAa,EACb,WAAW,EACZ,MAAM,mBAAmB,CAAC"}
+{"version":3,"file":"demoPresets.d.ts","sourceRoot":"","sources":["../src/demoPresets.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,mBAAmB,EACnB,cAAc,EACd,aAAa,EACd,MAAM,mBAAmB,CAAC"}

package/dist/demoPresets.js

@@ -1,2 +1,2 @@
-export { DEMO_VIEWER_PRESETS, betaViewerDemo, sandboxCanvas, takeoffDemo } from "./demo-presets.js";
+export { DEMO_VIEWER_PRESETS, betaViewerDemo, sandboxCanvas } from "./demo-presets.js";
 //# sourceMappingURL=demoPresets.js.map

package/dist/demoPresets.js.map

@@ -1 +1 @@
-{"version":3,"file":"demoPresets.js","sourceRoot":"","sources":["../src/demoPresets.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,mBAAmB,EACnB,cAAc,EACd,aAAa,EACb,WAAW,EACZ,MAAM,mBAAmB,CAAC"}
+{"version":3,"file":"demoPresets.js","sourceRoot":"","sources":["../src/demoPresets.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,mBAAmB,EACnB,cAAc,EACd,aAAa,EACd,MAAM,mBAAmB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rasterex/viewer",
-  "version": "1.1.2",
+  "version": "2.0.0",
   "description": "TypeScript SDK for embedding Rasterex Canvas in web applications via iframe and PostMessage. Built for customer self-hosted deployments; hosted Canvas is available for evaluation and proof-of-concept testing.",
   "author": {
     "name": "Rasterex Software AS",