@onerjs/smart-filters 8.25.1 → 8.25.3

package/dist/runtime/smartFilterRuntime.js

@@ -0,0 +1,63 @@
+import { EffectRenderer } from "@onerjs/core/Materials/effectRenderer.js";
+import { CommandBuffer } from "../command/commandBuffer.js";
+/**
+ * The internal runtime implementation exposing more information than @see SmartFilterRuntime.
+ * This is used internally to render the smart filter.
+ *
+ * It is not fully exposed publicly to prevent any misuse of the runtime.
+ */
+export class InternalSmartFilterRuntime {
+    /**
+     * Instantiates a new smart filter runtime for one given engine.
+     * @param engine - the engine to use to render the smart filter
+     */
+    constructor(engine) {
+        this.engine = engine;
+        this._resources = [];
+        this.commandBuffer = new CommandBuffer();
+        this.effectRenderer = new EffectRenderer(engine);
+        this.registerResource(this.effectRenderer);
+    }
+    /**
+     * Register a resource to be disposed when the runtime is disposed.
+     * @param resource - defines the resource to dispose once the runtime is disposed
+     */
+    registerResource(resource) {
+        this._resources.push(resource);
+    }
+    /**
+     * Registers a command to be executed during the render loop.
+     * @param command - defines the command to execute
+     */
+    registerCommand(command) {
+        this.commandBuffer.push(command);
+    }
+    /**
+     * Renders the smart filter.
+     * This function will execute all the commands contained int the command buffer.
+     */
+    render() {
+        try {
+            const depthTest = this.engine.depthCullingState.depthTest;
+            const stencilTest = this.engine.stencilState.stencilTest;
+            this.commandBuffer.execute();
+            // EffectRenderer.applyEffectWrapper(), which is called by ShaderRuntime._draw(),
+            // sets the depth/stencil state, so we need to restore it.
+            this.engine.depthCullingState.depthTest = depthTest;
+            this.engine.stencilState.stencilTest = stencilTest;
+        }
+        catch (e) {
+            // eslint-disable-next-line no-debugger
+            debugger;
+        }
+    }
+    /**
+     * Dispose the runtime and all its associated resources
+     */
+    dispose() {
+        for (const resource of this._resources) {
+            resource.dispose();
+        }
+    }
+}
+//# sourceMappingURL=smartFilterRuntime.js.map

package/dist/runtime/smartFilterRuntime.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"smartFilterRuntime.js","sourceRoot":"","sources":["../../src/runtime/smartFilterRuntime.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,iDAAyC;AAElE,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAyB5D;;;;;GAKG;AACH,MAAM,OAAO,0BAA0B;IAkBnC;;;OAGG;IACH,YAAY,MAAkB;QAC1B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QAErB,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;QAErB,IAAI,CAAC,aAAa,GAAG,IAAI,aAAa,EAAE,CAAC;QAEzC,IAAI,CAAC,cAAc,GAAG,IAAI,cAAc,CAAC,MAAM,CAAC,CAAC;QACjD,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC/C,CAAC;IAED;;;OAGG;IACI,gBAAgB,CAAC,QAAqB;QACzC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACnC,CAAC;IAED;;;OAGG;IACI,eAAe,CAAC,OAAgB;QACnC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACrC,CAAC;IAED;;;OAGG;IACI,MAAM;QACT,IAAI,CAAC;YACD,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,SAAS,CAAC;YAC1D,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,WAAW,CAAC;YAEzD,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,CAAC;YAE7B,iFAAiF;YACjF,0DAA0D;YAC1D,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,SAAS,GAAG,SAAS,CAAC;YACpD,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,WAAW,GAAG,WAAW,CAAC;QACvD,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACT,uCAAuC;YACvC,QAAQ,CAAC;QACb,CAAC;IACL,CAAC;IAED;;OAEG;IACI,OAAO;QACV,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACrC,QAAQ,CAAC,OAAO,EAAE,CAAC;QACvB,CAAC;IACL,CAAC;CACJ"}

package/dist/runtime/strongRef.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This describes a strong reference to any data type.
+ */
+export type StrongRef<T> = {
+    /**
+     * The value of the strong reference.
+     */
+    value: T;
+};
+/**
+ * Create a strong reference to the given value.
+ * @param value - the value to wrap in a strong reference
+ * @returns the strong reference containing the value
+ */
+export declare function CreateStrongRef<T>(value: T): StrongRef<T>;
+//# sourceMappingURL=strongRef.d.ts.map

package/dist/runtime/strongRef.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"strongRef.d.ts","sourceRoot":"","sources":["../../src/runtime/strongRef.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,SAAS,CAAC,CAAC,IAAI;IACvB;;OAEG;IACH,KAAK,EAAE,CAAC,CAAC;CACZ,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAEzD"}

package/dist/runtime/strongRef.js

@@ -0,0 +1,9 @@
+/**
+ * Create a strong reference to the given value.
+ * @param value - the value to wrap in a strong reference
+ * @returns the strong reference containing the value
+ */
+export function CreateStrongRef(value) {
+    return { value };
+}
+//# sourceMappingURL=strongRef.js.map

package/dist/runtime/strongRef.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"strongRef.js","sourceRoot":"","sources":["../../src/runtime/strongRef.ts"],"names":[],"mappings":"AAUA;;;;GAIG;AACH,MAAM,UAAU,eAAe,CAAI,KAAQ;IACvC,OAAO,EAAE,KAAK,EAAE,CAAC;AACrB,CAAC"}

package/dist/serialization/importCustomBlockDefinition.d.ts

@@ -0,0 +1,15 @@
+import type { SerializedBlockDefinition } from "./serializedBlockDefinition.js";
+/**
+ * Imports a serialized custom block definition. Supports either serialized CustomShaderBlock definitions or
+ * CustomAggregateBlock definitions. Can throw an exception if the serialized data is invalid.
+ *
+ * CustomShaderBlock definitions can be supplied either as serialized SerializedBlockDefinition object
+ * or a glsl shader with the required annotations (see readme.md for details).
+ *
+ * CustomAggregateBlock definitions must be supplied as serialized SerializedBlockDefinition object.
+ *
+ * @param serializedData - The serialized data
+ * @returns The serialized block definition
+ */
+export declare function ImportCustomBlockDefinition(serializedData: string): SerializedBlockDefinition;
+//# sourceMappingURL=importCustomBlockDefinition.d.ts.map

