@twin.org/entity 0.0.2-next.9 → 0.0.3-next.2

package/dist/es/decorators/entityDecorator.js

@@ -0,0 +1,19 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import "reflect-metadata";
+import { DecoratorHelper } from "../utils/decoratorHelper.js";
+/**
+ * Decorator to produce schema data for entity.
+ * @param options The options for the entity.
+ * @returns The class decorator.
+ */
+export function entity(options) {
+    return (target) => {
+        const entitySchema = DecoratorHelper.getSchema(target);
+        entitySchema.type = target.name;
+        entitySchema.options = options;
+        DecoratorHelper.setSchema(target, entitySchema);
+    };
+}
+//# sourceMappingURL=entityDecorator.js.map

package/dist/es/decorators/entityDecorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"entityDecorator.js","sourceRoot":"","sources":["../../../src/decorators/entityDecorator.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,uDAAuD;AACvD,OAAO,kBAAkB,CAAC;AAE1B,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAE9D;;;;GAIG;AACH,MAAM,UAAU,MAAM,CAAC,OAA8B;IACpD,OAAO,CAAC,MAAW,EAAE,EAAE;QACtB,MAAM,YAAY,GAAG,eAAe,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QACvD,YAAY,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;QAChC,YAAY,CAAC,OAAO,GAAG,OAAO,CAAC;QAC/B,eAAe,CAAC,SAAS,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IACjD,CAAC,CAAC;AACH,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n/* eslint-disable @typescript-eslint/no-explicit-any */\nimport \"reflect-metadata\";\nimport type { IEntitySchemaOptions } from \"../models/IEntitySchemaOptions.js\";\nimport { DecoratorHelper } from \"../utils/decoratorHelper.js\";\n\n/**\n * Decorator to produce schema data for entity.\n * @param options The options for the entity.\n * @returns The class decorator.\n */\nexport function entity(options?: IEntitySchemaOptions): any {\n\treturn (target: any) => {\n\t\tconst entitySchema = DecoratorHelper.getSchema(target);\n\t\tentitySchema.type = target.name;\n\t\tentitySchema.options = options;\n\t\tDecoratorHelper.setSchema(target, entitySchema);\n\t};\n}\n"]}

package/dist/es/decorators/propertyDecorator.js

@@ -0,0 +1,31 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import "reflect-metadata";
+import { DecoratorHelper } from "../utils/decoratorHelper.js";
+/**
+ * Decorator to produce schema property data for entities.
+ * @param options The options for the property.
+ * @returns The property decorator.
+ */
+export function property(options) {
+    return (target, propertyKey) => {
+        const entitySchema = DecoratorHelper.getSchema(target);
+        entitySchema.properties ??= [];
+        const idx = entitySchema.properties.findIndex(p => p.property === propertyKey);
+        if (idx !== -1) {
+            entitySchema.properties[idx] = {
+                ...options,
+                property: propertyKey
+            };
+        }
+        else {
+            entitySchema.properties.push({
+                ...options,
+                property: propertyKey
+            });
+        }
+        DecoratorHelper.setSchema(target, entitySchema);
+    };
+}
+//# sourceMappingURL=propertyDecorator.js.map

package/dist/es/decorators/propertyDecorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"propertyDecorator.js","sourceRoot":"","sources":["../../../src/decorators/propertyDecorator.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,uDAAuD;AACvD,OAAO,kBAAkB,CAAC;AAE1B,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAE9D;;;;GAIG;AACH,MAAM,UAAU,QAAQ,CAAC,OAAgD;IACxE,OAAO,CAAC,MAAW,EAAE,WAAmB,EAAE,EAAE;QAC3C,MAAM,YAAY,GAAG,eAAe,CAAC,SAAS,CAAM,MAAM,CAAC,CAAC;QAC5D,YAAY,CAAC,UAAU,KAAK,EAAE,CAAC;QAC/B,MAAM,GAAG,GAAG,YAAY,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,WAAW,CAAC,CAAC;QAC/E,IAAI,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC;YAChB,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG;gBAC9B,GAAG,OAAO;gBACV,QAAQ,EAAE,WAAW;aACrB,CAAC;QACH,CAAC;aAAM,CAAC;YACP,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC;gBAC5B,GAAG,OAAO;gBACV,QAAQ,EAAE,WAAW;aACrB,CAAC,CAAC;QACJ,CAAC;QACD,eAAe,CAAC,SAAS,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IACjD,CAAC,CAAC;AACH,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n/* eslint-disable @typescript-eslint/no-explicit-any */\nimport \"reflect-metadata\";\nimport type { IEntitySchemaProperty } from \"../models/IEntitySchemaProperty.js\";\nimport { DecoratorHelper } from \"../utils/decoratorHelper.js\";\n\n/**\n * Decorator to produce schema property data for entities.\n * @param options The options for the property.\n * @returns The property decorator.\n */\nexport function property(options: Omit<IEntitySchemaProperty, \"property\">): any {\n\treturn (target: any, propertyKey: string) => {\n\t\tconst entitySchema = DecoratorHelper.getSchema<any>(target);\n\t\tentitySchema.properties ??= [];\n\t\tconst idx = entitySchema.properties.findIndex(p => p.property === propertyKey);\n\t\tif (idx !== -1) {\n\t\t\tentitySchema.properties[idx] = {\n\t\t\t\t...options,\n\t\t\t\tproperty: propertyKey\n\t\t\t};\n\t\t} else {\n\t\t\tentitySchema.properties.push({\n\t\t\t\t...options,\n\t\t\t\tproperty: propertyKey\n\t\t\t});\n\t\t}\n\t\tDecoratorHelper.setSchema(target, entitySchema);\n\t};\n}\n"]}

