@typespec/json-schema 0.68.0-dev.3 → 0.68.0-dev.4

package/README.md

@@ -131,7 +131,7 @@ Set the base URI for any schemas emitted from types within this namespace.
 
 | Name    | Type             | Description                                                              |
 | ------- | ---------------- | ------------------------------------------------------------------------ |
-| baseUri | `valueof string` | the base URI. Schema IDs inside this namespace are relative to this URI. |
+| baseUri | `valueof string` | The base URI. Schema IDs inside this namespace are relative to this URI. |
 
 #### `@contains`
 
@@ -186,7 +186,7 @@ Specify the content type of content stored in a string.
 
 | Name  | Type             | Description                           |
 | ----- | ---------------- | ------------------------------------- |
-| value | `valueof string` | the media type of the string contents |
+| value | `valueof string` | The media type of the string contents |
 
 #### `@contentSchema`
 
@@ -205,11 +205,11 @@ media type and encoding.
 
 | Name  | Type      | Description                       |
 | ----- | --------- | --------------------------------- |
-| value | `unknown` | the schema of the string contents |
+| value | `unknown` | The schema of the string contents |
 
 #### `@extension`
 
-Specify a custom property to add to the emitted schema. Useful for adding custom keywords
+Specify a custom property to add to the emitted schema. This is useful for adding custom keywords
 and other vendor-specific extensions. Scalar values need to be specified using `typeof` to be converted to a schema.
 
 For example, `@extension("x-schema", typeof "foo")` will emit a JSON schema value for `x-schema`,
@@ -217,9 +217,9 @@ whereas `@extension("x-schema", "foo")` will emit the raw code `"foo"`.
 
 The value will be treated as a raw value if any of the following are true:
 
-1. The value is a scalar value (e.g. string, number, boolean, etc.)
-2. The value is wrapped in the `Json<Data>` template
-3. The value is provided using the value syntax (e.g. `#{}`, `#[]`)
+- The value is a scalar value (e.g. string, number, boolean, etc.)
+- The value is wrapped in the `Json<Data>` template
+- The value is provided using the value syntax (e.g. `#{}`, `#[]`)
 
 For example, `@extension("x-schema", { x: "value" })` will emit a JSON schema value for `x-schema`,
 whereas `@extension("x-schema", #{x: "value"})` and `@extension("x-schema", Json<{x: "value"}>)`
@@ -237,8 +237,8 @@ will emit the raw JSON code `{x: "value"}`.
 
 | Name  | Type                           | Description                                                   |
 | ----- | ------------------------------ | ------------------------------------------------------------- |
-| key   | `valueof string`               | the name of the keyword of vendor extension, e.g. `x-custom`. |
-| value | `unknown` \| `valueof unknown` | the value of the keyword.                                     |
+| key   | `valueof string`               | The name of the keyword of vendor extension, e.g. `x-custom`. |
+| value | `unknown` \| `valueof unknown` | The value of the keyword.                                     |
 
 #### `@id`
 
@@ -259,7 +259,7 @@ By default, the id will be constructed based on the declaration's name.
 
 | Name | Type             | Description                                     |
 | ---- | ---------------- | ----------------------------------------------- |
-| id   | `valueof string` | the id of the JSON schema for this declaration. |
+| id   | `valueof string` | The id of the JSON schema for this declaration. |
 
 #### `@jsonSchema`
 
@@ -285,8 +285,8 @@ you can provide the id.
 
 #### `@maxContains`
 
-Specify that the array must contain at most some number of the types provided
-by the contains decorator.
+Used in conjunction with the `@contains` decorator,
+specifies that the array must contain at most a certain number of the types provided by the `@contains` decorator.
 
 ```typespec
 @TypeSpec.JsonSchema.maxContains(value: valueof int32)
@@ -322,8 +322,8 @@ Specify the maximum number of properties this object can have.
 
 #### `@minContains`
 
-Specify that the array must contain at least some number of the types provided
-by the contains decorator.
+Used in conjunction with the `@contains` decorator,
+specifies that the array must contain at least a certain number of the types provided by the `@contains` decorator.
 
 ```typespec
 @TypeSpec.JsonSchema.minContains(value: valueof int32)
