@rasterex/viewer 1.0.0

package/dist/utils/compatibility.js

@@ -0,0 +1,170 @@
+import { PROTOCOL_VERSION, ERROR_CODES } from "../protocol/index.js";
+import { SDK_VERSION } from "../constants.js";
+import { SDK_COMPATIBILITY_MATRIX } from "../compat/matrix.js";
+import { RasterexViewerError } from "../errors.js";
+export function evaluateCompatibility(options) {
+    const invalidVersionField = getInvalidVersionField({
+        sdkVersion: SDK_VERSION,
+        protocolVersion: PROTOCOL_VERSION,
+        canvasProtocolVersion: options.protocolVersion,
+        canvasVersion: options.canvasVersion,
+        minimumSdkVersion: options.minimumSdkVersion
+    });
+    if (invalidVersionField) {
+        return {
+            result: {
+                state: "incompatible",
+                reason: `Invalid compatibility version value: ${invalidVersionField}.`
+            },
+            error: new RasterexViewerError({
+                code: ERROR_CODES.incompatibleCanvas,
+                message: `Invalid compatibility version value: ${invalidVersionField}.`,
+                canvasVersion: options.canvasVersion,
+                context: {
+                    field: invalidVersionField,
+                    sdkVersion: SDK_VERSION,
+                    protocolVersion: PROTOCOL_VERSION,
+                    canvasProtocolVersion: options.protocolVersion,
+                    canvasVersion: options.canvasVersion,
+                    minimumSdkVersion: options.minimumSdkVersion
+                }
+            })
+        };
+    }
+    const matrixEntry = SDK_COMPATIBILITY_MATRIX.find((entry) => entry.sdkVersion === SDK_VERSION &&
+        entry.protocolVersion === PROTOCOL_VERSION);
+    if (!matrixEntry) {
+        return {
+            result: {
+                state: "incompatible",
+                reason: "No compatibility matrix entry exists for this SDK/protocol pair."
+            },
+            error: new RasterexViewerError({
+                code: ERROR_CODES.incompatibleCanvas,
+                message: "No compatibility matrix entry exists for this SDK/protocol pair.",
+                context: {
+                    sdkVersion: SDK_VERSION,
+                    protocolVersion: PROTOCOL_VERSION
+                }
+            })
+        };
+    }
+    if (options.protocolVersion !== PROTOCOL_VERSION) {
+        return {
+            result: {
+                state: "incompatible",
+                reason: "Canvas protocol version does not match SDK protocol version."
+            },
+            error: new RasterexViewerError({
+                code: ERROR_CODES.incompatibleCanvas,
+                message: "Canvas protocol version does not match SDK protocol version.",
+                canvasVersion: options.canvasVersion,
+                context: {
+                    sdkProtocolVersion: PROTOCOL_VERSION,
+                    canvasProtocolVersion: options.protocolVersion
+                }
+            })
+        };
+    }
+    if (compareVersions(options.canvasVersion, matrixEntry.minimumCanvasVersion) < 0) {
+        return {
+            result: {
+                state: "incompatible",
+                reason: "Canvas version is below the minimum supported version."
+            },
+            error: new RasterexViewerError({
+                code: ERROR_CODES.incompatibleCanvas,
+                message: "Canvas version is below the minimum supported version.",
+                canvasVersion: options.canvasVersion,
+                context: {
+                    canvasVersion: options.canvasVersion,
+                    minimumCanvasVersion: matrixEntry.minimumCanvasVersion
+                }
+            })
+        };
+    }
+    if (compareVersions(SDK_VERSION, options.minimumSdkVersion) < 0) {
+        return {
+            result: {
+                state: "incompatible",
+                reason: "SDK version is below the minimum version required by Canvas."
+            },
+            error: new RasterexViewerError({
+                code: ERROR_CODES.incompatibleSdk,
+                message: "SDK version is below the minimum version required by Canvas.",
+                canvasVersion: options.canvasVersion,
+                context: {
+                    sdkVersion: SDK_VERSION,
+                    minimumSdkVersion: options.minimumSdkVersion
+                }
+            })
+        };
+    }
+    const unsupportedCapabilities = matrixEntry.requiredCapabilities.filter((capability) => !options.capabilities.includes(capability));
+    if (unsupportedCapabilities.length > 0) {
+        return {
+            result: {
+                state: "degraded",
+                reason: "Canvas does not advertise all SDK-required capabilities.",
+                unsupportedCapabilities
+            },
+            error: null
+        };
+    }
+    if (compareVersions(options.canvasVersion, matrixEntry.currentCanvasVersion) < 0) {
+        return {
+            result: {
+                state: "degraded",
+                reason: "Canvas version is supported but older than the current SDK target."
+            },
+            error: null
+        };
+    }
+    return {
+        result: {
+            state: "compatible"
+        },
+        error: null
+    };
+}
+export function compareVersions(left, right) {
+    assertVersion(left, "left");
+    assertVersion(right, "right");
+    const leftParts = parseVersionParts(left);
+    const rightParts = parseVersionParts(right);
+    const length = Math.max(leftParts.length, rightParts.length);
+    for (let index = 0; index < length; index += 1) {
+        const leftPart = leftParts[index] ?? 0;
+        const rightPart = rightParts[index] ?? 0;
+        if (leftPart > rightPart) {
+            return 1;
+        }
+        if (leftPart < rightPart) {
+            return -1;
+        }
+    }
+    return 0;
+}
+function getInvalidVersionField(versions) {
+    for (const [field, version] of Object.entries(versions)) {
+        if (!isVersionString(version)) {
+            return field;
+        }
+    }
+    return null;
+}
+function assertVersion(version, label) {
+    if (!isVersionString(version)) {
+        throw new RangeError(`${label} must be a dot-separated numeric version.`);
+    }
+}
+function isVersionString(version) {
+    return /^\d+(?:\.\d+)*$/.test(version);
+}
+function parseVersionParts(version) {
+    return version
+        .split(/[^0-9]+/)
+        .filter(Boolean)
+        .map((part) => Number.parseInt(part, 10));
+}
+//# sourceMappingURL=compatibility.js.map