package/dist/es/factories/entitySchemaFactory.js

@@ -0,0 +1,9 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { Factory } from "@twin.org/core";
+/**
+ * Factory for creating entity schemas.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const EntitySchemaFactory = Factory.createFactory("entity-schema");
+//# sourceMappingURL=entitySchemaFactory.js.map

package/dist/es/factories/entitySchemaFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"entitySchemaFactory.js","sourceRoot":"","sources":["../../../src/factories/entitySchemaFactory.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAGzC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,mBAAmB,GAAG,OAAO,CAAC,aAAa,CAAgB,eAAe,CAAC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Factory } from \"@twin.org/core\";\nimport type { IEntitySchema } from \"../models/IEntitySchema.js\";\n\n/**\n * Factory for creating entity schemas.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const EntitySchemaFactory = Factory.createFactory<IEntitySchema>(\"entity-schema\");\n"]}

package/dist/es/index.js

@@ -0,0 +1,22 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export * from "./decorators/entityDecorator.js";
+export * from "./decorators/propertyDecorator.js";
+export * from "./factories/entitySchemaFactory.js";
+export * from "./models/comparisonOperator.js";
+export * from "./models/entityCondition.js";
+export * from "./models/entitySchemaPropertyFormat.js";
+export * from "./models/entitySchemaPropertyType.js";
+export * from "./models/IComparator.js";
+export * from "./models/IComparatorGroup.js";
+export * from "./models/IEntitySchema.js";
+export * from "./models/IEntitySchemaOptions.js";
+export * from "./models/IEntitySchemaProperty.js";
+export * from "./models/IEntitySort.js";
+export * from "./models/logicalOperator.js";
+export * from "./models/sortDirection.js";
+export * from "./utils/decoratorHelper.js";
+export * from "./utils/entityConditions.js";
+export * from "./utils/entitySchemaHelper.js";
+export * from "./utils/entitySorter.js";
+//# sourceMappingURL=index.js.map

package/dist/es/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,iCAAiC,CAAC;AAChD,cAAc,mCAAmC,CAAC;AAClD,cAAc,oCAAoC,CAAC;AACnD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,wCAAwC,CAAC;AACvD,cAAc,sCAAsC,CAAC;AACrD,cAAc,yBAAyB,CAAC;AACxC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,kCAAkC,CAAC;AACjD,cAAc,mCAAmC,CAAC;AAClD,cAAc,yBAAyB,CAAC;AACxC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,yBAAyB,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./decorators/entityDecorator.js\";\nexport * from \"./decorators/propertyDecorator.js\";\nexport * from \"./factories/entitySchemaFactory.js\";\nexport * from \"./models/comparisonOperator.js\";\nexport * from \"./models/entityCondition.js\";\nexport * from \"./models/entitySchemaPropertyFormat.js\";\nexport * from \"./models/entitySchemaPropertyType.js\";\nexport * from \"./models/IComparator.js\";\nexport * from \"./models/IComparatorGroup.js\";\nexport * from \"./models/IEntitySchema.js\";\nexport * from \"./models/IEntitySchemaOptions.js\";\nexport * from \"./models/IEntitySchemaProperty.js\";\nexport * from \"./models/IEntitySort.js\";\nexport * from \"./models/logicalOperator.js\";\nexport * from \"./models/sortDirection.js\";\nexport * from \"./utils/decoratorHelper.js\";\nexport * from \"./utils/entityConditions.js\";\nexport * from \"./utils/entitySchemaHelper.js\";\nexport * from \"./utils/entitySorter.js\";\n"]}

package/dist/es/models/IComparator.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IComparator.js.map

package/dist/es/models/IComparator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IComparator.js","sourceRoot":"","sources":["../../../src/models/IComparator.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { ComparisonOperator } from \"./comparisonOperator.js\";\n\n/**\n * Interface defining comparator operator.\n */\nexport interface IComparator {\n\t/**\n\t * The name of the property in the object to check.\n\t */\n\tproperty: string;\n\n\t/**\n\t * The value of the property to check.\n\t */\n\tvalue: unknown;\n\n\t/**\n\t * The comparison to perform.\n\t */\n\tcomparison: ComparisonOperator;\n}\n"]}

