@trakit/objects 0.0.15 → 0.0.16

package/objects/API/Interfaces/IAmCompany.d.ts

@@ -0,0 +1,11 @@
+import { ulong } from '../Types';
+import { IIdUlong } from './IIdUlong';
+/**
+ * An interface for all the Company___ classes.
+*/
+export interface IAmCompany extends IIdUlong {
+    /**
+     * The {@link Company} to which this {@link Company} belongs.
+     */
+    parentId: ulong;
+}

package/objects/API/Interfaces/IBelongAsset.d.ts

@@ -0,0 +1,15 @@
+import { Asset } from "../../Assets/Asset";
+import { ulong } from "../Types";
+/**
+ * An interface for objects that belong to a single asset.
+*/
+export interface IBelongAsset {
+    /**
+     * The {@link Asset.id} to which this object belongs.
+     */
+    assetId: ulong;
+    /**
+     * The {@link Asset} to which this object belongs.
+     */
+    get asset(): Asset;
+}

package/objects/API/Interfaces/IBelongBillingProfile.d.ts

@@ -0,0 +1,15 @@
+import { BillingProfile } from "../../Billing/BillingProfile";
+import { ulong } from "../Types";
+/**
+ * An interface for objects that belong to a single billing profile.
+*/
+export interface IBelongBillingProfile {
+    /**
+     * The {@link BillingProfile} to which this object belongs.
+     */
+    get profileId(): ulong;
+    /**
+     * The {@link BillingProfile} to which this object belongs.
+     */
+    readonly profile: BillingProfile;
+}

package/objects/API/Interfaces/IBelongCompany.d.ts

@@ -0,0 +1,15 @@
+import { ulong } from "../Types";
+import { Company } from "../../Companies/Company";
+/**
+ * An interface for objects that belong to a single company.
+*/
+export interface IBelongCompany {
+    /**
+     * The {@link Company} to which this object belongs.
+     */
+    get companyId(): ulong;
+    /**
+     * The {@link Company} to which this object belongs.
+     */
+    get company(): Company;
+}

package/objects/API/Interfaces/IDeserializable.d.ts

@@ -0,0 +1,13 @@
+import { JsonObject } from "../../API/Types";
+/**
+ * An interface for types that are updated using JSON values.
+ */
+export interface IDeserializable {
+    /**
+     * Updates this {@link IDeserializable} from the given input.
+     * @param json      A JSON value used to update this class.
+     * @param forced    When true, forces the update.
+     * @returns True when an update was completed.
+     */
+    fromJSON(json: JsonObject, force?: boolean): boolean;
+}

package/objects/API/Interfaces/IEnabled.d.ts

@@ -0,0 +1,10 @@
+/**
+ * An interface for objects that can be marked as "enabled".
+ * "Enabled" objects remain in the system, but are inactive.
+*/
+export interface IEnabled {
+    /**
+     * Marked as true for objects that have been deleted.
+     */
+    enabled: boolean;
+}

package/objects/API/Interfaces/IFileSize.d.ts

@@ -0,0 +1,9 @@
+/**
+ * An interface for an object's size on a disk.
+*/
+export interface IFileSize {
+    /**
+     * Size (in bytes) of the object on the HDD or SSD.
+     */
+    bytes: number;
+}

package/objects/API/Interfaces/IGlobal.d.ts

@@ -0,0 +1,11 @@
+import { IBelongCompany } from './IBelongCompany';
+/**
+ * An interface for objects that can be marked as "global".
+ * "Global" objects can be listed in child companies.
+*/
+export interface IGlobal extends IBelongCompany {
+    /**
+     * Indicates whether this icon is available to child companies.
+     */
+    global: boolean;
+}

package/objects/API/Interfaces/IHavePermissions.d.ts

@@ -0,0 +1,20 @@
+import { Permission } from '../../Accounts/Permissions/Permission';
+import { UserGroup } from '../../Accounts/UserGroup';
+import { ulong } from '../Types';
+/**
+ * This interface exists so that I can work with Machine and UserAdvanced objects the same way.
+*/
+export interface IHavePermissions {
+    /**
+     * A list of groups to which this object.
+     */
+    get groups(): UserGroup[];
+    /**
+     * A list of groups to which this object.
+     */
+    groupIds: ulong[];
+    /**
+     * Permission rules which override the group rules.
+     */
+    permissions: Permission[];
+}

package/objects/API/Interfaces/IHavePreferences.d.ts

