@twin.org/entity 0.0.3-next.36 → 0.0.3-next.38

package/dist/es/index.js

@@ -18,5 +18,7 @@ export * from "./models/sortDirection.js";
 export * from "./utils/decoratorHelper.js";
 export * from "./utils/entityConditions.js";
 export * from "./utils/entitySchemaHelper.js";
+export * from "./utils/entitySchemaDiff.js";
 export * from "./utils/entitySorter.js";
+export * from "./models/IEntitySchemaDiff.js";
 //# sourceMappingURL=index.js.map

package/dist/es/index.js.map

@@ -1 +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"]}
+{"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,6BAA6B,CAAC;AAC5C,cAAc,yBAAyB,CAAC;AACxC,cAAc,+BAA+B,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/entitySchemaDiff.js\";\nexport * from \"./utils/entitySorter.js\";\nexport * from \"./models/IEntitySchemaDiff.js\";\n"]}

package/dist/es/models/IEntitySchemaDiff.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IEntitySchemaDiff.js","sourceRoot":"","sources":["../../../src/models/IEntitySchemaDiff.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IEntitySchemaProperty } from \"./IEntitySchemaProperty.js\";\n\n/**\n * The result of comparing two sets of entity schema properties.\n */\nexport interface IEntitySchemaDiff<T = unknown> {\n\t/**\n\t * Properties present in the new schema but absent from the old one.\n\t * Each entry is the full property descriptor from the new schema, so it can\n\t * be passed directly to bootstrap / table-creation logic.\n\t */\n\tadded: IEntitySchemaProperty<T>[];\n\n\t/**\n\t * Properties present in the old schema but absent from the new one.\n\t * Each entry is the full property descriptor from the old schema, allowing\n\t * connectors to drop the correct column, index, or field by name.\n\t */\n\tremoved: IEntitySchemaProperty<T>[];\n\n\t/**\n\t * Properties that exist in both schemas but differ in at least one structural\n\t * field (type, format, isSecondary, sortDirection, optional, itemType, itemTypeRef).\n\t * `from` is the old descriptor; `to` is the new one.\n\t * Both are full property objects so connectors can drop the old definition and\n\t * create the new one using the same bootstrap code path.\n\t */\n\tmodified: {\n\t\t/**\n\t\t * The old property descriptor.\n\t\t */\n\t\tfrom: IEntitySchemaProperty<T>;\n\t\t/**\n\t\t * The new property descriptor.\n\t\t */\n\t\tto: IEntitySchemaProperty<T>;\n\t}[];\n}\n"]}

package/dist/es/utils/entitySchemaDiff.js

