@twin.org/entity 0.0.1-next.1

package/dist/types/models/IEntitySchemaOptions.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Definition for an entity schema options.
+ */
+export interface IEntitySchemaOptions {
+    /**
+     * Description of the object.
+     */
+    description?: string;
+}

package/dist/types/models/IEntitySchemaProperty.d.ts

@@ -0,0 +1,52 @@
+import type { EntitySchemaPropertyFormat } from "./entitySchemaPropertyFormat";
+import type { EntitySchemaPropertyType } from "./entitySchemaPropertyType";
+import type { SortDirection } from "./sortDirection";
+/**
+ * Definition for an entity schema property.
+ */
+export interface IEntitySchemaProperty<T = unknown> {
+    /**
+     * The property name from the entity.
+     */
+    property: keyof T;
+    /**
+     * The type of the property.
+     */
+    type: EntitySchemaPropertyType;
+    /**
+     * The format of the property.
+     */
+    format?: EntitySchemaPropertyFormat;
+    /**
+     * Is this the primary index property.
+     */
+    isPrimary?: boolean;
+    /**
+     * Is this a secondary index property.
+     */
+    isSecondary?: boolean;
+    /**
+     * Default sort direction for this field, leave empty if not sortable.
+     */
+    sortDirection?: SortDirection;
+    /**
+     * Is the property optional.
+     */
+    optional?: boolean;
+    /**
+     * The type of the item (only applies when type is `array`).
+     */
+    itemType?: EntitySchemaPropertyType;
+    /**
+     * The type ref of the item (only applies when type is either `array` or `object`).
+     */
+    itemTypeRef?: string;
+    /**
+     * Description of the object.
+     */
+    description?: string;
+    /**
+     * Examples of the property values.
+     */
+    examples?: unknown[];
+}

package/dist/types/models/IEntitySort.d.ts

@@ -0,0 +1,19 @@
+import type { EntitySchemaPropertyType } from "./entitySchemaPropertyType";
+import type { SortDirection } from "./sortDirection";
+/**
+ * Definition of an entity property sort details.
+ */
+export interface IEntitySort<T> {
+    /**
+     * The name of the property.
+     */
+    property: keyof T;
+    /**
+     * The type of the property.
+     */
+    type: EntitySchemaPropertyType;
+    /**
+     * Default sort direction for this column, leave empty if not sortable.
+     */
+    sortDirection: SortDirection;
+}

package/dist/types/models/comparisonOperator.d.ts

@@ -0,0 +1,52 @@
+/**
+ * The types of comparisons.
+ */
+export declare const ComparisonOperator: {
+    /**
+     * Equals.
+     */
+    readonly Equals: "equals";
+    /**
+     * Not Equals.
+     */
+    readonly NotEquals: "not-equals";
+    /**
+     * Greater Than.
+     */
+    readonly GreaterThan: "greater-than";
+    /**
+     * Greater Than Or Equal.
+     */
+    readonly GreaterThanOrEqual: "greater-than-or-equal";
+    /**
+     * Less Than.
+     */
+    readonly LessThan: "less-than";
+    /**
+     * Less Than Or Equal.
+     */
+    readonly LessThanOrEqual: "less-than-or-equal";
+    /**
+     * Includes.
+     * A string in a substring.
+     * A set contains an element.
+     * A list contains an element.
+     */
+    readonly Includes: "includes";
+    /**
+     * Not Includes.
+     * A string not in a substring.
+     * A set does not contain an element.
+     * A list does not contain an element.
+     */
+    readonly NotIncludes: "not-includes";
+    /**
+     * In.
+     * A element is in a set.
+     */
+    readonly In: "in";
+};
+/**
+ * The types of comparisons.
+ */
+export type ComparisonOperator = (typeof ComparisonOperator)[keyof typeof ComparisonOperator];

package/dist/types/models/entityCondition.d.ts

@@ -0,0 +1,6 @@
+import type { IComparator } from "./IComparator";
+import type { IComparatorGroup } from "./IComparatorGroup";
+/**
+ * Type defining condition for entities filtering.
+ */
+export type EntityCondition<T> = IComparator | IComparatorGroup<T>;

package/dist/types/models/entitySchemaPropertyFormat.d.ts

