@trakit/objects 0.0.14 → 0.0.16

package/objects/Dispatch/DispatchTask.d.ts

@@ -0,0 +1,154 @@
+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 { TimeSpan } from "../API/TimeSpan";
+import { JsonObject, ulong } from "../API/Types";
+import { Asset } from "../Assets/Asset";
+import { Company } from "../Companies/Company";
+import { Document } from "../Hosting/Document";
+import { Place } from "../Places/Place";
+import { DispatchTaskStatus } from "./DispatchTaskStatus";
+/**
+ * A task assigned to an asset which represents a coordinate on the map which must be visited.
+ * @deprecated Use DispatchJob instead
+ */
+export declare class DispatchTask extends BaseComponent implements IIdUlong, IBelongCompany, IBelongAsset {
+    /**
+     * Unique identifier of this task.
+     */
+    id: ulong;
+    /**
+     * The company to which this task belongs.
+     * {@link Company.id}
+     */
+    companyId: ulong;
+    /**
+     * The {@link Company} to which this task belongs.
+     */
+    get company(): Company;
+    /**
+     * The asset to which this task belongs.
+     * {@link Asset.id}
+     */
+    assetId: ulong;
+    /**
+     * The {@link Asset} to which this task belongs.
+     */
+    get asset(): Asset;
+    set asset(value: Asset);
+    /**
+     * The name of this task or the work needed to be performed.
+     */
+    name: string;
+    /**
+     * Name/value collections of custom fields used to refer to external systems.
+     */
+    references: Map<string, string>;
+    /**
+     * An optional place which can be used as a template instead of providing lat/long coordinates and a street address.
+     * {@link Place.id}
+     */
+    placeId: ulong;
+    /**
+     * An optional place which can be used as a template instead of providing lat/long coordinates and a street address.
+     * {@link Place.id}
+     */
+    get place(): Place;
+    set place(value: Place);
+    /**
+     * The street address of where the task must be completed.
+     */
+    address: string;
+    /**
+     * The lat/long coordinates of where the task must be completed.
+     */
+    latlng: LatLng;
+    /**
+     * The progress of this task.
+     */
+    status: DispatchTaskStatus;
+    /**
+     * When this task was created.
+     */
+    created: Date;
+    /**
+     * The optional estimated time of arrival for the asset.
+     */
+    eta: Date;
+    /**
+     * The optional expected duration of the work for this task.
+     */
+    duration: TimeSpan;
+    /**
+     * The date/time stamp of when the asset arrived at this task.
+     */
+    arrived: Date;
+    /**
+     * The date/time stamp of when this task was completed.
+     */
+    completed: Date;
+    /**
+     * Instructions (filled out by dispatcher) for the field-employee to help them completed the task.
+     */
+    instructions: string;
+    /**
+     * Indicates whether the task has a signature.
+     */
+    signature: boolean;
+    /**
+     * The name of the person who signed the task's completion.
+     */
+    signatory: string;
+    /**
+     * Notes about the status of the work filled in by field-employee.
+     */
+    notes: string;
+    /**
+     * A list of hosted {@link Document} identifiers attached to this task.
+     */
+    attachmentIds: ulong[];
+    /**
+     * A list of hosted {@link Document} identifiers attached to this task.
+     */
+    get attachments(): Document[];
+    set attachments(value: Document[]);
+    /**
+     * Either the user's login, or provider's identifier that changed this task
+     */
+    updatedBy: string;
+    /**
+     * Timestamp from the last change made to this task
+     */
+    updatedUtc: Date;
+    toJSON(): {
+        id: number | null;
+        company: number | null;
+        asset: number | null;
+        v: number[];
+        name: string;
+        references: JsonObject;
+        place: number | null;
+        address: string;
+        latlng: import("../API/Geography/Interfaces").ILatLng;
+        status: DispatchTaskStatus;
+        created: string | null;
+        eta: string | null;
+        duration: string;
+        arrived: string | null;
+        completed: string | null;
+        instructions: string;
+        signature: boolean;
+        signatory: string;
+        notes: string;
+        attachments: number[];
+        updatedBy: string;
+        updatedUtc: string | null;
+    };
+    fromJSON(json: JsonObject, force?: boolean): boolean;
+    /**
+     * The {@link id} is the key.
+     */
+    getKey(): number;
+}

