@shapediver/sdk.sdtf-v1/src/structure/ISdtfComponentFactory.ts

Official sdTF SDK for TypeScript

import {
    ISdtfAccessor,
    ISdtfAsset,
    ISdtfAttributes,
    ISdtfBuffer,
    ISdtfBufferView,
    ISdtfChunk,
    ISdtfDataItem,
    ISdtfFileInfo,
    ISdtfNode,
    ISdtfTypeHint,
} from '@shapediver/sdk.sdtf-core';

/**
 * Creates instances of individual sdTF components.
 * The given data is analyzed for each component property and the respective data is only set when the TypeScript type
 * matches; otherwise the property is left `unknown`.
 * However, further validation must be executed later on to ensure correct values corresponding the sdTF specification.
 */
export interface ISdtfComponentFactory {
    // @formatter:off
    readonly propertyNameAccessors: string;
    readonly propertyNameAttributes: string;
    readonly propertyNameBufferViews: string;
    readonly propertyNameBuffers: string;
    readonly propertyNameChunks: string;
    readonly propertyNameDataItems: string;
    readonly propertyNameFileInfo: string;
    readonly propertyNameNodes: string;
    readonly propertyNameTypeHints: string;
    // @formatter:on

    /** Instantiates a new sdTF accessor object and sets the given data when the respective types are correct. */
    createAccessor(accessorData: Record<string, unknown>): Partial<ISdtfAccessor>;

    /** Instantiates a new sdTF asset object and sets the given data when the respective types are correct. */
    createAsset(assetData: Record<string, unknown>): Partial<ISdtfAsset>;

    /** Instantiates a new sdTF attributes object and sets the given data when the respective types are correct. */
    createAttributes(attributesData: Record<string, unknown>): Partial<ISdtfAttributes>;

    /** Instantiates a new sdTF buffer object and sets the given data when the respective types are correct. */
    createBuffer(bufferData: Record<string, unknown>): Partial<ISdtfBuffer>;

    /** Instantiates a new sdTF buffer view object and sets the given data when the respective types are correct. */
    createBufferView(bufferViewData: Record<string, unknown>): Partial<ISdtfBufferView>;

    /** Instantiates a new sdTF chunk object and sets the given data when the respective types are correct. */
    createChunk(chunkData: Record<string, unknown>): Partial<ISdtfChunk>;

    /** Instantiates a new sdTF data item object and sets the given data when the respective types are correct. */
    createDataItem(dataItemData: Record<string, unknown>): Partial<ISdtfDataItem>;

    /** Instantiates a new sdTF file info object and sets the given data when the respective types are correct. */
    createFileInfo(fileInfoData: Record<string, unknown>): Partial<ISdtfFileInfo>;

    /** Instantiates a new sdTF node object and sets the given data when the respective types are correct. */
    createNode(nodeData: Record<string, unknown>): Partial<ISdtfNode>;

    /** Instantiates a new sdTF type hint object and sets the given data when the respective types are correct. */
    createTypeHint(typeHintData: Record<string, unknown>): Partial<ISdtfTypeHint>;
}