@@ -0,0 +1,67 @@
+/**
+ * Compare two arrays of entity schema properties and return a structured diff.
+ *
+ * Properties are matched by their `property` key name. A property is considered
+ * modified when any structural field differs: `type`, `format`, `isPrimary`,
+ * `isSecondary`, `sortDirection`, `optional`, `itemType`, or `itemTypeRef`.
+ * Documentation-only fields (`description`, `examples`) are intentionally
+ * excluded from the comparison to avoid spurious diffs.
+ * @param oldProperties The property descriptors from the current (live) schema.
+ * @param newProperties The property descriptors from the target (new) schema.
+ * @returns A diff object with `added`, `removed`, and `modified` arrays, each
+ * containing full `IEntitySchemaProperty` descriptors.
+ */
+export function entitySchemaDiff(oldProperties, newProperties) {
+    const added = [];
+    const removed = [];
+    const modified = [];
+    const oldMap = new Map();
+    for (const prop of oldProperties) {
+        oldMap.set(prop.property, prop);
+    }
+    const newMap = new Map();
+    for (const prop of newProperties) {
+        newMap.set(prop.property, prop);
+    }
+    for (const newProp of newProperties) {
+        const oldProp = oldMap.get(newProp.property);
+        if (!oldProp) {
+            added.push(newProp);
+        }
+        else if (!schemaPropertiesEqual(oldProp, newProp)) {
+            modified.push({ from: oldProp, to: newProp });
+        }
+    }
+    for (const oldProp of oldProperties) {
+        if (!newMap.has(oldProp.property)) {
+            removed.push(oldProp);
+        }
+    }
+    return { added, removed, modified };
+}
+/**
+ * Returns true when the diff contains no changes (nothing added, removed, or modified).
+ * @param diff The diff to check.
+ * @returns True if the diff is empty.
+ */
+export function isEmptyDiff(diff) {
+    return diff.added.length === 0 && diff.removed.length === 0 && diff.modified.length === 0;
+}
+/**
+ * Compare two property descriptors for structural equality.
+ * Documentation fields (description, examples) are excluded.
+ * @param a The first property descriptor.
+ * @param b The second property descriptor.
+ * @returns True if all structural fields are equal.
+ */
+function schemaPropertiesEqual(a, b) {
+    return (a.type === b.type &&
+        a.format === b.format &&
+        a.isPrimary === b.isPrimary &&
+        a.isSecondary === b.isSecondary &&
+        a.sortDirection === b.sortDirection &&
+        a.optional === b.optional &&
+        a.itemType === b.itemType &&
+        a.itemTypeRef === b.itemTypeRef);
+}
+//# sourceMappingURL=entitySchemaDiff.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"entitySchemaDiff.js","sourceRoot":"","sources":["../../../src/utils/entitySchemaDiff.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,gBAAgB,CAC/B,aAAyC,EACzC,aAAyC;IAEzC,MAAM,KAAK,GAA+B,EAAE,CAAC;IAC7C,MAAM,OAAO,GAA+B,EAAE,CAAC;IAC/C,MAAM,QAAQ,GAAqC,EAAE,CAAC;IAEtD,MAAM,MAAM,GAAG,IAAI,GAAG,EAAoC,CAAC;IAC3D,KAAK,MAAM,IAAI,IAAI,aAAa,EAAE,CAAC;QAClC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,QAAkB,EAAE,IAAI,CAAC,CAAC;IAC3C,CAAC;IAED,MAAM,MAAM,GAAG,IAAI,GAAG,EAAoC,CAAC;IAC3D,KAAK,MAAM,IAAI,IAAI,aAAa,EAAE,CAAC;QAClC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,QAAkB,EAAE,IAAI,CAAC,CAAC;IAC3C,CAAC;IAED,KAAK,MAAM,OAAO,IAAI,aAAa,EAAE,CAAC;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,QAAkB,CAAC,CAAC;QACvD,IAAI,CAAC,OAAO,EAAE,CAAC;YACd,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACrB,CAAC;aAAM,IAAI,CAAC,qBAAqB,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,CAAC;YACrD,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;QAC/C,CAAC;IACF,CAAC;IAED,KAAK,MAAM,OAAO,IAAI,aAAa,EAAE,CAAC;QACrC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,QAAkB,CAAC,EAAE,CAAC;YAC7C,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACvB,CAAC;IACF,CAAC;IAED,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC;AACrC,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,WAAW,CAAI,IAA0B;IACxD,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,CAAC;AAC3F,CAAC;AAED;;;;;;GAMG;AACH,SAAS,qBAAqB,CAC7B,CAA2B,EAC3B,CAA2B;IAE3B,OAAO,CACN,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,IAAI;QACjB,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM;QACrB,CAAC,CAAC,SAAS,KAAK,CAAC,CAAC,SAAS;QAC3B,CAAC,CAAC,WAAW,KAAK,CAAC,CAAC,WAAW;QAC/B,CAAC,CAAC,aAAa,KAAK,CAAC,CAAC,aAAa;QACnC,CAAC,CAAC,QAAQ,KAAK,CAAC,CAAC,QAAQ;QACzB,CAAC,CAAC,QAAQ,KAAK,CAAC,CAAC,QAAQ;QACzB,CAAC,CAAC,WAAW,KAAK,CAAC,CAAC,WAAW,CAC/B,CAAC;AACH,CAAC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IEntitySchemaDiff } from \"../models/IEntitySchemaDiff.js\";\nimport type { IEntitySchemaProperty } from \"../models/IEntitySchemaProperty.js\";\n\n/**\n * Compare two arrays of entity schema properties and return a structured diff.\n *\n * Properties are matched by their `property` key name. A property is considered\n * modified when any structural field differs: `type`, `format`, `isPrimary`,\n * `isSecondary`, `sortDirection`, `optional`, `itemType`, or `itemTypeRef`.\n * Documentation-only fields (`description`, `examples`) are intentionally\n * excluded from the comparison to avoid spurious diffs.\n * @param oldProperties The property descriptors from the current (live) schema.\n * @param newProperties The property descriptors from the target (new) schema.\n * @returns A diff object with `added`, `removed`, and `modified` arrays, each\n * containing full `IEntitySchemaProperty` descriptors.\n */\nexport function entitySchemaDiff<T>(\n\toldProperties: IEntitySchemaProperty<T>[],\n\tnewProperties: IEntitySchemaProperty<T>[]\n): IEntitySchemaDiff<T> {\n\tconst added: IEntitySchemaProperty<T>[] = [];\n\tconst removed: IEntitySchemaProperty<T>[] = [];\n\tconst modified: IEntitySchemaDiff<T>[\"modified\"] = [];\n\n\tconst oldMap = new Map<string, IEntitySchemaProperty<T>>();\n\tfor (const prop of oldProperties) {\n\t\toldMap.set(prop.property as string, prop);\n\t}\n\n\tconst newMap = new Map<string, IEntitySchemaProperty<T>>();\n\tfor (const prop of newProperties) {\n\t\tnewMap.set(prop.property as string, prop);\n\t}\n\n\tfor (const newProp of newProperties) {\n\t\tconst oldProp = oldMap.get(newProp.property as string);\n\t\tif (!oldProp) {\n\t\t\tadded.push(newProp);\n\t\t} else if (!schemaPropertiesEqual(oldProp, newProp)) {\n\t\t\tmodified.push({ from: oldProp, to: newProp });\n\t\t}\n\t}\n\n\tfor (const oldProp of oldProperties) {\n\t\tif (!newMap.has(oldProp.property as string)) {\n\t\t\tremoved.push(oldProp);\n\t\t}\n\t}\n\n\treturn { added, removed, modified };\n}\n\n/**\n * Returns true when the diff contains no changes (nothing added, removed, or modified).\n * @param diff The diff to check.\n * @returns True if the diff is empty.\n */\nexport function isEmptyDiff<T>(diff: IEntitySchemaDiff<T>): boolean {\n\treturn diff.added.length === 0 && diff.removed.length === 0 && diff.modified.length === 0;\n}\n\n/**\n * Compare two property descriptors for structural equality.\n * Documentation fields (description, examples) are excluded.\n * @param a The first property descriptor.\n * @param b The second property descriptor.\n * @returns True if all structural fields are equal.\n */\nfunction schemaPropertiesEqual<T>(\n\ta: IEntitySchemaProperty<T>,\n\tb: IEntitySchemaProperty<T>\n): boolean {\n\treturn (\n\t\ta.type === b.type &&\n\t\ta.format === b.format &&\n\t\ta.isPrimary === b.isPrimary &&\n\t\ta.isSecondary === b.isSecondary &&\n\t\ta.sortDirection === b.sortDirection &&\n\t\ta.optional === b.optional &&\n\t\ta.itemType === b.itemType &&\n\t\ta.itemTypeRef === b.itemTypeRef\n\t);\n}\n"]}