@@ -0,0 +1,77 @@
+/**
+ * Definition of the entity property format.
+ */
+export declare const EntitySchemaPropertyFormat: {
+    /**
+     * UUID.
+     */
+    readonly Uuid: "uuid";
+    /**
+     * URI.
+     */
+    readonly Uri: "uri";
+    /**
+     * email.
+     */
+    readonly Email: "email";
+    /**
+     * int8.
+     */
+    readonly Int8: "int8";
+    /**
+     * uint8.
+     */
+    readonly Uint8: "uint8";
+    /**
+     * int16.
+     */
+    readonly Int16: "int16";
+    /**
+     * uint16.
+     */
+    readonly Uint16: "uint16";
+    /**
+     * int32.
+     */
+    readonly Int32: "int32";
+    /**
+     * uint32.
+     */
+    readonly Uint32: "uint32";
+    /**
+     * float.
+     */
+    readonly Float: "float";
+    /**
+     * double.
+     */
+    readonly Double: "double";
+    /**
+     * int64.
+     */
+    readonly Int64: "int64";
+    /**
+     * uint64.
+     */
+    readonly Uint64: "uint64";
+    /**
+     * date.
+     */
+    readonly Date: "date";
+    /**
+     * time.
+     */
+    readonly Time: "time";
+    /**
+     * date-time.
+     */
+    readonly DateTime: "date-time";
+    /**
+     * JSON.
+     */
+    readonly Json: "json";
+};
+/**
+ * Definition of the entity property type's format.
+ */
+export type EntitySchemaPropertyFormat = (typeof EntitySchemaPropertyFormat)[keyof typeof EntitySchemaPropertyFormat];

package/dist/types/models/entitySchemaPropertyType.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Definition of the entity property types.
+ */
+export declare const EntitySchemaPropertyType: {
+    /**
+     * String.
+     */
+    readonly String: "string";
+    /**
+     * Number.
+     */
+    readonly Number: "number";
+    /**
+     * Integer.
+     */
+    readonly Integer: "integer";
+    /**
+     * Boolean.
+     */
+    readonly Boolean: "boolean";
+    /**
+     * Array.
+     */
+    readonly Array: "array";
+    /**
+     * Object.
+     */
+    readonly Object: "object";
+};
+/**
+ * Definition of the entity property types.
+ */
+export type EntitySchemaPropertyType = (typeof EntitySchemaPropertyType)[keyof typeof EntitySchemaPropertyType];

package/dist/types/models/logicalOperator.d.ts

@@ -0,0 +1,17 @@
+/**
+ * The logical operators for condition combining.
+ */
+export declare const LogicalOperator: {
+    /**
+     * Logical operator AND.
+     */
+    readonly And: "and";
+    /**
+     * Logical operator OR.
+     */
+    readonly Or: "or";
+};
+/**
+ * The logical operators for condition combining.
+ */
+export type LogicalOperator = (typeof LogicalOperator)[keyof typeof LogicalOperator];

package/dist/types/models/sortDirection.d.ts

@@ -0,0 +1,17 @@
+/**
+ * The sort directions.
+ */
+export declare const SortDirection: {
+    /**
+     * Ascending.
+     */
+    readonly Ascending: "asc";
+    /**
+     * Descending.
+     */
+    readonly Descending: "desc";
+};
+/**
+ * The sort directions.
+ */
+export type SortDirection = (typeof SortDirection)[keyof typeof SortDirection];

package/dist/types/utils/decoratorHelper.d.ts

@@ -0,0 +1,19 @@
+import "reflect-metadata";
+import type { IEntitySchema } from "../models/IEntitySchema";
+/**
+ * Class to help with decorators.
+ */
+export declare class DecoratorHelper {
+    /**
+     * Get the schema from the reflection metadata.
+     * @param target The object to get the schema data from.
+     * @returns The schema from the metadata if it can be found.
+     */
+    static getSchema<T = unknown>(target: any): IEntitySchema<T>;
+    /**
+     * Set the schema from the reflection metadata.
+     * @param target The object to get the schema data from.
+     * @param entitySchema The schema to set.
+     */
+    static setSchema<T = unknown>(target: any, entitySchema: IEntitySchema<T>): void;
+}

package/dist/types/utils/entityConditions.d.ts

@@ -0,0 +1,21 @@
+import type { EntityCondition } from "../models/entityCondition";
+import type { IComparator } from "../models/IComparator";
+/**
+ * Class to perform condition checks.
+ */
+export declare class EntityConditions {
+    /**
+     * See if the entity matches the conditions.
+     * @param entity The entity to test.
+     * @param condition The conditions to test.
+     * @returns True if the entity matches.
+     */
+    static check<T>(entity: T, condition?: EntityCondition<T>): boolean;
+    /**
+     * See if the entity matches the conditions.
+     * @param entity The entity to test.
+     * @param comparator The condition to test.
+     * @returns True if the entity matches.
+     */
+    static compare<T>(entity: T, comparator: IComparator): boolean;
+}

package/dist/types/utils/entitySchemaHelper.d.ts

