@trakit/objects 0.0.14 → 0.0.16

package/objects/Hosting/FormFieldType.d.ts

@@ -0,0 +1,127 @@
+/**
+ * The supported types of user interface modules for a {@link FormTemplate}.
+ */
+export declare enum FormFieldType {
+    /**
+     * Any text input.
+     * {@link FormFieldText}
+     */
+    text = "text",
+    /**
+     * A choice of one (or more) values defined.
+     * {@link FormFieldChoice}
+     */
+    choice = "choice",
+    /**
+     * A drop-down or fly-out UI for choosing a single value.
+     * Works better than {@link choice} when there are a lot of values. ie; country or province list.
+     * {@link FormFieldChoice}
+     */
+    dropdown = "dropdown",
+    /**
+     * A check mark to represent a boolean value.
+     * {@link FormFieldBoolean}
+     */
+    checkbox = "checkbox",
+    /**
+     * A toggle box to represent one of two possible values (optionally defined).
+     * {@link FormFieldBoolean}
+     */
+    toggle = "toggle",
+    /**
+     * Numeric (optionally decimal) input.
+     * {@link FormFieldNumeric}
+     */
+    numeric = "numeric",
+    /**
+     * A slider bar to choose a numeric value between a given high and low value.
+     * {@link FormFieldNumeric}
+     */
+    range = "range",
+    /**
+     * A numeric value of distance (for easy conversion between {@link SystemsOfUnits.metric} and {@link SystemsOfUnits.standard}).
+     * {@link FormFieldNumeric}
+     */
+    distance = "distance",
+    /**
+     * A numeric value of area (for easy conversion between {@link SystemsOfUnits.metric} and {@link SystemsOfUnits.standard}).
+     * {@link FormFieldNumeric}
+     */
+    area = "area",
+    /**
+     * A numeric value of temperature (for easy conversion between {@link SystemsOfUnits.metric} and {@link SystemsOfUnits.standard}).
+     * {@link FormFieldNumeric}
+     */
+    temperature = "temperature",
+    /**
+     * A numeric value of weight (for easy conversion between {@link SystemsOfUnits.metric} and {@link SystemsOfUnits.standard}).
+     * {@link FormFieldNumeric}
+     */
+    weight = "weight",
+    /**
+     * A numeric value of volume (for easy conversion between {@link SystemsOfUnits.metric} and {@link SystemsOfUnits.standard}).
+     * {@link FormFieldNumeric}
+     */
+    volume = "volume",
+    /**
+     * A numeric value of pressure (for easy conversion between {@link SystemsOfUnits.metric} and {@link SystemsOfUnits.standard}).
+     * {@link FormFieldNumeric}
+     */
+    pressure = "pressure",
+    /**
+     * A numeric value of speed (for easy conversion between {@link SystemsOfUnits.metric} and {@link SystemsOfUnits.standard}).
+     * {@link FormFieldNumeric}
+     */
+    speed = "speed",
+    /**
+     * A numeric value of fuel economy (for easy conversion between {@link SystemsOfUnits.metric} and {@link SystemsOfUnits.standard}).
+     * {@link FormFieldNumeric}
+     */
+    fuelEconomy = "fuelEconomy",
+    /**
+     * A numeric value representing an amount of money.
+     * {@link FormFieldNumeric}
+     */
+    currency = "currency",
+    /**
+     * A date and time picker.
+     * {@link FormFieldDate}
+     */
+    datetime = "datetime",
+    /**
+     * A calendar/date picker.
+     * {@link FormFieldDate}
+     */
+    date = "date",
+    /**
+     * A clock/time picker.
+     * {@link FormFieldTime}
+     */
+    time = "time",
+    /**
+     * A duration picker.
+     * Different than {@link time} because a duration can be negative, or longer than 24 hours.
+     * {@link FormFieldTime}
+     */
+    duration = "duration",
+    /**
+     * Area to capture a signature bitmap.
+     * {@link FormFieldSignature}
+     */
+    signature = "signature",
+    /**
+     * A browser of {@link Picture}s that can be attached.
+     * {@link FormFieldAttachments}
+     */
+    pictures = "pictures",
+    /**
+     * A browser of {@link Document}s that can be attached.
+     * {@link FormFieldAttachments}
+     */
+    files = "files",
+    /**
+     * A list of {@link Timezone}s.
+     * {@link FormFieldTimezone}
+     */
+    timezone = "timezone"
+}

package/objects/Hosting/FormResult.d.ts

