@trakit/objects 0.0.1

package/Dispatch/DispatchJobPriority.d.ts

@@ -0,0 +1,25 @@
+/**
+ * A value assigned to {@link DispatchJob}s in order to weigh them when optimizing a route.
+ */
+export declare enum DispatchJobPriority {
+    /**
+     * Will be done last, after all others, if at all.
+     */
+    standby = "standby",
+    /**
+     * Low priority jobs are assigned towards the end of a dispatch, unless they are in very close proximity to another job.
+     */
+    low = "low",
+    /**
+     * A normal job that will be done at the first opportunity.
+     */
+    medium = "medium",
+    /**
+     * More important job that will be routed to first unless the next high importance job is much farther away.
+     */
+    high = "high",
+    /**
+     * Must be done first, before all others.
+     */
+    urgent = "urgent"
+}

package/Dispatch/DispatchStep.d.ts

@@ -0,0 +1,99 @@
+import { ILatLng } from "../API/Geography/Interfaces";
+import { LatLng } from "../API/Geography/LatLng";
+import { IIdUlong } from "../API/Interfaces/IIdUlong";
+import { INamed } from "../API/Interfaces/INamed";
+import { ISerializable } from "../API/Interfaces/ISerializable";
+import { TimeSpan } from "../API/TimeSpan";
+import { datetime, timespan, ulong } from "../API/Types";
+import { Place } from "../Places/Place";
+import { DispatchStepState } from "./DispatchStepState";
+import { DispatchStepStatus } from "./DispatchStepStatus";
+/**
+ * A portion of work for a {@link DispatchJob}.
+ */
+export declare class DispatchStep implements IIdUlong, INamed, ISerializable {
+    /**
+     *
+     * @param json
+     */
+    static fromJSON(json: any): DispatchStep;
+    /**
+     * Identifier for this {@link DispatchStep}.
+     * This value is unique per {@link DispatchJob}, but is not unique system-wide.
+     */
+    id: ulong;
+    /**
+     * A name for the work needed to be performed.
+     */
+    name: string;
+    /**
+     * The most recently updated state for this step.
+     */
+    get status(): DispatchStepStatus;
+    /**
+     *
+     */
+    get updated(): Date;
+    /**
+     * The progress of this step.
+     */
+    states: Map<DispatchStepStatus, DispatchStepState>;
+    /**
+     * The optional estimated time of arrival for the asset.
+     */
+    eta: Date;
+    /**
+     * The optional expected duration of the work for this step.
+     */
+    duration: TimeSpan;
+    /**
+     * The total number of seconds in the {@link duration}.
+     */
+    get timeOnSite(): number;
+    set timeOnSite(value: number);
+    /**
+     * 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 step must be completed.
+     */
+    address: string;
+    /**
+     * The lat/long coordinates of where the step must be {@link DispatchStepStatus.completed}.
+     */
+    latlng: LatLng | null;
+    /**
+     * Notes about the status of the work filled in by field-employee.
+     */
+    notes: string;
+    /**
+     * Indicates whether this step requires a signature.
+     */
+    signature: boolean;
+    /**
+     * The name of the person who signed the step's completion.
+     */
+    signatory: string;
+    constructor(id?: ulong, name?: string, states?: Map<DispatchStepStatus, DispatchStepState>, eta?: Date | number | datetime, duration?: TimeSpan | timespan | number, place?: ulong, address?: string, latlng?: ILatLng | null, notes?: string, signature?: boolean, signatory?: string);
+    toJSON(): {
+        id: number | null;
+        address: string;
+        duration: string;
+        eta: string;
+        latlng: ILatLng | null;
+        name: string;
+        notes: string;
+        place: number | null;
+        signature: boolean;
+        signatory: string;
+        states: object;
+    };
+}

package/Dispatch/DispatchStepState.d.ts

@@ -0,0 +1,27 @@
+import { ILatLng } from "../API/Geography/Interfaces";
+import { LatLng } from "../API/Geography/LatLng";
+import { ISerializable } from "../API/Interfaces/ISerializable";
+import { datetime } from "../API/Types";
+/**
+ * Details about the lifetime of a {@link DispatchStep}.
+ */
+export declare class DispatchStepState implements ISerializable {
+    /**
+     *
+     * @param json
+     */
+    static fromJSON(json: any): DispatchStepState;
+    /**
+     * A timestamp from when the lifetime was updated.
+     */
+    updated: Date;
+    /**
+     * The coordinates from the {@link Asset} when the update happened.
+     */
+    latlng: LatLng | null;
+    constructor(updated?: Date | number | datetime, latlng?: ILatLng | null);
+    toJSON(): {
+        updated: string | null;
+        latlng: ILatLng | null;
+    };
+}

package/Dispatch/DispatchStepStatus.d.ts

@@ -0,0 +1,21 @@
+/**
+ * The lifetime of all {@link DispatchStep}s (in order).
+ */
+export declare enum DispatchStepStatus {
+    /**
+     * The {@link DispatchStep} has not yet been started.
+     */
+    pending = "pending",
+    /**
+     * The asset is on the way to the {@link DispatchStep}'s location next.
+     */
+    onRoute = "onRoute",
+    /**
+     * The asset has arrived at the {@link DispatchStep}'s location.
+     */
+    arrived = "arrived",
+    /**
+     * The {@link DispatchStep} is done (or the asset has departed the location).
+     */
+    completed = "completed"
+}

package/Dispatch/DispatchTask.d.ts

