@trakit/objects 0.0.1

package/Providers/Config/ProviderScriptBlock.d.ts

@@ -0,0 +1,40 @@
+import { ISerializable } from "../../API/Interfaces/ISerializable";
+/**
+ * A chunk of script and variables used to assemble a working ProviderScript.
+ */
+export declare class ProviderScriptBlock implements ISerializable {
+    /**
+     *
+     * @param json
+     * @returns
+     */
+    static fromJSON(json: any): 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.
+     */
+    content: string;
+    /**
+     * A regular expression used to match variables in the content.
+     * The regex must contain at least one match-group.
+     * The value fom the last group is what's used as a parameter name.
+     * @example {{([a-z]+)}}
+     * @example <(var[a-z]+)>
+     */
+    replace: string;
+    /**
+     * When defined, this condition matches a {@link ProviderScriptParameter} defined in the {@link ProviderConfig} to include or exclude this chunk from the script.
+     */
+    condition: string;
+    /**
+     * Used in conjunction with condition, this value must match the given ProviderScriptParameter value to have the chunk included.
+     */
+    validate: string;
+    constructor(content?: string, replace?: string, condition?: string, validate?: string);
+    toJSON(): {
+        content: string;
+        replace: string;
+        condition: string;
+        validate: string;
+    };
+}

package/Providers/Config/ProviderScriptParameter.d.ts

@@ -0,0 +1,49 @@
+import { ISerializable } from "../../API/Interfaces/ISerializable";
+import { uint } from "../../API/Types";
+import { ProviderScriptParameterType } from "./ProviderScriptParameterType";
+/**
+ * Definition of an argument passed to a ProviderScript.
+ */
+export declare class ProviderScriptParameter implements ISerializable {
+    /**
+     *
+     * @param json
+     * @returns
+     */
+    static fromJSON(json: any): ProviderScriptParameter;
+    /**
+     * Simple type information for the gateway to process.
+     */
+    kind: ProviderScriptParameterType;
+    /**
+     * The value is given as a string, but parsed into native type when used by the gateway.
+     */
+    value: string;
+    /**
+     * Usage notes.
+     */
+    notes: string;
+    /**
+     * Gives a hint to the client on the best UI to use for editing.
+     * For example, "checkbox" is a good UI hint for boolean parameter types.
+     */
+    context: string;
+    /**
+     * The order in which this parameter is displayed compared to other parameters.
+     * The value has no effect on how this parameter is inserted into the ProviderScriptBlocks.
+     */
+    order: uint;
+    /**
+     * Used as a hint that this parameter controls an advanced script option and should only be set if you really know what you're doing.
+     */
+    advanced: boolean;
+    constructor(kind?: ProviderScriptParameterType, value?: string, notes?: string, context?: string, order?: uint, advanced?: boolean);
+    toJSON(): {
+        kind: ProviderScriptParameterType;
+        value: string;
+        notes: string;
+        context: string;
+        order: number;
+        advanced: boolean;
+    };
+}

package/Providers/Config/ProviderScriptParameterType.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Possible data-types given to ProviderScriptParameter.
+ */
+export declare enum ProviderScriptParameterType {
+    /**
+     * True or false.
+     */
+    boolean = "boolean",
+    /**
+     * Numeric value (double-precision floating point number).
+     */
+    number = "number",
+    /**
+     * Text.
+     */
+    text = "text"
+}

package/Providers/Configuration/ProviderConfiguration.d.ts