@@ -0,0 +1,95 @@
+import { BaseComponent } from "../API/BaseComponent";
+import { LatLng } from "../API/Geography/LatLng";
+import { IBelongAsset } from "../API/Interfaces/IBelongAsset";
+import { IBelongCompany } from "../API/Interfaces/IBelongCompany";
+import { IIdUlong } from "../API/Interfaces/IIdUlong";
+import { ILabelled } from "../API/Interfaces/ILabelled";
+import { INamed } from "../API/Interfaces/INamed";
+import { codified, ulong, JsonObject } from "../API/Types";
+import { Asset } from "../Assets/Asset";
+import { Company } from "../Companies/Company";
+import { FormTemplate } from "./FormTemplate";
+/**
+ * A completed form submitted by a {@link User} or {@link Asset}.
+ */
+export declare class FormResult extends BaseComponent implements IIdUlong, INamed, IBelongCompany, IBelongAsset, ILabelled {
+    /**
+     * Unique identifier of this form.
+     */
+    id: ulong;
+    /**
+     * The {@link Company} to which this form belongs.
+     * {@link Company.id}
+     */
+    companyId: ulong;
+    /**
+     * The {@link Company} to which this form belongs.
+     */
+    get company(): Company;
+    /**
+     * The {@link FormTemplate} to which this form belongs.
+     */
+    templateId: ulong;
+    /**
+     * The {@link FormTemplate} to which this form belongs.
+     */
+    get template(): FormTemplate;
+    set template(value: FormTemplate);
+    /**
+     * The {@link Asset} to which this form belongs.
+     * {@link Asset.id}
+     */
+    assetId: ulong;
+    /**
+     * The {@link Asset} to which this form belongs.
+     */
+    get asset(): Asset;
+    /**
+     * Name of this form.
+     */
+    name: string;
+    /**
+     * Notes about this form.
+     */
+    notes: string;
+    /**
+     * Codified label names used to relate forms to {@link Asset}s.
+     */
+    labels: codified[];
+    /**
+     * All the values for fillable fields by index.
+     */
+    fields: Map<ulong, string>;
+    /**
+     * A timestamp from when this form was completed by a {@link User} or {@link Asset}.
+     */
+    completed: Date;
+    /**
+     * The coordinates of the {@link User} or {@link Asset} from when the form was completed.
+     */
+    latlng: LatLng | null;
+    /**
+     * Clocked-in driver name who made the update.
+     * Null if not clocked-in, or no changes have been made.
+     */
+    driver: string;
+    /**
+     * The {@link id} is the key.
+     */
+    getKey(): number;
+    toJSON(): {
+        id: number;
+        company: number;
+        v: number[];
+        template: number | null;
+        asset: number | null;
+        name: string;
+        notes: string;
+        labels: string[];
+        fields: JsonObject;
+        completed: string | null;
+        latlng: import("../API/Geography/Interfaces").ILatLng | null;
+        driver: string | null;
+    };
+    fromJSON(json: JsonObject, force?: boolean): boolean;
+}

package/objects/Hosting/FormTemplate.d.ts

@@ -0,0 +1,80 @@
+import { BaseComponent } from "../API/BaseComponent";
+import { IBelongCompany } from "../API/Interfaces/IBelongCompany";
+import { IIdUlong } from "../API/Interfaces/IIdUlong";
+import { ILabelled } from "../API/Interfaces/ILabelled";
+import { INamed } from "../API/Interfaces/INamed";
+import { IVisual } from "../API/Interfaces/IVisual";
+import { codified, colour, ulong, JsonObject } from "../API/Types";
+import { Company } from "../Companies/Company";
+import { FormFieldAttachments } from './Fields/FormFieldAttachments';
+import { FormFieldBoolean } from './Fields/FormFieldBoolean';
+import { FormFieldChoice } from './Fields/FormFieldChoice';
+import { FormFieldDate } from './Fields/FormFieldDate';
+import { FormFieldNumeric } from './Fields/FormFieldNumeric';
+import { FormFieldSignature } from './Fields/FormFieldSignature';
+import { FormFieldText } from './Fields/FormFieldText';
+import { FormFieldTime } from './Fields/FormFieldTime';
+import { FormFieldTimezone } from './Fields/FormFieldTimezone';
+/**
+ * The full definition of a form that needs to be filled out.
+ */
+export declare class FormTemplate extends BaseComponent implements IIdUlong, INamed, IBelongCompany, ILabelled, IVisual {
+    /**
+     * Unique identifier of this form.
+     */
+    id: ulong;
+    /**
+     * The {@link Company} to which this form belongs.
+     * {@link Company.id}
+     */
+    companyId: ulong;
+    /**
+     * The {@link Company} to which this form belongs.
+     */
+    get company(): Company;
+    /**
+     * Name of this form.
+     */
+    name: string;
+    /**
+     * Notes about this form.
+     */
+    notes: string;
+    /**
+     * Codified label names used to relate forms to {@link Asset}s.
+     */
+    labels: codified[];
+    /**
+     * The fill/background colour of the icon.
+     */
+    fill: colour;
+    /**
+     * Outline and graphic colour.
+     */
+    stroke: colour;
+    /**
+     * The name of the symbol for this template.
+     */
+    graphic: codified;
+    /**
+     * All the user fillable fields by name.
+     */
+    fields: (FormFieldText | FormFieldChoice | FormFieldBoolean | FormFieldNumeric | FormFieldDate | FormFieldTime | FormFieldSignature | FormFieldAttachments | FormFieldTimezone)[];
+    /**
+     * The {@link id} is the key.
+     */
+    getKey(): number;
+    toJSON(): {
+        id: number | null;
+        company: number | null;
+        v: number[];
+        name: string;
+        notes: string;
+        labels: string[];
+        fields: any[];
+        fill: string;
+        stroke: string;
+        graphic: string;
+    };
+    fromJSON(json: JsonObject, force?: boolean): boolean;
+}

