@trakit/objects 0.0.9 → 0.0.10

package/API/Interfaces/IAmCompany.d.ts

@@ -0,0 +1,12 @@
+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;
+}
+//# sourceMappingURL=IAmCompany.d.ts.map

package/API/Interfaces/IBelongAsset.d.ts

@@ -0,0 +1,16 @@
+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;
+}
+//# sourceMappingURL=IBelongAsset.d.ts.map

package/API/Interfaces/IBelongBillingProfile.d.ts

@@ -0,0 +1,16 @@
+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;
+}
+//# sourceMappingURL=IBelongBillingProfile.d.ts.map

package/API/Interfaces/IBelongCompany.d.ts

@@ -0,0 +1,16 @@
+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;
+}
+//# sourceMappingURL=IBelongCompany.d.ts.map

package/API/Interfaces/IDeserializable.d.ts

@@ -0,0 +1,14 @@
+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;
+}
+//# sourceMappingURL=IDeserializable.d.ts.map

package/API/Interfaces/IEnabled.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 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;
+}
+//# sourceMappingURL=IEnabled.d.ts.map

package/API/Interfaces/IFileSize.d.ts

@@ -0,0 +1,10 @@
+/**
+ * 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;
+}
+//# sourceMappingURL=IFileSize.d.ts.map

package/API/Interfaces/IGlobal.d.ts

@@ -0,0 +1,12 @@
+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;
+}
+//# sourceMappingURL=IGlobal.d.ts.map

package/API/Interfaces/IHavePermissions.d.ts

@@ -0,0 +1,21 @@
+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[];
+}
+//# sourceMappingURL=IHavePermissions.d.ts.map

package/API/Interfaces/IHavePreferences.d.ts

@@ -0,0 +1,30 @@
+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>;
+}
+//# sourceMappingURL=IHavePreferences.d.ts.map

package/API/Interfaces/IIconic.d.ts

@@ -0,0 +1,16 @@
+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;
+}
+//# sourceMappingURL=IIconic.d.ts.map

package/API/Interfaces/IIdUlong.d.ts

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

package/API/Interfaces/ILabelled.d.ts

@@ -0,0 +1,11 @@
+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[];
+}
+//# sourceMappingURL=ILabelled.d.ts.map

package/API/Interfaces/INamed.d.ts

@@ -0,0 +1,14 @@
+/**
+ * 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;
+}
+//# sourceMappingURL=INamed.d.ts.map

package/API/Interfaces/IPictured.d.ts

@@ -0,0 +1,16 @@
+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[];
+}
+//# sourceMappingURL=IPictured.d.ts.map

package/API/Interfaces/IRequestable.d.ts

@@ -0,0 +1,23 @@
+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;
+}
+//# sourceMappingURL=IRequestable.d.ts.map

package/API/Interfaces/ISerializable.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 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;
+}
+//# sourceMappingURL=ISerializable.d.ts.map

package/API/Interfaces/ISuspendable.d.ts

@@ -0,0 +1,17 @@
+/**
+ * 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;
+}
+//# sourceMappingURL=ISuspendable.d.ts.map

package/API/Interfaces/IVisual.d.ts

@@ -0,0 +1,19 @@
+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;
+}
+//# sourceMappingURL=IVisual.d.ts.map

package/Accounts/Permissions/Authorizer.d.ts

@@ -0,0 +1,205 @@
+import { codified, ulong } from '../../API/Types';
+import { Permission } from './Permission';
+import { PermissionEscalation } from './PermissionEscalation';
+import { PermissionLevel } from './PermissionLevel';
+import { PermissionType } from './PermissionType';
+/**
+ * Users have implied read access to their company's general, labels, policies, icons, and pictures.
+ */
+export declare const IMPLIED_PERMS: PermissionType[];
+/**
+ * These are the permissions which require label-based calculations.
+ */
+export declare const LABEL_BASED_PERMS: PermissionType[];
+/**
+ * Creates a {@link Dictionary} where the key is a {@link Company#id} and the values are well ordered arrays of {@link Permission}s which can be used to further calculate a user's permissions.
+ * @param	userCompanyId				Unique identifier of the {@link Company} to which the User belongs.
+ * @param	fromGroups	Collection of permissions from {@link UserGroup}s to which the User belongs.
+ * @param	fromUser		The User's user-specific permissions.
+ * @param	skipImpliedPermissions		When true, does not automatically add implied permissions for the user's company.
+ */
+export declare function computeAll(userCompanyId: ulong, fromGroups: Permission[], fromUser: Permission[], skipImpliedPermissions?: boolean): Map<number, Permission[]>;
+/**
+ * Creates a well ordered array of {@link Permission}s which can be used to further calculate a user's permissions for the target company.
+ * @param	userCompanyId				Unique identifier of the {@link Company#id} to which the User belongs.
+ * @param	fromGroups	Collection of permissions from {@link UserGroup}s to which the User belongs.
+ * @param	fromUser		The User's user-specific permissions.
+ * @param	targetCompanyId			Unique identifier of the {@link Company#id} being tested for access.
+ * @param	skipImpliedPermissions		When true, does not automatically add implied permissions for the user's company.
+ */
+export declare function compute(userCompanyId: ulong, fromGroups: Permission[], fromUser: Permission[], targetCompanyId?: ulong, skipImpliedPermissions?: boolean): Permission[];
+/**
+ * Creates a {@link Dictionary} where the key is a {@link Company#id} and the values are well ordered arrays of simple {@link Permission}s which can be used to further calculate a user's permissions.
+ * @param	userCompanyId				Unique identifier of the {@link Company} to which the User belongs.
+ * @param	fromGroups	Collection of permissions from {@link UserGroup}s to which the User belongs.
+ * @param	fromUser		The User's user-specific permissions.
+ */
+export declare function computeAllSimple(userCompanyId: ulong, fromGroups: Permission[], fromUser: Permission[]): Map<number, Permission[]>;
+/**
+ * Creates a well ordered array of simple {@link Permission}s which can be used to further calculate a user's permissions.
+ * @param	userCompanyId				Unique identifier of the {@link Company} to which the User belongs.
+ * @param	fromGroups	Collection of permissions from {@link UserGroup}s to which the User belongs.
+ * @param	fromUser		The User's user-specific permissions.
+ * @param	targetCompanyId			Unique identifier of the {@link Company} being tested for access.
+ */
+export declare function computeSimple(userCompanyId: ulong, fromGroups: Permission[], fromUser: Permission[], targetCompanyId: ulong): Permission[];
+/**
+ * Creates a {@link Dictionary} where the key is a {@link PermissionType} and the values are {@link PermissionLevel}s.
+ * @param	userCompanyId				Unique identifier of the {@link Company} to which the User belongs.
+ * @param	fromGroups	Collection of permissions from {@link UserGroup}s to which the User belongs.
+ * @param	fromUser		The User's user-specific permissions.
+ * @param	targetCompanyId			Unique identifier of the {@link Company} being tested for access.
+ */
+export declare function computeSimpleLevels(userCompanyId: ulong, fromGroups: Permission[], fromUser: Permission[], targetCompanyId: ulong): Map<PermissionType, PermissionLevel>;
+/**
+ * Gets the permission level of the given simple permission type.
+ * If the permission type specified is not found, undefined is returned instead.
+ * @param	userCompanyId				Unique identifier of the {@link Company} to which the User belongs.
+ * @param	fromGroups	Collection of permissions from {@link UserGroup}s to which the User belongs.
+ * @param	fromUser		The User's user-specific permissions.
+ * @param	targetCompanyId			Unique identifier of the {@link Company} being tested for access.
+ * @param	targetType			The specific {@link PermissionType}s to check.
+ */
+export declare function getSimpleLevel(userCompanyId: ulong, fromGroups: Permission[], fromUser: Permission[], targetCompanyId: ulong, targetType: PermissionType): PermissionLevel | undefined;
+/**
+ * Checks a specific simple permission type and level, and returns true if access is granted.
+ * @param	userCompanyId				Unique identifier of the {@link Company} to which the User belongs.
+ * @param	fromGroups	Collection of permissions from {@link UserGroup}s to which the User belongs.
+ * @param	fromUser		The User's user-specific permissions.
+ * @param	targetCompanyId			Unique identifier of the {@link Company} being tested for access.
+ * @param	targetType			The specific {@link PermissionType}s to check.
+ * @param	targetLevel		Minimum requested level of access.
+ */
+export declare function hasSimple(userCompanyId: ulong, fromGroups: Permission[], fromUser: Permission[], targetCompanyId: ulong, targetType: PermissionType, targetLevel: PermissionLevel): boolean;
+/**
+ * Checks a specific simple permission type and level from a pre-computed array of permissions, and returns true if access is granted.
+ * @param	userCompanyId				Unique identifier of the {@link Company} to which the User belongs.
+ * @param	permissions	Pre-computed and ordered array of {@link Permission} like the kind returned by {@link authorizer.computeSimple}.
+ * @param	targetType			The specific {@link PermissionType}s to check.
+ * @param	targetLevel		Minimum requested level of access.
+ */
+export declare function findSimple(userCompanyId: ulong, permissions: Permission[], targetType: PermissionType, targetLevel: PermissionLevel): boolean;
+/**
+ * Retrieves the specified simple permission level from a pre-computed array of permissions.
+ * If the permission type specified is not found, undefined is returned instead.
+ * @param	userCompanyId				Unique identifier of the {@link Company} to which the User belongs.
+ * @param	permissions	Pre-computed and ordered array of {@link Permission} like the kind returned by {@link authorizer.computeSimple}.
+ * @param	targetType			The specific {@link PermissionType}s to check.
+ */
+export declare function findSimpleLevel(userCompanyId: ulong, permissions: Permission[], targetType: PermissionType): PermissionLevel | undefined;
+/**
+ * Creates a {@link Dictionary} where the key is a {@link Company#id} and the values are well ordered arrays of complex {@link Permission}s which can be used to further calculate a user's permissions.
+ * @param	userCompanyId				Unique identifier of the {@link Company} to which the User belongs.
+ * @param	fromGroups	Collection of permissions from {@link UserGroup}s to which the User belongs.
+ * @param	fromUser		The User's user-specific permissions.
+ */
+export declare function computeAllComplex(userCompanyId: ulong, fromGroups: Permission[], fromUser: Permission[]): Map<number, Permission[]>;
+/**
+ * Creates a well ordered array of complex {@link Permission}s which can be used to further calculate a user's permissions.
+ * @param	userCompanyId				Unique identifier of the {@link Company} to which the User belongs.
+ * @param	fromGroups	Collection of permissions from {@link UserGroup}s to which the User belongs.
+ * @param	fromUser		The User's user-specific permissions.
+ * @param	targetCompanyId			Unique identifier of the {@link Company} being tested for access.
+ */
+export declare function computeComplex(userCompanyId: ulong, fromGroups: Permission[], fromUser: Permission[], targetCompanyId?: ulong): Permission[];
+/**
+ * Gets the permission level of the given complex permission type.
+ * If the permission type specified is not found, undefined is returned instead.
+ * @param	userCompanyId				Unique identifier of the {@link Company} to which the User belongs.
+ * @param	fromGroups	Collection of permissions from {@link UserGroup}s to which the User belongs.
+ * @param	fromUser		The User's user-specific permissions.
+ * @param	targetCompanyId			Unique identifier of the {@link Company} being tested for access.
+ * @param	targetCompanyLabels	List of codified {@link LabelStyle} names available in the Company.
+ * @param	targetType			The specific {@link PermissionType}s to check.
+ * @param	targetLabels		List of codified {@link LabelStyle} names used by the target.
+ */
+export declare function getComplexLevel(userCompanyId: ulong, fromGroups: Permission[], fromUser: Permission[], targetCompanyId: ulong, targetCompanyLabels: codified[], targetType: PermissionType, targetLabels: codified[]): PermissionLevel | undefined;
+/**
+ * Checks a specific complex permission type, level, and labels, and returns true if access is granted.
+ * @param	userCompanyId				Unique identifier of the {@link Company} to which the User belongs.
+ * @param	fromGroups	Collection of permissions from {@link UserGroup}s to which the User belongs.
+ * @param	fromUser		The User's user-specific permissions.
+ * @param	targetCompanyId			Unique identifier of the {@link Company} being tested for access.
+ * @param	targetCompanyLabels	List of codified {@link LabelStyle} names available in the Company.
+ * @param	targetType			The specific {@link PermissionType}s to check.
+ * @param	targetLabels		List of codified {@link LabelStyle} names used by the target.
+ * @param	targetLevel		Minimum requested level of access.
+ */
+export declare function hasComplex(userCompanyId: ulong, fromGroups: Permission[], fromUser: Permission[], targetCompanyId: ulong, targetCompanyLabels: codified[], targetType: PermissionType, targetLabels: codified[], targetLevel: PermissionLevel): boolean;
+/**
+ * Checks a specific complex permission type, level, and labels from a pre-computed array of permissions, and returns true if access is granted.
+ * @param	userCompanyId				Unique identifier of the {@link Company} to which the User belongs.
+ * @param	permissions	Pre-computed and ordered array of {@link Permission} like the kind returned by {@link authorizer.computeComplex}.
+ * @param	targetCompanyLabels	List of codified {@link LabelStyle} names available in the Company
+ * @param	targetType			The specific {@link PermissionType}s to check.
+ * @param	targetLabels		List of codified {@link LabelStyle} names used by the target.
+ * @param	targetLevel		Minimum requested level of access.
+ */
+export declare function findComplex(userCompanyId: ulong, permissions: Permission[], targetCompanyLabels: codified[], targetType: PermissionType, targetLabels: codified[], targetLevel: PermissionLevel): boolean;
+/**
+ * Retrieves the specified complex permission level from a pre-computed array of permissions.
+ * If the permission type specified is not found, undefined is returned instead.
+ * @param	userCompanyId				Unique identifier of the {@link Company} to which the User belongs.
+ * @param	permissions	Pre-computed and ordered array of {@link Permission} like the kind returned by {@link authorizer.computeComplex}.
+ * @param	targetCompanyLabels	List of codified {@link LabelStyle} names available in the Company
+ * @param	targetType			The specific {@link PermissionType}s to check.
+ * @param	targetLabels		List of codified {@link LabelStyle} names used by the target.
+ */
+export declare function findComplexLevel(userCompanyId: ulong, permissions: Permission[], targetCompanyLabels: codified[], targetType: PermissionType, targetLabels: codified[]): PermissionLevel | undefined;
+/**
+ * Checks a specific complex permission type, level, but not the labels, and returns true if access is granted.
+ * This method can be used as a short-circuit to diving deeper into check label specific permissions.
+ * @param	userCompanyId				Unique identifier of the {@link Company} to which the User belongs.
+ * @param	fromGroups	Collection of permissions from {@link UserGroup}s to which the User belongs.
+ * @param	fromUser		The User's user-specific permissions.
+ * @param	targetCompanyId			Unique identifier of the {@link Company} being tested for access.
+ * @param	targetType			The specific {@link PermissionType}s to check.
+ * @param	targetLevel		Optional level of access. If not specified, default is {@link PermissionLevel.read}.
+ */
+export declare function hasAnyComplex(userCompanyId: ulong, fromGroups: Permission[], fromUser: Permission[], targetCompanyId: ulong, targetType: PermissionType, targetLevel: PermissionLevel): boolean;
+/**
+ * Checks a specific complex permission type, level, but not the labels, and returns true if access is granted.
+ * This method can be used as a short-circuit to diving deeper into check label specific permissions.
+ * @param	userCompanyId				Unique identifier of the {@link Company} to which the User belongs.
+ * @param	permissions	Pre-computed and ordered array of {@link Permission} like the kind returned by {@link authorizer.computeComplex}.
+ * @param	targetType			The specific {@link PermissionType}s to check.
+ * @param	targetLevel		Optional level of access. If not specified, default is {@link PermissionLevel.read}.
+ */
+export declare function findAnyComplex(userCompanyId: ulong, permissions: Permission[], targetType: PermissionType, targetLevel: PermissionLevel): boolean;
+/**
+ * Generates a {@link Dictionary} (company identifier as the key) of permissions being escalated between two computed permission states.
+ * @param	userCompanyId								Unique identifier of the {@link Company} to which the User belongs.
+ * @param	before		Initial state of fully computed list of permissions (like returned by returned by {@link authorizer.computeAll}).
+ * @param	after		Proposed state of computed permissions (like returned by {@link authorizer.computeAll}).
+ * @param	targetCompaniesLabels	{@link Dictionary} of company and list of codified {@link LabelStyle} names available.  If not specified, complex permissions will not be evaluated correctly.
+ */
+export declare function findAllEscalations(userCompanyId: ulong, before: Map<ulong, Permission[]>, after: Map<ulong, Permission[]>, targetCompaniesLabels: Map<ulong, codified[]>): Map<number, PermissionEscalation[]>;
+/**
+ * Generates an array of permissions being escalated between two computed permission states for a target company.
+ * @param	userCompanyId								Unique identifier of the {@link Company} to which the User belongs.
+ * @param	before						Initial list of computed permissions for a company (like returned by {@link authorizer.compute}).
+ * @param	after						Proposed list of computed permissions for a company (like returned by {@link authorizer.compute}).
+ * @param	targetCompanyLabels					List of codified {@link LabelStyle} names available in the Company.  If not specified, complex permissions will not be evaluated correctly.
+ */
+export declare function findEscalations(userCompanyId: ulong, before: Permission[], after: Permission[], targetCompanyLabels: codified[]): PermissionEscalation[];
+/**
+ * Generates a list of labels that create an escalated permission state after the proposed modification.
+ * @param	userCompanyId							Unique identifier of the Company to which the User belongs.
+ * @param	targetCompanyPermissions	List of computed permissions for a company (like returned by {@link authorizer.compute}).
+ * @param	targetTypes				List of {@link PermissionType}s to check.
+ * @param	targetCompanyLabels				List of codified {@link LabelStyle} names available in the {@link Company}.
+ * @param	targetBeforeLabels				The labels appled to the ILabelled object before the proposed change.
+ * @param	targetAfterLabels				The labels appled to the ILabelled object after the proposed change.
+ */
+export declare function findAllLabelEscalations(userCompanyId: ulong, targetCompanyPermissions: Permission[], targetTypes: PermissionType[], targetCompanyLabels: codified[], targetBeforeLabels: codified[], targetAfterLabels: codified[]): PermissionEscalation[];
+/**
+ * Generates a list of labels that create an escalated permission state after the proposed modification to an labelled object.
+ * @param	userCompanyId							Unique identifier of the Company to which the User belongs.
+ * @param	targetCompanyPermissions	List of computed permissions for a single company (like returned by {@link authorizer.compute}).
+ * @param	targetType						The specific {@link PermissionType} to check.
+ * @param	targetCompanyLabels				List of codified {@link LabelStyle} names available in the {@link Company}.
+ * @param	targetBeforeLabels				The labels appled to the ILabelled object before the proposed change.
+ * @param	targetAfterLabels				The labels appled to the ILabelled object after the proposed change.
+ */
+export declare function findLabelEscalation(userCompanyId: ulong, targetCompanyPermissions: Permission[], targetType: PermissionType, targetCompanyLabels: codified[], targetBeforeLabels?: codified[], targetAfterLabels?: codified[]): PermissionEscalation | null;
+//# sourceMappingURL=Authorizer.d.ts.map