@@ -0,0 +1,29 @@
+import { SystemsOfUnits } from '../../Accounts/SystemsOfUnits';
+import { Timezone } from '../Timezone';
+import { codified } from '../Types';
+/**
+ * This interface exists so that I can work with Machine and UserGeneral objects the same way.
+*/
+export interface IHavePreferences {
+    /**
+     * The local timezone for this object.
+     */
+    timezone: Timezone;
+    /**
+     * Preferred region/language for the UI and notifications.
+     * Valid formats use <ISO 639-1><dash><ISO 3166-2> such as "fr-CA" or "en-US".
+     */
+    language: codified;
+    /**
+     * The format strings defining the preferred way to display ambiguous values.
+     */
+    formats: Map<codified, string>;
+    /**
+     * Preferred way of displaying ambiguous numbers in the context of measurements.
+     */
+    measurements: Map<codified, SystemsOfUnits>;
+    /**
+     * Additional options which do not fit in with the formats or measurements preferences.
+     */
+    options: Map<codified, string>;
+}

package/objects/API/Interfaces/IIconic.d.ts

@@ -0,0 +1,15 @@
+import { Icon } from '../../Images/Icon';
+import { ulong } from '../Types';
+/**
+ * An interface for objcts that have an "icon".
+*/
+export interface IIconic {
+    /**
+     * This thing's {@link Icon.id}.
+     */
+    iconId: ulong;
+    /**
+     * This thing's {@link Icon}.
+     */
+    get icon(): Icon;
+}

package/objects/API/Interfaces/IIdUlong.d.ts

@@ -0,0 +1,10 @@
+import { ulong } from '../Types';
+/**
+ * An interface for objects with a ulong "id".
+*/
+export interface IIdUlong {
+    /**
+     * Unique identifier of this object.
+     */
+    id: ulong;
+}

package/objects/API/Interfaces/ILabelled.d.ts

@@ -0,0 +1,10 @@
+import { codified } from "../Types";
+/**
+ * An interface for objects that have "labels".
+*/
+export interface ILabelled {
+    /**
+     * A list of codified labels for this asset or place.
+     */
+    labels: codified[];
+}

package/objects/API/Interfaces/INamed.d.ts

@@ -0,0 +1,13 @@
+/**
+ * An interface for objects that have a "name" and "notes".
+*/
+export interface INamed {
+    /**
+     * This thing's name.
+     */
+    name: string;
+    /**
+     * This thing's notes.
+     */
+    notes: string;
+}

package/objects/API/Interfaces/IPictured.d.ts

@@ -0,0 +1,15 @@
+import { ulong } from '../Types';
+import { Picture } from '../../Images/Picture';
+/**
+ * An interface for objects that have "pictures".
+*/
+export interface IPictured {
+    /**
+     * An array of picture identifiers of this object.
+     */
+    pictureIds: ulong[];
+    /**
+     * An array of {@link Picture}s of this object.
+     */
+    get pictures(): Picture[];
+}

package/objects/API/Interfaces/IRequestable.d.ts

@@ -0,0 +1,22 @@
+import { codified, email, guid, ulong } from "../Types";
+/**
+ * The main interface for an object in the Trak-iT system.
+*/
+export interface IRequestable {
+    /**
+     * Returns a unique identifier as a string.
+     * {@link Dashcam.guid}
+     * {@link IIdUlong.id}
+     * {@link Machine.key}
+     * {@link Provider.id}
+     * {@link ProviderGeneral.id}
+     * {@link ProviderAdvanced.id}
+     * {@link ProviderControl.id}
+     * {@link ProviderRegistration.code}
+     * {@link User.login}
+     * {@link UserGeneral.login}
+     * {@link UserAdvanced.login}
+     * {@link Timezone.code}
+     */
+    getKey(): ulong | email | guid | codified | string;
+}

package/objects/API/Interfaces/ISerializable.d.ts

@@ -0,0 +1,10 @@
+/**
+ * An interface for types that can be converted to JSON for transmission or storage.
+ */
+export interface ISerializable {
+    /**
+     * Creates a literal of this {@link ISerializable} object.
+     * Used internally by {@link JSON.stringify}.
+     */
+    toJSON(): any;
+}

package/objects/API/Interfaces/ISuspendable.d.ts

@@ -0,0 +1,16 @@
+/**
+ * An interface for objects that can be marked as "suspended".
+ * "Suspended" objects can be "revived", but are otherwise treated as "achived" or "inert" (events are not processed).
+*/
+export interface ISuspendable {
+    /**
+     * Marked as true for objects that have been suspended.
+     * This value is not present in the JSON scheme when {@link deleted} is false.
+     */
+    suspended?: boolean;
+    /**
+     * A timestamp from when the object was most recently suspended or revived.
+     * This value is not present in the JSON scheme when {@link suspended} is false.
+     */
+    since?: Date;
+}