package/dist/es/models/IComparatorGroup.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IComparatorGroup.js.map

package/dist/es/models/IComparatorGroup.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IComparatorGroup.js","sourceRoot":"","sources":["../../../src/models/IComparatorGroup.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { EntityCondition } from \"./entityCondition.js\";\nimport type { LogicalOperator } from \"./logicalOperator.js\";\n\n/**\n * Interface defining condition group operator.\n */\nexport interface IComparatorGroup<T = unknown> {\n\t/**\n\t * The conditions to join in a group.\n\t */\n\tconditions: EntityCondition<T>[];\n\n\t/**\n\t * The logical operator to use.\n\t */\n\tlogicalOperator?: LogicalOperator;\n}\n"]}

package/dist/es/models/IEntitySchema.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IEntitySchema.js.map

package/dist/es/models/IEntitySchema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IEntitySchema.js","sourceRoot":"","sources":["../../../src/models/IEntitySchema.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IEntitySchemaOptions } from \"./IEntitySchemaOptions.js\";\nimport type { IEntitySchemaProperty } from \"./IEntitySchemaProperty.js\";\n\n/**\n * Definition for an entity schema.\n */\nexport interface IEntitySchema<T = unknown> {\n\t/**\n\t * The type of the entity.\n\t */\n\ttype: string | undefined;\n\n\t/**\n\t * The options for the entity.\n\t */\n\toptions?: IEntitySchemaOptions;\n\n\t/**\n\t * The properties of the entity.\n\t */\n\tproperties?: IEntitySchemaProperty<T>[];\n}\n"]}

package/dist/es/models/IEntitySchemaOptions.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IEntitySchemaOptions.js.map

package/dist/es/models/IEntitySchemaOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IEntitySchemaOptions.js","sourceRoot":"","sources":["../../../src/models/IEntitySchemaOptions.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Definition for an entity schema options.\n */\nexport interface IEntitySchemaOptions {\n\t/**\n\t * Description of the object.\n\t */\n\tdescription?: string;\n}\n"]}

package/dist/es/models/IEntitySchemaProperty.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IEntitySchemaProperty.js.map

package/dist/es/models/IEntitySchemaProperty.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IEntitySchemaProperty.js","sourceRoot":"","sources":["../../../src/models/IEntitySchemaProperty.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { EntitySchemaPropertyFormat } from \"./entitySchemaPropertyFormat.js\";\nimport type { EntitySchemaPropertyType } from \"./entitySchemaPropertyType.js\";\nimport type { SortDirection } from \"./sortDirection.js\";\n\n/**\n * Definition for an entity schema property.\n */\nexport interface IEntitySchemaProperty<T = unknown> {\n\t/**\n\t * The property name from the entity.\n\t */\n\tproperty: keyof T;\n\n\t/**\n\t * The type of the property.\n\t */\n\ttype: EntitySchemaPropertyType;\n\n\t/**\n\t * The format of the property.\n\t */\n\tformat?: EntitySchemaPropertyFormat;\n\n\t/**\n\t * Is this the primary index property.\n\t */\n\tisPrimary?: boolean;\n\n\t/**\n\t * Is this a secondary index property.\n\t */\n\tisSecondary?: boolean;\n\n\t/**\n\t * Default sort direction for this field, leave empty if not sortable.\n\t */\n\tsortDirection?: SortDirection;\n\n\t/**\n\t * Is the property optional.\n\t */\n\toptional?: boolean;\n\n\t/**\n\t * The type of the item (only applies when type is `array`).\n\t */\n\titemType?: EntitySchemaPropertyType;\n\n\t/**\n\t * The type ref of the item (only applies when type is either `array` or `object`).\n\t */\n\titemTypeRef?: string;\n\n\t/**\n\t * Description of the object.\n\t */\n\tdescription?: string;\n\n\t/**\n\t * Examples of the property values.\n\t */\n\texamples?: unknown[];\n}\n"]}

package/dist/es/models/IEntitySort.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IEntitySort.js.map

