@twin.org/entity-storage-models 0.0.3-next.9 → 0.9.0

package/docs/reference/type-aliases/EntityPropertyTransformer.md

@@ -0,0 +1,34 @@
+# Type Alias: EntityPropertyTransformer\<T, U\>
+
+> **EntityPropertyTransformer**\<`T`, `U`\> = (`schema1Property`, `schemaProperty2`, `value`) => `unknown`
+
+Type for the optional transformEntityProperty function.
+Used in migration steps for custom property transformations.
+
+## Type Parameters
+
+### T
+
+`T` = `unknown`
+
+### U
+
+`U` = `unknown`
+
+## 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,3 +1,20 @@
 {
-	"error": {}
+	"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": {
+			"migrateSchemaFailed": "Migration failed for schema \"{schemaName}\".",
+			"transformRequiredForProperty": "A transformation function is required to migrate property \"{from}\" to \"{to}\" of type \"{type}\"",
+			"coercionProducedUndefined": "Coercion of property \"{property}\" to type \"{type}\" produced undefined but the property is not optional"
+		}
+	},
+	"info": {
+		"migrationHelper": {
+			"migrateSchemaStarting": "Migrating schema \"{schemaName}\"",
+			"migrateSchemaFinalizing": "Finalizing migration of schema \"{schemaName}\"",
+			"migrateSchemaComplete": "Migration of schema \"{schemaName}\" complete"
+		}
+	}
 }

package/package.json

@@ -1,10 +1,10 @@
 {
 	"name": "@twin.org/entity-storage-models",
-	"version": "0.0.3-next.9",
+	"version": "0.9.0",
 	"description": "Shared models for storage contracts, requests, responses and connector capabilities.",
 	"repository": {
 		"type": "git",
-		"url": "git+https://github.com/twinfoundation/entity-storage.git",
+		"url": "git+https://github.com/iotaledger/twin-entity-storage.git",
 		"directory": "packages/entity-storage-models"
 	},
 	"author": "martyn.janes@iota.org",
@@ -14,9 +14,11 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/core": "next",
-		"@twin.org/entity": "next",
-		"@twin.org/nameof": "next"
+		"@twin.org/context": "^0.9.0",
+		"@twin.org/core": "^0.9.0",
+		"@twin.org/entity": "^0.9.0",
+		"@twin.org/logging-models": "^0.9.0",
+		"@twin.org/nameof": "^0.9.0"
 	},
 	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",
@@ -50,7 +52,7 @@
 		"schemas"
 	],
 	"bugs": {
-		"url": "git+https://github.com/twinfoundation/entity-storage/issues"
+		"url": "git+https://github.com/iotaledger/twin-entity-storage/issues"
 	},
 	"homepage": "https://twindev.org"
 }