@twin.org/entity-storage-models 0.0.3-next.21 → 0.0.3-next.23

package/docs/reference/interfaces/ISchemaMigration.md

@@ -0,0 +1,65 @@
+# Interface: ISchemaMigration\<T, U\>
+
+Optional per-step override for a single version-to-version migration.
+Only register an entry in SchemaMigrationFactory when a step requires property
+renames or a custom object/array transform. For purely structural changes
+(add/remove/type-change fields) no entry is needed — the runner diffs the two
+versioned schema classes (e.g. MyEntityV0 vs MyEntityV1) from EntitySchemaFactory
+automatically.
+
+Register under the key "<BaseSchemaName>_<fromVersion>_<toVersion>"
+e.g. "MyEntity_0_1" for the step that migrates from version 0 to version 1.
+The key itself encodes the version pair; no version field is needed on the object.
+
+## Type Parameters
+
+### T
+
+`T` = `unknown`
+
+### U
+
+`U` = `unknown`
+
+## Properties
+
+### renames? {#renames}
+
+> `optional` **renames?**: `object`[]
+
+Optional property renames to apply during this step.
+
+#### from
+
+> **from**: `string`
+
+#### to
+
+> **to**: `string`
+
+***
+
+### transformEntityProperty? {#transformentityproperty}
+
+> `optional` **transformEntityProperty?**: (`schema1Property`, `schemaProperty2`, `value`) => `unknown`
+
+Optional per-property transformer for object/array properties that cannot be
+automatically coerced. T is the source entity type, U is the target entity type.
+
+#### Parameters
+
+##### schema1Property
+
+`IEntitySchemaProperty`\<`T`\>
+
+##### schemaProperty2
+
+`IEntitySchemaProperty`\<`U`\>
+
+##### value
+
+`unknown`
+
+#### Returns
+
+`unknown`

package/docs/reference/variables/SchemaMigrationFactory.md

@@ -0,0 +1,13 @@
+# Variable: SchemaMigrationFactory
+
+> `const` **SchemaMigrationFactory**: `Factory`\<[`ISchemaMigration`](../interfaces/ISchemaMigration.md)\<`unknown`, `unknown`\>\>
+
+Factory for optional per-step migration overrides.
+
+Only register an entry when a version step requires property renames or a custom
+transform hook. For purely structural changes (add/remove/type-change) the
+SchemaVersionService diffs the two versioned schema classes automatically
+without needing any factory entry.
+
+Keys follow the convention "<BaseSchemaName>_<fromVersion>_<toVersion>",
+for example "MyEntity_0_1" for the step that migrates MyEntity from version 0 to 1.

package/locales/en.json

@@ -1,5 +1,9 @@
 {
 	"error": {
+		"entityStorageHelper": {
+			"sortNotIndexed": "The property \"{property}\" is not indexed and cannot be used for sorting",
+			"propertyNotInSchema": "The property \"{property}\" does not exist in the schema and cannot be used for projection"
+		},
 		"migrationHelper": {
 			"migrationFailed": "Migration failed.",
 			"transformRequiredForProperty": "A transformation function is required to migrate property \"{from}\" to \"{to}\" of type \"{type}\"",

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/entity-storage-models",
-	"version": "0.0.3-next.21",
+	"version": "0.0.3-next.23",
 	"description": "Shared models for storage contracts, requests, responses and connector capabilities.",
 	"repository": {
 		"type": "git",