package/dist/es/models/IEntitySort.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IEntitySort.js","sourceRoot":"","sources":["../../../src/models/IEntitySort.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { EntitySchemaPropertyType } from \"./entitySchemaPropertyType.js\";\nimport type { SortDirection } from \"./sortDirection.js\";\n\n/**\n * Definition of an entity property sort details.\n */\nexport interface IEntitySort<T> {\n\t/**\n\t * The name of the property.\n\t */\n\tproperty: keyof T;\n\n\t/**\n\t * The type of the property.\n\t */\n\ttype: EntitySchemaPropertyType;\n\n\t/**\n\t * Default sort direction for this column, leave empty if not sortable.\n\t */\n\tsortDirection: SortDirection;\n}\n"]}

package/dist/es/models/comparisonOperator.js

@@ -0,0 +1,52 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The types of comparisons.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const ComparisonOperator = {
+    /**
+     * Equals.
+     */
+    Equals: "equals",
+    /**
+     * Not Equals.
+     */
+    NotEquals: "not-equals",
+    /**
+     * Greater Than.
+     */
+    GreaterThan: "greater-than",
+    /**
+     * Greater Than Or Equal.
+     */
+    GreaterThanOrEqual: "greater-than-or-equal",
+    /**
+     * Less Than.
+     */
+    LessThan: "less-than",
+    /**
+     * Less Than Or Equal.
+     */
+    LessThanOrEqual: "less-than-or-equal",
+    /**
+     * Includes.
+     * A string in a substring.
+     * A set contains an element.
+     * A list contains an element.
+     */
+    Includes: "includes",
+    /**
+     * Not Includes.
+     * A string not in a substring.
+     * A set does not contain an element.
+     * A list does not contain an element.
+     */
+    NotIncludes: "not-includes",
+    /**
+     * In.
+     * A element is in a set.
+     */
+    In: "in"
+};
+//# sourceMappingURL=comparisonOperator.js.map

package/dist/es/models/comparisonOperator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"comparisonOperator.js","sourceRoot":"","sources":["../../../src/models/comparisonOperator.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,kBAAkB,GAAG;IACjC;;OAEG;IACH,MAAM,EAAE,QAAQ;IAEhB;;OAEG;IACH,SAAS,EAAE,YAAY;IAEvB;;OAEG;IACH,WAAW,EAAE,cAAc;IAE3B;;OAEG;IACH,kBAAkB,EAAE,uBAAuB;IAE3C;;OAEG;IACH,QAAQ,EAAE,WAAW;IAErB;;OAEG;IACH,eAAe,EAAE,oBAAoB;IAErC;;;;;OAKG;IACH,QAAQ,EAAE,UAAU;IAEpB;;;;;OAKG;IACH,WAAW,EAAE,cAAc;IAE3B;;;OAGG;IACH,EAAE,EAAE,IAAI;CACC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The types of comparisons.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const ComparisonOperator = {\n\t/**\n\t * Equals.\n\t */\n\tEquals: \"equals\",\n\n\t/**\n\t * Not Equals.\n\t */\n\tNotEquals: \"not-equals\",\n\n\t/**\n\t * Greater Than.\n\t */\n\tGreaterThan: \"greater-than\",\n\n\t/**\n\t * Greater Than Or Equal.\n\t */\n\tGreaterThanOrEqual: \"greater-than-or-equal\",\n\n\t/**\n\t * Less Than.\n\t */\n\tLessThan: \"less-than\",\n\n\t/**\n\t * Less Than Or Equal.\n\t */\n\tLessThanOrEqual: \"less-than-or-equal\",\n\n\t/**\n\t * Includes.\n\t * A string in a substring.\n\t * A set contains an element.\n\t * A list contains an element.\n\t */\n\tIncludes: \"includes\",\n\n\t/**\n\t * Not Includes.\n\t * A string not in a substring.\n\t * A set does not contain an element.\n\t * A list does not contain an element.\n\t */\n\tNotIncludes: \"not-includes\",\n\n\t/**\n\t * In.\n\t * A element is in a set.\n\t */\n\tIn: \"in\"\n} as const;\n\n/**\n * The types of comparisons.\n */\nexport type ComparisonOperator = (typeof ComparisonOperator)[keyof typeof ComparisonOperator];\n"]}

package/dist/es/models/entityCondition.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=entityCondition.js.map

package/dist/es/models/entityCondition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"entityCondition.js","sourceRoot":"","sources":["../../../src/models/entityCondition.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComparator } from \"./IComparator.js\";\nimport type { IComparatorGroup } from \"./IComparatorGroup.js\";\n\n/**\n * Type defining condition for entities filtering.\n */\nexport type EntityCondition<T> = IComparator | IComparatorGroup<T>;\n"]}