package/dist/utils/compatibility.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"compatibility.js","sourceRoot":"","sources":["../../src/utils/compatibility.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,gBAAgB,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACrE,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,EAAE,wBAAwB,EAAE,MAAM,qBAAqB,CAAC;AAC/D,OAAO,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAcnD,MAAM,UAAU,qBAAqB,CACnC,OAAqC;IAErC,MAAM,mBAAmB,GAAG,sBAAsB,CAAC;QACjD,UAAU,EAAE,WAAW;QACvB,eAAe,EAAE,gBAAgB;QACjC,qBAAqB,EAAE,OAAO,CAAC,eAAe;QAC9C,aAAa,EAAE,OAAO,CAAC,aAAa;QACpC,iBAAiB,EAAE,OAAO,CAAC,iBAAiB;KAC7C,CAAC,CAAC;IAEH,IAAI,mBAAmB,EAAE,CAAC;QACxB,OAAO;YACL,MAAM,EAAE;gBACN,KAAK,EAAE,cAAc;gBACrB,MAAM,EAAE,wCAAwC,mBAAmB,GAAG;aACvE;YACD,KAAK,EAAE,IAAI,mBAAmB,CAAC;gBAC7B,IAAI,EAAE,WAAW,CAAC,kBAAkB;gBACpC,OAAO,EAAE,wCAAwC,mBAAmB,GAAG;gBACvE,aAAa,EAAE,OAAO,CAAC,aAAa;gBACpC,OAAO,EAAE;oBACP,KAAK,EAAE,mBAAmB;oBAC1B,UAAU,EAAE,WAAW;oBACvB,eAAe,EAAE,gBAAgB;oBACjC,qBAAqB,EAAE,OAAO,CAAC,eAAe;oBAC9C,aAAa,EAAE,OAAO,CAAC,aAAa;oBACpC,iBAAiB,EAAE,OAAO,CAAC,iBAAiB;iBAC7C;aACF,CAAC;SACH,CAAC;IACJ,CAAC;IAED,MAAM,WAAW,GAAG,wBAAwB,CAAC,IAAI,CAC/C,CAAC,KAAK,EAAE,EAAE,CACR,KAAK,CAAC,UAAU,KAAK,WAAW;QAChC,KAAK,CAAC,eAAe,KAAK,gBAAgB,CAC7C,CAAC;IAEF,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,OAAO;YACL,MAAM,EAAE;gBACN,KAAK,EAAE,cAAc;gBACrB,MAAM,EAAE,kEAAkE;aAC3E;YACD,KAAK,EAAE,IAAI,mBAAmB,CAAC;gBAC7B,IAAI,EAAE,WAAW,CAAC,kBAAkB;gBACpC,OAAO,EAAE,kEAAkE;gBAC3E,OAAO,EAAE;oBACP,UAAU,EAAE,WAAW;oBACvB,eAAe,EAAE,gBAAgB;iBAClC;aACF,CAAC;SACH,CAAC;IACJ,CAAC;IAED,IAAI,OAAO,CAAC,eAAe,KAAK,gBAAgB,EAAE,CAAC;QACjD,OAAO;YACL,MAAM,EAAE;gBACN,KAAK,EAAE,cAAc;gBACrB,MAAM,EAAE,8DAA8D;aACvE;YACD,KAAK,EAAE,IAAI,mBAAmB,CAAC;gBAC7B,IAAI,EAAE,WAAW,CAAC,kBAAkB;gBACpC,OAAO,EAAE,8DAA8D;gBACvE,aAAa,EAAE,OAAO,CAAC,aAAa;gBACpC,OAAO,EAAE;oBACP,kBAAkB,EAAE,gBAAgB;oBACpC,qBAAqB,EAAE,OAAO,CAAC,eAAe;iBAC/C;aACF,CAAC;SACH,CAAC;IACJ,CAAC;IAED,IAAI,eAAe,CAAC,OAAO,CAAC,aAAa,EAAE,WAAW,CAAC,oBAAoB,CAAC,GAAG,CAAC,EAAE,CAAC;QACjF,OAAO;YACL,MAAM,EAAE;gBACN,KAAK,EAAE,cAAc;gBACrB,MAAM,EAAE,wDAAwD;aACjE;YACD,KAAK,EAAE,IAAI,mBAAmB,CAAC;gBAC7B,IAAI,EAAE,WAAW,CAAC,kBAAkB;gBACpC,OAAO,EAAE,wDAAwD;gBACjE,aAAa,EAAE,OAAO,CAAC,aAAa;gBACpC,OAAO,EAAE;oBACP,aAAa,EAAE,OAAO,CAAC,aAAa;oBACpC,oBAAoB,EAAE,WAAW,CAAC,oBAAoB;iBACvD;aACF,CAAC;SACH,CAAC;IACJ,CAAC;IAED,IAAI,eAAe,CAAC,WAAW,EAAE,OAAO,CAAC,iBAAiB,CAAC,GAAG,CAAC,EAAE,CAAC;QAChE,OAAO;YACL,MAAM,EAAE;gBACN,KAAK,EAAE,cAAc;gBACrB,MAAM,EAAE,8DAA8D;aACvE;YACD,KAAK,EAAE,IAAI,mBAAmB,CAAC;gBAC7B,IAAI,EAAE,WAAW,CAAC,eAAe;gBACjC,OAAO,EAAE,8DAA8D;gBACvE,aAAa,EAAE,OAAO,CAAC,aAAa;gBACpC,OAAO,EAAE;oBACP,UAAU,EAAE,WAAW;oBACvB,iBAAiB,EAAE,OAAO,CAAC,iBAAiB;iBAC7C;aACF,CAAC;SACH,CAAC;IACJ,CAAC;IAED,MAAM,uBAAuB,GAAG,WAAW,CAAC,oBAAoB,CAAC,MAAM,CACrE,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,QAAQ,CAAC,UAAwB,CAAC,CACzE,CAAC;IAEF,IAAI,uBAAuB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACvC,OAAO;YACL,MAAM,EAAE;gBACN,KAAK,EAAE,UAAU;gBACjB,MAAM,EAAE,0DAA0D;gBAClE,uBAAuB;aACxB;YACD,KAAK,EAAE,IAAI;SACZ,CAAC;IACJ,CAAC;IAED,IAAI,eAAe,CAAC,OAAO,CAAC,aAAa,EAAE,WAAW,CAAC,oBAAoB,CAAC,GAAG,CAAC,EAAE,CAAC;QACjF,OAAO;YACL,MAAM,EAAE;gBACN,KAAK,EAAE,UAAU;gBACjB,MAAM,EAAE,oEAAoE;aAC7E;YACD,KAAK,EAAE,IAAI;SACZ,CAAC;IACJ,CAAC;IAED,OAAO;QACL,MAAM,EAAE;YACN,KAAK,EAAE,YAAY;SACpB;QACD,KAAK,EAAE,IAAI;KACZ,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,IAAY,EAAE,KAAa;IACzD,aAAa,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAC5B,aAAa,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAE9B,MAAM,SAAS,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAC1C,MAAM,UAAU,GAAG,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAC5C,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,MAAM,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC;IAE7D,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,MAAM,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC;QAC/C,MAAM,QAAQ,GAAG,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACvC,MAAM,SAAS,GAAG,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAEzC,IAAI,QAAQ,GAAG,SAAS,EAAE,CAAC;YACzB,OAAO,CAAC,CAAC;QACX,CAAC;QAED,IAAI,QAAQ,GAAG,SAAS,EAAE,CAAC;YACzB,OAAO,CAAC,CAAC,CAAC;QACZ,CAAC;IACH,CAAC;IAED,OAAO,CAAC,CAAC;AACX,CAAC;AAED,SAAS,sBAAsB,CAC7B,QAAgC;IAEhC,KAAK,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;QACxD,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC;YAC9B,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,aAAa,CAAC,OAAe,EAAE,KAAa;IACnD,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC;QAC9B,MAAM,IAAI,UAAU,CAAC,GAAG,KAAK,2CAA2C,CAAC,CAAC;IAC5E,CAAC;AACH,CAAC;AAED,SAAS,eAAe,CAAC,OAAe;IACtC,OAAO,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;AACzC,CAAC;AAED,SAAS,iBAAiB,CAAC,OAAe;IACxC,OAAO,OAAO;SACX,KAAK,CAAC,SAAS,CAAC;SAChB,MAAM,CAAC,OAAO,CAAC;SACf,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC;AAC9C,CAAC"}

