@trakit/objects 0.0.1

package/Hosting/Fields/FormFieldNumeric.d.ts

@@ -0,0 +1,61 @@
+import { byte, double, 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, name?: string, kind?: FormFieldType, size?: FormFieldNumericSize, precision?: byte, step?: double, units?: string, minimum?: double, maximum?: double, notes?: string, required?: boolean, value?: string | null, editable?: boolean);
+    toJSON(): {
+        size: FormFieldNumericSize;
+        precision: number | null;
+        step: number | null;
+        units: string;
+        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/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/Hosting/Fields/FormFieldSignature.d.ts

@@ -0,0 +1,17 @@
+import { 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, name?: string, notes?: string, required?: boolean, value?: string | null, editable?: boolean);
+    isValid(value: string): boolean;
+}

package/Hosting/Fields/FormFieldText.d.ts

@@ -0,0 +1,39 @@
+import { byte, 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, name?: string, rows?: byte, minimum?: ushort, maximum?: ushort, notes?: string, required?: boolean, value?: string | null, editable?: boolean);
+    toJSON(): {
+        rows: number | null;
+        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/FormFieldTime.d.ts

@@ -0,0 +1,34 @@
+import { TimeSpan } from "../../API/TimeSpan";
+import { 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 {
+    /**
+     * 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, name?: string, kind?: FormFieldType, minimum?: TimeSpan | timespan | number, maximum?: TimeSpan | timespan | number, 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;
+}

package/Hosting/Fields/FormFieldTimezone.d.ts

@@ -0,0 +1,14 @@
+import { 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, name?: string, notes?: string, required?: boolean, value?: string | null, editable?: boolean);
+    isValid(value: string): boolean;
+}

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

@@ -0,0 +1,97 @@
+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 } 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.
+     * {@link Company.id}
+     */
+    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.
+     * {@link Asset.id}
+     */
+    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(): string;
+    toJSON(): {
+        id: number;
+        company: number;
+        v: number[];
+        template: number | null;
+        asset: number | null;
+        name: string;
+        notes: string;
+        labels: string[];
+        fields: object;
+        completed: string | null;
+        latlng: import("../API/Geography/Interfaces").ILatLng | null;
+        driver: string | null;
+    };
+    fromJSON(json: any, force?: boolean): boolean;
+}

package/Hosting/FormTemplate.d.ts

@@ -0,0 +1,81 @@
+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 } 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.
+     * {@link Company.id}
+     */
+    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(): string;
+    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: any, force?: boolean): boolean;
+}

package/Images/Dashcam.d.ts

@@ -0,0 +1,70 @@
+import { ISize } from "../API/Geometry/Interfaces";
+import { Size } from "../API/Geometry/Size";
+import { TimeSpan } from "../API/TimeSpan";
+import { byte, datetime, double, guid, single, ulong } 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 {
+    /**
+     *
+     * @param json
+     */
+    static fromJSON(json: any): Dashcam;
+    /**
+     * 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;
+    constructor(bytes?: ulong, size?: Size | ISize, provider?: string, company?: ulong, asset?: ulong, camera?: byte, latitude?: double, longitude?: double, speed?: double, heading?: double, altitude?: double, guid?: guid, kind?: DashcamMediaType, fps?: single, start?: Date | number | datetime, end?: Date | number | datetime, eventName?: string);
+    toJSON(): {
+        guid: string;
+        kind: DashcamMediaType;
+        fps: number | null;
+        start: string | null;
+        end: string | null;
+        eventName: string;
+        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;
+    };
+    /**
+     * The {@link guid} is the key.
+     */
+    getKey(): string;
+}

package/Images/DashcamBase.d.ts

@@ -0,0 +1,98 @@
+import { ISize } from "../API/Geometry/Interfaces";
+import { Size } from "../API/Geometry/Size";
+import { IFileSize } from "../API/Interfaces/IFileSize";
+import { IRequestable } from "../API/Interfaces/IRequestable";
+import { ISerializable } from "../API/Interfaces/ISerializable";
+import { byte, double, 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 {
+    /**
+     * 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;
+    /**
+     * Unique identifier of the provider that sent the data.
+     * {@link Provider.id}
+     */
+    get provider(): Provider;
+    /**
+     * Unique identifier of the company of the provider.
+     * {@link Company.id}
+     */
+    companyId: ulong;
+    /**
+     * Unique identifier of the company of the provider.
+     * {@link Company.id}
+     */
+    get company(): Company;
+    /**
+     * Unique identifier of the asset tied to the provider at the time.
+     * {@link Asset.id}
+     */
+    assetId: ulong;
+    /**
+     * Unique identifier of the asset tied to the provider at the time.
+     * {@link Asset.id}
+     */
+    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(bytes?: ulong, size?: Size | ISize, provider?: string, company?: ulong, asset?: ulong, camera?: byte, latitude?: double, longitude?: double, speed?: double, heading?: double, altitude?: double);
+    /**
+     *
+     */
+    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;
+}