dsh-3d-viewer 0.1.0 → 0.2.0

package/scripts/embed-hdri.mjs

@@ -1,70 +0,0 @@
-import { mkdir, readFile, stat, writeFile } from 'node:fs/promises';
-import { dirname, resolve } from 'node:path';
-import { fileURLToPath } from 'node:url';
-
-const root = resolve(dirname(fileURLToPath(import.meta.url)), '..');
-const files = {
-  nature: 'nature.hdr',
-  city: 'city.hdr',
-  indoor: 'indoor.hdr',
-  studio: 'studio.hdr',
-};
-
-const targetPath = resolve(root, 'src', 'generated', 'hdri-data.js');
-const scriptPath = fileURLToPath(import.meta.url);
-
-async function mtime(path) {
-  try {
-    return (await stat(path)).mtimeMs;
-  } catch {
-    return 0;
-  }
-}
-
-async function isUpToDate() {
-  const targetInfo = await stat(targetPath).catch(() => null);
-  if (targetInfo === null || targetInfo.size === 0) return false;
-
-  const assets = Object.values(files).map((file) => resolve(root, 'assets', 'hdri', file));
-  const newestSource = Math.max(await mtime(scriptPath), ...(await Promise.all(assets.map(mtime))));
-  return targetInfo.mtimeMs >= newestSource;
-}
-
-/**
- * Embed the four CC0 HDRIs into a generated ES module.
- *
- * The generated module is reused when it is newer than every source asset, so
- * repeated builds do not re-read and re-encode ~8.7 MB of base64 text.
- *
- * @param {{ force?: boolean }} [options] Regenerate even when the cache is fresh.
- * @returns {Promise<boolean>} Whether the file was rewritten.
- */
-export async function embedHdri({ force = false } = {}) {
-  if (!force && await isUpToDate()) {
-    console.log('Embedded HDRIs are up to date; skipped regeneration.');
-    return false;
-  }
-
-  const entries = [];
-  for (const [id, file] of Object.entries(files)) {
-    const data = await readFile(resolve(root, 'assets', 'hdri', file));
-    const dataUrl = `data:application/octet-stream;base64,${data.toString('base64')}`;
-    entries.push(`  ${id}: ${JSON.stringify(dataUrl)},`);
-  }
-
-  const source = `// Generated by scripts/embed-hdri.mjs from assets/hdri/*.hdr. Do not edit.
-// HDRIs are Poly Haven CC0 assets; see assets/hdri/LICENSE.md.
-export const HDRI_DATA_URLS = {
-${entries.join('\n')}
-};
-`;
-  await mkdir(dirname(targetPath), { recursive: true });
-  await writeFile(targetPath, source);
-  console.log(`Embedded ${entries.length} HDRIs into src/generated/hdri-data.js.`);
-  return true;
-}
-
-const invokedDirectly = process.argv[1] !== undefined
-  && resolve(process.argv[1]) === fileURLToPath(import.meta.url);
-
-if (invokedDirectly) await embedHdri({ force: process.argv.includes('--force') });

package/src/bytes.js