package/objects/Dispatch/DispatchTaskStatus.d.ts

@@ -0,0 +1,50 @@
+/**
+ * Tasks have a lifetime and each status represents a task's progress through it's life.
+ * @deprecated Use {@link DispatchStepStatus} instead
+ */
+export declare enum DispatchTaskStatus {
+    /**
+     * The task has been created, but not yet assigned to an asset.
+     */
+    created = "created",
+    /**
+     * The task has been given to an asset (and delivered to the asset's primary device).
+     */
+    queued = "queued",
+    /**
+     * The asset is on the way to the task's location next.
+     */
+    onRoute = "onRoute",
+    /**
+     * The asset has arrived at the task's location.
+     */
+    arrived = "arrived",
+    /**
+     * The task is done.
+     */
+    completed = "completed",
+    /**
+     * The task was cancelled by either the asset or a user.
+     */
+    cancelled = "cancelled",
+    /**
+     * An item was picked-up for this task.
+     */
+    pickedUp = "pickedUp",
+    /**
+     * An item was dropped-off for this task.
+     */
+    droppedOff = "droppedOff",
+    /**
+     * The asset is waiting and can't complete the task.
+     */
+    waiting = "waiting",
+    /**
+     * An item associated with this task is damaged.
+     */
+    damaged = "damaged",
+    /**
+     * The task couldn't be completed by the asset.
+     */
+    unsuccessful = "unsuccessful"
+}

package/objects/Hosting/Document.d.ts

@@ -0,0 +1,70 @@
+import { BaseComponent } from "../API/BaseComponent";
+import { IBelongCompany } from "../API/Interfaces/IBelongCompany";
+import { IFileSize } from "../API/Interfaces/IFileSize";
+import { IIdUlong } from "../API/Interfaces/IIdUlong";
+import { INamed } from "../API/Interfaces/INamed";
+import { ulong, JsonObject } from "../API/Types";
+import { Company } from "../Companies/Company";
+/**
+ * A file stored temporarily by the system.
+ */
+export declare class Document extends BaseComponent implements IIdUlong, INamed, IBelongCompany, IFileSize {
+    /**
+     * Unique identifier of this file.
+     */
+    id: ulong;
+    /**
+     * The company to which this file belongs.
+     * {@link Company.id}
+     */
+    companyId: ulong;
+    /**
+     * The {@link Company} to which this file belongs.
+     */
+    get company(): Company;
+    /**
+     * The file name of this file.
+     */
+    name: string;
+    /**
+     * Notes about this file.
+     */
+    notes: string;
+    /**
+     * The URL/path to find this file.
+     */
+    src: string;
+    /**
+     * The file-size on the disk.
+     */
+    bytes: ulong;
+    /**
+     * The MIME type of the file.
+     */
+    mime: string;
+    /**
+     * The date and time this fill will be automatically purged from our system.
+     */
+    expiry: Date;
+    /**
+     * Name/value collections of custom fields used to refer to external systems.
+     */
+    references: Map<string, string>;
+    toJSON(): {
+        id: number | null;
+        v: number[];
+        company: number;
+        name: string;
+        notes: string;
+        src: string;
+        mime: string;
+        bytes: number;
+        expiry: string | null;
+        references: Map<string, any>;
+    };
+    fromJSON(json: JsonObject, force?: boolean): boolean;
+    /**
+     * The {@link id} is the key.
+     */
+    getKey(): number;
+}

package/objects/Hosting/Fields/FormFieldAttachments.d.ts

