@shapediver/sdk.sdtf-v1/src/binary_sdtf/ISdtfBinarySdtf.ts

Official sdTF SDK for TypeScript

import { ISdtfComponentList } from '../structure/ISdtfComponentList';

/** Handles parsing and construction of the three sdTF file parts: _Header_, _JSON content_ and _binary body_. */
export interface ISdtfBinarySdtf {
    readonly binaryHeaderLength: number;

    /** Constructs a new binary sdTF file from the given component list. */
    constructBinarySdtf(componentList: ISdtfComponentList): ArrayBuffer;

    /**
     * Parses the given buffer data that holds a binary sdTF and returns its JSON content and body as buffers.
     * @returns - [ JSON content buffer, binary body buffer ]
     */
    parseBinarySdtf(sdtf: ArrayBuffer): [DataView, DataView];

    /**
     * Parses the given sdTF header and validates its parts.
     * @returns - [ content length, total length ]
     * @throws {@link SdtfError} when the validation fails.
     */
    readHeader(header: DataView | ArrayBuffer): [number, number];

    /**
     * Encodes and parses the given sdTF JSON content buffer.
     * @throws {@link SdtfError} when parsing of the content fails.
     */
    readJsonContent(jsonContent: DataView | ArrayBuffer): Record<string, unknown>;
}