@trakit/objects 0.0.14 → 0.0.16

package/objects/Places/Place.d.ts

@@ -0,0 +1,114 @@
+import { BaseComponent } from "../API/BaseComponent";
+import { LatLng } from "../API/Geography/LatLng";
+import { IBelongCompany } from "../API/Interfaces/IBelongCompany";
+import { IIconic } from "../API/Interfaces/IIconic";
+import { IIdUlong } from "../API/Interfaces/IIdUlong";
+import { ILabelled } from "../API/Interfaces/ILabelled";
+import { INamed } from "../API/Interfaces/INamed";
+import { IPictured } from "../API/Interfaces/IPictured";
+import { JsonObject, codified, colour, double, ulong } from "../API/Types";
+import { Company } from "../Companies/Company";
+import { Icon } from "../Images/Icon";
+import { Picture } from "../Images/Picture";
+import { PlaceType } from "./PlaceType";
+/**
+ * A POI (point-of-interest) saved to the system to help determine an asset's real-world position.
+ */
+export declare class Place extends BaseComponent implements IIdUlong, INamed, IIconic, IBelongCompany, ILabelled, IPictured {
+    /**
+     * Unique identifier of this POI.
+     */
+    id: ulong;
+    /**
+     * The company to which this POI belongs.
+     * {@link Company.id}
+     */
+    companyId: ulong;
+    /**
+     * The {@link Company} to which this POI belongs.
+     */
+    get company(): Company;
+    /**
+     * The kind of geography represented by this POI.
+     */
+    kind: PlaceType;
+    /**
+     * POI's common name instead of street address.
+     */
+    name: string;
+    /**
+     * Full street address including province/state, country, and postal/zip code.
+     */
+    address: string;
+    /**
+     * The icon used to display this POI in lists and on the map.
+     * {@link Icon.id}
+     */
+    iconId: ulong;
+    /**
+     * The {@link Icon} used to display this POI in lists and on the map.
+     */
+    get icon(): Icon;
+    set icon(value: Icon);
+    /**
+     * Notes!
+     */
+    notes: string;
+    /**
+     * The codified names of labels
+     */
+    labels: codified[];
+    /**
+     * The fill colour given to this place for easy visual identification on the map (given in 24bit hex; #RRGGBB)
+     */
+    colour: colour;
+    /**
+     * {@link Picture.id}s of this POI.
+     */
+    pictureIds: ulong[];
+    /**
+     * {@link Picture}s of this POI.
+     */
+    get pictures(): Picture[];
+    set pictures(values: Picture[]);
+    /**
+     * A custom field used to refer to an external system.
+     */
+    reference: string;
+    /**
+     * A central point of the shape.
+     * This is the exact centre of a {@link PlaceType.radial} and {@link PlaceType.point} shaped places, and the location of the pin on the map for all types.
+     * When routing, {@link PlaceType.polygon} and {@link PlaceType.rectangle} shapes use the anchor as the location within the place for deliveries.
+     */
+    anchor: LatLng | null;
+    /**
+     * This member is only present for {@link PlaceType.radial} shapes, and is the radius in meters from the centre anchor.
+     */
+    radius: double;
+    /**
+     * A list of points forming a non-self-intersecting polygon.
+     */
+    points: LatLng[] | null;
+    toJSON(): {
+        id: number | null;
+        v: number[];
+        company: number;
+        icon: number;
+        name: string;
+        notes: string;
+        address: string;
+        kind: PlaceType;
+        labels: string[];
+        colour: string;
+        pictures: number[];
+        reference: string;
+        anchor: import("../API/Geography/Interfaces").ILatLng | null;
+        radius: number | null;
+        shape: string | null;
+    };
+    fromJSON(json: JsonObject, force?: boolean): boolean;
+    /**
+     * The {@link id} is the key.
+     */
+    getKey(): number;
+}

package/objects/Places/PlaceType.d.ts

@@ -0,0 +1,25 @@
+/**
+ * The types of geography the system supports
+ */
+export declare enum PlaceType {
+    /**
+     * A lat/long coordinate pair.
+     * Places of this type do not contain the {@link Vorgon.PlaceGeneral.radius} or {@link Vorgon.PlaceGeneral.shape} keys.
+     */
+    point = "point",
+    /**
+     * Defined as a radius around a lat/long pair used to create a circular boundary.
+     * Places of this type do not contain the {@link Vorgon.PlaceGeneral.shape} key.
+     */
+    radial = "radial",
+    /**
+     * The {@link Vorgon.PlaceGeneral.shape} is an array of lat/long coordinates used to create a boundary.
+     * Places of this type do not contain the {@link Vorgon.PlaceGeneral.radius} key.
+     */
+    polygon = "polygon",
+    /**
+     * The {@link Vorgon.PlaceGeneral.shape} is an array of two lat/long coordinates defined as north-east and south-west corners.
+     * Places of this type do not contain the {@link Vorgon.PlaceGeneral.radius} key.
+     */
+    rectangle = "rectangle"
+}

