@typespec/compiler 1.18.0-dev.4 → 1.18.0-dev.5

package/dist/src/utils/state-accessor.d.ts

@@ -1,11 +1,21 @@
 import type { Program } from "../core/program.js";
 import type { Type } from "../core/types.js";
+/** Read a type's program-local state value, returning undefined when no entry exists. */
 type StateMapGetter<K extends Type, V> = (program: Program, type: K) => V | undefined;
+/** Associate a state value with a type in the supplied program, replacing any previous entry. */
 type StateMapSetter<K extends Type, V> = (program: Program, type: K, value: V) => void;
+/** Obtain the live mutable state map, not a copy, for the supplied program. */
 type StateMapMapGetter<K extends Type, V> = (program: Program) => Map<K, V>;
+/**
+ * Bind a symbol to typed getter, setter, and live-map accessor functions, in that order.
+ * Data belongs to the program passed on each call; creating these accessors does not allocate a shared map.
+ */
 export declare function useStateMap<K extends Type, V>(key: symbol): [StateMapGetter<K, V>, StateMapSetter<K, V>, StateMapMapGetter<K, V>];
+/** Test a type's membership in the state set belonging to the supplied program. */
 type StateSetGetter<K extends Type> = (program: Program, type: K) => boolean;
+/** Add a type to the supplied program's state set; adding it again leaves membership unchanged. */
 type StateSetSetter<K extends Type> = (program: Program, type: K) => void;
+/** Bind a symbol to membership-test and add functions for a program-local set, in that order. */
 export declare function useStateSet<K extends Type>(key: symbol): [StateSetGetter<K>, StateSetSetter<K>];
 export {};
 //# sourceMappingURL=state-accessor.d.ts.map

