@trakit/objects 0.0.1 → 0.0.5

package/Providers/Config/ProviderRegistration.d.ts

@@ -4,7 +4,7 @@ import { IBelongCompany } from "../../API/Interfaces/IBelongCompany";
 import { INamed } from "../../API/Interfaces/INamed";
 import { IRequestable } from "../../API/Interfaces/IRequestable";
 import { ISerializable } from "../../API/Interfaces/ISerializable";
-import { email, phone, ulong } from "../../API/Types";
+import { email, phone, ulong, JsonObject } from "../../API/Types";
 import { User } from "../../Accounts/User";
 import { Asset } from "../../Assets/Asset";
 import { Company } from "../../Companies/Company";
@@ -115,7 +115,7 @@ export declare class ProviderRegistration extends Base implements IRequestable,
         asset: number | null;
         phoneNumber: number | null;
     };
-    fromJSON(json: any, force?: boolean): boolean;
+    fromJSON(json: JsonObject, force?: boolean): boolean;
     /**
      * The {@link code} is the key.
      */

package/Providers/Config/ProviderScript.d.ts

@@ -4,7 +4,7 @@ import { IGlobal } from "../../API/Interfaces/IGlobal";
 import { IIdUlong } from "../../API/Interfaces/IIdUlong";
 import { INamed } from "../../API/Interfaces/INamed";
 import { IVisual } from "../../API/Interfaces/IVisual";
-import { codified, colour, ulong } from "../../API/Types";
+import { JsonObject, codified, colour, ulong } from "../../API/Types";
 import { Company } from "../../Companies/Company";
 import { ProviderType } from "../ProviderType";
 import { ProviderScriptBlock } from "./ProviderScriptBlock";
@@ -77,11 +77,11 @@ export declare class ProviderScript extends BaseComponent implements IIdUlong, I
         global: boolean;
         kind: ProviderType;
         blocks: any[];
-        parameters: object;
+        parameters: JsonObject;
     };
-    fromJSON(json: any, force?: boolean): boolean;
+    fromJSON(json: JsonObject, force?: boolean): boolean;
     /**
      * The {@link id} is the key.
      */
-    getKey(): string;
+    getKey(): number;
 }

package/Providers/Config/ProviderScriptBlock.d.ts

@@ -1,4 +1,5 @@
 import { ISerializable } from "../../API/Interfaces/ISerializable";
+import { JsonObject } from "../../API/Types";
 /**
  * A chunk of script and variables used to assemble a working ProviderScript.
  */
@@ -8,7 +9,7 @@ export declare class ProviderScriptBlock implements ISerializable {
      * @param json
      * @returns
      */
-    static fromJSON(json: any): ProviderScriptBlock;
+    static fromJSON(json: JsonObject): ProviderScriptBlock;
     /**
      * A chunk of the file loaded onto a provider with it's variables replaced with configurable variables.
      * Trailing or leading whitespace should be included here, so when blocks are merged, so too is the newline characters.

package/Providers/Config/ProviderScriptParameter.d.ts

@@ -1,5 +1,5 @@
 import { ISerializable } from "../../API/Interfaces/ISerializable";
-import { uint } from "../../API/Types";
+import { uint, JsonObject } from "../../API/Types";
 import { ProviderScriptParameterType } from "./ProviderScriptParameterType";
 /**
  * Definition of an argument passed to a ProviderScript.
@@ -10,7 +10,7 @@ export declare class ProviderScriptParameter implements ISerializable {
      * @param json
      * @returns
      */
-    static fromJSON(json: any): ProviderScriptParameter;
+    static fromJSON(json: JsonObject): ProviderScriptParameter;
     /**
      * Simple type information for the gateway to process.
      */

package/Providers/Configuration/ProviderConfiguration.d.ts

@@ -2,7 +2,7 @@ import { BaseComponent } from "../../API/BaseComponent";
 import { IBelongCompany } from "../../API/Interfaces/IBelongCompany";
 import { IIdUlong } from "../../API/Interfaces/IIdUlong";
 import { INamed } from "../../API/Interfaces/INamed";
-import { ulong } from "../../API/Types";
+import { JsonObject, ulong } from "../../API/Types";
 import { Company } from "../../Companies/Company";
 import { ProviderConfigurationType } from "./ProviderConfigurationType";
 /**
@@ -57,12 +57,12 @@ export declare class ProviderConfiguration extends BaseComponent implements IIdU
         name: string;
         notes: string;
         type: number | null;
-        scriptParameters: object;
+        scriptParameters: JsonObject;
         geofences: number[];
     };
-    fromJSON(json: any, force?: boolean): boolean;
+    fromJSON(json: JsonObject, force?: boolean): boolean;
     /**
      * The {@link id} is the key.
      */
-    getKey(): string;
+    getKey(): number;
 }

