arri_client

What's Changed

• [ts-codegen] fix regression where generated enum validator type name is incorrect by @joshmossas in #200

Full Changelog: v0.84.0...v0.84.1

Typescript

• [ts-codegen] the typescriptClient generator now accepts an optional features object to enable and disable some of the generated helper functions

  export default defineConfig({
       generators: [
           generators.typescriptClient({
              features: {
                  validateFn: true, // output a "validate" helper fn for every type (default: false)
                  cloneFn: true, // output a "clone" helper fn for every type that does a deep clone (default: false)
                  validatorObj: true,  // output a validator object for every type that is prefixed with $$ (default: true)
              }
              // rest of config
          })
      ]
  })

• [ts-codegen] BREAKING: the typescriptClient generator no longer outputs the validate helper fn by default. You must enable it in the arri config

• [ts-codegen] The outputted typescript code is now much more treeshakable.

  • All helper functions such as "validate" and "clone" will not be included in the final bundle unless actually imported into your application
  • generated code now outputs separate functions such as "fromJson" and "toJson" for each type, that can be imported individually to improve treeshaking. The previous validator objects are still outputted for compatibility reasons and for convenience reasons.

    import { MyTypeFromJsonString, MyTypeToJsonString, MyTypeValidate } from './my-client.g';
    const result = MyTypeFromJsonString('{}');
    MyTypeToJsonString(result);
    MyTypeValidate(result);
    
    // the old way is still available but it is less tree-shakable
    // this will cause FromJson, ToJson, New, and any other helper fns for this type to be imported
    import { $$MyType } from './my-client.g';
    const result = $$MyType.fromJsonString('{}'); 

PRs

• feature: make TS client more tree-shakeable by @joshmossas in #198
• feature: add option to generate a clone helper function for generated types by @joshmossas in #199

Full Changelog: v0.83.1...v0.84.0

Full Changelog: v0.83.0...v0.83.1

What's Changed

• dart client: SSE partial character parsing bugfix by @joshmossas in #197

Full Changelog: v0.82.0...v0.83.0

I marked this as a breaking change just in case, however nobody should be broken by these changes.

What's Changed

Typescript

Enum Generation

For enums ts-codegen will now also output a static object with all of the possible values. Example:

// before
export type MyEnum = (typeof $$MyEnumValues)[number];
const $$MyEnumValues = ["foo", "bar", "baz"];

// after
export type MyEnum = "foo" | "bar" | "baz";
export const MyEnum = {
  Foo: "foo",
  Bar: "bar",
  Baz: "baz",
} as const;
const $$MyEnumValues = ["foo", "bar", "baz"];

This allows users to access enum variants like so if they so choose:

console.log(MyEnum.Foo)

The actual type remains a string union so consumers aren't affected.

Lines of Code Reduction

The generated typescript code now outputs 10%-25% less lines of code on average.

PRs:

• feature: make ts clients coerce bigints
• feature: ts enum generation improvements by @joshmossas in #195
• feature: reduce line-count of generated ts code by @joshmossas in #196

Full Changelog: v0.81.3...v0.82.0

What's Changed

Rust

• feature: add annotation to ignore clippy lints in rust codegen output by @joshmossas in #192

Full Changelog: v0.81.2...v0.81.3

What's Changed

Typescript

• [@arrirpc/schema] feat: add a.toJsonSchema() function

CLI

• add export json schema command

arri export json-schema ./app-definition.json

Commits

• feat: add ATD to JSON Schema converter by @Arthurdw in #191

New Contributors

• @Arthurdw made their first contribution in #191

Full Changelog: v0.81.1...v0.81.2

What's Changed

• fix(rust-codegen): emit nested service struct definitions by @michael-dm in #188
• fix(go-server): fix bug where url paths for nested services are not consistent with the ts server implementation
• chore: add tests for nested services to integration test suite by @joshmossas in #189

New Contributors

• @michael-dm made their first contribution in #188

Full Changelog: v0.81.0...v0.81.1

What's Changed

Typescript

• BREAKING [ts-codegen] new Date(0) is now the fallback value for timestamps instead of new Date()
• [ts-server] fallback to non-compiled validators in environments that do not allow eval (e.g. cloudflare workers, edge functions)

Dart

• BREAKING [dart-codegen] DateTime(0) is now the fallback value for timestamps instead of DateTime.now()

Merged PRs

• chore: update libs by @joshmossas in #180
• refactor: dart and ts make datetime parsing treat Date(0) as the default by @joshmossas in #183
• feature: fallback to runtime validation if a.compile fails by @joshmossas in #185
• chore: update ts libs by @joshmossas in #186

Full Changelog: v0.80.3...v0.81.0

What's Changed

Arri CLI

• fix build issues on windows when running arri dev and arri build. Fixes are in place for both the go server plugin and ts server plugin

Typescript

• [ts-server] add ability to set default heartbeatInterval app - wide

Go

• [go-server] add ability to set default HeartbeatInterval app wide

Dart

• [dart-client] add optional timeout parameter to generated clients that accepts a Duration. This parameter is used to set a default timeout duration for http requests
• [dart-client] add optional heartbeatIntervalMultiplier parameter to generated clients. This is used when setting heartbeat timeouts for server sent events.

Commits

• Modify GitHub Actions yaml to run unit tests on ubuntu and windows os to validate cross platform build by @MatthewMarroquin in #177
• feature: more dart and ts client options by @joshmossas in #178

New Contributors

• @MatthewMarroquin made their first contribution in #177

Full Changelog: v0.80.2...v0.80.3

No changes

No changes

No changes