@base2datadesign/viewer-kit 0.1.0

package/README.md

@@ -0,0 +1,5 @@
+# @base2datadesign/viewer-kit
+
+Framework-agnostic viewer core for Configurator products.
+
+This package will host the stable viewer API and “systems” (renderer/environment/lighting/postfx/debug).

package/dist/engine/createViewer.d.ts

@@ -0,0 +1,3 @@
+import type { ViewerCreateOptions, ViewerHandle } from "./types";
+export declare function createViewer(options: ViewerCreateOptions): ViewerHandle;
+//# sourceMappingURL=createViewer.d.ts.map

package/dist/engine/createViewer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createViewer.d.ts","sourceRoot":"","sources":["../../src/engine/createViewer.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,YAAY,EAAkB,MAAM,SAAS,CAAC;AAIjF,wBAAgB,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,YAAY,CA0DvE"}

package/dist/engine/createViewer.js

@@ -0,0 +1,57 @@
+// NOTE: Stub engine: this exists to stabilize API and publishing early.
+// Rendering systems (Three.js) will be implemented next without breaking the surface area.
+export function createViewer(options) {
+    const { hooks } = options;
+    let running = false;
+    let presetId = options.presetId;
+    const snapshot = () => ({
+        capturedAt: new Date().toISOString(),
+        presetId,
+        renderer: {
+            toneMapping: "NeutralToneMapping",
+            toneMappingExposure: 1.0,
+            outputColorSpace: "SRGBColorSpace",
+        },
+        environment: {
+            mode: "none",
+            backgroundEnabled: false,
+            lightingEnabled: false,
+        },
+    });
+    const handle = {
+        start() {
+            running = true;
+        },
+        stop() {
+            running = false;
+        },
+        resize() {
+            void running;
+        },
+        dispose() {
+            running = false;
+        },
+        setPreset(nextPresetId) {
+            presetId = nextPresetId;
+        },
+        setSceneRoot(_root) {
+            // placeholder
+        },
+        async capturePng() {
+            // placeholder blob (transparent 1x1 PNG)
+            const bytes = Uint8Array.from([
+                0x89, 0x50, 0x4e, 0x47, 0x0d, 0x0a, 0x1a, 0x0a, 0x00, 0x00, 0x00, 0x0d, 0x49, 0x48,
+                0x44, 0x52, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x01, 0x08, 0x06, 0x00, 0x00,
+                0x00, 0x1f, 0x15, 0xc4, 0x89, 0x00, 0x00, 0x00, 0x0a, 0x49, 0x44, 0x41, 0x54, 0x78,
+                0x9c, 0x63, 0x00, 0x01, 0x00, 0x00, 0x05, 0x00, 0x01, 0x0d, 0x0a, 0x2d, 0xb4, 0x00,
+                0x00, 0x00, 0x00, 0x49, 0x45, 0x4e, 0x44, 0xae, 0x42, 0x60, 0x82,
+            ]);
+            return new Blob([bytes], { type: "image/png" });
+        },
+        getSnapshot() {
+            return snapshot();
+        },
+    };
+    queueMicrotask(() => hooks?.onReady?.(handle));
+    return handle;
+}

package/dist/engine/types.d.ts

@@ -0,0 +1,40 @@
+export type AssetKind = "hdr" | "texture" | "cubeface";
+export type AssetResolverResult = {
+    url: string;
+    headers?: Record<string, string>;
+};
+export type AssetResolver = (src: string, kind: AssetKind) => Promise<AssetResolverResult>;
+export type ViewerSnapshot = {
+    capturedAt: string;
+    presetId: string;
+    renderer: {
+        toneMapping: string;
+        toneMappingExposure: number;
+        outputColorSpace: string;
+    };
+    environment: {
+        mode: "none" | "gradient" | "hdr" | "cube";
+        backgroundEnabled: boolean;
+        lightingEnabled: boolean;
+    };
+};
+export type ViewerCreateOptions = {
+    container: HTMLElement;
+    presetId: string;
+    assetResolver?: AssetResolver;
+    hooks?: {
+        onReady?: (handle: ViewerHandle) => void;
+        onError?: (error: unknown) => void;
+    };
+};
+export type ViewerHandle = {
+    start(): void;
+    stop(): void;
+    resize(): void;
+    dispose(): void;
+    setPreset(presetId: string): void;
+    setSceneRoot(root: unknown): void;
+    capturePng(): Promise<Blob>;
+    getSnapshot(): ViewerSnapshot;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/engine/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/engine/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,SAAS,GAAG,KAAK,GAAG,SAAS,GAAG,UAAU,CAAC;AAEvD,MAAM,MAAM,mBAAmB,GAAG;IAChC,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClC,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,KAAK,OAAO,CAAC,mBAAmB,CAAC,CAAC;AAE3F,MAAM,MAAM,cAAc,GAAG;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE;QACR,WAAW,EAAE,MAAM,CAAC;QACpB,mBAAmB,EAAE,MAAM,CAAC;QAC5B,gBAAgB,EAAE,MAAM,CAAC;KAC1B,CAAC;IACF,WAAW,EAAE;QACX,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,KAAK,GAAG,MAAM,CAAC;QAC3C,iBAAiB,EAAE,OAAO,CAAC;QAC3B,eAAe,EAAE,OAAO,CAAC;KAC1B,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,SAAS,EAAE,WAAW,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,KAAK,CAAC,EAAE;QACN,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,YAAY,KAAK,IAAI,CAAC;QACzC,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,CAAC;KACpC,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,KAAK,IAAI,IAAI,CAAC;IACd,IAAI,IAAI,IAAI,CAAC;IACb,MAAM,IAAI,IAAI,CAAC;IACf,OAAO,IAAI,IAAI,CAAC;IAEhB,SAAS,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,YAAY,CAAC,IAAI,EAAE,OAAO,GAAG,IAAI,CAAC;IAElC,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5B,WAAW,IAAI,cAAc,CAAC;CAC/B,CAAC"}

package/dist/engine/types.js

@@ -0,0 +1 @@
+export {};

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export type { ViewerCreateOptions, ViewerHandle, ViewerSnapshot } from "./engine/types";
+export { createViewer } from "./engine/createViewer";
+//# 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,YAAY,EAAE,mBAAmB,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AACxF,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC"}

package/dist/index.js

@@ -0,0 +1 @@
+export { createViewer } from "./engine/createViewer";

package/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "@base2datadesign/viewer-kit",
+  "version": "0.1.0",
+  "type": "module",
+  "license": "UNLICENSED",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc -b",
+    "typecheck": "tsc -b --pretty false --noEmit"
+  }
+}