@@ -0,0 +1,68 @@
+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 { Company } from "../../Companies/Company";
+import { ProviderConfigurationType } from "./ProviderConfigurationType";
+/**
+ * The configured logic loaded onto the provider over-the-air to control it's reporting schedule and behaviour.
+ * @deprecated Use {@link ProviderConfig} instead.
+ */
+export declare class ProviderConfiguration extends BaseComponent implements IIdUlong, INamed, IBelongCompany {
+    /**
+     * Unique identifier of this configuration.
+     */
+    id: ulong;
+    /**
+     * The company to which this configuration belongs.
+     * {@link Company.id}
+     */
+    companyId: ulong;
+    /**
+     * The company to which this configuration belongs.
+     * {@link Company.id}
+     */
+    get company(): Company;
+    /**
+     * The nickname given to this configuration
+     */
+    name: string;
+    /**
+     * Simple details about how the providers are expected to behave.
+     */
+    notes: string;
+    /**
+     * The logic type which this configuration implements.
+     * {@link ProviderConfigurationType.id}
+     */
+    typeId: ulong;
+    /**
+     * The logic type which this configuration implements.
+     * {@link ProviderConfigurationType.id}
+     */
+    get type(): ProviderConfigurationType;
+    /**
+     * The list of defined variables given to the {@link ProviderConfigurationType.scriptOptions|logic type's options} pairs for the logic type requires.
+     */
+    scriptParameters: Map<string, any>;
+    /**
+     * List of Places loaded directly onto the provider.
+     */
+    geofences: ulong[];
+    toJSON(): {
+        id: number;
+        company: number;
+        v: number[];
+        name: string;
+        notes: string;
+        type: number | null;
+        scriptParameters: object;
+        geofences: number[];
+    };
+    fromJSON(json: any, force?: boolean): boolean;
+    /**
+     * The {@link id} is the key.
+     */
+    getKey(): string;
+}

package/Providers/Configuration/ProviderConfigurationNode.d.ts

@@ -0,0 +1,65 @@
+import { ISerializable } from '../../API/Interfaces/ISerializable';
+/**
+ * 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
+ */
+export declare class ProviderConfigurationNode implements ISerializable {
+    /**
+     *
+     * @param json
+     */
+    static nodesFromJSON(json: any): Map<string, ProviderConfigurationNode>;
+    /**
+     *
+     * @param json
+     */
+    static fromJSON(json: any): ProviderConfigurationNode;
+    /**
+     * Indicates that this configuration is an advanced property and should only be set by someone who knows what they're doing.
+     */
+    isAdvanced: boolean;
+    /**
+     * Unique identifier of the value being mapped.
+     */
+    id: string;
+    /**
+     * The value being set.
+     */
+    value: any;
+    /**
+     * The minimum possible value for this confugration node.
+     */
+    min: any;
+    /**
+     * The maximum possible value for this confugration node.
+     */
+    max: any;
+    /**
+     * Type hint used by the script processor to help format the value.
+     */
+    type: string;
+    /**
+     * Unit hint used to help the script processor format the value.
+     */
+    unit: string;
+    /**
+     * Description of what this configuration does when mapped to a device.
+     */
+    notes: string;
+    /**
+     * Child configuration nodes.
+     */
+    nodes: Map<string, ProviderConfigurationNode>;
+    constructor(id?: string, notes?: string, isAdvanced?: boolean, type?: string, min?: any, max?: any, value?: any, unit?: string, nodes?: Map<string, ProviderConfigurationNode>);
+    toJSON(): {
+        id: string;
+        value: any;
+        min: any;
+        max: any;
+        type: string;
+        unit: string;
+        notes: string;
+        isAdvanced: boolean;
+        nodes: object;
+    };
+}

package/Providers/Configuration/ProviderConfigurationType.d.ts

