typespec | TypeScript Ecosystem Directory

Bot releases are hidden (Show)

typespec - @typespec/[email protected]

Published by azure-sdk 3 months ago

Bug Fixes

#3875 Fix issues with examples not working with Array, Record, Union and unknown types

typespec - [email protected]

Published by azure-sdk 3 months ago

@typespec/compiler

Bug Fixes

#3623 Fix crash of language server on firefox
#3516 Deprecate getAssetEmitter and recommend calling createAssetEmitter directly
#3767 Fix semantic highlighting of using of single namespace
#3824 Do not cast model expression to object value if the constraint is allowing the type
#3577 Fix formatting of object and array literal in decorator to hug parenthesis
#3823 Fix formatting of scalar constructor called with no args
#3743 Fix 'typespec vs install' command on windows
#3605 Fix templates initialized on node 22

Bump dependencies

#3718 Dependency updates July 2024

Features

#3699 Moved compiler dependencies to peer and dev for scaffolded projects.

#3572 Add new @example and @opExample decorator to provide examples on types and operations.

@example(#{
  id: "some",
  date: utcDateTime.fromISO("2020-01-01T00:00:00Z"),
  timeout: duration.fromISO("PT1M"),
})
model Foo {
  id: string;
  date: utcDateTime;

  @encode("seconds", int32) timeout: duration;
}

@opExample(
  #{
    parameters: #{
      pet: #{
        id: "some",
        name: "Fluffy",
        dob: plainDate.fromISO("2020-01-01"),
      },
    },
    returnType: #{
      id: "some",
      name: "Fluffy",
      dob: plainDate.fromISO("2020-01-01"),
    },
  },
  #{ title: "First", description: "Show creating a pet" }
)
op createPet(pet: Pet): Pet;

#3751 Adds option to tsp init to generate .gitignore file

Breaking Changes

#3793 Do not carry over @friendlyName with model is or op is

@friendlyName("Abc{T}", T)
model Foo<T> {}

model Bar is Foo<string>;

// This can be changed to
model Abcstring is Foo<string>;

#3659 Disallows overriding a required inherited property with an optional property.

In previous versions of TypeSpec, it was possible to override a required property with an optional property. This is no longer allowed. This change may result in errors in your code if you were relying on this bug, but specifications that used this behavior are likely to have been exposed to errors resulting from incoherent type checking behavior.

The following example demonstrates the behavior that is no longer allowed:

model Base {
  example: string;
}

model Child extends Base {
  example?: string;
}

In this example, the Child model overrides the example property from the Base model with an optional property. This is no longer allowed.

@typespec/http

Bump dependencies

#3718 Dependency updates July 2024

Features

#3717 Allow overriding base operation verb
#3676 Expose getHttpPart and types functions
#3732 Expose model property on HttpAuth to retrieve original type used to define security scheme

Breaking Changes

#3737 Keep trailing slash when building http routes, this is breaking if you used to have @route() ending with /.

TypeSpec	Before	After
`@route("users/")`	`users`	`users/`
`@route("users")`	`users`	`users`
on interface `@route("users/")` and on op `@route("addresses/")`	`users/addresses`	`users/addresses/`
on interface `@route("users/")` and on op `@route("addresses")`	`users/addresses`	`users/addresses`

@typespec/versioning

Bump dependencies

#3718 Dependency updates July 2024

@typespec/rest

Bump dependencies

#3718 Dependency updates July 2024

@typespec/openapi

Bump dependencies

#3718 Dependency updates July 2024

Features

#3626 Adds public function for setting info object

@typespec/openapi3

Bug Fixes

#3516 Fix issue that could result in invalid document generation when running tsp compile from another directory
#3794 Updates tsp-openapi3 to always emit main.tsp when formatting encounters an error.
#3839 Updates tsp-openapi3 doc line wrapping to only automatically create newlines when they are present in the original documentation.

Bump dependencies

#3718 Dependency updates July 2024

Features