package/dist/es/models/entitySchemaPropertyFormat.js

@@ -0,0 +1,77 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Definition of the entity property format.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const EntitySchemaPropertyFormat = {
+    /**
+     * UUID.
+     */
+    Uuid: "uuid",
+    /**
+     * URI.
+     */
+    Uri: "uri",
+    /**
+     * email.
+     */
+    Email: "email",
+    /**
+     * int8.
+     */
+    Int8: "int8",
+    /**
+     * uint8.
+     */
+    Uint8: "uint8",
+    /**
+     * int16.
+     */
+    Int16: "int16",
+    /**
+     * uint16.
+     */
+    Uint16: "uint16",
+    /**
+     * int32.
+     */
+    Int32: "int32",
+    /**
+     * uint32.
+     */
+    Uint32: "uint32",
+    /**
+     * float.
+     */
+    Float: "float",
+    /**
+     * double.
+     */
+    Double: "double",
+    /**
+     * int64.
+     */
+    Int64: "int64",
+    /**
+     * uint64.
+     */
+    Uint64: "uint64",
+    /**
+     * date.
+     */
+    Date: "date",
+    /**
+     * time.
+     */
+    Time: "time",
+    /**
+     * date-time.
+     */
+    DateTime: "date-time",
+    /**
+     * JSON.
+     */
+    Json: "json"
+};
+//# sourceMappingURL=entitySchemaPropertyFormat.js.map

package/dist/es/models/entitySchemaPropertyFormat.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"entitySchemaPropertyFormat.js","sourceRoot":"","sources":["../../../src/models/entitySchemaPropertyFormat.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,0BAA0B,GAAG;IACzC;;OAEG;IACH,IAAI,EAAE,MAAM;IAEZ;;OAEG;IACH,GAAG,EAAE,KAAK;IAEV;;OAEG;IACH,KAAK,EAAE,OAAO;IAEd;;OAEG;IACH,IAAI,EAAE,MAAM;IAEZ;;OAEG;IACH,KAAK,EAAE,OAAO;IAEd;;OAEG;IACH,KAAK,EAAE,OAAO;IAEd;;OAEG;IACH,MAAM,EAAE,QAAQ;IAEhB;;OAEG;IACH,KAAK,EAAE,OAAO;IAEd;;OAEG;IACH,MAAM,EAAE,QAAQ;IAEhB;;OAEG;IACH,KAAK,EAAE,OAAO;IAEd;;OAEG;IACH,MAAM,EAAE,QAAQ;IAEhB;;OAEG;IACH,KAAK,EAAE,OAAO;IAEd;;OAEG;IACH,MAAM,EAAE,QAAQ;IAEhB;;OAEG;IACH,IAAI,EAAE,MAAM;IAEZ;;OAEG;IACH,IAAI,EAAE,MAAM;IAEZ;;OAEG;IACH,QAAQ,EAAE,WAAW;IAErB;;OAEG;IACH,IAAI,EAAE,MAAM;CACH,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Definition of the entity property format.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const EntitySchemaPropertyFormat = {\n\t/**\n\t * UUID.\n\t */\n\tUuid: \"uuid\",\n\n\t/**\n\t * URI.\n\t */\n\tUri: \"uri\",\n\n\t/**\n\t * email.\n\t */\n\tEmail: \"email\",\n\n\t/**\n\t * int8.\n\t */\n\tInt8: \"int8\",\n\n\t/**\n\t * uint8.\n\t */\n\tUint8: \"uint8\",\n\n\t/**\n\t * int16.\n\t */\n\tInt16: \"int16\",\n\n\t/**\n\t * uint16.\n\t */\n\tUint16: \"uint16\",\n\n\t/**\n\t * int32.\n\t */\n\tInt32: \"int32\",\n\n\t/**\n\t * uint32.\n\t */\n\tUint32: \"uint32\",\n\n\t/**\n\t * float.\n\t */\n\tFloat: \"float\",\n\n\t/**\n\t * double.\n\t */\n\tDouble: \"double\",\n\n\t/**\n\t * int64.\n\t */\n\tInt64: \"int64\",\n\n\t/**\n\t * uint64.\n\t */\n\tUint64: \"uint64\",\n\n\t/**\n\t * date.\n\t */\n\tDate: \"date\",\n\n\t/**\n\t * time.\n\t */\n\tTime: \"time\",\n\n\t/**\n\t * date-time.\n\t */\n\tDateTime: \"date-time\",\n\n\t/**\n\t * JSON.\n\t */\n\tJson: \"json\"\n} as const;\n\n/**\n * Definition of the entity property type's format.\n */\nexport type EntitySchemaPropertyFormat =\n\t(typeof EntitySchemaPropertyFormat)[keyof typeof EntitySchemaPropertyFormat];\n"]}

