@stately-cloud/schema - npm Package Compare versions

Comparing version 0.17.0 to 0.18.0

dist/fields.d.ts

@@ -61,3 +61,3 @@ import { FieldDescriptorProto } from "@bufbuild/protobuf/wkt";
     required?: boolean;
-} & Pick<SchemaType, "valid"> & // Rather than force people to use a new type just to set one of these type options, we allow overriding them at the field level
+} & Pick<SchemaType, "readDefault" | "valid"> & // Rather than force people to use a new type just to set one of these type options, we allow overriding them at the field level
 (FieldFromMetadata | FieldInitialValue);
@@ -64,0 +64,0 @@ /**

dist/fields.js

@@ -103,2 +103,6 @@ import { create, isMessage, setExtension } from "@bufbuild/protobuf";
     }
+    const defaultValue = stringifyDefault(fieldConfig.readDefault);
+    if (defaultValue !== undefined) {
+        statelyOptions.readDefault = defaultValue;
+    }
     // set custom options
@@ -222,2 +226,44 @@ field.options = create(FieldOptionsSchema);
 }
+/**
+ * This massages an unknown type into a Stately-serializable type. This is used
+ * to serialize default values for fields.
+ */
+function stringifyDefault(def) {
+    if (def === undefined || def === null) {
+        return undefined;
+    }
+    switch (typeof def) {
+        case "undefined":
+            return undefined;
+        case "number":
+        case "string":
+        case "boolean":
+        case "bigint":
+        case "symbol":
+            return def.toString();
+        case "function":
+            throw new Error("Cannot serialize a function as a default value");
+        case "object":
+            // TODO: handle more types here (e.g. our UUID type when we make it)
+            if (Array.isArray(def)) {
+                return def.map(stringifyDefault).toString();
+            }
+            else if (def instanceof Uint8Array) {
+                return Buffer.from(def).toString("base64");
+            }
+            else if (def instanceof Date) {
+                return def.toISOString();
+            }
+            else if (Symbol.iterator in def && typeof def[Symbol.iterator] === "function") {
+                // Handles Set, other iterables
+                return JSON.stringify(Array.from(def).map(stringifyDefault));
+            }
+            if (Object.getPrototypeOf(def) === Object.prototype || Object.getPrototypeOf(def) === null) {
+                return JSON.stringify(Object.fromEntries(Object.entries(def).map(([k, v]) => [k, stringifyDefault(v)])));
+            }
+            throw new Error(
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+            `Cannot serialize object of type ${Object.getPrototypeOf(def).constructor.name}`);
+    }
+}
 //# sourceMappingURL=fields.js.map

dist/migration_pb.js

@@ -11,3 +11,3 @@ // @generated by protoc-gen-es v2.2.3 with parameter "target=js+dts,import_extension=.js"
 /*@__PURE__*/