package/objects/Images/Dashcam.d.ts

@@ -0,0 +1,63 @@
+import { TimeSpan } from "../API/TimeSpan";
+import { guid, JsonObject, single } from "../API/Types";
+import { DashcamBase } from "./DashcamBase";
+import { DashcamMediaType } from "./DashcamMediaType";
+/**
+ * An image or video received from a dashcam-enabled provider or asset.
+ */
+export declare class Dashcam extends DashcamBase {
+    /**
+     * Unique identifier of this resource.
+     */
+    guid: guid;
+    /**
+     * The type of data being stored.
+     */
+    kind: DashcamMediaType;
+    /**
+     * For {@link DashcamMediaType.video} media files, this indicates the frames-per-second.
+     */
+    fps: single;
+    /**
+     * Timestamp of when this resource started.
+     * For {@link DashcamMediaType.image} media files, the start and end are the same.
+     */
+    start: Date;
+    /**
+     * Timestamp of when this resource ended.
+     * For {@link DashcamMediaType.image} media files, the start and end are the same.
+     */
+    end: Date;
+    /**
+     * For {@link DashcamMediaType.video} media files, the duration of the video clip.
+     */
+    get duration(): TimeSpan;
+    /**
+     * The reason why we're saving this image/video. Or the event name that triggered it.
+     */
+    eventName: string;
+    fromJSON(json: JsonObject, force?: boolean): boolean;
+    toJSON(): {
+        guid: string;
+        kind: DashcamMediaType;
+        fps: number | null;
+        start: string | null;
+        end: string | null;
+        eventName: string;
+        bytes: number | null;
+        size: import("../API/Geometry/Interfaces").ISize;
+        provider: string;
+        company: number | null;
+        asset: number | null;
+        camera: number | null;
+        latitude: number | null;
+        longitude: number | null;
+        speed: number | null;
+        heading: number | null;
+        altitude: number | null;
+    };
+    /**
+     * The {@link guid} is the key.
+     */
+    getKey(): string;
+}

package/objects/Images/DashcamBase.d.ts