@@ -0,0 +1,38 @@
+import type { IEntitySchema } from "../models/IEntitySchema";
+import type { IEntitySchemaProperty } from "../models/IEntitySchemaProperty";
+import type { IEntitySort } from "../models/IEntitySort";
+import type { SortDirection } from "../models/sortDirection";
+/**
+ * Class to help with entity schema operations.
+ */
+export declare class EntitySchemaHelper {
+    /**
+     * Get the schema for the specified object.
+     * @param target The object to get the schema data for.
+     * @returns The schema for the object if it can be found.
+     */
+    static getSchema<T = unknown>(target: any): IEntitySchema<T>;
+    /**
+     * Get the primary key from the entity schema.
+     * @param entitySchema The entity schema to find the primary key from.
+     * @returns The key if only one was found.
+     * @throws If no primary key was found, or more than one.
+     */
+    static getPrimaryKey<T>(entitySchema: IEntitySchema<T>): IEntitySchemaProperty<T>;
+    /**
+     * Get the sort properties from the schema.
+     * @param entitySchema The entity schema to find the primary key from.
+     * @returns The sort keys from the schema or undefined if there are none.
+     */
+    static getSortProperties<T>(entitySchema: IEntitySchema<T>): IEntitySort<T>[] | undefined;
+    /**
+     * Build sort properties from the schema and override if necessary.
+     * @param entitySchema The entity schema to retrieve the default sort keys.
+     * @param overrideSortKeys The override sort keys.
+     * @returns The finalised sort keys.
+     */
+    static buildSortProperties<T>(entitySchema: IEntitySchema<T>, overrideSortKeys?: {
+        property: keyof T;
+        sortDirection: SortDirection;
+    }[]): IEntitySort<T>[] | undefined;
+}

package/dist/types/utils/entitySorter.d.ts

@@ -0,0 +1,25 @@
+import type { EntitySchemaPropertyType } from "../models/entitySchemaPropertyType";
+import type { IEntitySort } from "../models/IEntitySort";
+import { SortDirection } from "../models/sortDirection";
+/**
+ * Class to perform sort operations on entities.
+ */
+export declare class EntitySorter {
+    /**
+     * Sort a list of entities using multiple keys and direction.
+     * @param entities The list of entities.
+     * @param entitySorters The sort keys to use.
+     * @returns The sorted list.
+     */
+    static sort<T>(entities: T[], entitySorters?: IEntitySort<T>[]): T[];
+    /**
+     * Compare two properties.
+     * @param entity1 The first entity.
+     * @param entity2 The second entity.
+     * @param prop The property to compare.
+     * @param type The type of the property.
+     * @param direction The direction of the sort.
+     * @returns The result of the comparison.
+     */
+    static compare<T>(entity1: T, entity2: T, prop: keyof T, type: EntitySchemaPropertyType, direction?: SortDirection): number;
+}

package/docs/changelog.md

@@ -0,0 +1,5 @@
+# @twin.org/entity - Changelog
+
+## v0.0.1
+
+- Initial Release

package/docs/examples.md

@@ -0,0 +1 @@
+# @twin.org/entity - Examples

package/docs/reference/classes/DecoratorHelper.md

@@ -0,0 +1,63 @@
+# Class: DecoratorHelper
+
+Class to help with decorators.
+
+## Constructors
+
+### new DecoratorHelper()
+
+> **new DecoratorHelper**(): [`DecoratorHelper`](DecoratorHelper.md)
+
+#### Returns
+
+[`DecoratorHelper`](DecoratorHelper.md)
+
+## Methods
+
+### getSchema()
+
+> `static` **getSchema**\<`T`\>(`target`): [`IEntitySchema`](../interfaces/IEntitySchema.md)\<`T`\>
+
+Get the schema from the reflection metadata.
+
+#### Type Parameters
+
+• **T** = `unknown`
+
+#### Parameters
+
+• **target**: `any`
+
+The object to get the schema data from.
+
+#### Returns
+
+[`IEntitySchema`](../interfaces/IEntitySchema.md)\<`T`\>
+
+The schema from the metadata if it can be found.
+
+***
+
+### setSchema()
+
+> `static` **setSchema**\<`T`\>(`target`, `entitySchema`): `void`
+
+Set the schema from the reflection metadata.
+
+#### Type Parameters
+
+• **T** = `unknown`
+
+#### Parameters
+
+• **target**: `any`
+
+The object to get the schema data from.
+
+• **entitySchema**: [`IEntitySchema`](../interfaces/IEntitySchema.md)\<`T`\>
+
+The schema to set.
+
+#### Returns
+
+`void`