package/Providers/Configuration/ProviderConfigurationNode.d.ts

@@ -1,4 +1,5 @@
 import { ISerializable } from '../../API/Interfaces/ISerializable';
+import { JsonObject } from '../../API/Types';
 /**
  * This tree-like structure is given to the script processor for the device type so that the device can follow a program.
  * @deprecated Use ProviderScriptBlock instead
@@ -8,12 +9,12 @@ export declare class ProviderConfigurationNode implements ISerializable {
      *
      * @param json
      */
-    static nodesFromJSON(json: any): Map<string, ProviderConfigurationNode>;
+    static nodesFromJSON(json: JsonObject): Map<string, ProviderConfigurationNode>;
     /**
      *
      * @param json
      */
-    static fromJSON(json: any): ProviderConfigurationNode;
+    static fromJSON(json: JsonObject): ProviderConfigurationNode;
     /**
      * Indicates that this configuration is an advanced property and should only be set by someone who knows what they're doing.
      */
@@ -60,6 +61,6 @@ export declare class ProviderConfigurationNode implements ISerializable {
         unit: string;
         notes: string;
         isAdvanced: boolean;
-        nodes: object;
+        nodes: JsonObject;
     };
 }

package/Providers/Configuration/ProviderConfigurationType.d.ts

@@ -1,7 +1,7 @@
 import { BaseComponent } from "../../API/BaseComponent";
 import { IIdUlong } from "../../API/Interfaces/IIdUlong";
 import { INamed } from "../../API/Interfaces/INamed";
-import { uint, ulong } from "../../API/Types";
+import { JsonObject, uint, ulong } from "../../API/Types";
 import { PlaceType } from "../../Places/PlaceType";
 import { ProviderType } from "../ProviderType";
 import { ProviderConfigurationNode } from "./ProviderConfigurationNode";
@@ -51,12 +51,12 @@ export declare class ProviderConfigurationType extends BaseComponent implements
         providerType: ProviderType;
         maxGeofenceCount: number | null;
         minGeofenceCount: number | null;
-        scriptOptions: object;
+        scriptOptions: JsonObject;
         geofenceTypes: PlaceType[];
     };
-    fromJSON(json: any, force?: boolean): boolean;
+    fromJSON(json: JsonObject, force?: boolean): boolean;
     /**
      * The {@link id} is the key.
      */
-    getKey(): string;
+    getKey(): number;
 }

package/Providers/Configuration/ProviderGeofenceBase.d.ts

@@ -1,20 +1,18 @@
 import { ISerializable } from "../../API/Interfaces/ISerializable";
-import { uint } from "../../API/Types";
+import { JsonObject, uint } from "../../API/Types";
 import { PlaceType } from "../../Places/PlaceType";