package/objects/API/Interfaces/IVisual.d.ts

@@ -0,0 +1,18 @@
+import { codified, colour } from "../Types";
+/**
+ * An interface for objects that make them more easily visually identifiable.
+*/
+export interface IVisual {
+    /**
+     * The background colour of the graphic.
+     */
+    fill: colour;
+    /**
+     * Outline and graphic colour.
+     */
+    stroke: colour;
+    /**
+     * The name of the symbol for this object.
+     */
+    graphic: codified;
+}

package/objects/API/Maps.d.ts

@@ -0,0 +1,28 @@
+import { IBelongAsset } from './Interfaces/IBelongAsset';
+import { IBelongBillingProfile } from './Interfaces/IBelongBillingProfile';
+import { IBelongCompany } from './Interfaces/IBelongCompany';
+import { ulong } from './Types';
+/**
+ * Returns an array of values where the {@link Map}'s key is present in the {@link keys} array.
+ * @param map   Map of objects to filter.
+ * @param keys  Array of keys to select.
+ */
+export declare function MAP_FILTERED_BY_KEYS<K, T>(map: Map<K, T>, keys: K[]): T[];
+/**
+ * Returns an array of values where the `value.companyId` matches the given {@link companyId}.
+ * @param map       Map of objects to filter.
+ * @param companyId {@link Company.id} used to filter.
+ */
+export declare function MAP_FILTERED_BY_COMPANY<K, T extends IBelongCompany>(map: Map<K, T>, companyId: ulong): T[];
+/**
+ * Returns an array of values where the `value.assetId` matches the given {@link assetId}.
+ * @param map     Map of objects to filter.
+ * @param assetId {@link Asset.id} used to filter.
+ */
+export declare function MAP_FILTERED_BY_ASSET<K, T extends IBelongAsset>(map: Map<K, T>, assetId: ulong): T[];
+/**
+ * Returns an array of values where the `value.profileId` matches the given {@link profileId}.
+ * @param map       Map of objects to filter.
+ * @param profileId {@link BillingProfile.id} used to filter.
+ */
+export declare function MAP_FILTERED_BY_BILLING<K, T extends IBelongBillingProfile>(map: Map<K, T>, profileId: ulong): T[];

package/objects/API/Objects.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Used internally by {@link MERGE}.
+ * @param value
+ */
+export declare function MERGE_INTERNAL(value: any): any;

package/objects/API/SearchPattern.d.ts

@@ -0,0 +1,46 @@
+import { nothing } from './Types';
+/**
+ * A common structure used to implement searching throughout the system.
+ * The input format is described in the {@link /wss/#format-expression|WebSocket reference}.
+ */
+export declare class SearchPattern {
+    /**
+     * Creates an array of {@link SearchPattern}s for easier matching.  Used for doing OR matching.
+     * @param expression
+     */
+    static parse(expression?: string | nothing): SearchPattern[];
+    /**
+     * Creates a single string from the given array of {@link SearchPattern}s for easier serialization.
+     * @param patterns
+     */
+    static stringify(patterns?: SearchPattern[] | nothing): string | null;
+    /**
+     * To help qualify matches, all operators must match for the search to be
+     * considered matched.
+     * Operators are formatted as "operator:terms".
+     */
+    operators: Map<string, string[]>;
+    /**
+     * If any term matches, then the search should be considered matched.
+     * Terms are any string contained by single/double-quotes or not parsed as an
+     * operator.
+     */
+    terms: string[];
+    constructor(pattern?: string);
+    /**
+     * True when this pattern will match all.
+     */
+    get wildcard(): boolean;
+    /**
+     * Returns a re-parseable string representation of the pattern.
+     */
+    toString(): string;
+    /**
+     *
+     */
+    toJSON: () => string;
+    /**
+     * Returns a new, identical instance of the pattern.
+     */
+    copy(): SearchPattern;
+}

package/objects/API/TimeSpan.d.ts