@@ -0,0 +1,31 @@
+import { byte, nothing, ulong } from '../../API/Types';
+import { FormFieldType } from '../FormFieldType';
+import { FormFieldBase } from './FormFieldBase';
+/**
+ * A control to allow the user to attach {@link Picture}s or {@link Document}s.
+*/
+export declare class FormFieldAttachments extends FormFieldBase {
+    /**
+     * Takes a string as input and returns an array split by comma with trimmed items.
+     * @param values
+     */
+    static split(values: string): string[];
+    /**
+     * These are the attachment types.
+     */
+    protected get supported(): FormFieldType[];
+    /**
+     * Minimum number of {@link Document}s and/or {@link Picture}s that must be attached.
+     */
+    minimum: byte;
+    /**
+     * Maximum number of {@link Document}s and/or {@link Picture}s that must be attached.
+     */
+    maximum: byte;
+    constructor(id?: ulong | nothing, name?: string | nothing, kind?: FormFieldType | nothing, minimum?: byte | nothing, maximum?: byte | nothing, notes?: string | nothing, required?: boolean | nothing, value?: string | nothing, editable?: boolean | nothing);
+    toJSON(): {
+        minimum: number | null;
+        maximum: number | null;
+    };
+    isValid(value: string): boolean;
+}

package/objects/Hosting/Fields/FormFieldBase.d.ts

@@ -0,0 +1,56 @@
+import { IIdUlong } from '../../API/Interfaces/IIdUlong';
+import { INamed } from '../../API/Interfaces/INamed';
+import { ISerializable } from '../../API/Interfaces/ISerializable';
+import { JsonObject, nothing, ulong } from '../../API/Types';
+import { FormFieldType } from '../FormFieldType';
+/**
+ * A base class for the common form field UI members.
+ */
+export declare abstract class FormFieldBase implements IIdUlong, INamed, ISerializable {
+    /**
+     * Instantiates a form field subclass based on the `kind` property in the JSON.
+     * Implementation is in {@link FormFieldBase_fromJSON.ts}
+     * @param json	The JSON to parse.
+     * @returns		An instance of a form field subclass, or null if the JSON is null or does not contain a recognized "kind" property.
+     */
+    static fromJSON: (json: JsonObject) => FormFieldBase;
+    /**
+     * A list of supported {@link FormFieldType}s that this class supports.
+     */
+    protected get supported(): FormFieldType[];
+    /**
+     * The type of interface control that should be presented to the user.
+     */
+    kind: FormFieldType;
+    /**
+     * Identifier for this field.
+     * This value is unique per {@link FormTemplate}, but is not unique system-wide.
+     */
+    id: ulong;
+    /**
+     * Name of the field.
+     */
+    name: string;
+    /**
+     * Notes or special instructions for this control.
+     */
+    notes: string;
+    /**
+     * When true, a valid value must be given for this field.
+     */
+    required: boolean;
+    /**
+     * The default value for the field in the template.
+     */
+    value: string | null;
+    /**
+     * When false, this field's value is treated as read-only.
+     */
+    editable: boolean;
+    constructor(id?: ulong | nothing, name?: string | nothing, kind?: FormFieldType | nothing, notes?: string | nothing, required?: boolean | nothing, value?: string | nothing, editable?: boolean | nothing);
+    toJSON(): JsonObject;
+    /**
+     * Returns true if the value can be parsed by the field type.
+     */
+    abstract isValid(value: string): boolean;
+}

package/objects/Hosting/Fields/FormFieldBase_fromJSON.d.ts

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

package/objects/Hosting/Fields/FormFieldBoolean.d.ts

@@ -0,0 +1,38 @@
+import { nothing, ulong } from "../../API/Types";
+import { FormFieldType } from "../FormFieldType";
+import { FormFieldBase } from "./FormFieldBase";
+/**
+ * A true/false (or either-or) input control.
+ * @tutorial
+ * For choices, the field definition will be an array of three values.
+ * The first value is the "true", second is the "false", and third is "indeterminate".
+ * For example:
+ * - "true", "false", ""
+ * - "on", "off", "unknown"
+ * - "yes", "no", "maybe"
+ */
+export declare class FormFieldBoolean extends FormFieldBase {
+    /**
+     * If no choices are given, then these choices are used.
+     */
+    static readonly DEFAULT_CHOICES: [string, string, string];
+    /**
+     * Returns an array of 3 strings representing the checked, unchecked, and indeterminate values.
+     * @param choices
+     */
+    static normalize(choices?: (string | nothing)[] | nothing): [string, string, string];
+    /**
+     * These are the boolean control types.
+     */
+    protected get supported(): FormFieldType[];
+    /**
+     * These three values are the values of the choices presented.
+     * The first value is the "checked" value, second is the "unchecked" value, and third is "indeterminate" value.
+     */
+    choices: [string, string, string];
+    constructor(id?: ulong | nothing, name?: string | nothing, kind?: FormFieldType | nothing, choices?: (string | nothing)[] | nothing, notes?: string | nothing, required?: boolean | nothing, value?: string | nothing, editable?: boolean | nothing);
+    toJSON(): {
+        choices: string[];
+    };
+    isValid(value: string): boolean;
+}

