@aura3d/apps 1.3.3 → 1.4.1

package/README.md

@@ -0,0 +1,34 @@
+# @aura3d/apps
+
+`@aura3d/apps` owns high-level Aura3D app workflow presets for asset viewers,
+product configurators, material studios, scene showcases, and interactive
+scenes.
+
+## Public API
+
+- `createA3DApp`: creates an app shell with an Aura3D `Engine`, optional
+  renderer, quality presets, workflow execution, diagnostics, and disposal.
+- `A3D_APP_WORKFLOW_PRESETS`: the supported workflow preset IDs.
+- `resolveA3DAppQualityPreset`: resolves draft, balanced, and production-sized
+  app quality settings.
+- `renderWorkflow(...)`: runs one of the package workflow presets and renders it
+  when the app owns a canvas-backed renderer.
+
+## Workflow Presets
+
+- `asset-viewer`
+- `product-configurator`
+- `material-studio`
+- `scene-showcase`
+- `interactive-scene`
+
+This package composes `@aura3d/core`, `@aura3d/rendering`, and
+`@aura3d/workflows`. It is a workflow/app shell package, not the root
+agent-authored `createAuraApp` safe API.
+
+## Verification
+
+Use the package through its exported workflow/app APIs and keep public examples
+bounded to the evidence for the workflow being rendered. Root public examples
+should still import from `@aura3d/engine` unless the task explicitly targets
+workflow internals.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aura3d/apps",
-  "version": "1.3.3",
+  "version": "1.4.1",
   "type": "module",
   "exports": {
     ".": {
@@ -11,9 +11,41 @@
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "dependencies": {
-    "@aura3d/rendering": "1.3.3",
-    "@aura3d/workflows": "1.3.3",
-    "@aura3d/core": "1.3.3"
+    "@aura3d/core": "1.4.1",
+    "@aura3d/rendering": "1.4.1",
+    "@aura3d/workflows": "1.4.1"
   },
-  "sideEffects": false
+  "sideEffects": false,
+  "description": "High-level Aura3D app workflow presets for asset viewers, product configurators, material studios, scene showcases, and interactive scenes.",
+  "keywords": [
+    "aura3d",
+    "3d",
+    "browser-3d",
+    "web-3d",
+    "typescript",
+    "3d-apps",
+    "app-workflows",
+    "asset-viewer",
+    "product-configurator",
+    "material-studio",
+    "scene-showcase",
+    "interactive-3d"
+  ],
+  "homepage": "https://aura3d.auraone.ai",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/auraoneai/aura3d.git",
+    "directory": "packages/apps"
+  },
+  "bugs": {
+    "url": "https://github.com/auraoneai/aura3d/issues"
+  },
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "README.md",
+    "dist"
+  ]
 }

package/src/index.ts