package/dist/serialization/importCustomBlockDefinition.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"importCustomBlockDefinition.d.ts","sourceRoot":"","sources":["../../src/serialization/importCustomBlockDefinition.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,gCAAgC,CAAC;AAIhF;;;;;;;;;;;GAWG;AACH,wBAAgB,2BAA2B,CAAC,cAAc,EAAE,MAAM,GAAG,yBAAyB,CAyB7F"}

package/dist/serialization/importCustomBlockDefinition.js

@@ -0,0 +1,76 @@
+import { ConnectionPointType } from "../connection/connectionPointType.js";
+import { HasGlslHeader, ParseFragmentShader } from "../utils/buildTools/shaderConverter.js";
+/**
+ * Imports a serialized custom block definition. Supports either serialized CustomShaderBlock definitions or
+ * CustomAggregateBlock definitions. Can throw an exception if the serialized data is invalid.
+ *
+ * CustomShaderBlock definitions can be supplied either as serialized SerializedBlockDefinition object
+ * or a glsl shader with the required annotations (see readme.md for details).
+ *
+ * CustomAggregateBlock definitions must be supplied as serialized SerializedBlockDefinition object.
+ *
+ * @param serializedData - The serialized data
+ * @returns The serialized block definition
+ */
+export function ImportCustomBlockDefinition(serializedData) {
+    if (HasGlslHeader(serializedData)) {
+        return ImportAnnotatedGlsl(serializedData);
+    }
+    else {
+        // Assume this is a serialized JSON object
+        const blockDefinition = JSON.parse(serializedData);
+        // Some old SmartFilters didn't have a format property - default to smartFilter if missing
+        if (blockDefinition.format === undefined) {
+            blockDefinition.format = "smartFilter";
+        }
+        // SmartFilters can be serialized without a blockType
+        // By convention, we use the SmartFilter name as the blockType when importing them as SerializedBlockDefinitions
+        if (blockDefinition.format === "smartFilter" && blockDefinition.name && !blockDefinition.blockType) {
+            blockDefinition.blockType = blockDefinition.name;
+        }
+        // Validation
+        if (!blockDefinition.blockType) {
+            throw new Error("Could not find a blockType");
+        }
+        return blockDefinition;
+    }
+}
+/**
+ * Converts a fragment shader .glsl file to an SerializedBlockDefinition instance for use
+ * as a CustomShaderBlock. The .glsl file must contain certain annotations to be imported.
+ * See readme.md for more information.
+ * @param fragmentShader - The contents of the .glsl fragment shader file
+ * @returns The serialized block definition
+ */
+function ImportAnnotatedGlsl(fragmentShader) {
+    const fragmentShaderInfo = ParseFragmentShader(fragmentShader);
+    if (!fragmentShaderInfo.blockType) {
+        throw new Error("blockType must be defined");
+    }
+    // Calculate the input connection points
+    const inputConnectionPoints = [];
+    for (const uniform of fragmentShaderInfo.uniforms) {
+        // Add to input connection point list
+        const inputConnectionPoint = {
+            name: uniform.name,
+            type: uniform.type,
+            autoBind: uniform.properties?.autoBind,
+        };
+        if (inputConnectionPoint.type !== ConnectionPointType.Texture && uniform.properties?.default !== undefined) {
+            inputConnectionPoint.defaultValue = uniform.properties.default;
+        }
+        inputConnectionPoints.push(inputConnectionPoint);
+    }
+    return {
+        format: "shaderBlockDefinition",
+        formatVersion: 1,
+        blockType: fragmentShaderInfo.blockType,
+        namespace: fragmentShaderInfo.namespace,
+        shaderProgram: {
+            fragment: fragmentShaderInfo.shaderCode,
+        },
+        inputConnectionPoints,
+        disableOptimization: !!fragmentShaderInfo.disableOptimization,
+    };
+}
+//# sourceMappingURL=importCustomBlockDefinition.js.map

package/dist/serialization/importCustomBlockDefinition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"importCustomBlockDefinition.js","sourceRoot":"","sources":["../../src/serialization/importCustomBlockDefinition.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,sCAAsC,CAAC;AAC3E,OAAO,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,wCAAwC,CAAC;AAK5F;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,2BAA2B,CAAC,cAAsB;IAC9D,IAAI,aAAa,CAAC,cAAc,CAAC,EAAE,CAAC;QAChC,OAAO,mBAAmB,CAAC,cAAc,CAAC,CAAC;IAC/C,CAAC;SAAM,CAAC;QACJ,0CAA0C;QAC1C,MAAM,eAAe,GAAG,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;QAEnD,0FAA0F;QAC1F,IAAI,eAAe,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YACvC,eAAe,CAAC,MAAM,GAAG,aAAa,CAAC;QAC3C,CAAC;QAED,qDAAqD;QACrD,gHAAgH;QAChH,IAAI,eAAe,CAAC,MAAM,KAAK,aAAa,IAAI,eAAe,CAAC,IAAI,IAAI,CAAC,eAAe,CAAC,SAAS,EAAE,CAAC;YACjG,eAAe,CAAC,SAAS,GAAG,eAAe,CAAC,IAAI,CAAC;QACrD,CAAC;QAED,aAAa;QACb,IAAI,CAAC,eAAe,CAAC,SAAS,EAAE,CAAC;YAC7B,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;QAClD,CAAC;QAED,OAAO,eAAe,CAAC;IAC3B,CAAC;AACL,CAAC;AAED;;;;;;GAMG;AACH,SAAS,mBAAmB,CAAC,cAAsB;IAC/C,MAAM,kBAAkB,GAAG,mBAAmB,CAAC,cAAc,CAAC,CAAC;IAE/D,IAAI,CAAC,kBAAkB,CAAC,SAAS,EAAE,CAAC;QAChC,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;IACjD,CAAC;IAED,wCAAwC;IACxC,MAAM,qBAAqB,GAAuC,EAAE,CAAC;IACrE,KAAK,MAAM,OAAO,IAAI,kBAAkB,CAAC,QAAQ,EAAE,CAAC;QAChD,qCAAqC;QACrC,MAAM,oBAAoB,GAAqC;YAC3D,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,QAAQ,EAAE,OAAO,CAAC,UAAU,EAAE,QAA2B;SAC5D,CAAC;QACF,IAAI,oBAAoB,CAAC,IAAI,KAAK,mBAAmB,CAAC,OAAO,IAAI,OAAO,CAAC,UAAU,EAAE,OAAO,KAAK,SAAS,EAAE,CAAC;YACzG,oBAAoB,CAAC,YAAY,GAAG,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC;QACnE,CAAC;QACD,qBAAqB,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;IACrD,CAAC;IAED,OAAO;QACH,MAAM,EAAE,uBAAuB;QAC/B,aAAa,EAAE,CAAC;QAChB,SAAS,EAAE,kBAAkB,CAAC,SAAS;QACvC,SAAS,EAAE,kBAAkB,CAAC,SAAS;QACvC,aAAa,EAAE;YACX,QAAQ,EAAE,kBAAkB,CAAC,UAAU;SAC1C;QACD,qBAAqB;QACrB,mBAAmB,EAAE,CAAC,CAAC,kBAAkB,CAAC,mBAAmB;KAChE,CAAC;AACN,CAAC"}

