@twin.org/entity 0.10.0 → 0.10.1-next.10

package/docs/reference/classes/EntitySchemaHelper.md

@@ -154,6 +154,42 @@ The sort keys from the schema or undefined if there are none.
 
 ***
 
+### getIndexGroups() {#getindexgroups}
+
+> `static` **getIndexGroups**\<`T`\>(`entitySchema`): `object`
+
+Get the composite index groups from the schema.
+Each property can be part of multiple indexes through its `indexGroup` list, so a property
+can appear in more than one group. The properties within a group are ordered by the `index`
+of their index entry, and each is returned with the sort direction it declared for that group.
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+#### Parameters
+
+##### entitySchema
+
+[`IEntitySchema`](../interfaces/IEntitySchema.md)\<`T`\>
+
+The entity schema to find the index groups from.
+
+#### Returns
+
+`object`
+
+The properties and their directions keyed by the group name, empty if there are no groups.
+
+#### Throws
+
+GeneralError if an index entry has an invalid direction or index, or if two properties
+claim the same index within the same group, or if a group contains fewer than two properties.
+
+***
+
 ### buildSortProperties() {#buildsortproperties}
 
 > `static` **buildSortProperties**\<`T`\>(`entitySchema`, `overrideSortKeys?`): [`IEntitySort`](../interfaces/IEntitySort.md)\<`T`\>[] \| `undefined`

package/docs/reference/functions/property.md

@@ -17,3 +17,11 @@ The options for the property.
 `any`
 
 The property decorator.
+
+## Throws
+
+GeneralError if an index group is declared on an object or array property.
+
+## Throws
+
+GeneralError if the same index group name is declared more than once for the property.

package/docs/reference/index.md

@@ -16,6 +16,7 @@
 - [IEntitySchemaDiff](interfaces/IEntitySchemaDiff.md)
 - [IEntitySchemaOptions](interfaces/IEntitySchemaOptions.md)
 - [IEntitySchemaProperty](interfaces/IEntitySchemaProperty.md)
+- [IEntitySchemaPropertyIndex](interfaces/IEntitySchemaPropertyIndex.md)
 - [IEntitySort](interfaces/IEntitySort.md)
 
 ## Type Aliases

package/docs/reference/interfaces/IEntitySchemaProperty.md

@@ -58,6 +58,16 @@ Is this a secondary index property.
 
 ***
 
+### indexGroup? {#indexgroup}
+
+> `optional` **indexGroup?**: [`IEntitySchemaPropertyIndex`](IEntitySchemaPropertyIndex.md)[]
+
+The composite indexes this property is part of.
+Connectors can use these to build a composite index for each group name,
+combining all the properties which share that name, ordered by their index.
+
+***
+
 ### isVersion? {#isversion}
 
 > `optional` **isVersion?**: `boolean`

package/docs/reference/interfaces/IEntitySchemaPropertyIndex.md

@@ -0,0 +1,27 @@
+# Interface: IEntitySchemaPropertyIndex
+
+Definition of a composite index that a property is part of.
+
+## Properties
+
+### name {#name}
+
+> **name**: `string`
+
+The name of the composite index group.
+
+***
+
+### direction {#direction}
+
+> **direction**: [`SortDirection`](../type-aliases/SortDirection.md)
+
+The sort direction for the property within the index.
+
+***
+
+### index {#index}
+
+> **index**: `number`
+
+The position of the property within the index, ordered ascending.

package/docs/reference/variables/ComparisonOperator.md

@@ -47,7 +47,7 @@ Less Than Or Equal.
 > `readonly` **Includes**: `"includes"` = `"includes"`
 
 Includes.
-A string in a substring.
+A string in a substring, this is a scan and cannot use an index.
 A set contains an element.
 A list contains an element.
 
@@ -60,6 +60,13 @@ A string not in a substring.
 A set does not contain an element.
 A list does not contain an element.
 
+### StartsWith {#startswith}
+
+> `readonly` **StartsWith**: `"starts-with"` = `"starts-with"`
+
+Starts With.
+A string begins with a prefix, the anchored match can use an index.
+
 ### In {#in}
 
 > `readonly` **In**: `"in"` = `"in"`

package/locales/en.json

@@ -4,6 +4,10 @@
 			"duplicateOldProperty": "The oldProperties array contains a duplicate property key \"{property}\"",
 			"duplicateNewProperty": "The newProperties array contains a duplicate property key \"{property}\""
 		},
+		"propertyDecorator": {
+			"indexGroupTypeNotSupported": "The property \"{property}\" of type \"{type}\" cannot be part of an index group",
+			"duplicateIndexGroup": "The property \"{property}\" declares the index group \"{group}\" more than once"
+		},
 		"entitySchemaHelper": {
 			"noIsPrimary": "Property \"entitySchema.properties\" must contain a value with isPrimary set",
 			"multipleIsPrimary": "Property \"entitySchema.properties\" contains more than one property with isPrimary set",
@@ -14,6 +18,10 @@
 			"maxLengthExceeded": "The entity property \"{property}\" has a length of {length} which exceeds the maximum length of {maxLength}",
 			"versionMustBeGreaterThanOrEqualZero": "Property \"entitySchema.version\" must be an integer >= 0, but got {version}",
 			"multipleVersionProperties": "The schema has more than one property with isVersion set, only one is allowed",
+			"invalidIndexGroupDirection": "The index group \"{group}\" on the property \"{property}\" has the direction \"{direction}\" which is not a valid sort direction",
+			"invalidIndexGroupIndex": "The index group \"{group}\" on the property \"{property}\" has the index {index} which must be an integer >= 0",
+			"duplicateIndexGroupIndex": "The index group \"{group}\" has more than one property using the index {index}, found again on the property \"{property}\"",
+			"indexGroupMustHaveAtLeastTwoProperties": "The index group \"{group}\" must contain at least two properties, but contains {count}",
 			"versionPropertyMustBeInteger": "The version property \"{property}\" has type \"{type}\" but must be of type integer"
 		}
 	}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/entity",
-	"version": "0.10.0",
+	"version": "0.10.1-next.10",
 	"description": "Helpers for defining and working with entities",
 	"repository": {
 		"type": "git",
@@ -14,8 +14,8 @@
 		"node": ">=24.0.0"
 	},
 	"dependencies": {
-		"@twin.org/core": "^0.10.0",
-		"@twin.org/nameof": "^0.10.0",
+		"@twin.org/core": "0.10.1-next.10",
+		"@twin.org/nameof": "0.10.1-next.10",
 		"reflect-metadata": "0.2.2",
 		"tslib": "2.8.1"
 	},