@trakit/objects 0.0.6 → 0.0.8

package/_publish/objects/API/Geometry/Rectangle.d.ts

@@ -1,159 +0,0 @@
-import { IPoint, IRectangle, RectangleExpansion } from './Interfaces';
-import { Point } from './Point';
-import { Radial } from './Radial';
-import { Size } from './Size';
-/**
- * A four-sided box on a flat surface.
- */
-export declare class Rectangle implements IRectangle {
-    #private;
-    /**
-     * Returns a new {@link Radial} from the given object.
-     */
-    static fromJSON(rectangle: any): Rectangle;
-    /**
-     * Left-most horizontal coordinate
-     */
-    left: number;
-    /**
-     * Highest vertical coordinate.
-     */
-    top: number;
-    /**
-     * Right-most horizontal coordinate
-     */
-    right: number;
-    /**
-     * Lowest vertical coordinate
-     */
-    bottom: number;
-    /**
-     * The absolute width of this Rectangle.
-     */
-    get width(): number;
-    /**
-     * The absolute height of this Rectangle.
-     */
-    get height(): number;
-    constructor(left?: number | RectangleExpansion, top?: number | RectangleExpansion, right?: number | RectangleExpansion, bottom?: number | RectangleExpansion);
-    /**
-     * Validates the boundary and returns a string representation
-     * @param delimiter	The boundary is delimited by a comma (,) by default, but you can override with your own value (optional)
-     * @returns A string in the format of "left,top,right,bottom".
-     */
-    toString(delimiter?: string): string;
-    /**
-     * Creates a literal of this {@link Rectangle}.
-     * Used internally by {@link JSON.stringify}.
-     */
-    toJSON(): IRectangle;
-    /**
-     * Compares this Rectangle to another to see if they are equal.
-     * @param rect	The other Rectangle to compare.
-     * @param precision	The degree of precision to use; default is full precision.
-     */
-    isEqual(rect: IRectangle, precision?: number): rect is IRectangle;
-    /**
-     * Checks to see if the bounds are valid (not inside-out).
-     */
-    isValid(): boolean;
-    /**
-     * Checks to see if the bounds are valid, and that the corners are different coordinates.
-     */
-    isEmpty(): boolean;
-    /**
-     * Determines if the given {@link IPoint} is contained by this {@link Rectangle}.
-     * @param dot
-     */
-    contains(dot: IPoint): boolean;
-    /**
-     * Determines if the given {@link IRectangle} is overlaps this {@link Rectangle} in any way
-     * @param rect
-     */
-    overlaps(rect: IRectangle): boolean;
-    /**
-     * Validates the boundary and creates a duplicate of this {@link Rectangle}.
-     */
-    copy(): Rectangle;
-    /**
-     * Returns the {@link Point} at the centre.
-     */
-    getCentre(): Point;
-    /**
-     * Validates the boundary and creates a {@link Size} representation.
-     */
-    getSize(): Size;
-    /**
-     * Returns the {@link Point} at the top-most/left-most corner.
-     */
-    getTopLeft(): Point;
-    /**
-     * Returns the {@link Point} at the top-most/right-most corner.
-     */
-    getTopRight(): Point;
-    /**
-     * Returns the {@link Point} at the bottom-most/left-most corner.
-     */
-    getBottomLeft(): Point;
-    /**
-     * Returns the {@link Point} at the bottom-most/right-most corner.
-     */
-    getBottomRight(): Point;
-    /**
-     * Validates the boundary by ensuring the top value is less than the bottom value,
-     * and the left value is less than the right value.
-     * Also adjusts the width and height values.
-     */
-    validate(): this;
-    /**
-     * Extends the boundary to envelop the given point(s) but does not automatically validate.
-     * This comes in efficient when doing many operations on a single {@link Rectangle}.
-     * @param object	The objects used to extend the boundary
-     */
-    expand(object: RectangleExpansion): this;
-    /**
-     * Extends the boundary to envelop the given point(s) and automatically validates
-     * @param object	The objects used to extend the boundary
-     */
-    extend(object: RectangleExpansion): this;
-    /**
-     * Increases the size of the boundary by the given width and height.
-     * If the direction contains the word "top", the {@link Rectangle#top} decreases by the given height.
-     * If the direction contains the word "bottom", the {@link Rectangle#bottom} increases by the given height.
-     * If the direction does not contain either "top" or "bottom", the {@link Rectangle#top} decreases by half the given height, and the {@link Rectangle#bottom} increases by half the given height.
-     * If the direction contains the word "left", the {@link Rectangle#left} decreases by the given width.
-     * If the direction contains the word "right", the {@link Rectangle#right} increases by the given width.
-     * If the direction does not contain either "left" or "right", the {@link Rectangle#left} decreases by half the given width, and the {@link Rectangle#right} increases by half the given height.
-     * @param width
-     * @param height
-     * @param direction
-     */
-    grow(width?: number, height?: number, direction?: string): this;
-    /**
-     * Updates this {@link Rectangle} with the given angle and distance.
-     * @param distance
-     * @param degrees
-     */
-    translateTo(distance: number, degrees: number): this;
-    /**
-     * Updates this {@link Rectangle} with the given offset.
-     * @param dot
-     */
-    offsetTo(dot: IPoint): this;
-    /**
-     * Creates a new {@link Rectangle} at the given angle and distance.
-     * @param distance
-     * @param degrees
-     */
-    toTranslated(distance: number, degrees: number): Rectangle;
-    /**
-     * Creates a new {@link Rectangle} offset by the given amounts.
-     * @param dot
-     */
-    toOffset(dot: IPoint): Rectangle;
-    /**
-     * Validates the boundary and returns a {@link Radial}.
-     * @param clip	If true, [()], if false ([]).
-     */
-    toRadial(clip?: boolean): Radial;
-}