package/dist/serialization/index.d.ts

@@ -0,0 +1,9 @@
+export * from "./v1/index.js";
+export * from "./serializedSmartFilter.js";
+export * from "./smartFilterDeserializer.js";
+export * from "./smartFilterSerializer.js";
+export * from "./serializedShaderBlockDefinition.js";
+export * from "./serializedBlockDefinition.js";
+export * from "./importCustomBlockDefinition.js";
+export { ImportCustomBlockDefinition as importCustomBlockDefinition } from "./importCustomBlockDefinition.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/serialization/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/serialization/index.ts"],"names":[],"mappings":"AACA,cAAc,eAAe,CAAC;AAC9B,cAAc,4BAA4B,CAAC;AAC3C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,sCAAsC,CAAC;AACrD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,kCAAkC,CAAC;AAEjD,OAAO,EAAE,2BAA2B,IAAI,2BAA2B,EAAE,MAAM,kCAAkC,CAAC"}

package/dist/serialization/index.js

@@ -0,0 +1,11 @@
+/* eslint-disable import/no-internal-modules */
+export * from "./v1/index.js";
+export * from "./serializedSmartFilter.js";
+export * from "./smartFilterDeserializer.js";
+export * from "./smartFilterSerializer.js";
+export * from "./serializedShaderBlockDefinition.js";
+export * from "./serializedBlockDefinition.js";
+export * from "./importCustomBlockDefinition.js";
+// Back compat for when camelCase was used
+export { ImportCustomBlockDefinition as importCustomBlockDefinition } from "./importCustomBlockDefinition.js";
+//# sourceMappingURL=index.js.map

package/dist/serialization/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/serialization/index.ts"],"names":[],"mappings":"AAAA,+CAA+C;AAC/C,cAAc,eAAe,CAAC;AAC9B,cAAc,4BAA4B,CAAC;AAC3C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,sCAAsC,CAAC;AACrD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,kCAAkC,CAAC;AACjD,0CAA0C;AAC1C,OAAO,EAAE,2BAA2B,IAAI,2BAA2B,EAAE,MAAM,kCAAkC,CAAC"}

package/dist/serialization/serializedBlockDefinition.d.ts

@@ -0,0 +1,12 @@
+import type { SerializedShaderBlockDefinition } from "./serializedShaderBlockDefinition.js";
+import type { SerializedSmartFilter } from "./serializedSmartFilter.js";
+/**
+ * Type that represents any type of serialized block definition - shader or aggregate.
+ */
+export type SerializedBlockDefinition = (SerializedShaderBlockDefinition | SerializedSmartFilter) & {
+    /**
+     * The type of block this is.
+     */
+    blockType: string;
+};
+//# sourceMappingURL=serializedBlockDefinition.d.ts.map

package/dist/serialization/serializedBlockDefinition.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"serializedBlockDefinition.d.ts","sourceRoot":"","sources":["../../src/serialization/serializedBlockDefinition.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,+BAA+B,EAAE,MAAM,sCAAsC,CAAC;AAC5F,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AAExE;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,CAAC,+BAA+B,GAAG,qBAAqB,CAAC,GAAG;IAChG;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACrB,CAAC"}

package/dist/serialization/serializedBlockDefinition.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=serializedBlockDefinition.js.map

package/dist/serialization/serializedBlockDefinition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"serializedBlockDefinition.js","sourceRoot":"","sources":["../../src/serialization/serializedBlockDefinition.ts"],"names":[],"mappings":""}

package/dist/serialization/serializedShaderBlockDefinition.d.ts

@@ -0,0 +1,7 @@
+import type { SerializedShaderBlockDefinitionV1 } from "./v1/shaderBlockSerialization.types.js";
+/**
+ * Type union of all versions of serialized SmartFilter block definitions
+ * A block definition is an object which is used to create a CustomShaderBlock instance.
+ */
+export type SerializedShaderBlockDefinition = SerializedShaderBlockDefinitionV1;
+//# sourceMappingURL=serializedShaderBlockDefinition.d.ts.map

package/dist/serialization/serializedShaderBlockDefinition.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"serializedShaderBlockDefinition.d.ts","sourceRoot":"","sources":["../../src/serialization/serializedShaderBlockDefinition.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iCAAiC,EAAE,MAAM,wCAAwC,CAAC;AAEhG;;;GAGG;AACH,MAAM,MAAM,+BAA+B,GAAG,iCAAiC,CAAC"}

package/dist/serialization/serializedShaderBlockDefinition.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=serializedShaderBlockDefinition.js.map

package/dist/serialization/serializedShaderBlockDefinition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"serializedShaderBlockDefinition.js","sourceRoot":"","sources":["../../src/serialization/serializedShaderBlockDefinition.ts"],"names":[],"mappings":""}

package/dist/serialization/serializedSmartFilter.d.ts

@@ -0,0 +1,6 @@
+import type { SerializedSmartFilterV1 } from "./v1/smartFilterSerialization.types.js";
+/**
+ * Type union of all versions of serialized SmartFilters
+ */
+export type SerializedSmartFilter = SerializedSmartFilterV1;
+//# sourceMappingURL=serializedSmartFilter.d.ts.map

package/dist/serialization/serializedSmartFilter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"serializedSmartFilter.d.ts","sourceRoot":"","sources":["../../src/serialization/serializedSmartFilter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,wCAAwC,CAAC;AAEtF;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,uBAAuB,CAAC"}

package/dist/serialization/serializedSmartFilter.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=serializedSmartFilter.js.map

package/dist/serialization/serializedSmartFilter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"serializedSmartFilter.js","sourceRoot":"","sources":["../../src/serialization/serializedSmartFilter.ts"],"names":[],"mappings":""}

package/dist/serialization/smartFilterDeserializer.d.ts