package/dist/types/index.d.ts

@@ -16,4 +16,6 @@ export * from "./models/sortDirection.js";
 export * from "./utils/decoratorHelper.js";
 export * from "./utils/entityConditions.js";
 export * from "./utils/entitySchemaHelper.js";
+export * from "./utils/entitySchemaDiff.js";
 export * from "./utils/entitySorter.js";
+export * from "./models/IEntitySchemaDiff.js";

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

@@ -0,0 +1,35 @@
+import type { IEntitySchemaProperty } from "./IEntitySchemaProperty.js";
+/**
+ * The result of comparing two sets of entity schema properties.
+ */
+export interface IEntitySchemaDiff<T = unknown> {
+    /**
+     * Properties present in the new schema but absent from the old one.
+     * Each entry is the full property descriptor from the new schema, so it can
+     * be passed directly to bootstrap / table-creation logic.
+     */
+    added: IEntitySchemaProperty<T>[];
+    /**
+     * Properties present in the old schema but absent from the new one.
+     * Each entry is the full property descriptor from the old schema, allowing
+     * connectors to drop the correct column, index, or field by name.
+     */
+    removed: IEntitySchemaProperty<T>[];
+    /**
+     * Properties that exist in both schemas but differ in at least one structural
+     * field (type, format, isSecondary, sortDirection, optional, itemType, itemTypeRef).
+     * `from` is the old descriptor; `to` is the new one.
+     * Both are full property objects so connectors can drop the old definition and
+     * create the new one using the same bootstrap code path.
+     */
+    modified: {
+        /**
+         * The old property descriptor.
+         */
+        from: IEntitySchemaProperty<T>;
+        /**
+         * The new property descriptor.
+         */
+        to: IEntitySchemaProperty<T>;
+    }[];
+}

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