-fileDesc("Cg9taWdyYXRpb24ucHJvdG8SE3N0YXRlbHkuc2NoZW1hbW9kZWwifwoJTWlncmF0aW9uEiMKE2Zyb21fc2NoZW1hX3ZlcnNpb24YASABKARCBrpIA8gBARIMCgRuYW1lGAIgASgJEj8KCGNvbW1hbmRzGAMgAygLMiUuc3RhdGVseS5zY2hlbWFtb2RlbC5NaWdyYXRpb25Db21tYW5kQga6SAPIAQEiagoQTWlncmF0aW9uQ29tbWFuZBIZCgl0eXBlX25hbWUYASABKAlCBrpIA8gBARI7CgdhY3Rpb25zGAIgAygLMiIuc3RhdGVseS5zY2hlbWFtb2RlbC5NaWdyYXRlQWN0aW9uQga6SAPIAQEirQQKDU1pZ3JhdGVBY3Rpb24SMgoJYWRkX2ZpZWxkGAIgASgLMh0uc3RhdGVseS5zY2hlbWFtb2RlbC5BZGRGaWVsZEgAEjgKDHJlbW92ZV9maWVsZBgDIAEoCzIgLnN0YXRlbHkuc2NoZW1hbW9kZWwuUmVtb3ZlRmllbGRIABI4CgxyZW5hbWVfZmllbGQYBCABKAsyIC5zdGF0ZWx5LnNjaGVtYW1vZGVsLlJlbmFtZUZpZWxkSAASNgoLcmVuYW1lX3R5cGUYBiABKAsyHy5zdGF0ZWx5LnNjaGVtYW1vZGVsLlJlbmFtZVR5cGVIABI2CgtyZW1vdmVfdHlwZRgHIAEoCzIfLnN0YXRlbHkuc2NoZW1hbW9kZWwuUmVtb3ZlVHlwZUgAEjAKCGFkZF90eXBlGAggASgLMhwuc3RhdGVseS5zY2hlbWFtb2RlbC5BZGRUeXBlSAASQQoRcmVuYW1lX2VudW1fdmFsdWUYCSABKAsyJC5zdGF0ZWx5LnNjaGVtYW1vZGVsLlJlbmFtZUVudW1WYWx1ZUgAEjsKDmFkZF9lbnVtX3ZhbHVlGAogASgLMiEuc3RhdGVseS5zY2hlbWFtb2RlbC5BZGRFbnVtVmFsdWVIABJBChFyZW1vdmVfZW51bV92YWx1ZRgLIAEoCzIkLnN0YXRlbHkuc2NoZW1hbW9kZWwuUmVtb3ZlRW51bVZhbHVlSABCDwoGYWN0aW9uEgW6SAIIASIgCghBZGRGaWVsZBIUCgRuYW1lGAEgASgJQga6SAPIAQEiIwoLUmVtb3ZlRmllbGQSFAoEbmFtZRgBIAEoCUIGukgDyAEBIkEKC1JlbmFtZUZpZWxkEhgKCG9sZF9uYW1lGAEgASgJQga6SAPIAQESGAoIbmV3X25hbWUYAiABKAlCBrpIA8gBASImCgpSZW5hbWVUeXBlEhgKCG5ld19uYW1lGAIgASgJQga6SAPIAQEiDAoKUmVtb3ZlVHlwZSIJCgdBZGRUeXBlIlEKD1JlbmFtZUVudW1WYWx1ZRIeCg5vbGRfdmFsdWVfbmFtZRgBIAEoCUIGukgDyAEBEh4KDm5ld192YWx1ZV9uYW1lGAIgASgJQga6SAPIAQEiLgoMQWRkRW51bVZhbHVlEh4KDm5ld192YWx1ZV9uYW1lGAEgASgJQga6SAPIAQEiLQoPUmVtb3ZlRW51bVZhbHVlEhoKCnZhbHVlX25hbWUYASABKAlCBrpIA8gBAUKWAQoXY29tLnN0YXRlbHkuc2NoZW1hbW9kZWxCDk1pZ3JhdGlvblByb3RvUAGiAgNTU1iqAhNTdGF0ZWx5LlNjaGVtYW1vZGVsygITU3RhdGVseVxTY2hlbWFtb2RlbOICH1N0YXRlbHlcU2NoZW1hbW9kZWxcR1BCTWV0YWRhdGHqAhRTdGF0ZWx5OjpTY2hlbWFtb2RlbGIGcHJvdG8z", [file_buf_validate_validate]);
+fileDesc("Cg9taWdyYXRpb24ucHJvdG8SE3N0YXRlbHkuc2NoZW1hbW9kZWwifwoJTWlncmF0aW9uEiMKE2Zyb21fc2NoZW1hX3ZlcnNpb24YASABKARCBrpIA8gBARIMCgRuYW1lGAIgASgJEj8KCGNvbW1hbmRzGAMgAygLMiUuc3RhdGVseS5zY2hlbWFtb2RlbC5NaWdyYXRpb25Db21tYW5kQga6SAPIAQEiagoQTWlncmF0aW9uQ29tbWFuZBIZCgl0eXBlX25hbWUYASABKAlCBrpIA8gBARI7CgdhY3Rpb25zGAIgAygLMiIuc3RhdGVseS5zY2hlbWFtb2RlbC5NaWdyYXRlQWN0aW9uQga6SAPIAQEirQQKDU1pZ3JhdGVBY3Rpb24SMgoJYWRkX2ZpZWxkGAIgASgLMh0uc3RhdGVseS5zY2hlbWFtb2RlbC5BZGRGaWVsZEgAEjgKDHJlbW92ZV9maWVsZBgDIAEoCzIgLnN0YXRlbHkuc2NoZW1hbW9kZWwuUmVtb3ZlRmllbGRIABI4CgxyZW5hbWVfZmllbGQYBCABKAsyIC5zdGF0ZWx5LnNjaGVtYW1vZGVsLlJlbmFtZUZpZWxkSAASNgoLcmVuYW1lX3R5cGUYBiABKAsyHy5zdGF0ZWx5LnNjaGVtYW1vZGVsLlJlbmFtZVR5cGVIABI2CgtyZW1vdmVfdHlwZRgHIAEoCzIfLnN0YXRlbHkuc2NoZW1hbW9kZWwuUmVtb3ZlVHlwZUgAEjAKCGFkZF90eXBlGAggASgLMhwuc3RhdGVseS5zY2hlbWFtb2RlbC5BZGRUeXBlSAASQQoRcmVuYW1lX2VudW1fdmFsdWUYCSABKAsyJC5zdGF0ZWx5LnNjaGVtYW1vZGVsLlJlbmFtZUVudW1WYWx1ZUgAEjsKDmFkZF9lbnVtX3ZhbHVlGAogASgLMiEuc3RhdGVseS5zY2hlbWFtb2RlbC5BZGRFbnVtVmFsdWVIABJBChFyZW1vdmVfZW51bV92YWx1ZRgLIAEoCzIkLnN0YXRlbHkuc2NoZW1hbW9kZWwuUmVtb3ZlRW51bVZhbHVlSABCDwoGYWN0aW9uEgW6SAIIASIgCghBZGRGaWVsZBIUCgRuYW1lGAEgASgJQga6SAPIAQEiOQoLUmVtb3ZlRmllbGQSFAoEbmFtZRgBIAEoCUIGukgDyAEBEhQKDHJlYWRfZGVmYXVsdBgCIAEoCSJBCgtSZW5hbWVGaWVsZBIYCghvbGRfbmFtZRgBIAEoCUIGukgDyAEBEhgKCG5ld19uYW1lGAIgASgJQga6SAPIAQEiJgoKUmVuYW1lVHlwZRIYCghuZXdfbmFtZRgCIAEoCUIGukgDyAEBIgwKClJlbW92ZVR5cGUiCQoHQWRkVHlwZSJRCg9SZW5hbWVFbnVtVmFsdWUSHgoOb2xkX3ZhbHVlX25hbWUYASABKAlCBrpIA8gBARIeCg5uZXdfdmFsdWVfbmFtZRgCIAEoCUIGukgDyAEBIi4KDEFkZEVudW1WYWx1ZRIeCg5uZXdfdmFsdWVfbmFtZRgBIAEoCUIGukgDyAEBIi0KD1JlbW92ZUVudW1WYWx1ZRIaCgp2YWx1ZV9uYW1lGAEgASgJQga6SAPIAQFClgEKF2NvbS5zdGF0ZWx5LnNjaGVtYW1vZGVsQg5NaWdyYXRpb25Qcm90b1ABogIDU1NYqgITU3RhdGVseS5TY2hlbWFtb2RlbMoCE1N0YXRlbHlcU2NoZW1hbW9kZWziAh9TdGF0ZWx5XFNjaGVtYW1vZGVsXEdQQk1ldGFkYXRh6gIUU3RhdGVseTo6U2NoZW1hbW9kZWxiBnByb3RvMw", [file_buf_validate_validate]);
 /**
@@ -14,0 +14,0 @@ * Describes the message stately.schemamodel.Migration.

dist/options_pb.d.ts

@@ -131,7 +131,2 @@ /**
 /**
- * Describes the message stately.schemamodel.BoolOptions.
- * Use `create(BoolOptionsSchema)` to create a new message.
- */
-export const BoolOptionsSchema: import("@bufbuild/protobuf/codegenv1").GenMessage<import("@bufbuild/protobuf").Message, import("@bufbuild/protobuf").JsonValue>;
-/**
  * Describes the message stately.schemamodel.StringOptions.
@@ -138,0 +133,0 @@ * Use `create(StringOptionsSchema)` to create a new message.

dist/options_pb.js

@@ -11,3 +11,3 @@ // @generated by protoc-gen-es v2.2.3 with parameter "target=js+dts,import_extension=.js"
 /*@__PURE__*/
