@trakit/objects 0.0.5 → 0.0.7

package/README.md

@@ -0,0 +1,24 @@
+# Trak-iT API Object Model
+
+All of the Trak-iT APIs use the same object definitions.
+Other Trak-iT API libraries are available on [GitHub](https://github.com/trakitwireless) and [npm](https://www.npmjs.com/org/trakit).
+
+### Prerequisites
+
+We do not require any other packages, however, we are targetting `ESNext`, so if your project uses CommonJS or another module manager, you will need to account for that yourself.
+
+### Building
+
+In order to build this project, you need to install the RollupJS, and plugins for TypeScript and Minifying.
+```
+npm i rollup rollup-plugin-typescript2 @rollup/plugin-terser
+```
+After those have been installed, build the project normally.
+```
+rollup --config rollup.config.js
+```
+
+## Questions and Feedback
+
+If you have any questions, please start for the project on GitHub
+https://github.com/trakitwireless/trakit-ts-objects/issues

package/{API → _publish/API}/Arrays.d.ts

@@ -44,3 +44,4 @@ export declare function ARRAY_TO_ENUMS<T>(type: any, array: string[]): T[];
  * @param index		The index of the obect in the source array.
  */
 export declare function FILTER_BY_BOOLEAN_ARRAY(this: boolean[], object: unknown, index: number): boolean;
+//# sourceMappingURL=Arrays.d.ts.map

package/{API → _publish/API}/Base.d.ts

@@ -17,3 +17,4 @@ export declare abstract class Base implements IDeserializable {
      */
     abstract fromJSON(json: JsonObject, force?: boolean): boolean;
 }
+//# sourceMappingURL=Base.d.ts.map

package/{API → _publish/API}/BaseComponent.d.ts

@@ -38,3 +38,4 @@ export declare abstract class BaseComponent extends Base implements IRequestable
      */
     abstract toJSON(): any;
 }
+//# sourceMappingURL=BaseComponent.d.ts.map

package/{API → _publish/API}/BaseCompound.d.ts

@@ -17,3 +17,4 @@ export declare abstract class BaseCompound extends BaseComponent {
      */
     get v(): int[];
 }
+//# sourceMappingURL=BaseCompound.d.ts.map

package/{API → _publish/API}/Codifier.d.ts

@@ -13,3 +13,4 @@ export declare function CODIFY(input: string): codified;
  * @param suffix	Added to the end of each of the {@code terms}.
  */
 export declare function HIGHLIGHT(input: string, terms: codified[], [prefix, suffix]?: [string, string]): string;
+//# sourceMappingURL=Codifier.d.ts.map

package/{API → _publish/API}/Constants.d.ts

@@ -37,3 +37,4 @@ export declare const HALF_PI: number, RADIANS_TO_DEGREES: number, DEGREES_TO_RAD
  *
  */
 export declare const WIN: typeof globalThis, DOC: Document, LOC: Location;
+//# sourceMappingURL=Constants.d.ts.map

package/{API → _publish/API}/Conversion.d.ts

@@ -5,7 +5,7 @@
  * @param number
  * @param fromUnit
  * @param toUnit