package/dist/utils/createRequestId.d.ts

@@ -0,0 +1,2 @@
+export declare function createRequestId(): string;
+//# sourceMappingURL=createRequestId.d.ts.map

package/dist/utils/createRequestId.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createRequestId.d.ts","sourceRoot":"","sources":["../../src/utils/createRequestId.ts"],"names":[],"mappings":"AAEA,wBAAgB,eAAe,IAAI,MAAM,CAIxC"}

package/dist/utils/createRequestId.js

@@ -0,0 +1,6 @@
+let requestCounter = 0;
+export function createRequestId() {
+    requestCounter += 1;
+    return `req-${Date.now().toString(36)}-${requestCounter.toString(36)}`;
+}
+//# sourceMappingURL=createRequestId.js.map

package/dist/utils/createRequestId.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createRequestId.js","sourceRoot":"","sources":["../../src/utils/createRequestId.ts"],"names":[],"mappings":"AAAA,IAAI,cAAc,GAAG,CAAC,CAAC;AAEvB,MAAM,UAAU,eAAe;IAC7B,cAAc,IAAI,CAAC,CAAC;IAEpB,OAAO,OAAO,IAAI,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,IAAI,cAAc,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC;AACzE,CAAC"}

package/dist/utils/createSdkInstanceId.d.ts