@@ -0,0 +1,34 @@
+import type { BaseBlock } from "../blockFoundation/baseBlock.js";
+import { SmartFilter } from "../smartFilter.js";
+import type { ThinEngine } from "@onerjs/core/Engines/thinEngine.js";
+import type { ISerializedBlockV1, OptionalBlockDeserializerV1 } from "./v1/smartFilterSerialization.types.js";
+import type { Nullable } from "@onerjs/core/types.js";
+/**
+ * A function that creates a block instance of the given class block type, or return null if it cannot.
+ */
+export type BlockFactory = (smartFilter: SmartFilter, engine: ThinEngine, serializedBlock: ISerializedBlockV1, smartFilterDeserializer: SmartFilterDeserializer) => Promise<Nullable<BaseBlock>>;
+/**
+ * Deserializes serialized SmartFilters. The caller passes in a map of block deserializers it wants to use,
+ * which allows the caller to provide custom deserializers for blocks beyond the core blocks.
+ * The deserializer supports versioned serialized SmartFilters.
+ */
+export declare class SmartFilterDeserializer {
+    private readonly _blockFactory;
+    private readonly _customInputBlockDeserializer?;
+    /**
+     * Creates a new SmartFilterDeserializer
+     * @param blockFactory - A function that creates a block of the given class name, or returns null if it cannot
+     * @param customInputBlockDeserializer - An optional custom deserializer for InputBlocks - if supplied and it returns null, the default deserializer will be used
+     */
+    constructor(blockFactory: BlockFactory, customInputBlockDeserializer?: OptionalBlockDeserializerV1);
+    /**
+     * Deserializes a SmartFilter from a JSON object - can be safely called multiple times and has no side effects within the class.
+     * @param engine - The ThinEngine to pass to the new SmartFilter
+     * @param smartFilterJson - The JSON object to deserialize
+     * @returns A promise that resolves to the deserialized SmartFilter
+     */
+    deserialize(engine: ThinEngine, smartFilterJson: any): Promise<SmartFilter>;
+    private _deserializeV1Async;
+    private _deserializeBlockV1Async;
+}
+//# sourceMappingURL=smartFilterDeserializer.d.ts.map

package/dist/serialization/smartFilterDeserializer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"smartFilterDeserializer.d.ts","sourceRoot":"","sources":["../../src/serialization/smartFilterDeserializer.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAC;AAEjE,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAIhD,OAAO,KAAK,EAAE,UAAU,EAAE,2CAAmC;AAE7D,OAAO,KAAK,EAAE,kBAAkB,EAA2B,2BAA2B,EAA2B,MAAM,wCAAwC,CAAC;AAEhK,OAAO,KAAK,EAAE,QAAQ,EAAE,8BAAsB;AAE9C;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,CACvB,WAAW,EAAE,WAAW,EACxB,MAAM,EAAE,UAAU,EAClB,eAAe,EAAE,kBAAkB,EACnC,uBAAuB,EAAE,uBAAuB,KAC/C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;AAElC;;;;GAIG;AACH,qBAAa,uBAAuB;IAChC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAe;IAC7C,OAAO,CAAC,QAAQ,CAAC,6BAA6B,CAAC,CAA8B;IAE7E;;;;OAIG;gBACgB,YAAY,EAAE,YAAY,EAAE,4BAA4B,CAAC,EAAE,2BAA2B;IAKzG;;;;;OAKG;IAEU,WAAW,CAAC,MAAM,EAAE,UAAU,EAAE,eAAe,EAAE,GAAG,GAAG,OAAO,CAAC,WAAW,CAAC;YAc1E,mBAAmB;YA0DnB,wBAAwB;CAqEzC"}

package/dist/serialization/smartFilterDeserializer.js

