@trakit/objects 0.0.6 → 0.0.8

package/_publish/Images/IconGlyph.d.ts

@@ -1,47 +0,0 @@
-import { IPoint, ISize } from "../API/Geometry/Interfaces";
-import { Point } from "../API/Geometry/Point";
-import { Size } from "../API/Geometry/Size";
-import { ISerializable } from "../API/Interfaces/ISerializable";
-import { codified, ushort, JsonObject } from "../API/Types";
-import { IconLayer } from "./IconLayer";
-/**
- * The image source and defined status tags which need to be applied to an asset in order to show the image.
- */
-export declare class IconGlyph implements ISerializable {
-    /**
-     *
-     * @param json
-     */
-    static fromJSON(json: JsonObject): IconGlyph;
-    /**
-     * A list of codified status tag names.  Any of the tags must be applied to the asset for the image to appear.
-     */
-    tags: codified[];
-    /**
-     * Path to the image.
-     */
-    src: string;
-    /**
-     * Size of the glyph in pixels.
-     */
-    size: Size;
-    /**
-     * The offset from the lat/long in pixels.
-     */
-    anchor: Point;
-    /**
-     * The layer on which this glyph is displayed.
-     */
-    layer: IconLayer;
-    /**
-     * The z-order of this glyph compared to other glyphs on the same layer.
-     */
-    zIndex: ushort;
-    /**
-     * Indicates that this glyph rotate based on GPS bearing.
-     */
-    rotates: boolean;
-    constructor(tags?: codified[], src?: string, size?: ISize | JsonObject, anchor?: IPoint | JsonObject, layer?: IconLayer, zIndex?: ushort, rotates?: boolean);
-    toJSON(): JsonObject;
-    isEqual(other: IconGlyph): boolean;
-}

package/_publish/Images/IconLabel.d.ts

@@ -1,29 +0,0 @@
-import { IPoint } from "../API/Geometry/Interfaces";
-import { Point } from "../API/Geometry/Point";
-import { ISerializable } from "../API/Interfaces/ISerializable";
-import { colour, JsonObject } from "../API/Types";
-/**
- * Definition for the name bubble above the icon on a map.
- */
-export declare class IconLabel implements ISerializable {
-    /**
-     *
-     * @param json
-     */
-    static fromJSON(json: JsonObject): IconLabel;
-    /**
-     * The offset from the lat/long in pixels.
-     */
-    anchor: Point;
-    /**
-     * Determines which corner of the label is attached to the anchor.
-     */
-    align: string;
-    /**
-     * Background colour of the label.
-     */
-    colour: colour;
-    constructor(anchor?: IPoint | JsonObject, align?: string, colour?: colour);
-    toJSON(): JsonObject;
-    isEqual(other: IconLabel): boolean;
-}

package/_publish/Images/IconLayer.d.ts

@@ -1,33 +0,0 @@
-/**
- * The layers of the map used to visualize the icon.
- */
-export declare enum IconLayer {
-    /**
-     * An SVG only layer just above the roads used for solid Places and accuracy radius fill.
-     */
-    fills = "fills",
-    /**
-     * An HTML only layer intended for use by an icon's drop-shadow.
-     */
-    shadows = "shadows",
-    /**
-     * An SVG only layer intended for use by shape and accuracy radius outlines.
-     */
-    outlines = "outlines",
-    /**
-     * An HTML only layer intended for use by an icon's main images.
-     */
-    markers = "markers",
-    /**
-     * An HTML only layer intended for use by an icon's label.
-     */
-    labels = "labels",
-    /**
-     * An SVG only layer for special drawing controls.  Icons should not use this layer.
-     */
-    drawings = "drawings",
-    /**
-     * An HTML only layer for special drawing controls.  Icons should not use this layer.
-     */
-    edits = "edits"
-}

package/_publish/Images/Picture.d.ts