- **/
+ */
 export declare function CONVERT_FROM_TO(number: number, fromUnit: string, toUnit: string): number;
 /**
  * Value in square meters converted to square feet.
@@ -200,7 +200,7 @@ export declare function CONVERT_BETWEEN_MPGUK_AND_L100KM(fuelEconomy: number): n
 /**
  * Returns the corollary of either miles per kilowatt hour or kilowatt hour per 100 kilometres.
  * @param electricEconomy
- **/
+ */
 export declare function CONVERT_BETWEEN_MPKWH_AND_KWH100KM(electricEconomy: number): number;
 export declare const CONVERT: {
     fromTo: typeof CONVERT_FROM_TO;
@@ -253,3 +253,4 @@ export declare const CONVERT: {
     tToTonUK: typeof CONVERT_TONNE_TO_TON_UK;
     tonUKToT: typeof CONVERT_TON_UK_TO_TONNE;
 };
+//# sourceMappingURL=Conversion.d.ts.map

package/{API → _publish/API}/Encoding.d.ts

@@ -7,3 +7,4 @@ export declare function PASSWORD_ENCODE(value: string): string;
  * @param value
  * */
 export declare function PASSWORD_DECODE(value: string): string;
+//# sourceMappingURL=Encoding.d.ts.map

package/{API → _publish/API}/Files.d.ts

@@ -19,3 +19,4 @@ export declare function NUMBER_GROUPS(number: number, size?: number, delimiter?:
  * @param point				Character(s) to use to divide the integer groups from the decimal groups. The detauls is ".".
  * */
 export declare function FILESIZE_HELPER(bytes: number, places?: number, maxScale?: string, groupSize?: number, groupDelimiter?: string, decimalDelimiter?: string, point?: string): string;
+//# sourceMappingURL=Files.d.ts.map

package/{API → _publish/API}/Functions.d.ts

@@ -194,3 +194,4 @@ export declare function WEEKDAYS_PARSE(days: string | boolean[]): boolean[];
  * Creates as string of 7 characters (either `1` or `0`).
  */
 export declare function WEEKDAYS_JSON(days: string | boolean[]): string;
+//# sourceMappingURL=Functions.d.ts.map

package/{API → _publish/API}/Guid.d.ts

@@ -2,3 +2,4 @@
  * Delivers a GUID-like string with a mixed in location/refresh unique seed
  */
 export declare function GUID(): string;
+//# sourceMappingURL=Guid.d.ts.map

package/{API → _publish/API}/Maps.d.ts

@@ -26,3 +26,4 @@ export declare function MAP_FILTERED_BY_ASSET<K, T extends IBelongAsset>(map: Ma
  * @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[];
+//# sourceMappingURL=Maps.d.ts.map

package/{API → _publish/API}/Objects.d.ts

@@ -3,3 +3,4 @@
  * @param value
  */
 export declare function MERGE_INTERNAL(value: any): any;
+//# sourceMappingURL=Objects.d.ts.map

package/{API → _publish/API}/SearchPattern.d.ts

@@ -44,3 +44,4 @@ export declare class SearchPattern {
      */
     copy(): SearchPattern;
 }
+//# sourceMappingURL=SearchPattern.d.ts.map

package/{API → _publish/API}/TimeSpan.d.ts

@@ -107,3 +107,4 @@ export declare function TIMESPAN_PARSE(duration: TimeSpan | timespan | number):
  * @param value		Use a decimal to show milliseconds.
  */
 export declare function TIMESPAN_STRINGIFY(value: number): timespan;
+//# sourceMappingURL=TimeSpan.d.ts.map

package/{API → _publish/API}/Timezone.d.ts

@@ -42,3 +42,4 @@ export declare class Timezone implements IRequestable, ISerializable {
      */
     getKey(): string;
 }
+//# sourceMappingURL=Timezone.d.ts.map

package/{API → _publish/API}/Timezones.d.ts

@@ -5,3 +5,4 @@ import { codified } from './Types';
  * @param code
  */
 export declare function TIMEZONE_FIND(code: codified): Timezone | undefined;
+//# sourceMappingURL=Timezones.d.ts.map

package/{API → _publish/API}/Types.d.ts

@@ -1,120 +1,120 @@
 /**
  * Represents the absence of a value.
- **/
+ */
 export type nothing = undefined | null;
 /**
  * 8bit integer
  * @example minimum value (-128) to maximum value (127)
- **/
+ */
 export type sbyte = number;
 /**
  * 16bit integer
  * @example minimum value (-32768) to maximum value (32767)
- **/
+ */
 export type short = number;
 /**
  * 32bit integer
  * @example minimum value (-2147483648) to maximum value (2147483647)
- **/
+ */
 export type int = number;
 /**
  * 64bit integer
  * @example minimum value (-9223372036854775808) to maximum value (9223372036854775807)
- **/
+ */
 export type long = number;
 /**
  * 8bit unsigned integer
  * @example minimum value (0) to maximum value (255)
- **/
+ */
 export type byte = number;
 /**
  * 16bit unsigned integer
  * @example minimum value (0) to maximum value (65535)
- **/
+ */
 export type ushort = number;
 /**
  * 32bit unsigned integer
  * @example minimum value (0) to maximum value (4294967295)
- **/
+ */
 export type uint = number;
 /**
  * 64bit unsigned integer
  * @example minimum value (0) to maximum value (18446744073709551615)
- **/
+ */
 export type ulong = number;
 /**
  * Single-precision floating point number
  * @example minimum value (-3.40282347E+38F) to maximum value (3.40282347E+38F)
- **/
+ */
 export type single = number;
 /**
  * Double-precision floating point number
  * @example minimum value (-1.7976931348623157e+308) to maximum value (1.7976931348623157e+308)
- **/
+ */
 export type double = number;
 /**
  * A phone number for a phone in Canada or the United States of America. All phone numbers start with a 1 and are eleven digits long.
  * @example "[1]AAALLLSSSS"
- **/
+ */
 export type phone = number;
 /**
  * A lower-case string with all the apostrophes and quotation marks [`"`, `'`, ```, `“`, and `”`] removed, and all non-alphanumeric character sequences replaced with a single minus sign.  Diacritics such as `®`, `é`, and `ç` are also replaced with their alhpabetic equivalents (`r`, `e`, and `c`).
- **/
+ */
 export type codified = string;
 /**
  * A string that contains only a valid CSS colour.
  * More: {@link https://developer.mozilla.org/en-US/docs/Web/CSS/color_value}
- **/
+ */
 export type colour = string;
 /**
  * A serialized-string representation of a date and time in ISO-8601 format.  Square brackets `[]` are used to show optional format information. All other non-alphabetic characters are required.
  * @example "yyyy-MM-ddTHH:mm:ss[.fff]Z"
- **/
+ */
 export type datetime = string;
 /**
  * These formats define the text representation of dates and times.
- **/
+ */
 export type datetimetemplate = string;
 /**
  * An email address identifies a mailbox to which messages are delivered. We follow the `RFC 2822` pattern for addresses.
  * More: {@link https://tools.ietf.org/html/rfc2822}
  * @example "user@domain.tld"
- **/
+ */
 export type email = string;
 /**
  * A targeting pattern is a string that represents an in-the-moment search for objects. The operators used depend entirely on the context of the search, and compatibility with the sub-system.
  * More: {@link https://fleetfreedom.freshdesk.com/en/support/solutions/articles/3000061325-advanced-search-options}
  * @example "operator:terms terms"
- **/
+ */
 export type expression = string;
 /**
  * Globally/Universally Unique Identifier. It is a 36 character long string made up of letters, numbers, and dashes. The letters can be transmitted as upper-case, lower-case, or a combination.
  * More: {@link https://docs.microsoft.com/en-us/dotnet/api/system.guid?view=net-5.0}
  * @example "xxxxxxxx-xxxx-4xxx-xxxx-xxxxxxxxxxxx"
- **/
+ */
 export type guid = string;
 /**
  * A serialized-string representation of an IPv4 Address.  Square brackets `[]` are used to show optional format information. All other non-alphabetic characters are required.
  * @example "n.n.n.n[/r]"
- **/
+ */
 export type ipv4 = string;
 /**
  * The algorithm is a lossy compression that stores a series of coordinates as a single string. All coordinates are rounded to six decimal places before encoding, but this should be accurate to within roughly one and a half meters.
  * More: {@link https://developers.google.com/maps/documentation/utilities/polylinealgorithm}
- **/
+ */
 export type polyline = string;
 /**
  * A serialized-string representation of a duration of time.  There are two possible formats when using a duration string.  Square brackets `[]` are used to show optional format information. All other non-alphabetic characters are required.
  * @example "[-][d.]H:mm[:ss[.fff]]"
  * @example "[-]d"
- **/
+ */
 export type timespan = string;
 /**
  * Most commonly a website address, but can also be any other type of locator like `ssh:`. We follow the `RFC 1738` pattern for addresses.
  * More: {@link https://tools.ietf.org/html/rfc1738}
  * @example "http[s]://domain.tld/path?query#fragment"
  * @example "protocol:path?query"
- **/
+ */
 export type url = string;
 /**
  * A JSON object is an unordered collection of key/value pairs.
@@ -130,3 +130,4 @@ export type JsonArray = JsonValue[];
  * Any valid JSON value.
  */
 export type JsonValue = null | boolean | number | string | JsonArray | JsonObject;
+//# sourceMappingURL=Types.d.ts.map

package/{Accounts → _publish/Accounts}/Contact.d.ts

@@ -20,8 +20,7 @@ export declare class Contact extends BaseComponent implements IIdUlong, INamed,
      */
     companyId: ulong;
     /**
-     * The company to which this contact belongs
-     * {@link Company.id}
+     * The {@link Company} to which this contact belongs
      */
     get company(): Company;
     /**
@@ -78,11 +77,11 @@ export declare class Contact extends BaseComponent implements IIdUlong, INamed,
      */
     roles: codified[];
     /**
-     * {@link Picture.id}s of this Contact.
+     * {@link Picture.id}s of this {@link Contact}.
      */
     pictureIds: ulong[];
     /**
-     * {@link Picture}s of this Contact.
+     * {@link Picture}s of this {@link Contact}.
      */
     get pictures(): Picture[];
     set pictures(values: Picture[]);
@@ -138,3 +137,4 @@ export declare class Contact extends BaseComponent implements IIdUlong, INamed,
      */
     getKey(): number;
 }
+//# sourceMappingURL=Contact.d.ts.map

package/{Accounts → _publish/Accounts}/Machine.d.ts

@@ -137,3 +137,4 @@ export declare class Machine extends BaseComponent implements IEnabled, IBelongC
      */
     createHmacSignature(absoluteUri: URL | string, method?: string, contentLength?: number, date?: Date): Promise<string>;
 }
+//# sourceMappingURL=Machine.d.ts.map

package/_publish/Accounts/MultiFactorType.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Types of multi-factor authentication implementations for a {@link Company}.
+ */
+export declare enum MultiFactorType {
+    /**
+     * Use a mobile authenticator app from Apple, Google, Microsoft, or others.
+     */
+    app = "app",
+    /**
+     * Receive an SMS message with a PIN code to continue logging-in.
+     */
+    sms = "sms",
+    /**
+     * Receive an email with a PIN code to continue logging-in.
+     */
+    email = "email"
+}
+//# sourceMappingURL=MultiFactorType.d.ts.map

package/{Accounts → _publish/Accounts}/NotificationMethod.d.ts

@@ -15,3 +15,4 @@ export declare enum NotificationMethod {
      */
     email = "email"
 }
+//# sourceMappingURL=NotificationMethod.d.ts.map

package/_publish/Accounts/SSOIdentityProvider.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Supported SSO Identity Providers.
+ */
+export declare enum SSOIdentityProvider {
+    /**
+     * Google Identity Provider.
+     */
+    google = "google",
+    /**
+     * Apple Identity Provider.
+     */
+    apple = "apple",
+    /**
+     * Facebook Identity Provider.
+     */
+    facebook = "facebook",
+    /**
+     * X Identity Provider, formerly known as Twitter.
+     */
+    twitter = "twitter",
+    /**
+     * Microsoft Identity Provider.
+     */
+    microsoft = "microsoft"
+}
+//# sourceMappingURL=SSOIdentityProvider.d.ts.map

package/{Accounts → _publish/Accounts}/Session.d.ts

@@ -1,18 +1,14 @@
 import { IBelongCompany } from "../API/Interfaces/IBelongCompany";
+import { IDeserializable } from "../API/Interfaces/IDeserializable";
 import { IRequestable } from "../API/Interfaces/IRequestable";
 import { ISerializable } from "../API/Interfaces/ISerializable";
-import { datetime, int, JsonObject, ulong } from "../API/Types";
+import { int, JsonObject, nothing, ulong } from "../API/Types";
 import { Company } from "../Companies/Company";
 import { SessionStatus } from "./SessionStatus";
 /**
  * Information about another {@link User}'s {@link Session}.
  */
-export declare class Session implements IBelongCompany, IRequestable, ISerializable {
-    /**
-     *
-     * @param json
-     */
-    static fromJSON(json: JsonObject): Session;
+export declare class Session implements IBelongCompany, IRequestable, ISerializable, IDeserializable {
     /**
      * A "handle" identifying a resource.
      */
@@ -22,8 +18,7 @@ export declare class Session implements IBelongCompany, IRequestable, ISerializa
      */
     companyId: ulong;
     /**
-     * The company to which this contact belongs
-     * {@link Company.id}
+     * The {@link Company} to which this contact belongs
      */
     get company(): Company;
     /**
@@ -69,20 +64,22 @@ export declare class Session implements IBelongCompany, IRequestable, ISerializa
      * Indicator that this {@link Session} is using at least one WebSocket connection.
      */
     get active(): boolean;
-    constructor(handle?: string, company?: ulong, ipAddress?: string, userAgent?: string, sockets?: int, login?: string, status?: SessionStatus, created?: Date | number | datetime, expiry?: Date | number | datetime, lastCommand?: string, lastActivity?: Date | number | datetime);
+    constructor(json?: JsonObject | nothing);
+    fromJSON(json: JsonObject, force?: boolean): boolean;
     /**
      *
      */
     toJSON(): {
         handle: string;
+        company: number | null;
         login: string;
-        company: number;
+        status: SessionStatus;
+        userAgent: string;
+        ipAddress: string;
         created: string;
+        expires: string;
         lastActivity: string;
-        ipAddress: string;
-        userAgent: string;
         lastCommand: string;
-        active: boolean;
         sockets: number;
     };
     /**
@@ -90,3 +87,4 @@ export declare class Session implements IBelongCompany, IRequestable, ISerializa
      */
     getKey(): string;
 }
+//# sourceMappingURL=Session.d.ts.map

package/{Accounts → _publish/Accounts}/SessionStatus.d.ts

@@ -27,3 +27,4 @@ export declare enum SessionStatus {
      */
     expired = "expired"
 }
+//# sourceMappingURL=SessionStatus.d.ts.map

package/{Accounts → _publish/Accounts}/SystemsOfUnits.d.ts

@@ -11,3 +11,4 @@ export declare enum SystemsOfUnits {
      */
     standard = "standard"
 }
+//# sourceMappingURL=SystemsOfUnits.d.ts.map

package/{Accounts → _publish/Accounts}/User.d.ts

@@ -11,9 +11,12 @@ import { Contact } from "./Contact";
 import { Permission } from "./Permissions/Permission";
 import { SystemsOfUnits } from "./SystemsOfUnits";
 import { UserAdvanced } from "./UserAdvanced";
+import { UserAuthentication } from "./UserAuthentication";
 import { UserGeneral } from "./UserGeneral";
 import { UserGroup } from "./UserGroup";
+import { UserMFA } from "./UserMFA";
 import { UserNotifications } from "./UserNotifications";
+import { UserSSO } from "./UserSSO";
 /**
  * A grouping of credentials, information, preferences, and permissions for a person or machine to login to the system and access its resources.
  */
@@ -34,19 +37,13 @@ export declare class User extends BaseCompound implements IEnabled, IBelongCompa
      */
     get companyId(): ulong;
     /**
-     * The company to which this user belongs.
-     * {@link Company.id}
+     * The {@link Company} to which this user belongs.
      */
     get company(): Company;
     /**
      *
      */
     get general(): UserGeneral;
-    /**
-     * Indicated whether the credentials have expired according to the company's policy.
-     */
-    get passwordExpired(): boolean;
-    set passwordExpired(value: boolean);
     /**
      * Indicates whether system access is disabled.
      */
@@ -64,14 +61,12 @@ export declare class User extends BaseCompound implements IEnabled, IBelongCompa
     get contactId(): ulong;
     set contactId(value: ulong | nothing);
     /**
-     * Contact information for this user.
-     * {@link Contact.id}
+     * {@link Contact} information for this user.
      */
     get contact(): Contact;
     set contact(value: Contact | nothing);
     /**
      * The user's local timezone.
-     * {@link Timezone.code}
      */
     get timezone(): Timezone;
     set timezone(value: Timezone);
@@ -106,14 +101,13 @@ export declare class User extends BaseCompound implements IEnabled, IBelongCompa
      */
     get advanced(): UserAdvanced;
     /**
-     * A list of groups to which this user belongs.
+     * A list of {@link UserGroup}s to which this user belongs.
      * {@link UserGroup.id}
      */
     get groupIds(): ulong[];
     set groupIds(value: ulong[]);
     /**
      * A list of groups to which this user belongs.
-     * {@link UserGroup.id}
      */
     get groups(): UserGroup[];
     set groups(value: UserGroup[]);
@@ -122,16 +116,42 @@ export declare class User extends BaseCompound implements IEnabled, IBelongCompa
      */
     get permissions(): Permission[];
     set permissions(value: Permission[]);
+    /**
+     *
+     */
+    get authentication(): UserAuthentication;
+    /**
+     * Indicated whether the credentials have expired according to the company's policy.
+     */
+    get passwordExpired(): boolean;
+    set passwordExpired(value: boolean);
+    /**
+     * Multi-factor authentication details for the user.
+     */
+    get mfa(): UserMFA[];
+    set mfa(value: UserMFA[]);
+    /**
+     * Single Sign-On details for the user.
+     */
+    get sso(): UserSSO;
+    set sso(value: UserSSO);
     toJSON(): {
         v: number[];
         login: string;
         company: number;
+        passwordExpired: boolean;
+        mfa: any[];
+        sso: {
+            enabled: boolean;
+            provider: import("./SSOIdentityProvider").SSOIdentityProvider;
+            lastAuthentication: string | null;
+            externalId: string | null;
+        };
         groups: number[];
         permissions: any[];
         nickname: string;
         enabled: boolean;
         contact: boolean;
-        passwordExpired: boolean;
         timezone: string;
         language: string;
         formats: JsonObject;
@@ -145,3 +165,4 @@ export declare class User extends BaseCompound implements IEnabled, IBelongCompa
      */
     getKey(): string;
 }
+//# sourceMappingURL=User.d.ts.map

package/{Accounts → _publish/Accounts}/UserAdvanced.d.ts

@@ -20,8 +20,7 @@ export declare class UserAdvanced extends BaseComponent implements IBelongCompan
      */
     companyId: ulong;
     /**
-     * The company to which this user belongs.
-     * {@link Company.id}
+     * The {@link Company} to which this user belongs.
      */
     get company(): Company;
     /**
@@ -52,3 +51,4 @@ export declare class UserAdvanced extends BaseComponent implements IBelongCompan
      */
     getKey(): string;
 }
+//# sourceMappingURL=UserAdvanced.d.ts.map

package/_publish/Accounts/UserAuthentication.d.ts

@@ -0,0 +1,56 @@
+import { BaseComponent } from "../API/BaseComponent";
+import { IBelongCompany } from "../API/Interfaces/IBelongCompany";
+import { JsonObject, email, ulong } from "../API/Types";
+import { Company } from "../Companies/Company";
+import { UserMFA } from "./UserMFA";
+import { UserSSO } from "./UserSSO";
+/**
+ * Credentials, information, and preferences about a user.
+ */
+export declare class UserAuthentication extends BaseComponent implements IBelongCompany {
+    /**
+     * The unique public email address used to access the system.
+     * {@link User.login}
+     */
+    login: email;
+    /**
+     * The company to which this user belongs.
+     * {@link Company.id}
+     */
+    companyId: ulong;
+    /**
+     * The {@link Company} to which this user belongs.
+     */
+    get company(): Company;
+    /**
+     * Indicated whether the credentials have expired according to the company's policy.
+     */
+    passwordExpired: boolean;
+    /**
+     * Multi-factor authentication details for the user.
+     */
+    mfa: UserMFA[];
+    /**
+     * Single Sign-On details for the user.
+     */
+    sso: UserSSO;
+    toJSON(): {
+        login: string;
+        v: number[];
+        company: number;
+        passwordExpired: boolean;
+        mfa: any[];
+        sso: {
+            enabled: boolean;
+            provider: import("./SSOIdentityProvider").SSOIdentityProvider;
+            lastAuthentication: string | null;
+            externalId: string | null;
+        };
+    };
+    fromJSON(json: JsonObject, force?: boolean): boolean;
+    /**
+     * The {@link login} is the key.
+     */
+    getKey(): string;
+}
+//# sourceMappingURL=UserAuthentication.d.ts.map