-import { ProviderGeofenceCircular } from "./ProviderGeofenceCircular";
-import { ProviderGeofencePoint } from "./ProviderGeofencePoint";
-import { ProviderGeofencePolygon } from "./ProviderGeofencePolygon";
-import { ProviderGeofenceRectangle } from "./ProviderGeofenceRectangle";
 /**
  * An abstract class used as a base for all Geofence type classes.
  * @deprecated
  */
 export declare abstract class ProviderGeofenceBase implements ISerializable {
     /**
-     *
-     * @param json
+     * Instantiates a geofence based on the `type` property in the given JSON.
+     * Implementation is in {@link ProviderGeofenceBase_fromJSON.ts}
+     * @param json	The JSON to parse.
+     * @returns		An instance of a {@link ProviderGeofenceBase} subclass.
      */
-    static fromJSON(json: any): ProviderGeofencePoint | ProviderGeofenceCircular | ProviderGeofenceRectangle | ProviderGeofencePolygon;
+    static fromJSON: (json: JsonObject) => ProviderGeofenceBase;
     /**
      * The supported shape of geofence.
      */

package/Providers/Configuration/ProviderGeofenceBase_fromJSON.d.ts

@@ -0,0 +1 @@
+export {};

package/Providers/Provider.d.ts

@@ -3,8 +3,11 @@ import { BaseCompound } from "../API/BaseCompound";
 import { IBelongCompany } from "../API/Interfaces/IBelongCompany";
 import { INamed } from "../API/Interfaces/INamed";
 import { ISuspendable } from "../API/Interfaces/ISuspendable";
-import { ipv4, phone, ulong } from "../API/Types";
+import { JsonObject, ipv4, phone, ulong } from "../API/Types";
+import { Asset } from "../Assets/Asset";
 import { Company } from "../Companies/Company";
+import { ProviderConfig } from "./Config/ProviderConfig";
+import { ProviderConfiguration } from "./Configuration/ProviderConfiguration";
 import { ProviderAdvanced } from "./ProviderAdvanced";
 import { ProviderCommand } from "./ProviderCommand";
 import { ProviderCommandType } from "./ProviderCommandType";
@@ -56,15 +59,28 @@ export declare class Provider extends BaseCompound implements INamed, IBelongCom
      * The asset for which this device provides field data.
      * {@link Asset.id}
      */
-    get asset(): ulong;
-    set asset(value: ulong);
+    get assetId(): ulong;
+    set assetId(value: ulong);
+    /**
+     * The asset for which this device provides field data.
+     * {@link Asset.id}
+     */
+    get asset(): Asset;
+    set asset(value: Asset);
+    /**
+     * The provider's current (or pending) configuration profile.
+     * {@link ProviderConfig.id}
+     * {@link ProviderConfiguration.id}
+     */
+    get configurationId(): ulong;
+    set configurationId(value: ulong);
     /**
      * The provider's current (or pending) configuration profile.
      * {@link ProviderConfig.id}
      * {@link ProviderConfiguration.id}
      */
-    get configuration(): ulong;
-    set configuration(value: ulong);
+    get configuration(): ProviderConfig | ProviderConfiguration;
+    set configuration(value: ProviderConfig | ProviderConfiguration);
     /**
      * The password programmed on the device used to ensure the system is the only client authorized to make changes.
      */
@@ -113,23 +129,73 @@ export declare class Provider extends BaseCompound implements INamed, IBelongCom
     get commands(): Map<ProviderCommandType, ProviderCommand>;
     set commands(value: Map<ProviderCommandType, ProviderCommand>);
     toJSON(): {
-        asset?: number | null | undefined;
-        password?: string | undefined;
-        firmware?: string | undefined;
-        phoneNumber?: number | null | undefined;
-        information?: object | undefined;
-        sim?: string | undefined;
-        suspended?: boolean | undefined;
-        since?: string | null | undefined;
+        suspended: boolean;
+        since: string | null;
+        id: string | null;
+        v: number[];
+        company: number | null;
+        name: string;
+        notes: string;
+        kind: ProviderType;
+        configuration: number | null;
+    } | {
+        asset: number | null;
+        password: string;
+        firmware: string;
+        phoneNumber: number | null;
+        information: JsonObject;
+        sim: string;
         id: string | null;
+        v: number[];
         company: number | null;
+        name: string;
+        notes: string;
         kind: ProviderType;
+        configuration: number | null;
+    } | {
+        control: {
+            id: string | null;
+            v: number[];
+            company: number | null;
+            commands: JsonObject;
+        };
+        v: number[];
+        id: string | null;
+        company: number;
+        lastIP: string;
+        attributes: JsonObject;
+        snf: JsonObject;
+        suspended: boolean;
+        since: string | null;
         name: string;
         notes: string;
+        kind: ProviderType;
         configuration: number | null;
+    } | {
+        control: {
+            id: string | null;
+            v: number[];
+            company: number | null;
+            commands: JsonObject;
+        };
         v: number[];
+        id: string | null;
+        company: number;
+        lastIP: string;
+        attributes: JsonObject;
+        snf: JsonObject;
+        asset: number | null;
+        password: string;
+        firmware: string;
+        phoneNumber: number | null;
+        information: JsonObject;
+        sim: string;
+        name: string;
+        notes: string;
+        kind: ProviderType;
+        configuration: number | null;
     };
-    fromJSON(json: any, force?: boolean): boolean;
+    fromJSON(json: JsonObject, force?: boolean): boolean;
     /**
      * The {@link id} is the key.
      */

package/Providers/ProviderAdvanced.d.ts

@@ -1,6 +1,6 @@
 import { BaseComponent } from "../API/BaseComponent";
 import { IBelongCompany } from "../API/Interfaces/IBelongCompany";
-import { ipv4, ulong } from "../API/Types";
+import { JsonObject, ipv4, ulong } from "../API/Types";
 import { Company } from "../Companies/Company";
 import { ProviderData } from "./ProviderData";
 /**
@@ -40,10 +40,10 @@ export declare class ProviderAdvanced extends BaseComponent implements IBelongCo
         v: number[];
         company: number;
         lastIP: string;
-        attributes: object;
-        snf: object;
+        attributes: JsonObject;
+        snf: JsonObject;
     };
-    fromJSON(json: any, force?: boolean): boolean;
+    fromJSON(json: JsonObject, force?: boolean): boolean;
     /**
      * The {@link id} is the key.
      */

package/Providers/ProviderCommand.d.ts

@@ -1,5 +1,5 @@
 import { ISerializable } from "../API/Interfaces/ISerializable";
-import { datetime } from "../API/Types";
+import { datetime, JsonObject } from "../API/Types";
 import { ProviderCommandStatus } from "./ProviderCommandStatus";
 /**
  * Details regarding a provider command
@@ -9,7 +9,7 @@ export declare class ProviderCommand implements ISerializable {
      *
      * @param json
      */
-    static fromJSON(json: any): ProviderCommand;
+    static fromJSON(json: JsonObject): ProviderCommand;
     /**
      * Current status of this command.
      */

package/Providers/ProviderControl.d.ts

@@ -1,6 +1,6 @@
 import { BaseComponent } from "../API/BaseComponent";
 import { IBelongCompany } from "../API/Interfaces/IBelongCompany";
-import { ulong } from "../API/Types";
+import { JsonObject, ulong } from "../API/Types";
 import { Company } from "../Companies/Company";
 import { ProviderCommand } from "./ProviderCommand";
 import { ProviderCommandType } from "./ProviderCommandType";
@@ -32,9 +32,9 @@ export declare class ProviderControl extends BaseComponent implements IBelongCom
         id: string | null;
         v: number[];
         company: number | null;
-        commands: object;
+        commands: JsonObject;
     };