@@ -1,73 +0,0 @@
-import { BaseComponent } from "../API/BaseComponent";
-import { Rectangle } from "../API/Geometry/Rectangle";
-import { Size } from "../API/Geometry/Size";
-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 { uint, ulong, JsonObject } from "../API/Types";
-import { Company } from "../Companies/Company";
-/**
- * An image stored by the system.
- */
-export declare class Picture extends BaseComponent implements IIdUlong, INamed, IBelongCompany, IFileSize {
-    /**
-     * Unique identifier of this image.
-     */
-    id: ulong;
-    /**
-     * The company to which this image belongs.
-     * {@link Company.id}
-     */
-    companyId: ulong;
-    /**
-     * The company to which this image belongs.
-     * {@link Company.id}
-     */
-    get company(): Company;
-    /**
-     * The file name of this image.
-     */
-    name: string;
-    /**
-     * Notes about this image.
-     */
-    notes: string;
-    /**
-     * The URL/path to find this image.
-     */
-    src: string;
-    /**
-     * Resolution defined in pixels.
-     */
-    size: Size;
-    /**
-     * A list of focal points in the images like faces.
-     */
-    focals: Rectangle[];
-    /**
-     * The file-size on the disk.
-     */
-    bytes: ulong;
-    /**
-     * A count of the times this image was used for something (asset, contact, task, etc).
-     */
-    uses: uint;
-    toJSON(): {
-        id: number | null;
-        v: number[];
-        company: number;
-        name: string;
-        notes: string;
-        src: string;
-        size: import("../API/Geometry/Interfaces").ISize;
-        focals: any[];
-        bytes: number | null;
-        uses: number | null;
-    };
-    fromJSON(json: JsonObject, force?: boolean): boolean;
-    /**
-     * The {@link id} is the key.
-     */
-    getKey(): number;
-}

package/_publish/Maintenance/MaintenanceJob.d.ts

@@ -1,137 +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 { INamed } from "../API/Interfaces/INamed";
-import { IPictured } from "../API/Interfaces/IPictured";
-import { TimeSpan } from "../API/TimeSpan";
-import { double, JsonObject, ulong } from "../API/Types";
-import { Asset } from "../Assets/Asset";
-import { Company } from "../Companies/Company";
-import { Picture } from "../Images/Picture";
-import { MaintenanceJobStatus } from "./MaintenanceJobStatus";
-import { MaintenanceSchedule } from "./MaintenanceSchedule";
-/**
- * Historical service work performed on a Vehicle or Trailer
- */
-export declare class MaintenanceJob extends BaseComponent implements IIdUlong, INamed, IBelongCompany, IBelongAsset, IPictured {
-    /**
-     * Unique identifier
-     */
-    id: ulong;
-    /**
-     * The Vehicle or Trailer to which this job belongs
-     * {@link Asset.id}
-     */
-    assetId: ulong;
-    /**
-     * The Vehicle or Trailer to which this job belongs
-     * {@link Asset.id}
-     */
-    get asset(): Asset;
-    /**
-     * The company to which this Vehicle or Trailer belongs
-     * {@link Company.id}
-     */
-    companyId: ulong;
-    /**
-     * The company to which this Vehicle or Trailer belongs
-     * {@link Company.id}
-     */
-    get company(): Company;
-    /**
-     * The Maintenance Schedule from which this job was created
-     * {@link MaintenanceSchedule.id}
-     */
-    scheduleId: ulong;
-    /**
-     * The Maintenance Schedule from which this job was created
-     * {@link MaintenanceSchedule.id}
-     */
-    get schedule(): MaintenanceSchedule;
-    set schedule(value: MaintenanceSchedule);
-    /**
-     * The work being done. Like "oil change".
-     */
-    name: string;
-    /**
-     * Notes about the job.  Like "changed the oil and filter".
-     */
-    notes: string;
-    /**
-     * The status of this job.
-     */
-    status: MaintenanceJobStatus;
-    /**
-     * When was this job created.
-     */
-    created: Date;
-    /**
-     * When was this job created.
-     */
-    completed: Date;
-    /**
-     * The odometer at the time of the service.
-     */
-    odometer: double;
-    /**
-     * The operating time at the time of the service.
-     */
-    engineHours: double;
-    /**
-     * The name of the garage or service facility where the work is done.
-     */
-    garage: string;
-    /**
-     * Time it took to complete the job.
-     */
-    duration: TimeSpan;
-    /**
-     * How much the job cost in dollars.
-     */
-    cost: double;
-    /**
-     * A reference code used to track this job
-     */
-    reference: string;
-    /**
-     * The mechanic who performed the work.
-     */
-    technician: string;
-    /**
-     * Images taken while performing the work for reference.
-     * {@link Picture.id}
-     */
-    pictureIds: ulong[];
-    /**
-     * Images taken while performing the work for reference.
-     * {@link Picture.id}
-     */
-    get pictures(): Picture[];
-    set pictures(values: Picture[]);
-    toJSON(): {
-        id: number | null;
-        v: number[];
-        company: number;
-        asset: number;
-        schedule: number;
-        name: string;
-        notes: string;
-        status: MaintenanceJobStatus;
-        created: string | null;
-        completed: string | null;
-        odometer: number;
-        engineHours: number;
-        garage: string;
-        cost: number;
-        duration: string;
-        reference: string;
-        technician: string;
-        pictures: number[];
-    };
-    fromJSON(json: JsonObject, force?: boolean): boolean;
-    /**
-     * The {@link id} is the key.
-     */
-    getKey(): number;
-}