-fileDesc("Cg1vcHRpb25zLnByb3RvEhNzdGF0ZWx5LnNjaGVtYW1vZGVsIrYDCg5NZXNzYWdlT3B0aW9ucxJLCglrZXlfcGF0aHMYASADKAsyKy5zdGF0ZWx5LnNjaGVtYW1vZGVsLk1lc3NhZ2VPcHRpb25zLktleVBhdGhCC7pICMgBAZIBAhAFEiUKA3R0bBgCIAEoCzIYLnN0YXRlbHkuc2NoZW1hbW9kZWwuVHRsEjoKB2luZGV4ZXMYBCADKAsyKS5zdGF0ZWx5LnNjaGVtYW1vZGVsLk1lc3NhZ2VPcHRpb25zLkluZGV4GigKB0tleVBhdGgSHQoNcGF0aF90ZW1wbGF0ZRgBIAEoCUIGukgDyAEBGkoKBUluZGV4Eh0KDXByb3BlcnR5X3BhdGgYASABKAlCBrpIA8gBARIiChFncm91cF9sb2NhbF9pbmRleBgCIAEoDUIHukgEKgIYBDp+ukh7GnkKDmluZGV4ZXMudW5pcXVlEjR5b3UgY2FuJ3QgaGF2ZSB0d28gY29uZmlndXJhdGlvbnMgZm9yIHRoZSBzYW1lIGluZGV4GjF0aGlzLmluZGV4ZXMubWFwKGMsIGMuZ3JvdXBfbG9jYWxfaW5kZXgpLnVuaXF1ZSgpIpACCgNUdGwSIwoQZHVyYXRpb25fc2Vjb25kcxgBIAEoBEIHukgEMgIgAEgAEhgKBWZpZWxkGAIgASgJQge6SARyAhABSAASOgoGc291cmNlGAMgASgOMiIuc3RhdGVseS5zY2hlbWFtb2RlbC5UdGwuVHRsU291cmNlQga6SAPIAQEifgoJVHRsU291cmNlEhQKEFRUTF9TT1VSQ0VfVU5TRVQQABIbChdUVExfU09VUkNFX0ZST01fQ1JFQVRFRBABEiEKHVRUTF9TT1VSQ0VfRlJPTV9MQVNUX01PRElGSUVEEAISGwoXVFRMX1NPVVJDRV9BVF9USU1FU1RBTVAQA0IOCgV2YWx1ZRIFukgCCAEiqwoKDEZpZWxkT3B0aW9ucxIyCgVmbG9hdBgBIAEoCzIhLnN0YXRlbHkuc2NoZW1hbW9kZWwuRmxvYXRPcHRpb25zSAASNAoGZG91YmxlGAIgASgLMiIuc3RhdGVseS5zY2hlbWFtb2RlbC5Eb3VibGVPcHRpb25zSAASMgoFaW50MzIYAyABKAsyIS5zdGF0ZWx5LnNjaGVtYW1vZGVsLkludDMyT3B0aW9uc0gAEjIKBWludDY0GAQgASgLMiEuc3RhdGVseS5zY2hlbWFtb2RlbC5JbnQ2NE9wdGlvbnNIABI0CgZ1aW50MzIYBSABKAsyIi5zdGF0ZWx5LnNjaGVtYW1vZGVsLlVJbnQzMk9wdGlvbnNIABI0CgZ1aW50NjQYBiABKAsyIi5zdGF0ZWx5LnNjaGVtYW1vZGVsLlVJbnQ2NE9wdGlvbnNIABI0CgZzaW50MzIYByABKAsyIi5zdGF0ZWx5LnNjaGVtYW1vZGVsLlNJbnQzMk9wdGlvbnNIABI0CgZzaW50NjQYCCABKAsyIi5zdGF0ZWx5LnNjaGVtYW1vZGVsLlNJbnQ2NE9wdGlvbnNIABI2CgdmaXhlZDMyGAkgASgLMiMuc3RhdGVseS5zY2hlbWFtb2RlbC5GaXhlZDMyT3B0aW9uc0gAEjYKB2ZpeGVkNjQYCiABKAsyIy5zdGF0ZWx5LnNjaGVtYW1vZGVsLkZpeGVkNjRPcHRpb25zSAASOAoIc2ZpeGVkMzIYCyABKAsyJC5zdGF0ZWx5LnNjaGVtYW1vZGVsLlNGaXhlZDMyT3B0aW9uc0gAEjgKCHNmaXhlZDY0GAwgASgLMiQuc3RhdGVseS5zY2hlbWFtb2RlbC5TRml4ZWQ2NE9wdGlvbnNIABIwCgRib29sGA0gASgLMiAuc3RhdGVseS5zY2hlbWFtb2RlbC5Cb29sT3B0aW9uc0gAEjQKBnN0cmluZxgOIAEoCzIiLnN0YXRlbHkuc2NoZW1hbW9kZWwuU3RyaW5nT3B0aW9uc0gAEjIKBWJ5dGVzGA8gASgLMiEuc3RhdGVseS5zY2hlbWFtb2RlbC5CeXRlc09wdGlvbnNIABJHCg1pbml0aWFsX3ZhbHVlGBggASgOMi4uc3RhdGVseS5zY2hlbWFtb2RlbC5GaWVsZE9wdGlvbnMuSW5pdGlhbFZhbHVlSAESRwoNZnJvbV9tZXRhZGF0YRgZIAEoDjIuLnN0YXRlbHkuc2NoZW1hbW9kZWwuRmllbGRPcHRpb25zLkZyb21NZXRhZGF0YUgBItcBCgxGcm9tTWV0YWRhdGESHQoZRlJPTV9NRVRBREFUQV9VTlNQRUNJRklFRBAAEiEKHUZST01fTUVUQURBVEFfQ1JFQVRFRF9BVF9USU1FEAESJwojRlJPTV9NRVRBREFUQV9MQVNUX01PRElGSUVEX0FUX1RJTUUQAhIkCiBGUk9NX01FVEFEQVRBX0NSRUFURURfQVRfVkVSU0lPThADEioKJkZST01fTUVUQURBVEFfTEFTVF9NT0RJRklFRF9BVF9WRVJTSU9OEAQiBAgFEAUiBAgGEAYidAoMSW5pdGlhbFZhbHVlEhYKEklOSVRJQUxfVkFMVUVfTk9ORRAAEhoKFklOSVRJQUxfVkFMVUVfU0VRVUVOQ0UQARIWChJJTklUSUFMX1ZBTFVFX1VVSUQQAhIYChRJTklUSUFMX1ZBTFVFX1JBTkQ1MxAEQgYKBHR5cGVCBwoFdmFsdWUiTAoMRmxvYXRPcHRpb25zEjwKDGludGVycHJldF9hcxgCIAEoDjImLnN0YXRlbHkuc2NoZW1hbW9kZWwuTnVtYmVySW50ZXJwcmV0QXMiTQoNRG91YmxlT3B0aW9ucxI8CgxpbnRlcnByZXRfYXMYAiABKA4yJi5zdGF0ZWx5LnNjaGVtYW1vZGVsLk51bWJlckludGVycHJldEFzIkwKDEludDMyT3B0aW9ucxI8CgxpbnRlcnByZXRfYXMYAiABKA4yJi5zdGF0ZWx5LnNjaGVtYW1vZGVsLk51bWJlckludGVycHJldEFzIkwKDEludDY0T3B0aW9ucxI8CgxpbnRlcnByZXRfYXMYAiABKA4yJi5zdGF0ZWx5LnNjaGVtYW1vZGVsLk51bWJlckludGVycHJldEFzIk0KDVVJbnQzMk9wdGlvbnMSPAoMaW50ZXJwcmV0X2FzGAIgASgOMiYuc3RhdGVseS5zY2hlbWFtb2RlbC5OdW1iZXJJbnRlcnByZXRBcyJNCg1VSW50NjRPcHRpb25zEjwKDGludGVycHJldF9hcxgCIAEoDjImLnN0YXRlbHkuc2NoZW1hbW9kZWwuTnVtYmVySW50ZXJwcmV0QXMiTQoNU0ludDMyT3B0aW9ucxI8CgxpbnRlcnByZXRfYXMYAiABKA4yJi5zdGF0ZWx5LnNjaGVtYW1vZGVsLk51bWJlckludGVycHJldEFzIk0KDVNJbnQ2NE9wdGlvbnMSPAoMaW50ZXJwcmV0X2FzGAIgASgOMiYuc3RhdGVseS5zY2hlbWFtb2RlbC5OdW1iZXJJbnRlcnByZXRBcyJOCg5GaXhlZDMyT3B0aW9ucxI8CgxpbnRlcnByZXRfYXMYAiABKA4yJi5zdGF0ZWx5LnNjaGVtYW1vZGVsLk51bWJlckludGVycHJldEFzIk4KDkZpeGVkNjRPcHRpb25zEjwKDGludGVycHJldF9hcxgCIAEoDjImLnN0YXRlbHkuc2NoZW1hbW9kZWwuTnVtYmVySW50ZXJwcmV0QXMiTwoPU0ZpeGVkMzJPcHRpb25zEjwKDGludGVycHJldF9hcxgCIAEoDjImLnN0YXRlbHkuc2NoZW1hbW9kZWwuTnVtYmVySW50ZXJwcmV0QXMiTwoPU0ZpeGVkNjRPcHRpb25zEjwKDGludGVycHJldF9hcxgCIAEoDjImLnN0YXRlbHkuc2NoZW1hbW9kZWwuTnVtYmVySW50ZXJwcmV0QXMiDQoLQm9vbE9wdGlvbnMiTQoNU3RyaW5nT3B0aW9ucxI8CgxpbnRlcnByZXRfYXMYAiABKA4yJi5zdGF0ZWx5LnNjaGVtYW1vZGVsLlN0cmluZ0ludGVycHJldEFzIksKDEJ5dGVzT3B0aW9ucxI7CgxpbnRlcnByZXRfYXMYAiABKA4yJS5zdGF0ZWx5LnNjaGVtYW1vZGVsLkJ5dGVzSW50ZXJwcmV0QXMqlwIKEU51bWJlckludGVycHJldEFzEh4KGk5VTUJFUl9JTlRFUlBSRVRfQVNfTlVNQkVSEAASKQolTlVNQkVSX0lOVEVSUFJFVF9BU19USU1FU1RBTVBfU0VDT05EUxABEi4KKk5VTUJFUl9JTlRFUlBSRVRfQVNfVElNRVNUQU1QX01JTExJU0VDT05EUxACEi4KKk5VTUJFUl9JTlRFUlBSRVRfQVNfVElNRVNUQU1QX01JQ1JPU0VDT05EUxADEigKJE5VTUJFUl9JTlRFUlBSRVRfQVNfRFVSQVRJT05fU0VDT05EUxAEEi0KKU5VTUJFUl9JTlRFUlBSRVRfQVNfRFVSQVRJT05fTUlMTElTRUNPTkRTEAUqTQoQQnl0ZXNJbnRlcnByZXRBcxIcChhCWVRFU19JTlRFUlBSRVRfQVNfQllURVMQABIbChdCWVRFU19JTlRFUlBSRVRfQVNfVVVJRBABKnIKEVN0cmluZ0ludGVycHJldEFzEh4KGlNUUklOR19JTlRFUlBSRVRfQVNfU1RSSU5HEAASIAocU1RSSU5HX0lOVEVSUFJFVF9BU19LRVlfUEFUSBABEhsKF1NUUklOR19JTlRFUlBSRVRfQVNfVVJMEAJClAEKF2NvbS5zdGF0ZWx5LnNjaGVtYW1vZGVsQgxPcHRpb25zUHJvdG9QAaICA1NTWKoCE1N0YXRlbHkuU2NoZW1hbW9kZWzKAhNTdGF0ZWx5XFNjaGVtYW1vZGVs4gIfU3RhdGVseVxTY2hlbWFtb2RlbFxHUEJNZXRhZGF0YeoCFFN0YXRlbHk6OlNjaGVtYW1vZGVsYgZwcm90bzM", [file_buf_validate_validate]);
+fileDesc("Cg1vcHRpb25zLnByb3RvEhNzdGF0ZWx5LnNjaGVtYW1vZGVsIrYDCg5NZXNzYWdlT3B0aW9ucxJLCglrZXlfcGF0aHMYASADKAsyKy5zdGF0ZWx5LnNjaGVtYW1vZGVsLk1lc3NhZ2VPcHRpb25zLktleVBhdGhCC7pICMgBAZIBAhAFEiUKA3R0bBgCIAEoCzIYLnN0YXRlbHkuc2NoZW1hbW9kZWwuVHRsEjoKB2luZGV4ZXMYBCADKAsyKS5zdGF0ZWx5LnNjaGVtYW1vZGVsLk1lc3NhZ2VPcHRpb25zLkluZGV4GigKB0tleVBhdGgSHQoNcGF0aF90ZW1wbGF0ZRgBIAEoCUIGukgDyAEBGkoKBUluZGV4Eh0KDXByb3BlcnR5X3BhdGgYASABKAlCBrpIA8gBARIiChFncm91cF9sb2NhbF9pbmRleBgCIAEoDUIHukgEKgIYBDp+ukh7GnkKDmluZGV4ZXMudW5pcXVlEjR5b3UgY2FuJ3QgaGF2ZSB0d28gY29uZmlndXJhdGlvbnMgZm9yIHRoZSBzYW1lIGluZGV4GjF0aGlzLmluZGV4ZXMubWFwKGMsIGMuZ3JvdXBfbG9jYWxfaW5kZXgpLnVuaXF1ZSgpIpACCgNUdGwSIwoQZHVyYXRpb25fc2Vjb25kcxgBIAEoBEIHukgEMgIgAEgAEhgKBWZpZWxkGAIgASgJQge6SARyAhABSAASOgoGc291cmNlGAMgASgOMiIuc3RhdGVseS5zY2hlbWFtb2RlbC5UdGwuVHRsU291cmNlQga6SAPIAQEifgoJVHRsU291cmNlEhQKEFRUTF9TT1VSQ0VfVU5TRVQQABIbChdUVExfU09VUkNFX0ZST01fQ1JFQVRFRBABEiEKHVRUTF9TT1VSQ0VfRlJPTV9MQVNUX01PRElGSUVEEAISGwoXVFRMX1NPVVJDRV9BVF9USU1FU1RBTVAQA0IOCgV2YWx1ZRIFukgCCAEigwoKDEZpZWxkT3B0aW9ucxIyCgVmbG9hdBgBIAEoCzIhLnN0YXRlbHkuc2NoZW1hbW9kZWwuRmxvYXRPcHRpb25zSAASNAoGZG91YmxlGAIgASgLMiIuc3RhdGVseS5zY2hlbWFtb2RlbC5Eb3VibGVPcHRpb25zSAASMgoFaW50MzIYAyABKAsyIS5zdGF0ZWx5LnNjaGVtYW1vZGVsLkludDMyT3B0aW9uc0gAEjIKBWludDY0GAQgASgLMiEuc3RhdGVseS5zY2hlbWFtb2RlbC5JbnQ2NE9wdGlvbnNIABI0CgZ1aW50MzIYBSABKAsyIi5zdGF0ZWx5LnNjaGVtYW1vZGVsLlVJbnQzMk9wdGlvbnNIABI0CgZ1aW50NjQYBiABKAsyIi5zdGF0ZWx5LnNjaGVtYW1vZGVsLlVJbnQ2NE9wdGlvbnNIABI0CgZzaW50MzIYByABKAsyIi5zdGF0ZWx5LnNjaGVtYW1vZGVsLlNJbnQzMk9wdGlvbnNIABI0CgZzaW50NjQYCCABKAsyIi5zdGF0ZWx5LnNjaGVtYW1vZGVsLlNJbnQ2NE9wdGlvbnNIABI2CgdmaXhlZDMyGAkgASgLMiMuc3RhdGVseS5zY2hlbWFtb2RlbC5GaXhlZDMyT3B0aW9uc0gAEjYKB2ZpeGVkNjQYCiABKAsyIy5zdGF0ZWx5LnNjaGVtYW1vZGVsLkZpeGVkNjRPcHRpb25zSAASOAoIc2ZpeGVkMzIYCyABKAsyJC5zdGF0ZWx5LnNjaGVtYW1vZGVsLlNGaXhlZDMyT3B0aW9uc0gAEjgKCHNmaXhlZDY0GAwgASgLMiQuc3RhdGVseS5zY2hlbWFtb2RlbC5TRml4ZWQ2NE9wdGlvbnNIABI0CgZzdHJpbmcYDiABKAsyIi5zdGF0ZWx5LnNjaGVtYW1vZGVsLlN0cmluZ09wdGlvbnNIABIyCgVieXRlcxgPIAEoCzIhLnN0YXRlbHkuc2NoZW1hbW9kZWwuQnl0ZXNPcHRpb25zSAASRwoNaW5pdGlhbF92YWx1ZRgYIAEoDjIuLnN0YXRlbHkuc2NoZW1hbW9kZWwuRmllbGRPcHRpb25zLkluaXRpYWxWYWx1ZUgBEkcKDWZyb21fbWV0YWRhdGEYGSABKA4yLi5zdGF0ZWx5LnNjaGVtYW1vZGVsLkZpZWxkT3B0aW9ucy5Gcm9tTWV0YWRhdGFIARIUCgxyZWFkX2RlZmF1bHQYECABKAkiywEKDEZyb21NZXRhZGF0YRIdChlGUk9NX01FVEFEQVRBX1VOU1BFQ0lGSUVEEAASIQodRlJPTV9NRVRBREFUQV9DUkVBVEVEX0FUX1RJTUUQARInCiNGUk9NX01FVEFEQVRBX0xBU1RfTU9ESUZJRURfQVRfVElNRRACEiQKIEZST01fTUVUQURBVEFfQ1JFQVRFRF9BVF9WRVJTSU9OEAMSKgomRlJPTV9NRVRBREFUQV9MQVNUX01PRElGSUVEX0FUX1ZFUlNJT04QBCJ0CgxJbml0aWFsVmFsdWUSFgoSSU5JVElBTF9WQUxVRV9OT05FEAASGgoWSU5JVElBTF9WQUxVRV9TRVFVRU5DRRABEhYKEklOSVRJQUxfVkFMVUVfVVVJRBACEhgKFElOSVRJQUxfVkFMVUVfUkFORDUzEARCBgoEdHlwZUIHCgV2YWx1ZSJMCgxGbG9hdE9wdGlvbnMSPAoMaW50ZXJwcmV0X2FzGAIgASgOMiYuc3RhdGVseS5zY2hlbWFtb2RlbC5OdW1iZXJJbnRlcnByZXRBcyJNCg1Eb3VibGVPcHRpb25zEjwKDGludGVycHJldF9hcxgCIAEoDjImLnN0YXRlbHkuc2NoZW1hbW9kZWwuTnVtYmVySW50ZXJwcmV0QXMiTAoMSW50MzJPcHRpb25zEjwKDGludGVycHJldF9hcxgCIAEoDjImLnN0YXRlbHkuc2NoZW1hbW9kZWwuTnVtYmVySW50ZXJwcmV0QXMiTAoMSW50NjRPcHRpb25zEjwKDGludGVycHJldF9hcxgCIAEoDjImLnN0YXRlbHkuc2NoZW1hbW9kZWwuTnVtYmVySW50ZXJwcmV0QXMiTQoNVUludDMyT3B0aW9ucxI8CgxpbnRlcnByZXRfYXMYAiABKA4yJi5zdGF0ZWx5LnNjaGVtYW1vZGVsLk51bWJlckludGVycHJldEFzIk0KDVVJbnQ2NE9wdGlvbnMSPAoMaW50ZXJwcmV0X2FzGAIgASgOMiYuc3RhdGVseS5zY2hlbWFtb2RlbC5OdW1iZXJJbnRlcnByZXRBcyJNCg1TSW50MzJPcHRpb25zEjwKDGludGVycHJldF9hcxgCIAEoDjImLnN0YXRlbHkuc2NoZW1hbW9kZWwuTnVtYmVySW50ZXJwcmV0QXMiTQoNU0ludDY0T3B0aW9ucxI8CgxpbnRlcnByZXRfYXMYAiABKA4yJi5zdGF0ZWx5LnNjaGVtYW1vZGVsLk51bWJlckludGVycHJldEFzIk4KDkZpeGVkMzJPcHRpb25zEjwKDGludGVycHJldF9hcxgCIAEoDjImLnN0YXRlbHkuc2NoZW1hbW9kZWwuTnVtYmVySW50ZXJwcmV0QXMiTgoORml4ZWQ2NE9wdGlvbnMSPAoMaW50ZXJwcmV0X2FzGAIgASgOMiYuc3RhdGVseS5zY2hlbWFtb2RlbC5OdW1iZXJJbnRlcnByZXRBcyJPCg9TRml4ZWQzMk9wdGlvbnMSPAoMaW50ZXJwcmV0X2FzGAIgASgOMiYuc3RhdGVseS5zY2hlbWFtb2RlbC5OdW1iZXJJbnRlcnByZXRBcyJPCg9TRml4ZWQ2NE9wdGlvbnMSPAoMaW50ZXJwcmV0X2FzGAIgASgOMiYuc3RhdGVseS5zY2hlbWFtb2RlbC5OdW1iZXJJbnRlcnByZXRBcyJNCg1TdHJpbmdPcHRpb25zEjwKDGludGVycHJldF9hcxgCIAEoDjImLnN0YXRlbHkuc2NoZW1hbW9kZWwuU3RyaW5nSW50ZXJwcmV0QXMiSwoMQnl0ZXNPcHRpb25zEjsKDGludGVycHJldF9hcxgCIAEoDjIlLnN0YXRlbHkuc2NoZW1hbW9kZWwuQnl0ZXNJbnRlcnByZXRBcyqXAgoRTnVtYmVySW50ZXJwcmV0QXMSHgoaTlVNQkVSX0lOVEVSUFJFVF9BU19OVU1CRVIQABIpCiVOVU1CRVJfSU5URVJQUkVUX0FTX1RJTUVTVEFNUF9TRUNPTkRTEAESLgoqTlVNQkVSX0lOVEVSUFJFVF9BU19USU1FU1RBTVBfTUlMTElTRUNPTkRTEAISLgoqTlVNQkVSX0lOVEVSUFJFVF9BU19USU1FU1RBTVBfTUlDUk9TRUNPTkRTEAMSKAokTlVNQkVSX0lOVEVSUFJFVF9BU19EVVJBVElPTl9TRUNPTkRTEAQSLQopTlVNQkVSX0lOVEVSUFJFVF9BU19EVVJBVElPTl9NSUxMSVNFQ09ORFMQBSpNChBCeXRlc0ludGVycHJldEFzEhwKGEJZVEVTX0lOVEVSUFJFVF9BU19CWVRFUxAAEhsKF0JZVEVTX0lOVEVSUFJFVF9BU19VVUlEEAEqcgoRU3RyaW5nSW50ZXJwcmV0QXMSHgoaU1RSSU5HX0lOVEVSUFJFVF9BU19TVFJJTkcQABIgChxTVFJJTkdfSU5URVJQUkVUX0FTX0tFWV9QQVRIEAESGwoXU1RSSU5HX0lOVEVSUFJFVF9BU19VUkwQAkKUAQoXY29tLnN0YXRlbHkuc2NoZW1hbW9kZWxCDE9wdGlvbnNQcm90b1ABogIDU1NYqgITU3RhdGVseS5TY2hlbWFtb2RlbMoCE1N0YXRlbHlcU2NoZW1hbW9kZWziAh9TdGF0ZWx5XFNjaGVtYW1vZGVsXEdQQk1ldGFkYXRh6gIUU3RhdGVseTo6U2NoZW1hbW9kZWxiBnByb3RvMw", [file_buf_validate_validate]);
 /**
@@ -130,11 +130,6 @@ * Describes the message stately.schemamodel.MessageOptions.
 /**
- * Describes the message stately.schemamodel.BoolOptions.
- * Use `create(BoolOptionsSchema)` to create a new message.
- */
-export const BoolOptionsSchema = /*@__PURE__*/ messageDesc(file_options, 15);
-/**
  * Describes the message stately.schemamodel.StringOptions.
  * Use `create(StringOptionsSchema)` to create a new message.
  */