@@ -0,0 +1,62 @@
+import { BaseComponent } from "../../API/BaseComponent";
+import { IIdUlong } from "../../API/Interfaces/IIdUlong";
+import { INamed } from "../../API/Interfaces/INamed";
+import { uint, ulong } from "../../API/Types";
+import { PlaceType } from "../../Places/PlaceType";
+import { ProviderType } from "../ProviderType";
+import { ProviderConfigurationNode } from "./ProviderConfigurationNode";
+/**
+ * This read-only class describes a type of logic applied to a provider.
+ * ProviderConfigurationTypes are used to help define a ProviderConfiguration.
+ * @deprecated Use ProviderScript instead
+ */
+export declare class ProviderConfigurationType extends BaseComponent implements IIdUlong, INamed {
+    /**
+     * Unique identifier.
+     */
+    id: ulong;
+    /**
+     * Name of the configuration type.
+     */
+    name: string;
+    /**
+     * Notes regarding the use of this configuration.
+     */
+    notes: string;
+    /**
+     * The applicable type of provider for which this configuration type can be created.
+     */
+    providerType: ProviderType;
+    /**
+     * The maximum number of geofences that can be programmed onto a device. This number changes based on device make and model, and can also change based on the supported geofence types.
+     */
+    maxGeofenceCount: uint;
+    /**
+     * The minimum number of geofences that need to be programmed onto the device. This value is almost always zero.
+     */
+    minGeofenceCount: uint;
+    /**
+     * A tree-structure of configurations required (or optionally available) for programming a device.
+     */
+    scriptOptions: Map<string, ProviderConfigurationNode>;
+    /**
+     * A list of supported types of geofences which can be programmed directly onto the device.
+     */
+    geofenceTypes: PlaceType[];
+    toJSON(): {
+        id: number;
+        v: number[];
+        name: string;
+        notes: string;
+        providerType: ProviderType;
+        maxGeofenceCount: number | null;
+        minGeofenceCount: number | null;
+        scriptOptions: object;
+        geofenceTypes: PlaceType[];
+    };
+    fromJSON(json: any, force?: boolean): boolean;
+    /**
+     * The {@link id} is the key.
+     */
+    getKey(): string;
+}

package/Providers/Configuration/ProviderGeofenceBase.d.ts

@@ -0,0 +1,31 @@
+import { ISerializable } from "../../API/Interfaces/ISerializable";
+import { 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
+     */
+    static fromJSON(json: any): ProviderGeofencePoint | ProviderGeofenceCircular | ProviderGeofenceRectangle | ProviderGeofencePolygon;
+    /**
+     * The supported shape of geofence.
+     */
+    abstract get type(): PlaceType;
+    /**
+     * The maximum number of unique geofences supported by the device.
+     */
+    maxGeofenceCount: uint;
+    constructor(maxGeofenceCount?: uint);
+    toJSON(): {
+        type: PlaceType;
+        maxGeofenceCount: number;
+    };
+}

package/Providers/Configuration/ProviderGeofenceCircular.d.ts

@@ -0,0 +1,28 @@
+import { uint } from "../../API/Types";
+import { PlaceType } from "../../Places/PlaceType";
+import { ProviderGeofenceBase } from "./ProviderGeofenceBase";
+/**
+ * A geofence defined by a centre coordinate and a threshold value to indicate the boundary around that point.
+ * @deprecated
+ */
+export declare class ProviderGeofenceCircular extends ProviderGeofenceBase {
+    /**
+     * Distance from a central point.
+     */
+    get type(): PlaceType;
+    /**
+     * The smallest possible radius for this geofence.
+     */
+    minRadius: uint;
+    /**
+     * The largest possible radius for this geofence.
+     */
+    maxRadius: uint;
+    constructor(maxGeofenceCount?: uint, minRadius?: uint, maxRadius?: uint);
+    toJSON(): {
+        minRadius: number | null;
+        maxRadius: number | null;
+        type: PlaceType;
+        maxGeofenceCount: number;
+    };
+}

package/Providers/Configuration/ProviderGeofencePoint.d.ts

@@ -0,0 +1,12 @@
+import { PlaceType } from "../../Places/PlaceType";
+import { ProviderGeofenceBase } from "./ProviderGeofenceBase";
+/**
+ * This is a point and not a geofence, so I don't know why this is defined.
+ * @deprecated
+ */
+export declare class ProviderGeofencePoint extends ProviderGeofenceBase {
+    /**
+     * Not a boundary, so the modem must use its own internal threshold.
+     */
+    get type(): PlaceType;
+}

package/Providers/Configuration/ProviderGeofencePolygon.d.ts

