gingersnap 0.23.11 → 0.23.13

package/data/model/model.d.ts

@@ -23,10 +23,12 @@ export interface FieldProps {
     Type: any;
     KeyType?: any;
     ValueType?: any;
+    isUnion?: boolean;
     isArray?: boolean;
     isMap?: boolean;
     readonly?: boolean;
     aliases?: string[];
+    unionTypes?: any[];
     schema?: {
         description: string;
         dataType: DataType;
@@ -78,6 +80,26 @@ export declare class Optional<T> {
      */
     get(): T;
 }
+export interface ModelConversionOptions {
+    array?: boolean;
+    maybeArray?: boolean;
+    format?: DataFormat;
+}
+export interface ModelAdvanceConversionOptions extends ModelConversionOptions {
+    headers?: string[];
+    ignoreErrors?: boolean;
+    delimiter?: string;
+    newline?: string;
+}
+export interface ModelURLConversionOptions extends ModelAdvanceConversionOptions {
+    requestHeaders?: any;
+    mode?: any;
+}
+export interface ModelExportOptions {
+    removeMissingFields?: boolean;
+    keepOptionals?: boolean;
+}
+export type ModelJSONConversionOptions = Omit<ModelConversionOptions, "format">;
 /**
  * A Data de/serializer class that manages and validates data as JavaScript Objects
  */
@@ -87,46 +109,42 @@ export declare class Model {
     /**
      * 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;
+    static fromBuffer<T extends Model>(this: ModelConstructor<T>, data: Uint8Array | Buffer, options?: Omit<ModelAdvanceConversionOptions, "array" | "maybeArray">): T;
+    static fromBuffer<T extends Model>(this: ModelConstructor<T>, data: Uint8Array | Buffer, options: Omit<ModelAdvanceConversionOptions, "array" | "maybeArray"> & {
+        array: true;
+    }): T[];
+    static fromBuffer<T extends Model>(this: ModelConstructor<T>, data: Uint8Array | Buffer, options: Omit<ModelAdvanceConversionOptions, "array" | "maybeArray"> & {
+        maybeArray: true;
     }): T | T[];
+    static fromBuffer<T extends Model>(this: ModelConstructor<T>, data: Uint8Array | Buffer, options?: ModelAdvanceConversionOptions): 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;
+    static fromURL<T extends Model>(this: ModelConstructor<T>, source: string, options?: Omit<ModelURLConversionOptions, "array" | "maybeArray">): Promise<T>;
+    static fromURL<T extends Model>(this: ModelConstructor<T>, source: string, options: Omit<ModelURLConversionOptions, "array" | "maybeArray"> & {
+        array: true;
+    }): Promise<T[]>;
+    static fromURL<T extends Model>(this: ModelConstructor<T>, source: string, options: Omit<ModelURLConversionOptions, "array" | "maybeArray"> & {
+        maybeArray: true;
     }): 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;
+    static fromBlob<T extends Model>(this: ModelConstructor<T>, data: Blob, options?: Omit<ModelAdvanceConversionOptions, "array" | "maybeArray">): Promise<T>;
+    static fromBlob<T extends Model>(this: ModelConstructor<T>, data: Blob, options: Omit<ModelAdvanceConversionOptions, "array" | "maybeArray"> & {
+        array: true;
+    }): Promise<T[]>;
+    static fromBlob<T extends Model>(this: ModelConstructor<T>, data: Blob, options: Omit<ModelAdvanceConversionOptions, "array" | "maybeArray"> & {
+        maybeArray: true;
     }): Promise<T | T[]>;
     /**
      * Deserializes one or more models from given string
@@ -134,15 +152,14 @@ export declare class Model {
      * @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;
+    static fromString<T extends Model>(this: ModelConstructor<T>, data: string, options?: Omit<ModelAdvanceConversionOptions, "array" | "maybeArray">): T;
+    static fromString<T extends Model>(this: ModelConstructor<T>, data: string, options: Omit<ModelAdvanceConversionOptions, "array" | "maybeArray"> & {
+        array: true;
+    }): T[];
+    static fromString<T extends Model>(this: ModelConstructor<T>, data: string, options: Omit<ModelAdvanceConversionOptions, "maybeArray"> & {
+        maybeArray: true;
     }): T | T[];
     /**
      * Converts a JSON object to a model
@@ -150,47 +167,51 @@ export declare class Model {
      * @returns new model
      */
     static fromJSON<T extends Model>(this: ModelConstructor<T>, data: object): T;
+    static fromJSON<T extends Model>(this: ModelConstructor<T>, data: object, options: {
+        array: true;
+    }): T[];
+    static fromJSON<T extends Model>(this: ModelConstructor<T>, data: object, options: ModelJSONConversionOptions): T | T[];
     /**
      * Converts the current model to a JSON object
      */
-    object(removeMissingFields?: boolean): {
+    object(options?: ModelExportOptions): {
         [string: string]: any;
     };
     /**
      * Converts the current model to a JSON string
      */
-    json(removeMissingFields?: boolean): string;
+    json(options?: ModelExportOptions): string;
     /**
      * Converts the current model to an arraybuffer
      */
-    buffer(removeMissingFields?: boolean): ArrayBuffer;
+    buffer(options?: ModelExportOptions): ArrayBuffer;
     /**
      * Converts the current model to a blob
      */
-    blob(removeMissingFields?: boolean): Blob;
+    blob(options?: ModelExportOptions): Blob;
     /**
      * Converts the current model to an XML string
      */
-    xml(removeMissingFields?: boolean): string;
+    xml(options?: ModelExportOptions): string;
     /**
      * Converts the current model to message pack binary format
      * @returns message pack binary
      */
-    messagePack(removeMissingFields?: boolean): Buffer;
+    messagePack(options?: ModelExportOptions): Buffer;
     /**
      * Converts the current model to csv format
-     * @param removeMissingFields
+     * @param options
      * @param config CSV unparsing configuration
      * @returns csv string
      */
-    csv(removeMissingFields?: boolean, config?: Papa.UnparseConfig): string;
+    csv(options?: ModelExportOptions, config?: Papa.UnparseConfig): string;
     clone(): any;
     /**
      * Retrieves the schema of the current model based on the selected format
-     * @param format data format
+     * @param includeTitleAndDraft boolean whether the title and JSON schema draft version should be referenced in the schema
      * @returns the schema for the current model
      */
-    static schema(addTitleAndDraftRef?: boolean): {
+    static schema(includeTitleAndDraft?: boolean): {
         [string: string]: any;
     };
     toString(): string;
@@ -201,9 +222,9 @@ export declare class Model {
      */
     private static buildPropTree;
     /**
-     * Constructs a model from a JSON object
-     * @param data JSON object
-     * @param format
+     * Constructs a model from JSON objects
+     * @param data JSON object or array of JSON object
+     * @param options
      * @private
      */
     private static fromObject;