#3572 Add support for new @example and @opExample decorator
#3663 Adds support for converting OpenAPI3 specs to TypeSpec via the new tsp-openapi3 CLI included in the @typespec/openapi3 package.
#3732 Apply openapi3 extension on Security schemes
#3844 Updates tsp-openapi3 to escape identifiers that would otherwise be invalid, and automatically resolve namespaces for schemas with dots in their names.

@typespec/protobuf

Bump dependencies

#3718 Dependency updates July 2024

@typespec/prettier-plugin-typespec

Bump dependencies

#3718 Dependency updates July 2024

@typespec/eslint-plugin

Bump dependencies

#3718 Dependency updates July 2024

@typespec/html-program-viewer

Bug Fixes

#3585 Fix crash in program viewer when trying to display new value type

Bump dependencies

#3718 Dependency updates July 2024

Features

#3713 Complete new dynamic UI to navigate the TypeSpec type graph

@typespec/json-schema

Bug Fixes

#3516 Fix issue that could result in invalid document generation when running tsp compile from another directory

Bump dependencies

#3718 Dependency updates July 2024

@typespec/internal-build-utils

Bump dependencies

#3718 Dependency updates July 2024

typespec-vs

No changes, version bump only.

typespec-vscode

Bump dependencies

#3718 Dependency updates July 2024

@typespec/library-linter

Bump dependencies

#3718 Dependency updates July 2024

typespec - @typespec/[email protected]

Published by azure-sdk 3 months ago

Bump dependencies

#3718 Dependency updates July 2024

typespec - @typespec/[email protected]

Published by azure-sdk 3 months ago

Bump dependencies

#3718 Dependency updates July 2024

Features

#3585 Add error recovery for viewer that crash
#3750 Add new property on the playground to add custom buttons on the toolbar
#3713 Extract splitpane into separate package

typespec - @typespec/[email protected]

Published by azure-sdk 3 months ago

No changes, version bump only.

typespec - @typespec/[email protected]

Published by azure-sdk 3 months ago

Bump dependencies

#3718 Dependency updates July 2024

typespec - [email protected]

Published by azure-sdk 3 months ago

Bump dependencies

#3718 Dependency updates July 2024

typespec - @typespec/[email protected]

Published by azure-sdk 3 months ago

typespec - [email protected]

Published by azure-sdk 4 months ago

@typespec/compiler

Bug Fixes

#3399 Preserve leading whitespace in fenced blocks in doc comments
#3566 [API] Do not run decorators on cloned type if the original type wasn't finished
#3522 Fix EINVAL error when running tsp code install
#3371 Numeric not handling trailing zeros and causing freeze(e.g. const a = 100.0)
#3451 Emitter framework: fix losing context when referencing circular types
#3517 Fix application of @param doc tag on operation create with op is to override upstream doc
#3488 Add PickProperties type to dynamically select a subset of a model

Bump dependencies

#3401 Update dependencies - May 2024

Features

#3280 Support completion for Model with extended properties

Example

model Device {
  name: string;
  description: string;
}

model Phone extends Device {
  ┆
} | [name]
  | [description]

#3280 Support completion for object values and model expression properties.

Example

model User {
  name: string;
  age: int32;
  address: string;
}

const user: User = #{name: "Bob", ┆}
                                  | [age]
                                  | [address]

#3375 Allow @ to be escaped in doc comment with \
#3022 Add syntax for declaring values. See docs.

Object and array values

@dummy(#{
  name: "John",
  age: 48,
  address: #{ city: "London" }
  aliases: #["Bob", "Frank"]
})

Scalar constructors

scalar utcDateTime {
  init fromISO(value: string);
}

model DateRange {
  minDate: utcDateTime = utcDateTime.fromISO("2024-02-15T18:36:03Z");
}

#3527 Add support for @prop doc comment tag to describe model properties
#3422 Formatter: Indent or dedent multiline strings to the current indentation
#3460 Hide deprecated items from completion list

#3443 Support completion for keyword 'extends' and 'is'

Example

model Dog ┆ {}
          | [extends]
          | [is]

scalar Addresss ┆ 
                | [extends]