package/_publish/objects/API/Geometry/Size.d.ts

@@ -1,58 +0,0 @@
-import { JsonObject } from '../Types';
-import { ISize } from './Interfaces';
-/**
- * Dimensions on a flat surface.
- */
-export declare class Size implements ISize {
-    /**
-     *
-     * @param json
-     * @returns
-     */
-    static fromJSON(json: ISize | JsonObject): Size;
-    /**
-     * Width.
-     */
-    width: number;
-    /**
-     * Height.
-     */
-    height: number;
-    constructor(width: number, height: number);
-    /**
-     * Returns a string representation.
-     * @param delimiter The boundary is delimited by a comma (,) by default, but you can override with your own value.
-     * @returns A string in the format of "width,height".
-     */
-    toString(delimiter?: string): string;
-    /**
-     * Creates a literal of this {@link Size}.
-     * Used internally by {@link JSON.stringify}.
-     */
-    toJSON(): ISize;
-    /**
-     * Compares this Size to another to see if they are equal
-     * @param size		The other Size to compare
-     * @param precision	The degree of precision to use; default is full precision
-     */
-    isEqual(size: ISize, precision?: number): size is ISize;
-    /**
-     * Returns a new instance of a {@link Size} where the width and height are adjusted to the given ratios.
-     * If the second ratio is not given, then the first value is used for both.
-     * The ratios are given as a percentage between 0 and 1.
-     * To double the size of the Size, give a ratio of 2, and to shrink it to half size use 0.5.
-     * @param ratioX
-     * @param ratioY
-     */
-    resize(ratioX?: number, ratioY?: number): Size;
-    /**
-     * Returns a new {@link Size} where the width is the same as the given value, and the height is resized to preserve aspect ratio.
-     * @param width
-     */
-    resizeToWidth(width: number): Size;
-    /**
-     * Returns a new {@link Size} where the height is the same as the given value, and the width is resized to preserve aspect ratio.
-     * @param height
-     */
-    resizeToHeight(height: number): Size;
-}

package/_publish/objects/API/Guid.d.ts

@@ -1,4 +0,0 @@
-/**
- * Delivers a GUID-like string with a mixed in location/refresh unique seed
- */
-export declare function GUID(): string;

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

@@ -1,11 +0,0 @@
-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/_publish/objects/API/Interfaces/IBelongAsset.d.ts

@@ -1,15 +0,0 @@
-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/_publish/objects/API/Interfaces/IBelongBillingProfile.d.ts

@@ -1,15 +0,0 @@
-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/_publish/objects/API/Interfaces/IBelongCompany.d.ts

@@ -1,15 +0,0 @@
-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/_publish/objects/API/Interfaces/IDeserializable.d.ts

@@ -1,13 +0,0 @@
-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/_publish/objects/API/Interfaces/IEnabled.d.ts

@@ -1,10 +0,0 @@
-/**
- * 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/_publish/objects/API/Interfaces/IFileSize.d.ts

@@ -1,9 +0,0 @@
-/**
- * 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/_publish/objects/API/Interfaces/IGlobal.d.ts

@@ -1,11 +0,0 @@
-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/_publish/objects/API/Interfaces/IHavePermissions.d.ts

@@ -1,20 +0,0 @@
-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/_publish/objects/API/Interfaces/IHavePreferences.d.ts

@@ -1,29 +0,0 @@
-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/_publish/objects/API/Interfaces/IIconic.d.ts

@@ -1,15 +0,0 @@
-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/_publish/objects/API/Interfaces/IIdUlong.d.ts

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

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

@@ -1,10 +0,0 @@
-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/_publish/objects/API/Interfaces/INamed.d.ts

@@ -1,13 +0,0 @@
-/**
- * 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/_publish/objects/API/Interfaces/IPictured.d.ts

@@ -1,15 +0,0 @@
-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/_publish/objects/API/Interfaces/IRequestable.d.ts

@@ -1,22 +0,0 @@
-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/_publish/objects/API/Interfaces/ISerializable.d.ts

@@ -1,10 +0,0 @@
-/**
- * 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/_publish/objects/API/Interfaces/ISuspendable.d.ts

@@ -1,16 +0,0 @@
-/**
- * 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/_publish/objects/API/Interfaces/IVisual.d.ts

@@ -1,18 +0,0 @@
-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/_publish/objects/API/Maps.d.ts

@@ -1,28 +0,0 @@
-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/_publish/objects/API/SearchPattern.d.ts

@@ -1,46 +0,0 @@
-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/_publish/objects/API/Timezones.d.ts

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

package/_publish/objects/Accounts/NotificationMethod.d.ts

@@ -1,17 +0,0 @@
-/**
- * The types of alerts used.
- */
-export declare enum NotificationMethod {
-    /**
-     * A separate message sent across the WebSocket.
-     */
-    popup = "popup",
-    /**
-     * A text message (SMS).
-     */
-    sms = "sms",
-    /**
-     * Carrier pigeon.
-     */
-    email = "email"
-}