package/Accounts/Permissions/Permission.d.ts

@@ -0,0 +1,57 @@
+import { IBelongCompany } from '../../API/Interfaces/IBelongCompany';
+import { ISerializable } from '../../API/Interfaces/ISerializable';
+import { codified, JsonObject, nothing, ulong } from '../../API/Types';
+import { Company } from '../../Companies/Company';
+import { PermissionLevel } from './PermissionLevel';
+import { PermissionMethod } from './PermissionMethod';
+import { PermissionType } from './PermissionType';
+/**
+ * A defined permission for {@link User}s, {@link UserGroup}s, and {@link Machine}s.
+ */
+export declare class Permission implements IBelongCompany, ISerializable {
+    /**
+     *
+     * @param json
+     * @returns
+     */
+    static fromJSON(json: JsonObject): Permission;
+    /**
+     * The {@link Company.id} that this permission targets.
+     */
+    companyId: ulong;
+    /**
+     * The {@link Company} that this permission targets.
+     */
+    get company(): Company;
+    /**
+     * The type of permission.
+     */
+    kind: PermissionType;
+    /**
+     * The kind of permission.
+     * @deprecated Use {@link kind} instead.
+     */
+    get type(): string;
+    set type(value: string);
+    /**
+     * The level of access being defined.
+     */
+    level: PermissionLevel;
+    /**
+     * The way the access is used.
+     */
+    method: PermissionMethod;
+    /**
+     * Codified names of {@link LabelStyle}s.  If list is empty, this permission applies for all labels.
+     */
+    labels: codified[];
+    constructor(company?: ulong | nothing, kind?: PermissionType | nothing, level?: PermissionLevel | nothing, method?: PermissionMethod | nothing, labels?: codified[] | nothing);
+    toJSON(): {
+        company: number | null;
+        kind: PermissionType;
+        level: PermissionLevel;
+        method: PermissionMethod;
+        labels: string[];
+    };
+}
+//# sourceMappingURL=Permission.d.ts.map