op jump ┆ 
        | [is]

interface ResourceA ┆ {}
                    | [extends]

model Cat<T ┆> {}
            | [extends]

#3462 Linter all rulesets is automatically created if not explicitly provided
#3533 More logs and traces are added for diagnostic and troubleshooting in TypeSpec language server

Deprecations

#3022 Using a tuple type as a value is deprecated. Tuple types in contexts where values are expected must be updated to be array values instead. A codefix is provided to automatically convert tuple types into array values.

model Test {
  // Deprecated
  values: string[] = ["a", "b", "c"];
  
  // Correct
  values: string[] = #["a", "b", "c"];

#3022 Using a model type as a value is deprecated. Model types in contexts where values are expected must be updated to be object values instead. A codefix is provided to automatically convert model types into object values.

model Test {
  // Deprecated
  user: {name: string} = {name: "System"};
  
  // Correct
  user: {name: string} = #{name: "System"};

#3022 Decorator API: Legacy marshalling logic

With the introduction of values, the decorator marshalling behavior has changed in some cases. This behavior is opt-in by setting the valueMarshalling package flag to "new", but will be the default behavior in future versions. It is strongly recommended to adopt this new behavior as soon as possible.

Example:

extern dec multipleOf(target: numeric | Reflection.ModelProperty, value: valueof numeric);

Will now emit a deprecated warning because value is of type valueof string which would marshall to Numeric under the new logic but as number previously.

To opt-in you can add the following to your library js/ts files.

export const $flags = definePackageFlags({
  decoratorArgMarshalling: "new",
});

@typespec/http

Bug Fixes

#3022 Update Flow Template to make use of the new array values

Bump dependencies

#3401 Update dependencies - May 2024

Features

#3342 Add new multipart handling. Using @multipartBody with HttpPart<Type, Options>. See multipart docs for more information.

op upload(@header contentType: "multipart/mixed", @multipartBody body: {
  name: HttpPart<string>;
  avatar: HttpPart<bytes>[];
}): void;

#3462 Use new compiler automatic all ruleset instead of explicitly provided one

@typespec/versioning

Bug Fixes

#3292 Add @madeRequired decorator
#3022 Update to support new value types
#3409 Using @removed on member types and @added on containing type could result in errors
#3255 If a property were marked with @added on a later version, the logic that said it was originally added on the first version was erroneously removed, resulting in incorrect projections.

Bump dependencies

#3401 Update dependencies - May 2024

@typespec/rest

Bug Fixes

#3022 Update types to support new values in TypeSpec

Bump dependencies

#3401 Update dependencies - May 2024

@typespec/openapi

Bump dependencies

#3401 Update dependencies - May 2024

@typespec/openapi3

Bug Fixes

#3342 Add support for new multipart constructs in http library
#3574 Emit diagnostic when an invalid type is used as a property instead of crashing.

Bump dependencies

#3401 Update dependencies - May 2024

Features

#3022 Add support for new object and array values as default values (e.g. decimals: decimal[] = #[123, 456.7];)

@typespec/protobuf

Bug Fixes

#3022 Update to support new value types
#3561 Corrected cross-package reference behavior in some buggy cases.

Bump dependencies

#3401 Update dependencies - May 2024

@typespec/prettier-plugin-typespec

Bump dependencies

#3401 Update dependencies - May 2024

@typespec/eslint-plugin

Bump dependencies

#3401 Update dependencies - May 2024

@typespec/html-program-viewer

Bump dependencies

#3401 Update dependencies - May 2024

Features

#3022 Add support for values

@typespec/json-schema

Bug Fixes

#3398 Fix decorators application for union variants
#3022 Update to support new value types
#3430 The emitted JSON Schema now doesn't make root schemas for TypeSpec types which do not have the @jsonSchema decorator or are contained in a namespace with that decorator. Instead, such schemas are put into the $defs of any root schema which references them, and are referenced using JSON Pointers.

Bump dependencies

#3401 Update dependencies - May 2024

Features

#3557 Add support for @oneOf decorator.

@typespec/internal-build-utils

Bump dependencies

#3401 Update dependencies - May 2024

typespec-vs

Features

#3461 Support Arm64

typespec-vscode

Bump dependencies

#3401 Update dependencies - May 2024

Features

#3533 Enhance logging and trace

Support "Developer: Set Log Level..." command to filter logs in TypeSpec output channel
Add "typespecLanguageServer.trace.server" config for whether and how to send the traces from TypeSpec language server to client. (It still depends on client to decide whether to show these traces based on the configured Log Level.)
More logs and traces are added for diagnostic and troubleshooting

#3385 Add 'TypeSpec: Show Output Channel' command in VSCode extension

@typespec/library-linter

Bump dependencies

#3401 Update dependencies - May 2024

typespec - @typespec/[email protected]

Published by azure-sdk 4 months ago

Bump dependencies

#3401 Update dependencies - May 2024

typespec - @typespec/[email protected]

Published by azure-sdk 4 months ago

Bug Fixes

#3542 Fix issue where hover tooltip would be cropped or not visible

Bump dependencies

#3401 Update dependencies - May 2024

Features

#3465 Provide ability to add custom program viewers
#3569 Support loglevel in playground's logging

typespec - @typespec/[email protected]

Published by azure-sdk 4 months ago

Bump dependencies

#3401 Update dependencies - May 2024

typespec - [email protected]

Published by azure-sdk 4 months ago

Bump dependencies

#3401 Update dependencies - May 2024

typespec - [email protected]

Published by azure-sdk 5 months ago

@typespec/compiler

Bug Fixes

#3170 --nostdlib flag will now work by only applying to optional standard library types
#3212 Fix: augmenting template model property could result in sending invalid argument to decorator
#3188 Fix: Do not crash when trying to access member of aliased expressions
#3185 Fix tsp init hanging when done due to unclosed connection
#3151 IDE: Fix completion of statement keywords
#3287 Templated interface extending another templated interface shouldn't run decorator on their operations
#3290 Model with an optional property should not satisfy a constraint with that property required. ({foo?: string} cannot be assigned to a constraint of {foo: string})
#3163 Fix: Model with spread indexer shouldn't validate explicit properties
#3227 Stop running decorators on partially instantiated operations(When interface is instantiated but not the operation)
#3180 Fix issue where directives were not parsed to the leaf node in multi-segment Namespace segments.
#3243 Fix calling tsp install on windows due to recent NodeJS breaking change to fix vulnerability.
#3216 Fix compiler crash when using an invalid is target in an interface operation template
#3246 Internals: Use node built-in fetch API that is now stable since node 18.13.0

Bump dependencies

#3169 Update dependencies

Features

#3035 getEncode returns the fully qualified enum member name if using a custom enum.
#3183 Show template parameters when hovering on an operation template
#3191 [API] Add new sourceModels property to model

@typespec/http

Bug Fixes

#3196 Fix password flow defining authorizationUrl instead of tokenUrl
#3190 Fix @path param mapping when spreading a record in operation parameters
#3218 Fix: @path property shouldn't be applicableMetadata if the visibility contains Read

Bump dependencies

#3169 Update dependencies

Breaking Changes

#2945 Empty model after removing metadata and applying visibility always results in "void"
This means the following case have changed from returning {} to no body

op b1(): {};
op b2(): {@visibility("none") prop: string};
op b3(): {@added(Versions.v2) prop: string};

Workaround: Use explicit @body

op b1(): {@body _: {}};
op b2(): {@body _: {@visibility("none") prop: string}};
op b3(): {@body _: {@added(Versions.v2) prop: string}};

#2945 Implicit status code always 200 except if response is explicitly void

op c1(): {@header foo: string}; // status code 200 (used to be 204)

Solution: Add explicit @statusCode

op c1(): {@header foo: string, @statusCode _: 204};
op c1(): {@header foo: string, ...NoContent}; // or spread common model

#2945 @body means this is the body

This change makes using @body mean this is the exact body and everything underneath will be included, including metadata properties. If metadata properties are present on the body, a warning will be logged.
```
op a1(): {@body _: {@header foo: string, other: string} };
                ^ warning header in a body, it will not be included as a header.
```
Use @bodyRoot if you want to only change where to resolve the body from.
```
op a1(): {@bodyRoot _: {@header foo: string, other: string} };
```

#2945 Properties are not automatically omitted if everything was removed from metadata or visibility

op d1(): {headers: {@header foo: string}}; // body will be {headers: {}}

Solution: use @bodyIgnore

op d1(): {@bodyIgnore headers: {@header foo: string}}; // body will be {headers: {}}

@typespec/versioning

Bug Fixes

#3264 Fix crash when @service appears inside a versioned namespace

Bump dependencies

#3169 Update dependencies

@typespec/rest

Bump dependencies

#3169 Update dependencies

Features

#2945 Add support for new @bodyRoot and @body distinction

@typespec/openapi

Bump dependencies

#3169 Update dependencies

@typespec/openapi3

Bug Fixes

#3218 Fix: @path property should be included in unreachable models

Bump dependencies

#3169 Update dependencies

Features

#2945 Add support for new @bodyRoot and @body distinction

@typespec/protobuf

Bump dependencies

#3169 Update dependencies

@typespec/prettier-plugin-typespec

Bump dependencies

#3169 Update dependencies

@typespec/eslint-plugin

Bump dependencies

#3169 Update dependencies

@typespec/html-program-viewer

Bump dependencies

#3169 Update dependencies

Features

#3191 Add sourceModels property to model view

@typespec/json-schema

Bump dependencies

#3169 Update dependencies

@typespec/internal-build-utils

Bump dependencies

#3169 Update dependencies

typespec-vs

No changes, version bump only.

typespec-vscode

Bump dependencies

#3169 Update dependencies

@typespec/library-linter

Bump dependencies

#3169 Update dependencies

typespec - @typespec/[email protected]

Published by azure-sdk 5 months ago

Bump dependencies

#3169 Update dependencies

typespec - @typespec/[email protected]

Published by azure-sdk 5 months ago

Bug Fixes

#3170 Add support for new intrinsic vs std lib split in the compiler.
#3151 Fix completion of keywords

Bump dependencies

#3169 Update dependencies

typespec - @typespec/[email protected]

Published by azure-sdk 5 months ago

Bump dependencies

#3169 Update dependencies

typespec - [email protected]

Published by azure-sdk 5 months ago

Bump dependencies

#3169 Update dependencies

typespec - [email protected]

Published by azure-sdk 7 months ago

@typespec/compiler

Bug Fixes

#3018 Grammar: Fix comments in template params not tokenized
#3052 Fix: Union template declaration were incorrectly being finished in projection
#2983 Warnings converted to error with warn-as-error do not prevent compilation from moving to the next stage like regular warnings
#3041 Improve relability of application of codefixes in IDE, often it would not do anything
#3069 TmLanguage: Fix tokenization of escaped identifiers, enums and unions

Bump dependencies

#3027 Update dependencies

Features

#2992 Enable the use of @encode for model properties that have a union type. This supports cases like @encode("rfc3339") prop: utcDateTime | null
#3053 Experimental projection: Add support for scalars

Deprecations

#3094 Deprecate @knownValues decorator. Use a named union of string literal with a string variant to achieve the same result without a decorator

Example:

-enum FooKV { a, b, c}
-@knownValues(FooKV)
-scalar foo extends string;
+union Foo { "a", "b", "c", string }

#2910 Deprecate @projectedName decorator. @encodedName should be used instead.

Example:

-@projectedName("json", "exp")
+@encodedName("application/json", "exp")

@typespec/http

Bump dependencies

#3027 Update dependencies

@typespec/versioning

Bump dependencies

#3027 Update dependencies

Features

#3053 Add support for versioning of scalars(Added, removed, renamed)

@typespec/rest

Bump dependencies

#3027 Update dependencies

@typespec/openapi

Bump dependencies

#3027 Update dependencies

@typespec/openapi3

Bug Fixes

#3077 Do not crash if using an unsupported intrinsic type
#2967 Fix crash: emit {nullable: true} when trying to emit null in openapi3
#3013 Fix: OpenAPI3 not marking part of bytes or something else as format: binary
#3090 Fix: Literal unions with the same variants keep adding duplicate entries
#3049 Fix visibility naming conflict when a model used with extends was used in different visibility.

Bump dependencies

#3027 Update dependencies

@typespec/protobuf

Bump dependencies

#3027 Update dependencies

@typespec/prettier-plugin-typespec

Bump dependencies

#3027 Update dependencies

@typespec/eslint-config-typespec

Bug Fixes

#2122 Ignore generated-defs folder

Bump dependencies

#3027 Update dependencies

@typespec/eslint-plugin

Bump dependencies

#3027 Update dependencies

@typespec/html-program-viewer

Bump dependencies

#3027 Update dependencies

@typespec/json-schema

Bump dependencies

#3027 Update dependencies

@typespec/internal-build-utils

Bump dependencies

#3027 Update dependencies

typespec-vs

No changes, version bump only.

typespec-vscode

Bump dependencies

#3027 Update dependencies

@typespec/library-linter

Bump dependencies

#3027 Update dependencies

typespec - [email protected]

Published by timotheeguerin 8 months ago

@typespec/compiler

Bug Fixes

#2932 Report error when having a circular template constraint e.g. model Example<T extends T>
#2955 [Formatter] Formatting file with only comments would reorder the first line.
#2934 [IDE] Fix issue when deleting an open file outside the IDE that would crash the language server
#2959 Decorators that have missing arguments will not run. This is inline with passing invalid argument to a decorator that would prevent it from running.
#2976 [IDE] Fix type documentation shown twice when hovering symbols or in completion details.
#2929 [API] Add Scalar to TS TemplatedType type
#2978 [IDE] Go to imports
#2936 [IDE] Autocompleting file or folder with non alpha numeric charachter completes correctly
#2936 [IDE] Fix crashing when trying to autocomplete an invalid folder
#2951 Wrap string in quotes in errors
#2886 Fix: tsp compile --watch was missing coloring and error previews

Bump dependencies

#2900 Update dependencies

Features

#2888 Add support for codefixes
#2920 Add support for ...Record<T> to define the type of remaining properties
#2968 Any subtype of an error(marked with @error) is now an error.

Deprecations

#2919 [API] Create a new export @typespec/compiler/utils exports. Deprecate export from @typespec/compiler of utils like DuplicateTracker, Queue, createTwoKeyMap, etc.
#2902 Deprecate @service version property. If wanting to describe a service versioning you can use the @typespec/versioning library. If wanting to describe the project version you can use the package.json version. For OpenAPI generation. the @OpenAPI.info nows decorator allows providing the document version.

Breaking Changes

#2920 Intersecting Record with incompatible properties will now emit an error

@typespec/http

Bug Fixes

#2948 Fix don't emit shared route error when verb don't match

Bump dependencies

#2900 Update dependencies

Features

#2901 Add ability to sepcify authentication and different scopes per operation
#2958 Validate that only one @useAuth decorator is applied to a type.

@typespec/versioning

Bump dependencies

#2900 Update dependencies

Features

#2950 Export the VersionProjections interface.

@typespec/rest

Bump dependencies

#2900 Update dependencies

@typespec/openapi

Bump dependencies

#2900 Update dependencies

Features

#2902 Add support for all properties of openapi info object on the @info decorator

@typespec/openapi3

Bump dependencies

#2900 Update dependencies

Features

#2902 Add support for all properties of openapi info object on the @info decorator
#2950 Add getOpenAPI3 function that takes a TypeSpec program and returns the emitted OpenAPI as an object. Useful for other emitters and tools that want to work with emitted OpenAPI directly without writing it to disk.
#2933 Add a new option safeint-strategy that can be set to double-int to emit type: integer, format: double-int instead of type: integer, format: int64 when using the safeint scalar.