@trakit/objects 0.0.6 → 0.0.8

package/_publish/Dispatch/DispatchJob.d.ts

@@ -1,109 +0,0 @@
-import { BaseComponent } from "../API/BaseComponent";
-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 { codified, JsonObject, ulong } from "../API/Types";
-import { Asset } from "../Assets/Asset";
-import { Company } from "../Companies/Company";
-import { FormResult } from "../Hosting/FormResult";
-import { DispatchJobPriority } from "./DispatchJobPriority";
-import { DispatchStep } from "./DispatchStep";
-/**
- * Some work that needs to be done by performing one or more {@link DispatchStep}s.
- */
-export declare class DispatchJob extends BaseComponent implements IIdUlong, ILabelled, IBelongCompany, IBelongAsset {
-    /**
-     * Unique identifier of this job.
-     */
-    id: ulong;
-    /**
-     * The company to which this job belongs.
-     * {@link Company.id}
-     */
-    companyId: ulong;
-    /**
-     * The company to which this job belongs.
-     * {@link Company.id}
-     */
-    get company(): Company;
-    /**
-     * The {@link Asset} to which this job belongs.
-     * This value is null when unassigned.
-     * {@link Asset.id}
-     */
-    assetId: ulong;
-    /**
-     * The {@link Asset} to which this job belongs.
-     * This value is null when unassigned.
-     * {@link Asset.id}
-     */
-    get asset(): Asset;
-    set asset(value: Asset);
-    /**
-     * A name for the work needed to be performed.
-     */
-    name: string;
-    /**
-     * Name/value collections of custom fields used to refer to external systems.
-     */
-    references: Map<string, string>;
-    /**
-     * Instructions (filled out by dispatcher) for the field-employee to help them complete the job.
-     */
-    instructions: string;
-    /**
-     * A list of hosted {@link FormResult.id} attached to this job.
-     */
-    formIds: ulong[];
-    /**
-     * A list of hosted {@link FormResult}s attached to this job.
-     */
-    get forms(): FormResult[];
-    set forms(value: FormResult[]);
-    /**
-     * The importance of this job when scheduling for an asset.
-     */
-    priority: DispatchJobPriority;
-    /**
-     * Codified label names used to relate (unassigned) jobs to {@link Asset}s.
-     */
-    labels: codified[];
-    /**
-     * The codified status tag names reflecting the conditions of this job.
-     */
-    tags: codified[];
-    /**
-     * A list of coordinates to visit in order to carry out the work for this job.
-     */
-    steps: DispatchStep[];
-    /**
-     * When this job was originally created.
-     */
-    created: Date;
-    /**
-     * Clocked-in driver name who made the update.
-     * Null if not clocked-in, or no changes have been made.
-     */
-    driver: string;
-    toJSON(): {
-        id: number | null;
-        company: number | null;
-        v: number[];
-        driver: string;
-        created: string | null;
-        name: string;
-        instructions: string;
-        priority: DispatchJobPriority;
-        references: JsonObject;
-        labels: string[];
-        tags: string[];
-        forms: number[];
-        steps: any[];
-    };
-    fromJSON(json: JsonObject, force?: boolean): boolean;
-    /**
-     * The {@link id} is the key.
-     */
-    getKey(): number;
-}

package/_publish/Dispatch/DispatchStep.d.ts

@@ -1,99 +0,0 @@
-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, nothing, timespan, ulong, JsonObject } 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: JsonObject): 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 | nothing, name?: string | nothing, states?: Map<DispatchStepStatus, DispatchStepState> | nothing, eta?: Date | number | datetime | nothing, duration?: TimeSpan | timespan | number | nothing, place?: ulong | nothing, address?: string | nothing, latlng?: ILatLng | JsonObject | nothing, notes?: string | nothing, signature?: boolean | nothing, signatory?: string | nothing);
-    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: JsonObject;
-    };
-}

package/_publish/Dispatch/DispatchStepState.d.ts

@@ -1,27 +0,0 @@
-import { ILatLng } from "../API/Geography/Interfaces";
-import { LatLng } from "../API/Geography/LatLng";
-import { ISerializable } from "../API/Interfaces/ISerializable";
-import { datetime, JsonObject, nothing } from "../API/Types";
-/**
- * Details about the lifetime of a {@link DispatchStep}.
- */
-export declare class DispatchStepState implements ISerializable {
-    /**
-     *
-     * @param json
-     */
-    static fromJSON(json: JsonObject): 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 | nothing, latlng?: ILatLng | JsonObject | nothing);
-    toJSON(): {
-        updated: string | null;
-        latlng: ILatLng | null;
-    };
-}

package/_publish/Dispatch/DispatchTask.d.ts

@@ -1,156 +0,0 @@
-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 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: 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/_publish/Hosting/Document.d.ts

@@ -1,71 +0,0 @@
-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 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: JsonObject, force?: boolean): boolean;
-    /**
-     * The {@link id} is the key.
-     */
-    getKey(): number;
-}

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

@@ -1,31 +0,0 @@
-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/_publish/Hosting/Fields/FormFieldBase.d.ts

@@ -1,56 +0,0 @@
-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/_publish/Hosting/Fields/FormFieldBase_fromJSON.d.ts

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

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

@@ -1,38 +0,0 @@
-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/_publish/Hosting/Fields/FormFieldChoice.d.ts

@@ -1,46 +0,0 @@
-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/_publish/Hosting/Fields/FormFieldDate.d.ts

@@ -1,26 +0,0 @@
-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;
-}