package/objects/Hosting/Fields/FormFieldChoice.d.ts

@@ -0,0 +1,46 @@
+import { byte, nothing, ulong } from "../../API/Types";
+import { FormFieldType } from "../FormFieldType";
+import { FormFieldBase } from "./FormFieldBase";
+/**
+ * A single- or multiple-choice input control.
+ */
+export declare class FormFieldChoice extends FormFieldBase {
+    /**
+     * Splits the given value using commas (so long as the comma did not get escaped).
+     * @param values
+     */
+    static split(values: string): string[];
+    /**
+     * Replaces all the commas in a given value with backslash-comma.
+     * @param value
+     */
+    static escape(value: string): string;
+    /**
+     * Replaces all the commas in a given value with backslash-comma.
+     * @param value
+     */
+    static unescape(value: string): string;
+    /**
+     * Just {@link FormFieldType.choice} control type.
+     */
+    protected get supported(): FormFieldType[];
+    /**
+     * The list of choices available and their values.
+     */
+    choices: Map<string, string>;
+    /**
+     * Minimum number of choices that must be selected.
+     */
+    minimum: byte;
+    /**
+     * Maximum number of choices that must be selected.
+     */
+    maximum: byte;
+    constructor(id?: ulong | nothing, name?: string | nothing, kind?: FormFieldType | nothing, choices?: Map<string, string> | nothing, minimum?: byte | nothing, maximum?: byte | nothing, notes?: string | nothing, required?: boolean | nothing, value?: string | nothing, editable?: boolean | nothing);
+    toJSON(): {
+        choices: import("../..").JsonObject;
+        minimum: number | null;
+        maximum: number | null;
+    };
+    isValid(value: string): boolean;
+}

package/objects/Hosting/Fields/FormFieldDate.d.ts

@@ -0,0 +1,26 @@
+import { datetime, nothing, ulong } from "../../API/Types";
+import { FormFieldType } from "../FormFieldType";
+import { FormFieldBase } from "./FormFieldBase";
+/**
+ * A control to choose a date and (optionally) a time.
+ */
+export declare class FormFieldDate extends FormFieldBase {
+    /**
+     * These are the calendar control types.
+     */
+    protected get supported(): FormFieldType[];
+    /**
+     * The earliest date or date/time.
+     */
+    minimum: Date;
+    /**
+     * The latest date or date/time.
+     */
+    maximum: Date;
+    constructor(id?: ulong | nothing, name?: string | nothing, kind?: FormFieldType | nothing, minimum?: Date | number | datetime | nothing, maximum?: Date | number | datetime | nothing, notes?: string | nothing, required?: boolean | nothing, value?: string | nothing, editable?: boolean | nothing);
+    toJSON(): {
+        minimum: string | null;
+        maximum: string | null;
+    };
+    isValid(value: string): boolean;
+}

package/objects/Hosting/Fields/FormFieldNumeric.d.ts