package/Accounts/Permissions/PermissionEscalation.d.ts

@@ -0,0 +1,42 @@
+import { ISerializable } from "../../API/Interfaces/ISerializable";
+import { codified, JsonObject, nothing, ulong } from "../../API/Types";
+import { PermissionEscalationState } from "./PermissionEscalationState";
+import { PermissionEscalationType } from "./PermissionEscalationType";
+import { PermissionLevel } from "./PermissionLevel";
+import { PermissionType } from "./PermissionType";
+/**
+ * Used to throw permission escalation exceptions, this is similar to a {@link Permission},
+ * but defines a {@link before} and {@link after} for a proposed change.
+ */
+export declare class PermissionEscalation implements ISerializable {
+    /**
+     * Parses a JSON object into a PermissionEscalation instance.
+     * @param json The JSON to parse.
+     * @returns A PermissionEscalation instance.
+     */
+    static fromJSON(json: JsonObject): PermissionEscalation;
+    /**
+     * Gets the direction of the escalation.
+     */
+    direction: PermissionEscalationType;
+    /**
+     * The {@link Company} that this permission targets.
+     * {@link Company.id}
+     */
+    company: ulong;
+    /**
+     * The type of permission.
+     */
+    kind: PermissionType;
+    /**
+     * Effective permission after the proposed change.
+     */
+    after: PermissionEscalationState;
+    /**
+     * Effective permission before the proposed change.
+     */
+    before: PermissionEscalationState;
+    constructor(direction: PermissionEscalationType, company: ulong, kind: PermissionType, levelAfter: PermissionLevel, labelsAfter?: codified[] | nothing, levelBefore?: PermissionLevel | nothing, labelsBefore?: codified[] | nothing);
+    toJSON(): JsonObject;
+}
+//# sourceMappingURL=PermissionEscalation.d.ts.map

package/Accounts/Permissions/PermissionEscalationState.d.ts

@@ -0,0 +1,20 @@
+import { ISerializable } from "../../API/Interfaces/ISerializable";
+import { codified, JsonObject, nothing } from "../../API/Types";
+import { PermissionLevel } from "./PermissionLevel";
+/**
+ * Describes the changes in state that raised the escalation.
+ */
+export declare class PermissionEscalationState implements ISerializable {
+    /**
+     * The level of access defined before the proposed change.
+     */
+    level: PermissionLevel | null;
+    /**
+     * Codified names of {@link LabelStyle}s.
+     * If list is empty, this permission applies for all labels.
+     */
+    labels: codified[] | null;
+    constructor(level?: PermissionLevel | nothing, labels?: codified[] | nothing);
+    toJSON(): JsonObject;
+}
+//# sourceMappingURL=PermissionEscalationState.d.ts.map