package/dist/es/models/entitySchemaPropertyType.js

@@ -0,0 +1,33 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Definition of the entity property types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const EntitySchemaPropertyType = {
+    /**
+     * String.
+     */
+    String: "string",
+    /**
+     * Number.
+     */
+    Number: "number",
+    /**
+     * Integer.
+     */
+    Integer: "integer",
+    /**
+     * Boolean.
+     */
+    Boolean: "boolean",
+    /**
+     * Array.
+     */
+    Array: "array",
+    /**
+     * Object.
+     */
+    Object: "object"
+};
+//# sourceMappingURL=entitySchemaPropertyType.js.map

package/dist/es/models/entitySchemaPropertyType.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"entitySchemaPropertyType.js","sourceRoot":"","sources":["../../../src/models/entitySchemaPropertyType.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,wBAAwB,GAAG;IACvC;;OAEG;IACH,MAAM,EAAE,QAAQ;IAEhB;;OAEG;IACH,MAAM,EAAE,QAAQ;IAEhB;;OAEG;IACH,OAAO,EAAE,SAAS;IAElB;;OAEG;IACH,OAAO,EAAE,SAAS;IAElB;;OAEG;IACH,KAAK,EAAE,OAAO;IAEd;;OAEG;IACH,MAAM,EAAE,QAAQ;CACP,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Definition of the entity property types.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const EntitySchemaPropertyType = {\n\t/**\n\t * String.\n\t */\n\tString: \"string\",\n\n\t/**\n\t * Number.\n\t */\n\tNumber: \"number\",\n\n\t/**\n\t * Integer.\n\t */\n\tInteger: \"integer\",\n\n\t/**\n\t * Boolean.\n\t */\n\tBoolean: \"boolean\",\n\n\t/**\n\t * Array.\n\t */\n\tArray: \"array\",\n\n\t/**\n\t * Object.\n\t */\n\tObject: \"object\"\n} as const;\n\n/**\n * Definition of the entity property types.\n */\nexport type EntitySchemaPropertyType =\n\t(typeof EntitySchemaPropertyType)[keyof typeof EntitySchemaPropertyType];\n"]}

package/dist/es/models/logicalOperator.js

@@ -0,0 +1,17 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The logical operators for condition combining.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const LogicalOperator = {
+    /**
+     * Logical operator AND.
+     */
+    And: "and",
+    /**
+     * Logical operator OR.
+     */
+    Or: "or"
+};
+//# sourceMappingURL=logicalOperator.js.map

package/dist/es/models/logicalOperator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logicalOperator.js","sourceRoot":"","sources":["../../../src/models/logicalOperator.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,eAAe,GAAG;IAC9B;;OAEG;IACH,GAAG,EAAE,KAAK;IAEV;;OAEG;IACH,EAAE,EAAE,IAAI;CACC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The logical operators for condition combining.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const LogicalOperator = {\n\t/**\n\t * Logical operator AND.\n\t */\n\tAnd: \"and\",\n\n\t/**\n\t * Logical operator OR.\n\t */\n\tOr: \"or\"\n} as const;\n\n/**\n * The logical operators for condition combining.\n */\nexport type LogicalOperator = (typeof LogicalOperator)[keyof typeof LogicalOperator];\n"]}

package/dist/es/models/sortDirection.js

@@ -0,0 +1,17 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The sort directions.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const SortDirection = {
+    /**
+     * Ascending.
+     */
+    Ascending: "asc",
+    /**
+     * Descending.
+     */
+    Descending: "desc"
+};
+//# sourceMappingURL=sortDirection.js.map

package/dist/es/models/sortDirection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sortDirection.js","sourceRoot":"","sources":["../../../src/models/sortDirection.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,aAAa,GAAG;IAC5B;;OAEG;IACH,SAAS,EAAE,KAAK;IAEhB;;OAEG;IACH,UAAU,EAAE,MAAM;CACT,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The sort directions.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const SortDirection = {\n\t/**\n\t * Ascending.\n\t */\n\tAscending: \"asc\",\n\n\t/**\n\t * Descending.\n\t */\n\tDescending: \"desc\"\n} as const;\n\n/**\n * The sort directions.\n */\nexport type SortDirection = (typeof SortDirection)[keyof typeof SortDirection];\n"]}

package/dist/es/utils/decoratorHelper.js