@@ -0,0 +1,54 @@
+import { byte, double, nothing, ulong } from "../../API/Types";
+import { FormFieldType } from "../FormFieldType";
+import { FormFieldBase } from "./FormFieldBase";
+import { FormFieldNumericSize } from "./FormFieldNumericSize";
+/**
+ * A numeric value input control with multiple contexts available.
+ * @tutorial
+ * For this field, the {@link FormFieldBase.kind} is just a helper for the UI, and does not affect input validation.
+ */
+export declare class FormFieldNumeric extends FormFieldBase {
+    /**
+     * These are the numeric control types.
+     */
+    protected get supported(): FormFieldType[];
+    /**
+     * A context hint for the kind of numeric size for this field.
+     * Used only for {@link FormFieldType.distance}, {@link FormFieldType.weight}, {@link FormFieldType.volume},
+     * and {@link FormFieldType.speed}.
+     */
+    size: FormFieldNumericSize;
+    /**
+     * Number of decimal places of accuracy are required.
+     */
+    precision: byte;
+    /**
+     * The numeric value increments by this amount.
+     */
+    step: double;
+    /**
+     * An optional suffix for this numeric value, like "%" or "ppm".
+     * This value is ignored for {@link FormFieldType.distance}, {@link FormFieldType.weight},
+     *  {@link FormFieldType.volume}, {@link FormFieldType.speed}, and {@link FormFieldType.area} field types.
+     * And for {@link FormFieldType.currency} fields it acts as a prefix, like "$" or "USD".
+     */
+    units: string;
+    /**
+     * The (optional) minimum value.
+     */
+    minimum: double;
+    /**
+     * The (optional) maximum value.
+     */
+    maximum: double;
+    constructor(id?: ulong | nothing, name?: string | nothing, kind?: FormFieldType | nothing, size?: FormFieldNumericSize | nothing, precision?: byte | nothing, step?: double | nothing, units?: string | nothing, minimum?: double | nothing, maximum?: double | nothing, notes?: string | nothing, required?: boolean | nothing, value?: string | nothing, editable?: boolean | nothing);
+    toJSON(): {
+        size: FormFieldNumericSize;
+        precision: number | null;
+        step: number | null;
+        units: string;
+        minimum: number | null;
+        maximum: number | null;
+    };
+    isValid(value: string): boolean;
+}

package/objects/Hosting/Fields/FormFieldNumericSize.d.ts

@@ -0,0 +1,32 @@
+/**
+ * A context hint for the size of a measurements.
+ */
+export declare enum FormFieldNumericSize {
+    /**
+     * A small measurement.
+     * For {@link FormFieldType.distance}: {@link Units.CENTIMETER}/{@link Units.INCH}
+     * For {@link FormFieldType.weight}: {@link Units.GRAM}/{@link Units.OUNCE}
+     * For {@link FormFieldType.volume}: {@link Units.MILLILITER}/{@link Units.OUNCE}
+     * For {@link FormFieldType.speed}: {@link Units.CENTIMETER_PER_SECOND}/{@link Units.INCH_PER_SECOND}
+     * For {@link FormFieldType.area}: {@link Units.SQUARE_METRE}/{@link Units.SQUARE_FOOT}
+     */
+    small = "small",
+    /**
+     * A medium measurement.
+     * For {@link FormFieldType.distance}: {@link Units.METER}/{@link Units.FOOT}
+     * For {@link FormFieldType.weight}: {@link Units.KILOGRAM}/{@link Units.POUND}
+     * For {@link FormFieldType.volume}: same as {@link FormFieldNumericSize.small}
+     * For {@link FormFieldType.speed}: {@link Units.METER_PER_SECOND}/{@link Units.FOOT_PER_SECOND}
+     * For {@link FormFieldType.area}: {@link Units.SQUARE_KILOMETRE}/{@link Units.SQUARE_MILE}
+     */
+    medium = "medium",
+    /**
+     * A large measurement.
+     * For {@link FormFieldType.distance}: {@link Units.KILOMETER}/{@link Units.MILE}
+     * For {@link FormFieldType.weight}: {@link Units.TONNE}/{@link Units.TON}
+     * For {@link FormFieldType.volume}: {@link Units.LITER}/{@link Units.GALLON}
+     * For {@link FormFieldType.speed}: {@link Units.KILOMETER_PER_HOUR}/{@link Units.MILE_PER_HOUR}
+     * For {@link FormFieldType.area}: {@link Units.HECTARE}/{@link Units.ACRE}
+     */
+    large = "large"
+}

package/objects/Hosting/Fields/FormFieldSignature.d.ts

@@ -0,0 +1,17 @@
+import { nothing, ulong } from '../../API/Types';
+import { FormFieldType } from '../FormFieldType';
+import { FormFieldBase } from './FormFieldBase';
+/**
+ * A control to capture a signature from the user.
+ * @tutorial
+ * The device making the capture must save the image to the server some other way.
+ * When submitting the {@link FormResult}, the value must be a path to the signature file.
+ */
+export declare class FormFieldSignature extends FormFieldBase {
+    /**
+     * Just {@link FormFieldType.signature} control type.
+     */
+    protected get supported(): FormFieldType[];
+    constructor(id?: ulong | nothing, name?: string | nothing, notes?: string | nothing, required?: boolean | nothing, value?: string | nothing, editable?: boolean | nothing);
+    isValid(value: string): boolean;
+}

