@dice-o-rolla/dice-renderer 0.1.0 → 0.2.0

package/README.md

@@ -9,4 +9,8 @@ implementation is available from `@dice-o-rolla/dice-renderer-three`.
 import type { DiceRenderer, RendererTheme } from '@dice-o-rolla/dice-renderer';
 ```
 
+The package also exports `VisualPresetRegistry`. Preset descriptors contain geometry, scaling,
+labels, value mapping, and optional opaque asset IDs, but never load skins or sounds. A renderer is
+not required to depend on `@dice-o-rolla/dice-assets`.
+
 Licensed under Apache-2.0. See `LICENSE`, `NOTICE`, and `THIRD_PARTY_NOTICES.md` in the package.

package/dist/index.d.ts

@@ -1 +1,2 @@
 export type { DiceRenderer, RenderDieState, RendererTheme, RendererViewport, RenderTransform, } from './types.js';
+export { createVisualPresetDescriptor, VisualPresetRegistry, type RegisterVisualPresetOptions, type VisualPresetDescriptor, type VisualPresetMetadataValue, } from './visual-preset-registry.js';

package/dist/index.js

@@ -0,0 +1 @@
+export { createVisualPresetDescriptor, VisualPresetRegistry, } from './visual-preset-registry.js';

package/dist/types.d.ts

@@ -1,11 +1,14 @@
 import type { QuaternionLike, Vector3Like } from '@dice-o-rolla/dice-core';
+import type { VisualPresetDescriptor } from './visual-preset-registry.js';
 export interface RenderTransform {
     readonly position: Vector3Like;
     readonly quaternion: QuaternionLike;
 }
 export interface RenderDieState {
     readonly id: string;
+    readonly presetId: string;
     readonly geometryId: string;
+    readonly scale: number;
     readonly faceLabels?: Readonly<Record<number, string | number>>;
     readonly previous: RenderTransform;
     readonly current: RenderTransform;
@@ -24,6 +27,8 @@ export interface RendererTheme {
 }
 export interface DiceRenderer {
     initialize(): Promise<void> | void;
+    registerPreset(preset: VisualPresetDescriptor): void;
+    unregisterPreset(id: string): void;
     createDie(state: RenderDieState): void;
     updateDie(state: RenderDieState): void;
     removeDie(id: string): void;

package/dist/visual-preset-registry.d.ts

@@ -0,0 +1,26 @@
+export type VisualPresetMetadataValue = string | number | boolean;
+export interface VisualPresetDescriptor {
+    readonly id: string;
+    readonly dieType: string;
+    readonly geometryId: string;
+    readonly scale?: number;
+    readonly skinId?: string;
+    readonly soundPackId?: string;
+    readonly faceLabels?: Readonly<Record<number, string | number>>;
+    readonly valueMap?: Readonly<Record<number, number>>;
+    readonly metadata?: Readonly<Record<string, VisualPresetMetadataValue>>;
+}
+export interface RegisterVisualPresetOptions {
+    readonly replace?: boolean;
+}
+export declare function createVisualPresetDescriptor(source: VisualPresetDescriptor): VisualPresetDescriptor;
+export declare class VisualPresetRegistry {
+    #private;
+    constructor(presets?: readonly VisualPresetDescriptor[]);
+    get revision(): number;
+    register(source: VisualPresetDescriptor, options?: RegisterVisualPresetOptions): VisualPresetDescriptor;
+    unregister(id: string): VisualPresetDescriptor | undefined;
+    get(id: string): VisualPresetDescriptor | undefined;
+    has(id: string): boolean;
+    list(): readonly VisualPresetDescriptor[];
+}

package/dist/visual-preset-registry.js

@@ -0,0 +1,100 @@
+const PRESET_ID_PATTERN = /^[a-z0-9][a-z0-9._:-]*$/i;
+function assertIdentifier(value, name) {
+    if (!PRESET_ID_PATTERN.test(value)) {
+        throw new RangeError(`${name} must be a non-empty portable identifier`);
+    }
+}
+function cloneNumericRecord(source, name) {
+    if (source === undefined)
+        return undefined;
+    const copy = {};
+    for (const [rawKey, value] of Object.entries(source)) {
+        const key = Number(rawKey);
+        if (!Number.isSafeInteger(key) || key <= 0) {
+            throw new RangeError(`${name} keys must be positive safe integers`);
+        }
+        if (typeof value === 'number' && !Number.isSafeInteger(value)) {
+            throw new RangeError(`${name} numeric values must be safe integers`);
+        }
+        copy[key] = value;
+    }
+    return Object.freeze(copy);
+}
+function cloneMetadata(source) {
+    if (source === undefined)
+        return undefined;
+    const copy = {};
+    for (const [key, value] of Object.entries(source)) {
+        if (key.length === 0)
+            throw new RangeError('metadata keys must not be empty');
+        if (typeof value === 'number' && !Number.isFinite(value)) {
+            throw new RangeError('metadata numeric values must be finite');
+        }
+        copy[key] = value;
+    }
+    return Object.freeze(copy);
+}
+export function createVisualPresetDescriptor(source) {
+    assertIdentifier(source.id, 'id');
+    assertIdentifier(source.dieType, 'dieType');
+    assertIdentifier(source.geometryId, 'geometryId');
+    if (source.skinId !== undefined)
+        assertIdentifier(source.skinId, 'skinId');
+    if (source.soundPackId !== undefined)
+        assertIdentifier(source.soundPackId, 'soundPackId');
+    const scale = source.scale ?? 1;
+    if (!Number.isFinite(scale) || scale <= 0) {
+        throw new RangeError('scale must be a positive finite number');
+    }
+    const faceLabels = cloneNumericRecord(source.faceLabels, 'faceLabels');
+    const valueMap = cloneNumericRecord(source.valueMap, 'valueMap');
+    const metadata = cloneMetadata(source.metadata);
+    return Object.freeze({
+        id: source.id,
+        dieType: source.dieType,
+        geometryId: source.geometryId,
+        scale,
+        ...(source.skinId === undefined ? {} : { skinId: source.skinId }),
+        ...(source.soundPackId === undefined ? {} : { soundPackId: source.soundPackId }),
+        ...(faceLabels === undefined ? {} : { faceLabels }),
+        ...(valueMap === undefined ? {} : { valueMap }),
+        ...(metadata === undefined ? {} : { metadata }),
+    });
+}
+export class VisualPresetRegistry {
+    #presets = new Map();
+    #revision = 0;
+    constructor(presets = []) {
+        for (const preset of presets)
+            this.register(preset);
+    }
+    get revision() {
+        return this.#revision;
+    }
+    register(source, options = {}) {
+        const preset = createVisualPresetDescriptor(source);
+        if (this.#presets.has(preset.id) && options.replace !== true) {
+            throw new Error(`Visual preset "${preset.id}" is already registered`);
+        }
+        this.#presets.set(preset.id, preset);
+        this.#revision += 1;
+        return preset;
+    }
+    unregister(id) {
+        const preset = this.#presets.get(id);
+        if (preset === undefined)
+            return undefined;
+        this.#presets.delete(id);
+        this.#revision += 1;
+        return preset;
+    }
+    get(id) {
+        return this.#presets.get(id);
+    }
+    has(id) {
+        return this.#presets.has(id);
+    }
+    list() {
+        return Object.freeze(Array.from(this.#presets.values()));
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dice-o-rolla/dice-renderer",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Renderer-neutral dice snapshots, themes, and rendering lifecycle contracts.",
   "keywords": [
     "dice",
@@ -8,7 +8,16 @@
     "renderer",
     "typescript"
   ],
+  "homepage": "https://github.com/creepiest-space/dice-o-rolla#readme",
+  "bugs": {
+    "url": "https://github.com/creepiest-space/dice-o-rolla/issues"
+  },
   "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/creepiest-space/dice-o-rolla.git",
+    "directory": "packages/dice-renderer"
+  },
   "files": [
     "dist",
     "README.md",
@@ -31,7 +40,7 @@
     "registry": "https://registry.npmjs.org/"
   },
   "dependencies": {
-    "@dice-o-rolla/dice-core": "0.1.0"
+    "@dice-o-rolla/dice-core": "0.2.0"
   },
   "engines": {
     "node": ">=20.0.0"