-    fromJSON(json: any, force?: boolean): boolean;
+    fromJSON(json: JsonObject, force?: boolean): boolean;
     /**
      * The {@link id} is the key.
      */

package/Providers/ProviderData.d.ts

@@ -1,5 +1,5 @@
 import { ISerializable } from "../API/Interfaces/ISerializable";
-import { datetime } from "../API/Types";
+import { datetime, JsonObject } from "../API/Types";
 /**
  * A fragment of data given by a device.
  */
@@ -8,7 +8,7 @@ export declare class ProviderData implements ISerializable {
      *
      * @param json
      */
-    static fromJSON(json: any): ProviderData;
+    static fromJSON(json: JsonObject): ProviderData;
     /**
      * The value of the data given like true, 17.3, "asdf", etc...
      */

package/Providers/ProviderGeneral.d.ts

@@ -2,7 +2,7 @@ import { BaseComponent } from "../API/BaseComponent";
 import { IBelongCompany } from "../API/Interfaces/IBelongCompany";
 import { INamed } from "../API/Interfaces/INamed";
 import { ISuspendable } from "../API/Interfaces/ISuspendable";
-import { phone, ulong } from "../API/Types";
+import { JsonObject, phone, ulong } from "../API/Types";
 import { Asset } from "../Assets/Asset";
 import { Company } from "../Companies/Company";
 import { ProviderConfig } from "./Config/ProviderConfig";
@@ -85,23 +85,31 @@ export declare class ProviderGeneral extends BaseComponent implements INamed, IB
      */
     sim: string;
     toJSON(): {
-        asset?: number | null | undefined;
-        password?: string | undefined;
-        firmware?: string | undefined;
-        phoneNumber?: number | null | undefined;
-        information?: object | undefined;
-        sim?: string | undefined;
-        suspended?: boolean | undefined;
-        since?: string | null | undefined;
+        suspended: boolean;
+        since: string | null;
         id: string | null;
+        v: number[];
         company: number | null;
         name: string;
         notes: string;
         kind: ProviderType;
         configuration: number | null;
+    } | {
+        asset: number | null;
+        password: string;
+        firmware: string;
+        phoneNumber: number | null;
+        information: JsonObject;
+        sim: string;
+        id: string | null;
         v: number[];
+        company: number | null;
+        name: string;
+        notes: string;
+        kind: ProviderType;
+        configuration: number | null;
     };
-    fromJSON(json: any, force?: boolean): boolean;
+    fromJSON(json: JsonObject, force?: boolean): boolean;
     /**
      * The {@link id} is the key.
      */

package/Reports/ReportBreakdown.d.ts

@@ -1,5 +1,5 @@
 import { ISerializable } from "../API/Interfaces/ISerializable";
-import { uint, ulong } from "../API/Types";
+import { JsonObject, nothing, uint, ulong } from "../API/Types";
 import { Asset } from "../Assets/Asset";
 import { AssetAdvanced } from "../Assets/AssetAdvanced";
 import { AssetGeneral } from "../Assets/AssetGeneral";
@@ -8,10 +8,12 @@ import { AssetGeneral } from "../Assets/AssetGeneral";
  */
 export declare class ReportBreakdown implements ISerializable {
     /**
-     *
-     * @param json
+     * Instantiates a {@link ReportBreakdown} or one of its subclasses based on the shape of the JSON.
+     * Implementation is in {@link ReportBreakdown_fromJSON.ts}
+     * @param json	The JSON to parse.
+     * @returns		An instance of a {@link ReportBreakdown} or one of its subclasses.
      */
-    static fromJSON(json: any): ReportBreakdown;
+    static fromJSON: (json: JsonObject) => ReportBreakdown;
     /**
      * The asset to which this event data belongs.
      */
@@ -36,37 +38,12 @@ export declare class ReportBreakdown implements ISerializable {
      * Advanced/detailed information used.
      */
     advanced: AssetAdvanced | null;
-    constructor(asset?: ulong, instance?: uint, summaryInstances?: uint[], general?: AssetGeneral | null, advanced?: AssetAdvanced | null);
+    constructor(asset: ulong, instance: uint, summaryInstances?: uint[] | nothing, general?: AssetGeneral | nothing, advanced?: AssetAdvanced | nothing);
     toJSON(): {
         asset: number | null;
         instance: number | null;
         summaryInstances: number[];
-        general: {
-            suspended?: boolean | undefined;
-            since?: string | null | undefined;
-            references?: object | undefined;
-            messagingAddress?: string | undefined;
-            pictures?: number[] | undefined;
-            id: number | null;
-            v: number[];
-            company: number;
-            kind: import("../Assets/AssetType").AssetType;
-            name: string;
-            notes: string;
-            icon: number;
-            labels: string[];
-        } | null;
-        advanced: {
-            id: number | null;
-            v: number[];
-            company: number;
-            position: import("../API/Geography/Interfaces").IPosition | null;
-            odometer: number;
-            tags: string[];
-            attributes: object;
-            providers: string[];
-            relationships: number[];
-            places: object;
-        } | null;
+        general: JsonObject | null;
+        advanced: JsonObject | null;
     };
 }

package/Reports/ReportBreakdownJob.d.ts

@@ -1,4 +1,4 @@
-import { uint, ulong } from "../API/Types";
+import { nothing, uint, ulong } from "../API/Types";
 import { AssetAdvanced } from "../Assets/AssetAdvanced";
 import { AssetGeneral } from "../Assets/AssetGeneral";
 import { DispatchJob } from "../Dispatch/DispatchJob";
@@ -11,7 +11,7 @@ export declare class ReportBreakdownJob extends ReportBreakdown {
      * The Job used.
      */
     job: DispatchJob;
-    constructor(job: DispatchJob, asset?: ulong, instance?: uint, summaryInstances?: uint[], general?: AssetGeneral | null, advanced?: AssetAdvanced | null);
+    constructor(job: DispatchJob, asset: ulong, instance: uint, summaryInstances?: uint[] | nothing, general?: AssetGeneral | nothing, advanced?: AssetAdvanced | nothing);
     toJSON(): {
         job: {
             id: number | null;
@@ -21,8 +21,8 @@ export declare class ReportBreakdownJob extends ReportBreakdown {
             created: string | null;
             name: string;
             instructions: string;
-            priority: import("../Dispatch/DispatchJobPriority").DispatchJobPriority;
-            references: object;
+            priority: import("..").DispatchJobPriority;
+            references: import("..").JsonObject;
             labels: string[];
             tags: string[];
             forms: number[];
@@ -31,32 +31,7 @@ export declare class ReportBreakdownJob extends ReportBreakdown {
         asset: number | null;
         instance: number | null;
         summaryInstances: number[];
-        general: {
-            suspended?: boolean | undefined;
-            since?: string | null | undefined;
-            references?: object | undefined;
-            messagingAddress?: string | undefined;
-            pictures?: number[] | undefined;
-            id: number | null;
-            v: number[];
-            company: number;
-            kind: import("../Assets/AssetType").AssetType;
-            name: string;
-            notes: string;
-            icon: number;
-            labels: string[];
-        } | null;
-        advanced: {
-            id: number | null;
-            v: number[];
-            company: number;
-            position: import("../API/Geography/Interfaces").IPosition | null;
-            odometer: number;
-            tags: string[];
-            attributes: object;
-            providers: string[];
-            relationships: number[];
-            places: object;
-        } | null;
+        general: import("..").JsonObject | null;
+        advanced: import("..").JsonObject | null;
     };
 }

package/Reports/ReportBreakdownMessage.d.ts

@@ -1,4 +1,4 @@
-import { uint, ulong } from "../API/Types";
+import { nothing, uint, ulong } from "../API/Types";
 import { AssetAdvanced } from "../Assets/AssetAdvanced";
 import { AssetGeneral } from "../Assets/AssetGeneral";
 import { AssetMessage } from "../Messaging/AssetMessage";
@@ -11,17 +11,17 @@ export declare class ReportBreakdownMessage extends ReportBreakdown {
      * The Message used.
      */
     message: AssetMessage;
-    constructor(message: AssetMessage, asset?: ulong, instance?: uint, summaryInstances?: uint[], general?: AssetGeneral | null, advanced?: AssetAdvanced | null);
+    constructor(message: AssetMessage, asset: ulong, instance: uint, summaryInstances?: uint[] | nothing, general?: AssetGeneral | nothing, advanced?: AssetAdvanced | nothing);
     toJSON(): {
         message: {
-            folder: import("../Messaging/MessageFolder").MessageFolder;
+            folder: import("..").MessageFolder;
             incoming: boolean;
             readBy: string;
             id: number | null;
             v: number[];
             company: number;
-            kind: import("../Messaging/MessageType").MessageType;
-            status: import("../Messaging/MessageStatus").MessageStatus;
+            status: import("..").MessageStatus;
+            kind: import("..").MessageType;
             to: string;
             from: string;
             body: string;
@@ -34,32 +34,7 @@ export declare class ReportBreakdownMessage extends ReportBreakdown {
         asset: number | null;
         instance: number | null;
         summaryInstances: number[];
-        general: {
-            suspended?: boolean | undefined;
-            since?: string | null | undefined;
-            references?: object | undefined;
-            messagingAddress?: string | undefined;
-            pictures?: number[] | undefined;
-            id: number | null;
-            v: number[];
-            company: number;
-            kind: import("../Assets/AssetType").AssetType;
-            name: string;
-            notes: string;
-            icon: number;
-            labels: string[];
-        } | null;
-        advanced: {
-            id: number | null;
-            v: number[];
-            company: number;
-            position: import("../API/Geography/Interfaces").IPosition | null;
-            odometer: number;
-            tags: string[];
-            attributes: object;
-            providers: string[];
-            relationships: number[];
-            places: object;
-        } | null;
+        general: import("..").JsonObject | null;
+        advanced: import("..").JsonObject | null;
     };
 }