@@ -0,0 +1,29 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import "reflect-metadata";
+const META_DATA_KEY = "EntitySchemaMetadata";
+/**
+ * Class to help with decorators.
+ */
+export 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.
+     */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    static getSchema(target) {
+        return (Reflect.getMetadata(META_DATA_KEY, typeof target === "object" ? target : target.prototype) ??
+            {});
+    }
+    /**
+     * Set the schema from the reflection metadata.
+     * @param target The object to get the schema data from.
+     * @param entitySchema The schema to set.
+     */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    static setSchema(target, entitySchema) {
+        Reflect.defineMetadata(META_DATA_KEY, entitySchema, typeof target === "object" ? target : target.prototype);
+    }
+}
+//# sourceMappingURL=decoratorHelper.js.map

package/dist/es/utils/decoratorHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"decoratorHelper.js","sourceRoot":"","sources":["../../../src/utils/decoratorHelper.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,kBAAkB,CAAC;AAG1B,MAAM,aAAa,GAAG,sBAAsB,CAAC;AAE7C;;GAEG;AACH,MAAM,OAAO,eAAe;IAC3B;;;;OAIG;IACH,8DAA8D;IACvD,MAAM,CAAC,SAAS,CAAc,MAAW;QAC/C,OAAO,CACN,OAAO,CAAC,WAAW,CAAC,aAAa,EAAE,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC;YAC1F,EAAE,CACF,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,8DAA8D;IACvD,MAAM,CAAC,SAAS,CAAc,MAAW,EAAE,YAA8B;QAC/E,OAAO,CAAC,cAAc,CACrB,aAAa,EACb,YAAY,EACZ,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CACtD,CAAC;IACH,CAAC;CACD","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport \"reflect-metadata\";\nimport type { IEntitySchema } from \"../models/IEntitySchema.js\";\n\nconst META_DATA_KEY = \"EntitySchemaMetadata\";\n\n/**\n * Class to help with decorators.\n */\nexport class DecoratorHelper {\n\t/**\n\t * Get the schema from the reflection metadata.\n\t * @param target The object to get the schema data from.\n\t * @returns The schema from the metadata if it can be found.\n\t */\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\tpublic static getSchema<T = unknown>(target: any): IEntitySchema<T> {\n\t\treturn (\n\t\t\tReflect.getMetadata(META_DATA_KEY, typeof target === \"object\" ? target : target.prototype) ??\n\t\t\t{}\n\t\t);\n\t}\n\n\t/**\n\t * Set the schema from the reflection metadata.\n\t * @param target The object to get the schema data from.\n\t * @param entitySchema The schema to set.\n\t */\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\tpublic static setSchema<T = unknown>(target: any, entitySchema: IEntitySchema<T>): void {\n\t\tReflect.defineMetadata(\n\t\t\tMETA_DATA_KEY,\n\t\t\tentitySchema,\n\t\t\ttypeof target === \"object\" ? target : target.prototype\n\t\t);\n\t}\n}\n"]}

package/dist/es/utils/entityConditions.js