package/objects/Providers/Config/ProviderConfig.d.ts

@@ -0,0 +1,70 @@
+import { BaseComponent } from "../../API/BaseComponent";
+import { IBelongCompany } from "../../API/Interfaces/IBelongCompany";
+import { IIdUlong } from "../../API/Interfaces/IIdUlong";
+import { INamed } from "../../API/Interfaces/INamed";
+import { SearchPattern } from "../../API/SearchPattern";
+import { JsonObject, ulong } from "../../API/Types";
+import { Company } from "../../Companies/Company";
+import { ProviderScript } from "./ProviderScript";
+/**
+ * The configured script loaded onto the provider over-the-air to control it's reporting schedule and behaviour.
+ */
+export declare class ProviderConfig 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 {@link Company} to which this configuration belongs.
+     */
+    get company(): Company;
+    /**
+     * The script which this configuration implements.
+     * {@link ProviderScript.id}
+     */
+    scriptId: ulong;
+    /**
+     * The {@link ProviderScript} which this configuration implements.
+     */
+    get script(): ProviderScript;
+    set script(value: ProviderScript);
+    /**
+     * The nickname given to this configuration
+     */
+    name: string;
+    /**
+     * Simple details about how the providers are expected to behave.
+     */
+    notes: string;
+    /**
+     * The list of defined variable name/value pairs that the script requires.
+     */
+    parameters: Map<string, string>;
+    /**
+     * A search pattern used to filter which Places' geometry are used as geofences.
+     * Use null to disable.
+     * Use "*" to match all the Places the Provider's Asset can match.
+     * Or use "#123456" or "label:term" like other Place search patterns.
+     */
+    geofences: SearchPattern[] | null;
+    toJSON(): {
+        id: number | null;
+        v: number[];
+        company: number | null;
+        script: number | null;
+        name: string;
+        notes: string;
+        parameters: JsonObject;
+        geofences: string | null;
+    };
+    fromJSON(json: JsonObject, force?: boolean): boolean;
+    /**
+     * The {@link id} is the key.
+     */
+    getKey(): number;
+}

package/objects/Providers/Config/ProviderRegistration.d.ts

@@ -0,0 +1,119 @@
+import { Base } from "../../API/Base";
+import { IBelongAsset } from "../../API/Interfaces/IBelongAsset";
+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, JsonObject } from "../../API/Types";
+import { User } from "../../Accounts/User";
+import { Asset } from "../../Assets/Asset";
+import { Company } from "../../Companies/Company";
+import { ProviderConfiguration } from "../Configuration/ProviderConfiguration";
+import { ProviderType } from "../ProviderType";
+import { ProviderConfig } from "./ProviderConfig";
+/**
+ * The temporary reference to a device whose ownership is pending.
+ */
+export declare class ProviderRegistration extends Base implements IRequestable, INamed, IBelongCompany, IBelongAsset, ISerializable {
+    /**
+     * A unique six digit code.
+     */
+    code: string;
+    /**
+     * The company to which the device will belong.
+     * {@link Company.id}
+     */
+    companyId: ulong;
+    /**
+     * The {@link Company} to which the device will belong.
+     */
+    get company(): Company;
+    /**
+     * A nickname given to the device once it has been provisioned.
+     */
+    name: string;
+    /**
+     * Notes!
+     */
+    notes: string;
+    /**
+     * The password programmed on the device used to ensure the system is the only client authorized to make changes.
+     */
+    password: string;
+    /**
+     * The unique identifier the user who generated this registration.
+     * {@link User.login}
+     */
+    userLogin: email;
+    /**
+     * The unique identifier the user who generated this registration.
+     * {@link User.login}
+     */
+    get user(): User;
+    /**
+     * The predefined configuration this device will use.
+     * {@link ProviderConfig.id}
+     * {@link ProviderConfiguration.id}
+     */
+    configId: ulong;
+    /**
+     * The predefined {@link ProviderConfig} (or {@link ProviderConfiguration}) this device will use.
+     */
+    get config(): ProviderConfig | ProviderConfiguration;
+    /**
+     * The kind of protocol this device supports.
+     */
+    kind: ProviderType;
+    /**
+     * Date/time stamp of when this registration began.
+     */
+    since: Date;
+    /**
+     * Date/time stamp of when this registration ended successfully.
+     */
+    completed: Date;
+    /**
+     * The expiry date for this registration.
+     */
+    expires: Date;
+    /**
+     * The unique identifier of the device that completed this registration.
+     * {@link Provider.id}
+     */
+    identifier: string;
+    /**
+     * The Asset for which this device will provide data.
+     * {@link Asset.id}
+     */
+    assetId: ulong;
+    /**
+     * The {@link Asset} for which this device will provide data.
+     */
+    get asset(): Asset;
+    /**
+     * The phone number of the device being provisioned.
+     * This is set by the user for long-term registrations, or by the client during serial port setup.
+     */
+    phoneNumber: phone;
+    toJSON(): {
+        code: string | null;
+        company: number | null;
+        name: string;
+        notes: string;
+        password: string;
+        user: string;
+        config: number | null;
+        kind: ProviderType;
+        since: string | null;
+        completed: string | null;
+        expires: string | null;
+        identifier: string;
+        asset: number | null;
+        phoneNumber: number | null;
+    };
+    fromJSON(json: JsonObject, force?: boolean): boolean;
+    /**
+     * The {@link code} is the key.
+     */
+    getKey(): string;
+}