package/_publish/Maintenance/MaintenanceSchedule.d.ts

@@ -1,119 +0,0 @@
-import { BaseComponent } from "../API/BaseComponent";
-import { IBelongCompany } from "../API/Interfaces/IBelongCompany";
-import { IIdUlong } from "../API/Interfaces/IIdUlong";
-import { INamed } from "../API/Interfaces/INamed";
-import { IVisual } from "../API/Interfaces/IVisual";
-import { SearchPattern } from "../API/SearchPattern";
-import { TimeSpan } from "../API/TimeSpan";
-import { codified, colour, double, email, JsonObject, uint, ulong } from "../API/Types";
-import { Company } from "../Companies/Company";
-import { MaintenanceInterval } from "./MaintenanceInterval";
-/**
- * Recurring service work
- */
-export declare class MaintenanceSchedule extends BaseComponent implements IIdUlong, INamed, IBelongCompany, IVisual {
-    /**
-     * Unique identifier
-     */
-    id: ulong;
-    /**
-     * The company to which this schedule belongs
-     * {@link Company.id}
-     */
-    companyId: ulong;
-    /**
-     * The company to which this schedule belongs
-     * {@link Company.id}
-     */
-    get company(): Company;
-    /**
-     * The name of the work to be done.  Like "oil change".
-     */
-    name: string;
-    /**
-     * Notes about the work to be done.  Like "change the oil and oil filter".
-     */
-    notes: string;
-    /**
-     * The targeting expression to select which Vehicles and Trailers require this maintenance work.
-     */
-    targets: SearchPattern[] | null;
-    /**
-     * List of Users to send notifications.
-     */
-    notify: email[];
-    /**
-     * The fill/background colour of the icon.
-     */
-    fill: colour;
-    /**
-     * Outline and graphic colour.
-     */
-    stroke: colour;
-    /**
-     * The name of the symbol for this schedule.
-     */
-    graphic: codified;
-    /**
-     * The number of days in advance to predict a job will become pending.
-     */
-    predictionDays: uint;
-    /**
-     * The number of days between service visits.
-     */
-    recurDays: uint;
-    /**
-     * The amount of mileage between service visits.
-     */
-    recurDistance: double;
-    /**
-     * The number of operating hours between service visits.
-     */
-    recurEngineHours: double;
-    /**
-     * The per-asset details calculated by the system to help predict the creation of Maintenance Jobs.
-     */
-    intervals: Map<ulong, MaintenanceInterval>;
-    /**
-     * The name of the garage or service facility where the work is done.
-     */
-    garage: string;
-    /**
-     * The estimated time for the job.
-     */
-    duration: TimeSpan;
-    /**
-     * The estimated cost for the job cost in dollars.
-     */
-    cost: double;
-    /**
-     * A reference code used to track this job.
-     */
-    reference: string;
-    toJSON(): {
-        id: number | null;
-        v: number[];
-        company: number;
-        name: string;
-        notes: string;
-        notify: string[];
-        targets: string | null;
-        fill: string;
-        stroke: string;
-        graphic: string;
-        garage: string;
-        cost: number;
-        duration: string;
-        reference: string;
-        predictionDays: number;
-        recurDays: number | null;
-        recurDistance: number | null;
-        recurEngineHours: number | null;
-        intervals: JsonObject;
-    };
-    fromJSON(json: JsonObject, force?: boolean): boolean;
-    /**
-     * The {@link id} is the key.
-     */
-    getKey(): number;
-}

package/_publish/Messaging/AssetMessage.d.ts