@@ -0,0 +1,97 @@
+import { ISize } from "../API/Geometry/Interfaces";
+import { Size } from "../API/Geometry/Size";
+import { IDeserializable } from "../API/Interfaces/IDeserializable";
+import { IFileSize } from "../API/Interfaces/IFileSize";
+import { IRequestable } from "../API/Interfaces/IRequestable";
+import { ISerializable } from "../API/Interfaces/ISerializable";
+import { byte, double, JsonObject, ulong } from "../API/Types";
+import { Asset } from "../Assets/Asset";
+import { Company } from "../Companies/Company";
+import { Provider } from "../Providers/Provider";
+/**
+ * A base class for Dashcam meta-data.
+ */
+export declare abstract class DashcamBase implements IRequestable, IFileSize, ISerializable, IDeserializable {
+    /**
+     * Number bytes in the dashcam media file.
+     */
+    bytes: ulong;
+    /**
+     * Resolution defined in pixels.
+     */
+    size: Size;
+    /**
+     * Unique identifier of the provider that sent the data.
+     * {@link Provider.id}
+     */
+    providerId: string;
+    /**
+     * The {@link Provider} that sent the data.
+     */
+    get provider(): Provider;
+    /**
+     * Unique identifier of the company of the provider.
+     * {@link Company.id}
+     */
+    companyId: ulong;
+    /**
+     * Unique identifier of the {@link Company} of the provider.
+     */
+    get company(): Company;
+    /**
+     * Unique identifier of the asset tied to the provider at the time.
+     * {@link Asset.id}
+     */
+    assetId: ulong;
+    /**
+     * Unique identifier of the {@link Asset} tied to the provider at the time.
+     */
+    get asset(): Asset;
+    /**
+     * Number assigned to the camera that took the image/video.
+     */
+    camera: byte;
+    /**
+     * Latitude of the start of the resource.
+     */
+    latitude: double;
+    /**
+     * Longitude of the start of the resource.
+     */
+    longitude: double;
+    /**
+     * Speed of the start of the resource.
+     */
+    speed: double;
+    /**
+     * Heading of the start of the resource.
+     */
+    heading: double;
+    /**
+     * Altitude of the start of the resource.
+     */
+    altitude: double;
+    constructor(json?: JsonObject);
+    fromJSON(json: JsonObject, force?: boolean): boolean;
+    /**
+     *
+     */
+    toJSON(): {
+        bytes: number | null;
+        size: ISize;
+        provider: string;
+        company: number | null;
+        asset: number | null;
+        camera: number | null;
+        latitude: number | null;
+        longitude: number | null;
+        speed: number | null;
+        heading: number | null;
+        altitude: number | null;
+    };
+    /**
+     * For dashcams, this is either a unique identifier, or a combination of the {@link assetId}, {@link providerId}, and {@link camera} values.
+     * @returns A string unique for this type of object.
+     */
+    abstract getKey(): string;
+}

package/objects/Images/DashcamLive.d.ts

@@ -0,0 +1,36 @@
+import { JsonObject } from "../API/Types";
+import { DashcamBase } from "./DashcamBase";
+import { DashcamMediaType } from "./DashcamMediaType";
+/**
+ * A live snapshot a dashcam-enabled provider or asset.
+ */
+export declare class DashcamLive extends DashcamBase {
+    /**
+     * The type of data being stored.
+     */
+    readonly kind = DashcamMediaType.image;
+    /**
+     * Timestamp of this live camera image.
+     */
+    dts: Date;
+    fromJSON(json: JsonObject, force?: boolean): boolean;
+    toJSON(): {
+        kind: DashcamMediaType;
+        dts: string | null;
+        bytes: number | null;
+        size: import("../API/Geometry/Interfaces").ISize;
+        provider: string;
+        company: number | null;
+        asset: number | null;
+        camera: number | null;
+        latitude: number | null;
+        longitude: number | null;
+        speed: number | null;
+        heading: number | null;
+        altitude: number | null;
+    };
+    /**
+     * A combination of the asset, provider, and camera number.
+     */
+    getKey(): string;
+}

package/objects/Images/DashcamMediaType.d.ts

@@ -0,0 +1,17 @@
+/**
+ * The type of dashcam data being stored.
+ */
+export declare enum DashcamMediaType {
+    /**
+     * Unknown or other.
+     */
+    unknown = "unknown",
+    /**
+     * Image
+     */
+    image = "image",
+    /**
+     * Video
+     */
+    video = "video"
+}

package/objects/Images/Icon.d.ts

@@ -0,0 +1,66 @@
+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 { JsonObject, ulong } from "../API/Types";
+import { Company } from "../Companies/Company";
+import { IconGlyph } from "./IconGlyph";
+import { IconLabel } from "./IconLabel";
+/**
+ * A visual representation of a thing on a map or in a list.
+ */
+export declare class Icon extends BaseComponent implements IIdUlong, INamed, IBelongCompany, IGlobal {
+    /**
+     * Unique identifier of this icon.
+     */
+    id: ulong;
+    /**
+     * The company to which this icon belongs.
+     * {@link Company.id}
+     */
+    companyId: ulong;
+    /**
+     * The {@link Company} to which this icon belongs.
+     */
+    get company(): Company;
+    /**
+     * A noun to describe the type of thing represented.  Like Truck, Car, Trailer, Hot-Air Balloon, etc...
+     */
+    category: string;
+    /**
+     * A specific adjective to describe the thing.  Like Blue, Red, Empty, Full, etc...
+     */
+    name: string;
+    /**
+     * Notes.
+     */
+    notes: string;
+    /**
+     * Indicates whether this icon is available to child companies.
+     */
+    global: boolean;
+    /**
+     * A list of things that this icon can be used to represent.  Like asset, place, user, etc...
+     */
+    usage: string[];
+    /**
+     * Definition for the name bubble above the icon on a map.
+     */
+    label: IconLabel;
+    /**
+     * Where the notification will appear for a mapped icon.
+     * Such as the number of dispatches an asset is working on, or the number of dispatches at a place.
+     */
+    badge: IconLabel;
+    /**
+     * The images used to show the detail of this icon.
+     */
+    glyphs: IconGlyph[];
+    toJSON(): JsonObject;
+    fromJSON(json: JsonObject, force?: boolean): boolean;
+    /**
+     * The {@link id} is the key.
+     */
+    getKey(): number;
+}