@@ -0,0 +1,175 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { ArrayHelper, Is, ObjectHelper } from "@twin.org/core";
+import { ComparisonOperator } from "../models/comparisonOperator.js";
+import { LogicalOperator } from "../models/logicalOperator.js";
+/**
+ * Class to perform condition checks.
+ */
+export 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(entity, condition) {
+        // If no conditions are defined then it's a match
+        if (Is.undefined(condition)) {
+            return true;
+        }
+        if ("conditions" in condition) {
+            // It's a group of comparisons, so check the individual items and combine with the logical operator
+            const results = condition.conditions.map(c => EntityConditions.check(entity, c));
+            if ((condition.logicalOperator ?? LogicalOperator.And) === LogicalOperator.And) {
+                return results.every(Boolean);
+            }
+            return results.some(Boolean);
+        }
+        if (condition.property.includes(".")) {
+            // It's a child property comparison, so evaluate the child property
+            // and then compare it to the conditions
+            const path = condition.property.split(".");
+            const child = ObjectHelper.propertyGet(entity, path[0]);
+            // If the child is an array then check each item
+            if (Is.array(child)) {
+                for (const c of child) {
+                    const check = EntityConditions.check(c, {
+                        ...condition,
+                        property: path.slice(1).join(".")
+                    });
+                    if (check) {
+                        return true;
+                    }
+                }
+                return false;
+            }
+        }
+        // It's a single value so just check the condition
+        return EntityConditions.compare(entity, condition);
+    }
+    /**
+     * 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(entity, comparator) {
+        const val = ObjectHelper.propertyGet(entity, comparator.property);
+        const conditionValue = comparator.value;
+        if (Is.undefined(conditionValue)) {
+            const valUndefined = Is.undefined(val);
+            if (valUndefined && comparator.comparison === ComparisonOperator.Equals) {
+                return true;
+            }
+            else if (!valUndefined && comparator.comparison === ComparisonOperator.NotEquals) {
+                return true;
+            }
+            return false;
+        }
+        else if (Is.string(val)) {
+            if (Is.string(conditionValue)) {
+                if (!((comparator.comparison === ComparisonOperator.Equals && val === conditionValue) ||
+                    (comparator.comparison === ComparisonOperator.NotEquals && val !== conditionValue) ||
+                    (comparator.comparison === ComparisonOperator.GreaterThan && val > conditionValue) ||
+                    (comparator.comparison === ComparisonOperator.LessThan && val < conditionValue) ||
+                    (comparator.comparison === ComparisonOperator.GreaterThanOrEqual &&
+                        val >= conditionValue) ||
+                    (comparator.comparison === ComparisonOperator.LessThanOrEqual &&
+                        val <= conditionValue) ||
+                    (comparator.comparison === ComparisonOperator.Includes &&
+                        val.includes(conditionValue)) ||
+                    (comparator.comparison === ComparisonOperator.NotIncludes &&
+                        !val.includes(conditionValue)))) {
+                    return false;
+                }
+                return true;
+            }
+            else if (Is.array(conditionValue)) {
+                if (!(comparator.comparison === ComparisonOperator.In && conditionValue.includes(val))) {
+                    return false;
+                }
+                return true;
+            }
+            return false;
+        }
+        else if (Is.number(val)) {
+            if (Is.number(conditionValue)) {
+                if (!((comparator.comparison === ComparisonOperator.Equals && val === conditionValue) ||
+                    (comparator.comparison === ComparisonOperator.NotEquals && val !== conditionValue) ||
+                    (comparator.comparison === ComparisonOperator.GreaterThan && val > conditionValue) ||
+                    (comparator.comparison === ComparisonOperator.LessThan && val < conditionValue) ||
+                    (comparator.comparison === ComparisonOperator.GreaterThanOrEqual &&
+                        val >= conditionValue) ||
+                    (comparator.comparison === ComparisonOperator.LessThanOrEqual && val <= conditionValue))) {
+                    return false;
+                }
+                return true;
+            }
+            else if (Is.array(conditionValue)) {
+                if (!(comparator.comparison === ComparisonOperator.In && conditionValue.includes(val))) {
+                    return false;
+                }
+                return true;
+            }
+            return false;
+        }
+        else if (Is.boolean(val)) {
+            if (Is.boolean(conditionValue)) {
+                if (!((comparator.comparison === ComparisonOperator.Equals && val === conditionValue) ||
+                    (comparator.comparison === ComparisonOperator.NotEquals && val !== conditionValue))) {
+                    return false;
+                }
+                return true;
+            }
+            return false;
+        }
+        else if (Is.array(val)) {
+            if (Is.array(conditionValue)) {
+                if (comparator.comparison === ComparisonOperator.Equals ||
+                    comparator.comparison === ComparisonOperator.NotEquals) {
+                    const matches = ArrayHelper.matches(val, conditionValue);
+                    if (!((comparator.comparison === ComparisonOperator.Equals && matches) ||
+                        (comparator.comparison === ComparisonOperator.NotEquals && !matches))) {
+                        return false;
+                    }
+                    return true;
+                }
+                return false;
+            }
+            else if (Is.number(conditionValue) || Is.string(conditionValue)) {
+                if (comparator.comparison === ComparisonOperator.Includes ||
+                    comparator.comparison === ComparisonOperator.NotIncludes ||
+                    comparator.comparison === ComparisonOperator.In) {
+                    const includes = val.includes(conditionValue);
+                    if (!((comparator.comparison === ComparisonOperator.Includes && includes) ||
+                        (comparator.comparison === ComparisonOperator.NotIncludes && !includes) ||
+                        (comparator.comparison === ComparisonOperator.In && includes))) {
+                        return false;
+                    }
+                    return true;
+                }
+                return false;
+            }
+            else if (Is.object(conditionValue)) {
+                if (comparator.comparison === ComparisonOperator.Includes) {
+                    for (const v of val) {
+                        if (ObjectHelper.equal(v, conditionValue)) {
+                            return true;
+                        }
+                    }
+                }
+                else if (comparator.comparison === ComparisonOperator.NotIncludes) {
+                    for (const v of val) {
+                        if (!ObjectHelper.equal(v, conditionValue)) {
+                            return true;
+                        }
+                    }
+                }
+            }
+            return false;
+        }
+        return false;
+    }
+}
+//# sourceMappingURL=entityConditions.js.map