@@ -1,40 +0,0 @@
-import { email, JsonObject } from '../API/Types';
-import { MessageBase } from './MessageBase';
-import { MessageFolder } from './MessageFolder';
-/**
- * A conversational message between users and assets.
- */
-export declare class AssetMessage extends MessageBase {
-    /**
-     * The folder under which this message is stored.
-     */
-    folder: MessageFolder;
-    /**
-     * Indicates that this is a received message instead of a sent message.
-     */
-    incoming: boolean;
-    /**
-     * The user that read this message.  This field is blank/null when unread.
-     * {@link User.login}
-     */
-    readBy: email;
-    toJSON(): {
-        folder: MessageFolder;
-        incoming: boolean;
-        readBy: string;
-        id: number | null;
-        v: number[];
-        company: number;
-        status: import("./MessageStatus").MessageStatus;
-        kind: import("./MessageType").MessageType;
-        to: string;
-        from: string;
-        body: string;
-        processed: string | null;
-        delivered: string | null;
-        subject: string;
-        asset: number;
-        user: string;
-    };
-    fromJSON(json: JsonObject, force?: boolean): boolean;
-}

package/_publish/Messaging/MessageBase.d.ts

@@ -1,101 +0,0 @@
-import { User } from "../Accounts/User";
-import { BaseComponent } from "../API/BaseComponent";
-import { IBelongAsset } from "../API/Interfaces/IBelongAsset";
-import { IBelongCompany } from "../API/Interfaces/IBelongCompany";
-import { IIdUlong } from "../API/Interfaces/IIdUlong";
-import { email, JsonObject, ulong } from "../API/Types";
-import { Asset } from "../Assets/Asset";
-import { Company } from "../Companies/Company";
-import { MessageStatus } from './MessageStatus';
-import { MessageType } from './MessageType';
-/**
- * A base class for Alerts and Messages.
- */
-export declare abstract class MessageBase extends BaseComponent implements IIdUlong, IBelongCompany, IBelongAsset {
-    /**
-     * Unique identifier of this memo.
-     */
-    id: ulong;
-    /**
-     * The company to which this memo belongs.
-     * {@link Company.id}
-     */
-    companyId: ulong;
-    /**
-     * The company to which this memo belongs.
-     * {@link Company.id}
-     */
-    get company(): Company;
-    /**
-     * Lifetime status
-     */
-    status: MessageStatus;
-    /**
-     * Protocol type
-     */
-    kind: MessageType;
-    /**
-     * Recipient address.
-     */
-    to: email;
-    /**
-     * Sender address.
-     */
-    from: email;
-    /**
-     * The main contents of the memo.
-     */
-    body: string;
-    /**
-     * Date/time stamp of when the memo was processed.
-     */
-    processed: Date;
-    /**
-     * Date/time stamp of when the memo was delivered (or sent if delivery information unavailable).
-     */
-    delivered: Date;
-    /**
-     * The subject of this message.
-     */
-    subject: string;
-    /**
-     * The asset to which this message relates.
-     * {@link Asset.id}
-     */
-    assetId: ulong;
-    /**
-     * The asset to which this message relates.
-     * {@link Asset.id}
-     */
-    get asset(): Asset;
-    /**
-     * The user who sent/received this message.
-     * {@link User.login}
-     */
-    userLogin: email;
-    /**
-     * The user who sent/received this message.
-     * {@link User.login}
-     */
-    get user(): User;
-    toJSON(): {
-        id: number | null;
-        v: number[];
-        company: number;
-        status: MessageStatus;
-        kind: MessageType;
-        to: string;
-        from: string;
-        body: string;
-        processed: string | null;
-        delivered: string | null;
-        subject: string;
-        asset: number;
-        user: string;
-    };
-    fromJSON(json: JsonObject, force?: boolean): boolean;
-    /**
-     * The {@link id} is the key.
-     */
-    getKey(): number;
-}

package/_publish/Messaging/MessageType.d.ts

@@ -1,33 +0,0 @@
-/**
- * The kind of protocol used for this memo.
- */
-export declare enum MessageType {
-    /**
-     * If the type of memo has not yet been determined, or there was an error determining its type.
-     */
-    unknown = "unknown",
-    /**
-     * Short Message Service (text message)
-     */
-    sms = "sms",
-    /**
-     * Email
-     */
-    email = "email",
-    /**
-     * Garmin/Magellan/etc (Personal Navigation Device)
-     */
-    pnd = "pnd",
-    /**
-     * Google Cloud Message
-     */
-    gcm = "gcm",
-    /**
-     * Apple Push Notification Service
-     */
-    apn = "apn",
-    /**
-     * WebSocket alert message
-     */
-    socket = "socket"
-}