@@ -0,0 +1,141 @@
+import { SmartFilter } from "../smartFilter.js";
+import { ShaderBlock } from "../blockFoundation/shaderBlock.js";
+import { InputBlockDeserializer } from "../blockFoundation/inputBlock.deserializer.js";
+import { OutputBlock } from "../blockFoundation/outputBlock.js";
+import { InputBlock } from "../blockFoundation/inputBlock.js";
+import { UniqueIdGenerator } from "../utils/uniqueIdGenerator.js";
+/**
+ * Deserializes serialized SmartFilters. The caller passes in a map of block deserializers it wants to use,
+ * which allows the caller to provide custom deserializers for blocks beyond the core blocks.
+ * The deserializer supports versioned serialized SmartFilters.
+ */
+export class SmartFilterDeserializer {
+    /**
+     * Creates a new SmartFilterDeserializer
+     * @param blockFactory - A function that creates a block of the given class name, or returns null if it cannot
+     * @param customInputBlockDeserializer - An optional custom deserializer for InputBlocks - if supplied and it returns null, the default deserializer will be used
+     */
+    constructor(blockFactory, customInputBlockDeserializer) {
+        this._blockFactory = blockFactory;
+        this._customInputBlockDeserializer = customInputBlockDeserializer;
+    }
+    /**
+     * Deserializes a SmartFilter from a JSON object - can be safely called multiple times and has no side effects within the class.
+     * @param engine - The ThinEngine to pass to the new SmartFilter
+     * @param smartFilterJson - The JSON object to deserialize
+     * @returns A promise that resolves to the deserialized SmartFilter
+     */
+    // eslint-disable-next-line @typescript-eslint/naming-convention
+    async deserialize(engine, smartFilterJson) {
+        const serializedSmartFilter = smartFilterJson;
+        // Back-compat for the rename of version to formatVersion, didn't warrant a new version
+        if (serializedSmartFilter.version && serializedSmartFilter.formatVersion === undefined) {
+            serializedSmartFilter.formatVersion = serializedSmartFilter.version;
+        }
+        switch (serializedSmartFilter.formatVersion) {
+            case 1:
+                return await this._deserializeV1Async(engine, serializedSmartFilter);
+        }
+    }
+    async _deserializeV1Async(engine, serializedSmartFilter) {
+        const smartFilter = new SmartFilter(serializedSmartFilter.name, serializedSmartFilter.namespace);
+        const blockIdMap = new Map();
+        // Only needed for smart filters saved before we started using uniqueIds for the maps, didn't warrant new version
+        const blockNameMap = new Map();
+        // Deserialize the SmartFilter level data
+        smartFilter.comments = serializedSmartFilter.comments;
+        smartFilter.editorData = serializedSmartFilter.editorData;
+        // Deserialize the blocks
+        const blockDeserializationWork = [];
+        const blockDefinitionsWhichCouldNotBeDeserialized = [];
+        serializedSmartFilter.blocks.forEach((serializedBlock) => {
+            blockDeserializationWork.push(this._deserializeBlockV1Async(smartFilter, serializedBlock, engine, blockDefinitionsWhichCouldNotBeDeserialized, blockIdMap, blockNameMap));
+        });
+        await Promise.all(blockDeserializationWork);
+        // If any block definitions could not be deserialized, throw an error
+        if (blockDefinitionsWhichCouldNotBeDeserialized.length > 0) {
+            throw new Error(`Could not deserialize the following block definitions: ${blockDefinitionsWhichCouldNotBeDeserialized.join(", ")}`);
+        }
+        // Deserialize the connections
+        serializedSmartFilter.connections.forEach((connection) => {
+            // Find the source block and its connection point's connectTo function
+            const sourceBlock = typeof connection.outputBlock === "string" ? blockNameMap.get(connection.outputBlock) : blockIdMap.get(connection.outputBlock);
+            if (!sourceBlock) {
+                throw new Error(`Source block ${connection.outputBlock} not found`);
+            }
+            const sourceConnectionPoint = sourceBlock.outputs.find((output) => output.name === connection.outputConnectionPoint);
+            if (!sourceConnectionPoint || typeof sourceConnectionPoint.connectTo !== "function") {
+                throw new Error(`Block ${connection.outputBlock} does not have an connection point named ${connection.outputConnectionPoint}`);
+            }
+            const sourceConnectToFunction = sourceConnectionPoint.connectTo.bind(sourceConnectionPoint);
+            // Find the target block and its connection point
+            const targetBlock = typeof connection.inputBlock === "string" ? blockNameMap.get(connection.inputBlock) : blockIdMap.get(connection.inputBlock);
+            if (!targetBlock) {
+                throw new Error(`Target block ${connection.inputBlock} not found`);
+            }
+            const targetConnectionPoint = targetBlock.inputs.find((input) => input.name === connection.inputConnectionPoint);
+            if (!targetConnectionPoint || typeof targetConnectionPoint !== "object") {
+                throw new Error(`Block ${connection.inputBlock} does not have a connection point named ${connection.inputConnectionPoint}`);
+            }
+            // Create the connection
+            sourceConnectToFunction.call(sourceBlock, targetConnectionPoint);
+        });
+        return smartFilter;
+    }
+    async _deserializeBlockV1Async(smartFilter, serializedBlock, engine, blockTypesWhichCouldNotBeDeserialized, blockIdMap, blockNameMap) {
+        let newBlock = null;
+        // Back compat for early Smart Filter V1 serialization where the blockType was stored in className
+        // Not worth creating a new version for this, as it's only used in the deserializer
+        if (serializedBlock.className && !serializedBlock.blockType) {
+            serializedBlock.blockType = serializedBlock.className;
+        }
+        // Back compat for early Smart Filter V1 serialization where the namespace was not stored
+        if (serializedBlock.namespace === undefined) {
+            serializedBlock.namespace = null;
+        }
+        // Get the instance of the block
+        switch (serializedBlock.blockType) {
+            case InputBlock.ClassName:
+                {
+                    if (this._customInputBlockDeserializer) {
+                        newBlock = await this._customInputBlockDeserializer(smartFilter, serializedBlock, engine);
+                    }
+                    if (newBlock === null) {
+                        newBlock = InputBlockDeserializer(smartFilter, serializedBlock);
+                    }
+                }
+                break;
+            case OutputBlock.ClassName:
+                {
+                    newBlock = smartFilter.output.ownerBlock;
+                }
+                break;
+            default: {
+                // If it's not an input or output block, use the provided block factory
+                newBlock = await this._blockFactory(smartFilter, engine, serializedBlock, this);
+                if (!newBlock) {
+                    if (blockTypesWhichCouldNotBeDeserialized.indexOf(serializedBlock.blockType) === -1) {
+                        blockTypesWhichCouldNotBeDeserialized.push(serializedBlock.blockType);
+                    }
+                    return;
+                }
+            }
+        }
+        // Deserializers are not responsible for setting the uniqueId or comments.
+        // This is so they don't have to be passed into the constructors when programmatically creating
+        // blocks, and so each deserializer doesn't have to remember to do it.
+        newBlock.uniqueId = serializedBlock.uniqueId;
+        newBlock.comments = serializedBlock.comments;
+        // Deserializers are also not responsible for deserializing the outputTextureOptions of ShaderBlocks.
+        if (serializedBlock.outputTextureOptions && newBlock instanceof ShaderBlock) {
+            newBlock.outputTextureOptions = serializedBlock.outputTextureOptions;
+        }
+        // We need to ensure any uniqueIds generated in the future (e.g. a new block is added to the SmartFilter)
+        // are higher than this one.
+        UniqueIdGenerator.EnsureIdsGreaterThan(newBlock.uniqueId);
+        // Save in the map
+        blockIdMap.set(newBlock.uniqueId, newBlock);
+        blockNameMap.set(newBlock.name, newBlock);
+    }
+}
+//# sourceMappingURL=smartFilterDeserializer.js.map