package/objects/Providers/Config/ProviderScript.d.ts

@@ -0,0 +1,86 @@
+import { BaseComponent } from "../../API/BaseComponent";
+import { IBelongCompany } from "../../API/Interfaces/IBelongCompany";
+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 { JsonObject, codified, colour, ulong } from "../../API/Types";
+import { Company } from "../../Companies/Company";
+import { ProviderType } from "../ProviderType";
+import { ProviderScriptBlock } from "./ProviderScriptBlock";
+import { ProviderScriptParameter } from "./ProviderScriptParameter";
+/**
+ * This class describes a type of logic applied to a provider.
+ * A script will generate a file which is loaded onto a provider in the field.
+ */
+export declare class ProviderScript extends BaseComponent implements IIdUlong, INamed, IBelongCompany, IGlobal, IVisual {
+    /**
+     * Unique identifier of this configuration.
+     */
+    id: ulong;
+    /**
+     * The company to which this configuration belongs.
+     * {@link Company.id}
+     */
+    companyId: ulong;
+    /**
+     * The {@link Company} to which this configuration belongs.
+     */
+    get company(): Company;
+    /**
+     * The nickname given to this configuration
+     */
+    name: string;
+    /**
+     * Simple details about how the providers are expected to behave.
+     */
+    notes: string;
+    /**
+     * The fill/background colour of the icon.
+     */
+    fill: colour;
+    /**
+     * Outline and graphic colour.
+     */
+    stroke: colour;
+    /**
+     * The name of the symbol for this script.
+     */
+    graphic: codified;
+    /**
+     * Indicates whether this script is available to child companies.
+     */
+    global: boolean;
+    /**
+     * The type of provider for which this script can be used.
+     * Limiting to a specific model from a manufacturer is accomplished through the block conditions.
+     */
+    kind: ProviderType;
+    /**
+     * Blocks of file data which are (optionally) included in the script data file.
+     */
+    blocks: ProviderScriptBlock[];
+    /**
+     * Parameter definitions for this script, including type-hints and default values.
+     */
+    parameters: Map<string, ProviderScriptParameter>;
+    toJSON(): {
+        id: number | null;
+        v: number[];
+        company: number;
+        name: string;
+        notes: string;
+        fill: string;
+        stroke: string;
+        graphic: string;
+        global: boolean;
+        kind: ProviderType;
+        blocks: any[];
+        parameters: JsonObject;
+    };
+    fromJSON(json: JsonObject, force?: boolean): boolean;
+    /**
+     * The {@link id} is the key.
+     */
+    getKey(): number;
+}

package/objects/Providers/Config/ProviderScriptBlock.d.ts

@@ -0,0 +1,41 @@
+import { ISerializable } from "../../API/Interfaces/ISerializable";
+import { JsonObject } from "../../API/Types";
+/**
+ * A chunk of script and variables used to assemble a working ProviderScript.
+ */
+export declare class ProviderScriptBlock implements ISerializable {
+    /**
+     *
+     * @param json
+     * @returns
+     */
+    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.
+     */
+    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/objects/Providers/Config/ProviderScriptParameter.d.ts

@@ -0,0 +1,49 @@
+import { ISerializable } from "../../API/Interfaces/ISerializable";
+import { uint, JsonObject } 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: JsonObject): 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/objects/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/objects/Providers/Configuration/ProviderConfiguration.d.ts

@@ -0,0 +1,66 @@
+import { BaseComponent } from "../../API/BaseComponent";
+import { IBelongCompany } from "../../API/Interfaces/IBelongCompany";
+import { IIdUlong } from "../../API/Interfaces/IIdUlong";
+import { INamed } from "../../API/Interfaces/INamed";
+import { JsonObject, 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 {@link Company} to which this configuration belongs.
+     */
+    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 {@link ProviderConfigurationType} which this configuration implements.
+     */
+    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: JsonObject;
+        geofences: number[];
+    };
+    fromJSON(json: JsonObject, force?: boolean): boolean;
+    /**
+     * The {@link id} is the key.
+     */
+    getKey(): number;
+}

package/objects/Providers/Configuration/ProviderConfigurationNode.d.ts

@@ -0,0 +1,66 @@
+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
+ */
+export declare class ProviderConfigurationNode implements ISerializable {
+    /**
+     *
+     * @param json
+     */
+    static nodesFromJSON(json: JsonObject): Map<string, ProviderConfigurationNode>;
+    /**
+     *
+     * @param json
+     */
+    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.
+     */
+    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: JsonObject;
+    };
+}