@dvina/artifact-renderer-core 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Dvina
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS 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 NONINFRINGEMENT. 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 OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,7 @@
+# @dvina/artifact-renderer-core
+
+Advanced shared types for the Dvina Artifact Renderer.
+
+Most users should install `@dvina/artifact-renderer` instead of this package directly.
+
+Use this package only if you need the underlying document, theme, telemetry, or renderer contract types separately.

package/dist/index.d.ts

@@ -0,0 +1,108 @@
+export type ViewerFormat = "pdf" | "docx" | "xls" | "xlsx" | "csv" | "pptx" | "audio" | "image" | "video" | "zip" | "epub" | "text" | "code" | "html" | "markdown" | "mermaid" | "json" | "jsonl" | "ndjson" | "tsv" | "xml" | "toml" | "ini" | "dotenv" | "yaml" | "unknown";
+export type ViewerJsonPrimitive = string | number | boolean | null;
+export type ViewerJsonValue = ViewerJsonPrimitive | {
+    [key: string]: ViewerJsonValue;
+} | ViewerJsonValue[];
+export type HtmlSandboxCapability = "allow-downloads" | "allow-forms" | "allow-modals" | "allow-pointer-lock" | "allow-popups" | "allow-popups-to-escape-sandbox" | "allow-same-origin" | "allow-scripts" | "allow-top-navigation-by-user-activation";
+export type ViewerThemeMode = "light" | "dark";
+export interface ViewerThemeTokens {
+    surface?: string;
+    surfaceMuted?: string;
+    text?: string;
+    accent?: string;
+}
+export interface ViewerTheme {
+    mode: ViewerThemeMode;
+    tokens?: ViewerThemeTokens;
+}
+export interface ViewerUrlSource {
+    kind: "url";
+    url: string;
+}
+export interface ViewerSessionSource {
+    kind: "session";
+    sessionId: string;
+}
+export type ViewerSource = ViewerUrlSource | ViewerSessionSource;
+export interface ViewerDocument {
+    id: string;
+    name: string;
+    format: ViewerFormat;
+    source: ViewerSource;
+    renderOptions?: ViewerRenderOptions;
+    previewUrl?: string;
+    mimeType?: string;
+    size?: number;
+    downloadUrl?: string;
+    openUrl?: string;
+}
+export type SpreadsheetRenderMode = "fast" | "styled";
+export interface HtmlRenderOptions {
+    revisionId?: string;
+    artifactData?: ViewerJsonValue;
+    sandbox?: HtmlSandboxCapability[];
+    bootstrap?: "auto" | "off";
+}
+export interface ViewerRenderOptions {
+    spreadsheetMode?: SpreadsheetRenderMode;
+    codeLanguage?: string;
+    html?: HtmlRenderOptions;
+}
+export type ViewerCapability = "load-document" | "pagination" | "slide-navigation" | "download" | "open-externally" | "resize-notifications" | "artifact-runtime";
+export type ViewerState = "booting" | "waiting-for-init" | "initializing" | "loading-document" | "ready" | "unsupported" | "error";
+export type ViewerUnsupportedReason = "format-not-supported" | "encrypted-document" | "missing-renderer" | "feature-not-available";
+export type ViewerFallbackAction = "download" | "open-externally" | "retry";
+export type ViewerTelemetryLevel = "info" | "warn" | "error";
+export type ViewerErrorCode = "invalid-message" | "origin-mismatch" | "session-expired" | "document-fetch-failed" | "renderer-failed" | "timeout";
+export interface ViewerUnsupportedDetails {
+    reason: ViewerUnsupportedReason;
+    message: string;
+    recommendedAction: ViewerFallbackAction;
+}
+export interface ViewerErrorDetails {
+    code: ViewerErrorCode;
+    message: string;
+    recoverable: boolean;
+    recommendedAction?: ViewerFallbackAction;
+}
+export interface ViewerTelemetryRecord {
+    name: string;
+    level: ViewerTelemetryLevel;
+    message: string;
+    context?: Record<string, string | number | boolean | null>;
+}
+export interface ViewerNavigationState {
+    kind: "none" | "pages" | "slides";
+    index: number;
+    total: number;
+}
+export interface ViewerRenderContext {
+    container: HTMLElement;
+    document: ViewerDocument;
+    theme?: ViewerTheme;
+    sessionToken?: string;
+}
+export interface ViewerRenderResult {
+    navigation?: ViewerNavigationState;
+}
+export interface ViewerRenderer {
+    readonly id: string;
+    readonly supportedFormats: readonly ViewerFormat[];
+    readonly capabilities: readonly ViewerCapability[];
+    canRender(document: ViewerDocument): boolean;
+    render(context: ViewerRenderContext): Promise<ViewerRenderResult>;
+    destroy?(): Promise<void> | void;
+}
+export interface SupportedRendererMatch {
+    kind: "supported";
+    renderer: ViewerRenderer;
+}
+export interface UnsupportedRendererMatch {
+    kind: "unsupported";
+    unsupported: ViewerUnsupportedDetails;
+}
+export type ViewerRendererMatch = SupportedRendererMatch | UnsupportedRendererMatch;
+export declare function isViewerUrlSource(source: ViewerSource): source is ViewerUrlSource;
+export declare function isViewerSessionSource(source: ViewerSource): source is ViewerSessionSource;
+export declare function resolveRenderer(document: ViewerDocument, renderers: readonly ViewerRenderer[]): ViewerRendererMatch;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,YAAY,GACpB,KAAK,GACL,MAAM,GACN,KAAK,GACL,MAAM,GACN,KAAK,GACL,MAAM,GACN,OAAO,GACP,OAAO,GACP,OAAO,GACP,KAAK,GACL,MAAM,GACN,MAAM,GACN,MAAM,GACN,MAAM,GACN,UAAU,GACV,SAAS,GACT,MAAM,GACN,OAAO,GACP,QAAQ,GACR,KAAK,GACL,KAAK,GACL,MAAM,GACN,KAAK,GACL,QAAQ,GACR,MAAM,GACN,SAAS,CAAC;AAEd,MAAM,MAAM,mBAAmB,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC;AAEnE,MAAM,MAAM,eAAe,GACvB,mBAAmB,GACnB;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,eAAe,CAAA;CAAE,GAClC,eAAe,EAAE,CAAC;AAEtB,MAAM,MAAM,qBAAqB,GAC7B,iBAAiB,GACjB,aAAa,GACb,cAAc,GACd,oBAAoB,GACpB,cAAc,GACd,gCAAgC,GAChC,mBAAmB,GACnB,eAAe,GACf,yCAAyC,CAAC;AAE9C,MAAM,MAAM,eAAe,GAAG,OAAO,GAAG,MAAM,CAAC;AAE/C,MAAM,WAAW,iBAAiB;IAChC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,eAAe,CAAC;IACtB,MAAM,CAAC,EAAE,iBAAiB,CAAC;CAC5B;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,KAAK,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,SAAS,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,MAAM,YAAY,GAAG,eAAe,GAAG,mBAAmB,CAAC;AAEjE,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,YAAY,CAAC;IACrB,MAAM,EAAE,YAAY,CAAC;IACrB,aAAa,CAAC,EAAE,mBAAmB,CAAC;IACpC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,MAAM,qBAAqB,GAAG,MAAM,GAAG,QAAQ,CAAC;AAEtD,MAAM,WAAW,iBAAiB;IAChC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,eAAe,CAAC;IAC/B,OAAO,CAAC,EAAE,qBAAqB,EAAE,CAAC;IAClC,SAAS,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;CAC5B;AAED,MAAM,WAAW,mBAAmB;IAClC,eAAe,CAAC,EAAE,qBAAqB,CAAC;IACxC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,IAAI,CAAC,EAAE,iBAAiB,CAAC;CAC1B;AAED,MAAM,MAAM,gBAAgB,GACxB,eAAe,GACf,YAAY,GACZ,kBAAkB,GAClB,UAAU,GACV,iBAAiB,GACjB,sBAAsB,GACtB,kBAAkB,CAAC;AAEvB,MAAM,MAAM,WAAW,GACnB,SAAS,GACT,kBAAkB,GAClB,cAAc,GACd,kBAAkB,GAClB,OAAO,GACP,aAAa,GACb,OAAO,CAAC;AAEZ,MAAM,MAAM,uBAAuB,GAC/B,sBAAsB,GACtB,oBAAoB,GACpB,kBAAkB,GAClB,uBAAuB,CAAC;AAE5B,MAAM,MAAM,oBAAoB,GAAG,UAAU,GAAG,iBAAiB,GAAG,OAAO,CAAC;AAE5E,MAAM,MAAM,oBAAoB,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;AAE7D,MAAM,MAAM,eAAe,GACvB,iBAAiB,GACjB,iBAAiB,GACjB,iBAAiB,GACjB,uBAAuB,GACvB,iBAAiB,GACjB,SAAS,CAAC;AAEd,MAAM,WAAW,wBAAwB;IACvC,MAAM,EAAE,uBAAuB,CAAC;IAChC,OAAO,EAAE,MAAM,CAAC;IAChB,iBAAiB,EAAE,oBAAoB,CAAC;CACzC;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,eAAe,CAAC;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,OAAO,CAAC;IACrB,iBAAiB,CAAC,EAAE,oBAAoB,CAAC;CAC1C;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,oBAAoB,CAAC;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC,CAAC;CAC5D;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,MAAM,GAAG,OAAO,GAAG,QAAQ,CAAC;IAClC,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,mBAAmB;IAClC,SAAS,EAAE,WAAW,CAAC;IACvB,QAAQ,EAAE,cAAc,CAAC;IACzB,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,kBAAkB;IACjC,UAAU,CAAC,EAAE,qBAAqB,CAAC;CACpC;AAED,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,gBAAgB,EAAE,SAAS,YAAY,EAAE,CAAC;IACnD,QAAQ,CAAC,YAAY,EAAE,SAAS,gBAAgB,EAAE,CAAC;IACnD,SAAS,CAAC,QAAQ,EAAE,cAAc,GAAG,OAAO,CAAC;IAC7C,MAAM,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAClE,OAAO,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;CAClC;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,WAAW,CAAC;IAClB,QAAQ,EAAE,cAAc,CAAC;CAC1B;AAED,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,aAAa,CAAC;IACpB,WAAW,EAAE,wBAAwB,CAAC;CACvC;AAED,MAAM,MAAM,mBAAmB,GAAG,sBAAsB,GAAG,wBAAwB,CAAC;AAEpF,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,YAAY,GAAG,MAAM,IAAI,eAAe,CAEjF;AAED,wBAAgB,qBAAqB,CACnC,MAAM,EAAE,YAAY,GACnB,MAAM,IAAI,mBAAmB,CAE/B;AAED,wBAAgB,eAAe,CAC7B,QAAQ,EAAE,cAAc,EACxB,SAAS,EAAE,SAAS,cAAc,EAAE,GACnC,mBAAmB,CAkBrB"}

