jsii-diff 1.117.0 → 1.118.0

package/BREAKING_CHANGES.md

@@ -49,7 +49,9 @@ const d = new Dog({ name: 'Fido' });
 console.log(d.name.toLowerCase());
 
 // Not valid anymore after the type of `d.name` has changed into `string | undefined`.
-// 'd.name' can be undefined, and we have to account for that with an `if`!
+// 'd.name' can be undefined, and calling `undefined.toLowerCase()` would throw an error.
+// The user will have to account for that with an `if`, which means changing their code,
+// which means a breaking change.
 ```
 
 ### Optional properties: how to solve
@@ -83,6 +85,30 @@ This doesn't break any existing users: all their Dogs will have names, so they w
 
 For new users that fail to give their Dog a name, presumably they will be aware that their Dog doesn't have a name, so they can avoid trying to read it. If you want to give them a way to avoid the exception, add a `public get hasName(): boolean` field so they can test for the existence of the name before accessing it.
 
+### Optional properties: what about structs?
+
+In the above example, we said that `DogOptions#name` was an *input* and `Dog#name` was an *output*. Does that mean it's
+always okay to change struct (data interface) fields to optional? 
+
+Not necessarily! It depends on how the struct is used. If the struct is used as the return value of a method or the 
+type of a class proeprty somewhere, it is in *output position* and all of its fields are as well. So if you have the following
+class:
+
+```ts
+class Dog {
+  public readonly options: DogOptions; // DogOptions is an OUTPUT
+
+  constructor(options: DogOptions) {  // DogOptions is an INPUT
+    this.options = options;
+  }
+}
+```
+
+Then `DogOptions` is now both in input as well as output position, and you're not allowed to make anything optional anymore!
+
+(That's why using the same struct name to represent both input and output data is best avoided, because it limits
+evolvability).
+
 ## Changing types to superclass/subclass
 
 When changing types involved in an operation, you run into a similar issue as with changing the optionality of a property:

package/lib/version.d.ts

@@ -1,3 +1,3 @@
 /** The qualified version number for this JSII compiler. */
-export declare const VERSION = "1.117.0 (build b8499c7)";
+export declare const VERSION = "1.118.0 (build 02eec31)";
 //# sourceMappingURL=version.d.ts.map

package/lib/version.js

@@ -1,7 +1,7 @@
 "use strict";
-// Generated at 2025-10-22T16:34:07Z by generate.sh
+// Generated at 2025-10-29T09:49:48Z by generate.sh
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
 /** The qualified version number for this JSII compiler. */
-exports.VERSION = '1.117.0 (build b8499c7)';
+exports.VERSION = '1.118.0 (build 02eec31)';
 //# sourceMappingURL=version.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jsii-diff",
-  "version": "1.117.0",
+  "version": "1.118.0",
   "description": "Assembly comparison for jsii",
   "license": "Apache-2.0",
   "author": {
@@ -33,10 +33,10 @@
     "package": "package-js"
   },
   "dependencies": {
-    "@jsii/check-node": "1.117.0",
-    "@jsii/spec": "1.117.0",
+    "@jsii/check-node": "1.118.0",
+    "@jsii/spec": "1.118.0",
     "fs-extra": "^10.1.0",
-    "jsii-reflect": "^1.117.0",
+    "jsii-reflect": "^1.118.0",
     "log4js": "^6.9.1",
     "yargs": "^17.7.2"
   },
@@ -46,6 +46,6 @@
     "@types/yargs": "^17.0.33",
     "jest-expect-message": "^1.1.3",
     "jsii": "^5.9.10",
-    "jsii-build-tools": "^1.117.0"
+    "jsii-build-tools": "^1.118.0"
   }
 }