@@ -0,0 +1,22 @@
+import type { IEntitySchemaDiff } from "../models/IEntitySchemaDiff.js";
+import type { IEntitySchemaProperty } from "../models/IEntitySchemaProperty.js";
+/**
+ * Compare two arrays of entity schema properties and return a structured diff.
+ *
+ * Properties are matched by their `property` key name. A property is considered
+ * modified when any structural field differs: `type`, `format`, `isPrimary`,
+ * `isSecondary`, `sortDirection`, `optional`, `itemType`, or `itemTypeRef`.
+ * Documentation-only fields (`description`, `examples`) are intentionally
+ * excluded from the comparison to avoid spurious diffs.
+ * @param oldProperties The property descriptors from the current (live) schema.
+ * @param newProperties The property descriptors from the target (new) schema.
+ * @returns A diff object with `added`, `removed`, and `modified` arrays, each
+ * containing full `IEntitySchemaProperty` descriptors.
+ */
+export declare function entitySchemaDiff<T>(oldProperties: IEntitySchemaProperty<T>[], newProperties: IEntitySchemaProperty<T>[]): IEntitySchemaDiff<T>;
+/**
+ * Returns true when the diff contains no changes (nothing added, removed, or modified).
+ * @param diff The diff to check.
+ * @returns True if the diff is empty.
+ */
+export declare function isEmptyDiff<T>(diff: IEntitySchemaDiff<T>): boolean;

package/docs/changelog.md

@@ -1,5 +1,43 @@
 # Changelog
 
