@trakit/objects 0.0.15 → 0.0.16

package/Accounts/User.d.ts

@@ -21,6 +21,7 @@ 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.
  */
 export declare class User extends BaseCompound implements IEnabled, IBelongCompany, IHavePermissions, IHavePreferences {
+    #private;
     /**
      *
      */
@@ -39,7 +40,6 @@ export declare class User extends BaseCompound implements IEnabled, IBelongCompa
      * The {@link Company} to which this user belongs.
      */
     get company(): Company;
-    protected _general: UserGeneral;
     /**
      *
      */
@@ -96,7 +96,6 @@ export declare class User extends BaseCompound implements IEnabled, IBelongCompa
      */
     get notify(): UserNotifications[];
     set notify(value: UserNotifications[]);
-    protected _advanced: UserAdvanced;
     /**
      *
      */
@@ -117,7 +116,6 @@ export declare class User extends BaseCompound implements IEnabled, IBelongCompa
      */
     get permissions(): Permission[];
     set permissions(value: Permission[]);
-    protected _authentication: UserAuthentication;
     /**
      *
      */
@@ -138,7 +136,30 @@ export declare class User extends BaseCompound implements IEnabled, IBelongCompa
     get sso(): UserSSO;
     set sso(value: UserSSO);
     constructor(json?: JsonObject | nothing);
-    toJSON(): any;
+    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;
+        timezone: string;
+        language: string;
+        formats: JsonObject;
+        measurements: JsonObject;
+        options: JsonObject;
+        notify: any[];
+    };
     fromJSON(json: JsonObject, force?: boolean): boolean;
     /**
      * The {@link login} is the key.

package/Assets/Asset.d.ts

@@ -24,6 +24,7 @@ import { AssetType } from "./AssetType";
  * The full details of an Asset, containing all the properties from the {@link AssetGeneral} and {@link AssetAdvanced} objects.
  */
 export declare class Asset extends BaseCompound implements IIdUlong, INamed, IIconic, IBelongCompany, ILabelled, IPictured, ISuspendable {
+    #private;
     /**
      *
      */
@@ -45,7 +46,6 @@ export declare class Asset extends BaseCompound implements IIdUlong, INamed, IIc
      * Type of asset.
      */
     get kind(): AssetType;
-    protected _general: AssetGeneral;
     /**
      *
      */
@@ -143,7 +143,6 @@ export declare class Asset extends BaseCompound implements IIdUlong, INamed, IIc
      */
     get serial(): string;
     set serial(value: string);
-    protected _advanced: AssetAdvanced;
     /**
      *
      */
@@ -198,7 +197,6 @@ export declare class Asset extends BaseCompound implements IIdUlong, INamed, IIc
      */
     get engineHours(): double;
     set engineHours(value: double);
-    protected _dispatch: AssetDispatch;
     /**
      *
      */

package/Companies/Company.d.ts

@@ -7,11 +7,7 @@ import { IIdUlong } from '../API/Interfaces/IIdUlong';
 import { INamed } from '../API/Interfaces/INamed';
 import { JsonObject, codified, nothing, ulong } from '../API/Types';
 import { Picture } from '../Images/Picture';
-import { CompanyDirectory } from './CompanyDirectory';
-import { CompanyGeneral } from './CompanyGeneral';
-import { CompanyPolicy } from './CompanyPolicy';
 import { CompanyReseller } from './CompanyReseller';
-import { CompanyStyle } from './CompanyStyle';
 import { LabelStyle } from './LabelStyle';
 import { PasswordPolicy } from './PasswordPolicy';
 import { SessionPolicy } from './SessionPolicy';
@@ -19,6 +15,7 @@ import { SessionPolicy } from './SessionPolicy';
  * The full company object which contains all fields.
  */
 export declare class Company extends BaseCompound implements IIdUlong, INamed, IAmCompany, IBelongCompany {
+    #private;
     /**
      *
      */
@@ -38,10 +35,6 @@ export declare class Company extends BaseCompound implements IIdUlong, INamed, I
      */
     get parentId(): number;
     set parentId(value: number);
-    /**
-     *
-     */
-    protected _general: CompanyGeneral;
     /**
      * The organizational name.
      */
@@ -57,19 +50,11 @@ export declare class Company extends BaseCompound implements IIdUlong, INamed, I
      */
     get references(): Map<string, string>;
     set references(value: Map<string, string>);
-    /**
-     *
-     */
-    protected _directory: CompanyDirectory;
     /**
      * The list of Contacts from this and other companies broken down by contact role.
      */
     get employees(): Map<string, ulong[]>;
     set employees(value: Map<string, ulong[]>);
-    /**
-     *
-     */
-    protected _policy: CompanyPolicy;
     /**
      * The session lifetime policy.
      */
@@ -80,10 +65,6 @@ export declare class Company extends BaseCompound implements IIdUlong, INamed, I
      */
     get passwordPolicy(): PasswordPolicy;
     set passwordPolicy(value: PasswordPolicy);
-    /**
-     *
-     */
-    protected _style: CompanyStyle;
     /**
      * The styles for labels added to Assets, Places, and other things.
      */

package/Providers/Provider.d.ts

@@ -19,6 +19,7 @@ import { ProviderType } from "./ProviderType";
  * A device, modem, or service which provides events from the field.
  */
 export declare class Provider extends BaseCompound implements INamed, IBelongCompany, ISuspendable {
+    #private;
     /**
      *
      */
@@ -40,10 +41,6 @@ export declare class Provider extends BaseCompound implements INamed, IBelongCom
      * The kind of communication protocol this device uses.
      */
     get kind(): ProviderType;
-    /**
-     *
-     */
-    protected _general: ProviderGeneral;
     get general(): ProviderGeneral;
     /**
      * This thing's name.
@@ -103,10 +100,6 @@ export declare class Provider extends BaseCompound implements INamed, IBelongCom
      */
     get sim(): string;
     set sim(value: string);
-    /**
-     *
-     */
-    protected _advanced: ProviderAdvanced;
     get advanced(): ProviderAdvanced;
     /**
      * The last IP address of the device.
@@ -123,10 +116,6 @@ export declare class Provider extends BaseCompound implements INamed, IBelongCom
      */
     get snf(): Map<string, string>;
     set snf(value: Map<string, string>);
-    /**
-     *
-     */
-    protected _control: ProviderControl;
     get control(): ProviderControl;
     /**
      * Collection of commands for this provider.

package/README.md

@@ -1,24 +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
+# 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/index.d.ts

@@ -204,7 +204,7 @@ import { ReportType } from "./Reports/ReportType";
 /**
  * Version number for this release.
  */
-export declare const version = "0.0.15";
+export declare const version = "0.0.16";
 /**
  * The names of all main object types in the Trak-iT Object Model.
  */

package/objects/API/Arrays.d.ts

@@ -0,0 +1,46 @@
+import { IIdUlong } from "./Interfaces/IIdUlong";
+import { ISerializable } from "./Interfaces/ISerializable";
+import { ulong } from "./Types";
+/**
+ * Returns the unique values from an array.
+ * @template T
+ * @param array
+ */
+export declare function ARRAY_UNIQUE<T>(array: T[]): T[];
+/**
+ * Returns an array of only those elements that existed in both input arrays.
+ * @template T
+ * @param array1
+ * @param array2
+ */
+export declare function ARRAY_INTERSECT<T>(array1: T[], array2: T[]): T[];
+/**
+ * Returns an array of only those elements that existe in both array1, and not in array2.
+ * @template T
+ * @param array1
+ * @param array2
+ */
+export declare function ARRAY_EXCEPT<T>(array1: T[], array2: T[]): T[];
+/**
+ * Given as the first argument to {@link Array#map}, the {@link IIdUlong.id}s are returned.
+ * @param   object
+ */
+export declare function ARRAY_TO_IDS(object: IIdUlong): ulong;
+/**
+ * Given as the first argument to {@link Array#map}, the {@link IIdUlong.id}s are returned.
+ * @param   object
+ */
+export declare function ARRAY_TO_JSON(object: ISerializable): any;
+/**
+ *
+ * @param type
+ * @param array
+ */
+export declare function ARRAY_TO_ENUMS<T>(type: any, array: string[]): T[];
+/**
+ * Given as the first argument to {@link Array#filter} where the second argument is a {@link boolean[]}.
+ * @param this		The array of booleans to use to filter the source array.
+ * @param object	Unused.
+ * @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;

package/objects/API/Base.d.ts

@@ -0,0 +1,19 @@
+import { IDeserializable } from './Interfaces/IDeserializable';
+import { JsonObject, nothing } from './Types';
+/**
+ * A base class used to construct objects from the sync system.
+ */
+export declare abstract class Base implements IDeserializable {
+    /**
+     * Almost all objects can be constructed using a simple JSON object.
+     * @param json
+     */
+    constructor(json?: JsonObject | nothing);
+    /**
+     * Updates this class 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.
+     */
+    abstract fromJSON(json: JsonObject, force?: boolean): boolean;
+}

package/objects/API/BaseComponent.d.ts

@@ -0,0 +1,40 @@
+import { Base } from './Base';
+import { IRequestable } from './Interfaces/IRequestable';
+import { ISerializable } from './Interfaces/ISerializable';
+import { email, guid, int, ulong } from './Types';
+/**
+ * Any derived class can/should be serialized and given to a user.
+ */
+export declare abstract class BaseComponent extends Base implements IRequestable, ISerializable {
+    /**
+     * Object version keys used to validate synchronization for all object properties.
+     */
+    private _version;
+    /**
+     * Object version keys used to validate synchronization for all object properties.
+     */
+    get v(): int[];
+    /**
+     *
+     * @param version
+     * @returns
+     */
+    protected updateVersion(version: int | int[]): boolean;
+    /**
+     *
+     * @param version
+     * @returns
+     */
+    protected updateVersions(versions?: int[]): boolean[];
+    /**
+     * Returns a value which can be used as a unique identifier for this object.
+     * Values are unique for each type of object, but can be identical for different object types.
+     * @returns A value unique for this type of object.
+     */
+    abstract getKey(): ulong | email | guid | string;
+    /**
+     * Creates a literal of this {@link BaseComponent}.
+     * Used internally by {@link JSON.stringify}.
+     */
+    abstract toJSON(): any;
+}

package/objects/API/BaseCompound.d.ts

@@ -0,0 +1,19 @@
+import { BaseComponent } from './BaseComponent';
+import { int } from './Types';
+/**
+ * Some objects are made up of the pieces of many objects.
+ * {@link Asset}
+ * {@link Company}
+ * {@link Provider}
+ * {@link User}
+ */
+export declare abstract class BaseCompound extends BaseComponent {
+    /**
+     * A list of individually subscribable objects that make up the compound object.
+     */
+    abstract get pieces(): BaseComponent[];
+    /**
+     * Compound objects have multiple {@link v} values; one for each part of the object.
+     */
+    get v(): int[];
+}

package/objects/API/Codifier.d.ts

@@ -0,0 +1,15 @@
+import { codified } from "./Types";
+/**
+ * Creates a searchable/coded string based on a user inputted string.  Quotation marks, apostrophes, and accents are removed.
+ * @param input
+ */
+export declare function CODIFY(input: string): codified;
+/**
+ * Wraps the {@code input} using the codified {@code terms} with the {@code prefix}s and {@code suffix}s.
+ * When a term is found beside a quotation mark or apostrophe, the mark is included inside the highlight.
+ * @param input		The string to add HTML highlights to.
+ * @param terms		Codified search terms from {@link CODIFY}.
+ * @param prefix	Added to the beginning of each of the {@code terms}.
+ * @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;

package/objects/API/Constants.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Timer methods that get used many places.
+ */
+export declare const SET_TIMER: typeof setTimeout, SET_EVERY: typeof setInterval, CLEAR_TIMER: typeof clearTimeout, CLEAR_EVERY: typeof clearInterval;
+/**
+ * Parsing functions that get used all over.
+ */
+export declare const INT: typeof parseInt, FLOAT: typeof parseFloat;
+/**
+ *
+ */
+export declare const OBJECT: ObjectConstructor, KEYS: {
+    (o: object): string[];
+    (o: {}): string[];
+}, FREEZE: {
+    <T extends Function>(f: T): T;
+    <T extends {
+        [idx: string]: U | null | undefined | object;
+    }, U extends string | bigint | number | boolean | symbol>(o: T): Readonly<T>;
+    <T>(o: T): Readonly<T>;
+}, JSON_PARSE: (text: string, reviver?: (this: any, key: string, value: any) => any) => any, JSON_STRINGIFY: {
+    (value: any, replacer?: (this: any, key: string, value: any) => any, space?: string | number): string;
+    (value: any, replacer?: (number | string)[] | null, space?: string | number): string;
+};
+/**
+ * Maths (as the Brits would say).
+ */
+export declare const MATH: Math, PI: number, ABS: (x: number) => number, ACOS: (x: number) => number, ASIN: (x: number) => number, ATAN: (x: number) => number, ATAN2: (y: number, x: number) => number, CEIL: (x: number) => number, COS: (x: number) => number, EXP: (x: number) => number, FLOOR: (x: number) => number, LOG: (x: number) => number, MAX: (...values: number[]) => number, MIN: (...values: number[]) => number, POW: (x: number, y: number) => number, RANDOM: () => number, ROUND: (x: number) => number, SIN: (x: number) => number, SQRT: (x: number) => number, TAN: (x: number) => number;
+/**
+ * Constant values used for calculations in geometry and geography.
+ * half of pi (used in mercator projects)
+ * radians to degrees: value * (180 / pi)
+ * degrees to radians: value * (pi / 180)
+ */
+export declare const HALF_PI: number, RADIANS_TO_DEGREES: number, DEGREES_TO_RADIANS: number;
+/**
+ *
+ */
+export declare const WIN: typeof globalThis, DOC: Document, LOC: Location;