gingersnap 0.22.0

package/data/model/model.d.ts

@@ -0,0 +1,207 @@
+/// <reference types="node" />
+import "reflect-metadata";
+import { DataFormat, DataType } from "./types";
+import Papa from "papaparse";
+export type ModelConstructor<T extends Model> = (new () => T) & typeof Model;
+/**
+ * Properties for handling de/serialization process for each property on a model
+ */
+export interface IgnoreProps {
+    /**
+     * Should serialization be enabled
+     */
+    serialize?: boolean;
+    /**
+     * Should deserialization be enabled
+     */
+    deserialize?: boolean;
+}
+/** @ignore */
+export interface FieldProps {
+    ignore?: IgnoreProps;
+    name: string;
+    Type: any;
+    KeyType?: any;
+    ValueType?: any;
+    isArray?: boolean;
+    isMap?: boolean;
+    readonly?: boolean;
+    aliases?: string[];
+    schema?: {
+        dataType: DataType;
+        options?: {
+            values?: string[];
+            length?: number;
+            itemType?: string;
+            recordClass?: any;
+            optional?: boolean;
+            useOptionalObj?: boolean;
+        };
+        aliases?: string[];
+    };
+    customTags?: {
+        [string: string]: {
+            properties: Object;
+            __callback__?: (name: string, properties: Object, target: Model, fieldName: string) => void;
+        };
+    };
+}
+/** @ignore */
+export interface ModelInternalProps {
+    fields: Map<string, FieldProps>;
+    parent?: string;
+}
+/** @ignore */
+export declare const namespacedModelInternalProps: Map<string, ModelInternalProps>;
+/**
+ * A container object which may or may not contain a non-null/non-undefined value
+ */
+export declare class Optional<T> {
+    private readonly value;
+    constructor(value: T | undefined);
+    /**
+     * Returns an Optional with the specified present non-null value.
+     * @param value
+     */
+    static of<T>(value: T | undefined): Optional<T>;
+    /**
+     * Returns an empty Optional instance.
+     */
+    static empty<T>(): Optional<T>;
+    /**
+     * Return true if there is a value present, otherwise false.
+     */
+    isPresent(): boolean;
+    /**
+     * If a value is present in this Optional, returns the value, otherwise throws NoSuchElement.
+     */
+    get(): T;
+}
+/**
+ * A Data de/serializer class that manages and validates data as JavaScript Objects
+ */
+export declare class Model {
+    /** @ignore */
+    private static readonly __xmlParser__;
+    /**
+     * Converts arraybuffer to a model
+     * @param data arraybuffer
+     * @param format data format
+     * @param options configurations for deserializing the data
+     * @returns new model or an array of models
+     */
+    static fromBuffer<T extends Model>(this: ModelConstructor<T>, data: Uint8Array | Buffer, format?: DataFormat, options?: {
+        headers?: string[];
+        ignoreErrors?: boolean;
+        array?: boolean;
+        delimiter?: string;
+        newline?: string;
+    }): T | T[];
+    /**
+     * Downloads data from the given source and deserializes the data to one or more models
+     * @param source URL source to fetch the data
+     * @param format data format
+     * @param options configurations for deserializing and/or retrieving the data
+     * @returns one or more models
+     */
+    static fromURL<T extends Model>(this: ModelConstructor<T>, source: string, format?: DataFormat, options?: {
+        headers?: string[];
+        ignoreErrors?: boolean;
+        array?: boolean;
+        delimiter?: string;
+        newline?: string;
+        requestHeaders?: any;
+        mode?: any;
+    }): Promise<T | T[]>;
+    /**
+     * Deserializes one or more models from a Blob
+     * @param data blob data
+     * @param format data format
+     * @param options configurations for deserializing the data
+     * @returns one or more models
+     */
+    static fromBlob<T extends Model>(this: ModelConstructor<T>, data: Blob, format?: DataFormat, options?: {
+        headers?: string[];
+        ignoreErrors?: boolean;
+        array?: boolean;
+        delimiter?: string;
+        newline?: string;
+    }): Promise<T | T[]>;
+    /**
+     * Deserializes one or more models from given string
+     *
+     * @remarks
+     * If the data format is a binary one, the provided string should be a hexadecimal string.
+     * @param data string data source
+     * @param format data format
+     * @param options
+     */
+    static fromString<T extends Model>(this: ModelConstructor<T>, data: string, format?: DataFormat, options?: {
+        headers?: string[];
+        ignoreErrors?: boolean;
+        array?: boolean;
+        delimiter?: string;
+        newline?: string;
+    }): T | T[];
+    /**
+     * Converts a JSON object to a model
+     * @param data JSON Object
+     * @returns new model
+     */
+    static fromJSON<T extends Model>(this: ModelConstructor<T>, data: object): T;
+    /**
+     * Converts the current model to a JSON object
+     */
+    object(removeMissingFields?: boolean): {
+        [string: string]: any;
+    };
+    /**
+     * Converts the current model to a JSON string
+     */
+    json(removeMissingFields?: boolean): string;
+    /**
+     * Converts the current model to an arraybuffer
+     */
+    buffer(removeMissingFields?: boolean): ArrayBuffer;
+    /**
+     * Converts the current model to a blob
+     */
+    blob(removeMissingFields?: boolean): Blob;
+    /**
+     * Converts the current model to an XML string
+     */
+    xml(removeMissingFields?: boolean): string;
+    /**
+     * Converts the current model to message pack binary format
+     * @returns message pack binary
+     */
+    messagePack(removeMissingFields?: boolean): Buffer;
+    /**
+     * Converts the current model to csv format
+     * @param removeMissingFields
+     * @param config CSV unparsing configuration
+     * @returns csv string
+     */
+    csv(removeMissingFields?: boolean, config?: Papa.UnparseConfig): string;
+    clone(): any;
+    /**
+     * Retrieves the schema of the current model based on the selected format
+     * @param format data format
+     * @returns the schema for the current model
+     */
+    schema(format?: DataFormat): any;
+    toString(): string;
+    /**
+     * Constructs the model properties by traversing the inheritance tree of the current Model being instantiated
+     * @param modelPrototype prototype of the model
+     * @ignore
+     */
+    private static buildPropTree;
+    /**
+     * Constructs a model from a JSON object
+     * @param data JSON object
+     * @param format
+     * @private
+     */
+    private static fromObject;
+}