package/dist/serialization/smartFilterDeserializer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"smartFilterDeserializer.js","sourceRoot":"","sources":["../../src/serialization/smartFilterDeserializer.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,WAAW,EAAE,MAAM,mCAAmC,CAAC;AAChE,OAAO,EAAE,sBAAsB,EAAE,MAAM,+CAA+C,CAAC;AACvF,OAAO,EAAE,WAAW,EAAE,MAAM,mCAAmC,CAAC;AAEhE,OAAO,EAAE,UAAU,EAAE,MAAM,kCAAkC,CAAC;AAE9D,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAalE;;;;GAIG;AACH,MAAM,OAAO,uBAAuB;IAIhC;;;;OAIG;IACH,YAAmB,YAA0B,EAAE,4BAA0D;QACrG,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC;QAClC,IAAI,CAAC,6BAA6B,GAAG,4BAA4B,CAAC;IACtE,CAAC;IAED;;;;;OAKG;IACH,gEAAgE;IACzD,KAAK,CAAC,WAAW,CAAC,MAAkB,EAAE,eAAoB;QAC7D,MAAM,qBAAqB,GAA0B,eAAe,CAAC;QAErE,uFAAuF;QACvF,IAAK,qBAA6B,CAAC,OAAO,IAAI,qBAAqB,CAAC,aAAa,KAAK,SAAS,EAAE,CAAC;YAC9F,qBAAqB,CAAC,aAAa,GAAI,qBAA6B,CAAC,OAAO,CAAC;QACjF,CAAC;QAED,QAAQ,qBAAqB,CAAC,aAAa,EAAE,CAAC;YAC1C,KAAK,CAAC;gBACF,OAAO,MAAM,IAAI,CAAC,mBAAmB,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;QAC7E,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,mBAAmB,CAAC,MAAkB,EAAE,qBAA8C;QAChG,MAAM,WAAW,GAAG,IAAI,WAAW,CAAC,qBAAqB,CAAC,IAAI,EAAE,qBAAqB,CAAC,SAAS,CAAC,CAAC;QACjG,MAAM,UAAU,GAAG,IAAI,GAAG,EAAqB,CAAC;QAEhD,iHAAiH;QACjH,MAAM,YAAY,GAAG,IAAI,GAAG,EAAqB,CAAC;QAElD,yCAAyC;QACzC,WAAW,CAAC,QAAQ,GAAG,qBAAqB,CAAC,QAAQ,CAAC;QACtD,WAAW,CAAC,UAAU,GAAG,qBAAqB,CAAC,UAAU,CAAC;QAE1D,yBAAyB;QACzB,MAAM,wBAAwB,GAAoB,EAAE,CAAC;QACrD,MAAM,2CAA2C,GAAa,EAAE,CAAC;QACjE,qBAAqB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,eAAmC,EAAE,EAAE;YACzE,wBAAwB,CAAC,IAAI,CACzB,IAAI,CAAC,wBAAwB,CAAC,WAAW,EAAE,eAAe,EAAE,MAAM,EAAE,2CAA2C,EAAE,UAAU,EAAE,YAAY,CAAC,CAC7I,CAAC;QACN,CAAC,CAAC,CAAC;QACH,MAAM,OAAO,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAC;QAE5C,qEAAqE;QACrE,IAAI,2CAA2C,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACzD,MAAM,IAAI,KAAK,CAAC,0DAA0D,2CAA2C,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACxI,CAAC;QAED,8BAA8B;QAC9B,qBAAqB,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,UAAmC,EAAE,EAAE;YAC9E,sEAAsE;YACtE,MAAM,WAAW,GAAG,OAAO,UAAU,CAAC,WAAW,KAAK,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;YAEnJ,IAAI,CAAC,WAAW,EAAE,CAAC;gBACf,MAAM,IAAI,KAAK,CAAC,gBAAgB,UAAU,CAAC,WAAW,YAAY,CAAC,CAAC;YACxE,CAAC;YACD,MAAM,qBAAqB,GAAG,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,UAAU,CAAC,qBAAqB,CAAC,CAAC;YACrH,IAAI,CAAC,qBAAqB,IAAI,OAAO,qBAAqB,CAAC,SAAS,KAAK,UAAU,EAAE,CAAC;gBAClF,MAAM,IAAI,KAAK,CAAC,SAAS,UAAU,CAAC,WAAW,4CAA4C,UAAU,CAAC,qBAAqB,EAAE,CAAC,CAAC;YACnI,CAAC;YACD,MAAM,uBAAuB,GAAG,qBAAqB,CAAC,SAAS,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;YAE5F,iDAAiD;YACjD,MAAM,WAAW,GAAG,OAAO,UAAU,CAAC,UAAU,KAAK,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;YAChJ,IAAI,CAAC,WAAW,EAAE,CAAC;gBACf,MAAM,IAAI,KAAK,CAAC,gBAAgB,UAAU,CAAC,UAAU,YAAY,CAAC,CAAC;YACvE,CAAC;YAED,MAAM,qBAAqB,GAAG,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,UAAU,CAAC,oBAAoB,CAAC,CAAC;YACjH,IAAI,CAAC,qBAAqB,IAAI,OAAO,qBAAqB,KAAK,QAAQ,EAAE,CAAC;gBACtE,MAAM,IAAI,KAAK,CAAC,SAAS,UAAU,CAAC,UAAU,2CAA2C,UAAU,CAAC,oBAAoB,EAAE,CAAC,CAAC;YAChI,CAAC;YAED,wBAAwB;YACxB,uBAAuB,CAAC,IAAI,CAAC,WAAW,EAAE,qBAAqB,CAAC,CAAC;QACrE,CAAC,CAAC,CAAC;QAEH,OAAO,WAAW,CAAC;IACvB,CAAC;IAEO,KAAK,CAAC,wBAAwB,CAClC,WAAwB,EACxB,eAAmC,EACnC,MAAkB,EAClB,qCAA+C,EAC/C,UAAkC,EAClC,YAAoC;QAEpC,IAAI,QAAQ,GAAwB,IAAI,CAAC;QAEzC,kGAAkG;QAClG,mFAAmF;QACnF,IAAK,eAAuB,CAAC,SAAS,IAAI,CAAC,eAAe,CAAC,SAAS,EAAE,CAAC;YACnE,eAAe,CAAC,SAAS,GAAI,eAAuB,CAAC,SAAS,CAAC;QACnE,CAAC;QAED,yFAAyF;QACzF,IAAI,eAAe,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;YAC1C,eAAe,CAAC,SAAS,GAAG,IAAI,CAAC;QACrC,CAAC;QAED,gCAAgC;QAChC,QAAQ,eAAe,CAAC,SAAS,EAAE,CAAC;YAChC,KAAK,UAAU,CAAC,SAAS;gBACrB,CAAC;oBACG,IAAI,IAAI,CAAC,6BAA6B,EAAE,CAAC;wBACrC,QAAQ,GAAG,MAAM,IAAI,CAAC,6BAA6B,CAAC,WAAW,EAAE,eAAe,EAAE,MAAM,CAAC,CAAC;oBAC9F,CAAC;oBACD,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;wBACpB,QAAQ,GAAG,sBAAsB,CAAC,WAAW,EAAE,eAAe,CAAC,CAAC;oBACpE,CAAC;gBACL,CAAC;gBACD,MAAM;YACV,KAAK,WAAW,CAAC,SAAS;gBACtB,CAAC;oBACG,QAAQ,GAAG,WAAW,CAAC,MAAM,CAAC,UAAU,CAAC;gBAC7C,CAAC;gBACD,MAAM;YACV,OAAO,CAAC,CAAC,CAAC;gBACN,uEAAuE;gBACvE,QAAQ,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE,MAAM,EAAE,eAAe,EAAE,IAAI,CAAC,CAAC;gBAChF,IAAI,CAAC,QAAQ,EAAE,CAAC;oBACZ,IAAI,qCAAqC,CAAC,OAAO,CAAC,eAAe,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;wBAClF,qCAAqC,CAAC,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;oBAC1E,CAAC;oBACD,OAAO;gBACX,CAAC;YACL,CAAC;QACL,CAAC;QAED,0EAA0E;QAC1E,+FAA+F;QAC/F,sEAAsE;QACtE,QAAQ,CAAC,QAAQ,GAAG,eAAe,CAAC,QAAQ,CAAC;QAC7C,QAAQ,CAAC,QAAQ,GAAG,eAAe,CAAC,QAAQ,CAAC;QAE7C,qGAAqG;QACrG,IAAI,eAAe,CAAC,oBAAoB,IAAI,QAAQ,YAAY,WAAW,EAAE,CAAC;YAC1E,QAAQ,CAAC,oBAAoB,GAAG,eAAe,CAAC,oBAAoB,CAAC;QACzE,CAAC;QAED,yGAAyG;QACzG,4BAA4B;QAC5B,iBAAiB,CAAC,oBAAoB,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAE1D,kBAAkB;QAClB,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAC5C,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAC9C,CAAC;CACJ"}