-export const StringOptionsSchema = /*@__PURE__*/ messageDesc(file_options, 16);
+export const StringOptionsSchema = /*@__PURE__*/ messageDesc(file_options, 15);
 /**
@@ -144,3 +139,3 @@ * Describes the message stately.schemamodel.BytesOptions.
  */
-export const BytesOptionsSchema = /*@__PURE__*/ messageDesc(file_options, 17);
+export const BytesOptionsSchema = /*@__PURE__*/ messageDesc(file_options, 16);
 /**
@@ -147,0 +142,0 @@ * Describes the enum stately.schemamodel.NumberInterpretAs.

dist/type-registry.js

@@ -83,3 +83,4 @@ import { deepEqual } from "fast-equals";
                 a.config.interpretAs === b.config.interpretAs &&
-                a.config.valid === b.config.valid);
+                a.config.valid === b.config.valid &&
+                deepEqual(a.config.readDefault, b.config.readDefault));
     }
@@ -86,0 +87,0 @@ }

dist/types.d.ts

@@ -28,7 +28,9 @@ import { DescriptorProto, EnumDescriptorProto, FieldDescriptorProto_Label, FieldDescriptorProto_Type } from "@bufbuild/protobuf/wkt";
     /**
-     * The default value for this type. This is used when a field is not set. If
-     * this isn't specified, the default is the "zero value" for the type - null
-     * for messages, zero for numbers and enums, false for booleans, and empty for
-     * arrays, strings and byte arrays.
+     * The default value for this type. This is returned on read when a field is
+     * not set. This value won't actually be saved into the database. If this
+     * isn't specified, the default is the "zero value" for the type - null for
+     * messages, zero for numbers and enums, false for booleans, and empty for
+     * arrays, strings and byte arrays. A required field cannot be the zero value.
      */