package/dist/index.js

@@ -0,0 +1,24 @@
+export function isViewerUrlSource(source) {
+    return source.kind === "url";
+}
+export function isViewerSessionSource(source) {
+    return source.kind === "session";
+}
+export function resolveRenderer(document, renderers) {
+    const renderer = renderers.find((candidate) => candidate.canRender(document));
+    if (renderer) {
+        return {
+            kind: "supported",
+            renderer,
+        };
+    }
+    return {
+        kind: "unsupported",
+        unsupported: {
+            reason: "missing-renderer",
+            message: `No renderer is registered for format \"${document.format}\".`,
+            recommendedAction: document.downloadUrl ? "download" : "open-externally",
+        },
+    };
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAkMA,MAAM,UAAU,iBAAiB,CAAC,MAAoB;IACpD,OAAO,MAAM,CAAC,IAAI,KAAK,KAAK,CAAC;AAC/B,CAAC;AAED,MAAM,UAAU,qBAAqB,CACnC,MAAoB;IAEpB,OAAO,MAAM,CAAC,IAAI,KAAK,SAAS,CAAC;AACnC,CAAC;AAED,MAAM,UAAU,eAAe,CAC7B,QAAwB,EACxB,SAAoC;IAEpC,MAAM,QAAQ,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;IAE9E,IAAI,QAAQ,EAAE,CAAC;QACb,OAAO;YACL,IAAI,EAAE,WAAW;YACjB,QAAQ;SACT,CAAC;IACJ,CAAC;IAED,OAAO;QACL,IAAI,EAAE,aAAa;QACnB,WAAW,EAAE;YACX,MAAM,EAAE,kBAAkB;YAC1B,OAAO,EAAE,0CAA0C,QAAQ,CAAC,MAAM,KAAK;YACvE,iBAAiB,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,iBAAiB;SACzE;KACF,CAAC;AACJ,CAAC"}

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@dvina/artifact-renderer-core",
+  "version": "0.0.1",
+  "description": "Core types and renderer contracts for Dvina Artifact Renderer.",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "license": "MIT",
+  "sideEffects": false,
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/dvina/artifact-renderer.git",
+    "directory": "packages/core"
+  },
+  "homepage": "https://github.com/dvina/artifact-renderer#readme",
+  "bugs": {
+    "url": "https://github.com/dvina/artifact-renderer/issues"
+  },
+  "keywords": [
+    "dvina",
+    "artifact-renderer",
+    "iframe",
+    "viewer",
+    "types"
+  ],
+  "engines": {
+    "node": ">=20"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "check": "tsc -p tsconfig.json --noEmit"
+  }
+}