package/dist/serialization/smartFilterSerializer.d.ts

@@ -0,0 +1,23 @@
+import type { SmartFilter } from "../smartFilter.js";
+import type { IBlockSerializerV1, SerializedSmartFilterV1 } from "./v1/smartFilterSerialization.types.js";
+/**
+ * Serializes SmartFilters using the latest SmartFilter serialization version.
+ * The caller passes in information necessary to serialize the blocks in the SmartFilter.
+ * This allows the caller to provide custom serializers for blocks beyond the core blocks.
+ */
+export declare class SmartFilterSerializer {
+    private readonly _blockSerializers;
+    /**
+     * Creates a new SmartFilterSerializer
+     * @param blocksUsingDefaultSerialization - A list of the blockType of blocks which can use default serialization (they only have ConnectionPoint properties and no constructor parameters)
+     * @param additionalBlockSerializers - An array of block serializers to use, beyond those for the core blocks
+     */
+    constructor(blocksUsingDefaultSerialization: string[], additionalBlockSerializers: IBlockSerializerV1[]);
+    /**
+     * Serializes a SmartFilter to a JSON object of the latest version
+     * @param smartFilter - The SmartFilter to serialize
+     * @returns The serialized SmartFilter
+     */
+    serialize(smartFilter: SmartFilter): SerializedSmartFilterV1;
+}
+//# sourceMappingURL=smartFilterSerializer.d.ts.map

package/dist/serialization/smartFilterSerializer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"smartFilterSerializer.d.ts","sourceRoot":"","sources":["../../src/serialization/smartFilterSerializer.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAMrD,OAAO,KAAK,EAAE,kBAAkB,EAAiE,uBAAuB,EAAE,MAAM,wCAAwC,CAAC;AAgBzK;;;;GAIG;AACH,qBAAa,qBAAqB;IAC9B,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAA4C;IAE9E;;;;OAIG;gBACgB,+BAA+B,EAAE,MAAM,EAAE,EAAE,0BAA0B,EAAE,kBAAkB,EAAE;IAS9G;;;;OAIG;IACI,SAAS,CAAC,WAAW,EAAE,WAAW,GAAG,uBAAuB;CA4DtE"}

package/dist/serialization/smartFilterSerializer.js

@@ -0,0 +1,95 @@
+import { InputBlockSerializer } from "../blockFoundation/inputBlock.serializer.js";
+import { DefaultBlockSerializer } from "./v1/defaultBlockSerializer.js";
+import { OutputBlock } from "../blockFoundation/outputBlock.js";
+import { CustomShaderBlock } from "../blockFoundation/customShaderBlock.js";
+import { CustomAggregateBlock } from "../blockFoundation/customAggregateBlock.js";
+/**
+ * Determines if two serialized connection points are equivalent to each other
+ * @param a - The first connection point to compare
+ * @param b - The second connection point to compare
+ * @returns True if the connection points are equivalent, false otherwise
+ */
+function SerializedConnectionPointsEqual(a, b) {
+    return (a.inputBlock === b.inputBlock && a.inputConnectionPoint === b.inputConnectionPoint && a.outputBlock === b.outputBlock && a.outputConnectionPoint === b.outputConnectionPoint);
+}
+/**
+ * Serializes SmartFilters using the latest SmartFilter serialization version.
+ * The caller passes in information necessary to serialize the blocks in the SmartFilter.
+ * This allows the caller to provide custom serializers for blocks beyond the core blocks.
+ */
+export class SmartFilterSerializer {
+    /**
+     * Creates a new SmartFilterSerializer
+     * @param blocksUsingDefaultSerialization - A list of the blockType of blocks which can use default serialization (they only have ConnectionPoint properties and no constructor parameters)
+     * @param additionalBlockSerializers - An array of block serializers to use, beyond those for the core blocks
+     */
+    constructor(blocksUsingDefaultSerialization, additionalBlockSerializers) {
+        this._blockSerializers = new Map();
+        this._blockSerializers.set(InputBlockSerializer.blockType, InputBlockSerializer.serialize);
+        this._blockSerializers.set(OutputBlock.ClassName, DefaultBlockSerializer);
+        blocksUsingDefaultSerialization.forEach((block) => {
+            this._blockSerializers.set(block, DefaultBlockSerializer);
+        });
+        additionalBlockSerializers.forEach((serializer) => this._blockSerializers.set(serializer.blockType, serializer.serialize));
+    }
+    /**
+     * Serializes a SmartFilter to a JSON object of the latest version
+     * @param smartFilter - The SmartFilter to serialize
+     * @returns The serialized SmartFilter
+     */
+    serialize(smartFilter) {
+        const connections = [];
+        const blocks = smartFilter.attachedBlocks.map((block) => {
+            // Serialize the block itself
+            const blockClassName = block.getClassName();
+            const serializeFn = blockClassName === CustomShaderBlock.ClassName || blockClassName === CustomAggregateBlock.ClassName
+                ? DefaultBlockSerializer
+                : this._blockSerializers.get(block.blockType);
+            if (!serializeFn) {
+                throw new Error(`No serializer was provided for a block of type ${block.blockType}`);
+            }
+            const serializedBlock = serializeFn(block);
+            // Serialize the connections to the inputs
+            block.inputs.forEach((input) => {
+                const connectedTo = input.connectedTo;
+                if (connectedTo) {
+                    const newConnection = {
+                        inputBlock: block.uniqueId,
+                        inputConnectionPoint: input.name,
+                        outputBlock: connectedTo.ownerBlock.uniqueId,
+                        outputConnectionPoint: connectedTo.name,
+                    };
+                    if (!connections.find((other) => SerializedConnectionPointsEqual(newConnection, other))) {
+                        connections.push(newConnection);
+                    }
+                }
+            });
+            // Serialize the connections to the outputs
+            block.outputs.forEach((output) => {
+                output.endpoints.forEach((input) => {
+                    const newConnection = {
+                        inputBlock: input.ownerBlock.uniqueId,
+                        inputConnectionPoint: input.name,
+                        outputBlock: block.uniqueId,
+                        outputConnectionPoint: output.name,
+                    };
+                    if (!connections.find((other) => SerializedConnectionPointsEqual(newConnection, other))) {
+                        connections.push(newConnection);
+                    }
+                });
+            });
+            return serializedBlock;
+        });
+        return {
+            format: "smartFilter",
+            formatVersion: 1,
+            name: smartFilter.name,
+            namespace: smartFilter.namespace,
+            comments: smartFilter.comments,
+            editorData: smartFilter.editorData,
+            blocks,
+            connections,
+        };
+    }
+}
+//# sourceMappingURL=smartFilterSerializer.js.map