@@ -0,0 +1,2 @@
+export declare function createSdkInstanceId(): string;
+//# sourceMappingURL=createSdkInstanceId.d.ts.map

package/dist/utils/createSdkInstanceId.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createSdkInstanceId.d.ts","sourceRoot":"","sources":["../../src/utils/createSdkInstanceId.ts"],"names":[],"mappings":"AAEA,wBAAgB,mBAAmB,IAAI,MAAM,CAI5C"}

package/dist/utils/createSdkInstanceId.js

@@ -0,0 +1,6 @@
+let sdkInstanceCounter = 0;
+export function createSdkInstanceId() {
+    sdkInstanceCounter += 1;
+    return `viewer-${Date.now().toString(36)}-${sdkInstanceCounter.toString(36)}`;
+}
+//# sourceMappingURL=createSdkInstanceId.js.map

package/dist/utils/createSdkInstanceId.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createSdkInstanceId.js","sourceRoot":"","sources":["../../src/utils/createSdkInstanceId.ts"],"names":[],"mappings":"AAAA,IAAI,kBAAkB,GAAG,CAAC,CAAC;AAE3B,MAAM,UAAU,mBAAmB;IACjC,kBAAkB,IAAI,CAAC,CAAC;IAExB,OAAO,UAAU,IAAI,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,IAAI,kBAAkB,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC;AAChF,CAAC"}

package/dist/utils/deriveOrigin.d.ts

@@ -0,0 +1,2 @@
+export declare function deriveOrigin(viewerUrl: string): string;
+//# sourceMappingURL=deriveOrigin.d.ts.map

package/dist/utils/deriveOrigin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deriveOrigin.d.ts","sourceRoot":"","sources":["../../src/utils/deriveOrigin.ts"],"names":[],"mappings":"AAAA,wBAAgB,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAEtD"}

package/dist/utils/deriveOrigin.js

@@ -0,0 +1,4 @@
+export function deriveOrigin(viewerUrl) {
+    return new URL(viewerUrl).origin;
+}
+//# sourceMappingURL=deriveOrigin.js.map

package/dist/utils/deriveOrigin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deriveOrigin.js","sourceRoot":"","sources":["../../src/utils/deriveOrigin.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,YAAY,CAAC,SAAiB;IAC5C,OAAO,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC;AACnC,CAAC"}

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@rasterex/viewer",
+  "version": "1.0.0",
+  "description": "Framework-independent Rasterex hosted viewer iframe SDK.",
+  "type": "module",
+  "sideEffects": false,
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./demo-presets": {
+      "types": "./dist/demo-presets.d.ts",
+      "import": "./dist/demo-presets.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE",
+    "SECURITY.md"
+  ],
+  "scripts": {
+    "clean": "node -e \"require('node:fs').rmSync('dist', { recursive: true, force: true })\"",
+    "build": "npm run clean && npm run build:sdk",
+    "build:sdk": "tsc -p tsconfig.json",
+    "dev": "vite examples/vanilla"
+  },
+  "keywords": [
+    "rasterex",
+    "canvas",
+    "viewer",
+    "iframe"
+  ],
+  "license": "MIT",
+  "devDependencies": {
+    "typescript": "^5.4.5",
+    "vite": "^8.0.16"
+  }
+}