@trakit/objects 0.0.6 → 0.0.8

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

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

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

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

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

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

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

package/_publish/Hosting/FormResult.d.ts

@@ -1,97 +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 { ILabelled } from "../API/Interfaces/ILabelled";
-import { INamed } from "../API/Interfaces/INamed";
-import { codified, ulong, JsonObject } from "../API/Types";
-import { Asset } from "../Assets/Asset";
-import { Company } from "../Companies/Company";
-import { FormTemplate } from "./FormTemplate";
-/**
- * A completed form submitted by a {@link User} or {@link Asset}.
- */
-export declare class FormResult extends BaseComponent implements IIdUlong, INamed, IBelongCompany, IBelongAsset, ILabelled {
-    /**
-     * Unique identifier of this form.
-     */
-    id: ulong;
-    /**
-     * The {@link Company} to which this form belongs.
-     * {@link Company.id}
-     */
-    companyId: ulong;
-    /**
-     * The {@link Company} to which this form belongs.
-     * {@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(): number;
-    toJSON(): {
-        id: number;
-        company: number;
-        v: number[];
-        template: number | null;
-        asset: number | null;
-        name: string;
-        notes: string;
-        labels: string[];
-        fields: JsonObject;
-        completed: string | null;
-        latlng: import("../API/Geography/Interfaces").ILatLng | null;
-        driver: string | null;
-    };
-    fromJSON(json: JsonObject, force?: boolean): boolean;
-}

package/_publish/Hosting/FormTemplate.d.ts

@@ -1,81 +0,0 @@
-import { BaseComponent } from "../API/BaseComponent";
-import { IBelongCompany } from "../API/Interfaces/IBelongCompany";
-import { IIdUlong } from "../API/Interfaces/IIdUlong";
-import { ILabelled } from "../API/Interfaces/ILabelled";
-import { INamed } from "../API/Interfaces/INamed";
-import { IVisual } from "../API/Interfaces/IVisual";
-import { codified, colour, ulong, JsonObject } from "../API/Types";
-import { Company } from "../Companies/Company";
-import { FormFieldAttachments } from './Fields/FormFieldAttachments';
-import { FormFieldBoolean } from './Fields/FormFieldBoolean';
-import { FormFieldChoice } from './Fields/FormFieldChoice';
-import { FormFieldDate } from './Fields/FormFieldDate';
-import { FormFieldNumeric } from './Fields/FormFieldNumeric';
-import { FormFieldSignature } from './Fields/FormFieldSignature';
-import { FormFieldText } from './Fields/FormFieldText';
-import { FormFieldTime } from './Fields/FormFieldTime';
-import { FormFieldTimezone } from './Fields/FormFieldTimezone';
-/**
- * The full definition of a form that needs to be filled out.
- */
-export declare class FormTemplate extends BaseComponent implements IIdUlong, INamed, IBelongCompany, ILabelled, IVisual {
-    /**
-     * Unique identifier of this form.
-     */
-    id: ulong;
-    /**
-     * The {@link Company} to which this form belongs.
-     * {@link Company.id}
-     */
-    companyId: ulong;
-    /**
-     * The {@link Company} to which this form belongs.
-     * {@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(): number;
-    toJSON(): {
-        id: number | null;
-        company: number | null;
-        v: number[];
-        name: string;
-        notes: string;
-        labels: string[];
-        fields: any[];
-        fill: string;
-        stroke: string;
-        graphic: string;
-    };
-    fromJSON(json: JsonObject, force?: boolean): boolean;
-}

package/_publish/Images/Dashcam.d.ts

@@ -1,70 +0,0 @@
-import { ISize } from "../API/Geometry/Interfaces";
-import { Size } from "../API/Geometry/Size";
-import { TimeSpan } from "../API/TimeSpan";
-import { byte, datetime, double, guid, JsonObject, 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: JsonObject): 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 | JsonObject, 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/_publish/Images/DashcamBase.d.ts

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

package/_publish/Images/DashcamLive.d.ts

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

package/_publish/Images/DashcamMediaType.d.ts

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

package/_publish/Images/Icon.d.ts

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