@@ -1,158 +0,0 @@
-/**
- * Byte, text, and path helpers shared by the model loaders.
- *
- * The loaders previously carried their own copies of these conversions
- * (`toArrayBuffer`, `decodeText`, `localPath`, `mimeOf`, `abortError`), which
- * drifted apart over time. One module keeps their edge cases consistent.
- */
-
-/** URLs Three.js resolves itself instead of the DSH workspace. */
-export const REMOTE_URL = /^(?:data:|blob:|https?:|file:|\/\/)/iu;
-
-/** Local paths anchored at a drive letter or a POSIX root. */
-export const ABSOLUTE_PATH = /^(?:[A-Za-z]:[\\/]|\/)/u;
-
-const MIME_TYPES = new Map([
-  ['bin', 'application/octet-stream'],
-  ['png', 'image/png'],
-  ['jpg', 'image/jpeg'],
-  ['jpeg', 'image/jpeg'],
-  ['webp', 'image/webp'],
-  ['gif', 'image/gif'],
-  ['bmp', 'image/bmp'],
-  ['tga', 'image/x-tga'],
-  ['dds', 'image/vnd-ms.dds'],
-  ['exr', 'image/x-exr'],
-  ['hdr', 'image/vnd.radiance'],
-]);
-
-const UTF8 = new TextDecoder('utf-8');
-
-/**
- * Copy preview bytes into a standalone ArrayBuffer.
- *
- * A view into a larger buffer is copied, so the returned payload never keeps
- * the document-preview store's memory alive. Text is encoded as UTF-8 for the
- * loaders that also accept a decoded document.
- *
- * @param {Uint8Array | ArrayBuffer | string} data Complete file bytes or text.
- * @returns {ArrayBuffer} A standalone payload.
- */
-export function toArrayBuffer(data) {
-  if (data instanceof ArrayBuffer) return data;
-  if (ArrayBuffer.isView(data)) {
-    return data.buffer.slice(data.byteOffset, data.byteOffset + data.byteLength);
-  }
-  if (typeof data === 'string') return new TextEncoder().encode(data).buffer;
-  throw new TypeError('The 3D preview was not given binary data');
-}
-
-/**
- * View preview bytes as a Uint8Array without copying, encoding text inputs.
- *
- * @param {Uint8Array | ArrayBuffer | string} data Complete file bytes or text.
- * @returns {Uint8Array} Byte view of the payload.
- */
-export function toBytes(data) {
-  if (data instanceof ArrayBuffer) return new Uint8Array(data);
-  if (ArrayBuffer.isView(data)) {
-    return new Uint8Array(data.buffer, data.byteOffset, data.byteLength);
-  }
-  if (typeof data === 'string') return new TextEncoder().encode(data);
-  throw new TypeError('The 3D preview was not given model data');
-}
-
-/**
- * Decode text-format model data, decoding bytes as UTF-8.
- *
- * @param {Uint8Array | ArrayBuffer | string} data Complete file bytes or text.
- * @returns {string} Decoded text.
- */
-export function decodeText(data) {
-  if (typeof data === 'string') return data;
-  if (data instanceof ArrayBuffer) return UTF8.decode(data);
-  if (ArrayBuffer.isView(data)) return UTF8.decode(data);
-  throw new TypeError('The 3D preview was not given model data');
-}
-
-/**
- * Turn a loader URL into a workspace-relative path.
- *
- * Query and fragment suffixes are dropped and percent escapes are decoded;
- * backslashes are normalized so Windows-authored MTL/FBX/glTF references
- * resolve on every platform.
- *
- * @param {string} value Loader URL or asset path.
- * @returns {string} Normalized forward-slash path.
- */
-export function decodeLocalPath(value) {
-  const withoutSuffix = String(value).split(/[?#]/u, 1)[0];
-  try {
-    return decodeURIComponent(withoutSuffix).replaceAll('\\', '/');
-  } catch {
-    return withoutSuffix.replaceAll('\\', '/');
-  }
-}
-
-/**
- * Whether a loader URL must be read from the session workspace.
- *
- * @param {unknown} value Loader URL or asset path.
- * @returns {boolean} True for relative or absolute local paths.
- */
-export function isLocalPath(value) {
-  return typeof value === 'string' && value !== '' && REMOTE_URL.test(value) === false;
-}
-
-/**
- * Guess a blob MIME type from a file name.
- *
- * @param {unknown} value File name, path, or loader URL.
- * @returns {string} A MIME type, defaulting to application/octet-stream.
- */
-export function mimeOf(value) {
-  const path = decodeLocalPath(value);
-  const extension = path.slice(path.lastIndexOf('.') + 1).toLowerCase();
-  return MIME_TYPES.get(extension) ?? 'application/octet-stream';
-}
-
-/**
- * Decode a base64 payload into bytes.
- *
- * `Uint8Array.fromBase64` is used when the runtime provides it; the manual
- * fallback keeps older browsers working.
- *
- * @param {string} value Base64 payload without a data-URL prefix.
- * @returns {Uint8Array} Decoded bytes.
- */
-export function decodeBase64(value) {
-  if (typeof Uint8Array.fromBase64 === 'function') return Uint8Array.fromBase64(value);
-
-  const binary = atob(value);
-  const bytes = new Uint8Array(binary.length);
-  for (let index = 0; index < binary.length; index += 1) {
-    bytes[index] = binary.charCodeAt(index);
-  }
-  return bytes;
-}
-
-/**
- * Create the error a cancelled load rejects with.
- *
- * @param {string} [message] Human-readable reason.
- * @returns {Error} Error named `AbortError`.
- */
-export function abortError(message = 'Model loading was cancelled.') {
-  const error = new Error(message);
-  error.name = 'AbortError';
-  return error;
-}
-
-/**
- * Log a recoverable loading problem without failing the whole preview.
- *
- * @param {string} message Diagnostic message.
- */
-export function warn(message) {
-  if (typeof console !== 'undefined') console.warn(message);
-}

package/src/client.js

@@ -1,57 +0,0 @@
-import { FORMAT_ENTRIES } from './formats.js';
-import { readWorkspaceFile } from './loaders/workspace.js';
-import { VIEWER_COMPONENTS } from './ui/ModelViewer.js';
-import { en, zh } from './ui/dictionaries.js';
-
-const NS = 'dsh3dViewer';
-const BODY_SLOT = 'sidebar.right.tab.document';
-
-export const inject = ['documentPreviews', 'slots', 'locale', 'remote', 'remote.workspaceFiles'];
-
-/**
- * Register one document format and its right-Sidebar view body.
- *
- * @param {import('@deepseek-ai/cordis').Context} ctx Owning Client context.
- * @param {(key: string) => string} t Namespace-bound translator.
- * @param {import('./formats.js').FormatDefinition} entry Format definition.
- */
-function registerPreview(ctx, t, entry) {
-  const component = VIEWER_COMPONENTS[entry.format];
-
-  ctx.effect(() => ctx.documentPreviews.register({
-    id: entry.id,
-    extensions: [...entry.extensions],
-    binaryExtensions: [...entry.extensions],
-    priority: 'extension',
-    title: () => t(entry.titleKey),
-    loading: 'bytes-complete',
-    wrap: false,
-  }), `dsh-3d-viewer: ${entry.label} document preview`);
-
-  ctx.effect(() => ctx.slots.inject(BODY_SLOT, () => ctx.slots.register({
-    name: BODY_SLOT,
-    key: entry.id,
-    locale: NS,
-    inject: () => ({
-      fallbackT: t,
-      readWorkspaceFile: (address, path, options) => readWorkspaceFile(ctx.remote, address, path, options),
-    }),
-  }, component)), `dsh-3d-viewer: ${entry.label} viewer body`);
-}
-
-/**
- * Register the FBX, OBJ, glTF/GLB, and STL document renderers and their view
- * bodies in the right Sidebar.
- *
- * Formats come from the shared registry, so registration, badges, and viewer
- * components cannot drift apart.
- *
- * @param {import('@deepseek-ai/cordis').Context} ctx Owning Client context.
- */
-export function apply(ctx) {
-  const t = ctx.locale.bind(NS);
-
-  ctx.effect(() => ctx.locale.register(NS, { zh, en }), 'dsh-3d-viewer: dictionaries');
-
-  for (const entry of FORMAT_ENTRIES) registerPreview(ctx, t, entry);
-}

package/src/formats.js

@@ -1,100 +0,0 @@
-/**
- * The single registry of document formats this plugin renders.
- *
- * Registration (client.js), the viewer factories (ui/ModelViewer.js), the HUD
- * badge (ui/chrome.js), and format normalization all derive from this table,
- * so a format is declared exactly once instead of in four parallel lists.
- */
-
-/**
- * @typedef {{
- *   id: string,
- *   format: 'fbx' | 'obj' | 'gltf' | 'stl',
- *   extensions: readonly string[],
- *   titleKey: string,
- *   badgeKey: string,
- *   glbBadgeKey?: string,
- *   label: string,
- * }} FormatDefinition
- */
-
-/** @type {Readonly<Record<string, FormatDefinition>>} */
-export const FORMATS = Object.freeze({
-  fbx: Object.freeze({
-    id: 'dsh-3d-viewer/fbx',
-    format: 'fbx',
-    extensions: Object.freeze(['fbx']),
-    titleKey: 'rendererTitle',
-    badgeKey: 'badge',
-    label: 'FBX',
-  }),
-  obj: Object.freeze({
-    id: 'dsh-3d-viewer/obj',
-    format: 'obj',
-    extensions: Object.freeze(['obj']),
-    titleKey: 'objRendererTitle',
-    badgeKey: 'objBadge',
-    label: 'OBJ',
-  }),
-  gltf: Object.freeze({
-    id: 'dsh-3d-viewer/gltf',
-    format: 'gltf',
-    extensions: Object.freeze(['gltf', 'glb']),
-    titleKey: 'gltfRendererTitle',
-    badgeKey: 'gltfBadge',
-    glbBadgeKey: 'glbBadge',
-    label: 'glTF / GLB',
-  }),
-  stl: Object.freeze({
-    id: 'dsh-3d-viewer/stl',
-    format: 'stl',
-    extensions: Object.freeze(['stl']),
-    titleKey: 'stlRendererTitle',
-    badgeKey: 'stlBadge',
-    label: 'STL',
-  }),
-});
-
-/** Registration order, which is also the order of the sidebar preview list. */
-export const FORMAT_IDS = Object.freeze(Object.keys(FORMATS));
-
-/** @type {readonly FormatDefinition[]} */
-export const FORMAT_ENTRIES = Object.freeze(FORMAT_IDS.map((id) => FORMATS[id]));
-
-/**
- * Normalize a slot-provided format name.
- *
- * `glb` is an alias of `gltf`; unknown values fall back to the FBX viewer,
- * matching the previous default of the single viewer component.
- *
- * @param {unknown} value Requested format.
- * @returns {'fbx' | 'obj' | 'gltf' | 'stl'} A registered format.
- */
-export function normalizeFormat(value) {
-  if (value === 'glb') return 'gltf';
-  return typeof value === 'string' && Object.hasOwn(FORMATS, value)
-    ? /** @type {'fbx' | 'obj' | 'gltf' | 'stl'} */ (value)
-    : 'fbx';
-}
-
-/**
- * Resolve the dictionary key for a preview badge.
- *
- * @param {unknown} format Document format.
- * @param {boolean} [glb] Whether a glTF document is a binary GLB.
- * @returns {string} Dictionary key.
- */
-export function badgeKeyFor(format, glb = false) {
-  const entry = FORMATS[normalizeFormat(format)];
-  return glb === true && entry.glbBadgeKey !== undefined ? entry.glbBadgeKey : entry.badgeKey;
-}
-
-/**
- * Whether a document address points at a binary GLB container.
- *
- * @param {unknown} address Document resource address.
- * @returns {boolean} True for `.glb` paths, ignoring query and fragment suffixes.
- */
-export function isGlbAddress(address) {
-  return typeof address === 'string' && /\.glb(?:[?#]|$)/iu.test(address);
-}