package/objects/Images/IconGlyph.d.ts

@@ -0,0 +1,47 @@
+import { IPoint, ISize } from "../API/Geometry/Interfaces";
+import { Point } from "../API/Geometry/Point";
+import { Size } from "../API/Geometry/Size";
+import { ISerializable } from "../API/Interfaces/ISerializable";
+import { codified, ushort, JsonObject } from "../API/Types";
+import { IconLayer } from "./IconLayer";
+/**
+ * The image source and defined status tags which need to be applied to an asset in order to show the image.
+ */
+export declare class IconGlyph implements ISerializable {
+    /**
+     *
+     * @param json
+     */
+    static fromJSON(json: JsonObject): IconGlyph;
+    /**
+     * A list of codified status tag names.  Any of the tags must be applied to the asset for the image to appear.
+     */
+    tags: codified[];
+    /**
+     * Path to the image.
+     */
+    src: string;
+    /**
+     * Size of the glyph in pixels.
+     */
+    size: Size;
+    /**
+     * The offset from the lat/long in pixels.
+     */
+    anchor: Point;
+    /**
+     * The layer on which this glyph is displayed.
+     */
+    layer: IconLayer;
+    /**
+     * The z-order of this glyph compared to other glyphs on the same layer.
+     */
+    zIndex: ushort;
+    /**
+     * Indicates that this glyph rotate based on GPS bearing.
+     */
+    rotates: boolean;
+    constructor(tags?: codified[], src?: string, size?: ISize | JsonObject, anchor?: IPoint | JsonObject, layer?: IconLayer, zIndex?: ushort, rotates?: boolean);
+    toJSON(): JsonObject;
+    isEqual(other: IconGlyph): boolean;
+}

package/objects/Images/IconLabel.d.ts

@@ -0,0 +1,29 @@
+import { IPoint } from "../API/Geometry/Interfaces";
+import { Point } from "../API/Geometry/Point";
+import { ISerializable } from "../API/Interfaces/ISerializable";
+import { colour, JsonObject } from "../API/Types";
+/**
+ * Definition for the name bubble above the icon on a map.
+ */
+export declare class IconLabel implements ISerializable {
+    /**
+     *
+     * @param json
+     */
+    static fromJSON(json: JsonObject): IconLabel;
+    /**
+     * The offset from the lat/long in pixels.
+     */
+    anchor: Point;
+    /**
+     * Determines which corner of the label is attached to the anchor.
+     */
+    align: string;
+    /**
+     * Background colour of the label.
+     */
+    colour: colour;
+    constructor(anchor?: IPoint | JsonObject, align?: string, colour?: colour);
+    toJSON(): JsonObject;
+    isEqual(other: IconLabel): boolean;
+}

package/objects/Images/IconLayer.d.ts

@@ -0,0 +1,33 @@
+/**
+ * The layers of the map used to visualize the icon.
+ */
+export declare enum IconLayer {
+    /**
+     * An SVG only layer just above the roads used for solid Places and accuracy radius fill.
+     */
+    fills = "fills",
+    /**
+     * An HTML only layer intended for use by an icon's drop-shadow.
+     */
+    shadows = "shadows",
+    /**
+     * An SVG only layer intended for use by shape and accuracy radius outlines.
+     */
+    outlines = "outlines",
+    /**
+     * An HTML only layer intended for use by an icon's main images.
+     */
+    markers = "markers",
+    /**
+     * An HTML only layer intended for use by an icon's label.
+     */
+    labels = "labels",
+    /**
+     * An SVG only layer for special drawing controls.  Icons should not use this layer.
+     */
+    drawings = "drawings",
+    /**
+     * An HTML only layer for special drawing controls.  Icons should not use this layer.
+     */
+    edits = "edits"
+}