@playcanvas/splat-transform 1.1.0 → 1.2.0

package/dist/lib/index.d.cts

@@ -30,5 +30,5 @@ export { writeHtml } from './writers/write-html';
 export { writeLod } from './writers/write-lod';
 export type { Options, Param } from './types';
 export { logger } from './utils/logger';
-export type { Logger } from './utils/logger';
+export type { Logger, ProgressNode } from './utils/logger';
 export { WebPCodec } from './utils/webp-codec';

package/dist/lib/index.d.ts

@@ -30,5 +30,5 @@ export { writeHtml } from './writers/write-html';
 export { writeLod } from './writers/write-lod';
 export type { Options, Param } from './types';
 export { logger } from './utils/logger';
-export type { Logger } from './utils/logger';
+export type { Logger, ProgressNode } from './utils/logger';
 export { WebPCodec } from './utils/webp-codec';

package/dist/lib/utils/logger.d.ts

@@ -1,3 +1,19 @@
+/**
+ * Progress node representing a step in a nested progress tree.
+ * Walk up via `parent` to access enclosing steps.
+ */
+interface ProgressNode {
+    /** Current step number at this level. */
+    step: number;
+    /** Total number of steps at this level. */
+    totalSteps: number;
+    /** Name of the current step (undefined for anonymous steps). */
+    stepName?: string;
+    /** Parent node (undefined for root level). */
+    parent?: ProgressNode;
+    /** Nesting depth (0 for root level). */
+    depth: number;
+}
 /**
  * Logger interface for injectable logging implementation.
  */
@@ -10,10 +26,29 @@ interface Logger {
     error(...args: any[]): void;
     /** Log debug/verbose messages. */
     debug(...args: any[]): void;
-    /** Output text without newline (for progress indicators). */
-    progress(text: string): void;
     /** Output data to stdout (for piping). */
     output(text: string): void;
+    /** Called on progress step updates with the current node. */
+    onProgress(node: ProgressNode): void;
+}
+/**
+ * Progress tracking with nested step support.
+ * Access via logger.progress.begin(), logger.progress.step()
+ */
+declare class Progress {
+    private currentNode;
+    /**
+     * Start a multi-step progress operation. Creates a new node with current as parent.
+     * Calls onProgress with step: 0 to notify consumers of the new progress block.
+     * @param totalSteps - Total number of steps in the operation.
+     */
+    begin(totalSteps: number): void;
+    /**
+     * Advance to the next step. Auto-increments the step counter.
+     * Auto-ends when all steps are complete.
+     * @param name - Optional name of the step.
+     */
+    step(name?: string): void;
 }
 /**
  * Global logger instance with injectable implementation.
@@ -21,6 +56,11 @@ interface Logger {
  * Use setQuiet() to suppress log/warn/progress output.
  */
 declare const logger: {
+    /**
+     * Progress tracking with nested step support.
+     * Call begin(n) to start, then step() n times. Auto-ends when complete.
+     */
+    progress: Progress;
     /**
      * Set a custom logger implementation.
      * @param l - The logger implementation to use.
@@ -51,11 +91,6 @@ declare const logger: {
      * @param args - The arguments to log.
      */
     debug(...args: any[]): void;
-    /**
-     * Output text without newline (for progress indicators). Suppressed in quiet mode.
-     * @param text - The text to output.
-     */
-    progress(text: string): void;
     /**
      * Output data to stdout (for piping). Always shown, even in quiet mode.
      * @param text - The text to output.
@@ -63,4 +98,4 @@ declare const logger: {
     output(text: string): void;
 };
 export { logger };
-export type { Logger };
+export type { Logger, ProgressNode };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@playcanvas/splat-transform",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "author": "PlayCanvas<support@playcanvas.com>",
   "homepage": "https://playcanvas.com",
   "description": "Library and CLI tool for 3D Gaussian splat format conversion and transformation",