diff --git a/.chronus/changes/accessibility-fix-pass-2-2024-2-19-18-29-3.md b/.chronus/changes/accessibility-fix-pass-2-2024-2-19-18-29-3.md deleted file mode 100644 index 01d1deffc2..0000000000 --- a/.chronus/changes/accessibility-fix-pass-2-2024-2-19-18-29-3.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: fix -packages: - - "@typespec/playground" ---- - -Add `aria` attributes for accessibility diff --git a/.chronus/changes/allow-encode-union-2024-2-6-17-42-29.md b/.chronus/changes/allow-encode-union-2024-2-6-17-42-29.md deleted file mode 100644 index df3eedfde1..0000000000 --- a/.chronus/changes/allow-encode-union-2024-2-6-17-42-29.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: feature -packages: - - "@typespec/compiler" ---- - -Enable the use of `@encode` for model properties that have a union type. This supports cases like `@encode("rfc3339") prop: utcDateTime | null` diff --git a/.chronus/changes/deprecate-known-values-2024-3-2-11-42-15.md b/.chronus/changes/deprecate-known-values-2024-3-2-11-42-15.md deleted file mode 100644 index 9e9b7b30c5..0000000000 --- a/.chronus/changes/deprecate-known-values-2024-3-2-11-42-15.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -changeKind: deprecation -packages: - - "@typespec/compiler" ---- - -Deprecate `@knownValues` decorator. Use a named union of string literal with a string variant to achieve the same result without a decorator - -Example: -```diff --enum FooKV { a, b, c} --@knownValues(FooKV) --scalar foo extends string; -+union Foo { "a", "b", "c", string } -``` diff --git a/.chronus/changes/deprecate-known-values-2024-3-2-18-48-59.md b/.chronus/changes/deprecate-known-values-2024-3-2-18-48-59.md deleted file mode 100644 index 957a83097d..0000000000 --- a/.chronus/changes/deprecate-known-values-2024-3-2-18-48-59.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: internal -packages: - - "@typespec/openapi3" ---- diff --git a/.chronus/changes/deprecate-projected-name-2024-1-12-21-5-53.md b/.chronus/changes/deprecate-projected-name-2024-1-12-21-5-53.md deleted file mode 100644 index 2236f0634b..0000000000 --- a/.chronus/changes/deprecate-projected-name-2024-1-12-21-5-53.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: deprecation -packages: - - "@typespec/compiler" ---- - -Deprecate `@projectedName` decorator. `@encodedName` should be used instead. - -Example: -```diff --@projectedName("json", "exp") -+@encodedName("application/json", "exp") -``` diff --git a/.chronus/changes/deprecate-projected-name-2024-1-12-21-9-58.md b/.chronus/changes/deprecate-projected-name-2024-1-12-21-9-58.md deleted file mode 100644 index 957a83097d..0000000000 --- a/.chronus/changes/deprecate-projected-name-2024-1-12-21-9-58.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: internal -packages: - - "@typespec/openapi3" ---- diff --git a/.chronus/changes/feature-dec-ts-sig-2024-2-7-19-6-24.md b/.chronus/changes/feature-dec-ts-sig-2024-2-7-19-6-24.md deleted file mode 100644 index 9de267d64f..0000000000 --- a/.chronus/changes/feature-dec-ts-sig-2024-2-7-19-6-24.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: internal -packages: - - "@typespec/compiler" - - "@typespec/openapi" - - "@typespec/openapi3" - - "@typespec/json-schema" - - "@typespec/protobuf" - - "@typespec/versioning" - - "@typespec/rest" - - "@typespec/http" ---- -Align TS decorators implementation types with the TypeSpec signature diff --git a/.chronus/changes/feature-dec-ts-sig-2024-2-8-21-36-50.md b/.chronus/changes/feature-dec-ts-sig-2024-2-8-21-36-50.md deleted file mode 100644 index 670ffc5622..0000000000 --- a/.chronus/changes/feature-dec-ts-sig-2024-2-8-21-36-50.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: fix -packages: - - "@typespec/eslint-config-typespec" ---- - -Ignore `generated-defs` folder diff --git a/.chronus/changes/fix-comment-in-template-params-2024-2-13-16-45-3.md b/.chronus/changes/fix-comment-in-template-params-2024-2-13-16-45-3.md deleted file mode 100644 index 8062d92e8e..0000000000 --- a/.chronus/changes/fix-comment-in-template-params-2024-2-13-16-45-3.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: fix -packages: - - "@typespec/compiler" ---- - -Grammar: Fix comments in template params not tokenized diff --git a/.chronus/changes/fix-dont-crash-unsupported-intrinsic-2024-2-28-19-23-35.md b/.chronus/changes/fix-dont-crash-unsupported-intrinsic-2024-2-28-19-23-35.md deleted file mode 100644 index 4cbbc413db..0000000000 --- a/.chronus/changes/fix-dont-crash-unsupported-intrinsic-2024-2-28-19-23-35.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: fix -packages: - - "@typespec/openapi3" ---- - -Do not crash if using an unsupported intrinsic type diff --git a/.chronus/changes/fix-multipart-union-part-conflict-2024-2-25-17-49-35.md b/.chronus/changes/fix-multipart-union-part-conflict-2024-2-25-17-49-35.md deleted file mode 100644 index f8501a86d3..0000000000 --- a/.chronus/changes/fix-multipart-union-part-conflict-2024-2-25-17-49-35.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: internal -packages: - - "@typespec/openapi3" ---- - -OpenAPI3: Fix multipart union part conflict diff --git a/.chronus/changes/fix-no-crash-nullable-2024-1-28-22-57-44.md b/.chronus/changes/fix-no-crash-nullable-2024-1-28-22-57-44.md deleted file mode 100644 index f1d30235df..0000000000 --- a/.chronus/changes/fix-no-crash-nullable-2024-1-28-22-57-44.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: fix -packages: - - "@typespec/openapi3" ---- - -Fix crash: emit `{nullable: true}` when trying to emit `null` in openapi3 diff --git a/.chronus/changes/fix-openapi3-multipart-union-bytes-2024-2-12-22-52-55.md b/.chronus/changes/fix-openapi3-multipart-union-bytes-2024-2-12-22-52-55.md deleted file mode 100644 index f5328e7012..0000000000 --- a/.chronus/changes/fix-openapi3-multipart-union-bytes-2024-2-12-22-52-55.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: fix -packages: - - "@typespec/openapi3" ---- - -Fix: OpenAPI3 not marking part of bytes or something else as `format: binary` diff --git a/.chronus/changes/fix-swagger-ui-build-2024-3-1-18-48-1.md b/.chronus/changes/fix-swagger-ui-build-2024-3-1-18-48-1.md deleted file mode 100644 index f1073d0f71..0000000000 --- a/.chronus/changes/fix-swagger-ui-build-2024-3-1-18-48-1.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -changeKind: internal -packages: - - "@typespec/playground" ---- - diff --git a/.chronus/changes/fix-union-literal-conflicts-2024-3-1-17-54-19.md b/.chronus/changes/fix-union-literal-conflicts-2024-3-1-17-54-19.md deleted file mode 100644 index 494eabf95c..0000000000 --- a/.chronus/changes/fix-union-literal-conflicts-2024-3-1-17-54-19.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: fix -packages: - - "@typespec/openapi3" ---- - -Fix: Literal unions with the same variants keep adding duplicate entries \ No newline at end of file diff --git a/.chronus/changes/fix-union-template-2024-2-26-16-22-2.md b/.chronus/changes/fix-union-template-2024-2-26-16-22-2.md deleted file mode 100644 index 3b88f2080b..0000000000 --- a/.chronus/changes/fix-union-template-2024-2-26-16-22-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: Union template declaration were incorrectly being finished in projection diff --git a/.chronus/changes/fix-visibility-conflict-base-model-2024-2-25-15-48-50.md b/.chronus/changes/fix-visibility-conflict-base-model-2024-2-25-15-48-50.md deleted file mode 100644 index a0599d1e68..0000000000 --- a/.chronus/changes/fix-visibility-conflict-base-model-2024-2-25-15-48-50.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: fix -packages: - - "@typespec/openapi3" ---- - -Fix visibility naming conflict when a model used with `extends` was used in different visibility. diff --git a/.chronus/changes/fix-warn-as-error-keep-going-2024-2-5-16-55-37.md b/.chronus/changes/fix-warn-as-error-keep-going-2024-2-5-16-55-37.md deleted file mode 100644 index 92305cfcc5..0000000000 --- a/.chronus/changes/fix-warn-as-error-keep-going-2024-2-5-16-55-37.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: fix -packages: - - "@typespec/compiler" ---- - -Warnings converted to error with `warn-as-error` do not prevent compilation from moving to the next stage like regular warnings diff --git a/.chronus/changes/more-reliable-codefix-application-2024-2-22-17-23-9.md b/.chronus/changes/more-reliable-codefix-application-2024-2-22-17-23-9.md deleted file mode 100644 index 07b97745ab..0000000000 --- a/.chronus/changes/more-reliable-codefix-application-2024-2-22-17-23-9.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: fix -packages: - - "@typespec/compiler" ---- - -Improve relability of application of codefixes in IDE, often it would not do anything diff --git a/.chronus/changes/remove-unusued-dep-2024-2-29-14-4-43.md b/.chronus/changes/remove-unusued-dep-2024-2-29-14-4-43.md deleted file mode 100644 index 9e5bd980d5..0000000000 --- a/.chronus/changes/remove-unusued-dep-2024-2-29-14-4-43.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -changeKind: internal -packages: - - "@typespec/bundler" - - "@typespec/compiler" - - "@typespec/eslint-config-typespec" - - "@typespec/eslint-plugin" - - "@typespec/html-program-viewer" - - "@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" ---- - -Dep update \ No newline at end of file diff --git a/.chronus/changes/scalar-versioning-2024-2-26-9-56-30.md b/.chronus/changes/scalar-versioning-2024-2-26-9-56-30.md deleted file mode 100644 index 09a0924452..0000000000 --- a/.chronus/changes/scalar-versioning-2024-2-26-9-56-30.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: feature -packages: - - "@typespec/versioning" ---- - -Add support for versioning of scalars(Added, removed, renamed) \ No newline at end of file diff --git a/.chronus/changes/scalar-versioning-2024-2-26-9-56-6.md b/.chronus/changes/scalar-versioning-2024-2-26-9-56-6.md deleted file mode 100644 index 21f0dd4800..0000000000 --- a/.chronus/changes/scalar-versioning-2024-2-26-9-56-6.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: feature -packages: - - "@typespec/compiler" ---- - -Experimental projection: Add support for scalars \ No newline at end of file diff --git a/.chronus/changes/swagger-ui-dist-2024-3-1-16-0-13.md b/.chronus/changes/swagger-ui-dist-2024-3-1-16-0-13.md deleted file mode 100644 index 2d312e5a42..0000000000 --- a/.chronus/changes/swagger-ui-dist-2024-3-1-16-0-13.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: internal -packages: - - "@typespec/playground" ---- - -Change swagger ui dependency \ No newline at end of file diff --git a/.chronus/changes/tmlanguage-escpaed-identifiers-2024-2-27-16-22-28.md b/.chronus/changes/tmlanguage-escpaed-identifiers-2024-2-27-16-22-28.md deleted file mode 100644 index d485c06134..0000000000 --- a/.chronus/changes/tmlanguage-escpaed-identifiers-2024-2-27-16-22-28.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: fix -packages: - - "@typespec/compiler" ---- - -TmLanguage: Fix tokenization of escaped identifiers, enums and unions diff --git a/.chronus/changes/upgrade-deps-march-2024-2024-2-18-16-33-47.md b/.chronus/changes/upgrade-deps-march-2024-2024-2-18-16-33-47.md deleted file mode 100644 index eb8b9c4674..0000000000 --- a/.chronus/changes/upgrade-deps-march-2024-2024-2-18-16-33-47.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: dependencies -packages: - - "@typespec/bundler" - - "@typespec/compiler" - - "@typespec/eslint-config-typespec" - - "@typespec/eslint-plugin" - - "@typespec/html-program-viewer" - - "@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" ---- - -Update dependencies diff --git a/.chronus/changes/vitest-allow-reload-js-2024-3-1-10-34-31.md b/.chronus/changes/vitest-allow-reload-js-2024-3-1-10-34-31.md deleted file mode 100644 index 7770d3f3ce..0000000000 --- a/.chronus/changes/vitest-allow-reload-js-2024-3-1-10-34-31.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -changeKind: internal -packages: - - "@typespec/openapi" ---- - diff --git a/.chronus/changes/website-doc-cleanup-2024-2-11-22-12-8.md b/.chronus/changes/website-doc-cleanup-2024-2-11-22-12-8.md deleted file mode 100644 index 6d25726e3e..0000000000 --- a/.chronus/changes/website-doc-cleanup-2024-2-11-22-12-8.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking -changeKind: internal -packages: - - "@typespec/compiler" - - "@typespec/http" - - "@typespec/openapi3" ---- diff --git a/packages/bundler/CHANGELOG.md b/packages/bundler/CHANGELOG.md index 4ae55a8467..3ce88c99b5 100644 --- a/packages/bundler/CHANGELOG.md +++ b/packages/bundler/CHANGELOG.md @@ -1,5 +1,12 @@ # Change Log - @typespec/bundler +## 0.1.2 + +### Bump dependencies + +- [#3027](https://github.com/microsoft/typespec/pull/3027) Update dependencies + + ## 0.1.1 ### Bump dependencies diff --git a/packages/bundler/package.json b/packages/bundler/package.json index af348b536a..cfe712e59a 100644 --- a/packages/bundler/package.json +++ b/packages/bundler/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/bundler", - "version": "0.1.1", + "version": "0.1.2", "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 69ad9732ce..c640e810ea 100644 --- a/packages/compiler/CHANGELOG.md +++ b/packages/compiler/CHANGELOG.md @@ -1,5 +1,44 @@ # Change Log - @typespec/compiler +## 0.55.0 + +### Bug Fixes + +- [#3018](https://github.com/microsoft/typespec/pull/3018) Grammar: Fix comments in template params not tokenized +- [#3052](https://github.com/microsoft/typespec/pull/3052) Fix: Union template declaration were incorrectly being finished in projection +- [#2983](https://github.com/microsoft/typespec/pull/2983) Warnings converted to error with `warn-as-error` do not prevent compilation from moving to the next stage like regular warnings +- [#3041](https://github.com/microsoft/typespec/pull/3041) Improve relability of application of codefixes in IDE, often it would not do anything +- [#3069](https://github.com/microsoft/typespec/pull/3069) TmLanguage: Fix tokenization of escaped identifiers, enums and unions + +### Bump dependencies + +- [#3027](https://github.com/microsoft/typespec/pull/3027) Update dependencies + +### Features + +- [#2992](https://github.com/microsoft/typespec/pull/2992) Enable the use of `@encode` for model properties that have a union type. This supports cases like `@encode("rfc3339") prop: utcDateTime | null` +- [#3053](https://github.com/microsoft/typespec/pull/3053) Experimental projection: Add support for scalars + +### Deprecations + +- [#3094](https://github.com/microsoft/typespec/pull/3094) Deprecate `@knownValues` decorator. Use a named union of string literal with a string variant to achieve the same result without a decorator + +Example: +```diff +-enum FooKV { a, b, c} +-@knownValues(FooKV) +-scalar foo extends string; ++union Foo { "a", "b", "c", string } +``` +- [#2910](https://github.com/microsoft/typespec/pull/2910) Deprecate `@projectedName` decorator. `@encodedName` should be used instead. + +Example: +```diff +-@projectedName("json", "exp") ++@encodedName("application/json", "exp") +``` + + ## 0.54.0 ### Bug Fixes diff --git a/packages/compiler/package.json b/packages/compiler/package.json index 4e8c38aff9..3957e61f16 100644 --- a/packages/compiler/package.json +++ b/packages/compiler/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/compiler", - "version": "0.54.0", + "version": "0.55.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 1227e684d3..fa460666de 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.54.0" + "compilerVersion": "0.55.0" }, "rest": { "title": "Generic REST API", "description": "Create a project representing a generic REST API", - "compilerVersion": "0.54.0", + "compilerVersion": "0.55.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.54.0", + "compilerVersion": "0.55.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.54.0", + "compilerVersion": "0.55.0", "libraries": [], "files": [ { diff --git a/packages/eslint-config-typespec/CHANGELOG.md b/packages/eslint-config-typespec/CHANGELOG.md index a49cbb5a2b..ccc717de13 100644 --- a/packages/eslint-config-typespec/CHANGELOG.md +++ b/packages/eslint-config-typespec/CHANGELOG.md @@ -1,5 +1,16 @@ # Change Log - @typespec/eslint-config-typespec +## 0.55.0 + +### Bug Fixes + +- [#2122](https://github.com/microsoft/typespec/pull/2122) Ignore `generated-defs` folder + +### Bump dependencies + +- [#3027](https://github.com/microsoft/typespec/pull/3027) Update dependencies + + ## 0.54.0 ### Bug Fixes diff --git a/packages/eslint-config-typespec/package.json b/packages/eslint-config-typespec/package.json index 03b1383e6d..d6f6ddae6c 100644 --- a/packages/eslint-config-typespec/package.json +++ b/packages/eslint-config-typespec/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/eslint-config-typespec", - "version": "0.54.0", + "version": "0.55.0", "description": "ESLint config for TypeSpec packages", "main": "index.js", "repository": { diff --git a/packages/eslint-plugin-typespec/CHANGELOG.md b/packages/eslint-plugin-typespec/CHANGELOG.md index 625682518f..cc7daf0144 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.55.0 + +### Bump dependencies + +- [#3027](https://github.com/microsoft/typespec/pull/3027) Update dependencies + + ## 0.54.0 ### Bump dependencies diff --git a/packages/eslint-plugin-typespec/package.json b/packages/eslint-plugin-typespec/package.json index 6de63cce07..a0e709556b 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.54.0", + "version": "0.55.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/html-program-viewer/CHANGELOG.md b/packages/html-program-viewer/CHANGELOG.md index 6902eecb68..570f10f38f 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.55.0 + +### Bump dependencies + +- [#3027](https://github.com/microsoft/typespec/pull/3027) Update dependencies + + ## 0.54.0 ### Bug Fixes diff --git a/packages/html-program-viewer/package.json b/packages/html-program-viewer/package.json index 0542bdc366..3396a809fb 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.54.0", + "version": "0.55.0", "author": "Microsoft Corporation", "description": "TypeSpec library for emitting an html view of the program.", "homepage": "https://typespec.io", diff --git a/packages/http/CHANGELOG.md b/packages/http/CHANGELOG.md index 100d85d1c8..cdc1709e1d 100644 --- a/packages/http/CHANGELOG.md +++ b/packages/http/CHANGELOG.md @@ -1,5 +1,12 @@ # Change Log - @typespec/http +## 0.55.0 + +### Bump dependencies + +- [#3027](https://github.com/microsoft/typespec/pull/3027) Update dependencies + + ## 0.54.0 ### Bug Fixes diff --git a/packages/http/package.json b/packages/http/package.json index a25fa7da98..9c84c10431 100644 --- a/packages/http/package.json +++ b/packages/http/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/http", - "version": "0.54.0", + "version": "0.55.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 27a3275384..e129494609 100644 --- a/packages/internal-build-utils/CHANGELOG.md +++ b/packages/internal-build-utils/CHANGELOG.md @@ -1,5 +1,12 @@ # Change Log - @typespec/internal-build-utils +## 0.55.0 + +### Bump dependencies + +- [#3027](https://github.com/microsoft/typespec/pull/3027) Update dependencies + + ## 0.54.0 ### Bug Fixes diff --git a/packages/internal-build-utils/package.json b/packages/internal-build-utils/package.json index 4b079264d2..ef4ec193ee 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.54.0", + "version": "0.55.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 4d4926fa78..06feb2f0ed 100644 --- a/packages/json-schema/CHANGELOG.md +++ b/packages/json-schema/CHANGELOG.md @@ -1,5 +1,12 @@ # Change Log - @typespec/json-schema +## 0.55.0 + +### Bump dependencies + +- [#3027](https://github.com/microsoft/typespec/pull/3027) Update dependencies + + ## 0.54.0 ### Bug Fixes diff --git a/packages/json-schema/package.json b/packages/json-schema/package.json index 93771fb04b..0d4fecaff8 100644 --- a/packages/json-schema/package.json +++ b/packages/json-schema/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/json-schema", - "version": "0.54.0", + "version": "0.55.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 10d8646639..c57ef78ad2 100644 --- a/packages/library-linter/CHANGELOG.md +++ b/packages/library-linter/CHANGELOG.md @@ -1,5 +1,12 @@ # Change Log - @typespec/library-linter +## 0.55.0 + +### Bump dependencies + +- [#3027](https://github.com/microsoft/typespec/pull/3027) Update dependencies + + ## 0.54.0 ### Bump dependencies diff --git a/packages/library-linter/package.json b/packages/library-linter/package.json index 9c713965d2..071fe0e782 100644 --- a/packages/library-linter/package.json +++ b/packages/library-linter/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/library-linter", - "version": "0.54.0", + "version": "0.55.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 597abac7ad..13de8511cc 100644 --- a/packages/openapi/CHANGELOG.md +++ b/packages/openapi/CHANGELOG.md @@ -1,5 +1,12 @@ # Change Log - @typespec/openapi +## 0.55.0 + +### Bump dependencies + +- [#3027](https://github.com/microsoft/typespec/pull/3027) Update dependencies + + ## 0.54.0 ### Bump dependencies diff --git a/packages/openapi/package.json b/packages/openapi/package.json index 23337eeb1c..51266ff9a3 100644 --- a/packages/openapi/package.json +++ b/packages/openapi/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/openapi", - "version": "0.54.0", + "version": "0.55.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 633a1bc847..d599c35acc 100644 --- a/packages/openapi3/CHANGELOG.md +++ b/packages/openapi3/CHANGELOG.md @@ -1,5 +1,20 @@ # Change Log - @typespec/openapi3 +## 0.55.0 + +### Bug Fixes + +- [#3077](https://github.com/microsoft/typespec/pull/3077) Do not crash if using an unsupported intrinsic type +- [#2967](https://github.com/microsoft/typespec/pull/2967) Fix crash: emit `{nullable: true}` when trying to emit `null` in openapi3 +- [#3013](https://github.com/microsoft/typespec/pull/3013) Fix: OpenAPI3 not marking part of bytes or something else as `format: binary` +- [#3090](https://github.com/microsoft/typespec/pull/3090) Fix: Literal unions with the same variants keep adding duplicate entries +- [#3049](https://github.com/microsoft/typespec/pull/3049) Fix visibility naming conflict when a model used with `extends` was used in different visibility. + +### Bump dependencies + +- [#3027](https://github.com/microsoft/typespec/pull/3027) Update dependencies + + ## 0.54.0 ### Bump dependencies diff --git a/packages/openapi3/package.json b/packages/openapi3/package.json index 63ce466ea5..06a3fd6565 100644 --- a/packages/openapi3/package.json +++ b/packages/openapi3/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/openapi3", - "version": "0.54.0", + "version": "0.55.0", "author": "Microsoft Corporation", "description": "TypeSpec library for emitting OpenAPI 3.0 from the TypeSpec REST protocol binding", "homepage": "https://typespec.io", diff --git a/packages/playground/CHANGELOG.md b/packages/playground/CHANGELOG.md index 0e9c38f9f9..80dac82f21 100644 --- a/packages/playground/CHANGELOG.md +++ b/packages/playground/CHANGELOG.md @@ -1,5 +1,16 @@ # Change Log - @typespec/playground +## 0.2.1 + +### Bug Fixes + +- [#3031](https://github.com/microsoft/typespec/pull/3031) Add `aria` attributes for accessibility + +### Bump dependencies + +- [#3027](https://github.com/microsoft/typespec/pull/3027) Update dependencies + + ## 0.2.0 ### Bug Fixes diff --git a/packages/playground/package.json b/packages/playground/package.json index 379cc09bdf..29069fbb17 100644 --- a/packages/playground/package.json +++ b/packages/playground/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/playground", - "version": "0.2.0", + "version": "0.2.1", "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 8ca478e408..47d05e7930 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.55.0 + +### Bump dependencies + +- [#3027](https://github.com/microsoft/typespec/pull/3027) Update dependencies + + ## 0.54.0 ### Bump dependencies diff --git a/packages/prettier-plugin-typespec/package.json b/packages/prettier-plugin-typespec/package.json index ad1141508c..9a9f07223f 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.54.0", + "version": "0.55.0", "description": "", "main": "dist/index.js", "scripts": { diff --git a/packages/protobuf/CHANGELOG.md b/packages/protobuf/CHANGELOG.md index 5c0170cdc8..c90500ca76 100644 --- a/packages/protobuf/CHANGELOG.md +++ b/packages/protobuf/CHANGELOG.md @@ -1,5 +1,12 @@ # Change Log - @typespec/protobuf +## 0.55.0 + +### Bump dependencies + +- [#3027](https://github.com/microsoft/typespec/pull/3027) Update dependencies + + ## 0.54.0 ### Bump dependencies diff --git a/packages/protobuf/package.json b/packages/protobuf/package.json index 1bd52ba769..12bb567d7a 100644 --- a/packages/protobuf/package.json +++ b/packages/protobuf/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/protobuf", - "version": "0.54.0", + "version": "0.55.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 35ac8855d9..a72e4d15d7 100644 --- a/packages/rest/CHANGELOG.md +++ b/packages/rest/CHANGELOG.md @@ -1,5 +1,12 @@ # Change Log - @typespec/rest +## 0.55.0 + +### Bump dependencies + +- [#3027](https://github.com/microsoft/typespec/pull/3027) Update dependencies + + ## 0.54.0 ### Bump dependencies diff --git a/packages/rest/package.json b/packages/rest/package.json index 6fc80694c1..aeaf91b9d7 100644 --- a/packages/rest/package.json +++ b/packages/rest/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/rest", - "version": "0.54.0", + "version": "0.55.0", "author": "Microsoft Corporation", "description": "TypeSpec REST protocol binding", "homepage": "https://typespec.io", diff --git a/packages/tmlanguage-generator/CHANGELOG.md b/packages/tmlanguage-generator/CHANGELOG.md index 482c7e169b..39273bf20a 100644 --- a/packages/tmlanguage-generator/CHANGELOG.md +++ b/packages/tmlanguage-generator/CHANGELOG.md @@ -1,5 +1,12 @@ # Change Log - tmlanguage-generator +## 0.5.4 + +### Bump dependencies + +- [#3027](https://github.com/microsoft/typespec/pull/3027) Update dependencies + + ## 0.5.3 ### Bump dependencies diff --git a/packages/tmlanguage-generator/package.json b/packages/tmlanguage-generator/package.json index 3466bd9f47..bac1b6a8ee 100644 --- a/packages/tmlanguage-generator/package.json +++ b/packages/tmlanguage-generator/package.json @@ -1,6 +1,6 @@ { "name": "tmlanguage-generator", - "version": "0.5.3", + "version": "0.5.4", "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 87257f06f6..9fd8c84a5a 100644 --- a/packages/typespec-vs/CHANGELOG.md +++ b/packages/typespec-vs/CHANGELOG.md @@ -1,5 +1,9 @@ # Change Log - typespec-vs +## 0.55.0 + +No changes, version bump only. + ## 0.54.0 ### Bump dependencies diff --git a/packages/typespec-vs/package.json b/packages/typespec-vs/package.json index 129cb52287..b786e811e9 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.54.0", + "version": "0.55.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 8a7c991668..e35a28540c 100644 --- a/packages/typespec-vscode/CHANGELOG.md +++ b/packages/typespec-vscode/CHANGELOG.md @@ -1,5 +1,12 @@ # Change Log - typespec-vscode +## 0.55.0 + +### Bump dependencies + +- [#3027](https://github.com/microsoft/typespec/pull/3027) Update dependencies + + ## 0.54.0 ### Bump dependencies diff --git a/packages/typespec-vscode/package.json b/packages/typespec-vscode/package.json index 6e8839d24f..239b4b1335 100644 --- a/packages/typespec-vscode/package.json +++ b/packages/typespec-vscode/package.json @@ -1,6 +1,6 @@ { "name": "typespec-vscode", - "version": "0.54.1", + "version": "0.55.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 88fba4bdab..105e2a1d9a 100644 --- a/packages/versioning/CHANGELOG.md +++ b/packages/versioning/CHANGELOG.md @@ -1,5 +1,16 @@ # Change Log - @typespec/versioning +## 0.55.0 + +### Bump dependencies + +- [#3027](https://github.com/microsoft/typespec/pull/3027) Update dependencies + +### Features + +- [#3053](https://github.com/microsoft/typespec/pull/3053) Add support for versioning of scalars(Added, removed, renamed) + + ## 0.54.0 ### Bump dependencies diff --git a/packages/versioning/package.json b/packages/versioning/package.json index 9121476bff..d60d04f6cd 100644 --- a/packages/versioning/package.json +++ b/packages/versioning/package.json @@ -1,6 +1,6 @@ { "name": "@typespec/versioning", - "version": "0.54.0", + "version": "0.55.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 2c3eb274fc..d2445f1649 100644 --- a/packages/website/playground-versions.json +++ b/packages/website/playground-versions.json @@ -1,4 +1,5 @@ [ + "0.55.x", "0.54.x", "0.53.x", "0.52.x", 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 6ff08b930e..6928722ab7 100644 --- a/packages/website/versioned_docs/version-latest/extending-typespec/basics.md +++ b/packages/website/versioned_docs/version-latest/extending-typespec/basics.md @@ -238,9 +238,7 @@ The first step is to define how your library can be loaded from the test framewo 1. Create a new file `./src/testing/index.ts` with the following content ```ts -import { resolvePath } from "@typespec/compiler"; -import { createTestLibrary } from "@typespec/compiler/testing"; -import { fileURLToPath } from "url"; +import { createTestLibrary, findTestPackageRoot } from "@typespec/compiler/testing"; export const MyTestLibrary = createTestLibrary({ name: "", @@ -279,7 +277,7 @@ Create a new file `test/test-host.js` (change `test` to be your test folder) ```ts import { createTestHost, createTestWrapper } from "@typespec/compiler/testing"; -import { RestTestLibrary } from "/rest/testing"; +import { RestTestLibrary } from "@typespec/rest/testing"; import { MyTestLibrary } from "../src/testing/index.js"; export async function createMyTestHost() { diff --git a/packages/website/versioned_docs/version-latest/extending-typespec/create-decorators.md b/packages/website/versioned_docs/version-latest/extending-typespec/create-decorators.md index dd127be96c..717c917f1e 100644 --- a/packages/website/versioned_docs/version-latest/extending-typespec/create-decorators.md +++ b/packages/website/versioned_docs/version-latest/extending-typespec/create-decorators.md @@ -1,13 +1,13 @@ --- id: create-decorators -title: How to create TypeSpec decorators +title: Decorators --- -# How to create TypeSpec decorators +# Decorators TypeSpec decorators are implemented as JavaScript functions. The process of creating a decorator can be divided into two parts: -1. [(Optional) Declare the decorator signature in TypeSpec](#declare-the-decorator-signature) +1. [Declare the decorator signature in TypeSpec](#declare-the-decorator-signature) (optional but recommended) 2. [Implement the decorator in JavaScript](#implement-the-decorator-in-javascript) ## Declare the decorator signature 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 ae24e24970..66d6f851eb 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 @@ -7,6 +7,14 @@ title: 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. +## Emitter design + +TypeSpec is designed to support many protocols and many output formats. It is important that an emitter is designed to select only the part of the TypeSpec spec that makes sense for them. Having emitters designed correctly will allow a user to define multiple layers of their API in a single TypeSpec document, allowing tools to view the entire picture of the service. + +For example assuming a User wants to emit `openapi3` and `protobuf` but each API has a different set of operations and is split into different namespaces. + +It is important that there is a way for the openapi3 emitter and protobuf emitter to select only the part of the spec that applies to them. For instance, the protobuf emitter should not try to emit the http service namespace and fail because of missing annotations. + ## Starting out TypeSpec emitters are a unique type of TypeSpec library, so they follow the same initial setup instructions. diff --git a/packages/website/versioned_docs/version-latest/extending-typespec/linters.md b/packages/website/versioned_docs/version-latest/extending-typespec/linters.md index 972506acba..7d6bd88576 100644 --- a/packages/website/versioned_docs/version-latest/extending-typespec/linters.md +++ b/packages/website/versioned_docs/version-latest/extending-typespec/linters.md @@ -1,9 +1,9 @@ --- id: linters -title: Understanding linters +title: Linters --- -# Understanding linters +# Linters ## Linter versus `onValidate` @@ -78,8 +78,8 @@ context.reportDiagnostic({ codefixes: [ defineCodeFix({ id: "add-model-suffix", - description: "Add 'Model' suffix to model name", - apply: (program) => { + label: "Add 'Model' suffix to model name", + fix: (program) => { program.update(model, { name: `${model.name}Model`, }); diff --git a/packages/website/versioned_docs/version-latest/images/vscode.gif b/packages/website/versioned_docs/version-latest/images/vscode.gif new file mode 100644 index 0000000000..6f14a6438e Binary files /dev/null and b/packages/website/versioned_docs/version-latest/images/vscode.gif differ diff --git a/packages/website/versioned_docs/version-latest/libraries/http/multipart.md b/packages/website/versioned_docs/version-latest/libraries/http/multipart.md index 9d8445dfe4..2d9a40d6f3 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/multipart.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/multipart.md @@ -54,12 +54,19 @@ op create(@header contentType: "multipart/form-data", images: bytes[]): void; // Upload 2 form fields op create(@header contentType: "multipart/form-data", firstName: string, lastName: string): void; -// Upload a json field +// Send a json field model Address { street: string; city: string; } op create(@header contentType: "multipart/form-data", address: Address): void; + +// Send multiple fields - In this scenario each address is sent as an individual part +model Address { + street: string; + city: string; +} +op create(@header contentType: "multipart/form-data", addresses: Address[]): void; ``` ## Custom Content-Type, boundary, etc. diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$body.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$body.md index 74c51eca4a..85ed387308 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$body.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$body.md @@ -4,7 +4,7 @@ title: "[F] $body" --- ```ts -$body(context, entity): void +$body(context, target): void ``` ## Parameters @@ -12,7 +12,7 @@ $body(context, entity): void | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `entity` | `ModelProperty` | +| `target` | `ModelProperty` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$delete.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$delete.md index a97fdb5e37..b498c22bd3 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$delete.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$delete.md @@ -4,7 +4,7 @@ title: "[F] $delete" --- ```ts -$delete(context, entity): void +$delete(context, target): void ``` ## Parameters @@ -12,7 +12,7 @@ $delete(context, entity): void | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `entity` | `Operation` | +| `target` | `Operation` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$get.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$get.md index 0815e4bbf2..480aa9ffb0 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$get.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$get.md @@ -4,7 +4,7 @@ title: "[F] $get" --- ```ts -$get(context, entity): void +$get(context, target): void ``` ## Parameters @@ -12,7 +12,7 @@ $get(context, entity): void | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `entity` | `Operation` | +| `target` | `Operation` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$head.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$head.md index 63c0520514..84b422f952 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$head.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$head.md @@ -4,7 +4,7 @@ title: "[F] $head" --- ```ts -$head(context, entity): void +$head(context, target): void ``` ## Parameters @@ -12,7 +12,7 @@ $head(context, entity): void | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `entity` | `Operation` | +| `target` | `Operation` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$header.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$header.md index a420147c29..61cbd7196e 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$header.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$header.md @@ -6,7 +6,7 @@ title: "[F] $header" ```ts $header( context, - entity, + target, headerNameOrOptions?): void ``` @@ -15,8 +15,8 @@ $header( | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `entity` | `ModelProperty` | -| `headerNameOrOptions`? | `StringLiteral` \| `Model` | +| `target` | `ModelProperty` | +| `headerNameOrOptions`? | `Type` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$patch.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$patch.md index 32efa20c4d..f975792dfc 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$patch.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$patch.md @@ -4,7 +4,7 @@ title: "[F] $patch" --- ```ts -$patch(context, entity): void +$patch(context, target): void ``` ## Parameters @@ -12,7 +12,7 @@ $patch(context, entity): void | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `entity` | `Operation` | +| `target` | `Operation` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$path.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$path.md index f7e253f31c..9574f3a3b8 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$path.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$path.md @@ -6,7 +6,7 @@ title: "[F] $path" ```ts $path( context, - entity, + target, paramName?): void ``` @@ -15,7 +15,7 @@ $path( | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `entity` | `ModelProperty` | +| `target` | `ModelProperty` | | `paramName`? | `string` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$plainData.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$plainData.md index d61d12c6bb..d340a798ad 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$plainData.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$plainData.md @@ -4,7 +4,7 @@ title: "[F] $plainData" --- ```ts -$plainData(context, entity): void +$plainData(context, target): void ``` ## Parameters @@ -12,7 +12,7 @@ $plainData(context, entity): void | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `entity` | `Model` | +| `target` | `Model` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$post.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$post.md index 61ab855910..b0fc15a8a9 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$post.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$post.md @@ -4,7 +4,7 @@ title: "[F] $post" --- ```ts -$post(context, entity): void +$post(context, target): void ``` ## Parameters @@ -12,7 +12,7 @@ $post(context, entity): void | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `entity` | `Operation` | +| `target` | `Operation` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$put.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$put.md index 0c991e4bbe..445052ac48 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$put.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$put.md @@ -4,7 +4,7 @@ title: "[F] $put" --- ```ts -$put(context, entity): void +$put(context, target): void ``` ## Parameters @@ -12,7 +12,7 @@ $put(context, entity): void | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `entity` | `Operation` | +| `target` | `Operation` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$query.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$query.md index 1f05c53a9a..89857025ac 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$query.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$query.md @@ -6,7 +6,7 @@ title: "[F] $query" ```ts $query( context, - entity, + target, queryNameOrOptions?): void ``` @@ -15,8 +15,8 @@ $query( | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `entity` | `ModelProperty` | -| `queryNameOrOptions`? | `StringLiteral` \| `Model` | +| `target` | `ModelProperty` | +| `queryNameOrOptions`? | `Type` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$route.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$route.md index 588ec13667..283b04bedb 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$route.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$route.md @@ -6,9 +6,9 @@ title: "[F] $route" ```ts $route( context, - entity, + target, path, - parameters?): void + options?): void ``` `@route` defines the relative route URI for the target operation @@ -24,9 +24,9 @@ it will be used as a prefix to the route URI of the operation. | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `entity` | `Type` | +| `target` | `Interface` \| `Namespace` \| `Operation` | | `path` | `string` | -| `parameters`? | `Model` | +| `options`? | `Type` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$server.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$server.md index c673165613..d2987164ab 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$server.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$server.md @@ -22,7 +22,7 @@ Configure the server url for the service. | `target` | `Namespace` | Decorator target (must be a namespace) | | `url` | `string` | - | | `description` | `string` | Description for this server. | -| `parameters`? | `Model` | | +| `parameters`? | `Type` | | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$sharedRoute.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$sharedRoute.md index 85f083c588..5543b78ade 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$sharedRoute.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$sharedRoute.md @@ -4,7 +4,7 @@ title: "[F] $sharedRoute" --- ```ts -$sharedRoute(context, entity): void +$sharedRoute(context, target): void ``` `@sharedRoute` marks the operation as sharing a route path with other operations. @@ -19,7 +19,7 @@ route path as long as those operations are also marked with `@sharedRoute`. | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `entity` | `Operation` | +| `target` | `Operation` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$statusCode.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$statusCode.md index 6fa9dcb737..3b421164c6 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$statusCode.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$statusCode.md @@ -4,7 +4,7 @@ title: "[F] $statusCode" --- ```ts -$statusCode(context, entity): void +$statusCode(context, target): void ``` ## Parameters @@ -12,7 +12,7 @@ $statusCode(context, entity): void | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `entity` | `ModelProperty` | +| `target` | `ModelProperty` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$useAuth.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$useAuth.md index a029b9b705..faee9533ac 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$useAuth.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/$useAuth.md @@ -16,7 +16,7 @@ $useAuth( | :------ | :------ | | `context` | `DecoratorContext` | | `entity` | `Interface` \| `Namespace` \| `Operation` | -| `authConfig` | `Model` \| `Tuple` \| `Union` | +| `authConfig` | `Type` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/setStatusCode.md b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/setStatusCode.md index e09ba37432..47ddd91520 100644 --- a/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/setStatusCode.md +++ b/packages/website/versioned_docs/version-latest/libraries/http/reference/js-api/functions/setStatusCode.md @@ -15,7 +15,7 @@ setStatusCode( | Parameter | Type | | :------ | :------ | | `program` | `Program` | -| `entity` | `Model` \| `ModelProperty` | +| `entity` | `ModelProperty` \| `Model` | | `codes` | `string`[] | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/json-schema/reference/js-api/classes/JsonSchemaEmitter.md b/packages/website/versioned_docs/version-latest/libraries/json-schema/reference/js-api/classes/JsonSchemaEmitter.md index 1a405d1cd3..9dd44e51bf 100644 --- a/packages/website/versioned_docs/version-latest/libraries/json-schema/reference/js-api/classes/JsonSchemaEmitter.md +++ b/packages/website/versioned_docs/version-latest/libraries/json-schema/reference/js-api/classes/JsonSchemaEmitter.md @@ -53,7 +53,7 @@ private #applyConstraints(type, schema): void | Parameter | Type | | :------ | :------ | -| `type` | \| `Model` \| `ModelProperty` \| `Scalar` \| `Enum` \| `Union` | +| `type` | \| `Scalar` \| `ModelProperty` \| `Model` \| `Enum` \| `Union` | | `schema` | `ObjectBuilder`<`unknown`\> | #### Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/json-schema/reference/js-api/functions/$contains.md b/packages/website/versioned_docs/version-latest/libraries/json-schema/reference/js-api/functions/$contains.md index fcf787f237..d006f08dac 100644 --- a/packages/website/versioned_docs/version-latest/libraries/json-schema/reference/js-api/functions/$contains.md +++ b/packages/website/versioned_docs/version-latest/libraries/json-schema/reference/js-api/functions/$contains.md @@ -15,7 +15,7 @@ $contains( | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `target` | `Model` \| `ModelProperty` | +| `target` | `Type` | | `value` | `Type` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/json-schema/reference/js-api/functions/$contentEncoding.md b/packages/website/versioned_docs/version-latest/libraries/json-schema/reference/js-api/functions/$contentEncoding.md index e870014ec8..899fe9e016 100644 --- a/packages/website/versioned_docs/version-latest/libraries/json-schema/reference/js-api/functions/$contentEncoding.md +++ b/packages/website/versioned_docs/version-latest/libraries/json-schema/reference/js-api/functions/$contentEncoding.md @@ -15,7 +15,7 @@ $contentEncoding( | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `target` | `StringLiteral` \| `ModelProperty` | +| `target` | `Scalar` \| `ModelProperty` | | `value` | `string` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/json-schema/reference/js-api/functions/$contentMediaType.md b/packages/website/versioned_docs/version-latest/libraries/json-schema/reference/js-api/functions/$contentMediaType.md index 9a10f6fd39..8b0e86d5c1 100644 --- a/packages/website/versioned_docs/version-latest/libraries/json-schema/reference/js-api/functions/$contentMediaType.md +++ b/packages/website/versioned_docs/version-latest/libraries/json-schema/reference/js-api/functions/$contentMediaType.md @@ -15,7 +15,7 @@ $contentMediaType( | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `target` | `StringLiteral` \| `ModelProperty` | +| `target` | `Scalar` \| `ModelProperty` | | `value` | `string` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/json-schema/reference/js-api/functions/$contentSchema.md b/packages/website/versioned_docs/version-latest/libraries/json-schema/reference/js-api/functions/$contentSchema.md index f664a3f065..d22ee477e1 100644 --- a/packages/website/versioned_docs/version-latest/libraries/json-schema/reference/js-api/functions/$contentSchema.md +++ b/packages/website/versioned_docs/version-latest/libraries/json-schema/reference/js-api/functions/$contentSchema.md @@ -15,7 +15,7 @@ $contentSchema( | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `target` | `StringLiteral` \| `ModelProperty` | +| `target` | `Scalar` \| `ModelProperty` | | `value` | `Type` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/json-schema/reference/js-api/functions/$id.md b/packages/website/versioned_docs/version-latest/libraries/json-schema/reference/js-api/functions/$id.md index 36d72d7118..c649d21172 100644 --- a/packages/website/versioned_docs/version-latest/libraries/json-schema/reference/js-api/functions/$id.md +++ b/packages/website/versioned_docs/version-latest/libraries/json-schema/reference/js-api/functions/$id.md @@ -7,7 +7,7 @@ title: "[F] $id" $id( context, target, - value): void + id): void ``` ## Parameters @@ -15,8 +15,8 @@ $id( | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `target` | `Model` \| `Scalar` \| `Enum` \| `Union` | -| `value` | `string` | +| `target` | `Type` | +| `id` | `string` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/json-schema/reference/js-api/functions/$jsonSchema.md b/packages/website/versioned_docs/version-latest/libraries/json-schema/reference/js-api/functions/$jsonSchema.md index 79a46a5842..7f06cffe04 100644 --- a/packages/website/versioned_docs/version-latest/libraries/json-schema/reference/js-api/functions/$jsonSchema.md +++ b/packages/website/versioned_docs/version-latest/libraries/json-schema/reference/js-api/functions/$jsonSchema.md @@ -7,7 +7,7 @@ title: "[F] $jsonSchema" $jsonSchema( context, target, - baseUriOrId?): void + baseUri?): void ``` ## Parameters @@ -15,8 +15,8 @@ $jsonSchema( | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `target` | `Namespace` \| [`JsonSchemaDeclaration`](../type-aliases/JsonSchemaDeclaration.md) | -| `baseUriOrId`? | `string` | +| `target` | `Type` | +| `baseUri`? | `string` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/json-schema/reference/js-api/functions/$maxContains.md b/packages/website/versioned_docs/version-latest/libraries/json-schema/reference/js-api/functions/$maxContains.md index 7e576fdf86..112a0a5ac5 100644 --- a/packages/website/versioned_docs/version-latest/libraries/json-schema/reference/js-api/functions/$maxContains.md +++ b/packages/website/versioned_docs/version-latest/libraries/json-schema/reference/js-api/functions/$maxContains.md @@ -15,7 +15,7 @@ $maxContains( | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `target` | `Model` \| `ModelProperty` | +| `target` | `Type` | | `value` | `number` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/json-schema/reference/js-api/functions/$maxProperties.md b/packages/website/versioned_docs/version-latest/libraries/json-schema/reference/js-api/functions/$maxProperties.md index f91622f707..ad32709727 100644 --- a/packages/website/versioned_docs/version-latest/libraries/json-schema/reference/js-api/functions/$maxProperties.md +++ b/packages/website/versioned_docs/version-latest/libraries/json-schema/reference/js-api/functions/$maxProperties.md @@ -15,7 +15,7 @@ $maxProperties( | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `target` | `Model` \| `ModelProperty` | +| `target` | `Type` | | `value` | `number` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/json-schema/reference/js-api/functions/$minContains.md b/packages/website/versioned_docs/version-latest/libraries/json-schema/reference/js-api/functions/$minContains.md index 0ae50378ee..44074e3dce 100644 --- a/packages/website/versioned_docs/version-latest/libraries/json-schema/reference/js-api/functions/$minContains.md +++ b/packages/website/versioned_docs/version-latest/libraries/json-schema/reference/js-api/functions/$minContains.md @@ -15,7 +15,7 @@ $minContains( | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `target` | `Model` \| `ModelProperty` | +| `target` | `Type` | | `value` | `number` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/json-schema/reference/js-api/functions/$minProperties.md b/packages/website/versioned_docs/version-latest/libraries/json-schema/reference/js-api/functions/$minProperties.md index a48e1f0f64..4344763934 100644 --- a/packages/website/versioned_docs/version-latest/libraries/json-schema/reference/js-api/functions/$minProperties.md +++ b/packages/website/versioned_docs/version-latest/libraries/json-schema/reference/js-api/functions/$minProperties.md @@ -15,7 +15,7 @@ $minProperties( | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `target` | `Model` \| `ModelProperty` | +| `target` | `Type` | | `value` | `number` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/json-schema/reference/js-api/functions/$multipleOf.md b/packages/website/versioned_docs/version-latest/libraries/json-schema/reference/js-api/functions/$multipleOf.md index 7feeb085c1..11fad245a7 100644 --- a/packages/website/versioned_docs/version-latest/libraries/json-schema/reference/js-api/functions/$multipleOf.md +++ b/packages/website/versioned_docs/version-latest/libraries/json-schema/reference/js-api/functions/$multipleOf.md @@ -15,7 +15,7 @@ $multipleOf( | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `target` | `Model` | +| `target` | `Scalar` \| `ModelProperty` | | `value` | `number` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/json-schema/reference/js-api/functions/$prefixItems.md b/packages/website/versioned_docs/version-latest/libraries/json-schema/reference/js-api/functions/$prefixItems.md index f26b84cce1..5242fd4c67 100644 --- a/packages/website/versioned_docs/version-latest/libraries/json-schema/reference/js-api/functions/$prefixItems.md +++ b/packages/website/versioned_docs/version-latest/libraries/json-schema/reference/js-api/functions/$prefixItems.md @@ -15,8 +15,8 @@ $prefixItems( | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `target` | `Model` \| `ModelProperty` | -| `value` | `Tuple` | +| `target` | `Type` | +| `value` | `Type` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/json-schema/reference/js-api/functions/$uniqueItems.md b/packages/website/versioned_docs/version-latest/libraries/json-schema/reference/js-api/functions/$uniqueItems.md index cd02cd49ca..20481689b1 100644 --- a/packages/website/versioned_docs/version-latest/libraries/json-schema/reference/js-api/functions/$uniqueItems.md +++ b/packages/website/versioned_docs/version-latest/libraries/json-schema/reference/js-api/functions/$uniqueItems.md @@ -12,7 +12,7 @@ $uniqueItems(context, target): void | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `target` | `Model` \| `ModelProperty` | +| `target` | `Type` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/$defaultResponse.md b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/$defaultResponse.md index d22dfd043e..25ab4a45bf 100644 --- a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/$defaultResponse.md +++ b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/$defaultResponse.md @@ -4,7 +4,7 @@ title: "[F] $defaultResponse" --- ```ts -$defaultResponse(context, entity): void +$defaultResponse(context, target): void ``` ## Parameters @@ -12,7 +12,7 @@ $defaultResponse(context, entity): void | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `entity` | `Model` | +| `target` | `Model` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/$extension.md b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/$extension.md index 002ee5522f..b281f98f46 100644 --- a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/$extension.md +++ b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/$extension.md @@ -6,8 +6,8 @@ title: "[F] $extension" ```ts $extension( context, - entity, - extensionName, + target, + key, value): void ``` @@ -16,9 +16,9 @@ $extension( | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `entity` | `Type` | -| `extensionName` | `string` | -| `value` | `TypeSpecValue` | +| `target` | `Type` | +| `key` | `string` | +| `value` | `Type` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/$info.md b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/$info.md index e225208cdc..9dc9803a1a 100644 --- a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/$info.md +++ b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/$info.md @@ -6,8 +6,8 @@ title: "[F] $info" ```ts $info( context, - entity, - model): void + target, + additionalInfo): void ``` ## Parameters @@ -15,8 +15,8 @@ $info( | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `entity` | `Namespace` | -| `model` | `Model` | +| `target` | `Namespace` | +| `additionalInfo` | `Type` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/$operationId.md b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/$operationId.md index 7a8d026add..9528a9facf 100644 --- a/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/$operationId.md +++ b/packages/website/versioned_docs/version-latest/libraries/openapi/reference/js-api/functions/$operationId.md @@ -6,8 +6,8 @@ title: "[F] $operationId" ```ts $operationId( context, - entity, - opId): void + target, + operationId): void ``` Set a specific operation ID. @@ -17,8 +17,8 @@ Set a specific operation ID. | Parameter | Type | Description | | :------ | :------ | :------ | | `context` | `DecoratorContext` | Decorator Context | -| `entity` | `Operation` | Decorator target | -| `opId` | `string` | Operation ID. | +| `target` | `Operation` | - | +| `operationId` | `string` | - | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/openapi3/reference/js-api/functions/$oneOf.md b/packages/website/versioned_docs/version-latest/libraries/openapi3/reference/js-api/functions/$oneOf.md index 6277e79783..b87337b5f9 100644 --- a/packages/website/versioned_docs/version-latest/libraries/openapi3/reference/js-api/functions/$oneOf.md +++ b/packages/website/versioned_docs/version-latest/libraries/openapi3/reference/js-api/functions/$oneOf.md @@ -4,7 +4,7 @@ title: "[F] $oneOf" --- ```ts -$oneOf(context, entity): void +$oneOf(context, target): void ``` ## Parameters @@ -12,7 +12,7 @@ $oneOf(context, entity): void | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `entity` | `ModelProperty` \| `Union` | +| `target` | `ModelProperty` \| `Union` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/openapi3/reference/js-api/functions/$useRef.md b/packages/website/versioned_docs/version-latest/libraries/openapi3/reference/js-api/functions/$useRef.md index 5e47bd6b33..c68f406008 100644 --- a/packages/website/versioned_docs/version-latest/libraries/openapi3/reference/js-api/functions/$useRef.md +++ b/packages/website/versioned_docs/version-latest/libraries/openapi3/reference/js-api/functions/$useRef.md @@ -6,8 +6,8 @@ title: "[F] $useRef" ```ts $useRef( context, - entity, - refUrl): void + target, + ref): void ``` ## Parameters @@ -15,8 +15,8 @@ $useRef( | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `entity` | `Model` \| `ModelProperty` | -| `refUrl` | `string` | +| `target` | `ModelProperty` \| `Model` | +| `ref` | `string` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/protobuf/reference/js-api/functions/$field.md b/packages/website/versioned_docs/version-latest/libraries/protobuf/reference/js-api/functions/$field.md index 43af2a945a..c12164c1c3 100644 --- a/packages/website/versioned_docs/version-latest/libraries/protobuf/reference/js-api/functions/$field.md +++ b/packages/website/versioned_docs/version-latest/libraries/protobuf/reference/js-api/functions/$field.md @@ -5,9 +5,9 @@ title: "[F] $field" --- ```ts $field( - ctx, + context, target, - fieldIndex): void + index): void ``` Decorate a model property with a field index. Field indices are required for all fields of emitted messages. @@ -16,9 +16,9 @@ Decorate a model property with a field index. Field indices are required for all | Parameter | Type | Description | | :------ | :------ | :------ | -| `ctx` | `DecoratorContext` | - | +| `context` | `DecoratorContext` | - | | `target` | `ModelProperty` | | -| `fieldIndex` | `number` | | +| `index` | `number` | - | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/protobuf/reference/js-api/functions/$message.md b/packages/website/versioned_docs/version-latest/libraries/protobuf/reference/js-api/functions/$message.md index a20a75e381..bdd2d0b130 100644 --- a/packages/website/versioned_docs/version-latest/libraries/protobuf/reference/js-api/functions/$message.md +++ b/packages/website/versioned_docs/version-latest/libraries/protobuf/reference/js-api/functions/$message.md @@ -4,15 +4,15 @@ title: "[F] $message" --- ```ts -$message(ctx, target): void +$message(context, target): void ``` ## Parameters | Parameter | Type | | :------ | :------ | -| `ctx` | `DecoratorContext` | -| `target` | `Model` | +| `context` | `DecoratorContext` | +| `target` | `Type` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/protobuf/reference/js-api/functions/$package.md b/packages/website/versioned_docs/version-latest/libraries/protobuf/reference/js-api/functions/$package.md index b4ce8f4a9b..e5106863b5 100644 --- a/packages/website/versioned_docs/version-latest/libraries/protobuf/reference/js-api/functions/$package.md +++ b/packages/website/versioned_docs/version-latest/libraries/protobuf/reference/js-api/functions/$package.md @@ -5,7 +5,7 @@ title: "[F] $package" --- ```ts $package( - ctx, + context, target, details?): void ``` @@ -16,9 +16,9 @@ Declare a Protobuf package. | Parameter | Type | Description | | :------ | :------ | :------ | -| `ctx` | `DecoratorContext` | decorator context | +| `context` | `DecoratorContext` | - | | `target` | `Namespace` | target decorator namespace | -| `details`? | `Model` | - | +| `details`? | `Type` | - | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/protobuf/reference/js-api/functions/$reserve.md b/packages/website/versioned_docs/version-latest/libraries/protobuf/reference/js-api/functions/$reserve.md index a97299ce2f..c16acc6e4c 100644 --- a/packages/website/versioned_docs/version-latest/libraries/protobuf/reference/js-api/functions/$reserve.md +++ b/packages/website/versioned_docs/version-latest/libraries/protobuf/reference/js-api/functions/$reserve.md @@ -5,7 +5,7 @@ title: "[F] $reserve" --- ```ts $reserve( - ctx, + context, target, ... reservations): void ``` @@ -14,9 +14,9 @@ $reserve( | Parameter | Type | | :------ | :------ | -| `ctx` | `DecoratorContext` | -| `target` | `Model` | -| ...`reservations` | readonly (`string` \| `number` \| `Type`)[] | +| `context` | `DecoratorContext` | +| `target` | `Type` | +| ...`reservations` | `unknown`[] | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/protobuf/reference/js-api/functions/$stream.md b/packages/website/versioned_docs/version-latest/libraries/protobuf/reference/js-api/functions/$stream.md index e377d92751..4f82a6343b 100644 --- a/packages/website/versioned_docs/version-latest/libraries/protobuf/reference/js-api/functions/$stream.md +++ b/packages/website/versioned_docs/version-latest/libraries/protobuf/reference/js-api/functions/$stream.md @@ -5,7 +5,7 @@ title: "[F] $stream" --- ```ts $stream( - ctx, + context, target, mode): void ``` @@ -14,9 +14,9 @@ $stream( | Parameter | Type | | :------ | :------ | -| `ctx` | `DecoratorContext` | +| `context` | `DecoratorContext` | | `target` | `Operation` | -| `mode` | `EnumMember` | +| `mode` | `Type` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$action.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$action.md index 2e794ae091..7c45e08a5c 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$action.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$action.md @@ -6,7 +6,7 @@ title: "[F] $action" ```ts $action( context, - entity, + target, name?): void ``` @@ -15,7 +15,7 @@ $action( | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `entity` | `Operation` | +| `target` | `Operation` | | `name`? | `string` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$actionSegment.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$actionSegment.md index bbd5fc7700..7b2a7c302e 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$actionSegment.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$actionSegment.md @@ -6,8 +6,8 @@ title: "[F] $actionSegment" ```ts $actionSegment( context, - entity, - name): void + target, + value): void ``` ## Parameters @@ -15,8 +15,8 @@ $actionSegment( | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `entity` | `Operation` | -| `name` | `string` | +| `target` | `Operation` | +| `value` | `string` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$actionSeparator.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$actionSeparator.md index ae4bfadc13..595b0ae5a7 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$actionSeparator.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$actionSeparator.md @@ -20,7 +20,7 @@ $actionSeparator( | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `entity` | `Model` \| `ModelProperty` \| `Operation` | +| `entity` | `ModelProperty` \| `Model` \| `Operation` | | `separator` | `"/"` \| `":"` \| `"/:"` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$autoRoute.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$autoRoute.md index 56c6bc5b29..7c97e67eee 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$autoRoute.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$autoRoute.md @@ -4,7 +4,7 @@ title: "[F] $autoRoute" --- ```ts -$autoRoute(context, entity): void +$autoRoute(context, target): void ``` `@autoRoute` enables automatic route generation for an operation or interface. @@ -18,7 +18,7 @@ auto-generated routes. | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `entity` | `Interface` \| `Operation` | +| `target` | `Interface` \| `Operation` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$collectionAction.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$collectionAction.md index d76dc86f31..59d491664f 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$collectionAction.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$collectionAction.md @@ -6,7 +6,7 @@ title: "[F] $collectionAction" ```ts $collectionAction( context, - entity, + target, resourceType, name?): void ``` @@ -16,7 +16,7 @@ $collectionAction( | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `entity` | `Operation` | +| `target` | `Operation` | | `resourceType` | `Model` | | `name`? | `string` | diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$listsResource.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$listsResource.md index c44c4c93d5..ebf860a285 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$listsResource.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$listsResource.md @@ -6,7 +6,7 @@ title: "[F] $listsResource" ```ts $listsResource( context, - entity, + target, resourceType): void ``` @@ -15,7 +15,7 @@ $listsResource( | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `entity` | `Operation` | +| `target` | `Operation` | | `resourceType` | `Model` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$parentResource.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$parentResource.md index fb6ccf19ff..b8990d5102 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$parentResource.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$parentResource.md @@ -6,8 +6,8 @@ title: "[F] $parentResource" ```ts $parentResource( context, - entity, - parentType): void + target, + parent): void ``` `@parentResource` marks a model with a reference to its parent resource type @@ -23,8 +23,8 @@ the target type to show up in operations of the `Resource*` interfaces define | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `entity` | `Type` | -| `parentType` | `Model` | +| `target` | `Model` | +| `parent` | `Model` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$readsResource.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$readsResource.md index 3f2f247573..3c1424f9c0 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$readsResource.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$readsResource.md @@ -6,7 +6,7 @@ title: "[F] $readsResource" ```ts $readsResource( context, - entity, + target, resourceType): void ``` @@ -15,7 +15,7 @@ $readsResource( | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `entity` | `Operation` | +| `target` | `Operation` | | `resourceType` | `Model` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$resource.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$resource.md index 728fb6375e..4f2bb0e812 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$resource.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$resource.md @@ -6,7 +6,7 @@ title: "[F] $resource" ```ts $resource( context, - entity, + target, collectionName): void ``` @@ -23,7 +23,7 @@ name of `widgets`. | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `entity` | `Model` | +| `target` | `Model` | | `collectionName` | `string` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$resourceLocation.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$resourceLocation.md index 86bd604894..350044c631 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$resourceLocation.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$resourceLocation.md @@ -6,7 +6,7 @@ title: "[F] $resourceLocation" ```ts $resourceLocation( context, - entity, + target, resourceType): void ``` @@ -15,7 +15,7 @@ $resourceLocation( | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `entity` | `Model` | +| `target` | `Scalar` | | `resourceType` | `Model` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$segment.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$segment.md index 3f790317cd..1dcc213df9 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$segment.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$segment.md @@ -22,7 +22,7 @@ path parameter's name field. | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `entity` | `Model` \| `ModelProperty` \| `Operation` | +| `entity` | `ModelProperty` \| `Model` \| `Operation` | | `name` | `string` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$segmentOf.md b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$segmentOf.md index 725f4a7ae3..b90d9f5803 100644 --- a/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$segmentOf.md +++ b/packages/website/versioned_docs/version-latest/libraries/rest/reference/js-api/functions/$segmentOf.md @@ -6,8 +6,8 @@ title: "[F] $segmentOf" ```ts $segmentOf( context, - entity, - resourceType): void + target, + type): void ``` ## Parameters @@ -15,8 +15,8 @@ $segmentOf( | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `entity` | `Operation` | -| `resourceType` | `Model` | +| `target` | `Operation` | +| `type` | `Model` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$added.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$added.md index 2895a11a1c..07fd15966f 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$added.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$added.md @@ -6,8 +6,8 @@ title: "[F] $added" ```ts $added( context, - t, - v): void + target, + version): void ``` ## Parameters @@ -15,8 +15,8 @@ $added( | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `t` | \| `Model` \| `ModelProperty` \| `Scalar` \| `Enum` \| `EnumMember` \| `Operation` \| `Union` \| `UnionVariant` \| `Interface` | -| `v` | `EnumMember` | +| `target` | \| `Scalar` \| `ModelProperty` \| `Model` \| `Interface` \| `Enum` \| `EnumMember` \| `Operation` \| `Union` \| `UnionVariant` | +| `version` | `EnumMember` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$madeOptional.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$madeOptional.md index 1a56411398..2513a9314e 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$madeOptional.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$madeOptional.md @@ -6,8 +6,8 @@ title: "[F] $madeOptional" ```ts $madeOptional( context, - t, - v): void + target, + version): void ``` ## Parameters @@ -15,8 +15,8 @@ $madeOptional( | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `t` | `ModelProperty` | -| `v` | `EnumMember` | +| `target` | `ModelProperty` | +| `version` | `EnumMember` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$removed.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$removed.md index 9434c4b4fa..29716f7d5c 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$removed.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$removed.md @@ -15,7 +15,7 @@ $removed( | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `t` | \| `Model` \| `ModelProperty` \| `Scalar` \| `Enum` \| `EnumMember` \| `Operation` \| `Union` \| `UnionVariant` \| `Interface` | +| `t` | \| `Scalar` \| `ModelProperty` \| `Model` \| `Interface` \| `Enum` \| `EnumMember` \| `Operation` \| `Union` \| `UnionVariant` | | `v` | `EnumMember` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$renamedFrom.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$renamedFrom.md index e33a8adb75..b5f13c5052 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$renamedFrom.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$renamedFrom.md @@ -6,8 +6,8 @@ title: "[F] $renamedFrom" ```ts $renamedFrom( context, - t, - v, + target, + version, oldName): void ``` @@ -16,8 +16,8 @@ $renamedFrom( | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `t` | \| `Model` \| `ModelProperty` \| `Scalar` \| `Enum` \| `EnumMember` \| `Operation` \| `Union` \| `UnionVariant` \| `Interface` | -| `v` | `EnumMember` | +| `target` | \| `Scalar` \| `ModelProperty` \| `Model` \| `Interface` \| `Enum` \| `EnumMember` \| `Operation` \| `Union` \| `UnionVariant` | +| `version` | `EnumMember` | | `oldName` | `string` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$returnTypeChangedFrom.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$returnTypeChangedFrom.md index ee6148a2f5..4be50ea782 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$returnTypeChangedFrom.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$returnTypeChangedFrom.md @@ -6,9 +6,9 @@ title: "[F] $returnTypeChangedFrom" ```ts $returnTypeChangedFrom( context, - op, - v, - oldReturnType): void + target, + version, + oldType): void ``` ## Parameters @@ -16,9 +16,9 @@ $returnTypeChangedFrom( | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `op` | `Operation` | -| `v` | `EnumMember` | -| `oldReturnType` | `any` | +| `target` | `Operation` | +| `version` | `EnumMember` | +| `oldType` | `Type` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$typeChangedFrom.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$typeChangedFrom.md index 819a72520e..961a253b18 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$typeChangedFrom.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$typeChangedFrom.md @@ -6,8 +6,8 @@ title: "[F] $typeChangedFrom" ```ts $typeChangedFrom( context, - prop, - v, + target, + version, oldType): void ``` @@ -16,9 +16,9 @@ $typeChangedFrom( | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `prop` | `ModelProperty` | -| `v` | `EnumMember` | -| `oldType` | `any` | +| `target` | `ModelProperty` | +| `version` | `EnumMember` | +| `oldType` | `Type` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$versioned.md b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$versioned.md index e5b86d0cf6..e3bab32690 100644 --- a/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$versioned.md +++ b/packages/website/versioned_docs/version-latest/libraries/versioning/reference/js-api/functions/$versioned.md @@ -6,7 +6,7 @@ title: "[F] $versioned" ```ts $versioned( context, - t, + target, versions): void ``` @@ -15,7 +15,7 @@ $versioned( | Parameter | Type | | :------ | :------ | | `context` | `DecoratorContext` | -| `t` | `Namespace` | +| `target` | `Namespace` | | `versions` | `Enum` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/release-notes/release-2024-04-02.md b/packages/website/versioned_docs/version-latest/release-notes/release-2024-04-02.md new file mode 100644 index 0000000000..590557a3f6 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/release-notes/release-2024-04-02.md @@ -0,0 +1,65 @@ +--- +title: 0.55 - April 2024 +--- + +# Release Notes Version 0.55 - April 2024 + +:::warning +This release contains deprecations +::: + +## Deprecations + +### @typespec/compiler + +- [#2910](https://github.com/microsoft/typespec/pull/2910) Deprecate `@projectedName` decorator. `@encodedName` should be used instead. + + Example: + + ```diff + -@projectedName("json", "exp") + +@encodedName("application/json", "exp") + ``` + +- [#3094](https://github.com/microsoft/typespec/pull/3094) Deprecate `@knownValues` decorator. Use a named union of string literal with a string variant to achieve the same result without a decorator + + Example: + + ```diff + -enum FooKV { a, b, c} + -@knownValues(FooKV) + -scalar foo extends string; + +union Foo { "a", "b", "c", string } + ``` + +## Features + +### @typespec/compiler + +- [#2992](https://github.com/microsoft/typespec/pull/2992) Enable the use of `@encode` for model properties that have a union type. This supports cases like `@encode("rfc3339") prop: utcDateTime | null` + +### @typespec/versioning + +- [#3053](https://github.com/microsoft/typespec/pull/3053) Add support for versioning of scalars(Added, removed, renamed) + +## Bug Fixes + +### @typespec/compiler + +- [#3018](https://github.com/microsoft/typespec/pull/3018) Grammar: Fix comments in template params not tokenized +- [#3052](https://github.com/microsoft/typespec/pull/3052) Fix: Union template declaration were incorrectly being finished in projection +- [#2983](https://github.com/microsoft/typespec/pull/2983) Warnings converted to error with `warn-as-error` do not prevent compilation from moving to the next stage like regular warnings +- [#3041](https://github.com/microsoft/typespec/pull/3041) Improve reliability of application of codefixes in IDE, often it would not do anything +- [#3069](https://github.com/microsoft/typespec/pull/3069) TmLanguage: Fix tokenization of escaped identifiers, enums and unions + +### @typespec/openapi3 + +- [#3077](https://github.com/microsoft/typespec/pull/3077) Do not crash if using an unsupported intrinsic type +- [#2967](https://github.com/microsoft/typespec/pull/2967) Fix crash: emit `{nullable: true}` when trying to emit `null` in openapi3 +- [#3013](https://github.com/microsoft/typespec/pull/3013) Fix: OpenAPI3 not marking part of bytes or something else as `format: binary` +- [#3090](https://github.com/microsoft/typespec/pull/3090) Fix: Literal unions with the same variants keep adding duplicate entries +- [#3049](https://github.com/microsoft/typespec/pull/3049) Fix visibility naming conflict when a model used with `extends` was used in different visibility. + +### @typespec/eslint-config-typespec + +- [#2122](https://github.com/microsoft/typespec/pull/2122) Ignore `generated-defs` folder diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/SyntaxKind.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/SyntaxKind.md index d1e480c3f6..5c660c344f 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/SyntaxKind.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/enumerations/SyntaxKind.md @@ -37,7 +37,7 @@ AST types | `InterfaceStatement` | `18` | - | | `IntersectionExpression` | `29` | - | | `InvalidStatement` | `49` | - | -| `JsNamespaceDeclaration` | `89` | - | +| `JsNamespaceDeclaration` | `90` | - | | `JsSourceFile` | `1` | - | | `LineComment` | `50` | - | | `MemberExpression` | `7` | - | @@ -52,36 +52,37 @@ AST types | `OperationSignatureReference` | `12` | - | | `OperationStatement` | `10` | - | | `Projection` | `59` | - | -| `ProjectionArithmeticExpression` | `77` | - | -| `ProjectionBlockExpression` | `71` | - | -| `ProjectionCallExpression` | `78` | - | -| `ProjectionDecoratorReferenceExpression` | `87` | - | -| `ProjectionEnumMemberSelector` | `68` | - | -| `ProjectionEnumSelector` | `67` | - | -| `ProjectionEqualityExpression` | `74` | - | -| `ProjectionExpressionStatement` | `69` | - | -| `ProjectionIfExpression` | `70` | - | -| `ProjectionInterfaceSelector` | `66` | - | -| `ProjectionLambdaExpression` | `79` | - | -| `ProjectionLambdaParameterDeclaration` | `80` | - | -| `ProjectionLogicalExpression` | `73` | - | -| `ProjectionMemberExpression` | `72` | - | -| `ProjectionModelExpression` | `81` | - | -| `ProjectionModelProperty` | `82` | - | +| `ProjectionArithmeticExpression` | `78` | - | +| `ProjectionBlockExpression` | `72` | - | +| `ProjectionCallExpression` | `79` | - | +| `ProjectionDecoratorReferenceExpression` | `88` | - | +| `ProjectionEnumMemberSelector` | `69` | - | +| `ProjectionEnumSelector` | `68` | - | +| `ProjectionEqualityExpression` | `75` | - | +| `ProjectionExpressionStatement` | `70` | - | +| `ProjectionIfExpression` | `71` | - | +| `ProjectionInterfaceSelector` | `67` | - | +| `ProjectionLambdaExpression` | `80` | - | +| `ProjectionLambdaParameterDeclaration` | `81` | - | +| `ProjectionLogicalExpression` | `74` | - | +| `ProjectionMemberExpression` | `73` | - | +| `ProjectionModelExpression` | `82` | - | +| `ProjectionModelProperty` | `83` | - | | `ProjectionModelPropertySelector` | `62` | - | | `ProjectionModelSelector` | `61` | - | -| `ProjectionModelSpreadProperty` | `83` | - | -| `ProjectionOperationSelector` | `63` | - | +| `ProjectionModelSpreadProperty` | `84` | - | +| `ProjectionOperationSelector` | `64` | - | | `ProjectionParameterDeclaration` | `60` | - | | `ProjectionReference` | `46` | - | -| `ProjectionRelationalExpression` | `76` | - | -| `ProjectionSpreadProperty` | `84` | - | -| `ProjectionStatement` | `86` | - | -| `ProjectionTupleExpression` | `85` | - | -| `ProjectionUnaryExpression` | `75` | - | -| `ProjectionUnionSelector` | `64` | - | -| `ProjectionUnionVariantSelector` | `65` | - | -| `Return` | `88` | - | +| `ProjectionRelationalExpression` | `77` | - | +| `ProjectionScalarSelector` | `63` | - | +| `ProjectionSpreadProperty` | `85` | - | +| `ProjectionStatement` | `87` | - | +| `ProjectionTupleExpression` | `86` | - | +| `ProjectionUnaryExpression` | `76` | - | +| `ProjectionUnionSelector` | `65` | - | +| `ProjectionUnionVariantSelector` | `66` | - | +| `Return` | `89` | - | | `ScalarStatement` | `17` | - | | `StringLiteral` | `32` | - | | `StringTemplateExpression` | `35` | - | @@ -89,7 +90,7 @@ AST types | `StringTemplateMiddle` | `37` | - | | `StringTemplateSpan` | `39` | - | | `StringTemplateTail` | `38` | - | -| `TemplateArgument` | `90` | - | +| `TemplateArgument` | `91` | - | | `TemplateParameterDeclaration` | `47` | - | | `TupleExpression` | `30` | - | | `TypeReference` | `45` | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$discriminator.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$discriminator.md index d1cb665454..730a4d2076 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$discriminator.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$discriminator.md @@ -6,7 +6,7 @@ title: "[F] $discriminator" ```ts $discriminator( context, - entity, + target, propertyName): void ``` @@ -15,7 +15,7 @@ $discriminator( | Parameter | Type | | :------ | :------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | -| `entity` | [`Model`](../interfaces/Model.md) \| [`Union`](../interfaces/Union.md) | +| `target` | [`Model`](../interfaces/Model.md) \| [`Union`](../interfaces/Union.md) | | `propertyName` | `string` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$doc.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$doc.md index 837ffa56d6..874967f9e0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$doc.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$doc.md @@ -7,8 +7,8 @@ title: "[F] $doc" $doc( context, target, - text, - sourceObject?): void + doc, + formatArgs?): void ``` ## Parameters @@ -17,8 +17,8 @@ $doc( | :------ | :------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`Type`](../type-aliases/Type.md) | -| `text` | `string` | -| `sourceObject`? | [`Type`](../type-aliases/Type.md) | +| `doc` | `string` | +| `formatArgs`? | [`Type`](../type-aliases/Type.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$encode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$encode.md index 822aabe4ce..733e8d82b0 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$encode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$encode.md @@ -8,7 +8,7 @@ $encode( context, target, encoding, - encodeAs?): void + encodedAs?): void ``` ## Parameters @@ -16,9 +16,9 @@ $encode( | Parameter | Type | | :------ | :------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | -| `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | -| `encoding` | `string` \| [`EnumMember`](../interfaces/EnumMember.md) | -| `encodeAs`? | [`Scalar`](../interfaces/Scalar.md) | +| `target` | [`Scalar`](../interfaces/Scalar.md) \| [`ModelProperty`](../interfaces/ModelProperty.md) | +| `encoding` | [`Type`](../type-aliases/Type.md) | +| `encodedAs`? | [`Scalar`](../interfaces/Scalar.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$error.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$error.md index 16676ca780..8a19de4299 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$error.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$error.md @@ -4,7 +4,7 @@ title: "[F] $error" --- ```ts -$error(context, entity): void +$error(context, target): void ``` `@error` decorator marks a model as an error type. @@ -15,7 +15,7 @@ $error(context, entity): void | Parameter | Type | | :------ | :------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | -| `entity` | [`Model`](../interfaces/Model.md) | +| `target` | [`Model`](../interfaces/Model.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$errorsDoc.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$errorsDoc.md index 75e3a82aa1..20301ec58d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$errorsDoc.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$errorsDoc.md @@ -7,7 +7,7 @@ title: "[F] $errorsDoc" $errorsDoc( context, target, - text): void + doc): void ``` ## Parameters @@ -16,7 +16,7 @@ $errorsDoc( | :------ | :------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`Operation`](../interfaces/Operation.md) | -| `text` | `string` | +| `doc` | `string` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$format.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$format.md index 2bd92aee43..a8af2e6751 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$format.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$format.md @@ -27,7 +27,7 @@ https://github.com/OAI/OpenAPI-Specification/blob/3.0.3/versions/3.0.3.md#dataTy | Parameter | Type | | :------ | :------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | -| `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | +| `target` | [`Scalar`](../interfaces/Scalar.md) \| [`ModelProperty`](../interfaces/ModelProperty.md) | | `format` | `string` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$friendlyName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$friendlyName.md index 28215ca021..3b8bf8bbb3 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$friendlyName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$friendlyName.md @@ -7,8 +7,8 @@ title: "[F] $friendlyName" $friendlyName( context, target, - friendlyName, - sourceObject): void + name, + formatArgs?): void ``` ## Parameters @@ -17,8 +17,8 @@ $friendlyName( | :------ | :------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`Type`](../type-aliases/Type.md) | -| `friendlyName` | `string` | -| `sourceObject` | `undefined` \| [`Type`](../type-aliases/Type.md) | +| `name` | `string` | +| `formatArgs`? | [`Type`](../type-aliases/Type.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$inspectType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$inspectType.md index 583af24f3d..170d63cccd 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$inspectType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$inspectType.md @@ -5,7 +5,7 @@ title: "[F] $inspectType" --- ```ts $inspectType( - program, + context, target, text): void ``` @@ -14,7 +14,7 @@ $inspectType( | Parameter | Type | | :------ | :------ | -| `program` | [`Program`](../interfaces/Program.md) | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`Type`](../type-aliases/Type.md) | | `text` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$inspectTypeName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$inspectTypeName.md index 8304c4567e..693ab993e3 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$inspectTypeName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$inspectTypeName.md @@ -5,7 +5,7 @@ title: "[F] $inspectTypeName" --- ```ts $inspectTypeName( - program, + context, target, text): void ``` @@ -14,7 +14,7 @@ $inspectTypeName( | Parameter | Type | | :------ | :------ | -| `program` | [`Program`](../interfaces/Program.md) | +| `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`Type`](../type-aliases/Type.md) | | `text` | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$key.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$key.md index dbb92c3e21..0b1d41e0a6 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$key.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$key.md @@ -6,7 +6,7 @@ title: "[F] $key" ```ts $key( context, - entity, + target, altName?): void ``` @@ -22,7 +22,7 @@ Otherwise, the name of the target property will be used. | Parameter | Type | | :------ | :------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | -| `entity` | [`ModelProperty`](../interfaces/ModelProperty.md) | +| `target` | [`ModelProperty`](../interfaces/ModelProperty.md) | | `altName`? | `string` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$knownValues.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$knownValues.md index 65315b1f3d..0e0b47ddaa 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$knownValues.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$knownValues.md @@ -22,7 +22,7 @@ type accepts. | Parameter | Type | Description | | :------ | :------ | :------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | - | -| `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | Decorator target. Must be a string. (model Foo extends string) | +| `target` | [`Scalar`](../interfaces/Scalar.md) \| [`ModelProperty`](../interfaces/ModelProperty.md) | Decorator target. Must be a string. (model Foo extends string) | | `knownValues` | [`Enum`](../interfaces/Enum.md) | Must be an enum. | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$list.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$list.md index b96907d0b0..54543b658b 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$list.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$list.md @@ -16,7 +16,7 @@ $list( | :------ | :------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`Operation`](../interfaces/Operation.md) | -| `listedType`? | [`Type`](../type-aliases/Type.md) | +| `listedType`? | [`Model`](../interfaces/Model.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxItems.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxItems.md index 23df1fab85..72526d8170 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxItems.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxItems.md @@ -7,7 +7,7 @@ title: "[F] $maxItems" $maxItems( context, target, - maxItems): void + value): void ``` ## Parameters @@ -15,8 +15,8 @@ $maxItems( | Parameter | Type | | :------ | :------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | -| `target` | [`Model`](../interfaces/Model.md) \| [`ModelProperty`](../interfaces/ModelProperty.md) | -| `maxItems` | `number` | +| `target` | [`Type`](../type-aliases/Type.md) | +| `value` | `number` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxLength.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxLength.md index b3ebd75c1b..470d7b8d6c 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxLength.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxLength.md @@ -7,7 +7,7 @@ title: "[F] $maxLength" $maxLength( context, target, - maxLength): void + value): void ``` ## Parameters @@ -15,8 +15,8 @@ $maxLength( | Parameter | Type | | :------ | :------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | -| `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | -| `maxLength` | `number` | +| `target` | [`Scalar`](../interfaces/Scalar.md) \| [`ModelProperty`](../interfaces/ModelProperty.md) | +| `value` | `number` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxValue.md index f1c3146452..a730209897 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxValue.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxValue.md @@ -7,7 +7,7 @@ title: "[F] $maxValue" $maxValue( context, target, - maxValue): void + value): void ``` ## Parameters @@ -15,8 +15,8 @@ $maxValue( | Parameter | Type | | :------ | :------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | -| `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | -| `maxValue` | `number` | +| `target` | [`Scalar`](../interfaces/Scalar.md) \| [`ModelProperty`](../interfaces/ModelProperty.md) | +| `value` | `number` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxValueExclusive.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxValueExclusive.md index e9973d538e..c5c6c08499 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxValueExclusive.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$maxValueExclusive.md @@ -7,7 +7,7 @@ title: "[F] $maxValueExclusive" $maxValueExclusive( context, target, - maxValueExclusive): void + value): void ``` ## Parameters @@ -15,8 +15,8 @@ $maxValueExclusive( | Parameter | Type | | :------ | :------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | -| `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | -| `maxValueExclusive` | `number` | +| `target` | [`Scalar`](../interfaces/Scalar.md) \| [`ModelProperty`](../interfaces/ModelProperty.md) | +| `value` | `number` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minItems.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minItems.md index 78323e0fbc..44a0f2e999 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minItems.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minItems.md @@ -7,7 +7,7 @@ title: "[F] $minItems" $minItems( context, target, - minItems): void + value): void ``` ## Parameters @@ -15,8 +15,8 @@ $minItems( | Parameter | Type | | :------ | :------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | -| `target` | [`Model`](../interfaces/Model.md) \| [`ModelProperty`](../interfaces/ModelProperty.md) | -| `minItems` | `number` | +| `target` | [`Type`](../type-aliases/Type.md) | +| `value` | `number` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minLength.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minLength.md index a19f4146fc..3f2c0e8e95 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minLength.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minLength.md @@ -7,7 +7,7 @@ title: "[F] $minLength" $minLength( context, target, - minLength): void + value): void ``` ## Parameters @@ -15,8 +15,8 @@ $minLength( | Parameter | Type | | :------ | :------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | -| `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | -| `minLength` | `number` | +| `target` | [`Scalar`](../interfaces/Scalar.md) \| [`ModelProperty`](../interfaces/ModelProperty.md) | +| `value` | `number` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minValue.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minValue.md index cf2965d52d..a02f3cf0cf 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minValue.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minValue.md @@ -7,7 +7,7 @@ title: "[F] $minValue" $minValue( context, target, - minValue): void + value): void ``` ## Parameters @@ -15,8 +15,8 @@ $minValue( | Parameter | Type | | :------ | :------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | -| `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | -| `minValue` | `number` | +| `target` | [`Scalar`](../interfaces/Scalar.md) \| [`ModelProperty`](../interfaces/ModelProperty.md) | +| `value` | `number` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minValueExclusive.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minValueExclusive.md index 3ff7809fe5..92b95141ca 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minValueExclusive.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$minValueExclusive.md @@ -7,7 +7,7 @@ title: "[F] $minValueExclusive" $minValueExclusive( context, target, - minValueExclusive): void + value): void ``` ## Parameters @@ -15,8 +15,8 @@ $minValueExclusive( | Parameter | Type | | :------ | :------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | -| `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | -| `minValueExclusive` | `number` | +| `target` | [`Scalar`](../interfaces/Scalar.md) \| [`ModelProperty`](../interfaces/ModelProperty.md) | +| `value` | `number` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$overload.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$overload.md index 58734fa746..3f936ba8ea 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$overload.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$overload.md @@ -7,7 +7,7 @@ title: "[F] $overload" $overload( context, target, - overloadBase): void + overloadbase): void ``` `@overload` - Indicate that the target overloads (specializes) the overloads type. @@ -18,7 +18,7 @@ $overload( | :------ | :------ | :------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | DecoratorContext | | `target` | [`Operation`](../interfaces/Operation.md) | The specializing operation declaration | -| `overloadBase` | [`Operation`](../interfaces/Operation.md) | The operation to be overloaded. | +| `overloadbase` | [`Operation`](../interfaces/Operation.md) | - | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$parameterVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$parameterVisibility.md index 97ff6a8662..d5e50e80be 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$parameterVisibility.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$parameterVisibility.md @@ -6,7 +6,7 @@ title: "[F] $parameterVisibility" ```ts $parameterVisibility( context, - entity, ... + target, ... visibilities): void ``` @@ -15,7 +15,7 @@ $parameterVisibility( | Parameter | Type | | :------ | :------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | -| `entity` | [`Operation`](../interfaces/Operation.md) | +| `target` | [`Operation`](../interfaces/Operation.md) | | ...`visibilities` | `string`[] | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$pattern.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$pattern.md index 922fa8a12a..b80b5ac720 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$pattern.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$pattern.md @@ -16,7 +16,7 @@ $pattern( | Parameter | Type | | :------ | :------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | -| `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | +| `target` | [`Scalar`](../interfaces/Scalar.md) \| [`ModelProperty`](../interfaces/ModelProperty.md) | | `pattern` | `string` | | `validationMessage`? | `string` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$projectedName.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$projectedName.md index bb942d28d9..d24686d40e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$projectedName.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$projectedName.md @@ -7,7 +7,7 @@ title: "[F] $projectedName" $projectedName( context, target, - projectionName, + targetName, projectedName): void ``` @@ -19,7 +19,7 @@ $projectedName( | :------ | :------ | :------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | DecoratorContext | | `target` | [`Type`](../type-aliases/Type.md) | The that should have a different name. | -| `projectionName` | `string` | Name of the projection (e.g. "toJson", "toCSharp") | +| `targetName` | `string` | - | | `projectedName` | `string` | Name of the type should have in the scope of the projection specified. | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$returnTypeVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$returnTypeVisibility.md index 5fbab40c75..87ceeaa964 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$returnTypeVisibility.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$returnTypeVisibility.md @@ -6,7 +6,7 @@ title: "[F] $returnTypeVisibility" ```ts $returnTypeVisibility( context, - entity, ... + target, ... visibilities): void ``` @@ -15,7 +15,7 @@ $returnTypeVisibility( | Parameter | Type | | :------ | :------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | -| `entity` | [`Operation`](../interfaces/Operation.md) | +| `target` | [`Operation`](../interfaces/Operation.md) | | ...`visibilities` | `string`[] | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$returnsDoc.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$returnsDoc.md index d0f5b2dff2..d1300a9a84 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$returnsDoc.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$returnsDoc.md @@ -7,7 +7,7 @@ title: "[F] $returnsDoc" $returnsDoc( context, target, - text): void + doc): void ``` ## Parameters @@ -16,7 +16,7 @@ $returnsDoc( | :------ | :------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`Operation`](../interfaces/Operation.md) | -| `text` | `string` | +| `doc` | `string` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$secret.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$secret.md index 4fe5aa9ad7..5e78d478b8 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$secret.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$secret.md @@ -14,7 +14,7 @@ Mark a string as a secret value that should be treated carefully to avoid exposu | Parameter | Type | Description | | :------ | :------ | :------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | Decorator context | -| `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | Decorator target, either a string model or a property with type string. | +| `target` | [`Scalar`](../interfaces/Scalar.md) \| [`ModelProperty`](../interfaces/ModelProperty.md) | Decorator target, either a string model or a property with type string. | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$service.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$service.md index 44ddcd4403..f3fcadb833 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$service.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$service.md @@ -16,7 +16,7 @@ $service( | :------ | :------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`Namespace`](../interfaces/Namespace.md) | -| `options`? | [`Model`](../interfaces/Model.md) | +| `options`? | [`Type`](../type-aliases/Type.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$summary.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$summary.md index 074e8ac0b4..7df5e12451 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$summary.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$summary.md @@ -7,8 +7,7 @@ title: "[F] $summary" $summary( context, target, - text, - sourceObject): void + summary): void ``` ## Parameters @@ -17,8 +16,7 @@ $summary( | :------ | :------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`Type`](../type-aliases/Type.md) | -| `text` | `string` | -| `sourceObject` | [`Type`](../type-aliases/Type.md) | +| `summary` | `string` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withDefaultKeyVisibility.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withDefaultKeyVisibility.md index be555676c1..b9ce0e80fe 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withDefaultKeyVisibility.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withDefaultKeyVisibility.md @@ -6,7 +6,7 @@ title: "[F] $withDefaultKeyVisibility" ```ts $withDefaultKeyVisibility( context, - entity, + target, visibility): void ``` @@ -15,7 +15,7 @@ $withDefaultKeyVisibility( | Parameter | Type | | :------ | :------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | -| `entity` | [`Model`](../interfaces/Model.md) | +| `target` | [`Model`](../interfaces/Model.md) | | `visibility` | `string` | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withUpdateableProperties.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withUpdateableProperties.md index d5ebda1e62..bad13c7465 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withUpdateableProperties.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withUpdateableProperties.md @@ -12,7 +12,7 @@ $withUpdateableProperties(context, target): void | Parameter | Type | | :------ | :------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | -| `target` | [`Type`](../type-aliases/Type.md) | +| `target` | [`Model`](../interfaces/Model.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withoutOmittedProperties.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withoutOmittedProperties.md index 5344ffd222..5a5c1316e6 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withoutOmittedProperties.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/$withoutOmittedProperties.md @@ -7,7 +7,7 @@ title: "[F] $withoutOmittedProperties" $withoutOmittedProperties( context, target, - omitProperties): void + omit): void ``` ## Parameters @@ -16,7 +16,7 @@ $withoutOmittedProperties( | :------ | :------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | | `target` | [`Model`](../interfaces/Model.md) | -| `omitProperties` | [`StringLiteral`](../interfaces/StringLiteral.md) \| [`Union`](../interfaces/Union.md) | +| `omit` | [`Type`](../type-aliases/Type.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/assertType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/assertType.md index 42750eb5f0..e38d3a60d9 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/assertType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/assertType.md @@ -17,9 +17,9 @@ Assert that the input type has one of the kinds provided | Type parameter | | :------ | | `TKind` extends ( - \| `"Model"` - \| `"ModelProperty"` \| `"Scalar"` + \| `"ModelProperty"` + \| `"Model"` \| `"Interface"` \| `"Enum"` \| `"EnumMember"` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDeprecationDetails.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDeprecationDetails.md index b64f03f8cd..f654277555 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDeprecationDetails.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getDeprecationDetails.md @@ -14,7 +14,7 @@ Returns complete deprecation details for the given type or node | Parameter | Type | Description | | :------ | :------ | :------ | | `program` | [`Program`](../interfaces/Program.md) | Program | -| `typeOrNode` | [`Node`](../type-aliases/Node.md) \| [`Type`](../type-aliases/Type.md) | A Type or Node to check for deprecation | +| `typeOrNode` | [`Type`](../type-aliases/Type.md) \| [`Node`](../type-aliases/Node.md) | A Type or Node to check for deprecation | ## Returns 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 a2e2192ac4..984c786f8c 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 @@ -12,7 +12,7 @@ getEncode(program, target): EncodeData | undefined | Parameter | Type | | :------ | :------ | | `program` | [`Program`](../interfaces/Program.md) | -| `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | +| `target` | [`Scalar`](../interfaces/Scalar.md) \| [`ModelProperty`](../interfaces/ModelProperty.md) | ## Returns 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 5fea8e23bf..4580f1e7d5 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 @@ -12,7 +12,7 @@ getKnownValues(program, target): Enum | undefined | Parameter | Type | | :------ | :------ | | `program` | [`Program`](../interfaces/Program.md) | -| `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | +| `target` | [`Scalar`](../interfaces/Scalar.md) \| [`ModelProperty`](../interfaces/ModelProperty.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPropertyType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPropertyType.md index c1de3243fd..87fdd3f58e 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPropertyType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/getPropertyType.md @@ -13,7 +13,7 @@ Return the type of the property or the model itself. | Parameter | Type | | :------ | :------ | -| `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | +| `target` | [`Scalar`](../interfaces/Scalar.md) \| [`ModelProperty`](../interfaces/ModelProperty.md) | ## Returns diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorParamType.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorParamType.md index 5fe11db3b7..6bd5f1b10d 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorParamType.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorParamType.md @@ -18,9 +18,9 @@ Validate a decorator parameter has the correct type. | Type parameter | | :------ | | `K` extends - \| `"Model"` - \| `"ModelProperty"` \| `"Scalar"` + \| `"ModelProperty"` + \| `"Model"` \| `"Interface"` \| `"Enum"` \| `"EnumMember"` diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorTargetIntrinsic.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorTargetIntrinsic.md index d3251f818f..cabe8dd644 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorTargetIntrinsic.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/functions/validateDecoratorTargetIntrinsic.md @@ -16,7 +16,7 @@ validateDecoratorTargetIntrinsic( | Parameter | Type | | :------ | :------ | | `context` | [`DecoratorContext`](../interfaces/DecoratorContext.md) | -| `target` | [`ModelProperty`](../interfaces/ModelProperty.md) \| [`Scalar`](../interfaces/Scalar.md) | +| `target` | [`Scalar`](../interfaces/Scalar.md) \| [`ModelProperty`](../interfaces/ModelProperty.md) | | `decoratorName` | `string` | | `expectedType` | [`IntrinsicScalarName`](../type-aliases/IntrinsicScalarName.md) \| [`IntrinsicScalarName`](../type-aliases/IntrinsicScalarName.md)[] | 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 0ed2e226e1..0fc5fd3f4f 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 @@ -174,6 +174,7 @@ title: "[P] JS API" - [ProjectionParameterDeclarationNode](interfaces/ProjectionParameterDeclarationNode.md) - [ProjectionReferenceNode](interfaces/ProjectionReferenceNode.md) - [ProjectionRelationalExpressionNode](interfaces/ProjectionRelationalExpressionNode.md) +- [ProjectionScalarSelectorNode](interfaces/ProjectionScalarSelectorNode.md) - [ProjectionStatementNode](interfaces/ProjectionStatementNode.md) - [ProjectionTupleExpressionNode](interfaces/ProjectionTupleExpressionNode.md) - [ProjectionUnaryExpressionNode](interfaces/ProjectionUnaryExpressionNode.md) diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionScalarSelectorNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionScalarSelectorNode.md new file mode 100644 index 0000000000..9ec87e3436 --- /dev/null +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionScalarSelectorNode.md @@ -0,0 +1,21 @@ +--- +jsApi: true +title: "[I] ProjectionScalarSelectorNode" + +--- +## Extends + +- [`BaseNode`](BaseNode.md) + +## Properties + +| Property | Modifier | Type | Description | Overrides | Inherited from | +| :------ | :------ | :------ | :------ | :------ | :------ | +| `directives?` | `readonly` | readonly [`DirectiveExpressionNode`](DirectiveExpressionNode.md)[] | - | [`BaseNode`](BaseNode.md).`directives` | [`BaseNode`](BaseNode.md).`directives` | +| `docs?` | `readonly` | readonly [`DocNode`](DocNode.md)[] | - | [`BaseNode`](BaseNode.md).`docs` | [`BaseNode`](BaseNode.md).`docs` | +| `end` | `readonly` | `number` | The ending position measured in UTF-16 code units from the start of the
full string. Exclusive. | [`BaseNode`](BaseNode.md).`end` | [`BaseNode`](BaseNode.md).`end` | +| `flags` | `readonly` | [`NodeFlags`](../enumerations/NodeFlags.md) | - | [`BaseNode`](BaseNode.md).`flags` | [`BaseNode`](BaseNode.md).`flags` | +| `kind` | `readonly` | `ProjectionScalarSelector` | - | [`BaseNode`](BaseNode.md).`kind` | [`BaseNode`](BaseNode.md).`kind` | +| `parent?` | `readonly` | [`Node`](../type-aliases/Node.md) | - | [`BaseNode`](BaseNode.md).`parent` | [`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` | [`BaseNode`](BaseNode.md).`pos` | +| `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionStatementNode.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionStatementNode.md index fc46e9d7cf..eae20bc8cc 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionStatementNode.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/interfaces/ProjectionStatementNode.md @@ -23,6 +23,6 @@ title: "[I] ProjectionStatementNode" | `preFrom?` | `readonly` | [`ProjectionNode`](ProjectionNode.md) | - | - | - | | `preTo?` | `readonly` | [`ProjectionNode`](ProjectionNode.md) | - | - | - | | `projections` | `readonly` | readonly [`ProjectionNode`](ProjectionNode.md)[] | - | - | - | -| `selector` | `readonly` | \| [`MemberExpressionNode`](MemberExpressionNode.md) \| [`IdentifierNode`](IdentifierNode.md) \| [`ProjectionModelSelectorNode`](ProjectionModelSelectorNode.md) \| [`ProjectionModelPropertySelectorNode`](ProjectionModelPropertySelectorNode.md) \| [`ProjectionInterfaceSelectorNode`](ProjectionInterfaceSelectorNode.md) \| [`ProjectionOperationSelectorNode`](ProjectionOperationSelectorNode.md) \| [`ProjectionEnumSelectorNode`](ProjectionEnumSelectorNode.md) \| [`ProjectionEnumMemberSelectorNode`](ProjectionEnumMemberSelectorNode.md) \| [`ProjectionUnionSelectorNode`](ProjectionUnionSelectorNode.md) \| [`ProjectionUnionVariantSelectorNode`](ProjectionUnionVariantSelectorNode.md) | - | - | - | +| `selector` | `readonly` | \| [`MemberExpressionNode`](MemberExpressionNode.md) \| [`IdentifierNode`](IdentifierNode.md) \| [`ProjectionModelSelectorNode`](ProjectionModelSelectorNode.md) \| [`ProjectionModelPropertySelectorNode`](ProjectionModelPropertySelectorNode.md) \| [`ProjectionScalarSelectorNode`](ProjectionScalarSelectorNode.md) \| [`ProjectionInterfaceSelectorNode`](ProjectionInterfaceSelectorNode.md) \| [`ProjectionOperationSelectorNode`](ProjectionOperationSelectorNode.md) \| [`ProjectionEnumSelectorNode`](ProjectionEnumSelectorNode.md) \| [`ProjectionEnumMemberSelectorNode`](ProjectionEnumMemberSelectorNode.md) \| [`ProjectionUnionSelectorNode`](ProjectionUnionSelectorNode.md) \| [`ProjectionUnionVariantSelectorNode`](ProjectionUnionVariantSelectorNode.md) | - | - | - | | `symbol` | `readonly` | [`Sym`](Sym.md) | Could be undefined but making this optional creates a lot of noise. In practice,
you will likely only access symbol in cases where you know the node has a symbol. | [`BaseNode`](BaseNode.md).`symbol` | [`BaseNode`](BaseNode.md).`symbol` | | `to?` | `readonly` | [`ProjectionNode`](ProjectionNode.md) | - | - | - | diff --git a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/Node.md b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/Node.md index 09f7f7a3e4..1b802da3ef 100644 --- a/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/Node.md +++ b/packages/website/versioned_docs/version-latest/standard-library/reference/js-api/type-aliases/Node.md @@ -37,6 +37,7 @@ type Node: | ProjectionExpression | ProjectionModelSelectorNode | ProjectionModelPropertySelectorNode + | ProjectionScalarSelectorNode | ProjectionInterfaceSelectorNode | ProjectionOperationSelectorNode | ProjectionEnumSelectorNode diff --git a/packages/website/versioned_sidebars/version-latest-sidebars.json b/packages/website/versioned_sidebars/version-latest-sidebars.json index 213362501a..af3a11e5da 100644 --- a/packages/website/versioned_sidebars/version-latest-sidebars.json +++ b/packages/website/versioned_sidebars/version-latest-sidebars.json @@ -215,6 +215,7 @@ "extending-typespec/diagnostics", "extending-typespec/create-decorators", "extending-typespec/linters", + "extending-typespec/codefixes", "extending-typespec/emitters", "extending-typespec/emitter-framework", "extending-typespec/emitter-metadata-handling",