@@ -0,0 +1,109 @@
+import { nothing, timespan } from "./Types";
+/**
+ * An object which represents an interval of time.
+ */
+export declare class TimeSpan {
+    #private;
+    /**
+     * Constructs a new TimeSpan with the value specified in days.
+     */
+    static fromDays(value: number): TimeSpan;
+    /**
+     * Constructs a new TimeSpan with the value specified in hours.
+     */
+    static fromHours(value: number): TimeSpan;
+    /**
+     * Constructs a new TimeSpan with the value specified in minutes.
+     */
+    static fromMinutes(value: number): TimeSpan;
+    /**
+     * Constructs a new TimeSpan with the value specified in seconds.
+     */
+    static fromSeconds(value: number): TimeSpan;
+    /**
+     * Constructs a new TimeSpan with the value specified in milliseconds.
+     */
+    static fromMilliseconds(value: number): TimeSpan;
+    /**
+     * @param duration		A time-span formatted string, or a number representing milliseconds
+     */
+    constructor(duration?: TimeSpan | timespan | number | nothing);
+    /**
+     * Days component of the time-span.
+     */
+    get days(): number;
+    /**
+     * Hours component of the time-span.
+     */
+    get hours(): number;
+    /**
+     * Minutes component of the time-span.
+     */
+    get minutes(): number;
+    /**
+     * Seconds component of the time-span.
+     */
+    get seconds(): number;
+    /**
+     * Millisecond component of the time-span.
+     */
+    get milliseconds(): number;
+    /**
+     * Total time-span value in decimal days.
+     */
+    get totalDays(): number;
+    /**
+     * Total time-span value in decimal hours.
+     */
+    get totalHours(): number;
+    /**
+     * Total time-span value in decimal minutes.
+     */
+    get totalMinutes(): number;
+    /**
+     * Total time-span value in decimal seconds.
+     */
+    get totalSeconds(): number;
+    /**
+     * Total time-span value in milliseconds.
+     */
+    get totalMilliseconds(): number;
+    /**
+     * Parses the time-span into a serialized TimeSpan string.
+     * The format follows the {@link timespan} definition.
+     * @param format	Use format strings like "HH:mm" for just hours and minutes.  Valid flags are d, h, H, m, s, and f.  If you use
+     */
+    toString(format?: timespan): timespan;
+    /**
+     * Same as {@link TimeSpan#toString}.
+     */
+    toJSON: (format?: timespan) => timespan;
+    /**
+     * Gets the comparable value of this time-span as total milliseconds.
+     */
+    valueOf(): number;
+    /**
+     * Adds the given value to the current time-span.
+     * @param duration	A time-span formatted string, or a number representing milliseconds
+     * @param subtract	When true, the value is subtracted from the time-span instead of added.
+     */
+    add(duration: TimeSpan | timespan | number, subtract?: boolean): number;
+    /**
+     * Subtracts the given value from the time-span.
+     * @param duration	A time-span formatted string, or a number representing milliseconds
+     * @param add		When true, the value is added from the time-span instead of subtracted.
+     */
+    subtract(duration: TimeSpan | timespan | number, add?: boolean): number;
+}
+/**
+ * Parses a serialized TimeSpan into a number representing the total seconds.
+ * For example the string "1.07:42:03.467" equals 114123.467, which is 1 day, 7 hours, 42 minutes, 3 seconds, and 467 milliseconds.
+ * @param duration	A valid timespan string.  The format is [-]( d | [d.]hh:mm[:ss[.fff]] )
+ */
+export declare function TIMESPAN_PARSE(duration: TimeSpan | timespan | number): number;
+/**
+ * Parses a number representing the total seconds into a serialized TimeSpan string.
+ * For example the number 114123.467 would be serialized as "1.07:42:03.467".
+ * @param value		Use a decimal to show milliseconds.
+ */
+export declare function TIMESPAN_STRINGIFY(value: number): timespan;

package/objects/API/Timezone.d.ts

@@ -0,0 +1,44 @@
+import { IRequestable } from "./Interfaces/IRequestable";
+import { ISerializable } from "./Interfaces/ISerializable";
+import { short, JsonObject } from "./Types";
+/**
+ * Timezone definition
+*/
+export declare class Timezone implements IRequestable, ISerializable {
+    /**
+     *
+     * @param json
+     */
+    static fromJSON(json: JsonObject): Timezone;
+    /**
+     *
+     */
+    static utc: Timezone;
+    /**
+     * Unique timezone code
+     */
+    code: string;
+    /**
+     * Common timezone name
+     */
+    name: string;
+    /**
+     * Minutes offset from GMT
+     */
+    offset: short;
+    /**
+     * Indicates whether this timezone abides by daylight savings
+     */
+    dst: boolean;
+    constructor(code: string, name?: string, offset?: short, dst?: boolean);
+    toJSON(): {
+        code: string;
+        name: string;
+        offset: number;
+        dst: boolean;
+    };
+    /**
+     * The {@link code} is the key.
+     */
+    getKey(): string;
+}

package/objects/API/Timezones.d.ts

@@ -0,0 +1,7 @@
+import { Timezone } from './Timezone';
+import { codified } from './Types';
+/**
+ *
+ * @param code
+ */
+export declare function TIMEZONE_FIND(code: codified): Timezone | undefined;