package/objects/Hosting/Fields/FormFieldText.d.ts

@@ -0,0 +1,32 @@
+import { byte, nothing, ulong, ushort } from "../../API/Types";
+import { FormFieldType } from "../FormFieldType";
+import { FormFieldBase } from "./FormFieldBase";
+/**
+ * A text input control.
+ */
+export declare class FormFieldText extends FormFieldBase {
+    /**
+     * Just {@link FormFieldType.text} control type.
+     */
+    protected get supported(): FormFieldType[];
+    /**
+     * The number of rows of text to display.
+     * @tutorial The control should grow to display all entered text even if the UI must add more rows.
+     */
+    rows: byte;
+    /**
+     * Minimum length of entered text to make it a valid entry.
+     */
+    minimum: ushort;
+    /**
+     * Maximum length of entered text to make it a valid entry.
+     */
+    maximum: ushort;
+    constructor(id?: ulong | nothing, name?: string | nothing, rows?: byte | nothing, minimum?: ushort | nothing, maximum?: ushort | nothing, notes?: string | nothing, required?: boolean | nothing, value?: string | nothing, editable?: boolean | nothing);
+    toJSON(): {
+        rows: number | null;
+        minimum: number | null;
+        maximum: number | null;
+    };
+    isValid(value: string): boolean;
+}

package/objects/Hosting/Fields/FormFieldTime.d.ts

@@ -0,0 +1,37 @@
+import { TimeSpan } from "../../API/TimeSpan";
+import { nothing, timespan, ulong } from "../../API/Types";
+import { FormFieldType } from "../FormFieldType";
+import { FormFieldBase } from "./FormFieldBase";
+/**
+ * A control to choose a time or duration longer than 24 hours.
+ */
+export declare class FormFieldTime extends FormFieldBase {
+    /**
+     * For a 24 hour day, anything negative span would be considered invalid.
+     * As such, the minimum time for a {@link FormFieldType.time} is midnight (zero).
+     */
+    static readonly MINIMUM_TIME_OF_DAY: TimeSpan;
+    /**
+     * For a 24 hour day, anything over a 24 hour span would be considered invalid.
+     * As such, the maximum time for a {@link FormFieldType.time} is midnight the next day.
+     */
+    static readonly MAXIMUM_TIME_OF_DAY: TimeSpan;
+    /**
+     * These are the clock control types.
+     */
+    protected get supported(): FormFieldType[];
+    /**
+     * The minimum duration or earliest time-of-day.
+     */
+    minimum: TimeSpan | null;
+    /**
+     * The maximum duration or latest time-of-day.
+     */
+    maximum: TimeSpan | null;
+    constructor(id?: ulong | nothing, name?: string | nothing, kind?: FormFieldType | nothing, minimum?: TimeSpan | timespan | number | nothing, maximum?: TimeSpan | timespan | number | nothing, notes?: string | nothing, required?: boolean | nothing, value?: string | nothing, editable?: boolean | nothing);
+    toJSON(): {
+        minimum: string | null;
+        maximum: string | null;
+    };
+    isValid(value: string): boolean;
+}

package/objects/Hosting/Fields/FormFieldTimezone.d.ts

@@ -0,0 +1,14 @@
+import { nothing, ulong } from "../../API/Types";
+import { FormFieldType } from "../FormFieldType";
+import { FormFieldBase } from "./FormFieldBase";
+/**
+ * A {@link Timezone} selection control.
+ */
+export declare class FormFieldTimezone extends FormFieldBase {
+    /**
+     * Just {@link FormFieldType.timezone} control type.
+     */
+    protected get supported(): FormFieldType[];
+    constructor(id?: ulong | nothing, name?: string | nothing, notes?: string | nothing, required?: boolean | nothing, value?: string | nothing, editable?: boolean | nothing);
+    isValid(value: string): boolean;
+}