@@ -407,7 +407,7 @@ Specify that the target array must begin with the provided types.
 
 | Name  | Type        | Description                                                                 |
 | ----- | ----------- | --------------------------------------------------------------------------- |
-| value | `unknown[]` | a tuple containing the types that must be present at the start of the array |
+| value | `unknown[]` | A tuple containing the types that must be present at the start of the array |
 
 #### `@uniqueItems`
 

package/dist/generated-defs/TypeSpec.JsonSchema.d.ts

@@ -12,7 +12,7 @@ export type JsonSchemaDecorator = (context: DecoratorContext, target: Type, base
 /**
  * Set the base URI for any schemas emitted from types within this namespace.
  *
- * @param baseUri the base URI. Schema IDs inside this namespace are relative to this URI.
+ * @param baseUri The base URI. Schema IDs inside this namespace are relative to this URI.
  */
 export type BaseUriDecorator = (context: DecoratorContext, target: Namespace, baseUri: string) => void;
 /**
@@ -21,7 +21,7 @@ export type BaseUriDecorator = (context: DecoratorContext, target: Namespace, ba
  *
  * By default, the id will be constructed based on the declaration's name.
  *
- * @param id the id of the JSON schema for this declaration.
+ * @param id The id of the JSON schema for this declaration.
  */
 export type IdDecorator = (context: DecoratorContext, target: Type, id: string) => void;
 /**
@@ -42,15 +42,15 @@ export type MultipleOfDecorator = (context: DecoratorContext, target: Scalar | M
  */
 export type ContainsDecorator = (context: DecoratorContext, target: Type | ModelProperty, value: Type) => void;
 /**
- * Specify that the array must contain at least some number of the types provided
- * by the contains decorator.
+ * Used in conjunction with the `@contains` decorator,
+ * specifies that the array must contain at least a certain number of the types provided by the `@contains` decorator.
  *
  * @param value The minimum number of instances the array must contain
  */
 export type MinContainsDecorator = (context: DecoratorContext, target: Type | ModelProperty, value: number) => void;
 /**
- * Specify that the array must contain at most some number of the types provided
- * by the contains decorator.
+ * Used in conjunction with the `@contains` decorator,
+ * specifies that the array must contain at most a certain number of the types provided by the `@contains` decorator.
  *
  * @param value The maximum number of instances the array must contain
  */
@@ -82,40 +82,40 @@ export type ContentEncodingDecorator = (context: DecoratorContext, target: Scala
 /**
  * Specify that the target array must begin with the provided types.
  *
- * @param value a tuple containing the types that must be present at the start of the array
+ * @param value A tuple containing the types that must be present at the start of the array
  */
 export type PrefixItemsDecorator = (context: DecoratorContext, target: Type | ModelProperty, value: Type) => void;
 /**
  * Specify the content type of content stored in a string.
  *
- * @param value the media type of the string contents
+ * @param value The media type of the string contents
  */
 export type ContentMediaTypeDecorator = (context: DecoratorContext, target: Scalar | ModelProperty, value: string) => void;
 /**
  * Specify the schema for the contents of a string when interpreted according to the content's
  * media type and encoding.
  *
- * @param value the schema of the string contents
+ * @param value The schema of the string contents
  */
 export type ContentSchemaDecorator = (context: DecoratorContext, target: Scalar | ModelProperty, value: Type) => void;
 /**
- * Specify a custom property to add to the emitted schema. Useful for adding custom keywords
+ * Specify a custom property to add to the emitted schema. This is useful for adding custom keywords
  * and other vendor-specific extensions. Scalar values need to be specified using `typeof` to be converted to a schema.
  *
  * For example, `@extension("x-schema", typeof "foo")` will emit a JSON schema value for `x-schema`,
  * whereas `@extension("x-schema", "foo")` will emit the raw code `"foo"`.
  *
  * The value will be treated as a raw value if any of the following are true:
- * 1. The value is a scalar value (e.g. string, number, boolean, etc.)
- * 2. The value is wrapped in the `Json<Data>` template
- * 3. The value is provided using the value syntax (e.g. `#{}`, `#[]`)
+ * - The value is a scalar value (e.g. string, number, boolean, etc.)
+ * - The value is wrapped in the `Json<Data>` template
+ * - The value is provided using the value syntax (e.g. `#{}`, `#[]`)
  *
  * For example, `@extension("x-schema", { x: "value" })` will emit a JSON schema value for `x-schema`,
  * whereas `@extension("x-schema", #{x: "value"})` and `@extension("x-schema", Json<{x: "value"}>)`
  * will emit the raw JSON code `{x: "value"}`.
  *
- * @param key the name of the keyword of vendor extension, e.g. `x-custom`.
- * @param value the value of the keyword.
+ * @param key The name of the keyword of vendor extension, e.g. `x-custom`.
+ * @param value The value of the keyword.
  */
 export type ExtensionDecorator = (context: DecoratorContext, target: Type, key: string, value: Type | unknown) => void;
 export type TypeSpecJsonSchemaDecorators = {

package/dist/src/lib.d.ts

@@ -20,14 +20,14 @@ export interface JSONSchemaEmitterOptions {
      */
     "file-type"?: FileType;
     /**
-     * How to handle 64 bit integers on the wire. Options are:
+     * How to handle 64-bit integers on the wire. Options are:
      *
-     * * string: serialize as a string (widely interoperable)
-     * * number: serialize as a number (not widely interoperable)
+     * - string: Serialize as a string (widely interoperable)
+     * - number: Serialize as a number (not widely interoperable)
      */
     "int64-strategy"?: Int64Strategy;
     /**
-     * When provided, bundle all the schemas into a single json schema document
+     * When provided, bundle all the schemas into a single JSON Schema document
      * with schemas under $defs. The provided id is the id of the root document
      * and is also used for the file name.
      */
@@ -38,7 +38,7 @@ export interface JSONSchemaEmitterOptions {
      */
     emitAllModels?: boolean;
     /**
-     * When true, emit all references as json schema files, even if the referenced
+     * When true, emit all references as JSON Schema files, even if the referenced
      * type does not have the `@jsonSchema` decorator or is not within a namespace
      * with the `@jsonSchema` decorator.
      */

package/lib/main.tsp

@@ -16,7 +16,7 @@ extern dec jsonSchema(target: unknown, baseUri?: valueof string);
 /**
  * Set the base URI for any schemas emitted from types within this namespace.
  *
- * @param baseUri the base URI. Schema IDs inside this namespace are relative to this URI.
+ * @param baseUri The base URI. Schema IDs inside this namespace are relative to this URI.
  */
 extern dec baseUri(target: Reflection.Namespace, baseUri: valueof string);
 
@@ -26,7 +26,7 @@ extern dec baseUri(target: Reflection.Namespace, baseUri: valueof string);
  *
  * By default, the id will be constructed based on the declaration's name.
  *
- * @param id the id of the JSON schema for this declaration.
+ * @param id The id of the JSON schema for this declaration.
  */
 extern dec id(target: unknown, id: valueof string);
 
@@ -51,16 +51,16 @@ extern dec multipleOf(target: numeric | Reflection.ModelProperty, value: valueof
 extern dec contains(target: unknown[] | Reflection.ModelProperty, value: unknown);
 
 /**
- * Specify that the array must contain at least some number of the types provided
- * by the contains decorator.
+ * Used in conjunction with the `@contains` decorator,
+ * specifies that the array must contain at least a certain number of the types provided by the `@contains` decorator.
  *
  * @param value The minimum number of instances the array must contain
  */
 extern dec minContains(target: unknown[] | Reflection.ModelProperty, value: valueof int32);
 
 /**
- * Specify that the array must contain at most some number of the types provided
- * by the contains decorator.
+ * Used in conjunction with the `@contains` decorator,
+ * specifies that the array must contain at most a certain number of the types provided by the `@contains` decorator.
  *
  * @param value The maximum number of instances the array must contain
  */
@@ -94,14 +94,14 @@ extern dec contentEncoding(target: string | Reflection.ModelProperty, value: val
 /**
  * Specify that the target array must begin with the provided types.
  *
- * @param value a tuple containing the types that must be present at the start of the array
+ * @param value A tuple containing the types that must be present at the start of the array
  */
 extern dec prefixItems(target: unknown[] | Reflection.ModelProperty, value: unknown[]);
 
 /**
  * Specify the content type of content stored in a string.
  *
- * @param value the media type of the string contents
+ * @param value The media type of the string contents
  *
  */
 extern dec contentMediaType(target: string | Reflection.ModelProperty, value: valueof string);
@@ -110,28 +110,28 @@ extern dec contentMediaType(target: string | Reflection.ModelProperty, value: va
  * Specify the schema for the contents of a string when interpreted according to the content's
  * media type and encoding.
  *
- * @param value the schema of the string contents
+ * @param value The schema of the string contents
  */
 extern dec contentSchema(target: string | Reflection.ModelProperty, value: unknown);
 
 /**
- * Specify a custom property to add to the emitted schema. Useful for adding custom keywords
+ * Specify a custom property to add to the emitted schema. This is useful for adding custom keywords
  * and other vendor-specific extensions. Scalar values need to be specified using `typeof` to be converted to a schema.
  * 
  * For example, `@extension("x-schema", typeof "foo")` will emit a JSON schema value for `x-schema`,
  * whereas `@extension("x-schema", "foo")` will emit the raw code `"foo"`.
  *
  * The value will be treated as a raw value if any of the following are true:
- * 1. The value is a scalar value (e.g. string, number, boolean, etc.)
- * 2. The value is wrapped in the `Json<Data>` template
- * 3. The value is provided using the value syntax (e.g. `#{}`, `#[]`)
+ * - The value is a scalar value (e.g. string, number, boolean, etc.)
+ * - The value is wrapped in the `Json<Data>` template
+ * - The value is provided using the value syntax (e.g. `#{}`, `#[]`)
  
  * For example, `@extension("x-schema", { x: "value" })` will emit a JSON schema value for `x-schema`,
  * whereas `@extension("x-schema", #{x: "value"})` and `@extension("x-schema", Json<{x: "value"}>)`
  * will emit the raw JSON code `{x: "value"}`.
  *
- * @param key the name of the keyword of vendor extension, e.g. `x-custom`.
- * @param value the value of the keyword.
+ * @param key The name of the keyword of vendor extension, e.g. `x-custom`.
+ * @param value The value of the keyword.
  */
 extern dec extension(target: unknown, key: valueof string, value: (valueof unknown) | unknown);
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@typespec/json-schema",
-  "version": "0.68.0-dev.3",
+  "version": "0.68.0-dev.4",
   "author": "Microsoft Corporation",
   "description": "TypeSpec library for emitting TypeSpec to JSON Schema and converting JSON Schema to TypeSpec",
   "homepage": "https://github.com/microsoft/typespec",
@@ -40,11 +40,11 @@
     "!dist/test/**"
   ],
   "peerDependencies": {
-    "@typespec/compiler": "^0.67.1 || >=0.68.0-dev <0.68.0"
+    "@typespec/compiler": "^0.67.2 || >=0.68.0-dev <0.68.0"
   },
   "devDependencies": {
     "@types/node": "~22.13.11",
-    "@typespec/compiler": "^0.67.1 || >=0.68.0-dev <0.68.0",
+    "@typespec/compiler": "^0.67.2 || >=0.68.0-dev <0.68.0",
     "@typespec/internal-build-utils": "^0.67.1 || >=0.68.0-dev <0.68.0",
     "@typespec/library-linter": "^0.67.1 || >=0.68.0-dev <0.68.0",
     "@vitest/coverage-v8": "^3.0.9",