+    readDefault?: unknown;
     /**
@@ -157,2 +159,3 @@ * Whether this type as a whole is deprecated. This can affect generated code.
     interpretAs?: SchemaType["interpretAs"];
+    readDefault?: SchemaType["readDefault"];
 };

dist/types.js

@@ -206,2 +206,3 @@ import { getExtension, hasExtension, isMessage } from "@bufbuild/protobuf";
     let interpretAs;
+    let readDefault;
     // Iterate through a chain of types to determine the set of resolved options.
@@ -222,2 +223,6 @@ let currentType = type;
         }
+        // Only take the "topmost" default value.
+        if (readDefault === undefined && currentType.readDefault !== undefined) {
+            readDefault = currentType.readDefault;
+        }
         const parentType = currentType.parentType;
@@ -249,4 +254,5 @@ switch (typeof parentType) {
         interpretAs,
+        readDefault,
     };
 }
 //# sourceMappingURL=types.js.map

package.json

 {
   "name": "@stately-cloud/schema",
-  "version": "0.17.0",
+  "version": "0.18.0",
   "engines": {
@@ -5,0 +5,0 @@ "node": ">=18.20"

New alerts

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

Fixed alerts

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

296675

increased by1.21%

Lines of code

3835

increased by1.19%

No dependency changes