diff --git a/.chronus/changes/1ds-mc1-ms0-2024-8-13-14-14-2.md b/.chronus/changes/1ds-mc1-ms0-2024-8-13-14-14-2.md deleted file mode 100644 index b26c8dd246..0000000000 --- a/.chronus/changes/1ds-mc1-ms0-2024-8-13-14-14-2.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: internal -packages: - - "@typespec/html-program-viewer" - - "@typespec/playground" ---- - diff --git a/.chronus/changes/InfoUnallowKeyChecker-2024-8-24-11-6-11.md b/.chronus/changes/InfoUnallowKeyChecker-2024-8-24-11-6-11.md deleted file mode 100644 index caa79913d8..0000000000 --- a/.chronus/changes/InfoUnallowKeyChecker-2024-8-24-11-6-11.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: fix -packages: - - "@typespec/openapi" ---- - -`@info` decorator validate no extra properties not starting with `x-` are provided. diff --git a/.chronus/changes/SemanticWalkerExitFixes-2024-9-9-10-27-23.md b/.chronus/changes/SemanticWalkerExitFixes-2024-9-9-10-27-23.md deleted file mode 100644 index 9d91beab1f..0000000000 --- a/.chronus/changes/SemanticWalkerExitFixes-2024-9-9-10-27-23.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: fix -packages: - - "@typespec/compiler" ---- - -[API] Add missing exit callback diff --git a/.chronus/changes/add-streaming-2024-8-25-11-52-49.md b/.chronus/changes/add-streaming-2024-8-25-11-52-49.md deleted file mode 100644 index f3ea9a0511..0000000000 --- a/.chronus/changes/add-streaming-2024-8-25-11-52-49.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: feature -packages: - - "@typespec/events" ---- - -Adds a new core package for describing events. \ No newline at end of file diff --git a/.chronus/changes/add-streaming-2024-8-25-11-53-37.md b/.chronus/changes/add-streaming-2024-8-25-11-53-37.md deleted file mode 100644 index 9eff9f7a59..0000000000 --- a/.chronus/changes/add-streaming-2024-8-25-11-53-37.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: feature -packages: - - "@typespec/streams" ---- - -Adds a new core package for describing streams and the type of data they contain. diff --git a/.chronus/changes/add-streaming-2024-8-25-11-54-27.md b/.chronus/changes/add-streaming-2024-8-25-11-54-27.md deleted file mode 100644 index 51a7a423b4..0000000000 --- a/.chronus/changes/add-streaming-2024-8-25-11-54-27.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: feature -packages: - - "@typespec/sse" ---- - -Adds a new core package to describe server-sent events. \ No newline at end of file diff --git a/.chronus/changes/add-streaming-2024-8-25-11-56-3.md b/.chronus/changes/add-streaming-2024-8-25-11-56-3.md deleted file mode 100644 index 00b64884ff..0000000000 --- a/.chronus/changes/add-streaming-2024-8-25-11-56-3.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: feature -packages: - - "@typespec/http" ---- - -Adds HttpStream and JsonlStream models to to support streaming use-cases. \ No newline at end of file diff --git a/.chronus/changes/add-streaming-2024-8-25-11-56-36.md b/.chronus/changes/add-streaming-2024-8-25-11-56-36.md deleted file mode 100644 index 6d4e774ab0..0000000000 --- a/.chronus/changes/add-streaming-2024-8-25-11-56-36.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: fix -packages: - - "@typespec/compiler" ---- - -Fixes issue with the semantic walker where `exitTuple` was not being emitted. \ No newline at end of file diff --git a/.chronus/changes/almend-ScalarDefaultValue-2024-8-12-15-34-32.md b/.chronus/changes/almend-ScalarDefaultValue-2024-8-12-15-34-32.md deleted file mode 100644 index 234ab1f96b..0000000000 --- a/.chronus/changes/almend-ScalarDefaultValue-2024-8-12-15-34-32.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: feature -packages: - - "@typespec/openapi3" ---- - -Added support to use Scalar and Object as default types \ No newline at end of file diff --git a/.chronus/changes/config-invalid-name-2024-8-25-19-8-41.md b/.chronus/changes/config-invalid-name-2024-8-25-19-8-41.md deleted file mode 100644 index d63030015a..0000000000 --- a/.chronus/changes/config-invalid-name-2024-8-25-19-8-41.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: breaking -packages: - - "@typespec/compiler" ---- - -Config parameters and emitters options cannot contains `.`. This conflict with newly added support for nested options. diff --git a/.chronus/changes/decorator-arg-marshalling-new-default-2024-8-23-14-22-52.md b/.chronus/changes/decorator-arg-marshalling-new-default-2024-8-23-14-22-52.md deleted file mode 100644 index 92a38e36cb..0000000000 --- a/.chronus/changes/decorator-arg-marshalling-new-default-2024-8-23-14-22-52.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -changeKind: breaking -packages: - - "@typespec/compiler" ---- - -API: Update default of `decoratorArgMarshalling` from `legacy` to `new` - -To revert to the old behavior export the following. **Highly discouraged, this will be removed in a few versions.** - -```ts -export const $flags = definePackageFlags({ - decoratorArgMarshalling: "legacy", -}); -``` diff --git a/.chronus/changes/decorator-arg-marshalling-new-default-2024-8-23-21-44-3.md b/.chronus/changes/decorator-arg-marshalling-new-default-2024-8-23-21-44-3.md deleted file mode 100644 index 4b94b02c3f..0000000000 --- a/.chronus/changes/decorator-arg-marshalling-new-default-2024-8-23-21-44-3.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: internal -packages: - - "@typespec/json-schema" ---- - -Update decorator arg marshalling to new default diff --git a/.chronus/changes/diagnostic-url-2024-8-13-19-59-26.md b/.chronus/changes/diagnostic-url-2024-8-13-19-59-26.md deleted file mode 100644 index 856b5f4b35..0000000000 --- a/.chronus/changes/diagnostic-url-2024-8-13-19-59-26.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: feature -packages: - - "@typespec/compiler" ---- - -Library diagnostic can now define a `description` and `url` that links to a more detailed doc for this diagnostic diff --git a/.chronus/changes/feature-mutators-2024-7-28-15-59-14.md b/.chronus/changes/feature-mutators-2024-7-28-15-59-14.md deleted file mode 100644 index 16165268c0..0000000000 --- a/.chronus/changes/feature-mutators-2024-7-28-15-59-14.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: feature -packages: - - "@typespec/compiler" ---- - -Adding experimental (unstable) API fro Type Mutators \ No newline at end of file diff --git a/.chronus/changes/fix-e2e-not-checking-file-changed-2024-9-4-21-56-58.md b/.chronus/changes/fix-e2e-not-checking-file-changed-2024-9-4-21-56-58.md deleted file mode 100644 index b5c17c7e23..0000000000 --- a/.chronus/changes/fix-e2e-not-checking-file-changed-2024-9-4-21-56-58.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: internal -packages: - - "@typespec/compiler" ---- - -Check that e2e snapshot files are up to date diff --git a/.chronus/changes/fix-enum-in-union-example-2024-8-17-18-25-2.md b/.chronus/changes/fix-enum-in-union-example-2024-8-17-18-25-2.md deleted file mode 100644 index d25024443d..0000000000 --- a/.chronus/changes/fix-enum-in-union-example-2024-8-17-18-25-2.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: fix -packages: - - "@typespec/compiler" ---- - -Fix examples with enums inside of unions diff --git a/.chronus/changes/fix-examples-const-2024-8-30-17-28-17.md b/.chronus/changes/fix-examples-const-2024-8-30-17-28-17.md deleted file mode 100644 index 205f0a2871..0000000000 --- a/.chronus/changes/fix-examples-const-2024-8-30-17-28-17.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: fix -packages: - - "@typespec/compiler" ---- - -Fix: Passing `const` of model type to `@example` diff --git a/.chronus/changes/fix-examples-encoded-name-2024-8-26-12-52-20.md b/.chronus/changes/fix-examples-encoded-name-2024-8-26-12-52-20.md deleted file mode 100644 index fb1dd64ee3..0000000000 --- a/.chronus/changes/fix-examples-encoded-name-2024-8-26-12-52-20.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: fix -packages: - - "@typespec/compiler" ---- - -Json serialization of example respect `@encodedName` \ No newline at end of file diff --git a/.chronus/changes/fix-invalid-or-2024-8-18-21-5-24.md b/.chronus/changes/fix-invalid-or-2024-8-18-21-5-24.md deleted file mode 100644 index 282ca17dc9..0000000000 --- a/.chronus/changes/fix-invalid-or-2024-8-18-21-5-24.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: internal -packages: - - "@typespec/compiler" - - "@typespec/rest" ---- - -Fix regressions during refactor of state accessor diff --git a/.chronus/changes/fix-not-handling-numeric-leading-0-mulitple-2024-8-24-10-20-50.md b/.chronus/changes/fix-not-handling-numeric-leading-0-mulitple-2024-8-24-10-20-50.md deleted file mode 100644 index 160f43ab78..0000000000 --- a/.chronus/changes/fix-not-handling-numeric-leading-0-mulitple-2024-8-24-10-20-50.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: fix -packages: - - "@typespec/compiler" ---- - -Fix issue with decimal numeric and leading `0.0` with multiple digit diff --git a/.chronus/changes/fix-playground-blank-screen-and-formatter-2024-8-26-12-35-15.md b/.chronus/changes/fix-playground-blank-screen-and-formatter-2024-8-26-12-35-15.md deleted file mode 100644 index f1073d0f71..0000000000 --- a/.chronus/changes/fix-playground-blank-screen-and-formatter-2024-8-26-12-35-15.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -changeKind: internal -packages: - - "@typespec/playground" ---- - diff --git a/.chronus/changes/fix-project-source-models-2024-8-13-15-15-44.md b/.chronus/changes/fix-project-source-models-2024-8-13-15-15-44.md deleted file mode 100644 index 9687ec4a92..0000000000 --- a/.chronus/changes/fix-project-source-models-2024-8-13-15-15-44.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: fix -packages: - - "@typespec/compiler" ---- - -[API] model `sourceModels` property are now projected correctly diff --git a/.chronus/changes/fix-server-file-cache-2024-8-18-11-4-8.md b/.chronus/changes/fix-server-file-cache-2024-8-18-11-4-8.md deleted file mode 100644 index d7ef43c29a..0000000000 --- a/.chronus/changes/fix-server-file-cache-2024-8-18-11-4-8.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: fix -packages: - - "@typespec/compiler" ---- - -Changing tspconfig.yaml won't take effect in LSP server because of the cache \ No newline at end of file diff --git a/.chronus/changes/fix-virtual-path-playground-2024-9-9-10-21-58.md b/.chronus/changes/fix-virtual-path-playground-2024-9-9-10-21-58.md deleted file mode 100644 index f1073d0f71..0000000000 --- a/.chronus/changes/fix-virtual-path-playground-2024-9-9-10-21-58.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -changeKind: internal -packages: - - "@typespec/playground" ---- - diff --git a/.chronus/changes/fix-virtual-path-playground-2024-9-9-10-47-42.md b/.chronus/changes/fix-virtual-path-playground-2024-9-9-10-47-42.md deleted file mode 100644 index f441bba5f0..0000000000 --- a/.chronus/changes/fix-virtual-path-playground-2024-9-9-10-47-42.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -changeKind: internal -packages: - - "@typespec/compiler" ---- - diff --git a/.chronus/changes/fix-watch-config-2024-8-27-22-7-45.md b/.chronus/changes/fix-watch-config-2024-8-27-22-7-45.md deleted file mode 100644 index bd02cd3689..0000000000 --- a/.chronus/changes/fix-watch-config-2024-8-27-22-7-45.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: fix -packages: - - "@typespec/compiler" ---- - - `tsp compile --watch` reread from `tspconfig.yaml` file diff --git a/.chronus/changes/format-trailling-commas-2024-8-16-18-56-35.md b/.chronus/changes/format-trailling-commas-2024-8-16-18-56-35.md deleted file mode 100644 index 9c31d7c488..0000000000 --- a/.chronus/changes/format-trailling-commas-2024-8-16-18-56-35.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: internal -packages: - - "@typespec/bundler" - - "@typespec/compiler" - - "@typespec/eslint-plugin" - - "@typespec/html-program-viewer" - - "@typespec/http-server-csharp" - - "@typespec/http-server-javascript" - - "@typespec/http" - - "@typespec/internal-build-utils" - - "@typespec/json-schema" - - "@typespec/library-linter" - - "@typespec/openapi" - - "@typespec/openapi3" - - "@typespec/playground" - - "@typespec/protobuf" - - "@typespec/rest" - - typespec-vs - - typespec-vscode - - "@typespec/versioning" - - "@typespec/xml" ---- - -Update prettier config to format trailing commas to `all` (Default) diff --git a/.chronus/changes/json-schema-examples-2024-8-13-16-5-45.md b/.chronus/changes/json-schema-examples-2024-8-13-16-5-45.md deleted file mode 100644 index 5898f8280f..0000000000 --- a/.chronus/changes/json-schema-examples-2024-8-13-16-5-45.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: feature -packages: - - "@typespec/json-schema" ---- - -Example set with `@example` decorator will populate the schema `examples` property \ No newline at end of file diff --git a/.chronus/changes/main-2024-8-4-15-6-54.md b/.chronus/changes/main-2024-8-4-15-6-54.md deleted file mode 100644 index 81399d79cb..0000000000 --- a/.chronus/changes/main-2024-8-4-15-6-54.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: feature -packages: - - typespec-vscode ---- - -Support Compile Task and Watch Task in vscode. diff --git a/.chronus/changes/refactor-packagejson-type-2024-9-3-17-20-34.md b/.chronus/changes/refactor-packagejson-type-2024-9-3-17-20-34.md deleted file mode 100644 index c46bd3a4f8..0000000000 --- a/.chronus/changes/refactor-packagejson-type-2024-9-3-17-20-34.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: feature -packages: - - "@typespec/compiler" ---- - -Expose more accurate `PackageJson` type and deprecate `NodePackage` diff --git a/.chronus/changes/refactor-state-accessor-2024-8-17-15-11-51.md b/.chronus/changes/refactor-state-accessor-2024-8-17-15-11-51.md deleted file mode 100644 index 0c90c5c044..0000000000 --- a/.chronus/changes/refactor-state-accessor-2024-8-17-15-11-51.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: internal -packages: - - "@typespec/http-server-csharp" ---- - -Fix potential undefined \ No newline at end of file diff --git a/.chronus/changes/refactor-state-accessor-2024-8-17-21-56-42.md b/.chronus/changes/refactor-state-accessor-2024-8-17-21-56-42.md deleted file mode 100644 index ab42b7b40b..0000000000 --- a/.chronus/changes/refactor-state-accessor-2024-8-17-21-56-42.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: internal -packages: - - "@typespec/compiler" ---- - -Use reusable state accessor for compiler decorators diff --git a/.chronus/changes/resolve-module-exports-2024-9-4-18-32-9.md b/.chronus/changes/resolve-module-exports-2024-9-4-18-32-9.md deleted file mode 100644 index b4bf9236c0..0000000000 --- a/.chronus/changes/resolve-module-exports-2024-9-4-18-32-9.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: feature -packages: - - "@typespec/compiler" ---- - -Add support for node `exports` field. Specific typespec exports can be provided with the `typespec` field - -```json -"exports": { - ".": { - "typespec": "./lib/main.tsp", - }, - "./named": { - "typespec": "./lib/named.tsp", - } -} -``` diff --git a/.chronus/changes/resolve-module-exports-2024-9-4-22-21-14.md b/.chronus/changes/resolve-module-exports-2024-9-4-22-21-14.md deleted file mode 100644 index 6836d03702..0000000000 --- a/.chronus/changes/resolve-module-exports-2024-9-4-22-21-14.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: fix -packages: - - "@typespec/playground" ---- - -Do not treat path as relative internally diff --git a/.chronus/changes/support-variable-base-nested-config-2024-8-25-19-8-41.md b/.chronus/changes/support-variable-base-nested-config-2024-8-25-19-8-41.md deleted file mode 100644 index d66c74cc75..0000000000 --- a/.chronus/changes/support-variable-base-nested-config-2024-8-25-19-8-41.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: feature -packages: - - "@typespec/compiler" ---- - -Support nested emitter options \ No newline at end of file diff --git a/.chronus/changes/termsOfServiceUrlCheck-2024-8-23-12-59-15.md b/.chronus/changes/termsOfServiceUrlCheck-2024-8-23-12-59-15.md deleted file mode 100644 index 541f10403d..0000000000 --- a/.chronus/changes/termsOfServiceUrlCheck-2024-8-23-12-59-15.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: fix -packages: - - "@typespec/openapi" ---- - -`@info` decorator validate `termsOfService` is a valid url \ No newline at end of file diff --git a/.chronus/changes/upgrade-deps-sep-2024-2-2024-8-25-9-32-48.md b/.chronus/changes/upgrade-deps-sep-2024-2-2024-8-25-9-32-48.md deleted file mode 100644 index 6b99fa4a47..0000000000 --- a/.chronus/changes/upgrade-deps-sep-2024-2-2024-8-25-9-32-48.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -changeKind: internal -packages: - - "@typespec/bundler" - - "@typespec/compiler" - - "@typespec/eslint-plugin" - - "@typespec/html-program-viewer" - - "@typespec/http-server-csharp" - - "@typespec/http-server-javascript" - - "@typespec/http" - - "@typespec/internal-build-utils" - - "@typespec/json-schema" - - "@typespec/library-linter" - - "@typespec/openapi" - - "@typespec/openapi3" - - "@typespec/playground" - - "@typespec/prettier-plugin-typespec" - - "@typespec/protobuf" - - "@typespec/rest" - - tmlanguage-generator - - typespec-vscode - - "@typespec/versioning" - - "@typespec/xml" ---- - diff --git a/.chronus/changes/upgrade-deps-sep-2024-2024-8-13-0-37-48.md b/.chronus/changes/upgrade-deps-sep-2024-2024-8-13-0-37-48.md deleted file mode 100644 index 5dcf0fdf5b..0000000000 --- a/.chronus/changes/upgrade-deps-sep-2024-2024-8-13-0-37-48.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: dependencies -packages: - - "@typespec/bundler" - - "@typespec/compiler" - - "@typespec/eslint-plugin" - - "@typespec/html-program-viewer" - - "@typespec/http-server-csharp" - - "@typespec/http-server-javascript" - - "@typespec/http" - - "@typespec/internal-build-utils" - - "@typespec/json-schema" - - "@typespec/library-linter" - - "@typespec/openapi" - - "@typespec/openapi3" - - "@typespec/playground" - - "@typespec/prettier-plugin-typespec" - - "@typespec/protobuf" - - "@typespec/rest" - - tmlanguage-generator - - typespec-vscode - - "@typespec/versioning" - - "@typespec/xml" ---- - -Bump dependencies diff --git a/.chronus/changes/upgrade-monaco-editor-2024-8-25-21-58-44.md b/.chronus/changes/upgrade-monaco-editor-2024-8-25-21-58-44.md deleted file mode 100644 index 20911ef824..0000000000 --- a/.chronus/changes/upgrade-monaco-editor-2024-8-25-21-58-44.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: feature -packages: - - "@typespec/playground" ---- - -Upgrade to latest monaco-editor diff --git a/.chronus/changes/use-shell-for-cmd-2024-8-13-11-39-59.md b/.chronus/changes/use-shell-for-cmd-2024-8-13-11-39-59.md deleted file mode 100644 index b3e569d0fa..0000000000 --- a/.chronus/changes/use-shell-for-cmd-2024-8-13-11-39-59.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: fix -packages: - - typespec-vscode ---- - -Use "shell" when spawning execution of .cmd file(i.e. tsp-server.cmd) in windows diff --git a/.chronus/changes/vscode-web-2024-8-23-20-15-22.md b/.chronus/changes/vscode-web-2024-8-23-20-15-22.md deleted file mode 100644 index d2e59acf6f..0000000000 --- a/.chronus/changes/vscode-web-2024-8-23-20-15-22.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: feature -packages: - - typespec-vscode ---- - -Make extension web compatible with minimal functionality diff --git a/.chronus/changes/vscode-web-2024-8-23-21-44-3.md b/.chronus/changes/vscode-web-2024-8-23-21-44-3.md deleted file mode 100644 index c8a42008c9..0000000000 --- a/.chronus/changes/vscode-web-2024-8-23-21-44-3.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: fix -packages: - - "@typespec/internal-build-utils" ---- - -Ignore test from third party notice generation diff --git a/packages/bundler/CHANGELOG.md b/packages/bundler/CHANGELOG.md index 3562788cd5..cc6ab132a8 100644 --- a/packages/bundler/CHANGELOG.md +++ b/packages/bundler/CHANGELOG.md @@ -1,5 +1,12 @@ # Change Log - @typespec/bundler +## 0.1.8 + +### Bump dependencies + +- [#4424](https://github.com/microsoft/typespec/pull/4424) Bump dependencies + + ## 0.1.7 ### Bug Fixes diff --git a/packages/bundler/package.json b/packages/bundler/package.json index 79fde26335..4fd43d5f27 100644 --- a/packages/bundler/package.json +++ b/packages/bundler/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/bundler", - "version": "0.1.7", + "version": "0.1.8", "author": "Microsoft Corporation", "description": "Package to bundle a TypeSpec library.", "homepage": "https://typespec.io", diff --git a/packages/compiler/CHANGELOG.md b/packages/compiler/CHANGELOG.md index 00bc024a8b..68af7a7f00 100644 --- a/packages/compiler/CHANGELOG.md +++ b/packages/compiler/CHANGELOG.md @@ -1,5 +1,56 @@ # Change Log - @typespec/compiler +## 0.61.0 + +### Bug Fixes + +- [#4626](https://github.com/microsoft/typespec/pull/4626) [API] Add missing exit callback +- [#4513](https://github.com/microsoft/typespec/pull/4513) Fixes issue with the semantic walker where `exitTuple` was not being emitted. +- [#4462](https://github.com/microsoft/typespec/pull/4462) Fix examples with enums inside of unions +- [#4574](https://github.com/microsoft/typespec/pull/4574) Fix: Passing `const` of model type to `@example` +- [#4551](https://github.com/microsoft/typespec/pull/4551) Json serialization of example respect `@encodedName` +- [#4514](https://github.com/microsoft/typespec/pull/4514) Fix issue with decimal numeric and leading `0.0` with multiple digit +- [#4445](https://github.com/microsoft/typespec/pull/4445) [API] model `sourceModels` property are now projected correctly +- [#4467](https://github.com/microsoft/typespec/pull/4467) Changing tspconfig.yaml won't take effect in LSP server because of the cache +- [#4563](https://github.com/microsoft/typespec/pull/4563) `tsp compile --watch` reread from `tspconfig.yaml` file + +### Bump dependencies + +- [#4424](https://github.com/microsoft/typespec/pull/4424) Bump dependencies + +### Features + +- [#4442](https://github.com/microsoft/typespec/pull/4442) Library diagnostic can now define a `description` and `url` that links to a more detailed doc for this diagnostic +- [#4290](https://github.com/microsoft/typespec/pull/4290) Adding experimental (unstable) API fro Type Mutators +- [#4595](https://github.com/microsoft/typespec/pull/4595) Expose more accurate `PackageJson` type and deprecate `NodePackage` +- [#4606](https://github.com/microsoft/typespec/pull/4606) Add support for node `exports` field. Specific typespec exports can be provided with the `typespec` field + +```json +"exports": { + ".": { + "typespec": "./lib/main.tsp", + }, + "./named": { + "typespec": "./lib/named.tsp", + } +} +``` +- [#4539](https://github.com/microsoft/typespec/pull/4539) Support nested emitter options + +### Breaking Changes + +- [#4539](https://github.com/microsoft/typespec/pull/4539) Config parameters and emitters options cannot contains `.`. This conflict with newly added support for nested options. +- [#4500](https://github.com/microsoft/typespec/pull/4500) API: Update default of `decoratorArgMarshalling` from `legacy` to `new` + +To revert to the old behavior export the following. **Highly discouraged, this will be removed in a few versions.** + +```ts +export const $flags = definePackageFlags({ + decoratorArgMarshalling: "legacy", +}); +``` + + ## 0.60.1 ### Bug Fixes diff --git a/packages/compiler/package.json b/packages/compiler/package.json index 34f5d7bac7..c674698152 100644 --- a/packages/compiler/package.json +++ b/packages/compiler/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/compiler", - "version": "0.60.1", + "version": "0.61.0", "description": "TypeSpec Compiler Preview", "author": "Microsoft Corporation", "license": "MIT", diff --git a/packages/compiler/templates/scaffolding.json b/packages/compiler/templates/scaffolding.json index 74397a24bf..780c5765c1 100644 --- a/packages/compiler/templates/scaffolding.json +++ b/packages/compiler/templates/scaffolding.json @@ -3,12 +3,12 @@ "title": "Empty project", "description": "Create an empty project.", "libraries": [], - "compilerVersion": "0.60.1" + "compilerVersion": "0.61.0" }, "rest": { "title": "Generic REST API", "description": "Create a project representing a generic REST API", - "compilerVersion": "0.60.1", + "compilerVersion": "0.61.0", "libraries": [ "@typespec/http", "@typespec/rest", @@ -23,7 +23,7 @@ "library-ts": { "title": "TypeSpec Library (With TypeScript)", "description": "Create a new package to add decorators or linters to typespec.", - "compilerVersion": "0.60.1", + "compilerVersion": "0.61.0", "libraries": [], "files": [ { @@ -99,7 +99,7 @@ "emitter-ts": { "title": "TypeSpec Emitter (With TypeScript)", "description": "Create a new package that will be emitting typespec", - "compilerVersion": "0.60.1", + "compilerVersion": "0.61.0", "libraries": [], "files": [ { diff --git a/packages/eslint-plugin-typespec/CHANGELOG.md b/packages/eslint-plugin-typespec/CHANGELOG.md index 86aaa11783..e06be07b6a 100644 --- a/packages/eslint-plugin-typespec/CHANGELOG.md +++ b/packages/eslint-plugin-typespec/CHANGELOG.md @@ -1,5 +1,12 @@ # Change Log - @typespec/eslint-plugin +## 0.61.0 + +### Bump dependencies + +- [#4424](https://github.com/microsoft/typespec/pull/4424) Bump dependencies + + ## 0.60.0 No changes, version bump only. diff --git a/packages/eslint-plugin-typespec/package.json b/packages/eslint-plugin-typespec/package.json index edf6fc8e39..5f228e618c 100644 --- a/packages/eslint-plugin-typespec/package.json +++ b/packages/eslint-plugin-typespec/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/eslint-plugin", - "version": "0.60.0", + "version": "0.61.0", "author": "Microsoft Corporation", "description": "Eslint plugin providing set of rules to be used in the JS/TS code of TypeSpec libraries", "homepage": "https://typespec.io", diff --git a/packages/events/CHANGELOG.md b/packages/events/CHANGELOG.md index 84aaa27d33..994030b8f4 100644 --- a/packages/events/CHANGELOG.md +++ b/packages/events/CHANGELOG.md @@ -1 +1,8 @@ # Changelog - @typespec/events + +## 0.61.0 + +### Features + +- [#4513](https://github.com/microsoft/typespec/pull/4513) Adds a new core package for describing events. + diff --git a/packages/events/package.json b/packages/events/package.json index f8e3a2510c..ecc32d6d1b 100644 --- a/packages/events/package.json +++ b/packages/events/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/events", - "version": "0.60.0", + "version": "0.61.0", "author": "Microsoft Corporation", "description": "TypeSpec library providing events bindings", "homepage": "https://typespec.io", diff --git a/packages/html-program-viewer/CHANGELOG.md b/packages/html-program-viewer/CHANGELOG.md index bd64a97979..de01816d4b 100644 --- a/packages/html-program-viewer/CHANGELOG.md +++ b/packages/html-program-viewer/CHANGELOG.md @@ -1,5 +1,12 @@ # Change Log - @typespec/html-program-viewer +## 0.61.0 + +### Bump dependencies + +- [#4424](https://github.com/microsoft/typespec/pull/4424) Bump dependencies + + ## 0.60.0 ### Bug Fixes diff --git a/packages/html-program-viewer/package.json b/packages/html-program-viewer/package.json index daf1657180..38598c9404 100644 --- a/packages/html-program-viewer/package.json +++ b/packages/html-program-viewer/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/html-program-viewer", - "version": "0.60.0", + "version": "0.61.0", "author": "Microsoft Corporation", "description": "TypeSpec library for emitting an html view of the program.", "homepage": "https://typespec.io", diff --git a/packages/http-server-csharp/CHANGELOG.md b/packages/http-server-csharp/CHANGELOG.md index c2f9e93cf3..a570eafe60 100644 --- a/packages/http-server-csharp/CHANGELOG.md +++ b/packages/http-server-csharp/CHANGELOG.md @@ -1,5 +1,12 @@ # Change Log - @typespec/http-server-csharp +## 0.58.0-alpha.4 + +### Bump dependencies + +- [#4424](https://github.com/microsoft/typespec/pull/4424) Bump dependencies + + ## 0.58.0-alpha.3 No changes, version bump only. diff --git a/packages/http-server-csharp/package.json b/packages/http-server-csharp/package.json index d0ddae7e0b..6a21ce74e8 100644 --- a/packages/http-server-csharp/package.json +++ b/packages/http-server-csharp/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/http-server-csharp", - "version": "0.58.0-alpha.3", + "version": "0.58.0-alpha.4", "author": "Microsoft Corporation", "description": "TypeSpec service code generator for c-sharp", "homepage": "https://typespec.io", diff --git a/packages/http-server-javascript/CHANGELOG.md b/packages/http-server-javascript/CHANGELOG.md index b502fb05cf..b016b6d0ea 100644 --- a/packages/http-server-javascript/CHANGELOG.md +++ b/packages/http-server-javascript/CHANGELOG.md @@ -1,5 +1,12 @@ # Changelog - @typespec/http-server-javascript +## 0.58.0-alpha.4 + +### Bump dependencies + +- [#4424](https://github.com/microsoft/typespec/pull/4424) Bump dependencies + + ## 0.58.0-alpha.3 No changes, version bump only. diff --git a/packages/http-server-javascript/package.json b/packages/http-server-javascript/package.json index e18d2c6dad..81494c6ee5 100644 --- a/packages/http-server-javascript/package.json +++ b/packages/http-server-javascript/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/http-server-javascript", - "version": "0.58.0-alpha.3", + "version": "0.58.0-alpha.4", "author": "Microsoft Corporation", "description": "TypeSpec HTTP server code generator for JavaScript", "homepage": "https://github.com/microsoft/typespec", diff --git a/packages/http/CHANGELOG.md b/packages/http/CHANGELOG.md index 6e09e7ed10..306a71d0b3 100644 --- a/packages/http/CHANGELOG.md +++ b/packages/http/CHANGELOG.md @@ -1,5 +1,16 @@ # Change Log - @typespec/http +## 0.61.0 + +### Bump dependencies + +- [#4424](https://github.com/microsoft/typespec/pull/4424) Bump dependencies + +### Features + +- [#4513](https://github.com/microsoft/typespec/pull/4513) Adds HttpStream and JsonlStream models to to support streaming use-cases. + + ## 0.60.0 ### Bug Fixes diff --git a/packages/http/package.json b/packages/http/package.json index 657f7731f9..871fa09eb1 100644 --- a/packages/http/package.json +++ b/packages/http/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/http", - "version": "0.60.0", + "version": "0.61.0", "author": "Microsoft Corporation", "description": "TypeSpec HTTP protocol binding", "homepage": "https://github.com/microsoft/typespec", diff --git a/packages/internal-build-utils/CHANGELOG.md b/packages/internal-build-utils/CHANGELOG.md index 8c647e2286..9c8ef1ba6b 100644 --- a/packages/internal-build-utils/CHANGELOG.md +++ b/packages/internal-build-utils/CHANGELOG.md @@ -1,5 +1,16 @@ # Change Log - @typespec/internal-build-utils +## 0.61.0 + +### Bug Fixes + +- [#4498](https://github.com/microsoft/typespec/pull/4498) Ignore test from third party notice generation + +### Bump dependencies + +- [#4424](https://github.com/microsoft/typespec/pull/4424) Bump dependencies + + ## 0.60.0 No changes, version bump only. diff --git a/packages/internal-build-utils/package.json b/packages/internal-build-utils/package.json index 83212dedb8..d8ce92004e 100644 --- a/packages/internal-build-utils/package.json +++ b/packages/internal-build-utils/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/internal-build-utils", - "version": "0.60.0", + "version": "0.61.0", "author": "Microsoft Corporation", "description": "Internal library to TypeSpec providing helpers to build.", "homepage": "https://typespec.io", diff --git a/packages/json-schema/CHANGELOG.md b/packages/json-schema/CHANGELOG.md index aa44aaa29d..edd2f6010a 100644 --- a/packages/json-schema/CHANGELOG.md +++ b/packages/json-schema/CHANGELOG.md @@ -1,5 +1,16 @@ # Change Log - @typespec/json-schema +## 0.61.0 + +### Bump dependencies + +- [#4424](https://github.com/microsoft/typespec/pull/4424) Bump dependencies + +### Features + +- [#4447](https://github.com/microsoft/typespec/pull/4447) Example set with `@example` decorator will populate the schema `examples` property + + ## 0.60.0 ### Bug Fixes diff --git a/packages/json-schema/package.json b/packages/json-schema/package.json index 225f848af7..4e164ca233 100644 --- a/packages/json-schema/package.json +++ b/packages/json-schema/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/json-schema", - "version": "0.60.0", + "version": "0.61.0", "author": "Microsoft Corporation", "description": "TypeSpec library for emitting TypeSpec to JSON Schema and converting JSON Schema to TypeSpec", "homepage": "https://github.com/microsoft/typespec", diff --git a/packages/library-linter/CHANGELOG.md b/packages/library-linter/CHANGELOG.md index 9a36b88c38..a50ec3bd62 100644 --- a/packages/library-linter/CHANGELOG.md +++ b/packages/library-linter/CHANGELOG.md @@ -1,5 +1,12 @@ # Change Log - @typespec/library-linter +## 0.61.0 + +### Bump dependencies + +- [#4424](https://github.com/microsoft/typespec/pull/4424) Bump dependencies + + ## 0.60.0 No changes, version bump only. diff --git a/packages/library-linter/package.json b/packages/library-linter/package.json index f40896497b..f45bce98f2 100644 --- a/packages/library-linter/package.json +++ b/packages/library-linter/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/library-linter", - "version": "0.60.0", + "version": "0.61.0", "author": "Microsoft Corporation", "description": "TypeSpec library for linting another library.", "homepage": "https://typespec.io", diff --git a/packages/openapi/CHANGELOG.md b/packages/openapi/CHANGELOG.md index 6a276e46a7..acde8e44f7 100644 --- a/packages/openapi/CHANGELOG.md +++ b/packages/openapi/CHANGELOG.md @@ -1,5 +1,17 @@ # Change Log - @typespec/openapi +## 0.61.0 + +### Bug Fixes + +- [#4505](https://github.com/microsoft/typespec/pull/4505) `@info` decorator validate no extra properties not starting with `x-` are provided. +- [#4483](https://github.com/microsoft/typespec/pull/4483) `@info` decorator validate `termsOfService` is a valid url + +### Bump dependencies + +- [#4424](https://github.com/microsoft/typespec/pull/4424) Bump dependencies + + ## 0.60.0 ### Features diff --git a/packages/openapi/package.json b/packages/openapi/package.json index a06d52df44..8799b2ee24 100644 --- a/packages/openapi/package.json +++ b/packages/openapi/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/openapi", - "version": "0.60.0", + "version": "0.61.0", "author": "Microsoft Corporation", "description": "TypeSpec library providing OpenAPI concepts", "homepage": "https://typespec.io", diff --git a/packages/openapi3/CHANGELOG.md b/packages/openapi3/CHANGELOG.md index 8e17476962..15517d8dea 100644 --- a/packages/openapi3/CHANGELOG.md +++ b/packages/openapi3/CHANGELOG.md @@ -1,5 +1,16 @@ # Change Log - @typespec/openapi3 +## 0.61.0 + +### Bump dependencies + +- [#4424](https://github.com/microsoft/typespec/pull/4424) Bump dependencies + +### Features + +- [#4423](https://github.com/microsoft/typespec/pull/4423) Added support to use Scalar and Object as default types + + ## 0.60.0 ### Bug Fixes diff --git a/packages/openapi3/package.json b/packages/openapi3/package.json index 28bc259281..a289307e7c 100644 --- a/packages/openapi3/package.json +++ b/packages/openapi3/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/openapi3", - "version": "0.60.0", + "version": "0.61.0", "author": "Microsoft Corporation", "description": "TypeSpec library for emitting OpenAPI 3.0 from the TypeSpec REST protocol binding and converting OpenAPI3 to TypeSpec", "homepage": "https://typespec.io", diff --git a/packages/playground/CHANGELOG.md b/packages/playground/CHANGELOG.md index d3051356e7..edcbd988ab 100644 --- a/packages/playground/CHANGELOG.md +++ b/packages/playground/CHANGELOG.md @@ -1,5 +1,20 @@ # Change Log - @typespec/playground +## 0.5.0 + +### Bug Fixes + +- [#4606](https://github.com/microsoft/typespec/pull/4606) Do not treat path as relative internally + +### Bump dependencies + +- [#4424](https://github.com/microsoft/typespec/pull/4424) Bump dependencies + +### Features + +- [#4538](https://github.com/microsoft/typespec/pull/4538) Upgrade to latest monaco-editor + + ## 0.4.2 ### Bug Fixes diff --git a/packages/playground/package.json b/packages/playground/package.json index f8d64dd3e0..7bf5d3e3e5 100644 --- a/packages/playground/package.json +++ b/packages/playground/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/playground", - "version": "0.4.2", + "version": "0.5.0", "author": "Microsoft Corporation", "description": "TypeSpec playground UI components.", "homepage": "https://typespec.io", diff --git a/packages/prettier-plugin-typespec/CHANGELOG.md b/packages/prettier-plugin-typespec/CHANGELOG.md index 97ba60e8c3..f2230b3d27 100644 --- a/packages/prettier-plugin-typespec/CHANGELOG.md +++ b/packages/prettier-plugin-typespec/CHANGELOG.md @@ -1,5 +1,12 @@ # Change Log - @typespec/prettier-plugin-typespec +## 0.61.0 + +### Bump dependencies + +- [#4424](https://github.com/microsoft/typespec/pull/4424) Bump dependencies + + ## 0.60.0 No changes, version bump only. diff --git a/packages/prettier-plugin-typespec/package.json b/packages/prettier-plugin-typespec/package.json index f27f06ded6..52a08d92b8 100644 --- a/packages/prettier-plugin-typespec/package.json +++ b/packages/prettier-plugin-typespec/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/prettier-plugin-typespec", - "version": "0.60.0", + "version": "0.61.0", "description": "", "main": "dist/index.js", "scripts": { diff --git a/packages/protobuf/CHANGELOG.md b/packages/protobuf/CHANGELOG.md index af6a5194fe..a4e8f070b4 100644 --- a/packages/protobuf/CHANGELOG.md +++ b/packages/protobuf/CHANGELOG.md @@ -1,5 +1,12 @@ # Change Log - @typespec/protobuf +## 0.61.0 + +### Bump dependencies + +- [#4424](https://github.com/microsoft/typespec/pull/4424) Bump dependencies + + ## 0.60.0 ### Features diff --git a/packages/protobuf/package.json b/packages/protobuf/package.json index 8422df5ffe..41357823cf 100644 --- a/packages/protobuf/package.json +++ b/packages/protobuf/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/protobuf", - "version": "0.60.0", + "version": "0.61.0", "author": "Microsoft Corporation", "description": "TypeSpec library and emitter for Protobuf (gRPC)", "homepage": "https://github.com/microsoft/typespec", diff --git a/packages/rest/CHANGELOG.md b/packages/rest/CHANGELOG.md index afa7e4de85..45281d1f19 100644 --- a/packages/rest/CHANGELOG.md +++ b/packages/rest/CHANGELOG.md @@ -1,5 +1,12 @@ # Change Log - @typespec/rest +## 0.61.0 + +### Bump dependencies + +- [#4424](https://github.com/microsoft/typespec/pull/4424) Bump dependencies + + ## 0.60.0 ### Features diff --git a/packages/rest/package.json b/packages/rest/package.json index 560d9df340..aa1097adfc 100644 --- a/packages/rest/package.json +++ b/packages/rest/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/rest", - "version": "0.60.0", + "version": "0.61.0", "author": "Microsoft Corporation", "description": "TypeSpec REST protocol binding", "homepage": "https://typespec.io", diff --git a/packages/sse/CHANGELOG.md b/packages/sse/CHANGELOG.md index b6a447457c..ebb9f4da1a 100644 --- a/packages/sse/CHANGELOG.md +++ b/packages/sse/CHANGELOG.md @@ -1 +1,8 @@ # Changelog - @typespec/sse + +## 0.61.0 + +### Features + +- [#4513](https://github.com/microsoft/typespec/pull/4513) Adds a new core package to describe server-sent events. + diff --git a/packages/sse/package.json b/packages/sse/package.json index 7c251fc22d..f2503bf78f 100644 --- a/packages/sse/package.json +++ b/packages/sse/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/sse", - "version": "0.60.0", + "version": "0.61.0", "author": "Microsoft Corporation", "description": "TypeSpec library providing server sent events bindings", "homepage": "https://typespec.io", diff --git a/packages/streams/CHANGELOG.md b/packages/streams/CHANGELOG.md index 87db52e4a7..7b91286dd8 100644 --- a/packages/streams/CHANGELOG.md +++ b/packages/streams/CHANGELOG.md @@ -1 +1,8 @@ # Changelog - @typespec/streams + +## 0.61.0 + +### Features + +- [#4513](https://github.com/microsoft/typespec/pull/4513) Adds a new core package for describing streams and the type of data they contain. + diff --git a/packages/streams/package.json b/packages/streams/package.json index bc902655d2..2a70ab78ee 100644 --- a/packages/streams/package.json +++ b/packages/streams/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/streams", - "version": "0.60.0", + "version": "0.61.0", "author": "Microsoft Corporation", "description": "TypeSpec library providing stream bindings", "homepage": "https://typespec.io", diff --git a/packages/tmlanguage-generator/CHANGELOG.md b/packages/tmlanguage-generator/CHANGELOG.md index 64dccf1980..aaeabf43af 100644 --- a/packages/tmlanguage-generator/CHANGELOG.md +++ b/packages/tmlanguage-generator/CHANGELOG.md @@ -1,5 +1,12 @@ # Change Log - tmlanguage-generator +## 0.5.9 + +### Bump dependencies + +- [#4424](https://github.com/microsoft/typespec/pull/4424) Bump dependencies + + ## 0.5.8 ### Bump dependencies diff --git a/packages/tmlanguage-generator/package.json b/packages/tmlanguage-generator/package.json index 3d0513b2a0..ebb072f1c2 100644 --- a/packages/tmlanguage-generator/package.json +++ b/packages/tmlanguage-generator/package.json @@ -1,6 +1,6 @@ { "name": "tmlanguage-generator", - "version": "0.5.8", + "version": "0.5.9", "author": "Microsoft Corporation", "description": "Helper library to generate TextMate syntax highlighting tmLanguage files.", "homepage": "https://github.com/microsoft/typespec/tree/main/packages/tmlanguage-generator", diff --git a/packages/typespec-vs/CHANGELOG.md b/packages/typespec-vs/CHANGELOG.md index 14194e139a..e9d6318c8c 100644 --- a/packages/typespec-vs/CHANGELOG.md +++ b/packages/typespec-vs/CHANGELOG.md @@ -1,5 +1,9 @@ # Change Log - typespec-vs +## 0.61.0 + +No changes, version bump only. + ## 0.60.0 No changes, version bump only. diff --git a/packages/typespec-vs/package.json b/packages/typespec-vs/package.json index 90cb9a96cc..14768d4b96 100644 --- a/packages/typespec-vs/package.json +++ b/packages/typespec-vs/package.json @@ -1,7 +1,7 @@ { "name": "typespec-vs", "author": "Microsoft Corporation", - "version": "0.60.0", + "version": "0.61.0", "description": "TypeSpec Language Support for Visual Studio", "homepage": "https://typespec.io", "readme": "https://github.com/microsoft/typespec/blob/main/README.md", diff --git a/packages/typespec-vscode/CHANGELOG.md b/packages/typespec-vscode/CHANGELOG.md index 401cdfffba..54c7f2259c 100644 --- a/packages/typespec-vscode/CHANGELOG.md +++ b/packages/typespec-vscode/CHANGELOG.md @@ -1,5 +1,21 @@ # Change Log - typespec-vscode +## 0.61.0 + +### Bug Fixes + +- [#4430](https://github.com/microsoft/typespec/pull/4430) Use "shell" when spawning execution of .cmd file(i.e. tsp-server.cmd) in windows + +### Bump dependencies + +- [#4424](https://github.com/microsoft/typespec/pull/4424) Bump dependencies + +### Features + +- [#4330](https://github.com/microsoft/typespec/pull/4330) Support Compile Task and Watch Task in vscode. +- [#4498](https://github.com/microsoft/typespec/pull/4498) Make extension web compatible with minimal functionality + + ## 0.60.0 No changes, version bump only. diff --git a/packages/typespec-vscode/package.json b/packages/typespec-vscode/package.json index 7f50732b85..a8794e6988 100644 --- a/packages/typespec-vscode/package.json +++ b/packages/typespec-vscode/package.json @@ -1,6 +1,6 @@ { "name": "typespec-vscode", - "version": "0.60.0", + "version": "0.61.0", "author": "Microsoft Corporation", "description": "TypeSpec language support for VS Code", "homepage": "https://typespec.io", diff --git a/packages/versioning/CHANGELOG.md b/packages/versioning/CHANGELOG.md index f686350387..ad486fd09a 100644 --- a/packages/versioning/CHANGELOG.md +++ b/packages/versioning/CHANGELOG.md @@ -1,5 +1,12 @@ # Change Log - @typespec/versioning +## 0.61.0 + +### Bump dependencies + +- [#4424](https://github.com/microsoft/typespec/pull/4424) Bump dependencies + + ## 0.60.1 ### Bug Fixes diff --git a/packages/versioning/package.json b/packages/versioning/package.json index 05e9af75aa..ba79b86ed4 100644 --- a/packages/versioning/package.json +++ b/packages/versioning/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/versioning", - "version": "0.60.0", + "version": "0.61.0", "author": "Microsoft Corporation", "description": "TypeSpec library for declaring and emitting versioned APIs", "homepage": "https://typespec.io", diff --git a/packages/website/playground-versions.json b/packages/website/playground-versions.json index fcab092f2c..4bf89b81a2 100644 --- a/packages/website/playground-versions.json +++ b/packages/website/playground-versions.json @@ -1,4 +1,5 @@ [ + "0.61.x", "0.60.x", "0.59.x", "0.58.x", diff --git a/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/variables/$lib.md b/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/variables/$lib.md index cbe951f393..3650b2262d 100644 --- a/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/variables/$lib.md +++ b/packages/website/versioned_docs/version-latest/emitters/openapi3/reference/js-api/variables/$lib.md @@ -23,8 +23,6 @@ const $lib: TypeSpecLibrary; | `inconsistent-shared-route-request-visibility.default` | "All operations with \`@sharedRoutes\` must have the same \`@requestVisibility\`." | "All operations with \`@sharedRoutes\` must have the same \`@requestVisibility\`." | | `inline-cycle` | `object` | - | | `inline-cycle.default` | `CallableMessage`<[`"type"`]\> | - | -| `invalid-default` | `object` | - | -| `invalid-default.default` | `CallableMessage`<[`"type"`]\> | - | | `invalid-format` | `object` | - | | `invalid-format.default` | `CallableMessage`<[`"value"`, `"paramType"`]\> | - | | `invalid-model-property` | `object` | - | diff --git a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/index.md b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/index.md index b12f9c2132..39bf6d574f 100644 --- a/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/index.md +++ b/packages/website/versioned_docs/version-latest/emitters/protobuf/reference/js-api/index.md @@ -14,8 +14,8 @@ title: "[P] JS API" ## Variables - [$lib](variables/$lib.md) -- [PROTO\_FULL\_IDENT](variables/PROTO_FULL_IDENT.md) - [namespace](variables/namespace.md) +- [PROTO\_FULL\_IDENT](variables/PROTO_FULL_IDENT.md) ## Functions diff --git a/packages/website/versioned_docs/version-latest/extending-typespec/basics.md b/packages/website/versioned_docs/version-latest/extending-typespec/basics.md index 05d3cb92a8..4deefa490b 100644 --- a/packages/website/versioned_docs/version-latest/extending-typespec/basics.md +++ b/packages/website/versioned_docs/version-latest/extending-typespec/basics.md @@ -75,7 +75,19 @@ Your package.json needs to refer to two main files: your Node module main file, ```jsonc "main": "dist/src/index.js", - "tspMain": "lib/main.tsp" + "exports": { + ".": { + "typespec": "./lib/main.tsp" + }, + // Additional named export are possible + "./experimental": { + "typespec": "./lib/experimental.tsp" + }, + // Wildcard export as well + "./lib/*": { + "typespec": "./lib/*.tsp" + } + } ``` ### d. Install and initialize TypeScript @@ -122,19 +134,7 @@ export const { reportDiagnostic, createDiagnostic } = $lib; Diagnostics are used for linters and decorators, which are covered in subsequent topics. -### f. Set package flags - -You can optionally set any package flags by exporting a `$flags` const that is initialized with the `definePackageFlags`. Like `$lib`, this value must be exported from your package. - -It is strongly recommended to set `valueMarshalling` to `"new"` as this will be the default behavior in future TypeSpec versions. - -```typescript -export const $flags = definePackageFlags({ - valueMarshalling: "new", -}); -``` - -### g. Create `index.ts` +### f. Create `index.ts` Open `./src/index.ts` and import your library definition: @@ -143,7 +143,7 @@ Open `./src/index.ts` and import your library definition: export { $lib } from "./lib.js"; ``` -### h. Build TypeScript +### g. Build TypeScript TypeSpec can only import JavaScript files, so any changes made to TypeScript sources need to be compiled before they are visible to TypeSpec. To do this, run `npx tsc -p .` in your library's root directory. If you want to re-run the TypeScript compiler whenever files are changed, you can run `npx tsc -p . --watch`. @@ -161,7 +161,7 @@ Alternatively, you can add these as scripts in your `package.json` to make them You can then run `npm run build` or `npm run watch` to build or watch your library. -### i. Add your main TypeSpec file +### h. Add your main TypeSpec file Open `./lib/main.tsp` and import your JS entrypoint. This ensures that when TypeSpec imports your library, the code to define the library is run. When we add decorators in later topics, this import will ensure those get exposed as well. diff --git a/packages/website/versioned_docs/version-latest/extending-typespec/emitter-metadata-handling.md b/packages/website/versioned_docs/version-latest/extending-typespec/emitter-metadata-handling.md index 6f91eef3da..70493280e7 100644 --- a/packages/website/versioned_docs/version-latest/extending-typespec/emitter-metadata-handling.md +++ b/packages/website/versioned_docs/version-latest/extending-typespec/emitter-metadata-handling.md @@ -17,7 +17,7 @@ If you're new to writing emitters, begin with the [emitter basics](./emitters-ba Next, examine the [REST metadata emitter sample](https://github.com/microsoft/typespec/tree/main/packages/samples/rest-metadata-emitter). This sample uses all of the APIs discussed below to create a simple textual representation. It intentionally avoids splitting types like the OpenAPI emitter to highlight that this is not mandatory. Instead, it includes contextual comments to indicate how data depends on context. -However, if you want your emitter to split types like OpenAPI, you can still use the same API. Cross-referencing with the official [OpenAPI emitter] where these APIs are called can also be helpful. +However, if you want your emitter to split types like OpenAPI, you can still use the same API. Cross-referencing with the official [OpenAPI emitter](../emitters/openapi3/openapi.md) where these APIs are called can also be helpful. ## Key API diff --git a/packages/website/versioned_docs/version-latest/extending-typespec/emitters-basics.md b/packages/website/versioned_docs/version-latest/extending-typespec/emitters-basics.md index 66d6f851eb..c7ea724509 100644 --- a/packages/website/versioned_docs/version-latest/extending-typespec/emitters-basics.md +++ b/packages/website/versioned_docs/version-latest/extending-typespec/emitters-basics.md @@ -5,7 +5,7 @@ title: Emitters # Creating emitters -TypeSpec emitters are libraries that utilize various TypeSpec compiler APIs to reflect on the TypeSpec compilation process and generate artifacts. The TypeSpec standard library includes an emitter for OpenAPI version 3.0. However, you might want to emit TypeSpec to a different output format. One of the main advantages of TypeSpec is its ease of use as a single source of truth for all data shapes, and the simplicity of creating an emitter contributes significantly to this. +TypeSpec emitters are libraries that utilize various TypeSpec compiler APIs to reflect on the TypeSpec compilation process and generate artifacts. The TypeSpec standard library includes emitters for OpenAPI version 3.0, JSON Schema, and Protocol Buffers (Protobuf). However, you might want to emit TypeSpec to a different output format. One of the main advantages of TypeSpec is its ease of use as a single source of truth for all data shapes, and the simplicity of creating an emitter contributes significantly to this. ## Emitter design @@ -128,6 +128,7 @@ Example: ### Configuration options convention - Name options `kebab-case`. So it can be inline with the rest of the cli +- Name options should not contain dots (`.`). Using a dot will conflict with using nested configuration values. - An option called `output-dir` can be created and should override the compiler `output-dir` #### Emitter options vs. decorators diff --git a/packages/website/versioned_docs/version-latest/handbook/configuration/configuration.md b/packages/website/versioned_docs/version-latest/handbook/configuration/configuration.md index 79948bbe35..d448452635 100644 --- a/packages/website/versioned_docs/version-latest/handbook/configuration/configuration.md +++ b/packages/website/versioned_docs/version-latest/handbook/configuration/configuration.md @@ -114,6 +114,8 @@ Here's what would be produced: #### Project Parameters A TypeSpec project file can define certain parameters that can subsequently be specified through the CLI. +Parameters can be organized in a nested structure, to access different levels of the structure, use dots (`.`) in the variable expression. +Therefore, parameter names should not contain `.` in their name. The `{cwd}` and `{project-root}` variables can be utilized in the default value of these parameters. @@ -130,7 +132,7 @@ parameters: output-dir: {base-dir}/output ``` -The parameter can then be specified via `--arg` in this format `--arg "="` +The parameter can then be specified via `--arg` in this format `--arg "="` and for nested structures `--arg ".="` ```bash tsp compile . --arg "base-dir=/path/to/base" @@ -170,6 +172,17 @@ options: ``` +Emitter options support a nested structure, enabling complex configurations. + +```yaml +options: + emitter-sub-folder: + sub-folder: bar +``` + +To set these values via the CLI, use dots to navigate deeper levels in the definition. `--option ".="` +Due to this capability, emitter option names should not contain a `.` in their name. + ## TypeSpec Configuration Options | Config | Cli | Description | diff --git a/packages/website/versioned_docs/version-latest/introduction/installation.md b/packages/website/versioned_docs/version-latest/introduction/installation.md index e219918c2f..969f8ef6d6 100644 --- a/packages/website/versioned_docs/version-latest/introduction/installation.md +++ b/packages/website/versioned_docs/version-latest/introduction/installation.md @@ -14,7 +14,17 @@ Install [Node.js 20 LTS](https://nodejs.org/en/download/) and ensure you can run npm --version ``` -We recommend using npm 7+. To update npm, run `npm install -g npm` +### Package manager + +TypeSpec uses node package linking to manage dependencies. Any package manager that produce a `node_modules` directory should work: + +- npm 7+. To update npm, run `npm install -g npm` +- pnpm +- yarn + +:::warning +Yarn will not automatically install implicit peerDependencies. TypeSpec libraries rely on this. Watch for warnings for any missing dependencies. +::: ## Install tsp diff --git a/packages/website/versioned_docs/version-latest/language-basics/imports.md b/packages/website/versioned_docs/version-latest/language-basics/imports.md index c8dfee102d..7ec9267e19 100644 --- a/packages/website/versioned_docs/version-latest/language-basics/imports.md +++ b/packages/website/versioned_docs/version-latest/language-basics/imports.md @@ -23,7 +23,7 @@ import "./decorators.js"; ## Importing a library -The import value can be the name of one of the package dependencies. In this case, TypeSpec will look for the `package.json` file and check the `tspMain` entry (defaulting to `main` if `tspMain` is absent) to determine the library entrypoint to load. +The import value can be the name of one of the package dependencies. ```typespec import "/rest"; @@ -32,12 +32,25 @@ import "/rest"; ```json // ./node_modules/@typespec/rest/package.json { - "tspMain": "./lib/main.tsp" + "exports": { + ".": { "typespec": "./lib/main.tsp" } + } } ``` This results in `./node_modules/@typespec/rest/lib/main.tsp` being imported. +### Package resolution algorithm + +When trying to import a package TypeSpec follows the following logic + +1. Parse the package name from the import specificier into `pkgName` and `subPath` (e.g. `@scope/lib/named` => pkgName: `@scope/lib` subpath: `named` ) +1. Look to see if `pkgName` is itself(Containing package) +1. Otherwise lookup for a parent folder with a `node_modules/${pkgName}` sub folder +1. Reading the `package.json` of the package + a. If `exports` is defined respect the [ESM logic](https://github.com/nodejs/node/blob/main/doc/api/esm.md) to resolve the `typespec` condition(TypeSpec will not respect the `default` condition) + b. If `exports` is not found or for back compat the `.` export is missing the `typespec` condition fallback to checking `tspMain` or `main` + ## Importing a directory If the import value is a directory, TypeSpec will check if that directory is a Node package and follow the npm package [lookup logic](#importing-a-library), or if the directory contains a `main.tsp` file. diff --git a/packages/website/versioned_docs/version-latest/libraries/events/reference/decorators.md b/packages/website/versioned_docs/version-latest/libraries/events/reference/decorators.md new file mode 100644 index 0000000000..69772a8bbd --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/events/reference/decorators.md @@ -0,0 +1,112 @@ +--- +title: "Decorators" +toc_min_heading_level: 2 +toc_max_heading_level: 3 +--- + +# Decorators + +## TypeSpec.Events + +### `@contentType` {#@TypeSpec.Events.contentType} + +Specifies the content type of the event envelope, event body, or event payload. +When applied to an event payload, that field must also have a corresponding `@data` +decorator. + +```typespec +@TypeSpec.Events.contentType(contentType: valueof string) +``` + +#### Target + +`UnionVariant | ModelProperty` + +#### Parameters + +| Name | Type | Description | +| ----------- | ---------------- | ----------- | +| contentType | `valueof string` | | + +#### Examples + +```typespec +@events +union MixedEvents { + @contentType("application/json") + message: { + id: string, + text: string, + }, +} +``` + +##### Specify the content type of the event payload. + +```typespec +@events +union MixedEvents { + { + done: true, + }, + { + done: false, + @data @contentType("text/plain") value: string, + }, +} +``` + +### `@data` {#@TypeSpec.Events.data} + +Identifies the payload of an event. +Only one field in an event can be marked as the payload. + +```typespec +@TypeSpec.Events.data +``` + +#### Target + +`ModelProperty` + +#### Parameters + +None + +#### Examples + +```typespec +@events +union MixedEvents { + { + metadata: Record, + @data payload: string, + }, +} +``` + +### `@events` {#@TypeSpec.Events.events} + +Specify that this union describes a set of events. + +```typespec +@TypeSpec.Events.events +``` + +#### Target + +`Union` + +#### Parameters + +None + +#### Examples + +```typespec +@events +union MixedEvents { + pingEvent: string, + doneEvent: "done", +} +``` diff --git a/packages/website/versioned_docs/version-latest/libraries/events/reference/index.mdx b/packages/website/versioned_docs/version-latest/libraries/events/reference/index.mdx new file mode 100644 index 0000000000..514d08760f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/events/reference/index.mdx @@ -0,0 +1,40 @@ +--- +title: Overview +sidebar_position: 0 +toc_min_heading_level: 2 +toc_max_heading_level: 3 +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Overview + +TypeSpec library providing events bindings + +## Install + + + + +```bash +npm install @typespec/events +``` + + + + +```bash +npm install --save-peer @typespec/events +``` + + + + +## TypeSpec.Events + +### Decorators + +- [`@contentType`](./decorators.md#@TypeSpec.Events.contentType) +- [`@data`](./decorators.md#@TypeSpec.Events.data) +- [`@events`](./decorators.md#@TypeSpec.Events.events) diff --git a/packages/website/versioned_docs/version-latest/libraries/events/reference/js-api/_category_.json b/packages/website/versioned_docs/version-latest/libraries/events/reference/js-api/_category_.json new file mode 100644 index 0000000000..bc91d15cee --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/events/reference/js-api/_category_.json @@ -0,0 +1 @@ +{"label":"JS API","link":{"type":"doc","id":"index"}} \ No newline at end of file diff --git a/packages/website/versioned_docs/version-latest/libraries/events/reference/js-api/functions/$onValidate.md b/packages/website/versioned_docs/version-latest/libraries/events/reference/js-api/functions/$onValidate.md new file mode 100644 index 0000000000..42cb14e224 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/events/reference/js-api/functions/$onValidate.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] $onValidate" + +--- +```ts +function $onValidate(program): void +``` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `program` | `Program` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/libraries/events/reference/js-api/functions/getContentType.md b/packages/website/versioned_docs/version-latest/libraries/events/reference/js-api/functions/getContentType.md new file mode 100644 index 0000000000..e90588f975 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/events/reference/js-api/functions/getContentType.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getContentType" + +--- +```ts +function getContentType(program, type): undefined | string +``` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `program` | `Program` | +| `type` | `ModelProperty` \| `UnionVariant` | + +## Returns + +`undefined` \| `string` diff --git a/packages/website/versioned_docs/version-latest/libraries/events/reference/js-api/functions/isEventData.md b/packages/website/versioned_docs/version-latest/libraries/events/reference/js-api/functions/isEventData.md new file mode 100644 index 0000000000..23347f446c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/events/reference/js-api/functions/isEventData.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] isEventData" + +--- +```ts +function isEventData(program, type): boolean +``` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `program` | `Program` | +| `type` | `ModelProperty` | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/libraries/events/reference/js-api/functions/isEvents.md b/packages/website/versioned_docs/version-latest/libraries/events/reference/js-api/functions/isEvents.md new file mode 100644 index 0000000000..8304000715 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/events/reference/js-api/functions/isEvents.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] isEvents" + +--- +```ts +function isEvents(program, type): boolean +``` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `program` | `Program` | +| `type` | `Union` | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/libraries/events/reference/js-api/index.md b/packages/website/versioned_docs/version-latest/libraries/events/reference/js-api/index.md new file mode 100644 index 0000000000..6d48fc8951 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/events/reference/js-api/index.md @@ -0,0 +1,16 @@ +--- +jsApi: true +title: "[P] JS API" + +--- +## Variables + +- [$decorators](variables/$decorators.md) +- [$lib](variables/$lib.md) + +## Functions + +- [$onValidate](functions/$onValidate.md) +- [getContentType](functions/getContentType.md) +- [isEventData](functions/isEventData.md) +- [isEvents](functions/isEvents.md) diff --git a/packages/website/versioned_docs/version-latest/libraries/events/reference/js-api/variables/$decorators.md b/packages/website/versioned_docs/version-latest/libraries/events/reference/js-api/variables/$decorators.md new file mode 100644 index 0000000000..c0066753dc --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/events/reference/js-api/variables/$decorators.md @@ -0,0 +1,17 @@ +--- +jsApi: true +title: "[V] $decorators" + +--- +```ts +const $decorators: object; +``` + +## Type declaration + +| Name | Type | Default value | +| ------ | ------ | ------ | +| `TypeSpec.Events` | `object` | - | +| `TypeSpec.Events.contentType` | `ContentTypeDecorator` | $contentTypeDecorator | +| `TypeSpec.Events.data` | `DataDecorator` | $dataDecorator | +| `TypeSpec.Events.events` | `EventsDecorator` | $eventsDecorator | diff --git a/packages/website/versioned_docs/version-latest/libraries/events/reference/js-api/variables/$lib.md b/packages/website/versioned_docs/version-latest/libraries/events/reference/js-api/variables/$lib.md new file mode 100644 index 0000000000..0371a6bd00 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/events/reference/js-api/variables/$lib.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[V] $lib" + +--- +```ts +const $lib: TypeSpecLibrary, "data" | "events" | "contentType">; +``` + +## Type declaration + +| Name | Type | +| ------ | ------ | +| `invalid-content-type-target` | `object` | +| `invalid-content-type-target.default` | `"@contentType can only be specified on the top-level event envelope, or the event payload marked with @data"` | +| `multiple-event-payloads` | `object` | +| `multiple-event-payloads.default` | `CallableMessage`<[`"dataPath"`, `"currentPath"`]\> | +| `multiple-event-payloads.payloadInIndexedModel` | `CallableMessage`<[`"dataPath"`]\> | diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/index.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/index.md index d096fa1aac..efcb844348 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/index.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/index.md @@ -41,9 +41,9 @@ title: "[P] JS API" - [MetadataInfoOptions](interfaces/MetadataInfoOptions.md) - [NoAuth](interfaces/NoAuth.md) - [NoHttpAuthRef](interfaces/NoHttpAuthRef.md) +- [Oauth2Auth](interfaces/Oauth2Auth.md) - [OAuth2HttpAuthRef](interfaces/OAuth2HttpAuthRef.md) - [OAuth2Scope](interfaces/OAuth2Scope.md) -- [Oauth2Auth](interfaces/Oauth2Auth.md) - [OpenIDConnectAuth](interfaces/OpenIDConnectAuth.md) - [OperationParameterOptions](interfaces/OperationParameterOptions.md) - [PasswordFlow](interfaces/PasswordFlow.md) @@ -104,9 +104,9 @@ title: "[P] JS API" - [$sharedRoute](functions/$sharedRoute.md) - [$statusCode](functions/$statusCode.md) - [$useAuth](functions/$useAuth.md) -- [DefaultRouteProducer](functions/DefaultRouteProducer.md) - [addQueryParamsToUriTemplate](functions/addQueryParamsToUriTemplate.md) - [createMetadataInfo](functions/createMetadataInfo.md) +- [DefaultRouteProducer](functions/DefaultRouteProducer.md) - [getAllHttpServices](functions/getAllHttpServices.md) - [getAllRoutes](functions/getAllRoutes.md) - [getAuthentication](functions/getAuthentication.md) diff --git a/packages/website/versioned_docs/version-latest/libraries/sse/reference/data-types.md b/packages/website/versioned_docs/version-latest/libraries/sse/reference/data-types.md new file mode 100644 index 0000000000..d322877397 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/sse/reference/data-types.md @@ -0,0 +1,71 @@ +--- +title: "Data types" +toc_min_heading_level: 2 +toc_max_heading_level: 3 +--- + +# Data types + +## TypeSpec.SSE + +### `SSEStream` {#TypeSpec.SSE.SSEStream} + +Describes a stream of server-sent events. + +The content-type is set to `text/event-stream`. + +The server-sent events are described by `Type`. +The event type for any event can be defined by using named union variants. +When a union variant is not named, it is considered a 'message' event. + +```typespec +model TypeSpec.SSE.SSEStream +``` + +#### Template Parameters + +| Name | Description | +| ---- | ---------------------------------------------------- | +| Type | The set of models describing the server-sent events. | + +#### Examples + +##### Mix of named union variants and terminal event + +```typespec +model UserConnect { + username: string; + time: string; +} + +model UserMessage { + username: string; + time: string; + text: string; +} + +model UserDisconnect { + username: string; + time: string; +} + +@TypeSpec.Events.events +union ChannelEvents { + userconnect: UserConnect, + usermessage: UserMessage, + userdisconnect: UserDisconnect, + + @Events.contentType("text/plain") + @terminalEvent + "[unsubscribe]", +} + +op subscribeToChannel(): SSEStream; +``` + +#### Properties + +| Name | Type | Description | +| ----------- | --------------------- | ----------- | +| contentType | `"text/event-stream"` | | +| body | `string` | | diff --git a/packages/website/versioned_docs/version-latest/libraries/sse/reference/decorators.md b/packages/website/versioned_docs/version-latest/libraries/sse/reference/decorators.md new file mode 100644 index 0000000000..a92b00db99 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/sse/reference/decorators.md @@ -0,0 +1,26 @@ +--- +title: "Decorators" +toc_min_heading_level: 2 +toc_max_heading_level: 3 +--- + +# Decorators + +## TypeSpec.SSE + +### `@terminalEvent` {#@TypeSpec.SSE.terminalEvent} + +Indicates that the presence of this event is a terminal event, +and the client should disconnect from the server. + +```typespec +@TypeSpec.SSE.terminalEvent +``` + +#### Target + +`UnionVariant` + +#### Parameters + +None diff --git a/packages/website/versioned_docs/version-latest/libraries/sse/reference/index.mdx b/packages/website/versioned_docs/version-latest/libraries/sse/reference/index.mdx new file mode 100644 index 0000000000..fd60078eb0 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/sse/reference/index.mdx @@ -0,0 +1,42 @@ +--- +title: Overview +sidebar_position: 0 +toc_min_heading_level: 2 +toc_max_heading_level: 3 +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Overview + +TypeSpec library providing server sent events bindings + +## Install + + + + +```bash +npm install @typespec/sse +``` + + + + +```bash +npm install --save-peer @typespec/sse +``` + + + + +## TypeSpec.SSE + +### Decorators + +- [`@terminalEvent`](./decorators.md#@TypeSpec.SSE.terminalEvent) + +### Models + +- [`SSEStream`](./data-types.md#TypeSpec.SSE.SSEStream) diff --git a/packages/website/versioned_docs/version-latest/libraries/sse/reference/js-api/_category_.json b/packages/website/versioned_docs/version-latest/libraries/sse/reference/js-api/_category_.json new file mode 100644 index 0000000000..bc91d15cee --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/sse/reference/js-api/_category_.json @@ -0,0 +1 @@ +{"label":"JS API","link":{"type":"doc","id":"index"}} \ No newline at end of file diff --git a/packages/website/versioned_docs/version-latest/libraries/sse/reference/js-api/functions/$onValidate.md b/packages/website/versioned_docs/version-latest/libraries/sse/reference/js-api/functions/$onValidate.md new file mode 100644 index 0000000000..42cb14e224 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/sse/reference/js-api/functions/$onValidate.md @@ -0,0 +1,18 @@ +--- +jsApi: true +title: "[F] $onValidate" + +--- +```ts +function $onValidate(program): void +``` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `program` | `Program` | + +## Returns + +`void` diff --git a/packages/website/versioned_docs/version-latest/libraries/sse/reference/js-api/functions/isTerminalEvent.md b/packages/website/versioned_docs/version-latest/libraries/sse/reference/js-api/functions/isTerminalEvent.md new file mode 100644 index 0000000000..3768ba2b78 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/sse/reference/js-api/functions/isTerminalEvent.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] isTerminalEvent" + +--- +```ts +function isTerminalEvent(program, type): boolean +``` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `program` | `Program` | +| `type` | `UnionVariant` | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/libraries/sse/reference/js-api/index.md b/packages/website/versioned_docs/version-latest/libraries/sse/reference/js-api/index.md new file mode 100644 index 0000000000..936afed43c --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/sse/reference/js-api/index.md @@ -0,0 +1,14 @@ +--- +jsApi: true +title: "[P] JS API" + +--- +## Variables + +- [$decorators](variables/$decorators.md) +- [$lib](variables/$lib.md) + +## Functions + +- [$onValidate](functions/$onValidate.md) +- [isTerminalEvent](functions/isTerminalEvent.md) diff --git a/packages/website/versioned_docs/version-latest/libraries/sse/reference/js-api/variables/$decorators.md b/packages/website/versioned_docs/version-latest/libraries/sse/reference/js-api/variables/$decorators.md new file mode 100644 index 0000000000..bb7ea97f70 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/sse/reference/js-api/variables/$decorators.md @@ -0,0 +1,15 @@ +--- +jsApi: true +title: "[V] $decorators" + +--- +```ts +const $decorators: object; +``` + +## Type declaration + +| Name | Type | Default value | +| ------ | ------ | ------ | +| `TypeSpec.SSE` | `object` | - | +| `TypeSpec.SSE.terminalEvent` | `TerminalEventDecorator` | $terminalEventDecorator | diff --git a/packages/website/versioned_docs/version-latest/libraries/sse/reference/js-api/variables/$lib.md b/packages/website/versioned_docs/version-latest/libraries/sse/reference/js-api/variables/$lib.md new file mode 100644 index 0000000000..5aa5ba8c66 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/sse/reference/js-api/variables/$lib.md @@ -0,0 +1,15 @@ +--- +jsApi: true +title: "[V] $lib" + +--- +```ts +const $lib: TypeSpecLibrary, "terminalEvent">; +``` + +## Type declaration + +| Name | Type | Default value | +| ------ | ------ | ------ | +| `terminal-event-not-in-events` | `object` | - | +| `terminal-event-not-in-events.default` | `"A field marked as '@terminalEvent' must be a member of a type decorated with '@TpeSpec.Events.events'."` | "A field marked as '@terminalEvent' must be a member of a type decorated with '@TpeSpec.Events.events'." | diff --git a/packages/website/versioned_docs/version-latest/libraries/stream/reference/data-types.md b/packages/website/versioned_docs/version-latest/libraries/stream/reference/data-types.md new file mode 100644 index 0000000000..6b52f0434f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/stream/reference/data-types.md @@ -0,0 +1,31 @@ +--- +title: "Data types" +toc_min_heading_level: 2 +toc_max_heading_level: 3 +--- + +# Data types + +## TypeSpec.Streams + +### `Stream` {#TypeSpec.Streams.Stream} + +Defines a model that represents a stream protocol type whose data is described +by `Type`. + +This can be useful when the underlying data type is not relevant, or to serve as +a base type for custom streams. + +```typespec +model TypeSpec.Streams.Stream +``` + +#### Template Parameters + +| Name | Description | +| ---- | ------------------------------ | +| Type | The type of the stream's data. | + +#### Properties + +None diff --git a/packages/website/versioned_docs/version-latest/libraries/stream/reference/decorators.md b/packages/website/versioned_docs/version-latest/libraries/stream/reference/decorators.md new file mode 100644 index 0000000000..7baec7a7bb --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/stream/reference/decorators.md @@ -0,0 +1,42 @@ +--- +title: "Decorators" +toc_min_heading_level: 2 +toc_max_heading_level: 3 +--- + +# Decorators + +## TypeSpec.Streams + +### `@streamOf` {#@TypeSpec.Streams.streamOf} + +Specify that a model represents a stream protocol type whose data is described +by `Type`. + +```typespec +@TypeSpec.Streams.streamOf(type: unknown) +``` + +#### Target + +`Model` + +#### Parameters + +| Name | Type | Description | +| ---- | --------- | ------------------------------------------------------- | +| type | `unknown` | The type that models the underlying data of the stream. | + +#### Examples + +```typespec +model Message { + id: string; + text: string; +} + +@streamOf(Message) +model Response { + @body body: string; +} +``` diff --git a/packages/website/versioned_docs/version-latest/libraries/stream/reference/index.mdx b/packages/website/versioned_docs/version-latest/libraries/stream/reference/index.mdx new file mode 100644 index 0000000000..854a1d24a3 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/stream/reference/index.mdx @@ -0,0 +1,42 @@ +--- +title: Overview +sidebar_position: 0 +toc_min_heading_level: 2 +toc_max_heading_level: 3 +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Overview + +TypeSpec library providing stream bindings + +## Install + + + + +```bash +npm install @typespec/streams +``` + + + + +```bash +npm install --save-peer @typespec/streams +``` + + + + +## TypeSpec.Streams + +### Decorators + +- [`@streamOf`](./decorators.md#@TypeSpec.Streams.streamOf) + +### Models + +- [`Stream`](./data-types.md#TypeSpec.Streams.Stream) diff --git a/packages/website/versioned_docs/version-latest/libraries/streams/reference/data-types.md b/packages/website/versioned_docs/version-latest/libraries/streams/reference/data-types.md new file mode 100644 index 0000000000..6b52f0434f --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/streams/reference/data-types.md @@ -0,0 +1,31 @@ +--- +title: "Data types" +toc_min_heading_level: 2 +toc_max_heading_level: 3 +--- + +# Data types + +## TypeSpec.Streams + +### `Stream` {#TypeSpec.Streams.Stream} + +Defines a model that represents a stream protocol type whose data is described +by `Type`. + +This can be useful when the underlying data type is not relevant, or to serve as +a base type for custom streams. + +```typespec +model TypeSpec.Streams.Stream +``` + +#### Template Parameters + +| Name | Description | +| ---- | ------------------------------ | +| Type | The type of the stream's data. | + +#### Properties + +None diff --git a/packages/website/versioned_docs/version-latest/libraries/streams/reference/decorators.md b/packages/website/versioned_docs/version-latest/libraries/streams/reference/decorators.md new file mode 100644 index 0000000000..7baec7a7bb --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/streams/reference/decorators.md @@ -0,0 +1,42 @@ +--- +title: "Decorators" +toc_min_heading_level: 2 +toc_max_heading_level: 3 +--- + +# Decorators + +## TypeSpec.Streams + +### `@streamOf` {#@TypeSpec.Streams.streamOf} + +Specify that a model represents a stream protocol type whose data is described +by `Type`. + +```typespec +@TypeSpec.Streams.streamOf(type: unknown) +``` + +#### Target + +`Model` + +#### Parameters + +| Name | Type | Description | +| ---- | --------- | ------------------------------------------------------- | +| type | `unknown` | The type that models the underlying data of the stream. | + +#### Examples + +```typespec +model Message { + id: string; + text: string; +} + +@streamOf(Message) +model Response { + @body body: string; +} +``` diff --git a/packages/website/versioned_docs/version-latest/libraries/streams/reference/index.mdx b/packages/website/versioned_docs/version-latest/libraries/streams/reference/index.mdx new file mode 100644 index 0000000000..854a1d24a3 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/streams/reference/index.mdx @@ -0,0 +1,42 @@ +--- +title: Overview +sidebar_position: 0 +toc_min_heading_level: 2 +toc_max_heading_level: 3 +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Overview + +TypeSpec library providing stream bindings + +## Install + + + + +```bash +npm install @typespec/streams +``` + + + + +```bash +npm install --save-peer @typespec/streams +``` + + + + +## TypeSpec.Streams + +### Decorators + +- [`@streamOf`](./decorators.md#@TypeSpec.Streams.streamOf) + +### Models + +- [`Stream`](./data-types.md#TypeSpec.Streams.Stream) diff --git a/packages/website/versioned_docs/version-latest/libraries/streams/reference/js-api/_category_.json b/packages/website/versioned_docs/version-latest/libraries/streams/reference/js-api/_category_.json new file mode 100644 index 0000000000..bc91d15cee --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/streams/reference/js-api/_category_.json @@ -0,0 +1 @@ +{"label":"JS API","link":{"type":"doc","id":"index"}} \ No newline at end of file diff --git a/packages/website/versioned_docs/version-latest/libraries/streams/reference/js-api/functions/getStreamOf.md b/packages/website/versioned_docs/version-latest/libraries/streams/reference/js-api/functions/getStreamOf.md new file mode 100644 index 0000000000..66c8a8770a --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/streams/reference/js-api/functions/getStreamOf.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] getStreamOf" + +--- +```ts +function getStreamOf(program, type): undefined | Type +``` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `program` | `Program` | +| `type` | `Model` | + +## Returns + +`undefined` \| `Type` diff --git a/packages/website/versioned_docs/version-latest/libraries/streams/reference/js-api/functions/isStream.md b/packages/website/versioned_docs/version-latest/libraries/streams/reference/js-api/functions/isStream.md new file mode 100644 index 0000000000..b77f4980ca --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/streams/reference/js-api/functions/isStream.md @@ -0,0 +1,19 @@ +--- +jsApi: true +title: "[F] isStream" + +--- +```ts +function isStream(program, target): boolean +``` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `program` | `Program` | +| `target` | `Model` | + +## Returns + +`boolean` diff --git a/packages/website/versioned_docs/version-latest/libraries/streams/reference/js-api/index.md b/packages/website/versioned_docs/version-latest/libraries/streams/reference/js-api/index.md new file mode 100644 index 0000000000..8c2c4836bb --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/streams/reference/js-api/index.md @@ -0,0 +1,14 @@ +--- +jsApi: true +title: "[P] JS API" + +--- +## Variables + +- [$decorators](variables/$decorators.md) +- [$lib](variables/$lib.md) + +## Functions + +- [getStreamOf](functions/getStreamOf.md) +- [isStream](functions/isStream.md) diff --git a/packages/website/versioned_docs/version-latest/libraries/streams/reference/js-api/variables/$decorators.md b/packages/website/versioned_docs/version-latest/libraries/streams/reference/js-api/variables/$decorators.md new file mode 100644 index 0000000000..ebf970ef8b --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/streams/reference/js-api/variables/$decorators.md @@ -0,0 +1,15 @@ +--- +jsApi: true +title: "[V] $decorators" + +--- +```ts +const $decorators: object; +``` + +## Type declaration + +| Name | Type | Default value | +| ------ | ------ | ------ | +| `TypeSpec.Streams` | `object` | - | +| `TypeSpec.Streams.streamOf` | `StreamOfDecorator` | $streamOfDecorator | diff --git a/packages/website/versioned_docs/version-latest/libraries/streams/reference/js-api/variables/$lib.md b/packages/website/versioned_docs/version-latest/libraries/streams/reference/js-api/variables/$lib.md new file mode 100644 index 0000000000..a2774ad9b5 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/libraries/streams/reference/js-api/variables/$lib.md @@ -0,0 +1,8 @@ +--- +jsApi: true +title: "[V] $lib" + +--- +```ts +const $lib: TypeSpecLibrary, "streamOf">; +``` diff --git a/packages/website/versioned_docs/version-latest/release-notes/release-2024-10-09.md b/packages/website/versioned_docs/version-latest/release-notes/release-2024-10-09.md new file mode 100644 index 0000000000..bc8425df22 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/release-notes/release-2024-10-09.md @@ -0,0 +1,90 @@ +--- +title: 0.61 - October 2024 +--- + +:::warning +This release contains breaking changes +::: + +## Breaking Changes + +### @typespec/compiler + +- [#4539](https://github.com/microsoft/typespec/pull/4539) Config parameters and emitters options cannot contains `.`. This conflict with newly added support for nested options. +- [#4500](https://github.com/microsoft/typespec/pull/4500) API: Update default of `decoratorArgMarshalling` from `legacy` to `new` + +To revert to the old behavior export the following. **Highly discouraged, this will be removed in a few versions.** + +```ts +export const $flags = definePackageFlags({ + decoratorArgMarshalling: "legacy", +}); +``` + +- TypeSpec compiler expect the entrypoint to be an absolute path. This used to work with some alternative `CompilerHost` that handled relative path but this is no longer supported due to the new `exports` field support. + +## Features + +### @typespec/compiler + +- [#4442](https://github.com/microsoft/typespec/pull/4442) Library diagnostic can now define a `description` and `url` that links to a more detailed doc for this diagnostic +- [#4290](https://github.com/microsoft/typespec/pull/4290) Adding experimental (unstable) API fro Type Mutators +- [#4595](https://github.com/microsoft/typespec/pull/4595) Expose more accurate `PackageJson` type and deprecate `NodePackage` +- [#4606](https://github.com/microsoft/typespec/pull/4606) Add support for node `exports` field. Specific typespec exports can be provided with the `typespec` field + +```json +"exports": { + ".": { + "typespec": "./lib/main.tsp", + }, + "./named": { + "typespec": "./lib/named.tsp", + } +} +``` + +- [#4539](https://github.com/microsoft/typespec/pull/4539) Support nested emitter options + +### @typespec/http + +- [#4513](https://github.com/microsoft/typespec/pull/4513) Adds HttpStream and JsonlStream models to to support streaming use-cases. + +### @typespec/openapi3 + +- [#4423](https://github.com/microsoft/typespec/pull/4423) Added support to use Scalar and Object as default types + +### @typespec/json-schema + +- [#4447](https://github.com/microsoft/typespec/pull/4447) Example set with `@example` decorator will populate the schema `examples` property + +### typespec-vscode + +- [#4330](https://github.com/microsoft/typespec/pull/4330) Support Compile Task and Watch Task in vscode. +- [#4498](https://github.com/microsoft/typespec/pull/4498) Make extension web compatible with minimal functionality + +## Bug Fixes + +### @typespec/compiler + +- [#4513](https://github.com/microsoft/typespec/pull/4513) Fixes issue with the semantic walker where `exitTuple` was not being emitted. +- [#4462](https://github.com/microsoft/typespec/pull/4462) Fix examples with enums inside of unions +- [#4574](https://github.com/microsoft/typespec/pull/4574) Fix: Passing `const` of model type to `@example` +- [#4551](https://github.com/microsoft/typespec/pull/4551) Json serialization of example respect `@encodedName` +- [#4514](https://github.com/microsoft/typespec/pull/4514) Fix issue with decimal numeric and leading `0.0` with multiple digit +- [#4445](https://github.com/microsoft/typespec/pull/4445) [API] model `sourceModels` property are now projected correctly +- [#4467](https://github.com/microsoft/typespec/pull/4467) Changing tspconfig.yaml won't take effect in LSP server because of the cache +- [#4563](https://github.com/microsoft/typespec/pull/4563) `tsp compile --watch` reread from `tspconfig.yaml` file +- [#4626](https://github.com/microsoft/typespec/pull/4626) [API] Add missing exit callback + +### @typespec/openapi + +- [#4505](https://github.com/microsoft/typespec/pull/4505) `@info` decorator validate no extra properties not starting with `x-` are provided. +- [#4483](https://github.com/microsoft/typespec/pull/4483) `@info` decorator validate `termsOfService` is a valid url + +### @typespec/internal-build-utils + +- [#4498](https://github.com/microsoft/typespec/pull/4498) Ignore test from third party notice generation + +### typespec-vscode + +- [#4430](https://github.com/microsoft/typespec/pull/4430) Use "shell" when spawning execution of .cmd file(i.e. tsp-server.cmd) in windows diff --git a/packages/website/versioned_docs/version-latest/standard-library/diags/triple-quote-indent.md b/packages/website/versioned_docs/version-latest/standard-library/diags/triple-quote-indent.md new file mode 100644 index 0000000000..794dbc3626 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/diags/triple-quote-indent.md @@ -0,0 +1,25 @@ +--- +title: triple-quote-indent +--- + +Triple quoted strings must all be at least indented to the same level as closing `"""`. + +#### ❌ Incorrect + +```tsp +const a = """ +one + two + """; +``` + +#### ✅ Correct + +```tsp +const a = """ + one + two + """; +``` + +This would result in the following string `"one\n two\n"`. diff --git a/packages/website/versioned_docs/version-latest/standard-library/examples.md b/packages/website/versioned_docs/version-latest/standard-library/examples.md index afbfaccffb..7ee382b624 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/examples.md +++ b/packages/website/versioned_docs/version-latest/standard-library/examples.md @@ -65,6 +65,18 @@ model Pet { } ``` +### Define typed examples using `const` + +```tsp +const petExample: Pet = #{ name: "Max", age: 3 }; + +@example(petExample) +model Pet { + name: string; + age: int32; +} +``` + ## Operation examples Operation example are provided with the `@opExample` decorator. Similar to the `@example` decorator the first argument is the example value however it takes both the `parameters` and `returnType` example. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/DuplicateTracker.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/DuplicateTracker.md index baa149a44c..49402e7442 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/DuplicateTracker.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/classes/DuplicateTracker.md @@ -29,14 +29,14 @@ new DuplicateTracker(): DuplicateTracker ### entries() ```ts -entries(): Iterable<[K, V[]]> +entries(): Iterable<[K, V[]], any, any> ``` Return iterator of all the duplicate entries. #### Returns -`Iterable`<[`K`, `V`[]]\> +`Iterable`<[`K`, `V`[]], `any`, `any`\> *** diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/Token.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/Token.md index 4e9d6a9010..70b09b710a 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/Token.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/Token.md @@ -63,10 +63,10 @@ title: "[E] Token" | `NewLine` | `11` | | `None` | `0` | | `NumericLiteral` | `4` | -| `OpKeyword` | `57` | | `OpenBrace` | `17` | | `OpenBracket` | `21` | | `OpenParen` | `19` | +| `OpKeyword` | `57` | | `Plus` | `42` | | `ProjectionKeyword` | `63` | | `Question` | `32` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/checkFormatCadl.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/checkFormatCadl.md index 353c73c399..551d554131 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/checkFormatCadl.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/checkFormatCadl.md @@ -18,6 +18,8 @@ function checkFormatCadl(code, prettierConfig?): Promise `Promise`<`boolean`\> +true if code is formatted correctly. + ## Deprecated use checkFormatTypeSpec diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createCadlLibrary.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createCadlLibrary.md index 5ccd217e75..7cd85584a2 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createCadlLibrary.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/createCadlLibrary.md @@ -25,6 +25,25 @@ function createCadlLibrary(lib): TypeSpecLibrary [`TypeSpecLibrary`](../interfaces/TypeSpecLibrary.md)<`T`, `E`, `State`\> +Library with utility functions. + ## Deprecated use createTypeSpecLibrary + +## Tutorial + +Create the lib object with `as const` to get the full typing. + +## Example + +```ts +const libDef = { + name: "myLib", + diagnostics: { + "my-code": {serverity: "error", messages: {default: "Foo bar"}} + }, +} as const; + +const lib = createTypeSpecLibrary(libDef); +``` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getEncode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getEncode.md index 92e5aba31c..6583a295e8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getEncode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getEncode.md @@ -4,7 +4,7 @@ title: "[F] getEncode" --- ```ts -function getEncode(program, target): EncodeData | undefined +function getEncode(program, type): undefined | EncodeData ``` ## Parameters @@ -12,8 +12,8 @@ function getEncode(program, target): EncodeData | undefined | Parameter | Type | | ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | -| `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | +| `type` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | ## Returns -[`EncodeData`](../interfaces/EncodeData.md) \| `undefined` +`undefined` \| [`EncodeData`](../interfaces/EncodeData.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFormat.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFormat.md index ef3b1fc08d..8e9593a1aa 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFormat.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFormat.md @@ -4,7 +4,7 @@ title: "[F] getFormat" --- ```ts -function getFormat(program, target): string | undefined +function getFormat(program, type): undefined | string ``` ## Parameters @@ -12,8 +12,8 @@ function getFormat(program, target): string | undefined | Parameter | Type | | ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | -| `target` | [`Type`](../type-aliases/Type.md) | +| `type` | [`Type`](../type-aliases/Type.md) | ## Returns -`string` \| `undefined` +`undefined` \| `string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFriendlyName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFriendlyName.md index a4eb4c881e..334331650f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFriendlyName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getFriendlyName.md @@ -4,7 +4,7 @@ title: "[F] getFriendlyName" --- ```ts -function getFriendlyName(program, target): string +function getFriendlyName(program, type): undefined | string ``` ## Parameters @@ -12,8 +12,8 @@ function getFriendlyName(program, target): string | Parameter | Type | | ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | -| `target` | [`Type`](../type-aliases/Type.md) | +| `type` | [`Type`](../type-aliases/Type.md) | ## Returns -`string` +`undefined` \| `string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getKeyName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getKeyName.md index ab907b95df..b3d0a44954 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getKeyName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getKeyName.md @@ -4,7 +4,7 @@ title: "[F] getKeyName" --- ```ts -function getKeyName(program, property): string +function getKeyName(program, property): string | undefined ``` ## Parameters @@ -16,4 +16,4 @@ function getKeyName(program, property): string ## Returns -`string` +`string` \| `undefined` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getKnownValues.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getKnownValues.md index 054feb1151..f6dd624b4b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getKnownValues.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getKnownValues.md @@ -4,7 +4,7 @@ title: "[F] getKnownValues" --- ```ts -function getKnownValues(program, target): Enum | undefined +function getKnownValues(program, type): undefined | Enum ``` ## Parameters @@ -12,8 +12,8 @@ function getKnownValues(program, target): Enum | undefined | Parameter | Type | | ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | -| `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | +| `type` | [`Type`](../type-aliases/Type.md) | ## Returns -[`Enum`](../interfaces/Enum.md) \| `undefined` +`undefined` \| [`Enum`](../interfaces/Enum.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverloadedOperation.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverloadedOperation.md index 552a593274..669354ba4e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverloadedOperation.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverloadedOperation.md @@ -4,20 +4,16 @@ title: "[F] getOverloadedOperation" --- ```ts -function getOverloadedOperation(program, operation): Operation | undefined +function getOverloadedOperation(program, type): undefined | Operation ``` -If the given operation overloads another operation, return that operation. - ## Parameters -| Parameter | Type | Description | -| ------ | ------ | ------ | -| `program` | [`Program`](../interfaces/Program.md) | Program | -| `operation` | [`Operation`](../interfaces/Operation.md) | The operation to check for an overload target. | +| Parameter | Type | +| ------ | ------ | +| `program` | [`Program`](../interfaces/Program.md) | +| `type` | [`Operation`](../interfaces/Operation.md) | ## Returns -[`Operation`](../interfaces/Operation.md) \| `undefined` - -The operation this operation overloads, if any. +`undefined` \| [`Operation`](../interfaces/Operation.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverloads.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverloads.md index 6a301c2e97..462a05428c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverloads.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getOverloads.md @@ -4,20 +4,16 @@ title: "[F] getOverloads" --- ```ts -function getOverloads(program, operation): Operation[] | undefined +function getOverloads(program, type): undefined | Operation[] ``` -Get all operations that are marked as overloads of the given operation - ## Parameters -| Parameter | Type | Description | -| ------ | ------ | ------ | -| `program` | [`Program`](../interfaces/Program.md) | Program | -| `operation` | [`Operation`](../interfaces/Operation.md) | Operation | +| Parameter | Type | +| ------ | ------ | +| `program` | [`Program`](../interfaces/Program.md) | +| `type` | [`Operation`](../interfaces/Operation.md) | ## Returns -[`Operation`](../interfaces/Operation.md)[] \| `undefined` - -An array of operations that overload the given operation. +`undefined` \| [`Operation`](../interfaces/Operation.md)[] diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getParameterVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getParameterVisibility.md index d35acc4ba3..aad949409b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getParameterVisibility.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getParameterVisibility.md @@ -4,22 +4,16 @@ title: "[F] getParameterVisibility" --- ```ts -function getParameterVisibility(program, entity): string[] | undefined +function getParameterVisibility(program, type): undefined | string[] ``` -Returns the visibilities of the parameters of the given operation, if provided with `@parameterVisibility`. - ## Parameters | Parameter | Type | | ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | -| `entity` | [`Operation`](../interfaces/Operation.md) | +| `type` | [`Type`](../type-aliases/Type.md) | ## Returns -`string`[] \| `undefined` - -## See - -[$parameterVisibility]($parameterVisibility.md) +`undefined` \| `string`[] diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPatternData.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPatternData.md index 75f6df6b66..97dc72e9a6 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPatternData.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPatternData.md @@ -4,21 +4,16 @@ title: "[F] getPatternData" --- ```ts -function getPatternData(program, target): PatternData | undefined +function getPatternData(program, type): undefined | PatternData ``` -Gets the associated pattern data, including the pattern regular expression and optional validation message, if any -has been set. - ## Parameters -| Parameter | Type | Description | -| ------ | ------ | ------ | -| `program` | [`Program`](../interfaces/Program.md) | the Program containing the target Type | -| `target` | [`Type`](../type-aliases/Type.md) | the type to get the pattern data for | +| Parameter | Type | +| ------ | ------ | +| `program` | [`Program`](../interfaces/Program.md) | +| `type` | [`Type`](../type-aliases/Type.md) | ## Returns -[`PatternData`](../interfaces/PatternData.md) \| `undefined` - -the pattern data, if any was set +`undefined` \| [`PatternData`](../interfaces/PatternData.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnTypeVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnTypeVisibility.md index e45612fd99..0f56a668a6 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnTypeVisibility.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getReturnTypeVisibility.md @@ -4,22 +4,16 @@ title: "[F] getReturnTypeVisibility" --- ```ts -function getReturnTypeVisibility(program, entity): string[] | undefined +function getReturnTypeVisibility(program, type): undefined | string[] ``` -Returns the visibilities of the return type of the given operation, if provided with `@returnTypeVisibility`. - ## Parameters | Parameter | Type | | ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | -| `entity` | [`Operation`](../interfaces/Operation.md) | +| `type` | [`Type`](../type-aliases/Type.md) | ## Returns -`string`[] \| `undefined` - -## See - -[$returnTypeVisibility]($returnTypeVisibility.md) +`undefined` \| `string`[] diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getService.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getService.md index befc7ff73d..eb677ba58d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getService.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getService.md @@ -4,20 +4,16 @@ title: "[F] getService" --- ```ts -function getService(program, namespace): Service | undefined +function getService(program, type): undefined | Service ``` -Get the service information for the given namespace. - ## Parameters -| Parameter | Type | Description | -| ------ | ------ | ------ | -| `program` | [`Program`](../interfaces/Program.md) | Program | -| `namespace` | [`Namespace`](../interfaces/Namespace.md) | Service namespace | +| Parameter | Type | +| ------ | ------ | +| `program` | [`Program`](../interfaces/Program.md) | +| `type` | [`Namespace`](../interfaces/Namespace.md) | ## Returns -[`Service`](../interfaces/Service.md) \| `undefined` - -Service information or undefined if namespace is not a service namespace. +`undefined` \| [`Service`](../interfaces/Service.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSummary.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSummary.md index 40a7262dfe..5467f4dc2b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSummary.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getSummary.md @@ -4,7 +4,7 @@ title: "[F] getSummary" --- ```ts -function getSummary(program, type): string | undefined +function getSummary(program, type): undefined | string ``` ## Parameters @@ -16,4 +16,4 @@ function getSummary(program, type): string | undefined ## Returns -`string` \| `undefined` +`undefined` \| `string` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getVisibility.md index 338d1f77f9..bd699c3931 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getVisibility.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getVisibility.md @@ -4,7 +4,7 @@ title: "[F] getVisibility" --- ```ts -function getVisibility(program, target): string[] | undefined +function getVisibility(program, type): undefined | string[] ``` ## Parameters @@ -12,8 +12,8 @@ function getVisibility(program, target): string[] | undefined | Parameter | Type | | ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | -| `target` | [`Type`](../type-aliases/Type.md) | +| `type` | [`Type`](../type-aliases/Type.md) | ## Returns -`string`[] \| `undefined` +`undefined` \| `string`[] diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isCadlValueTypeOf.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isCadlValueTypeOf.md index b52b83202b..cd01e90545 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isCadlValueTypeOf.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isCadlValueTypeOf.md @@ -24,6 +24,8 @@ function isCadlValueTypeOf(target, expectedType): target is InferredTypeSpecV `target is InferredTypeSpecValue` +boolean if the target is of one of the allowed types. + ## Deprecated use isTypeSpecValueTypeOf diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isSecret.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isSecret.md index 7647ae8e29..737878222b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isSecret.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/isSecret.md @@ -4,7 +4,7 @@ title: "[F] isSecret" --- ```ts -function isSecret(program, target): boolean | undefined +function isSecret(program, type): boolean ``` ## Parameters @@ -12,8 +12,8 @@ function isSecret(program, target): boolean | undefined | Parameter | Type | | ------ | ------ | | `program` | [`Program`](../interfaces/Program.md) | -| `target` | [`Type`](../type-aliases/Type.md) | +| `type` | [`Type`](../type-aliases/Type.md) | ## Returns -`boolean` \| `undefined` +`boolean` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveModule.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveModule.md index ee764c29fe..8a93510f94 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveModule.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/resolveModule.md @@ -6,7 +6,7 @@ title: "[F] resolveModule" ```ts function resolveModule( host, - name, + specifier, options): Promise ``` @@ -17,9 +17,13 @@ Resolve a module | Parameter | Type | Description | | ------ | ------ | ------ | | `host` | [`ResolveModuleHost`](../interfaces/ResolveModuleHost.md) | | -| `name` | `string` | | +| `specifier` | `string` | | | `options` | [`ResolveModuleOptions`](../interfaces/ResolveModuleOptions.md) | | ## Returns `Promise`<[`ModuleResolutionResult`](../type-aliases/ModuleResolutionResult.md)\> + +## Throws + +When the module cannot be resolved. diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/index.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/index.md index 318d051186..3f853d5ff7 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/index.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/index.md @@ -5,6 +5,12 @@ title: "[P] JS API" --- ## References +### ~~NodePackage~~ + +Renames and re-exports [PackageJson](interfaces/PackageJson.md) + +*** + ### printIdentifier Renames and re-exports [formatIdentifier](functions/formatIdentifier.md) @@ -45,8 +51,8 @@ Renames and re-exports [formatIdentifier](functions/formatIdentifier.md) - [BooleanLiteral](interfaces/BooleanLiteral.md) - [BooleanLiteralNode](interfaces/BooleanLiteralNode.md) - [BooleanValue](interfaces/BooleanValue.md) -- [CallExpressionNode](interfaces/CallExpressionNode.md) - [CallableMessage](interfaces/CallableMessage.md) +- [CallExpressionNode](interfaces/CallExpressionNode.md) - [Checker](interfaces/Checker.md) - [CodeFix](interfaces/CodeFix.md) - [CodeFixContext](interfaces/CodeFixContext.md) @@ -132,9 +138,9 @@ Renames and re-exports [formatIdentifier](functions/formatIdentifier.md) - [LinterRuleDefinition](interfaces/LinterRuleDefinition.md) - [LinterRuleSet](interfaces/LinterRuleSet.md) - [ListOperationOptions](interfaces/ListOperationOptions.md) +- [Logger](interfaces/Logger.md) - [LogInfo](interfaces/LogInfo.md) - [LogSink](interfaces/LogSink.md) -- [Logger](interfaces/Logger.md) - [MemberExpressionNode](interfaces/MemberExpressionNode.md) - [MixedFunctionParameter](interfaces/MixedFunctionParameter.md) - [MixedParameterConstraint](interfaces/MixedParameterConstraint.md) @@ -151,7 +157,6 @@ Renames and re-exports [formatIdentifier](functions/formatIdentifier.md) - [NavigationOptions](interfaces/NavigationOptions.md) - [NeverKeywordNode](interfaces/NeverKeywordNode.md) - [NeverType](interfaces/NeverType.md) -- [NodePackage](interfaces/NodePackage.md) - [NullType](interfaces/NullType.md) - [NullValue](interfaces/NullValue.md) - [Numeric](interfaces/Numeric.md) @@ -164,18 +169,18 @@ Renames and re-exports [formatIdentifier](functions/formatIdentifier.md) - [ObjectType](interfaces/ObjectType.md) - [ObjectValue](interfaces/ObjectValue.md) - [ObjectValuePropertyDescriptor](interfaces/ObjectValuePropertyDescriptor.md) -- [OpExample](interfaces/OpExample.md) - [Operation](interfaces/Operation.md) - [OperationSignatureDeclarationNode](interfaces/OperationSignatureDeclarationNode.md) - [OperationSignatureReferenceNode](interfaces/OperationSignatureReferenceNode.md) - [OperationStatementNode](interfaces/OperationStatementNode.md) +- [OpExample](interfaces/OpExample.md) - [PackageFlags](interfaces/PackageFlags.md) +- [PackageJson](interfaces/PackageJson.md) - [ParseOptions](interfaces/ParseOptions.md) - [PatternData](interfaces/PatternData.md) - [PositionDetail](interfaces/PositionDetail.md) - [ProcessedLog](interfaces/ProcessedLog.md) - [Program](interfaces/Program.md) -- [ProjectLocationContext](interfaces/ProjectLocationContext.md) - [ProjectedNameView](interfaces/ProjectedNameView.md) - [ProjectedProgram](interfaces/ProjectedProgram.md) - [Projection](interfaces/Projection.md) @@ -210,14 +215,15 @@ Renames and re-exports [formatIdentifier](functions/formatIdentifier.md) - [ProjectionUnaryExpressionNode](interfaces/ProjectionUnaryExpressionNode.md) - [ProjectionUnionSelectorNode](interfaces/ProjectionUnionSelectorNode.md) - [ProjectionUnionVariantSelectorNode](interfaces/ProjectionUnionVariantSelectorNode.md) +- [ProjectLocationContext](interfaces/ProjectLocationContext.md) - [Projector](interfaces/Projector.md) - [RecordModelType](interfaces/RecordModelType.md) - [ReplaceTextCodeFixEdit](interfaces/ReplaceTextCodeFixEdit.md) - [ResolveCompilerOptionsOptions](interfaces/ResolveCompilerOptionsOptions.md) -- [ResolveModuleHost](interfaces/ResolveModuleHost.md) -- [ResolveModuleOptions](interfaces/ResolveModuleOptions.md) - [ResolvedFile](interfaces/ResolvedFile.md) - [ResolvedModule](interfaces/ResolvedModule.md) +- [ResolveModuleHost](interfaces/ResolveModuleHost.md) +- [ResolveModuleOptions](interfaces/ResolveModuleOptions.md) - [ReturnExpressionNode](interfaces/ReturnExpressionNode.md) - [ReturnRecord](interfaces/ReturnRecord.md) - [RmOptions](interfaces/RmOptions.md) @@ -259,9 +265,9 @@ Renames and re-exports [formatIdentifier](functions/formatIdentifier.md) - [SyntheticLocationContext](interfaces/SyntheticLocationContext.md) - [TemplateArgumentNode](interfaces/TemplateArgumentNode.md) - [TemplateDeclarationNode](interfaces/TemplateDeclarationNode.md) +- [TemplatedTypeBase](interfaces/TemplatedTypeBase.md) - [TemplateParameter](interfaces/TemplateParameter.md) - [TemplateParameterDeclarationNode](interfaces/TemplateParameterDeclarationNode.md) -- [TemplatedTypeBase](interfaces/TemplatedTypeBase.md) - [TextRange](interfaces/TextRange.md) - [Tracer](interfaces/Tracer.md) - [TracerOptions](interfaces/TracerOptions.md) @@ -377,15 +383,15 @@ Renames and re-exports [formatIdentifier](functions/formatIdentifier.md) ## Variables -- [CadlPrettierPlugin](variables/CadlPrettierPlugin.md) -- [MANIFEST](variables/MANIFEST.md) -- [NoTarget](variables/NoTarget.md) -- [NodeHost](variables/NodeHost.md) -- [TypeSpecPrettierPlugin](variables/TypeSpecPrettierPlugin.md) - [altDirectorySeparator](variables/altDirectorySeparator.md) +- [CadlPrettierPlugin](variables/CadlPrettierPlugin.md) - [cadlVersion](variables/cadlVersion.md) - [directorySeparator](variables/directorySeparator.md) +- [MANIFEST](variables/MANIFEST.md) - [namespace](variables/namespace.md) +- [NodeHost](variables/NodeHost.md) +- [NoTarget](variables/NoTarget.md) +- [TypeSpecPrettierPlugin](variables/TypeSpecPrettierPlugin.md) - [typespecVersion](variables/typespecVersion.md) ## Functions @@ -417,8 +423,8 @@ Renames and re-exports [formatIdentifier](functions/formatIdentifier.md) - [$parameterVisibility](functions/$parameterVisibility.md) - [$pattern](functions/$pattern.md) - [$projectedName](functions/$projectedName.md) -- [$returnTypeVisibility](functions/$returnTypeVisibility.md) - [$returnsDoc](functions/$returnsDoc.md) +- [$returnTypeVisibility](functions/$returnTypeVisibility.md) - [$secret](functions/$secret.md) - [$service](functions/$service.md) - [$summary](functions/$summary.md) @@ -426,12 +432,11 @@ Renames and re-exports [formatIdentifier](functions/formatIdentifier.md) - [$visibility](functions/$visibility.md) - [$withDefaultKeyVisibility](functions/$withDefaultKeyVisibility.md) - [$withOptionalProperties](functions/$withOptionalProperties.md) +- [$withoutDefaultValues](functions/$withoutDefaultValues.md) +- [$withoutOmittedProperties](functions/$withoutOmittedProperties.md) - [$withPickedProperties](functions/$withPickedProperties.md) - [$withUpdateableProperties](functions/$withUpdateableProperties.md) - [$withVisibility](functions/$withVisibility.md) -- [$withoutDefaultValues](functions/$withoutDefaultValues.md) -- [$withoutOmittedProperties](functions/$withoutOmittedProperties.md) -- [Numeric](functions/Numeric.md) - [addService](functions/addService.md) - [assertType](functions/assertType.md) - [cadlTypeToJson](functions/cadlTypeToJson.md) @@ -526,9 +531,9 @@ Renames and re-exports [formatIdentifier](functions/formatIdentifier.md) - [getProperty](functions/getProperty.md) - [getPropertyType](functions/getPropertyType.md) - [getRelativePathFromDirectory](functions/getRelativePathFromDirectory.md) -- [getReturnTypeVisibility](functions/getReturnTypeVisibility.md) - [getReturnsDoc](functions/getReturnsDoc.md) - [getReturnsDocData](functions/getReturnsDocData.md) +- [getReturnTypeVisibility](functions/getReturnTypeVisibility.md) - [getRootLength](functions/getRootLength.md) - [getService](functions/getService.md) - [getSourceFileKindFromExt](functions/getSourceFileKindFromExt.md) @@ -594,6 +599,7 @@ Renames and re-exports [formatIdentifier](functions/formatIdentifier.md) - [navigateTypesInNamespace](functions/navigateTypesInNamespace.md) - [normalizePath](functions/normalizePath.md) - [normalizeSlashes](functions/normalizeSlashes.md) +- [Numeric](functions/Numeric.md) - [paramMessage](functions/paramMessage.md) - [parse](functions/parse.md) - [parseStandaloneTypeReference](functions/parseStandaloneTypeReference.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorArgument.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorArgument.md index 92c6b004b6..801280f97c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorArgument.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DecoratorArgument.md @@ -7,6 +7,6 @@ title: "[I] DecoratorArgument" | Property | Type | Description | | ------ | ------ | ------ | -| `jsValue` | \| `null` \| `string` \| `number` \| `boolean` \| `unknown`[] \| [`Numeric`](Numeric.md) \| [`Type`](../type-aliases/Type.md) \| `Record`<`string`, `unknown`\> \| [`Value`](../type-aliases/Value.md) | Marshalled value for use in Javascript. | +| `jsValue` | \| `null` \| `string` \| `number` \| `boolean` \| `unknown`[] \| `Record`<`string`, `unknown`\> \| [`Numeric`](Numeric.md) \| [`Type`](../type-aliases/Type.md) \| [`Value`](../type-aliases/Value.md) | Marshalled value for use in Javascript. | | `node?` | [`Node`](../type-aliases/Node.md) | - | | `value` | [`Type`](../type-aliases/Type.md) \| [`Value`](../type-aliases/Value.md) | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticDefinition.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticDefinition.md index 53fb59e6f4..ae8b3ea709 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticDefinition.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/DiagnosticDefinition.md @@ -3,6 +3,21 @@ jsApi: true title: "[I] DiagnosticDefinition" --- +Declare a diagnostic that can be reported by the library. + +## Example + +```ts +unterminated: { + severity: "error", + description: "Unterminated token.", + url: "https://example.com/docs/diags/unterminated", + messages: { + default: paramMessage`Unterminated ${"token"}.`, + }, +}, +``` + ## Type Parameters | Type Parameter | @@ -11,7 +26,9 @@ title: "[I] DiagnosticDefinition" ## Properties -| Property | Modifier | Type | -| ------ | ------ | ------ | -| `messages` | `readonly` | `M` | -| `severity` | `readonly` | `"error"` \| `"warning"` | +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `description?` | `readonly` | `string` | Short description of the diagnostic | +| `messages` | `readonly` | `M` | Messages that can be reported with the diagnostic. | +| `severity` | `readonly` | `"error"` \| `"warning"` | Diagnostic severity. - `warning` - Suppressable, should be used to represent potential issues but not blocking. - `error` - Non-suppressable, should be used to represent failure to move forward. | +| `url?` | `readonly` | `string` | Specifies the URL at which the full documentation can be accessed. | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IntrinsicType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IntrinsicType.md index 2256912e41..6423e51028 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IntrinsicType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/IntrinsicType.md @@ -23,7 +23,7 @@ title: "[I] IntrinsicType" | `instantiationParameters?` | `public` | [`Type`](../type-aliases/Type.md)[] | - | - | [`BaseType`](BaseType.md).`instantiationParameters` | | `isFinished` | `public` | `boolean` | Reflect if a type has been finished(Decorators have been called). There is multiple reasons a type might not be finished: - a template declaration will not - a template instance that argument that are still template parameters - a template instance that is only partially instantiated(like a templated operation inside a templated interface) | - | [`BaseType`](BaseType.md).`isFinished` | | `kind` | `public` | `"Intrinsic"` | - | [`BaseType`](BaseType.md).`kind` | - | -| `name` | `public` | \| `"unknown"` \| `"never"` \| `"null"` \| `"ErrorType"` \| `"void"` | - | - | - | +| `name` | `public` | \| `"unknown"` \| `"never"` \| `"null"` \| `"void"` \| `"ErrorType"` | - | - | - | | `node?` | `public` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseType`](BaseType.md).`node` | | `projectionBase?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`BaseType`](BaseType.md).`projectionBase` | | `projectionSource?` | `public` | [`Type`](../type-aliases/Type.md) | - | - | [`BaseType`](BaseType.md).`projectionSource` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterDefinition.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterDefinition.md index a9a46ea5c6..5e448f6a41 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterDefinition.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterDefinition.md @@ -7,5 +7,5 @@ title: "[I] LinterDefinition" | Property | Type | | ------ | ------ | -| `ruleSets?` | `Record`<`string`, [`LinterRuleSet`](LinterRuleSet.md)\> | | `rules` | [`LinterRuleDefinition`](LinterRuleDefinition.md)<`string`, [`DiagnosticMessages`](DiagnosticMessages.md)\>[] | +| `ruleSets?` | `Record`<`string`, [`LinterRuleSet`](LinterRuleSet.md)\> | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterResolvedDefinition.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterResolvedDefinition.md index 3060bbed5d..3e73921686 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterResolvedDefinition.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/LinterResolvedDefinition.md @@ -7,5 +7,5 @@ title: "[I] LinterResolvedDefinition" | Property | Modifier | Type | | ------ | ------ | ------ | -| `ruleSets` | `readonly` | `object` | | `rules` | `readonly` | [`LinterRule`](LinterRule.md)<`string`, [`DiagnosticMessages`](DiagnosticMessages.md)\>[] | +| `ruleSets` | `readonly` | `object` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NodePackage.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NodePackage.md deleted file mode 100644 index 01fc31cf1a..0000000000 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/NodePackage.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -jsApi: true -title: "[I] NodePackage" - ---- -Type for package.json https://docs.npmjs.com/cli/v8/configuring-npm/package-json - -## Properties - -| Property | Type | -| ------ | ------ | -| `bugs?` | `object` | -| `bugs.email?` | `string` | -| `bugs.url?` | `string` | -| `dependencies?` | `Record`<`string`, `string`\> | -| `description?` | `string` | -| `devDependencies?` | `Record`<`string`, `string`\> | -| `homepage?` | `string` | -| `main?` | `string` | -| `name` | `string` | -| `peerDependencies?` | `Record`<`string`, `string`\> | -| `private?` | `boolean` | -| `tspMain?` | `string` | -| `type?` | `"module"` \| `"commonjs"` | -| `version` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/PackageFlags.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/PackageFlags.md index c974386702..ef97858011 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/PackageFlags.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/PackageFlags.md @@ -7,4 +7,4 @@ title: "[I] PackageFlags" | Property | Modifier | Type | Description | | ------ | ------ | ------ | ------ | -| `decoratorArgMarshalling?` | `readonly` | `"new"` \| `"legacy"` | Decorator arg marshalling algorithm. Specify how TypeSpec values are marshalled to decorator arguments. - `lossless` - New recommended behavior - string value -> `string` - numeric value -> `number` if the constraint can be represented as a JS number, Numeric otherwise(e.g. for types int64, decimal128, numeric, etc.) - boolean value -> `boolean` - null value -> `null` - `legacy` Behavior before version 0.56.0. - string value -> `string` - numeric value -> `number` - boolean value -> `boolean` - null value -> `NullType` **Default** `legacy` | +| `decoratorArgMarshalling?` | `readonly` | `"new"` \| `"legacy"` | Decorator arg marshalling algorithm. Specify how TypeSpec values are marshalled to decorator arguments. - `new` - New recommended behavior - string value -> `string` - numeric value -> `number` if the constraint can be represented as a JS number, Numeric otherwise(e.g. for types int64, decimal128, numeric, etc.) - boolean value -> `boolean` - null value -> `null` - `legacy` - DEPRECATED - Behavior before version 0.56.0. - string value -> `string` - numeric value -> `number` - boolean value -> `boolean` - null value -> `NullType` **Default** `new` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/PackageJson.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/PackageJson.md new file mode 100644 index 0000000000..5ce9551387 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/PackageJson.md @@ -0,0 +1,26 @@ +--- +jsApi: true +title: "[I] PackageJson" + +--- +Type for package.json https://docs.npmjs.com/cli/configuring-npm/package-json + +## Properties + +| Property | Type | Description | +| ------ | ------ | ------ | +| `bugs?` | `object` | - | +| `bugs.email?` | `string` | - | +| `bugs.url?` | `string` | - | +| `dependencies?` | `Record`<`string`, `string`\> | - | +| `description?` | `string` | Package description | +| `devDependencies?` | `Record`<`string`, `string`\> | - | +| `exports?` | `null` \| `Exports` | Subpath exports to define entry points of the package. [Read more.](https://nodejs.org/api/packages.html#subpath-exports) | +| `homepage?` | `string` | - | +| `main?` | `string` | - | +| `name` | `string` | Package name | +| `peerDependencies?` | `Record`<`string`, `string`\> | - | +| `private?` | `boolean` | - | +| `tspMain?` | `string` | - | +| `type?` | `"module"` \| `"commonjs"` | - | +| `version?` | `string` | Package version | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectedProgram.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectedProgram.md index 7f1c831f5c..6048045bd6 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectedProgram.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectedProgram.md @@ -19,8 +19,8 @@ title: "[I] ProjectedProgram" | `jsSourceFiles` | `public` | `Map`<`string`, [`JsSourceFileNode`](JsSourceFileNode.md)\> | - | [`Program`](Program.md).`jsSourceFiles` | | `literalTypes` | `public` | `Map`<`string` \| `number` \| `boolean`, [`LiteralType`](../type-aliases/LiteralType.md)\> | - | [`Program`](Program.md).`literalTypes` | | `mainFile?` | `public` | [`TypeSpecScriptNode`](TypeSpecScriptNode.md) | - | [`Program`](Program.md).`mainFile` | -| `projectRoot` | `readonly` | `string` | Project root. If a tsconfig was found/specified this is the directory for the tsconfig.json. Otherwise directory where the entrypoint is located. | [`Program`](Program.md).`projectRoot` | | `projector` | `public` | [`Projector`](Projector.md) | - | - | +| `projectRoot` | `readonly` | `string` | Project root. If a tsconfig was found/specified this is the directory for the tsconfig.json. Otherwise directory where the entrypoint is located. | [`Program`](Program.md).`projectRoot` | | `sourceFiles` | `public` | `Map`<`string`, [`TypeSpecScriptNode`](TypeSpecScriptNode.md)\> | All source files in the program, keyed by their file path. | [`Program`](Program.md).`sourceFiles` | | `stateMaps` | `public` | `Map`<`symbol`, `StateMap`\> | - | [`Program`](Program.md).`stateMaps` | | `stateSets` | `public` | `Map`<`symbol`, `StateSet`\> | - | [`Program`](Program.md).`stateSets` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionArithmeticExpressionNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionArithmeticExpressionNode.md index 84f8e6cf20..0879c5ba6d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionArithmeticExpressionNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionArithmeticExpressionNode.md @@ -17,7 +17,7 @@ title: "[I] ProjectionArithmeticExpressionNode" | `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | - | [`BaseNode`](BaseNode.md).`flags` | | `kind` | `readonly` | `ProjectionArithmeticExpression` | - | [`BaseNode`](BaseNode.md).`kind` | - | | `left` | `readonly` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | - | -| `op` | `readonly` | `"-"` \| `"/"` \| `"+"` \| `"*"` | - | - | - | +| `op` | `readonly` | `"/"` \| `"*"` \| `"-"` \| `"+"` | - | - | - | | `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | - | [`BaseNode`](BaseNode.md).`parent` | | `pos` | `readonly` | `number` | The starting position of the ranger measured in UTF-16 code units from the start of the full string. Inclusive. | - | [`BaseNode`](BaseNode.md).`pos` | | `right` | `readonly` | [`ProjectionExpression`](../type-aliases/ProjectionExpression.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveModuleOptions.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveModuleOptions.md index 39592094d3..88ae68b4fc 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveModuleOptions.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolveModuleOptions.md @@ -5,8 +5,10 @@ title: "[I] ResolveModuleOptions" --- ## Properties -| Property | Type | Description | -| ------ | ------ | ------ | -| `baseDir` | `string` | - | -| `directoryIndexFiles?` | `string`[] | When resolution reach a directory without package.json look for those files to load in order. **Default** `["index.mjs", "index.js"]` | -| `resolveMain?` | (`pkg`: `any`) => `string` | When resolution reach package.json returns the path to the file relative to it. **Default** `pkg.main` | +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `baseDir` | `public` | `string` | - | +| `conditions?` | `readonly` | `string`[] | List of conditions to match in package exports | +| `directoryIndexFiles?` | `public` | `string`[] | When resolution reach a directory without package.json look for those files to load in order. **Default** `["index.mjs", "index.js"]` | +| `fallbackOnMissingCondition?` | `readonly` | `boolean` | If exports is defined ignore if the none of the given condition is found and fallback to using main field resolution. By default it will throw an error. | +| `resolveMain?` | `public` | (`pkg`: `any`) => `string` | When resolution reach package.json returns the path to the file relative to it. **Default** `pkg.main` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolvedModule.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolvedModule.md index a8c9fb0a70..117a4e4868 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolvedModule.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ResolvedModule.md @@ -8,6 +8,6 @@ title: "[I] ResolvedModule" | Property | Type | Description | | ------ | ------ | ------ | | `mainFile` | `string` | Resolved main file for the module. | -| `manifest` | [`NodePackage`](NodePackage.md) | Value of package.json. | +| `manifest` | [`PackageJson`](PackageJson.md) | Value of package.json. | | `path` | `string` | Root of the package. (Same level as package.json) | | `type` | `"module"` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceModel.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceModel.md index 7a88fb1409..69576b31b8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceModel.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/SourceModel.md @@ -8,4 +8,4 @@ title: "[I] SourceModel" | Property | Modifier | Type | Description | | ------ | ------ | ------ | ------ | | `model` | `readonly` | [`Model`](Model.md) | Source model | -| `usage` | `readonly` | `"is"` \| `"spread"` \| `"intersection"` | How was this model used. - is: `model A is B` - spread: `model A {...B}` - intersection: `alias A = B & C` | +| `usage` | `readonly` | `"is"` \| `"intersection"` \| `"spread"` | How was this model used. - is: `model A is B` - spread: `model A {...B}` - intersection: `alias A = B & C` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticReportWithoutTarget.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticReportWithoutTarget.md index 39c45e7abc..b4128299ab 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticReportWithoutTarget.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/DiagnosticReportWithoutTarget.md @@ -12,8 +12,8 @@ type DiagnosticReportWithoutTarget: object & DiagnosticFormat; | Name | Type | | ------ | ------ | | `code` | `C` | -| `codefixes` | readonly [`CodeFix`](../interfaces/CodeFix.md)[] | -| `messageId` | `M` | +| `codefixes`? | readonly [`CodeFix`](../interfaces/CodeFix.md)[] | +| `messageId`? | `M` | ## Type Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/LinterRuleDiagnosticReportWithoutTarget.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/LinterRuleDiagnosticReportWithoutTarget.md index 378d178aa2..1daeea2062 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/LinterRuleDiagnosticReportWithoutTarget.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/LinterRuleDiagnosticReportWithoutTarget.md @@ -11,8 +11,8 @@ type LinterRuleDiagnosticReportWithoutTarget: object & LinterRuleDiagnosti | Name | Type | | ------ | ------ | -| `codefixes` | [`CodeFix`](../interfaces/CodeFix.md)[] | -| `messageId` | `M` | +| `codefixes`? | [`CodeFix`](../interfaces/CodeFix.md)[] | +| `messageId`? | `M` | ## Type Parameters diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/SemanticNodeListener.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/SemanticNodeListener.md index 89b52ea9d0..b634487195 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/SemanticNodeListener.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/SemanticNodeListener.md @@ -11,4 +11,4 @@ type SemanticNodeListener: object & TypeListeners; | Name | Type | | ------ | ------ | -| `root` | (`context`) => `void` \| `undefined` | +| `root`? | (`context`) => `void` \| `undefined` | diff --git a/packages/website/versioned_sidebars/version-latest-sidebars.json b/packages/website/versioned_sidebars/version-latest-sidebars.json index 9937dfdba8..3996dfd809 100644 --- a/packages/website/versioned_sidebars/version-latest-sidebars.json +++ b/packages/website/versioned_sidebars/version-latest-sidebars.json @@ -87,6 +87,16 @@ "items": [ "standard-library/built-in-decorators", "standard-library/built-in-data-types", + { + "type": "category", + "label": "Diagnostics", + "items": [ + { + "type": "autogenerated", + "dirName": "standard-library/diags" + } + ] + }, { "type": "autogenerated", "dirName": "standard-library/reference" @@ -100,6 +110,20 @@ "type": "category", "label": "📚 Libraries", "items": [ + { + "type": "category", + "label": "Events", + "link": { + "type": "doc", + "id": "libraries/events/reference/index" + }, + "items": [ + { + "type": "autogenerated", + "dirName": "libraries/events/reference" + } + ] + }, { "type": "category", "label": "Http", @@ -161,6 +185,34 @@ } ] }, + { + "type": "category", + "label": "Server-Sent Events", + "link": { + "type": "doc", + "id": "libraries/sse/reference/index" + }, + "items": [ + { + "type": "autogenerated", + "dirName": "libraries/sse/reference" + } + ] + }, + { + "type": "category", + "label": "Streams", + "link": { + "type": "doc", + "id": "libraries/streams/reference/index" + }, + "items": [ + { + "type": "autogenerated", + "dirName": "libraries/streams/reference" + } + ] + }, { "type": "category", "label": "Versioning", diff --git a/packages/xml/CHANGELOG.md b/packages/xml/CHANGELOG.md index 2f0ed0f280..449e9c07c9 100644 --- a/packages/xml/CHANGELOG.md +++ b/packages/xml/CHANGELOG.md @@ -1,5 +1,12 @@ # Changelog - @typespec/xml +## 0.61.0 + +### Bump dependencies + +- [#4424](https://github.com/microsoft/typespec/pull/4424) Bump dependencies + + ## 0.60.0 ### Features diff --git a/packages/xml/package.json b/packages/xml/package.json index 36467adab9..f8fa0fc2df 100644 --- a/packages/xml/package.json +++ b/packages/xml/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/xml", - "version": "0.60.0", + "version": "0.61.0", "author": "Microsoft Corporation", "description": "TypeSpec library providing xml bindings", "homepage": "https://typespec.io",