@@ -0,0 +1,156 @@
+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 { ulong } from "../API/Types";
+import { Asset } from "../Assets/Asset";
+import { Company } from "../Companies/Company";
+import { Place } from "../Places/Place";
+import { DispatchTaskStatus } from "./DispatchTaskStatus";
+import { Document } from "../Hosting/Document";
+/**
+ * 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 company to which this task belongs.
+     * {@link Company.id}
+     */
+    get company(): Company;
+    /**
+     * The asset to which this task belongs.
+     * {@link Asset.id}
+     */
+    assetId: ulong;
+    /**
+     * The asset to which this task belongs.
+     * {@link Asset.id}
+     */
+    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: object;
+        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: any, force?: boolean): boolean;
+    /**
+     * The {@link id} is the key.
+     */
+    getKey(): string;
+}

package/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/Hosting/Document.d.ts

@@ -0,0 +1,71 @@
+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 } 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 company to which this file belongs.
+     * {@link Company.id}
+     */
+    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: any, force?: boolean): boolean;
+    /**
+     * The {@link id} is the key.
+     */
+    getKey(): string;
+}

package/Hosting/Fields/FormFieldAttachments.d.ts

@@ -0,0 +1,38 @@
+import { byte, ulong } from '../../API/Types';
+import { FormFieldBase } from './FormFieldBase';
+import { FormFieldType } from '../FormFieldType';
+/**
+ * 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 splitValues(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, name?: string, kind?: FormFieldType, minimum?: byte, maximum?: byte, notes?: string, required?: boolean, value?: string | null, editable?: boolean);
+    toJSON(): {
+        minimum: number | null;
+        maximum: number | null;
+        id: number | null;
+        kind: FormFieldType;
+        name: string;
+        notes: string;
+        required: boolean;
+        value: string | null;
+        editable: boolean;
+    };
+    isValid(value: string): boolean;
+}

package/Hosting/Fields/FormFieldBase.d.ts

@@ -0,0 +1,71 @@
+import { IIdUlong } from '../../API/Interfaces/IIdUlong';
+import { INamed } from '../../API/Interfaces/INamed';
+import { ISerializable } from '../../API/Interfaces/ISerializable';
+import { ulong } from '../../API/Types';
+import { FormFieldType } from '../FormFieldType';
+import { FormFieldAttachments } from './FormFieldAttachments';
+import { FormFieldBoolean } from './FormFieldBoolean';
+import { FormFieldChoice } from './FormFieldChoice';
+import { FormFieldDate } from './FormFieldDate';
+import { FormFieldNumeric } from './FormFieldNumeric';
+import { FormFieldSignature } from './FormFieldSignature';
+import { FormFieldText } from './FormFieldText';
+import { FormFieldTime } from './FormFieldTime';
+import { FormFieldTimezone } from './FormFieldTimezone';
+/**
+ * A base class for the common form field UI members.
+ */
+export declare abstract class FormFieldBase implements IIdUlong, INamed, ISerializable {
+    /**
+     * Instantiates a form field based on the kind property in the given JSON.
+     * @param json
+     */
+    static fromJSON(json: any): FormFieldText | FormFieldChoice | FormFieldBoolean | FormFieldNumeric | FormFieldDate | FormFieldTime | FormFieldSignature | FormFieldAttachments | FormFieldTimezone;
+    /**
+     * 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, name?: string, kind?: FormFieldType, notes?: string, required?: boolean, value?: string | null, editable?: boolean);
+    toJSON(): {
+        id: number | null;
+        kind: FormFieldType;
+        name: string;
+        notes: string;
+        required: boolean;
+        value: string | null;
+        editable: boolean;
+    };
+    /**
+     * Returns true if the value can be parsed by the field type.
+     */
+    abstract isValid(value: string): boolean;
+}

package/Hosting/Fields/FormFieldBoolean.d.ts

@@ -0,0 +1,46 @@
+import { 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 DEFAULT_CHOICES: [string, string, string];
+    /**
+     * Returns an array of 3 strings representing the checked, unchecked, and indeterminate values.
+     * @param choices
+     * @returns
+     */
+    static parseChoices(choices?: (string | null)[] | null): [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, name?: string, kind?: FormFieldType, choices?: string[], notes?: string, required?: boolean, value?: string | null, editable?: boolean);
+    toJSON(): {
+        choices: string[];
+        id: number | null;
+        kind: FormFieldType;
+        name: string;
+        notes: string;
+        required: boolean;
+        value: string | null;
+        editable: boolean;
+    };
+    isValid(value: string): boolean;
+}

package/Hosting/Fields/FormFieldChoice.d.ts

@@ -0,0 +1,48 @@
+import { byte, 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 splitValues(values: string): string[];
+    /**
+     * Replaces all the commas in a given value with backslash-comma.
+     * @param value
+     */
+    static escapeValue(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, name?: string, kind?: FormFieldType, choices?: Map<string, string>, minimum?: byte, maximum?: byte, notes?: string, required?: boolean, value?: string | null, editable?: boolean);
+    toJSON(): {
+        choices: object;
+        minimum: number | null;
+        maximum: number | null;
+        id: number | null;
+        kind: FormFieldType;
+        name: string;
+        notes: string;
+        required: boolean;
+        value: string | null;
+        editable: boolean;
+    };
+    isValid(value: string): boolean;
+}

package/Hosting/Fields/FormFieldDate.d.ts

@@ -0,0 +1,33 @@
+import { datetime, 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, name?: string, kind?: FormFieldType, minimum?: Date | number | datetime, maximum?: Date | number | datetime, notes?: string, required?: boolean, value?: string | null, editable?: boolean);
+    toJSON(): {
+        minimum: string | null;
+        maximum: string | null;
+        id: number | null;
+        kind: FormFieldType;
+        name: string;
+        notes: string;
+        required: boolean;
+        value: string | null;
+        editable: boolean;
+    };
+    isValid(value: string): boolean;
+}