package/dist/serialization/smartFilterSerializer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"smartFilterSerializer.js","sourceRoot":"","sources":["../../src/serialization/smartFilterSerializer.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,oBAAoB,EAAE,MAAM,6CAA6C,CAAC;AAEnF,OAAO,EAAE,sBAAsB,EAAE,MAAM,gCAAgC,CAAC;AACxE,OAAO,EAAE,WAAW,EAAE,MAAM,mCAAmC,CAAC;AAEhE,OAAO,EAAE,iBAAiB,EAAE,MAAM,yCAAyC,CAAC;AAC5E,OAAO,EAAE,oBAAoB,EAAE,MAAM,4CAA4C,CAAC;AAElF;;;;;GAKG;AACH,SAAS,+BAA+B,CAAC,CAA0B,EAAE,CAA0B;IAC3F,OAAO,CACH,CAAC,CAAC,UAAU,KAAK,CAAC,CAAC,UAAU,IAAI,CAAC,CAAC,oBAAoB,KAAK,CAAC,CAAC,oBAAoB,IAAI,CAAC,CAAC,WAAW,KAAK,CAAC,CAAC,WAAW,IAAI,CAAC,CAAC,qBAAqB,KAAK,CAAC,CAAC,qBAAqB,CAC/K,CAAC;AACN,CAAC;AAED;;;;GAIG;AACH,MAAM,OAAO,qBAAqB;IAG9B;;;;OAIG;IACH,YAAmB,+BAAyC,EAAE,0BAAgD;QAP7F,sBAAiB,GAAkC,IAAI,GAAG,EAAE,CAAC;QAQ1E,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,oBAAoB,CAAC,SAAS,EAAE,oBAAoB,CAAC,SAAS,CAAC,CAAC;QAC3F,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,WAAW,CAAC,SAAS,EAAE,sBAAsB,CAAC,CAAC;QAC1E,+BAA+B,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YAC9C,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,KAAK,EAAE,sBAAsB,CAAC,CAAC;QAC9D,CAAC,CAAC,CAAC;QACH,0BAA0B,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,UAAU,CAAC,SAAS,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC;IAC/H,CAAC;IAED;;;;OAIG;IACI,SAAS,CAAC,WAAwB;QACrC,MAAM,WAAW,GAA8B,EAAE,CAAC;QAElD,MAAM,MAAM,GAAG,WAAW,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,KAAgB,EAAE,EAAE;YAC/D,6BAA6B;YAC7B,MAAM,cAAc,GAAG,KAAK,CAAC,YAAY,EAAE,CAAC;YAC5C,MAAM,WAAW,GACb,cAAc,KAAK,iBAAiB,CAAC,SAAS,IAAI,cAAc,KAAK,oBAAoB,CAAC,SAAS;gBAC/F,CAAC,CAAC,sBAAsB;gBACxB,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;YACtD,IAAI,CAAC,WAAW,EAAE,CAAC;gBACf,MAAM,IAAI,KAAK,CAAC,kDAAkD,KAAK,CAAC,SAAS,EAAE,CAAC,CAAC;YACzF,CAAC;YACD,MAAM,eAAe,GAAuB,WAAW,CAAC,KAAK,CAAC,CAAC;YAE/D,0CAA0C;YAC1C,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAsB,EAAE,EAAE;gBAC5C,MAAM,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;gBACtC,IAAI,WAAW,EAAE,CAAC;oBACd,MAAM,aAAa,GAA4B;wBAC3C,UAAU,EAAE,KAAK,CAAC,QAAQ;wBAC1B,oBAAoB,EAAE,KAAK,CAAC,IAAI;wBAChC,WAAW,EAAE,WAAW,CAAC,UAAU,CAAC,QAAQ;wBAC5C,qBAAqB,EAAE,WAAW,CAAC,IAAI;qBAC1C,CAAC;oBACF,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,+BAA+B,CAAC,aAAa,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC;wBACtF,WAAW,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;oBACpC,CAAC;gBACL,CAAC;YACL,CAAC,CAAC,CAAC;YAEH,2CAA2C;YAC3C,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAuB,EAAE,EAAE;gBAC9C,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,KAAsB,EAAE,EAAE;oBAChD,MAAM,aAAa,GAA4B;wBAC3C,UAAU,EAAE,KAAK,CAAC,UAAU,CAAC,QAAQ;wBACrC,oBAAoB,EAAE,KAAK,CAAC,IAAI;wBAChC,WAAW,EAAE,KAAK,CAAC,QAAQ;wBAC3B,qBAAqB,EAAE,MAAM,CAAC,IAAI;qBACrC,CAAC;oBACF,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,+BAA+B,CAAC,aAAa,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC;wBACtF,WAAW,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;oBACpC,CAAC;gBACL,CAAC,CAAC,CAAC;YACP,CAAC,CAAC,CAAC;YAEH,OAAO,eAAe,CAAC;QAC3B,CAAC,CAAC,CAAC;QAEH,OAAO;YACH,MAAM,EAAE,aAAa;YACrB,aAAa,EAAE,CAAC;YAChB,IAAI,EAAE,WAAW,CAAC,IAAI;YACtB,SAAS,EAAE,WAAW,CAAC,SAAS;YAChC,QAAQ,EAAE,WAAW,CAAC,QAAQ;YAC9B,UAAU,EAAE,WAAW,CAAC,UAAU;YAClC,MAAM;YACN,WAAW;SACd,CAAC;IACN,CAAC;CACJ"}