typia 9.7.0 → 9.7.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/AssertionGuard.d.mts +27 -25
- package/lib/AssertionGuard.d.ts +27 -25
- package/lib/CamelCase.d.mts +1 -1
- package/lib/CamelCase.d.ts +1 -1
- package/lib/IRandomGenerator.d.mts +44 -42
- package/lib/IRandomGenerator.d.ts +44 -42
- package/lib/IReadableURLSearchParams.d.mts +2 -2
- package/lib/IReadableURLSearchParams.d.ts +2 -2
- package/lib/PascalCase.d.mts +1 -1
- package/lib/PascalCase.d.ts +1 -1
- package/lib/Primitive.d.mts +20 -22
- package/lib/Primitive.d.ts +20 -22
- package/lib/Resolved.d.mts +16 -18
- package/lib/Resolved.d.ts +16 -18
- package/lib/SnakeCase.d.mts +3 -2
- package/lib/SnakeCase.d.ts +3 -2
- package/lib/TypeGuardError.d.mts +88 -61
- package/lib/TypeGuardError.d.ts +88 -61
- package/lib/TypeGuardError.js +40 -29
- package/lib/TypeGuardError.js.map +1 -1
- package/lib/TypeGuardError.mjs +70 -48
- package/lib/factories/MetadataCollection.js +4 -12
- package/lib/factories/MetadataCollection.js.map +1 -1
- package/lib/factories/MetadataCollection.mjs +4 -12
- package/lib/factories/MetadataCommentTagFactory.js +5 -15
- package/lib/factories/MetadataCommentTagFactory.js.map +1 -1
- package/lib/factories/MetadataCommentTagFactory.mjs +5 -15
- package/lib/factories/MetadataFactory.js +1 -3
- package/lib/factories/MetadataFactory.js.map +1 -1
- package/lib/factories/MetadataFactory.mjs +1 -3
- package/lib/factories/ProtobufFactory.js +1 -3
- package/lib/factories/ProtobufFactory.js.map +1 -1
- package/lib/factories/ProtobufFactory.mjs +1 -3
- package/lib/functional.d.mts +196 -195
- package/lib/functional.d.ts +196 -195
- package/lib/functional.js +18 -54
- package/lib/functional.js.map +1 -1
- package/lib/functional.mjs +18 -54
- package/lib/http.d.mts +303 -319
- package/lib/http.d.ts +303 -319
- package/lib/http.js +26 -78
- package/lib/http.js.map +1 -1
- package/lib/http.mjs +26 -78
- package/lib/internal/_ProtobufReader.d.mts +3 -9
- package/lib/internal/_ProtobufReader.d.ts +3 -9
- package/lib/internal/_ProtobufReader.js.map +1 -1
- package/lib/internal/_ProtobufReader.mjs +3 -9
- package/lib/internal/_ProtobufSizer.d.mts +4 -12
- package/lib/internal/_ProtobufSizer.d.ts +4 -12
- package/lib/internal/_ProtobufSizer.js.map +1 -1
- package/lib/internal/_ProtobufSizer.mjs +4 -12
- package/lib/internal/_ProtobufWriter.d.mts +5 -15
- package/lib/internal/_ProtobufWriter.d.ts +5 -15
- package/lib/internal/_ProtobufWriter.js.map +1 -1
- package/lib/internal/_ProtobufWriter.mjs +5 -15
- package/lib/internal/_jsonStringifyString.d.mts +4 -4
- package/lib/internal/_jsonStringifyString.d.ts +4 -4
- package/lib/internal/_jsonStringifyString.js +4 -4
- package/lib/internal/_jsonStringifyString.mjs +4 -4
- package/lib/json.d.mts +174 -195
- package/lib/json.d.ts +174 -195
- package/lib/json.js +16 -48
- package/lib/json.js.map +1 -1
- package/lib/json.mjs +16 -48
- package/lib/llm.d.mts +275 -192
- package/lib/llm.d.ts +275 -192
- package/lib/llm.js +4 -12
- package/lib/llm.js.map +1 -1
- package/lib/llm.mjs +4 -12
- package/lib/misc.d.mts +149 -172
- package/lib/misc.d.ts +149 -172
- package/lib/misc.js +17 -51
- package/lib/misc.js.map +1 -1
- package/lib/misc.mjs +17 -51
- package/lib/module.d.mts +263 -275
- package/lib/module.d.ts +263 -275
- package/lib/module.js +18 -54
- package/lib/module.js.map +1 -1
- package/lib/module.mjs +18 -54
- package/lib/notations.d.mts +153 -174
- package/lib/notations.d.ts +153 -174
- package/lib/notations.js +24 -72
- package/lib/notations.js.map +1 -1
- package/lib/notations.mjs +24 -72
- package/lib/programmers/FeatureProgrammer.d.mts +19 -41
- package/lib/programmers/FeatureProgrammer.d.ts +19 -41
- package/lib/programmers/FeatureProgrammer.js.map +1 -1
- package/lib/programmers/ImportProgrammer.js +3 -9
- package/lib/programmers/ImportProgrammer.js.map +1 -1
- package/lib/programmers/ImportProgrammer.mjs +3 -9
- package/lib/programmers/RandomProgrammer.js +6 -0
- package/lib/programmers/RandomProgrammer.js.map +1 -1
- package/lib/programmers/RandomProgrammer.mjs +6 -0
- package/lib/programmers/helpers/ProtobufWire.d.mts +13 -13
- package/lib/programmers/helpers/ProtobufWire.d.ts +13 -13
- package/lib/programmers/internal/check_array_length.js +2 -6
- package/lib/programmers/internal/check_array_length.js.map +1 -1
- package/lib/programmers/internal/check_array_length.mjs +2 -6
- package/lib/programmers/internal/check_bigint.js +2 -6
- package/lib/programmers/internal/check_bigint.js.map +1 -1
- package/lib/programmers/internal/check_bigint.mjs +2 -6
- package/lib/programmers/internal/check_dynamic_key.js +2 -6
- package/lib/programmers/internal/check_dynamic_key.js.map +1 -1
- package/lib/programmers/internal/check_dynamic_key.mjs +2 -6
- package/lib/programmers/internal/check_dynamic_properties.js +3 -9
- package/lib/programmers/internal/check_dynamic_properties.js.map +1 -1
- package/lib/programmers/internal/check_dynamic_properties.mjs +3 -9
- package/lib/programmers/internal/check_everything.js +1 -3
- package/lib/programmers/internal/check_everything.js.map +1 -1
- package/lib/programmers/internal/check_everything.mjs +1 -3
- package/lib/programmers/internal/check_native.js +2 -6
- package/lib/programmers/internal/check_native.js.map +1 -1
- package/lib/programmers/internal/check_native.mjs +2 -6
- package/lib/programmers/internal/check_number.js +2 -6
- package/lib/programmers/internal/check_number.js.map +1 -1
- package/lib/programmers/internal/check_number.mjs +2 -6
- package/lib/programmers/internal/check_object.js +2 -6
- package/lib/programmers/internal/check_object.js.map +1 -1
- package/lib/programmers/internal/check_object.mjs +2 -6
- package/lib/programmers/internal/check_string.js +2 -6
- package/lib/programmers/internal/check_string.js.map +1 -1
- package/lib/programmers/internal/check_string.mjs +2 -6
- package/lib/programmers/internal/check_template.js +1 -3
- package/lib/programmers/internal/check_template.js.map +1 -1
- package/lib/programmers/internal/check_template.mjs +1 -3
- package/lib/programmers/internal/check_union_array_like.js +1 -3
- package/lib/programmers/internal/check_union_array_like.js.map +1 -1
- package/lib/programmers/internal/check_union_array_like.mjs +1 -3
- package/lib/programmers/internal/decode_union_object.js +2 -6
- package/lib/programmers/internal/decode_union_object.js.map +1 -1
- package/lib/programmers/internal/decode_union_object.mjs +2 -6
- package/lib/programmers/internal/feature_object_entries.js +1 -3
- package/lib/programmers/internal/feature_object_entries.js.map +1 -1
- package/lib/programmers/internal/feature_object_entries.mjs +1 -3
- package/lib/programmers/internal/json_schema_escaped.js +2 -6
- package/lib/programmers/internal/json_schema_escaped.js.map +1 -1
- package/lib/programmers/internal/json_schema_escaped.mjs +2 -6
- package/lib/programmers/internal/json_schema_object.js +3 -9
- package/lib/programmers/internal/json_schema_object.js.map +1 -1
- package/lib/programmers/internal/json_schema_object.mjs +3 -9
- package/lib/programmers/internal/metadata_to_pattern.js +1 -3
- package/lib/programmers/internal/metadata_to_pattern.js.map +1 -1
- package/lib/programmers/internal/metadata_to_pattern.mjs +1 -3
- package/lib/programmers/internal/postfix_of_tuple.js +1 -3
- package/lib/programmers/internal/postfix_of_tuple.js.map +1 -1
- package/lib/programmers/internal/postfix_of_tuple.mjs +1 -3
- package/lib/programmers/internal/prune_object_properties.js +1 -3
- package/lib/programmers/internal/prune_object_properties.js.map +1 -1
- package/lib/programmers/internal/prune_object_properties.mjs +1 -3
- package/lib/programmers/internal/stringify_dynamic_properties.js +2 -6
- package/lib/programmers/internal/stringify_dynamic_properties.js.map +1 -1
- package/lib/programmers/internal/stringify_dynamic_properties.mjs +2 -6
- package/lib/programmers/internal/stringify_native.js +1 -3
- package/lib/programmers/internal/stringify_native.js.map +1 -1
- package/lib/programmers/internal/stringify_native.mjs +1 -3
- package/lib/programmers/internal/stringify_regular_properties.js +2 -6
- package/lib/programmers/internal/stringify_regular_properties.js.map +1 -1
- package/lib/programmers/internal/stringify_regular_properties.mjs +2 -6
- package/lib/programmers/internal/template_to_pattern.js +1 -3
- package/lib/programmers/internal/template_to_pattern.js.map +1 -1
- package/lib/programmers/internal/template_to_pattern.mjs +1 -3
- package/lib/programmers/internal/wrap_metadata_rest_tuple.js +1 -3
- package/lib/programmers/internal/wrap_metadata_rest_tuple.js.map +1 -1
- package/lib/programmers/internal/wrap_metadata_rest_tuple.mjs +1 -3
- package/lib/protobuf.d.mts +290 -297
- package/lib/protobuf.d.ts +290 -297
- package/lib/protobuf.js +17 -51
- package/lib/protobuf.js.map +1 -1
- package/lib/protobuf.mjs +17 -51
- package/lib/reflect.d.mts +2 -4
- package/lib/reflect.d.ts +2 -4
- package/lib/reflect.js +1 -3
- package/lib/reflect.js.map +1 -1
- package/lib/reflect.mjs +1 -3
- package/lib/schemas/json/IJsonApplication.d.mts +4 -4
- package/lib/schemas/json/IJsonApplication.d.ts +4 -4
- package/lib/schemas/json/IJsonSchemaCollection.d.mts +73 -56
- package/lib/schemas/json/IJsonSchemaCollection.d.ts +73 -56
- package/lib/schemas/json/IJsonSchemaUnit.d.mts +83 -70
- package/lib/schemas/json/IJsonSchemaUnit.d.ts +83 -70
- package/lib/schemas/metadata/Metadata.d.mts +1 -3
- package/lib/schemas/metadata/Metadata.d.ts +1 -3
- package/lib/schemas/metadata/Metadata.js +9 -27
- package/lib/schemas/metadata/Metadata.js.map +1 -1
- package/lib/schemas/metadata/Metadata.mjs +9 -27
- package/lib/schemas/metadata/MetadataAliasType.d.mts +1 -3
- package/lib/schemas/metadata/MetadataAliasType.d.ts +1 -3
- package/lib/schemas/metadata/MetadataAliasType.js +3 -9
- package/lib/schemas/metadata/MetadataAliasType.js.map +1 -1
- package/lib/schemas/metadata/MetadataAliasType.mjs +3 -9
- package/lib/schemas/metadata/MetadataApplication.d.mts +1 -3
- package/lib/schemas/metadata/MetadataApplication.d.ts +1 -3
- package/lib/schemas/metadata/MetadataApplication.js +2 -6
- package/lib/schemas/metadata/MetadataApplication.js.map +1 -1
- package/lib/schemas/metadata/MetadataApplication.mjs +2 -6
- package/lib/schemas/metadata/MetadataArray.d.mts +1 -3
- package/lib/schemas/metadata/MetadataArray.d.ts +1 -3
- package/lib/schemas/metadata/MetadataArray.js +1 -3
- package/lib/schemas/metadata/MetadataArray.js.map +1 -1
- package/lib/schemas/metadata/MetadataArray.mjs +1 -3
- package/lib/schemas/metadata/MetadataArrayType.d.mts +1 -3
- package/lib/schemas/metadata/MetadataArrayType.d.ts +1 -3
- package/lib/schemas/metadata/MetadataArrayType.js +3 -9
- package/lib/schemas/metadata/MetadataArrayType.js.map +1 -1
- package/lib/schemas/metadata/MetadataArrayType.mjs +3 -9
- package/lib/schemas/metadata/MetadataAtomic.js +1 -3
- package/lib/schemas/metadata/MetadataAtomic.js.map +1 -1
- package/lib/schemas/metadata/MetadataAtomic.mjs +1 -3
- package/lib/schemas/metadata/MetadataEscaped.d.mts +1 -3
- package/lib/schemas/metadata/MetadataEscaped.d.ts +1 -3
- package/lib/schemas/metadata/MetadataEscaped.js +3 -9
- package/lib/schemas/metadata/MetadataEscaped.js.map +1 -1
- package/lib/schemas/metadata/MetadataEscaped.mjs +3 -9
- package/lib/schemas/metadata/MetadataFunction.d.mts +1 -3
- package/lib/schemas/metadata/MetadataFunction.d.ts +1 -3
- package/lib/schemas/metadata/MetadataFunction.js +2 -6
- package/lib/schemas/metadata/MetadataFunction.js.map +1 -1
- package/lib/schemas/metadata/MetadataFunction.mjs +2 -6
- package/lib/schemas/metadata/MetadataObject.d.mts +1 -3
- package/lib/schemas/metadata/MetadataObject.d.ts +1 -3
- package/lib/schemas/metadata/MetadataObject.js +1 -3
- package/lib/schemas/metadata/MetadataObject.js.map +1 -1
- package/lib/schemas/metadata/MetadataObject.mjs +1 -3
- package/lib/schemas/metadata/MetadataObjectType.d.mts +1 -3
- package/lib/schemas/metadata/MetadataObjectType.d.ts +1 -3
- package/lib/schemas/metadata/MetadataObjectType.js +5 -15
- package/lib/schemas/metadata/MetadataObjectType.js.map +1 -1
- package/lib/schemas/metadata/MetadataObjectType.mjs +6 -18
- package/lib/schemas/metadata/MetadataParameter.js +1 -3
- package/lib/schemas/metadata/MetadataParameter.js.map +1 -1
- package/lib/schemas/metadata/MetadataParameter.mjs +1 -3
- package/lib/schemas/metadata/MetadataProperty.d.mts +1 -3
- package/lib/schemas/metadata/MetadataProperty.d.ts +1 -3
- package/lib/schemas/metadata/MetadataProperty.js +3 -9
- package/lib/schemas/metadata/MetadataProperty.js.map +1 -1
- package/lib/schemas/metadata/MetadataProperty.mjs +3 -9
- package/lib/schemas/metadata/MetadataTemplate.js +1 -3
- package/lib/schemas/metadata/MetadataTemplate.js.map +1 -1
- package/lib/schemas/metadata/MetadataTemplate.mjs +1 -3
- package/lib/schemas/metadata/MetadataTuple.d.mts +1 -3
- package/lib/schemas/metadata/MetadataTuple.d.ts +1 -3
- package/lib/schemas/metadata/MetadataTuple.js +2 -6
- package/lib/schemas/metadata/MetadataTuple.js.map +1 -1
- package/lib/schemas/metadata/MetadataTuple.mjs +2 -6
- package/lib/schemas/metadata/MetadataTupleType.js +2 -6
- package/lib/schemas/metadata/MetadataTupleType.js.map +1 -1
- package/lib/schemas/metadata/MetadataTupleType.mjs +3 -9
- package/lib/tags/Constant.d.mts +32 -0
- package/lib/tags/Constant.d.ts +32 -0
- package/lib/tags/ContentMediaType.d.mts +17 -0
- package/lib/tags/ContentMediaType.d.ts +17 -0
- package/lib/tags/Default.d.mts +30 -0
- package/lib/tags/Default.d.ts +30 -0
- package/lib/tags/Example.d.mts +32 -0
- package/lib/tags/Example.d.ts +32 -0
- package/lib/tags/Examples.d.mts +40 -0
- package/lib/tags/Examples.d.ts +40 -0
- package/lib/tags/ExclusiveMaximum.d.mts +21 -0
- package/lib/tags/ExclusiveMaximum.d.ts +21 -0
- package/lib/tags/ExclusiveMinimum.d.mts +21 -0
- package/lib/tags/ExclusiveMinimum.d.ts +21 -0
- package/lib/tags/Format.d.mts +28 -0
- package/lib/tags/Format.d.ts +28 -0
- package/lib/tags/JsonSchemaPlugin.d.mts +28 -0
- package/lib/tags/JsonSchemaPlugin.d.ts +28 -0
- package/lib/tags/MaxItems.d.mts +19 -0
- package/lib/tags/MaxItems.d.ts +19 -0
- package/lib/tags/MaxLength.d.mts +13 -0
- package/lib/tags/MaxLength.d.ts +13 -0
- package/lib/tags/Maximum.d.mts +20 -0
- package/lib/tags/Maximum.d.ts +20 -0
- package/lib/tags/MinItems.d.mts +19 -0
- package/lib/tags/MinItems.d.ts +19 -0
- package/lib/tags/MinLength.d.mts +13 -0
- package/lib/tags/MinLength.d.ts +13 -0
- package/lib/tags/Minimum.d.mts +20 -0
- package/lib/tags/Minimum.d.ts +20 -0
- package/lib/tags/MultipleOf.d.mts +21 -0
- package/lib/tags/MultipleOf.d.ts +21 -0
- package/lib/tags/Pattern.d.mts +18 -0
- package/lib/tags/Pattern.d.ts +18 -0
- package/lib/tags/Sequence.d.mts +27 -0
- package/lib/tags/Sequence.d.ts +27 -0
- package/lib/tags/TagBase.d.mts +38 -18
- package/lib/tags/TagBase.d.ts +38 -18
- package/lib/tags/Type.d.mts +27 -0
- package/lib/tags/Type.d.ts +27 -0
- package/lib/tags/UniqueItems.d.mts +20 -0
- package/lib/tags/UniqueItems.d.ts +20 -0
- package/lib/tags/internal/FormatCheatSheet.d.mts +1 -3
- package/lib/tags/internal/FormatCheatSheet.d.ts +1 -3
- package/lib/tags/internal/FormatCheatSheet.js +1 -3
- package/lib/tags/internal/FormatCheatSheet.js.map +1 -1
- package/lib/tags/internal/FormatCheatSheet.mjs +1 -3
- package/lib/transformers/ITransformOptions.d.mts +27 -19
- package/lib/transformers/ITransformOptions.d.ts +27 -19
- package/lib/transformers/ImportTransformer.js +114 -1
- package/lib/transformers/ImportTransformer.js.map +1 -1
- package/lib/transformers/ImportTransformer.mjs +114 -1
- package/lib/transformers/NoTransformConfigurationError.js +1 -3
- package/lib/transformers/NoTransformConfigurationError.js.map +1 -1
- package/lib/transformers/NoTransformConfigurationError.mjs +1 -3
- package/lib/transformers/features/llm/LlmApplicationTransformer.js +1 -3
- package/lib/transformers/features/llm/LlmApplicationTransformer.js.map +1 -1
- package/lib/transformers/features/llm/LlmApplicationTransformer.mjs +1 -3
- package/lib/typings/Equal.d.mts +6 -6
- package/lib/typings/Equal.d.ts +6 -6
- package/package.json +2 -1
- package/src/AssertionGuard.ts +27 -25
- package/src/CamelCase.ts +1 -1
- package/src/IRandomGenerator.ts +57 -47
- package/src/IReadableURLSearchParams.ts +2 -2
- package/src/PascalCase.ts +1 -1
- package/src/Primitive.ts +20 -22
- package/src/Resolved.ts +16 -18
- package/src/SnakeCase.ts +3 -2
- package/src/TypeGuardError.ts +101 -64
- package/src/factories/MetadataCollection.ts +4 -12
- package/src/factories/MetadataCommentTagFactory.ts +8 -24
- package/src/factories/MetadataFactory.ts +1 -3
- package/src/factories/ProtobufFactory.ts +1 -3
- package/src/functional.ts +214 -249
- package/src/http.ts +329 -397
- package/src/internal/_ProtobufReader.ts +3 -9
- package/src/internal/_ProtobufSizer.ts +4 -12
- package/src/internal/_ProtobufWriter.ts +5 -15
- package/src/internal/_jsonStringifyString.ts +4 -4
- package/src/json.ts +190 -243
- package/src/llm.ts +279 -204
- package/src/misc.ts +166 -223
- package/src/module.ts +281 -329
- package/src/notations.ts +177 -246
- package/src/programmers/FeatureProgrammer.ts +19 -41
- package/src/programmers/ImportProgrammer.ts +3 -9
- package/src/programmers/RandomProgrammer.ts +6 -1
- package/src/programmers/helpers/ProtobufWire.ts +13 -13
- package/src/programmers/internal/check_array_length.ts +2 -6
- package/src/programmers/internal/check_bigint.ts +2 -6
- package/src/programmers/internal/check_dynamic_key.ts +2 -6
- package/src/programmers/internal/check_dynamic_properties.ts +3 -9
- package/src/programmers/internal/check_everything.ts +1 -3
- package/src/programmers/internal/check_native.ts +2 -6
- package/src/programmers/internal/check_number.ts +2 -6
- package/src/programmers/internal/check_object.ts +3 -9
- package/src/programmers/internal/check_string.ts +2 -6
- package/src/programmers/internal/check_template.ts +1 -3
- package/src/programmers/internal/check_union_array_like.ts +2 -6
- package/src/programmers/internal/decode_union_object.ts +3 -9
- package/src/programmers/internal/feature_object_entries.ts +1 -3
- package/src/programmers/internal/json_schema_escaped.ts +2 -6
- package/src/programmers/internal/json_schema_object.ts +4 -12
- package/src/programmers/internal/metadata_to_pattern.ts +1 -3
- package/src/programmers/internal/postfix_of_tuple.ts +1 -3
- package/src/programmers/internal/prune_object_properties.ts +1 -3
- package/src/programmers/internal/stringify_dynamic_properties.ts +2 -6
- package/src/programmers/internal/stringify_native.ts +1 -3
- package/src/programmers/internal/stringify_regular_properties.ts +2 -6
- package/src/programmers/internal/template_to_pattern.ts +1 -3
- package/src/programmers/internal/wrap_metadata_rest_tuple.ts +1 -3
- package/src/protobuf.ts +307 -348
- package/src/reflect.ts +3 -7
- package/src/schemas/json/IJsonApplication.ts +4 -4
- package/src/schemas/json/IJsonSchemaCollection.ts +73 -56
- package/src/schemas/json/IJsonSchemaUnit.ts +83 -70
- package/src/schemas/metadata/IMetadataTypeTag.ts +1 -3
- package/src/schemas/metadata/Metadata.ts +9 -27
- package/src/schemas/metadata/MetadataAliasType.ts +3 -9
- package/src/schemas/metadata/MetadataApplication.ts +2 -6
- package/src/schemas/metadata/MetadataArray.ts +1 -3
- package/src/schemas/metadata/MetadataArrayType.ts +3 -9
- package/src/schemas/metadata/MetadataAtomic.ts +1 -3
- package/src/schemas/metadata/MetadataEscaped.ts +3 -9
- package/src/schemas/metadata/MetadataFunction.ts +2 -6
- package/src/schemas/metadata/MetadataObject.ts +1 -3
- package/src/schemas/metadata/MetadataObjectType.ts +6 -18
- package/src/schemas/metadata/MetadataParameter.ts +1 -3
- package/src/schemas/metadata/MetadataProperty.ts +3 -9
- package/src/schemas/metadata/MetadataTemplate.ts +1 -3
- package/src/schemas/metadata/MetadataTuple.ts +2 -6
- package/src/schemas/metadata/MetadataTupleType.ts +3 -9
- package/src/tags/Constant.ts +32 -0
- package/src/tags/ContentMediaType.ts +17 -0
- package/src/tags/Default.ts +30 -0
- package/src/tags/Example.ts +32 -0
- package/src/tags/Examples.ts +40 -0
- package/src/tags/ExclusiveMaximum.ts +21 -0
- package/src/tags/ExclusiveMinimum.ts +21 -0
- package/src/tags/Format.ts +28 -0
- package/src/tags/JsonSchemaPlugin.ts +28 -0
- package/src/tags/MaxItems.ts +19 -0
- package/src/tags/MaxLength.ts +13 -0
- package/src/tags/Maximum.ts +20 -0
- package/src/tags/MinItems.ts +19 -0
- package/src/tags/MinLength.ts +13 -0
- package/src/tags/Minimum.ts +20 -0
- package/src/tags/MultipleOf.ts +21 -0
- package/src/tags/Pattern.ts +18 -0
- package/src/tags/Sequence.ts +27 -0
- package/src/tags/TagBase.ts +38 -18
- package/src/tags/Type.ts +27 -0
- package/src/tags/UniqueItems.ts +20 -0
- package/src/tags/internal/FormatCheatSheet.ts +1 -3
- package/src/transformers/ITransformOptions.ts +27 -19
- package/src/transformers/ImportTransformer.ts +173 -1
- package/src/transformers/NoTransformConfigurationError.ts +1 -3
- package/src/transformers/features/llm/LlmApplicationTransformer.ts +1 -3
- package/src/typings/Equal.ts +6 -6
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"MetadataObjectType.js","sourceRoot":"","sources":["../../../src/schemas/metadata/MetadataObjectType.ts"],"names":[],"mappings":";;;AAMA,MAAa,kBAAkB;
|
|
1
|
+
{"version":3,"file":"MetadataObjectType.js","sourceRoot":"","sources":["../../../src/schemas/metadata/MetadataObjectType.ts"],"names":[],"mappings":";;;AAMA,MAAa,kBAAkB;IAiB7B;;oEAEgE;IAChE,cAAc;IACd,YACE,KAA2D;QAbtD,cAAS,GAAc,EAAE,CAAC;QAEjC,gBAAgB;QACT,YAAO,GAAY,KAAK,CAAC;QAY9B,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QACvB,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC;QACnC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACrC,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;QAEjC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;QACzB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;QACjC,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;QACjC,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;QAEzC,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;IACvB,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,MAAM,CAClB,KAA2D;QAE3D,OAAO,IAAI,kBAAkB,CAAC,KAAK,CAAC,CAAC;IACvC,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,wBAAwB,CACpC,GAAwB;QAExB,OAAO,kBAAkB,CAAC,MAAM,CAAC;YAC/B,IAAI,EAAE,GAAG,CAAC,IAAI;YACd,UAAU,EAAE,EAAE;YACd,WAAW,EAAE,GAAG,CAAC,WAAW;YAC5B,SAAS,EAAE,GAAG,CAAC,SAAS;YAExB,KAAK,EAAE,GAAG,CAAC,KAAK;YAChB,SAAS,EAAE,KAAK;YAChB,SAAS,EAAE,GAAG,CAAC,SAAS;YACxB,SAAS,EAAE,GAAG,CAAC,SAAS,CAAC,KAAK,EAAE;SACjC,CAAC,CAAC;IACL,CAAC;IAEM,OAAO,CAAC,QAAgB,CAAC;QAC9B,OAAO,CACL,IAAI,CAAC,SAAS,KAAK,KAAK;YACxB,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,EAAE;YAC3B,IAAI,CAAC,UAAU,CAAC,KAAK,CACnB,CAAC,QAAQ,EAAE,EAAE,CACX,QAAQ,CAAC,GAAG,CAAC,aAAa,EAAE;gBAC5B,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC;gBAC3B,QAAQ,CAAC,KAAK,CAAC,UAAU,EAAE,KAAK,IAAI;gBACpC,QAAQ,CAAC,KAAK,CAAC,QAAQ,KAAK,KAAK;gBACjC,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC;oBAClC,CAAC,KAAK,GAAG,CAAC;wBACR,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC;wBACnC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAE,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAC3D,CACF,CAAC;IACJ,CAAC;IAEM,SAAS;;QACd,OAAO,OAAC,IAAI,CAAC,QAAQ,oCAAb,IAAI,CAAC,QAAQ,GAAK,CAAC,GAAG,EAAE;YAC9B,IAAI,IAAI,CAAC,SAAS,KAAK,IAAI;gBAAE,OAAO,KAAK,CAAC;YAC1C,OAAO,CACL,IAAI,CAAC,IAAI,KAAK,QAAQ;gBACtB,IAAI,CAAC,IAAI,KAAK,UAAU;gBACxB,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC;gBAC/B,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;gBACjC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,CACjC,CAAC;QACJ,CAAC,CAAC,EAAE,EAAC,CAAC;IACR,CAAC;IAEM,MAAM;QACX,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;YAChE,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,SAAS,EAAE,IAAI,CAAC,SAAS;YAEzB,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE;SAClC,CAAC;IACJ,CAAC;CACF;AAxGD,gDAwGC;AAED,gBAAgB;AAChB,WAAiB,kBAAkB;IACpB,6BAAU,GAAG,CACxB,CAAqB,EACrB,CAAqB,EACZ,EAAE,CACX,CAAC,CAAC,UAAU,CAAC,IAAI,CACf,CAAC,IAAI,EAAE,EAAE,CACP,CAAC,CAAC,UAAU,CAAC,IAAI,CACf,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,CACpD,KAAK,SAAS,CAClB,CAAC;IAES,yBAAM,GAAG,CACpB,CAAqB,EACrB,CAAqB,EACZ,EAAE,CACX,CAAC,CAAC,UAAU,CAAC,MAAM,IAAI,CAAC,CAAC,UAAU,CAAC,MAAM;QAC1C,CAAC,CAAC,UAAU,CAAC,KAAK,CAChB,CAAC,IAAI,EAAE,EAAE,CACP,CAAC,CAAC,UAAU,CAAC,IAAI,CACf,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,CACpD,KAAK,SAAS,CAClB,CAAC;AACN,CAAC,EAvBgB,kBAAkB,kCAAlB,kBAAkB,QAuBlC"}
|
|
@@ -7,20 +7,14 @@ class MetadataObjectType {
|
|
|
7
7
|
validated;
|
|
8
8
|
recursive;
|
|
9
9
|
nullables = [];
|
|
10
|
-
/**
|
|
11
|
-
* @internal
|
|
12
|
-
*/
|
|
10
|
+
/** @internal */
|
|
13
11
|
tagged_ = false;
|
|
14
|
-
/**
|
|
15
|
-
* @internal
|
|
16
|
-
*/
|
|
12
|
+
/** @internal */
|
|
17
13
|
literal_;
|
|
18
14
|
/* -----------------------------------------------------------
|
|
19
15
|
CONSTRUCTORS
|
|
20
16
|
----------------------------------------------------------- */
|
|
21
|
-
/**
|
|
22
|
-
* @hidden
|
|
23
|
-
*/
|
|
17
|
+
/** @ignore */
|
|
24
18
|
constructor(props) {
|
|
25
19
|
this.name = props.name;
|
|
26
20
|
this.properties = props.properties;
|
|
@@ -32,15 +26,11 @@ class MetadataObjectType {
|
|
|
32
26
|
this.nullables = props.nullables.slice();
|
|
33
27
|
this.tagged_ = false;
|
|
34
28
|
}
|
|
35
|
-
/**
|
|
36
|
-
* @internal
|
|
37
|
-
*/
|
|
29
|
+
/** @internal */
|
|
38
30
|
static create(props) {
|
|
39
31
|
return new MetadataObjectType(props);
|
|
40
32
|
}
|
|
41
|
-
/**
|
|
42
|
-
* @internal
|
|
43
|
-
*/
|
|
33
|
+
/** @internal */
|
|
44
34
|
static _From_without_properties(obj) {
|
|
45
35
|
return MetadataObjectType.create({
|
|
46
36
|
name: obj.name,
|
|
@@ -88,9 +78,7 @@ class MetadataObjectType {
|
|
|
88
78
|
};
|
|
89
79
|
}
|
|
90
80
|
}
|
|
91
|
-
/**
|
|
92
|
-
* @internal
|
|
93
|
-
*/
|
|
81
|
+
/** @internal */
|
|
94
82
|
(function (MetadataObjectType) {
|
|
95
83
|
MetadataObjectType.intersects = (x, y) => x.properties.some((prop) => y.properties.find((oppo) => prop.key.getName() === oppo.key.getName()) !== undefined);
|
|
96
84
|
MetadataObjectType.covers = (x, y) => x.properties.length >= y.properties.length &&
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"MetadataParameter.js","sourceRoot":"","sources":["../../../src/schemas/metadata/MetadataParameter.ts"],"names":[],"mappings":";;;AAOA,yCAAsC;AAEtC,MAAa,iBAAiB;IAO5B,YAAoB,KAAyC;QAC3D,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QACvB,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QACvB,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACrC,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;QACjC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;IAC7B,CAAC;IAED
|
|
1
|
+
{"version":3,"file":"MetadataParameter.js","sourceRoot":"","sources":["../../../src/schemas/metadata/MetadataParameter.ts"],"names":[],"mappings":";;;AAOA,yCAAsC;AAEtC,MAAa,iBAAiB;IAO5B,YAAoB,KAAyC;QAC3D,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QACvB,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QACvB,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACrC,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;QACjC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;IAC7B,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,MAAM,CAClB,KAAyC;QAEzC,OAAO,IAAI,iBAAiB,CAAC,KAAK,CAAC,CAAC;IACtC,CAAC;IAEM,MAAM,CAAC,IAAI,CAChB,IAAwB,EACxB,IAAyB;QAEzB,OAAO,iBAAiB,CAAC,MAAM,CAAC;YAC9B,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,IAAI,EAAE,mBAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC;YACpC,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,SAAS,EAAE,IAAI,CAAC,SAAS;SAC1B,CAAC,CAAC;IACL,CAAC;IAEM,MAAM;QACX,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YACxB,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,SAAS,EAAE,IAAI,CAAC,SAAS;SAC1B,CAAC;IACJ,CAAC;CACF;AA1CD,8CA0CC"}
|
|
@@ -8,9 +8,7 @@ export declare class MetadataProperty {
|
|
|
8
8
|
readonly description: string | null;
|
|
9
9
|
readonly jsDocTags: IJsDocTagInfo[];
|
|
10
10
|
of_protobuf_?: IProtobufProperty;
|
|
11
|
-
/**
|
|
12
|
-
* @hidden
|
|
13
|
-
*/
|
|
11
|
+
/** @ignore */
|
|
14
12
|
private constructor();
|
|
15
13
|
toJSON(): IMetadataProperty;
|
|
16
14
|
}
|
|
@@ -8,9 +8,7 @@ export declare class MetadataProperty {
|
|
|
8
8
|
readonly description: string | null;
|
|
9
9
|
readonly jsDocTags: IJsDocTagInfo[];
|
|
10
10
|
of_protobuf_?: IProtobufProperty;
|
|
11
|
-
/**
|
|
12
|
-
* @hidden
|
|
13
|
-
*/
|
|
11
|
+
/** @ignore */
|
|
14
12
|
private constructor();
|
|
15
13
|
toJSON(): IMetadataProperty;
|
|
16
14
|
}
|
|
@@ -6,24 +6,18 @@ class MetadataProperty {
|
|
|
6
6
|
/* -----------------------------------------------------------
|
|
7
7
|
CONSTRUCTORS
|
|
8
8
|
----------------------------------------------------------- */
|
|
9
|
-
/**
|
|
10
|
-
* @hidden
|
|
11
|
-
*/
|
|
9
|
+
/** @ignore */
|
|
12
10
|
constructor(props) {
|
|
13
11
|
this.key = props.key;
|
|
14
12
|
this.value = props.value;
|
|
15
13
|
this.description = props.description;
|
|
16
14
|
this.jsDocTags = props.jsDocTags;
|
|
17
15
|
}
|
|
18
|
-
/**
|
|
19
|
-
* @internal
|
|
20
|
-
*/
|
|
16
|
+
/** @internal */
|
|
21
17
|
static create(props) {
|
|
22
18
|
return new MetadataProperty(props);
|
|
23
19
|
}
|
|
24
|
-
/**
|
|
25
|
-
* @internal
|
|
26
|
-
*/
|
|
20
|
+
/** @internal */
|
|
27
21
|
static from(property, dict) {
|
|
28
22
|
return MetadataProperty.create({
|
|
29
23
|
key: Metadata_1.Metadata.from(property.key, dict),
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"MetadataProperty.js","sourceRoot":"","sources":["../../../src/schemas/metadata/MetadataProperty.ts"],"names":[],"mappings":";;;AAMA,yCAAsC;AAEtC,MAAa,gBAAgB;IAQ3B;;oEAEgE;IAChE
|
|
1
|
+
{"version":3,"file":"MetadataProperty.js","sourceRoot":"","sources":["../../../src/schemas/metadata/MetadataProperty.ts"],"names":[],"mappings":";;;AAMA,yCAAsC;AAEtC,MAAa,gBAAgB;IAQ3B;;oEAEgE;IAChE,cAAc;IACd,YAAoB,KAAwC;QAC1D,IAAI,CAAC,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC;QACrB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;QACzB,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACrC,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;IACnC,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,MAAM,CAClB,KAAwC;QAExC,OAAO,IAAI,gBAAgB,CAAC,KAAK,CAAC,CAAC;IACrC,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,IAAI,CAAC,QAA2B,EAAE,IAAyB;QACvE,OAAO,gBAAgB,CAAC,MAAM,CAAC;YAC7B,GAAG,EAAE,mBAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC;YACtC,KAAK,EAAE,mBAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC;YAC1C,WAAW,EAAE,QAAQ,CAAC,WAAW;YACjC,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,KAAK,EAAE;SACtC,CAAC,CAAC;IACL,CAAC;IAEM,MAAM;QACX,OAAO;YACL,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE;YACtB,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE;YAC1B,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,SAAS,EAAE,IAAI,CAAC,SAAS;SAC1B,CAAC;IACJ,CAAC;CACF;AA5CD,4CA4CC"}
|
|
@@ -9,24 +9,18 @@ class MetadataProperty {
|
|
|
9
9
|
/* -----------------------------------------------------------
|
|
10
10
|
CONSTRUCTORS
|
|
11
11
|
----------------------------------------------------------- */
|
|
12
|
-
/**
|
|
13
|
-
* @hidden
|
|
14
|
-
*/
|
|
12
|
+
/** @ignore */
|
|
15
13
|
constructor(props) {
|
|
16
14
|
this.key = props.key;
|
|
17
15
|
this.value = props.value;
|
|
18
16
|
this.description = props.description;
|
|
19
17
|
this.jsDocTags = props.jsDocTags;
|
|
20
18
|
}
|
|
21
|
-
/**
|
|
22
|
-
* @internal
|
|
23
|
-
*/
|
|
19
|
+
/** @internal */
|
|
24
20
|
static create(props) {
|
|
25
21
|
return new MetadataProperty(props);
|
|
26
22
|
}
|
|
27
|
-
/**
|
|
28
|
-
* @internal
|
|
29
|
-
*/
|
|
23
|
+
/** @internal */
|
|
30
24
|
static from(property, dict) {
|
|
31
25
|
return MetadataProperty.create({
|
|
32
26
|
key: Metadata.from(property.key, dict),
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"MetadataTemplate.js","sourceRoot":"","sources":["../../../src/schemas/metadata/MetadataTemplate.ts"],"names":[],"mappings":";;;AAKA,yCAAsC;AAEtC,MAAa,gBAAgB;IAM3B,YAAoB,KAAwC;QAC1D,IAAI,CAAC,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,mBAAQ,CAAC,MAAM,CAAC,CAAC;QAC1C,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;IACzB,CAAC;IAEM,MAAM,CAAC,MAAM,CAClB,KAAwC;QAExC,OAAO,IAAI,gBAAgB,CAAC,KAAK,CAAC,CAAC;IACrC,CAAC;IAEM,MAAM,CAAC,IAAI,CAChB,IAAuB,EACvB,IAAyB;QAEzB,OAAO,IAAI,gBAAgB,CAAC;YAC1B,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,mBAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;YAChD,IAAI,EAAE,IAAI,CAAC,IAAI;SAChB,CAAC,CAAC;IACL,CAAC;IAEM,OAAO;;QACZ,OAAO,OAAC,IAAI,CAAC,KAAK,oCAAV,IAAI,CAAC,KAAK,GAAK,OAAO,CAAC,IAAI,CAAC,EAAC,CAAC;IACxC,CAAC;IAED
|
|
1
|
+
{"version":3,"file":"MetadataTemplate.js","sourceRoot":"","sources":["../../../src/schemas/metadata/MetadataTemplate.ts"],"names":[],"mappings":";;;AAKA,yCAAsC;AAEtC,MAAa,gBAAgB;IAM3B,YAAoB,KAAwC;QAC1D,IAAI,CAAC,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,mBAAQ,CAAC,MAAM,CAAC,CAAC;QAC1C,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;IACzB,CAAC;IAEM,MAAM,CAAC,MAAM,CAClB,KAAwC;QAExC,OAAO,IAAI,gBAAgB,CAAC,KAAK,CAAC,CAAC;IACrC,CAAC;IAEM,MAAM,CAAC,IAAI,CAChB,IAAuB,EACvB,IAAyB;QAEzB,OAAO,IAAI,gBAAgB,CAAC;YAC1B,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,mBAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;YAChD,IAAI,EAAE,IAAI,CAAC,IAAI;SAChB,CAAC,CAAC;IACL,CAAC;IAEM,OAAO;;QACZ,OAAO,OAAC,IAAI,CAAC,KAAK,oCAAV,IAAI,CAAC,KAAK,GAAK,OAAO,CAAC,IAAI,CAAC,EAAC,CAAC;IACxC,CAAC;IAED,gBAAgB;IACT,WAAW;QAChB,OAAO,CACL,GAAG;YACH,IAAI,CAAC,GAAG;iBACL,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CACb,KAAK,CAAC,UAAU,EAAE,IAAI,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC;gBACtC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAE,CAAC,MAAM,CAAC,CAAC,CAAE,CAAC,KAAK;gBACtC,CAAC,CAAC,MAAM,KAAK,CAAC,OAAO,EAAE,IAAI,CAC9B;iBACA,IAAI,CAAC,EAAE,CAAC;iBACR,KAAK,CAAC,GAAG,CAAC;iBACV,IAAI,CAAC,KAAK,CAAC;YACd,GAAG,CACJ,CAAC;IACJ,CAAC;IAEM,MAAM;QACX,OAAO;YACL,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;YACpC,IAAI,EAAE,IAAI,CAAC,IAAI;SAChB,CAAC;IACJ,CAAC;CACF;AAtDD,4CAsDC;AAED,MAAM,OAAO,GAAG,CAAC,QAA0B,EAAU,EAAE;;IACrD,MAAM,IAAI,GAAW,QAAQ,CAAC,WAAW,EAAE,CAAC;IAC5C,IAAI,CAAC,CAAA,MAAA,QAAQ,CAAC,IAAI,0CAAE,MAAM,CAAA;QAAE,OAAO,IAAI,CAAC;SACnC,IAAI,QAAQ,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACpC,MAAM,GAAG,GAAW,CAAC,IAAI,EAAE,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CACtE,KAAK,CACN,CAAC;QACF,OAAO,IAAI,GAAG,GAAG,CAAC;IACpB,CAAC;IACD,MAAM,IAAI,GAAa,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QAC/C,MAAM,GAAG,GAAW,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACvD,OAAO,GAAG,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,GAAG,GAAG,CAAC;IAC7C,CAAC,CAAC,CAAC;IACH,OAAO,IAAI,IAAI,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;AAC7C,CAAC,CAAC"}
|
|
@@ -4,9 +4,7 @@ import { MetadataTupleType } from "./MetadataTupleType";
|
|
|
4
4
|
export declare class MetadataTuple {
|
|
5
5
|
readonly type: MetadataTupleType;
|
|
6
6
|
readonly tags: IMetadataTypeTag[][];
|
|
7
|
-
/**
|
|
8
|
-
* @hidden
|
|
9
|
-
*/
|
|
7
|
+
/** @ignore */
|
|
10
8
|
private constructor();
|
|
11
9
|
toJSON(): IMetadataTuple;
|
|
12
10
|
}
|
|
@@ -4,9 +4,7 @@ import { MetadataTupleType } from "./MetadataTupleType";
|
|
|
4
4
|
export declare class MetadataTuple {
|
|
5
5
|
readonly type: MetadataTupleType;
|
|
6
6
|
readonly tags: IMetadataTypeTag[][];
|
|
7
|
-
/**
|
|
8
|
-
* @hidden
|
|
9
|
-
*/
|
|
7
|
+
/** @ignore */
|
|
10
8
|
private constructor();
|
|
11
9
|
toJSON(): IMetadataTuple;
|
|
12
10
|
}
|
|
@@ -2,16 +2,12 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.MetadataTuple = void 0;
|
|
4
4
|
class MetadataTuple {
|
|
5
|
-
/**
|
|
6
|
-
* @hidden
|
|
7
|
-
*/
|
|
5
|
+
/** @ignore */
|
|
8
6
|
constructor(props) {
|
|
9
7
|
this.type = props.type;
|
|
10
8
|
this.tags = props.tags;
|
|
11
9
|
}
|
|
12
|
-
/**
|
|
13
|
-
* @internal
|
|
14
|
-
*/
|
|
10
|
+
/** @internal */
|
|
15
11
|
static create(props) {
|
|
16
12
|
return new MetadataTuple(props);
|
|
17
13
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"MetadataTuple.js","sourceRoot":"","sources":["../../../src/schemas/metadata/MetadataTuple.ts"],"names":[],"mappings":";;;AAMA,MAAa,aAAa;IAIxB
|
|
1
|
+
{"version":3,"file":"MetadataTuple.js","sourceRoot":"","sources":["../../../src/schemas/metadata/MetadataTuple.ts"],"names":[],"mappings":";;;AAMA,MAAa,aAAa;IAIxB,cAAc;IACd,YAAoB,KAAqC;QACvD,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QACvB,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;IACzB,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,MAAM,CAAC,KAAqC;QACxD,OAAO,IAAI,aAAa,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC;IAEM,MAAM;QACX,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI;YACpB,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC;SAC1C,CAAC;IACJ,CAAC;CACF;AArBD,sCAqBC"}
|
|
@@ -1,16 +1,12 @@
|
|
|
1
1
|
class MetadataTuple {
|
|
2
2
|
type;
|
|
3
3
|
tags;
|
|
4
|
-
/**
|
|
5
|
-
* @hidden
|
|
6
|
-
*/
|
|
4
|
+
/** @ignore */
|
|
7
5
|
constructor(props) {
|
|
8
6
|
this.type = props.type;
|
|
9
7
|
this.tags = props.tags;
|
|
10
8
|
}
|
|
11
|
-
/**
|
|
12
|
-
* @internal
|
|
13
|
-
*/
|
|
9
|
+
/** @internal */
|
|
14
10
|
static create(props) {
|
|
15
11
|
return new MetadataTuple(props);
|
|
16
12
|
}
|
|
@@ -2,9 +2,7 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.MetadataTupleType = void 0;
|
|
4
4
|
class MetadataTupleType {
|
|
5
|
-
/**
|
|
6
|
-
* @internal
|
|
7
|
-
*/
|
|
5
|
+
/** @internal */
|
|
8
6
|
constructor(props) {
|
|
9
7
|
this.name = props.name;
|
|
10
8
|
this.elements = props.elements;
|
|
@@ -12,9 +10,7 @@ class MetadataTupleType {
|
|
|
12
10
|
this.recursive = props.recursive;
|
|
13
11
|
this.nullables = props.nullables;
|
|
14
12
|
}
|
|
15
|
-
/**
|
|
16
|
-
* @internal
|
|
17
|
-
*/
|
|
13
|
+
/** @internal */
|
|
18
14
|
static _From_without_elements(props) {
|
|
19
15
|
return MetadataTupleType.create({
|
|
20
16
|
name: props.name,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"MetadataTupleType.js","sourceRoot":"","sources":["../../../src/schemas/metadata/MetadataTupleType.ts"],"names":[],"mappings":";;;AAKA,MAAa,iBAAiB;
|
|
1
|
+
{"version":3,"file":"MetadataTupleType.js","sourceRoot":"","sources":["../../../src/schemas/metadata/MetadataTupleType.ts"],"names":[],"mappings":";;;AAKA,MAAa,iBAAiB;IAW5B,gBAAgB;IAChB,YAAoB,KAAyC;QAC3D,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QACvB,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;QAC/B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;QACzB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;QACjC,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;IACnC,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,sBAAsB,CAClC,KAA2C;QAE3C,OAAO,iBAAiB,CAAC,MAAM,CAAC;YAC9B,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,KAAK,EAAE,KAAK,CAAC,KAAK;YAClB,QAAQ,EAAE,IAAK;YACf,SAAS,EAAE,KAAK,CAAC,SAAS;YAC1B,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC,KAAK,EAAE;SACnC,CAAC,CAAC;IACL,CAAC;IAEM,MAAM,CAAC,MAAM,CAClB,KAAyC;QAEzC,OAAO,IAAI,iBAAiB,CAAC,KAAK,CAAC,CAAC;IACtC,CAAC;IAEM,MAAM;QACX,OAAO,CACL,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC;YACxB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAE,CAAC,IAAI,KAAK,IAAI,CACvD,CAAC;IACJ,CAAC;IAEM,MAAM;QACX,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACpD,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE;SAClC,CAAC;IACJ,CAAC;CACF;AAvDD,8CAuDC"}
|
|
@@ -4,13 +4,9 @@ class MetadataTupleType {
|
|
|
4
4
|
index;
|
|
5
5
|
recursive;
|
|
6
6
|
nullables;
|
|
7
|
-
/**
|
|
8
|
-
* @internal
|
|
9
|
-
*/
|
|
7
|
+
/** @internal */
|
|
10
8
|
of_map;
|
|
11
|
-
/**
|
|
12
|
-
* @internal
|
|
13
|
-
*/
|
|
9
|
+
/** @internal */
|
|
14
10
|
constructor(props) {
|
|
15
11
|
this.name = props.name;
|
|
16
12
|
this.elements = props.elements;
|
|
@@ -18,9 +14,7 @@ class MetadataTupleType {
|
|
|
18
14
|
this.recursive = props.recursive;
|
|
19
15
|
this.nullables = props.nullables;
|
|
20
16
|
}
|
|
21
|
-
/**
|
|
22
|
-
* @internal
|
|
23
|
-
*/
|
|
17
|
+
/** @internal */
|
|
24
18
|
static _From_without_elements(props) {
|
|
25
19
|
return MetadataTupleType.create({
|
|
26
20
|
name: props.name,
|
package/lib/tags/Constant.d.mts
CHANGED
|
@@ -1,4 +1,36 @@
|
|
|
1
1
|
import { TagBase } from "./TagBase";
|
|
2
|
+
/**
|
|
3
|
+
* Constant tag that adds title and description metadata to literal types.
|
|
4
|
+
*
|
|
5
|
+
* This tag enhances literal values with human-readable documentation without
|
|
6
|
+
* changing their runtime type. It's particularly useful for enum-like values
|
|
7
|
+
* where you want to provide context about what each value represents.
|
|
8
|
+
*
|
|
9
|
+
* The metadata appears in generated JSON Schema, making API documentation more
|
|
10
|
+
* descriptive and helping developers understand the meaning of specific
|
|
11
|
+
* constant values.
|
|
12
|
+
*
|
|
13
|
+
* @author Jeongho Nam - https://github.com/samchon
|
|
14
|
+
* @example
|
|
15
|
+
* ```typescript
|
|
16
|
+
* type Status =
|
|
17
|
+
* | Constant<"active", { title: "Active", description: "User is currently active" }>
|
|
18
|
+
* | Constant<"inactive", { title: "Inactive", description: "User account is disabled" }>
|
|
19
|
+
* | Constant<"pending", { title: "Pending", description: "Awaiting verification" }>;
|
|
20
|
+
* ```;
|
|
21
|
+
*
|
|
22
|
+
* @example
|
|
23
|
+
* ```typescript
|
|
24
|
+
* interface Config {
|
|
25
|
+
* debugLevel: Constant<0, { title: "Off", description: "No debug output" }>
|
|
26
|
+
* | Constant<1, { title: "Basic", description: "Basic logging" }>
|
|
27
|
+
* | Constant<2, { title: "Verbose", description: "Detailed debug info" }>;
|
|
28
|
+
* }
|
|
29
|
+
* ```;
|
|
30
|
+
*
|
|
31
|
+
* @template Value The literal value (boolean, number, string, or bigint)
|
|
32
|
+
* @template Content Metadata with optional title and description
|
|
33
|
+
*/
|
|
2
34
|
export type Constant<Value extends boolean | number | string | bigint, Content extends {
|
|
3
35
|
title?: string | undefined;
|
|
4
36
|
description?: string | undefined;
|
package/lib/tags/Constant.d.ts
CHANGED
|
@@ -1,4 +1,36 @@
|
|
|
1
1
|
import { TagBase } from "./TagBase";
|
|
2
|
+
/**
|
|
3
|
+
* Constant tag that adds title and description metadata to literal types.
|
|
4
|
+
*
|
|
5
|
+
* This tag enhances literal values with human-readable documentation without
|
|
6
|
+
* changing their runtime type. It's particularly useful for enum-like values
|
|
7
|
+
* where you want to provide context about what each value represents.
|
|
8
|
+
*
|
|
9
|
+
* The metadata appears in generated JSON Schema, making API documentation more
|
|
10
|
+
* descriptive and helping developers understand the meaning of specific
|
|
11
|
+
* constant values.
|
|
12
|
+
*
|
|
13
|
+
* @author Jeongho Nam - https://github.com/samchon
|
|
14
|
+
* @example
|
|
15
|
+
* ```typescript
|
|
16
|
+
* type Status =
|
|
17
|
+
* | Constant<"active", { title: "Active", description: "User is currently active" }>
|
|
18
|
+
* | Constant<"inactive", { title: "Inactive", description: "User account is disabled" }>
|
|
19
|
+
* | Constant<"pending", { title: "Pending", description: "Awaiting verification" }>;
|
|
20
|
+
* ```;
|
|
21
|
+
*
|
|
22
|
+
* @example
|
|
23
|
+
* ```typescript
|
|
24
|
+
* interface Config {
|
|
25
|
+
* debugLevel: Constant<0, { title: "Off", description: "No debug output" }>
|
|
26
|
+
* | Constant<1, { title: "Basic", description: "Basic logging" }>
|
|
27
|
+
* | Constant<2, { title: "Verbose", description: "Detailed debug info" }>;
|
|
28
|
+
* }
|
|
29
|
+
* ```;
|
|
30
|
+
*
|
|
31
|
+
* @template Value The literal value (boolean, number, string, or bigint)
|
|
32
|
+
* @template Content Metadata with optional title and description
|
|
33
|
+
*/
|
|
2
34
|
export type Constant<Value extends boolean | number | string | bigint, Content extends {
|
|
3
35
|
title?: string | undefined;
|
|
4
36
|
description?: string | undefined;
|
|
@@ -1,4 +1,21 @@
|
|
|
1
1
|
import { TagBase } from "./TagBase";
|
|
2
|
+
/**
|
|
3
|
+
* String content media type constraint tag.
|
|
4
|
+
*
|
|
5
|
+
* Specifies the MIME type of string content for proper interpretation. This tag
|
|
6
|
+
* serves as metadata to indicate how the string content should be interpreted,
|
|
7
|
+
* but does not perform validation on the content itself.
|
|
8
|
+
*
|
|
9
|
+
* Examples: type JsonData = string & ContentMediaType<"application/json">; //
|
|
10
|
+
* JSON string type Base64Image = string & ContentMediaType<"image/png">; //
|
|
11
|
+
* Base64 PNG type XmlContent = string & ContentMediaType<"application/xml">; //
|
|
12
|
+
* XML data
|
|
13
|
+
*
|
|
14
|
+
* Common MIME types: application/json, text/html, image/jpeg, image/png,
|
|
15
|
+
* application/pdf, text/plain, application/xml, and many more.
|
|
16
|
+
*
|
|
17
|
+
* @author Jeongho Nam - https://github.com/samchon
|
|
18
|
+
*/
|
|
2
19
|
export type ContentMediaType<Value extends string> = TagBase<{
|
|
3
20
|
target: "string";
|
|
4
21
|
kind: "contentMediaType";
|
|
@@ -1,4 +1,21 @@
|
|
|
1
1
|
import { TagBase } from "./TagBase";
|
|
2
|
+
/**
|
|
3
|
+
* String content media type constraint tag.
|
|
4
|
+
*
|
|
5
|
+
* Specifies the MIME type of string content for proper interpretation. This tag
|
|
6
|
+
* serves as metadata to indicate how the string content should be interpreted,
|
|
7
|
+
* but does not perform validation on the content itself.
|
|
8
|
+
*
|
|
9
|
+
* Examples: type JsonData = string & ContentMediaType<"application/json">; //
|
|
10
|
+
* JSON string type Base64Image = string & ContentMediaType<"image/png">; //
|
|
11
|
+
* Base64 PNG type XmlContent = string & ContentMediaType<"application/xml">; //
|
|
12
|
+
* XML data
|
|
13
|
+
*
|
|
14
|
+
* Common MIME types: application/json, text/html, image/jpeg, image/png,
|
|
15
|
+
* application/pdf, text/plain, application/xml, and many more.
|
|
16
|
+
*
|
|
17
|
+
* @author Jeongho Nam - https://github.com/samchon
|
|
18
|
+
*/
|
|
2
19
|
export type ContentMediaType<Value extends string> = TagBase<{
|
|
3
20
|
target: "string";
|
|
4
21
|
kind: "contentMediaType";
|
package/lib/tags/Default.d.mts
CHANGED
|
@@ -1,4 +1,34 @@
|
|
|
1
1
|
import { TagBase } from "./TagBase";
|
|
2
|
+
/**
|
|
3
|
+
* Default value tag that specifies a default value for properties.
|
|
4
|
+
*
|
|
5
|
+
* When a property is not provided during validation, this tag instructs typia
|
|
6
|
+
* to use the specified default value. This is useful for optional properties
|
|
7
|
+
* that should have a specific fallback value.
|
|
8
|
+
*
|
|
9
|
+
* Supported types: boolean, bigint, number, and string primitives. Note:
|
|
10
|
+
* Default values are applied during validation, not at compile time.
|
|
11
|
+
*
|
|
12
|
+
* @author Jeongho Nam - https://github.com/samchon
|
|
13
|
+
* @example
|
|
14
|
+
* ```typescript
|
|
15
|
+
* interface User {
|
|
16
|
+
* name: string;
|
|
17
|
+
* active: boolean & Default<true>; // defaults to true if not provided
|
|
18
|
+
* retries: number & Default<3>; // defaults to 3 if not provided
|
|
19
|
+
* }
|
|
20
|
+
* ```;
|
|
21
|
+
*
|
|
22
|
+
* @example
|
|
23
|
+
* ```typescript
|
|
24
|
+
* interface Config {
|
|
25
|
+
* timeout: bigint & Default<5000n>; // defaults to 5000n
|
|
26
|
+
* prefix: string & Default<"user_">; // defaults to "user_"
|
|
27
|
+
* }
|
|
28
|
+
* ```;
|
|
29
|
+
*
|
|
30
|
+
* @template Value The default value (boolean, bigint, number, or string)
|
|
31
|
+
*/
|
|
2
32
|
export type Default<Value extends boolean | bigint | number | string> = TagBase<{
|
|
3
33
|
target: Value extends boolean ? "boolean" : Value extends bigint ? "bigint" : Value extends number ? "number" : "string";
|
|
4
34
|
kind: "default";
|
package/lib/tags/Default.d.ts
CHANGED
|
@@ -1,4 +1,34 @@
|
|
|
1
1
|
import { TagBase } from "./TagBase";
|
|
2
|
+
/**
|
|
3
|
+
* Default value tag that specifies a default value for properties.
|
|
4
|
+
*
|
|
5
|
+
* When a property is not provided during validation, this tag instructs typia
|
|
6
|
+
* to use the specified default value. This is useful for optional properties
|
|
7
|
+
* that should have a specific fallback value.
|
|
8
|
+
*
|
|
9
|
+
* Supported types: boolean, bigint, number, and string primitives. Note:
|
|
10
|
+
* Default values are applied during validation, not at compile time.
|
|
11
|
+
*
|
|
12
|
+
* @author Jeongho Nam - https://github.com/samchon
|
|
13
|
+
* @example
|
|
14
|
+
* ```typescript
|
|
15
|
+
* interface User {
|
|
16
|
+
* name: string;
|
|
17
|
+
* active: boolean & Default<true>; // defaults to true if not provided
|
|
18
|
+
* retries: number & Default<3>; // defaults to 3 if not provided
|
|
19
|
+
* }
|
|
20
|
+
* ```;
|
|
21
|
+
*
|
|
22
|
+
* @example
|
|
23
|
+
* ```typescript
|
|
24
|
+
* interface Config {
|
|
25
|
+
* timeout: bigint & Default<5000n>; // defaults to 5000n
|
|
26
|
+
* prefix: string & Default<"user_">; // defaults to "user_"
|
|
27
|
+
* }
|
|
28
|
+
* ```;
|
|
29
|
+
*
|
|
30
|
+
* @template Value The default value (boolean, bigint, number, or string)
|
|
31
|
+
*/
|
|
2
32
|
export type Default<Value extends boolean | bigint | number | string> = TagBase<{
|
|
3
33
|
target: Value extends boolean ? "boolean" : Value extends bigint ? "bigint" : Value extends number ? "number" : "string";
|
|
4
34
|
kind: "default";
|
package/lib/tags/Example.d.mts
CHANGED
|
@@ -1,4 +1,36 @@
|
|
|
1
1
|
import { TagBase } from "./TagBase";
|
|
2
|
+
/**
|
|
3
|
+
* Example value tag that provides a single example value for documentation.
|
|
4
|
+
*
|
|
5
|
+
* This tag adds an example value to your JSON Schema, which is useful for API
|
|
6
|
+
* documentation, client code generation, and helping developers understand
|
|
7
|
+
* expected data formats. The example doesn't affect runtime validation.
|
|
8
|
+
*
|
|
9
|
+
* Use Example for a single representative value. For multiple named examples,
|
|
10
|
+
* use the Examples tag instead.
|
|
11
|
+
*
|
|
12
|
+
* @author Jeongho Nam - https://github.com/samchon
|
|
13
|
+
* @example
|
|
14
|
+
* ```typescript
|
|
15
|
+
* interface Product {
|
|
16
|
+
* name: string & Example<"iPhone 15 Pro">;
|
|
17
|
+
* price: number & Example<999.99>;
|
|
18
|
+
* inStock: boolean & Example<true>;
|
|
19
|
+
* }
|
|
20
|
+
* ```;
|
|
21
|
+
*
|
|
22
|
+
* @example
|
|
23
|
+
* ```typescript
|
|
24
|
+
* interface User {
|
|
25
|
+
* profile: {
|
|
26
|
+
* bio: string;
|
|
27
|
+
* tags: string[];
|
|
28
|
+
* } & Example<{ bio: "Software engineer", tags: ["typescript", "react"] }>;
|
|
29
|
+
* }
|
|
30
|
+
* ```;
|
|
31
|
+
*
|
|
32
|
+
* @template Value The example value (primitives, objects, arrays, or null)
|
|
33
|
+
*/
|
|
2
34
|
export type Example<Value extends boolean | bigint | number | string | object | Array<unknown> | null> = TagBase<{
|
|
3
35
|
target: "boolean" | "bigint" | "number" | "string" | "array" | "object";
|
|
4
36
|
kind: "example";
|
package/lib/tags/Example.d.ts
CHANGED
|
@@ -1,4 +1,36 @@
|
|
|
1
1
|
import { TagBase } from "./TagBase";
|
|
2
|
+
/**
|
|
3
|
+
* Example value tag that provides a single example value for documentation.
|
|
4
|
+
*
|
|
5
|
+
* This tag adds an example value to your JSON Schema, which is useful for API
|
|
6
|
+
* documentation, client code generation, and helping developers understand
|
|
7
|
+
* expected data formats. The example doesn't affect runtime validation.
|
|
8
|
+
*
|
|
9
|
+
* Use Example for a single representative value. For multiple named examples,
|
|
10
|
+
* use the Examples tag instead.
|
|
11
|
+
*
|
|
12
|
+
* @author Jeongho Nam - https://github.com/samchon
|
|
13
|
+
* @example
|
|
14
|
+
* ```typescript
|
|
15
|
+
* interface Product {
|
|
16
|
+
* name: string & Example<"iPhone 15 Pro">;
|
|
17
|
+
* price: number & Example<999.99>;
|
|
18
|
+
* inStock: boolean & Example<true>;
|
|
19
|
+
* }
|
|
20
|
+
* ```;
|
|
21
|
+
*
|
|
22
|
+
* @example
|
|
23
|
+
* ```typescript
|
|
24
|
+
* interface User {
|
|
25
|
+
* profile: {
|
|
26
|
+
* bio: string;
|
|
27
|
+
* tags: string[];
|
|
28
|
+
* } & Example<{ bio: "Software engineer", tags: ["typescript", "react"] }>;
|
|
29
|
+
* }
|
|
30
|
+
* ```;
|
|
31
|
+
*
|
|
32
|
+
* @template Value The example value (primitives, objects, arrays, or null)
|
|
33
|
+
*/
|
|
2
34
|
export type Example<Value extends boolean | bigint | number | string | object | Array<unknown> | null> = TagBase<{
|
|
3
35
|
target: "boolean" | "bigint" | "number" | "string" | "array" | "object";
|
|
4
36
|
kind: "example";
|