package/dist/src/utils/state-accessor.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"state-accessor.d.ts","sourceRoot":"","sources":["../../../src/utils/state-accessor.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAE7C,KAAK,cAAc,CAAC,CAAC,SAAS,IAAI,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC;AACtF,KAAK,cAAc,CAAC,CAAC,SAAS,IAAI,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,KAAK,IAAI,CAAC;AACvF,KAAK,iBAAiB,CAAC,CAAC,SAAS,IAAI,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,KAAK,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAE5E,wBAAgB,WAAW,CAAC,CAAC,SAAS,IAAI,EAAE,CAAC,EAC3C,GAAG,EAAE,MAAM,GACV,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,iBAAiB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAMvE;AAED,KAAK,cAAc,CAAC,CAAC,SAAS,IAAI,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,KAAK,OAAO,CAAC;AAC7E,KAAK,cAAc,CAAC,CAAC,SAAS,IAAI,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,KAAK,IAAI,CAAC;AAE1E,wBAAgB,WAAW,CAAC,CAAC,SAAS,IAAI,EAAE,GAAG,EAAE,MAAM,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC,CAK/F"}
+{"version":3,"file":"state-accessor.d.ts","sourceRoot":"","sources":["../../../src/utils/state-accessor.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAE7C,yFAAyF;AACzF,KAAK,cAAc,CAAC,CAAC,SAAS,IAAI,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC;AACtF,iGAAiG;AACjG,KAAK,cAAc,CAAC,CAAC,SAAS,IAAI,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,KAAK,IAAI,CAAC;AACvF,+EAA+E;AAC/E,KAAK,iBAAiB,CAAC,CAAC,SAAS,IAAI,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,KAAK,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAE5E;;;GAGG;AACH,wBAAgB,WAAW,CAAC,CAAC,SAAS,IAAI,EAAE,CAAC,EAC3C,GAAG,EAAE,MAAM,GACV,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,iBAAiB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAMvE;AAED,mFAAmF;AACnF,KAAK,cAAc,CAAC,CAAC,SAAS,IAAI,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,KAAK,OAAO,CAAC;AAC7E,mGAAmG;AACnG,KAAK,cAAc,CAAC,CAAC,SAAS,IAAI,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,KAAK,IAAI,CAAC;AAE1E,iGAAiG;AACjG,wBAAgB,WAAW,CAAC,CAAC,SAAS,IAAI,EAAE,GAAG,EAAE,MAAM,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC,CAK/F"}

package/dist/src/utils/state-accessor.js

@@ -1,9 +1,14 @@
+/**
+ * Bind a symbol to typed getter, setter, and live-map accessor functions, in that order.
+ * Data belongs to the program passed on each call; creating these accessors does not allocate a shared map.
+ */
 export function useStateMap(key) {
     const getter = (program, target) => program.stateMap(key).get(target);
     const setter = (program, target, value) => program.stateMap(key).set(target, value);
     const mapGetter = (program) => program.stateMap(key);
     return [getter, setter, mapGetter];
 }
+/** Bind a symbol to membership-test and add functions for a program-local set, in that order. */
 export function useStateSet(key) {
     const getter = (program, target) => program.stateSet(key).has(target);
     const setter = (program, target) => program.stateSet(key).add(target);

package/dist/src/utils/state-accessor.js.map

@@ -1 +1 @@
-{"version":3,"file":"state-accessor.js","sourceRoot":"","sources":["../../../src/utils/state-accessor.ts"],"names":[],"mappings":"AAOA,MAAM,UAAU,WAAW,CACzB,GAAW;IAEX,MAAM,MAAM,GAAG,CAAC,OAAgB,EAAE,MAAS,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAClF,MAAM,MAAM,GAAG,CAAC,OAAgB,EAAE,MAAS,EAAE,KAAQ,EAAE,EAAE,CACvD,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAC3C,MAAM,SAAS,GAAG,CAAC,OAAgB,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IAC9D,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,SAAgB,CAAC,CAAC;AAC5C,CAAC;AAKD,MAAM,UAAU,WAAW,CAAiB,GAAW;IACrD,MAAM,MAAM,GAAG,CAAC,OAAgB,EAAE,MAAS,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAClF,MAAM,MAAM,GAAG,CAAC,OAAgB,EAAE,MAAS,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAElF,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAC1B,CAAC"}
+{"version":3,"file":"state-accessor.js","sourceRoot":"","sources":["../../../src/utils/state-accessor.ts"],"names":[],"mappings":"AAUA;;;GAGG;AACH,MAAM,UAAU,WAAW,CACzB,GAAW;IAEX,MAAM,MAAM,GAAG,CAAC,OAAgB,EAAE,MAAS,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAClF,MAAM,MAAM,GAAG,CAAC,OAAgB,EAAE,MAAS,EAAE,KAAQ,EAAE,EAAE,CACvD,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAC3C,MAAM,SAAS,GAAG,CAAC,OAAgB,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IAC9D,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,SAAgB,CAAC,CAAC;AAC5C,CAAC;AAOD,iGAAiG;AACjG,MAAM,UAAU,WAAW,CAAiB,GAAW;IACrD,MAAM,MAAM,GAAG,CAAC,OAAgB,EAAE,MAAS,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAClF,MAAM,MAAM,GAAG,CAAC,OAAgB,EAAE,MAAS,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAElF,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAC1B,CAAC"}

package/dist/src/yaml/types.d.ts

@@ -1,6 +1,9 @@
 import type { SourceFile } from "../core/types.js";
+/** Parsed YAML input with its original source file and resulting JavaScript value. */
 export interface YamlScript {
+    /** Discriminant identifying a parsed YAML script. */
     readonly kind: "yaml-script";
+    /** Original text and path used to locate diagnostics in the YAML input. */
     readonly file: SourceFile;
     /** Value of the yaml script. */
     readonly value: unknown;

package/dist/src/yaml/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/yaml/types.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEnD,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC;IAC7B,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;IAC1B,gCAAgC;IAChC,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;CAIzB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,aAAa,CAAC;IACpB,MAAM,EAAE,UAAU,CAAC;IACnB,IAAI,EAAE,MAAM,EAAE,CAAC;CAChB;AACD,MAAM,MAAM,wBAAwB,GAAG,OAAO,GAAG,KAAK,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/yaml/types.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEnD,sFAAsF;AACtF,MAAM,WAAW,UAAU;IACzB,qDAAqD;IACrD,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC;IAC7B,2EAA2E;IAC3E,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;IAC1B,gCAAgC;IAChC,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;CAIzB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,aAAa,CAAC;IACpB,MAAM,EAAE,UAAU,CAAC;IACnB,IAAI,EAAE,MAAM,EAAE,CAAC;CAChB;AACD,MAAM,MAAM,wBAAwB,GAAG,OAAO,GAAG,KAAK,CAAC"}

package/lib/std/decorators.tsp

@@ -643,10 +643,18 @@ extern dec example(
  * Operation example configuration.
  */
 model OperationExample {
-  /** Example request body. */
+  /**
+   * Example argument values keyed by operation parameter name.
+   * The object must match the operation's full parameter model. For HTTP operations,
+   * this includes required path, query, and header parameters as well as body parameters.
+   */
   parameters?: unknown;
 
-  /** Example response body. */
+  /**
+   * Example value matching the operation's full return type.
+   * This is not limited to an HTTP response body: required response metadata
+   * properties must also be present.
+   */
   returnType?: unknown;
 }
 
@@ -659,7 +667,12 @@ model OperationExample {
  * @example
  *
  * ```tsp
- * @opExample(#{parameters: #{name: "Fluffy", age: 2}, returnType: #{name: "Fluffy", age: 2, id: "abc"})
+ * model Pet { name: string; age: int32; }
+ *
+ * @opExample(#{
+ *   parameters: #{pet: #{name: "Fluffy", age: 2}},
+ *   returnType: #{name: "Fluffy", age: 2}
+ * })
  * op createPet(pet: Pet): Pet;
  * ```
  */

package/lib/std/visibility.tsp

@@ -265,8 +265,22 @@ enum Lifecycle {
  * - If the `none` key is present, the property must have none of the specified visibilities.
  */
 model VisibilityFilter {
+  /**
+   * Require at least one of these visibility modifiers.
+   * Omit to impose no such requirement; an empty array matches no properties.
+   */
   any?: EnumMember[];
+
+  /**
+   * Require every one of these visibility modifiers.
+   * Omit or pass an empty array to impose no such requirement.
+   */
   all?: EnumMember[];
+
+  /**
+   * Exclude properties with any of these visibility modifiers.
+   * Omit or pass an empty array to exclude no properties by this condition.
+   */
   none?: EnumMember[];
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@typespec/compiler",
-  "version": "1.18.0-dev.4",
+  "version": "1.18.0-dev.5",
   "description": "TypeSpec compiler and standard library",
   "author": "Microsoft Corporation",
   "license": "MIT",