@trakit/objects 0.0.1 → 0.0.6

package/_publish/index.d.ts

@@ -0,0 +1,406 @@
+/**
+ * Trak-iT API Object Model.
+ * {@link https://github.com/trakitwireless/trakit-ts-objects|Object definition.}
+ * All of the Trak-iT APIs use the same object definitions. Use this package in your TypeScript or JavaScript project.
+ * Last updated on Friday December 19, 2025
+ * @copyright Trak-iT Wireless Inc. 2025
+ */
+import { Contact } from "./objects/Accounts/Contact";
+import { Machine } from "./objects/Accounts/Machine";
+import { NotificationMethod } from "./objects/Accounts/NotificationMethod";
+import { compute, computeAll, computeAllComplex, computeAllSimple, computeComplex, computeSimple, computeSimpleLevels, findAllEscalations, findAllLabelEscalations, findAnyComplex, findComplex, findComplexLevel, findEscalations, findLabelEscalation, findSimple, findSimpleLevel, getComplexLevel, getSimpleLevel, hasAnyComplex, hasComplex, hasSimple } from "./objects/Accounts/Permissions/Authorizer";
+import { Permission } from "./objects/Accounts/Permissions/Permission";
+import { PermissionEscalation } from "./objects/Accounts/Permissions/PermissionEscalation";
+import { PermissionEscalationState } from "./objects/Accounts/Permissions/PermissionEscalationState";
+import { PermissionEscalationType } from "./objects/Accounts/Permissions/PermissionEscalationType";
+import { PermissionLevel } from "./objects/Accounts/Permissions/PermissionLevel";
+import { PermissionMethod } from "./objects/Accounts/Permissions/PermissionMethod";
+import { PermissionType } from "./objects/Accounts/Permissions/PermissionType";
+import { Session } from "./objects/Accounts/Session";
+import { SessionStatus } from "./objects/Accounts/SessionStatus";
+import { SystemsOfUnits } from "./objects/Accounts/SystemsOfUnits";
+import { User } from "./objects/Accounts/User";
+import { UserAdvanced } from "./objects/Accounts/UserAdvanced";
+import { UserGeneral } from "./objects/Accounts/UserGeneral";
+import { UserGroup } from "./objects/Accounts/UserGroup";
+import { UserNotifications } from "./objects/Accounts/UserNotifications";
+import { Base } from "./objects/API/Base";
+import { BaseComponent } from "./objects/API/BaseComponent";
+import { BaseCompound } from "./objects/API/BaseCompound";
+import { CODIFY, HIGHLIGHT } from "./objects/API/Codifier";
+import { PASSWORD_DECODE, PASSWORD_ENCODE } from "./objects/API/Encoding";
+import { FILESIZE_HELPER, NUMBER_GROUPS } from "./objects/API/Files";
+import { CAPITALIZE, DATE, DOUGLASPEUCKER, ID, IS_AN, IS_NOTHING, JSON_TO_MAP, JSON_TO_MAP_PREDICATE, MAP_TO_JSON, MAP_TO_JSON_PREDICATE, PHONE_PARSE, PLURALIZE, PYTHAGORA, ROUND_TO, SINGULARIZE } from "./objects/API/Functions";
+import { GEOFENCE_AREA, GEOFENCE_CONTAINS, GEOFENCE_PEUCKER, GEOFENCE_WIDEST, LATITUDE_NORMALIZED, LATLNG_ANGLE, LATLNG_DISTANCE, LATLNG_DISTANCE_VINCENTY, LATLNG_GREAT_CIRCLE, LATLNG_MIDPOINT, LATLNG_TRANSLATE, LONGITUDE_NORMALIZED, ROUTE_DECODE, ROUTE_ENCODE, ROUTE_LENGTH, ROUTE_PEUCKER } from "./objects/API/Geography/Functions";
+import { LatLng } from "./objects/API/Geography/LatLng";
+import { LatLngBounds } from "./objects/API/Geography/LatLngBounds";
+import { Position } from "./objects/API/Geography/Position";
+import { StreetAddress } from "./objects/API/Geography/StreetAddress";
+import { PATH_LENGTH, PATH_ORTHOGONAL, PATH_PEUCKER, POINT_ANGLE, POINT_DISTANCE, POINT_VECTOR, POLY_AREA, POLY_CONTAINS, POLY_PEUCKER, POLY_WRAPPER, RADIAL_AREA, RADIAL_BADOIU_CLARKSON, RADIAL_CIRCUMFERENCE, RADIAL_OVERLAP_RECTANGLE } from "./objects/API/Geometry/Functions";
+import { Point } from "./objects/API/Geometry/Point";
+import { Radial } from "./objects/API/Geometry/Radial";
+import { Rectangle } from "./objects/API/Geometry/Rectangle";
+import { Size } from "./objects/API/Geometry/Size";
+import { GUID } from "./objects/API/Guid";
+import { IDeserializable } from "./objects/API/Interfaces/IDeserializable";
+import { IRequestable } from "./objects/API/Interfaces/IRequestable";
+import { ISerializable } from "./objects/API/Interfaces/ISerializable";
+import { SearchPattern } from "./objects/API/SearchPattern";
+import { TIMESPAN_PARSE, TIMESPAN_STRINGIFY, TimeSpan } from "./objects/API/TimeSpan";
+import { Timezone } from "./objects/API/Timezone";
+import { TIMEZONE_FIND } from "./objects/API/Timezones";
+import { byte, codified, colour, datetime, datetimetemplate, double, email, expression, guid, int, ipv4, JsonArray, JsonObject, JsonValue, long, nothing, phone, polyline, sbyte, short, single, timespan, uint, ulong, url, ushort } from "./objects/API/Types";
+import { Asset } from "./objects/Assets/Asset";
+import { AssetAdvanced } from "./objects/Assets/AssetAdvanced";
+import { AssetAttribute } from "./objects/Assets/AssetAttribute";
+import { AssetDispatch } from "./objects/Assets/AssetDispatch";
+import { AssetGeneral } from "./objects/Assets/AssetGeneral";
+import { AssetPlaceStatus } from "./objects/Assets/AssetPlaceStatus";
+import { AssetPlaceStatusType } from "./objects/Assets/AssetPlaceStatusType";
+import { AssetType } from "./objects/Assets/AssetType";
+import { Behaviour } from "./objects/Behaviours/Behaviour";
+import { BehaviourLog } from "./objects/Behaviours/BehaviourLog";
+import { BehaviourLogType } from "./objects/Behaviours/BehaviourLogType";
+import { BehaviourParameter } from "./objects/Behaviours/BehaviourParameter";
+import { BehaviourParameterType } from "./objects/Behaviours/BehaviourParameterType";
+import { BehaviourScript } from "./objects/Behaviours/BehaviourScript";
+import { BillingCurrency } from "./objects/Billing/BillingCurrency";
+import { BillingCycle } from "./objects/Billing/BillingCycle";
+import { BillingProfile } from "./objects/Billing/BillingProfile";
+import { BillableHostingLicense } from "./objects/Billing/Hosting/BillableHostingLicense";
+import { BillableHostingLicenseType } from "./objects/Billing/Hosting/BillableHostingLicenseType";
+import { BillableHostingRule } from "./objects/Billing/Hosting/BillableHostingRule";
+import { BillableHostingType } from "./objects/Billing/Hosting/BillableHostingType";
+import { BillingReport } from "./objects/Billing/Report/BillingReport";
+import { BillingReportBreakdown } from "./objects/Billing/Report/BillingReportBreakdown";
+import { BillingReportHostingSummary } from "./objects/Billing/Report/BillingReportHostingSummary";
+import { BillingReportLicenseBreakdown } from "./objects/Billing/Report/BillingReportLicenseBreakdown";
+import { BillingReportServiceBreakdown } from "./objects/Billing/Report/BillingReportServiceBreakdown";
+import { BillingReportStatus } from "./objects/Billing/Report/BillingReportStatus";
+import { BillingReportSummary } from "./objects/Billing/Report/BillingReportSummary";
+import { ColourStyle } from "./objects/Companies/ColourStyle";
+import { Company } from "./objects/Companies/Company";
+import { CompanyDirectory } from "./objects/Companies/CompanyDirectory";
+import { CompanyGeneral } from "./objects/Companies/CompanyGeneral";
+import { CompanyPolicy } from "./objects/Companies/CompanyPolicy";
+import { CompanyReseller } from "./objects/Companies/CompanyReseller";
+import { CompanyStyle } from "./objects/Companies/CompanyStyle";
+import { LabelStyle } from "./objects/Companies/LabelStyle";
+import { NotificationServerEmail } from "./objects/Companies/NotificationServerEmail";
+import { NotificationServerSms } from "./objects/Companies/NotificationServerSms";
+import { PasswordExpiryMode } from "./objects/Companies/PasswordExpiryMode";
+import { PasswordPolicy } from "./objects/Companies/PasswordPolicy";
+import { SessionMultiUser } from "./objects/Companies/SessionMultiUser";
+import { SessionPolicy } from "./objects/Companies/SessionPolicy";
+import { DispatchDirection } from "./objects/Dispatch/DispatchDirection";
+import { DispatchJob } from "./objects/Dispatch/DispatchJob";
+import { DispatchJobPriority } from "./objects/Dispatch/DispatchJobPriority";
+import { DispatchStep } from "./objects/Dispatch/DispatchStep";
+import { DispatchStepState } from "./objects/Dispatch/DispatchStepState";
+import { DispatchStepStatus } from "./objects/Dispatch/DispatchStepStatus";
+import { DispatchTask } from "./objects/Dispatch/DispatchTask";
+import { DispatchTaskStatus } from "./objects/Dispatch/DispatchTaskStatus";
+import { Document } from "./objects/Hosting/Document";
+import { FormFieldAttachments } from "./objects/Hosting/Fields/FormFieldAttachments";
+import { FormFieldBase } from "./objects/Hosting/Fields/FormFieldBase";
+import "./objects/Hosting/Fields/FormFieldBase_fromJSON";
+import { FormFieldBoolean } from "./objects/Hosting/Fields/FormFieldBoolean";
+import { FormFieldChoice } from "./objects/Hosting/Fields/FormFieldChoice";
+import { FormFieldDate } from "./objects/Hosting/Fields/FormFieldDate";
+import { FormFieldNumeric } from "./objects/Hosting/Fields/FormFieldNumeric";
+import { FormFieldNumericSize } from "./objects/Hosting/Fields/FormFieldNumericSize";
+import { FormFieldSignature } from "./objects/Hosting/Fields/FormFieldSignature";
+import { FormFieldText } from "./objects/Hosting/Fields/FormFieldText";
+import { FormFieldTime } from "./objects/Hosting/Fields/FormFieldTime";
+import { FormFieldTimezone } from "./objects/Hosting/Fields/FormFieldTimezone";
+import { FormFieldType } from "./objects/Hosting/FormFieldType";
+import { FormResult } from "./objects/Hosting/FormResult";
+import { FormTemplate } from "./objects/Hosting/FormTemplate";
+import { Dashcam } from "./objects/Images/Dashcam";
+import { DashcamBase } from "./objects/Images/DashcamBase";
+import { DashcamLive } from "./objects/Images/DashcamLive";
+import { DashcamMediaType } from "./objects/Images/DashcamMediaType";
+import { Icon } from "./objects/Images/Icon";
+import { IconGlyph } from "./objects/Images/IconGlyph";
+import { IconLabel } from "./objects/Images/IconLabel";
+import { IconLayer } from "./objects/Images/IconLayer";
+import { Picture } from "./objects/Images/Picture";
+import { MaintenanceInterval } from "./objects/Maintenance/MaintenanceInterval";
+import { MaintenanceJob } from "./objects/Maintenance/MaintenanceJob";
+import { MaintenanceJobStatus } from "./objects/Maintenance/MaintenanceJobStatus";
+import { MaintenanceSchedule } from "./objects/Maintenance/MaintenanceSchedule";
+import { AlertPriority } from "./objects/Messaging/AlertPriority";
+import { AssetAlert } from "./objects/Messaging/AssetAlert";
+import { AssetMessage } from "./objects/Messaging/AssetMessage";
+import { MessageFolder } from "./objects/Messaging/MessageFolder";
+import { MessageStatus } from "./objects/Messaging/MessageStatus";
+import { MessageType } from "./objects/Messaging/MessageType";
+import { Place } from "./objects/Places/Place";
+import { PlaceType } from "./objects/Places/PlaceType";
+import { ProviderConfig } from "./objects/Providers/Config/ProviderConfig";
+import { ProviderRegistration } from "./objects/Providers/Config/ProviderRegistration";
+import { ProviderScript } from "./objects/Providers/Config/ProviderScript";
+import { ProviderScriptBlock } from "./objects/Providers/Config/ProviderScriptBlock";
+import { ProviderScriptParameter } from "./objects/Providers/Config/ProviderScriptParameter";
+import { ProviderScriptParameterType } from "./objects/Providers/Config/ProviderScriptParameterType";
+import { ProviderConfiguration } from "./objects/Providers/Configuration/ProviderConfiguration";
+import { ProviderConfigurationNode } from "./objects/Providers/Configuration/ProviderConfigurationNode";
+import { ProviderConfigurationType } from "./objects/Providers/Configuration/ProviderConfigurationType";
+import { ProviderGeofenceBase } from "./objects/Providers/Configuration/ProviderGeofenceBase";
+import "./objects/Providers/Configuration/ProviderGeofenceBase_fromJSON";
+import { ProviderGeofenceCircular } from "./objects/Providers/Configuration/ProviderGeofenceCircular";
+import { ProviderGeofencePoint } from "./objects/Providers/Configuration/ProviderGeofencePoint";
+import { ProviderGeofencePolygon } from "./objects/Providers/Configuration/ProviderGeofencePolygon";
+import { ProviderGeofenceRectangle } from "./objects/Providers/Configuration/ProviderGeofenceRectangle";
+import { Provider } from "./objects/Providers/Provider";
+import { ProviderAdvanced } from "./objects/Providers/ProviderAdvanced";
+import { ProviderCommand } from "./objects/Providers/ProviderCommand";
+import { ProviderCommandStatus } from "./objects/Providers/ProviderCommandStatus";
+import { ProviderCommandType } from "./objects/Providers/ProviderCommandType";
+import { ProviderControl } from "./objects/Providers/ProviderControl";
+import { ProviderData } from "./objects/Providers/ProviderData";
+import { ProviderGeneral } from "./objects/Providers/ProviderGeneral";
+import { ProviderType } from "./objects/Providers/ProviderType";
+import { ReportBreakdown } from "./objects/Reports/ReportBreakdown";
+import "./objects/Reports/ReportBreakdown_fromJSON";
+import { ReportBreakdownJob } from "./objects/Reports/ReportBreakdownJob";
+import { ReportBreakdownMessage } from "./objects/Reports/ReportBreakdownMessage";
+import { ReportBreakdownTask } from "./objects/Reports/ReportBreakdownTask";
+import { ReportFilterMode } from "./objects/Reports/ReportFilterMode";
+import { ReportNotifications } from "./objects/Reports/ReportNotifications";
+import { ReportOptions } from "./objects/Reports/ReportOptions";
+import { ReportParameter } from "./objects/Reports/ReportParameter";
+import { ReportParameterType } from "./objects/Reports/ReportParameterType";
+import { ReportRecurrence } from "./objects/Reports/ReportRecurrence";
+import { ReportRecurrenceType } from "./objects/Reports/ReportRecurrenceType";
+import { ReportResult } from "./objects/Reports/ReportResult";
+import { ReportResultData } from "./objects/Reports/ReportResultData";
+import { ReportSchedule } from "./objects/Reports/ReportSchedule";
+import { ReportScorecard } from "./objects/Reports/ReportScorecard";
+import { ReportScorecardParameter } from "./objects/Reports/ReportScorecardParameter";
+import { ReportScorecardRules } from "./objects/Reports/ReportScorecardRules";
+import { ReportStatus } from "./objects/Reports/ReportStatus";
+import { ReportSummary } from "./objects/Reports/ReportSummary";
+import { ReportSummaryReason } from "./objects/Reports/ReportSummaryReason";
+import { ReportTemplate } from "./objects/Reports/ReportTemplate";
+import { ReportTotal } from "./objects/Reports/ReportTotal";
+import { ReportType } from "./objects/Reports/ReportType";
+/**
+ * Version number for this release.
+ */
+export declare const version = 5.06;
+/**
+ * The names of all main object types in the Trak-iT Object Model.
+ */
+export type SyncName = "Company" | "CompanyGeneral" | "CompanyStyle" | "CompanyDirectory" | "CompanyPolicy" | "CompanyReseller" | "Contact" | "Machine" | "Session" | "User" | "UserGeneral" | "UserAdvanced" | "UserGroup" | "Asset" | "AssetGeneral" | "AssetAdvanced" | "AssetDispatch" | "AssetAlert" | "AssetMessage" | "Behaviour" | "BehaviourScript" | "BehaviourLog" | "BillableHostingLicense" | "BillableHostingRule" | "BillingProfile" | "BillingReport" | "DispatchJob" | "DispatchTask" | "Document" | "FormResult" | "FormTemplate" | "Dashcam" | "Icon" | "Picture" | "MaintenanceSchedule" | "MaintenanceJob" | "Place" | "Provider" | "ProviderGeneral" | "ProviderAdvanced" | "ProviderControl" | "ProviderScript" | "ProviderConfig" | "ProviderConfigurationType" | "ProviderConfiguration" | "ProviderRegistration" | "ReportTemplate" | "ReportSchedule" | "ReportResult";
+/**
+ * A mapping of all main object types in the Trak-iT Object Model to their class constructors.
+ */
+export declare const classes: {
+    [key in SyncName]: {
+        new (): IRequestable;
+    };
+};
+/**
+ * Local Maps that store various instances of objects.
+ * The storage is used by the sync system.
+ */
+export declare const storage: {
+    [key in SyncName]: Map<ulong | guid | email | codified | string, IRequestable>;
+};
+/**
+ * Common types used throughout the application.
+ * These are simply numbers or strings of a specific format.
+ */
+export type { JsonArray, JsonObject, JsonValue, byte, double, int, long, phone, sbyte, short, single, uint, ulong, ushort, codified, colour, datetime, datetimetemplate, email, expression, guid, ipv4, nothing, polyline, timespan, url, IRequestable, IDeserializable, ISerializable, };
+/**
+ * A group of utility functions for common tasks like dealing with strings.
+ */
+export declare const utility: {
+    capitalize: typeof CAPITALIZE;
+    codify: typeof CODIFY;
+    date: typeof DATE;
+    douglasPeucker: typeof DOUGLASPEUCKER;
+    fileSize: typeof FILESIZE_HELPER;
+    findTimeZoneById: typeof TIMEZONE_FIND;
+    guid: typeof GUID;
+    highlight: typeof HIGHLIGHT;
+    id: typeof ID;
+    isNothing: typeof IS_NOTHING;
+    isntNaN: typeof IS_AN;
+    numberGroups: typeof NUMBER_GROUPS;
+    roundTo: typeof ROUND_TO;
+    parseTime: typeof TIMESPAN_PARSE;
+    phoneNumber: typeof PHONE_PARSE;
+    pluralize: typeof PLURALIZE;
+    singularize: typeof SINGULARIZE;
+    stringifyTime: typeof TIMESPAN_STRINGIFY;
+};
+/**
+ * A group of functions for converting between different measurement systems.
+ */
+export declare const convert: {
+    fromTo: typeof import("./objects/API/Conversion").CONVERT_FROM_TO;
+    sqmToSqft: typeof import("./objects/API/Conversion").CONVERT_SQM_TO_SQFT;
+    sqftToSqm: typeof import("./objects/API/Conversion").CONVERT_SQFT_TO_SQM;
+    sqmToSqy: typeof import("./objects/API/Conversion").CONVERT_SQM_TO_YARDS;
+    yftToSqm: typeof import("./objects/API/Conversion").CONVERT_YARDS_TO_SQM;
+    sqkmToSqmi: typeof import("./objects/API/Conversion").CONVERT_SQKM_TO_SQMI;
+    sqmiToSqkm: typeof import("./objects/API/Conversion").CONVERT_SQMI_TO_SQKM;
+    haToAc: typeof import("./objects/API/Conversion").CONVERT_HECTARE_TO_ACRE;
+    acToHa: typeof import("./objects/API/Conversion").CONVERT_ACRE_TO_HECTARE;
+    kmToMi: typeof import("./objects/API/Conversion").CONVERT_KILOMETRES_TO_MILES;
+    miToKm: typeof import("./objects/API/Conversion").CONVERT_MILES_TO_KILOMETRES;
+    mToYd: typeof import("./objects/API/Conversion").CONVERT_METRES_TO_YARDS;
+    ydToM: typeof import("./objects/API/Conversion").CONVERT_YARDS_TO_METRES;
+    mToFt: typeof import("./objects/API/Conversion").CONVERT_METRES_TO_FEET;
+    ftToM: typeof import("./objects/API/Conversion").CONVERT_FEET_TO_METRES;
+    cmToIn: typeof import("./objects/API/Conversion").CONVERT_CENTIMETRES_TO_INCHES;
+    inToCm: typeof import("./objects/API/Conversion").CONVERT_INCHES_TO_CENTIMETRES;
+    mpgToL100km: typeof import("./objects/API/Conversion").CONVERT_BETWEEN_MPGUS_AND_L100KM;
+    mpgUKToL100km: typeof import("./objects/API/Conversion").CONVERT_BETWEEN_MPGUK_AND_L100KM;
+    mpkwhToKwh100kim: typeof import("./objects/API/Conversion").CONVERT_BETWEEN_MPKWH_AND_KWH100KM;
+    l100kmToMpg: typeof import("./objects/API/Conversion").CONVERT_BETWEEN_MPGUS_AND_L100KM;
+    l100kmToMpgUK: typeof import("./objects/API/Conversion").CONVERT_BETWEEN_MPGUK_AND_L100KM;
+    kwh100kimToMpkwh: typeof import("./objects/API/Conversion").CONVERT_BETWEEN_MPKWH_AND_KWH100KM;
+    kpaToPsi: typeof import("./objects/API/Conversion").CONVERT_KPA_TO_PSI;
+    psiToKpa: typeof import("./objects/API/Conversion").CONVERT_PSI_TO_KPA;
+    kphToMph: typeof import("./objects/API/Conversion").CONVERT_KILOMETRES_TO_MILES;
+    mphToKph: typeof import("./objects/API/Conversion").CONVERT_MILES_TO_KILOMETRES;
+    mpsToFtps: typeof import("./objects/API/Conversion").CONVERT_METRES_TO_FEET;
+    ftpsToMps: typeof import("./objects/API/Conversion").CONVERT_FEET_TO_METRES;
+    cmpsToInps: typeof import("./objects/API/Conversion").CONVERT_CENTIMETRES_TO_INCHES;
+    inpsToCmps: typeof import("./objects/API/Conversion").CONVERT_INCHES_TO_CENTIMETRES;
+    cToF: typeof import("./objects/API/Conversion").CONVERT_CELCIUS_TO_FAHRENHEIT;
+    fToC: typeof import("./objects/API/Conversion").CONVERT_FAHRENHEIT_TO_CELCIUS;
+    lToGal: typeof import("./objects/API/Conversion").CONVERT_LITRES_TO_GALLONS_US;
+    lToGalUK: typeof import("./objects/API/Conversion").CONVERT_LITRES_TO_GALLONS_UK;
+    galToL: typeof import("./objects/API/Conversion").CONVERT_GALLONS_US_TO_LITRES;
+    galUKToL: typeof import("./objects/API/Conversion").CONVERT_GALLONS_UK_TO_LITRES;
+    mlToFloz: typeof import("./objects/API/Conversion").CONVERT_MILLILITRES_TO_OUNCES_US;
+    mlToFlozUK: typeof import("./objects/API/Conversion").CONVERT_MILLILITRES_TO_OUNCES_UK;
+    flozToMl: typeof import("./objects/API/Conversion").CONVERT_OUNCES_US_TO_MILLILITRES;
+    flozUKToMl: typeof import("./objects/API/Conversion").CONVERT_OUNCES_UK_TO_MILLILITRES;
+    kgToLbs: typeof import("./objects/API/Conversion").CONVERT_KG_TO_LBS;
+    lbsToKg: typeof import("./objects/API/Conversion").CONVERT_LBS_TO_KG;
+    gToOz: typeof import("./objects/API/Conversion").CONVERT_GRAM_TO_OZ;
+    ozToG: typeof import("./objects/API/Conversion").CONVERT_OZ_TO_GRAM;
+    tToTon: typeof import("./objects/API/Conversion").CONVERT_TONNE_TO_TON_US;
+    tonToT: typeof import("./objects/API/Conversion").CONVERT_TON_US_TO_TONNE;
+    tToTonUK: typeof import("./objects/API/Conversion").CONVERT_TONNE_TO_TON_UK;
+    tonUKToT: typeof import("./objects/API/Conversion").CONVERT_TON_UK_TO_TONNE;
+};
+/**
+ * Functions for encoding and decoding device passwords.
+ */
+export declare const encoding: {
+    toPassword: typeof PASSWORD_ENCODE;
+    fromPassword: typeof PASSWORD_DECODE;
+};
+/**
+ * Functions for converting between JSON objects using our custom serialization.
+ */
+export declare const serialization: {
+    fromMap: typeof MAP_TO_JSON;
+    fromMapPredicate: typeof MAP_TO_JSON_PREDICATE;
+    toMap: typeof JSON_TO_MAP;
+    toMapPredicate: typeof JSON_TO_MAP_PREDICATE;
+};
+/**
+ * Common classes used throughout the API, and the Base classes used for synchronizable objects.
+ */
+export { Base, BaseComponent, BaseCompound, SearchPattern, TimeSpan, Timezone };
+/**
+ * Utility functions exposing algorithms for a flat plane.
+ */
+export declare const geometry: {
+    pathLength: typeof PATH_LENGTH;
+    pathOrthogonal: typeof PATH_ORTHOGONAL;
+    pathReduce: typeof PATH_PEUCKER;
+    pointAngle: typeof POINT_ANGLE;
+    pointDistance: typeof POINT_DISTANCE;
+    pointPythagora: typeof PYTHAGORA;
+    pointVector: typeof POINT_VECTOR;
+    polyArea: typeof POLY_AREA;
+    polyContains: typeof POLY_CONTAINS;
+    polyReduce: typeof POLY_PEUCKER;
+    polyWrapper: typeof POLY_WRAPPER;
+    radialCircumference: typeof RADIAL_CIRCUMFERENCE;
+    radialArea: typeof RADIAL_AREA;
+    radialSmallest: typeof RADIAL_BADOIU_CLARKSON;
+    radialOverlapsRectangle: typeof RADIAL_OVERLAP_RECTANGLE;
+};
+export { Point, Radial, Rectangle, Size };
+/**
+ * Utility functions exposing algorithms for a WGS84/NAD83 spheroid.
+ */
+export declare const geography: {
+    earthRadius: number;
+    clampLat: typeof LATITUDE_NORMALIZED;
+    clampLng: typeof LONGITUDE_NORMALIZED;
+    pathLength: typeof ROUTE_LENGTH;
+    pathReduce: typeof ROUTE_PEUCKER;
+    pathEncode: typeof ROUTE_ENCODE;
+    pathDecode: typeof ROUTE_DECODE;
+    pointAngle: typeof LATLNG_ANGLE;
+    pointDistance: typeof LATLNG_DISTANCE;
+    pointMiddle: typeof LATLNG_MIDPOINT;
+    pointOrthogonal: typeof LATLNG_GREAT_CIRCLE;
+    pointTranslate: typeof LATLNG_TRANSLATE;
+    pointVincenty: typeof LATLNG_DISTANCE_VINCENTY;
+    polyArea: typeof GEOFENCE_AREA;
+    polyContains: typeof GEOFENCE_CONTAINS;
+    polyReduce: typeof GEOFENCE_PEUCKER;
+    polyWidest: typeof GEOFENCE_WIDEST;
+};
+export { LatLng, LatLngBounds, Position, StreetAddress };
+export { ColourStyle, Company, CompanyDirectory, CompanyGeneral, CompanyPolicy, CompanyReseller, CompanyStyle, LabelStyle, NotificationServerEmail, NotificationServerSms, PasswordExpiryMode, PasswordPolicy, SessionMultiUser, SessionPolicy };
+/**
+ * Functions and collections for validating account permissions.
+ */
+export declare const authorizer: {
+    computeAll: typeof computeAll;
+    compute: typeof compute;
+    computeAllSimple: typeof computeAllSimple;
+    computeSimple: typeof computeSimple;
+    computeSimpleLevels: typeof computeSimpleLevels;
+    getSimpleLevel: typeof getSimpleLevel;
+    hasSimple: typeof hasSimple;
+    findSimple: typeof findSimple;
+    findSimpleLevel: typeof findSimpleLevel;
+    computeAllComplex: typeof computeAllComplex;
+    computeComplex: typeof computeComplex;
+    getComplexLevel: typeof getComplexLevel;
+    findComplexLevel: typeof findComplexLevel;
+    hasComplex: typeof hasComplex;
+    findComplex: typeof findComplex;
+    hasAnyComplex: typeof hasAnyComplex;
+    findAnyComplex: typeof findAnyComplex;
+    findAllEscalations: typeof findAllEscalations;
+    findEscalations: typeof findEscalations;
+    findAllLabelEscalations: typeof findAllLabelEscalations;
+    findLabelEscalation: typeof findLabelEscalation;
+    /**
+     * A list of {@link PermissionType}s which are implied for each user's own company.
+     */
+    implied: readonly PermissionType[];
+    /**
+     * {@link PermissionType}s which do not use labels to calculate access.
+     */
+    simple: readonly PermissionType[];
+    /**
+     * The {@link PermissionType}s which are calculated using labels.
+     */
+    complex: readonly PermissionType[];
+};
+export { Contact, Machine, NotificationMethod, Permission, PermissionEscalation, PermissionEscalationState, PermissionEscalationType, PermissionLevel, PermissionMethod, PermissionType, Session, SessionStatus, SystemsOfUnits, User, UserGeneral, UserAdvanced, UserGroup, UserNotifications, };
+export { Asset, AssetAdvanced, AssetAttribute, AssetDispatch, AssetGeneral, AssetPlaceStatus, AssetPlaceStatusType, AssetType, AssetAlert, AssetMessage, AlertPriority, MessageFolder, MessageStatus, MessageType, };
+export { Behaviour, BehaviourLog, BehaviourLogType, BehaviourParameter, BehaviourParameterType, BehaviourScript, };
+export { BillableHostingLicense, BillableHostingLicenseType, BillableHostingRule, BillableHostingType, BillingCurrency, BillingCycle, BillingProfile, BillingReport, BillingReportBreakdown, BillingReportHostingSummary, BillingReportLicenseBreakdown, BillingReportServiceBreakdown, BillingReportStatus, BillingReportSummary, };
+export { DispatchDirection, DispatchJob, DispatchJobPriority, DispatchStep, DispatchStepState, DispatchStepStatus, DispatchTask, DispatchTaskStatus, };
+export { Document, FormResult, FormTemplate, FormFieldType, FormFieldBase, FormFieldAttachments, FormFieldBoolean, FormFieldChoice, FormFieldDate, FormFieldNumeric, FormFieldNumericSize, FormFieldSignature, FormFieldText, FormFieldTime, FormFieldTimezone, };
+export { DashcamBase, Dashcam, DashcamLive, DashcamMediaType, Icon, IconGlyph, IconLabel, IconLayer, Picture, };
+export { MaintenanceSchedule, MaintenanceJob, MaintenanceJobStatus, MaintenanceInterval, };
+export { Place, PlaceType, };
+export { Provider, ProviderGeneral, ProviderAdvanced, ProviderControl, ProviderCommand, ProviderCommandStatus, ProviderCommandType, ProviderType, ProviderRegistration, ProviderData, ProviderScript, ProviderScriptBlock, ProviderScriptParameter, ProviderScriptParameterType, ProviderConfig, ProviderConfiguration, ProviderConfigurationNode, ProviderConfigurationType, ProviderGeofenceBase, ProviderGeofenceCircular, ProviderGeofencePoint, ProviderGeofencePolygon, ProviderGeofenceRectangle, };
+export { ReportResult, ReportResultData, ReportSchedule, ReportTemplate, ReportType, ReportBreakdown, ReportBreakdownJob, ReportBreakdownMessage, ReportBreakdownTask, ReportTotal, ReportFilterMode, ReportNotifications, ReportOptions, ReportParameter, ReportParameterType, ReportRecurrence, ReportRecurrenceType, ReportScorecard, ReportScorecardParameter, ReportScorecardRules, ReportStatus, ReportSummary, ReportSummaryReason, };

package/_publish/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/_publish/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/_publish/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/{API/Compound.d.ts → _publish/objects/API/BaseCompound.d.ts}

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

package/_publish/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/_publish/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;