@@ -0,0 +1,23 @@
+import { uint } from "../../API/Types";
+import { PlaceType } from "../../Places/PlaceType";
+import { ProviderGeofenceBase } from "./ProviderGeofenceBase";
+/**
+ * A geofence whose boundary is defined by a non-overlapping series of coordinates.
+ * @deprecated
+ */
+export declare class ProviderGeofencePolygon extends ProviderGeofenceBase {
+    /**
+     * Complex geofence.
+     */
+    get type(): PlaceType;
+    /**
+     * The maximum number of vertices supported by the device.
+     */
+    maxVertices: uint;
+    constructor(maxGeofenceCount?: uint, maxVertices?: uint);
+    toJSON(): {
+        maxVertices: number | null;
+        type: PlaceType;
+        maxGeofenceCount: number;
+    };
+}

package/Providers/Configuration/ProviderGeofenceRectangle.d.ts

@@ -0,0 +1,28 @@
+import { int, uint } from "../../API/Types";
+import { PlaceType } from "../../Places/PlaceType";
+import { ProviderGeofenceBase } from "./ProviderGeofenceBase";
+/**
+ * A geofence whose boundary is a "rectangle" defined by corner coordinates.
+ * @deprecated
+ */
+export declare class ProviderGeofenceRectangle extends ProviderGeofenceBase {
+    /**
+     * Boundaries defined with only two coordinates.
+     */
+    get type(): PlaceType;
+    /**
+     * The smallest possible diameter for this geofence.
+     */
+    maxLength: uint;
+    /**
+     * The smallest possible diameter for this geofence.
+     */
+    maxWidth: uint;
+    constructor(maxGeofenceCount?: uint, maxLength?: int, maxWidth?: int);
+    toJSON(): {
+        maxLength: number | null;
+        maxWidth: number | null;
+        type: PlaceType;
+        maxGeofenceCount: number;
+    };
+}

package/Providers/Provider.d.ts

@@ -0,0 +1,145 @@
+import { BaseComponent } from "../API/BaseComponent";
+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 { Company } from "../Companies/Company";
+import { ProviderAdvanced } from "./ProviderAdvanced";
+import { ProviderCommand } from "./ProviderCommand";
+import { ProviderCommandType } from "./ProviderCommandType";
+import { ProviderControl } from "./ProviderControl";
+import { ProviderData } from "./ProviderData";
+import { ProviderGeneral } from "./ProviderGeneral";
+import { ProviderType } from "./ProviderType";
+/**
+ * A device, modem, or service which provides events from the field.
+ */
+export declare class Provider extends BaseCompound implements INamed, IBelongCompany, ISuspendable {
+    #private;
+    /**
+     *
+     */
+    get pieces(): BaseComponent[];
+    /**
+     * Unique identifier of this device.
+     * {@link Asset.id}
+     */
+    get id(): string;
+    /**
+     * The company to which this device belongs.
+     * {@link Company.id}
+     */
+    get companyId(): ulong;
+    /**
+     * The company to which this device belongs.
+     * {@link Company.id}
+     */
+    get company(): Company;
+    set company(value: Company);
+    /**
+     * The kind of communication protocol this device uses.
+     */
+    get kind(): ProviderType;
+    get general(): ProviderGeneral;
+    /**
+     * This thing's name.
+     */
+    get name(): string;
+    set name(value: string);
+    /**
+     * Notes about it.
+     */
+    get notes(): string;
+    set notes(value: string);
+    /**
+     * The asset for which this device provides field data.
+     * {@link Asset.id}
+     */
+    get asset(): ulong;
+    set asset(value: ulong);
+    /**
+     * The provider's current (or pending) configuration profile.
+     * {@link ProviderConfig.id}
+     * {@link ProviderConfiguration.id}
+     */
+    get configuration(): ulong;
+    set configuration(value: ulong);
+    /**
+     * The password programmed on the device used to ensure the system is the only client authorized to make changes.
+     */
+    get password(): string;
+    set password(value: string);
+    /**
+     * The firmware/application version number.
+     */
+    get firmware(): string;
+    set firmware(value: string);
+    /**
+     * The phone number of this device.
+     */
+    get phoneNumber(): phone;
+    set phoneNumber(value: phone);
+    /**
+     * A list of read-only values about the device like IMEI, ESN, firmware version, hardware revision, etc...
+     */
+    get information(): Map<string, string>;
+    set information(value: Map<string, string>);
+    /**
+     * ICCID of the SIM card installed in this provider
+     */
+    get sim(): string;
+    set sim(value: string);
+    get advanced(): ProviderAdvanced;
+    /**
+     * The last IP address of the device.
+     */
+    get lastIP(): ipv4;
+    set lastIP(value: ipv4);
+    /**
+     * Often changing values like latitude, longitude, speed, wiring state, VBus information, etc...
+     */
+    get attributes(): Map<string, Map<string, ProviderData>>;
+    set attributes(value: Map<string, Map<string, ProviderData>>);
+    /**
+     * Store-and-forward information like last sequence number of SnF window
+     */
+    get snf(): Map<string, string>;
+    set snf(value: Map<string, string>);
+    get control(): ProviderControl;
+    /**
+     * Collection of commands for this provider.
+     */
+    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;
+        id: string | null;
+        company: number | null;
+        kind: ProviderType;
+        name: string;
+        notes: string;
+        configuration: number | null;
+        v: number[];
+    };
+    fromJSON(json: any, force?: boolean): boolean;
+    /**
+     * The {@link id} is the key.
+     */
+    getKey(): string;
+    /**
+     * Indicates whether this object is suspended from event processing.
+     */
+    get suspended(): boolean;
+    /**
+     * Timestamp from the action that deleted or suspended this object.
+     */
+    get since(): Date;
+}