@@ -1,162 +0,0 @@
-import { Engine, type DiagnosticsSnapshot } from "@aura3d/core";
-import { Renderer, type RenderDeviceDiagnostics, type RendererOptions } from "@aura3d/rendering";
-import {
-  createAssetViewerWorkflow,
-  createInteractiveSceneWorkflow,
-  createMaterialStudioWorkflow,
-  createProductConfiguratorWorkflow,
-  createSceneShowcaseWorkflow,
-  type AssetViewerWorkflowOptions,
-  type A3DWorkflowResult,
-  type InteractiveSceneWorkflowOptions,
-  type MaterialStudioWorkflowOptions,
-  type ProductConfiguratorWorkflowOptions,
-  type SceneShowcaseWorkflowOptions
-} from "@aura3d/workflows";
-
-export type A3DAppQualityPreset = "draft" | "balanced" | "production";
-export type A3DAppWorkflowPreset = "asset-viewer" | "product-configurator" | "material-studio" | "scene-showcase" | "interactive-scene";
-
-export interface A3DAppQualitySettings {
-  readonly preset: A3DAppQualityPreset;
-  readonly width: number;
-  readonly height: number;
-  readonly antialias: boolean;
-  readonly preserveDrawingBuffer: boolean;
-  readonly targetFormat: "rgba8" | "rgba16f";
-  readonly diagnostics: readonly string[];
-}
-
-export interface A3DAppOptions {
-  readonly canvas?: HTMLCanvasElement | OffscreenCanvas;
-  readonly quality?: A3DAppQualityPreset;
-  readonly width?: number;
-  readonly height?: number;
-  readonly rendererFactory?: (options: RendererOptions) => Promise<A3DAppRendererLike>;
-}
-
-export interface A3DAppRendererLike {
-  render(source: A3DWorkflowResult["source"], camera?: A3DWorkflowResult["camera"]): RenderDeviceDiagnostics;
-  dispose?(): void;
-}
-
-export interface A3DAppDiagnostics {
-  readonly appState: "ready" | "disposed";
-  readonly quality: A3DAppQualitySettings;
-  readonly workflowRuns: number;
-  readonly lastWorkflow?: A3DAppWorkflowPreset;
-  readonly lastRender?: RenderDeviceDiagnostics;
-  readonly engine: DiagnosticsSnapshot;
-}
-
-export interface A3DApp {
-  readonly engine: Engine;
-  readonly renderer?: A3DAppRendererLike;
-  readonly quality: A3DAppQualitySettings;
-  renderWorkflow(preset: "asset-viewer", options: AssetViewerWorkflowOptions): Promise<A3DWorkflowResult>;
-  renderWorkflow(preset: "product-configurator", options: ProductConfiguratorWorkflowOptions): Promise<A3DWorkflowResult>;
-  renderWorkflow(preset: "material-studio", options?: MaterialStudioWorkflowOptions): Promise<A3DWorkflowResult>;
-  renderWorkflow(preset: "scene-showcase", options?: SceneShowcaseWorkflowOptions): Promise<A3DWorkflowResult>;
-  renderWorkflow(preset: "interactive-scene", options?: InteractiveSceneWorkflowOptions): Promise<A3DWorkflowResult>;
-  renderWorkflow(preset: A3DAppWorkflowPreset, options?: unknown): Promise<A3DWorkflowResult>;
-  diagnostics(): A3DAppDiagnostics;
-  dispose(): Promise<void>;
-}
-
-export const A3D_APP_WORKFLOW_PRESETS: readonly A3DAppWorkflowPreset[] = [
-  "asset-viewer",
-  "product-configurator",
-  "material-studio",
-  "scene-showcase",
-  "interactive-scene"
-] as const;
-
-export function resolveA3DAppQualityPreset(preset: A3DAppQualityPreset = "balanced", overrides: Pick<A3DAppOptions, "width" | "height"> = {}): A3DAppQualitySettings {
-  const base = preset === "production"
-    ? { width: 1600, height: 1000, antialias: true, preserveDrawingBuffer: true, targetFormat: "rgba16f" as const }
-    : preset === "draft"
-      ? { width: 960, height: 540, antialias: false, preserveDrawingBuffer: false, targetFormat: "rgba8" as const }
-      : { width: 1280, height: 720, antialias: true, preserveDrawingBuffer: true, targetFormat: "rgba16f" as const };
-  return {
-    preset,
-    ...base,
-    width: overrides.width ?? base.width,
-    height: overrides.height ?? base.height,
-    diagnostics: [
-      "quality-preset",
-      "workflow-presets",
-      "renderer-diagnostics",
-      "engine-diagnostics"
-    ]
-  };
-}
-
-export async function createA3DApp(options: A3DAppOptions = {}): Promise<A3DApp> {
-  const quality = resolveA3DAppQualityPreset(options.quality, options);
-  const engine = new Engine({ autoStart: false });
-  await engine.init();
-  const renderer = options.canvas
-    ? await (options.rendererFactory ?? Renderer.create)({
-      backend: "webgl2",
-      canvas: options.canvas,
-      width: quality.width,
-      height: quality.height,
-      antialias: quality.antialias,
-      preserveDrawingBuffer: quality.preserveDrawingBuffer,
-      clearColor: [0.018, 0.02, 0.024, 1]
-    })
-    : undefined;
-  let disposed = false;
-  let workflowRuns = 0;
-  let lastWorkflow: A3DAppWorkflowPreset | undefined;
-  let lastRender: RenderDeviceDiagnostics | undefined;
-
-  return {
-    engine,
-    renderer,
-    quality,
-    async renderWorkflow(preset: A3DAppWorkflowPreset, workflowOptions?: unknown): Promise<A3DWorkflowResult> {
-      if (disposed) throw new Error("A3D app has been disposed.");
-      const workflow = await createWorkflow(preset, workflowOptions);
-      workflowRuns += 1;
-      lastWorkflow = preset;
-      engine.diagnostics.increment(`workflow.${preset}.runs`);
-      if (renderer) {
-        lastRender = renderer.render(workflow.source, workflow.camera);
-        engine.diagnostics.gauge("renderer.drawCalls", lastRender.drawCalls);
-      }
-      return workflow;
-    },
-    diagnostics(): A3DAppDiagnostics {
-      return {
-        appState: disposed ? "disposed" : "ready",
-        quality,
-        workflowRuns,
-        ...(lastWorkflow ? { lastWorkflow } : {}),
-        ...(lastRender ? { lastRender } : {}),
-        engine: engine.diagnostics.snapshot()
-      };
-    },
-    async dispose(): Promise<void> {
-      if (disposed) return;
-      disposed = true;
-      renderer?.dispose?.();
-      await engine.dispose();
-    }
-  };
-}
-
-async function createWorkflow(preset: A3DAppWorkflowPreset, options: unknown): Promise<A3DWorkflowResult> {
-  switch (preset) {
-    case "asset-viewer":
-      return createAssetViewerWorkflow(options as AssetViewerWorkflowOptions);
-    case "product-configurator":
-      return createProductConfiguratorWorkflow(options as ProductConfiguratorWorkflowOptions);
-    case "material-studio":
-      return createMaterialStudioWorkflow(options as MaterialStudioWorkflowOptions | undefined);
-    case "scene-showcase":
-      return createSceneShowcaseWorkflow(options as SceneShowcaseWorkflowOptions | undefined);
-    case "interactive-scene":
-      return createInteractiveSceneWorkflow(options as InteractiveSceneWorkflowOptions | undefined);
-  }
-}