package/docs/reference/classes/EntityConditions.md

@@ -0,0 +1,69 @@
+# Class: EntityConditions
+
+Class to perform condition checks.
+
+## Constructors
+
+### new EntityConditions()
+
+> **new EntityConditions**(): [`EntityConditions`](EntityConditions.md)
+
+#### Returns
+
+[`EntityConditions`](EntityConditions.md)
+
+## Methods
+
+### check()
+
+> `static` **check**\<`T`\>(`entity`, `condition`?): `boolean`
+
+See if the entity matches the conditions.
+
+#### Type Parameters
+
+• **T**
+
+#### Parameters
+
+• **entity**: `T`
+
+The entity to test.
+
+• **condition?**: [`EntityCondition`](../type-aliases/EntityCondition.md)\<`T`\>
+
+The conditions to test.
+
+#### Returns
+
+`boolean`
+
+True if the entity matches.
+
+***
+
+### compare()
+
+> `static` **compare**\<`T`\>(`entity`, `comparator`): `boolean`
+
+See if the entity matches the conditions.
+
+#### Type Parameters
+
+• **T**
+
+#### Parameters
+
+• **entity**: `T`
+
+The entity to test.
+
+• **comparator**: [`IComparator`](../interfaces/IComparator.md)
+
+The condition to test.
+
+#### Returns
+
+`boolean`
+
+True if the entity matches.

package/docs/reference/classes/EntitySchemaHelper.md

@@ -0,0 +1,117 @@
+# Class: EntitySchemaHelper
+
+Class to help with entity schema operations.
+
+## Constructors
+
+### new EntitySchemaHelper()
+
+> **new EntitySchemaHelper**(): [`EntitySchemaHelper`](EntitySchemaHelper.md)
+
+#### Returns
+
+[`EntitySchemaHelper`](EntitySchemaHelper.md)
+
+## Methods
+
+### getSchema()
+
+> `static` **getSchema**\<`T`\>(`target`): [`IEntitySchema`](../interfaces/IEntitySchema.md)\<`T`\>
+
+Get the schema for the specified object.
+
+#### Type Parameters
+
+• **T** = `unknown`
+
+#### Parameters
+
+• **target**: `any`
+
+The object to get the schema data for.
+
+#### Returns
+
+[`IEntitySchema`](../interfaces/IEntitySchema.md)\<`T`\>
+
+The schema for the object if it can be found.
+
+***
+
+### getPrimaryKey()
+
+> `static` **getPrimaryKey**\<`T`\>(`entitySchema`): [`IEntitySchemaProperty`](../interfaces/IEntitySchemaProperty.md)\<`T`\>
+
+Get the primary key from the entity schema.
+
+#### Type Parameters
+
+• **T**
+
+#### Parameters
+
+• **entitySchema**: [`IEntitySchema`](../interfaces/IEntitySchema.md)\<`T`\>
+
+The entity schema to find the primary key from.
+
+#### Returns
+
+[`IEntitySchemaProperty`](../interfaces/IEntitySchemaProperty.md)\<`T`\>
+
+The key if only one was found.
+
+#### Throws
+
+If no primary key was found, or more than one.
+
+***
+
+### getSortProperties()
+
+> `static` **getSortProperties**\<`T`\>(`entitySchema`): `undefined` \| [`IEntitySort`](../interfaces/IEntitySort.md)\<`T`\>[]
+
+Get the sort properties from the schema.
+
+#### Type Parameters
+
+• **T**
+
+#### Parameters
+
+• **entitySchema**: [`IEntitySchema`](../interfaces/IEntitySchema.md)\<`T`\>
+
+The entity schema to find the primary key from.
+
+#### Returns
+
+`undefined` \| [`IEntitySort`](../interfaces/IEntitySort.md)\<`T`\>[]
+
+The sort keys from the schema or undefined if there are none.
+
+***
+
+### buildSortProperties()
+
+> `static` **buildSortProperties**\<`T`\>(`entitySchema`, `overrideSortKeys`?): `undefined` \| [`IEntitySort`](../interfaces/IEntitySort.md)\<`T`\>[]
+
+Build sort properties from the schema and override if necessary.
+
+#### Type Parameters
+
+• **T**
+
+#### Parameters
+
+• **entitySchema**: [`IEntitySchema`](../interfaces/IEntitySchema.md)\<`T`\>
+
+The entity schema to retrieve the default sort keys.
+
+• **overrideSortKeys?**: `object`[]
+
+The override sort keys.
+
+#### Returns
+
+`undefined` \| [`IEntitySort`](../interfaces/IEntitySort.md)\<`T`\>[]
+
+The finalised sort keys.