package/Providers/ProviderAdvanced.d.ts

@@ -0,0 +1,51 @@
+import { BaseComponent } from "../API/BaseComponent";
+import { IBelongCompany } from "../API/Interfaces/IBelongCompany";
+import { ipv4, ulong } from "../API/Types";
+import { Company } from "../Companies/Company";
+import { ProviderData } from "./ProviderData";
+/**
+ * Device/hardware information reported from the field.
+ */
+export declare class ProviderAdvanced extends BaseComponent implements IBelongCompany {
+    /**
+     * Unique identifier of this device.
+     * {@link Provider.id}
+     */
+    id: string;
+    /**
+     * The company to which this device belongs.
+     * {@link Company.id}
+     */
+    companyId: ulong;
+    /**
+     * The company to which this device belongs.
+     * {@link Company.id}
+     */
+    get company(): Company;
+    set company(value: Company);
+    /**
+     * The last IP address of the device.
+     */
+    lastIP: ipv4;
+    /**
+     * Often changing values like latitude, longitude, speed, wiring state, VBus information, etc...
+     */
+    attributes: Map<string, Map<string, ProviderData>>;
+    /**
+     * Store-and-forward information like last sequence number of SnF window
+     */
+    snf: Map<string, string>;
+    toJSON(): {
+        id: string | null;
+        v: number[];
+        company: number;
+        lastIP: string;
+        attributes: object;
+        snf: object;
+    };
+    fromJSON(json: any, force?: boolean): boolean;
+    /**
+     * The {@link id} is the key.
+     */
+    getKey(): string;
+}

package/Providers/ProviderCommand.d.ts

@@ -0,0 +1,36 @@
+import { ISerializable } from "../API/Interfaces/ISerializable";
+import { datetime } from "../API/Types";
+import { ProviderCommandStatus } from "./ProviderCommandStatus";
+/**
+ * Details regarding a provider command
+ */
+export declare class ProviderCommand implements ISerializable {
+    /**
+     *
+     * @param json
+     */
+    static fromJSON(json: any): ProviderCommand;
+    /**
+     * Current status of this command.
+     */
+    status: ProviderCommandStatus;
+    /**
+     * Command message body.
+     */
+    parameters: string[];
+    /**
+     * Date/time stamp of when the command was created.
+     */
+    created: Date;
+    /**
+     * Date/time stamp of when the command was processed.
+     */
+    processed: Date;
+    constructor(status?: ProviderCommandStatus, parameters?: string[], created?: Date | number | datetime, processed?: Date | number | datetime);
+    toJSON(): {
+        status: ProviderCommandStatus;
+        parameters: string[];
+        created: string | null;
+        processed: string | null;
+    };
+}