+## [0.0.3-next.38](https://github.com/iotaledger/twin-framework/compare/entity-v0.0.3-next.37...entity-v0.0.3-next.38) (2026-05-11)
+
+
+### Features
+
+* typescript 6 update ([1d10f31](https://github.com/iotaledger/twin-framework/commit/1d10f31e6516ec622773f45e88af82fe749b384a))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/nameof bumped from 0.0.3-next.37 to 0.0.3-next.38
+    * @twin.org/core bumped from 0.0.3-next.37 to 0.0.3-next.38
+  * devDependencies
+    * @twin.org/nameof-transformer bumped from 0.0.3-next.37 to 0.0.3-next.38
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.3-next.37 to 0.0.3-next.38
+    * @twin.org/validate-locales bumped from 0.0.3-next.37 to 0.0.3-next.38
+
+## [0.0.3-next.37](https://github.com/iotaledger/twin-framework/compare/entity-v0.0.3-next.36...entity-v0.0.3-next.37) (2026-05-07)
+
+
+### Features
+
+* add IEntitySchemaDiff and entitySchemaDiff utility ([#282](https://github.com/iotaledger/twin-framework/issues/282)) ([9d63e94](https://github.com/iotaledger/twin-framework/commit/9d63e94021ee2ffc138004ee68cf53d08a6b17f9))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/nameof bumped from 0.0.3-next.36 to 0.0.3-next.37
+    * @twin.org/core bumped from 0.0.3-next.36 to 0.0.3-next.37
+  * devDependencies
+    * @twin.org/nameof-transformer bumped from 0.0.3-next.36 to 0.0.3-next.37
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.3-next.36 to 0.0.3-next.37
+    * @twin.org/validate-locales bumped from 0.0.3-next.36 to 0.0.3-next.37
+
 ## [0.0.3-next.36](https://github.com/iotaledger/twin-framework/compare/entity-v0.0.3-next.35...entity-v0.0.3-next.36) (2026-05-07)
 
 

package/docs/reference/functions/entitySchemaDiff.md

@@ -0,0 +1,38 @@
+# Function: entitySchemaDiff()
+
+> **entitySchemaDiff**\<`T`\>(`oldProperties`, `newProperties`): [`IEntitySchemaDiff`](../interfaces/IEntitySchemaDiff.md)\<`T`\>
+
+Compare two arrays of entity schema properties and return a structured diff.
+
+Properties are matched by their `property` key name. A property is considered
+modified when any structural field differs: `type`, `format`, `isPrimary`,
+`isSecondary`, `sortDirection`, `optional`, `itemType`, or `itemTypeRef`.
+Documentation-only fields (`description`, `examples`) are intentionally
+excluded from the comparison to avoid spurious diffs.
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### oldProperties
+
+[`IEntitySchemaProperty`](../interfaces/IEntitySchemaProperty.md)\<`T`\>[]
+
+The property descriptors from the current (live) schema.
+
+### newProperties
+
+[`IEntitySchemaProperty`](../interfaces/IEntitySchemaProperty.md)\<`T`\>[]
+
+The property descriptors from the target (new) schema.
+
+## Returns
+
+[`IEntitySchemaDiff`](../interfaces/IEntitySchemaDiff.md)\<`T`\>
+
+A diff object with `added`, `removed`, and `modified` arrays, each
+containing full `IEntitySchemaProperty` descriptors.

package/docs/reference/functions/isEmptyDiff.md

@@ -0,0 +1,25 @@
+# Function: isEmptyDiff()
+
+> **isEmptyDiff**\<`T`\>(`diff`): `boolean`
+
+Returns true when the diff contains no changes (nothing added, removed, or modified).
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### diff
+
+[`IEntitySchemaDiff`](../interfaces/IEntitySchemaDiff.md)\<`T`\>
+
+The diff to check.
+
+## Returns
+
+`boolean`
+
+True if the diff is empty.

package/docs/reference/index.md

@@ -12,6 +12,7 @@
 - [IComparator](interfaces/IComparator.md)
 - [IComparatorGroup](interfaces/IComparatorGroup.md)
 - [IEntitySchema](interfaces/IEntitySchema.md)
+- [IEntitySchemaDiff](interfaces/IEntitySchemaDiff.md)
 - [IEntitySchemaOptions](interfaces/IEntitySchemaOptions.md)
 - [IEntitySchemaProperty](interfaces/IEntitySchemaProperty.md)
 - [IEntitySort](interfaces/IEntitySort.md)
@@ -38,3 +39,5 @@
 
 - [entity](functions/entity.md)
 - [property](functions/property.md)
+- [entitySchemaDiff](functions/entitySchemaDiff.md)
+- [isEmptyDiff](functions/isEmptyDiff.md)

package/docs/reference/interfaces/IEntitySchemaDiff.md

@@ -0,0 +1,53 @@
+# Interface: IEntitySchemaDiff\<T\>
+
+The result of comparing two sets of entity schema properties.
+
+## Type Parameters
+
+### T
+
+`T` = `unknown`
+
+## Properties
+
+### added {#added}
+
+> **added**: [`IEntitySchemaProperty`](IEntitySchemaProperty.md)\<`T`\>[]
+
+Properties present in the new schema but absent from the old one.
+Each entry is the full property descriptor from the new schema, so it can
+be passed directly to bootstrap / table-creation logic.
+
+***
+
+### removed {#removed}
+
+> **removed**: [`IEntitySchemaProperty`](IEntitySchemaProperty.md)\<`T`\>[]
+
+Properties present in the old schema but absent from the new one.
+Each entry is the full property descriptor from the old schema, allowing
+connectors to drop the correct column, index, or field by name.
+
+***
+
+### modified {#modified}
+
+> **modified**: `object`[]
+
+Properties that exist in both schemas but differ in at least one structural
+field (type, format, isSecondary, sortDirection, optional, itemType, itemTypeRef).
+`from` is the old descriptor; `to` is the new one.
+Both are full property objects so connectors can drop the old definition and
+create the new one using the same bootstrap code path.
+
+#### from
+
+> **from**: [`IEntitySchemaProperty`](IEntitySchemaProperty.md)\<`T`\>
+
+The old property descriptor.
+
+#### to
+
+> **to**: [`IEntitySchemaProperty`](IEntitySchemaProperty.md)\<`T`\>
+
+The new property descriptor.

package/package.json

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