@arrirpc/codegen-ts 0.50.0 → 0.51.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (7) hide show
  1. package/README.md +2 -2
  2. package/dist/index.cjs +4 -4
  3. package/dist/index.d.cts +6 -6
  4. package/dist/index.d.mts +6 -6
  5. package/dist/index.d.ts +6 -6
  6. package/dist/index.mjs +5 -5
  7. package/package.json +4 -4
package/README.md CHANGED
@@ -6,11 +6,11 @@
6
6
 
7
7
  ```ts
8
8
  // arri.config.ts
9
- import { defineConfig, typescriptClientGenerator } from "arri";
9
+ import { defineConfig, generators } from "arri";
10
10
 
11
11
  export default defineConfig({
12
12
  generators: [
13
- typescriptClientGenerator({
13
+ generators.typescriptClient({
14
14
  clientName: "MyClient",
15
15
  outputFile: "./client/src/myClient.g.ts",
16
16
  }),
package/dist/index.cjs CHANGED
@@ -9,7 +9,7 @@ function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'defau
9
9
 
10
10
  const prettier__default = /*#__PURE__*/_interopDefaultCompat(prettier);
11
11
 
12
- const typescriptClientGenerator = codegenUtils.defineClientGeneratorPlugin(
12
+ const typescriptClientGenerator = codegenUtils.defineGeneratorPlugin(
13
13
  (options) => ({
14
14
  generator: async (def) => {
15
15
  if (!options.clientName) {
@@ -106,12 +106,12 @@ import { ${importParts.join(", ")} } from '@arrirpc/client';
106
106
 
107
107
  interface ${clientName}Options {
108
108
  baseUrl?: string;
109
- headers?: Record<string, string> | (() => Record<string, string> | Promise<Record<string, string>>);
109
+ headers?: Record<string, string | undefined> | (() => Record<string, string | undefined> | Promise<Record<string, string | undefined>>);
110
110
  }
111
111
 
112
112
  export class ${clientName} {
113
113
  private readonly baseUrl: string;
114
- private readonly headers: Record<string, string> | (() => Record<string, string> | Promise<Record<string, string>>)
114
+ private readonly headers: Record<string, string | undefined> | (() => Record<string, string | undefined> | Promise<Record<string, string | undefined>>)
115
115
  private readonly clientVersion = '${rpcOptions.versionNumber}';
116
116
  ${serviceFieldParts.join("\n ")}
117
117
 
@@ -238,7 +238,7 @@ function tsServiceFromDefinition(name, schema, options) {
238
238
  });
239
239
  return `export class ${name}Service {
240
240
  private readonly baseUrl: string;
241
- private readonly headers: Record<string, string> | (() => Record<string, string> | Promise<Record<string, string>>);
241
+ private readonly headers: Record<string, string | undefined> | (() => Record<string, string | undefined> | Promise<Record<string, string | undefined>>);
242
242
  private readonly clientVersion = '${options.versionNumber}';
243
243
  ${serviceFieldParts.join("\n ")}
244
244
 
package/dist/index.d.cts CHANGED
@@ -2,14 +2,14 @@ import * as _arrirpc_codegen_utils from '@arrirpc/codegen-utils';
2
2
  import { AppDefinition, RpcDefinition, HttpRpcDefinition, WsRpcDefinition, ServiceDefinition, Schema, SchemaFormType, SchemaFormProperties, SchemaFormEnum, SchemaFormElements, SchemaFormDiscriminator, SchemaFormValues, SchemaFormRef } from '@arrirpc/codegen-utils';
3
3
  import prettier from 'prettier';
4
4
 
5
- interface GeneratorOptions {
5
+ interface TypescriptGeneratorOptions {
6
6
  clientName: string;
7
7
  outputFile: string;
8
8
  prettierOptions?: Omit<prettier.Config, "parser">;
9
9
  }
10
- declare const typescriptClientGenerator: _arrirpc_codegen_utils.ClientGeneratorPlugin<GeneratorOptions>;
11
- declare function createTypescriptClient(def: AppDefinition, options: GeneratorOptions): Promise<string>;
12
- interface RpcOptions extends GeneratorOptions {
10
+ declare const typescriptClientGenerator: _arrirpc_codegen_utils.GeneratorPlugin<TypescriptGeneratorOptions>;
11
+ declare function createTypescriptClient(def: AppDefinition, options: TypescriptGeneratorOptions): Promise<string>;
12
+ interface RpcOptions extends TypescriptGeneratorOptions {
13
13
  versionNumber: string;
14
14
  typesNeedingParser: string[];
15
15
  hasSseProcedures: boolean;
@@ -35,7 +35,7 @@ interface TsProperty {
35
35
  declare function tsTypeFromJtdSchema(nodePath: string, def: Schema, options: RpcOptions, additionalOptions: AdditionalOptions): TsProperty;
36
36
  declare function maybeOptionalKey(keyName: string, isOptional?: boolean): string;
37
37
  declare function maybeNullType(typeName: string, isNullable?: boolean): string;
38
- declare function tsAnyFromJtdSchema(nodePath: string, def: Schema, options: GeneratorOptions, additionalOptions: AdditionalOptions): TsProperty;
38
+ declare function tsAnyFromJtdSchema(nodePath: string, def: Schema, options: TypescriptGeneratorOptions, additionalOptions: AdditionalOptions): TsProperty;
39
39
  declare function getJsDocComment(metadata: Schema["metadata"]): string;
40
40
  declare function tsScalarFromJtdSchema(nodePath: string, def: SchemaFormType, options: RpcOptions, additionalOptions: AdditionalOptions): TsProperty;
41
41
  declare function tsObjectFromJtdSchema(nodePath: string, def: SchemaFormProperties, options: RpcOptions, additionalOptions: AdditionalOptions & {
@@ -48,4 +48,4 @@ declare function tsDiscriminatedUnionFromJtdSchema(nodePath: string, def: Schema
48
48
  declare function tsRecordFromJtdSchema(nodePath: string, def: SchemaFormValues, options: RpcOptions, additionalOptions: AdditionalOptions): TsProperty;
49
49
  declare function tsRefFromJtdSchema(nodePath: string, def: SchemaFormRef, options: RpcOptions, additionalOptions: AdditionalOptions): TsProperty;
50
50
 
51
- export { createTypescriptClient, getJsDocComment, maybeNullType, maybeOptionalKey, tsAnyFromJtdSchema, tsArrayFromJtdSchema, tsDiscriminatedUnionFromJtdSchema, tsEnumFromJtdSchema, tsHttpRpcFromDefinition, tsObjectFromJtdSchema, tsRecordFromJtdSchema, tsRefFromJtdSchema, tsRpcFromDefinition, tsScalarFromJtdSchema, tsServiceFromDefinition, tsTypeFromJtdSchema, tsWsRpcFromDefinition, typescriptClientGenerator };
51
+ export { type TypescriptGeneratorOptions, createTypescriptClient, getJsDocComment, maybeNullType, maybeOptionalKey, tsAnyFromJtdSchema, tsArrayFromJtdSchema, tsDiscriminatedUnionFromJtdSchema, tsEnumFromJtdSchema, tsHttpRpcFromDefinition, tsObjectFromJtdSchema, tsRecordFromJtdSchema, tsRefFromJtdSchema, tsRpcFromDefinition, tsScalarFromJtdSchema, tsServiceFromDefinition, tsTypeFromJtdSchema, tsWsRpcFromDefinition, typescriptClientGenerator };
package/dist/index.d.mts CHANGED
@@ -2,14 +2,14 @@ import * as _arrirpc_codegen_utils from '@arrirpc/codegen-utils';
2
2
  import { AppDefinition, RpcDefinition, HttpRpcDefinition, WsRpcDefinition, ServiceDefinition, Schema, SchemaFormType, SchemaFormProperties, SchemaFormEnum, SchemaFormElements, SchemaFormDiscriminator, SchemaFormValues, SchemaFormRef } from '@arrirpc/codegen-utils';
3
3
  import prettier from 'prettier';
4
4
 
5
- interface GeneratorOptions {
5
+ interface TypescriptGeneratorOptions {
6
6
  clientName: string;
7
7
  outputFile: string;
8
8
  prettierOptions?: Omit<prettier.Config, "parser">;
9
9
  }
10
- declare const typescriptClientGenerator: _arrirpc_codegen_utils.ClientGeneratorPlugin<GeneratorOptions>;
11
- declare function createTypescriptClient(def: AppDefinition, options: GeneratorOptions): Promise<string>;
12
- interface RpcOptions extends GeneratorOptions {
10
+ declare const typescriptClientGenerator: _arrirpc_codegen_utils.GeneratorPlugin<TypescriptGeneratorOptions>;
11
+ declare function createTypescriptClient(def: AppDefinition, options: TypescriptGeneratorOptions): Promise<string>;
12
+ interface RpcOptions extends TypescriptGeneratorOptions {
13
13
  versionNumber: string;
14
14
  typesNeedingParser: string[];
15
15
  hasSseProcedures: boolean;
@@ -35,7 +35,7 @@ interface TsProperty {
35
35
  declare function tsTypeFromJtdSchema(nodePath: string, def: Schema, options: RpcOptions, additionalOptions: AdditionalOptions): TsProperty;
36
36
  declare function maybeOptionalKey(keyName: string, isOptional?: boolean): string;
37
37
  declare function maybeNullType(typeName: string, isNullable?: boolean): string;
38
- declare function tsAnyFromJtdSchema(nodePath: string, def: Schema, options: GeneratorOptions, additionalOptions: AdditionalOptions): TsProperty;
38
+ declare function tsAnyFromJtdSchema(nodePath: string, def: Schema, options: TypescriptGeneratorOptions, additionalOptions: AdditionalOptions): TsProperty;
39
39
  declare function getJsDocComment(metadata: Schema["metadata"]): string;
40
40
  declare function tsScalarFromJtdSchema(nodePath: string, def: SchemaFormType, options: RpcOptions, additionalOptions: AdditionalOptions): TsProperty;
41
41
  declare function tsObjectFromJtdSchema(nodePath: string, def: SchemaFormProperties, options: RpcOptions, additionalOptions: AdditionalOptions & {
@@ -48,4 +48,4 @@ declare function tsDiscriminatedUnionFromJtdSchema(nodePath: string, def: Schema
48
48
  declare function tsRecordFromJtdSchema(nodePath: string, def: SchemaFormValues, options: RpcOptions, additionalOptions: AdditionalOptions): TsProperty;
49
49
  declare function tsRefFromJtdSchema(nodePath: string, def: SchemaFormRef, options: RpcOptions, additionalOptions: AdditionalOptions): TsProperty;
50
50
 
51
- export { createTypescriptClient, getJsDocComment, maybeNullType, maybeOptionalKey, tsAnyFromJtdSchema, tsArrayFromJtdSchema, tsDiscriminatedUnionFromJtdSchema, tsEnumFromJtdSchema, tsHttpRpcFromDefinition, tsObjectFromJtdSchema, tsRecordFromJtdSchema, tsRefFromJtdSchema, tsRpcFromDefinition, tsScalarFromJtdSchema, tsServiceFromDefinition, tsTypeFromJtdSchema, tsWsRpcFromDefinition, typescriptClientGenerator };
51
+ export { type TypescriptGeneratorOptions, createTypescriptClient, getJsDocComment, maybeNullType, maybeOptionalKey, tsAnyFromJtdSchema, tsArrayFromJtdSchema, tsDiscriminatedUnionFromJtdSchema, tsEnumFromJtdSchema, tsHttpRpcFromDefinition, tsObjectFromJtdSchema, tsRecordFromJtdSchema, tsRefFromJtdSchema, tsRpcFromDefinition, tsScalarFromJtdSchema, tsServiceFromDefinition, tsTypeFromJtdSchema, tsWsRpcFromDefinition, typescriptClientGenerator };
package/dist/index.d.ts CHANGED
@@ -2,14 +2,14 @@ import * as _arrirpc_codegen_utils from '@arrirpc/codegen-utils';
2
2
  import { AppDefinition, RpcDefinition, HttpRpcDefinition, WsRpcDefinition, ServiceDefinition, Schema, SchemaFormType, SchemaFormProperties, SchemaFormEnum, SchemaFormElements, SchemaFormDiscriminator, SchemaFormValues, SchemaFormRef } from '@arrirpc/codegen-utils';
3
3
  import prettier from 'prettier';
4
4
 
5
- interface GeneratorOptions {
5
+ interface TypescriptGeneratorOptions {
6
6
  clientName: string;
7
7
  outputFile: string;
8
8
  prettierOptions?: Omit<prettier.Config, "parser">;
9
9
  }
10
- declare const typescriptClientGenerator: _arrirpc_codegen_utils.ClientGeneratorPlugin<GeneratorOptions>;
11
- declare function createTypescriptClient(def: AppDefinition, options: GeneratorOptions): Promise<string>;
12
- interface RpcOptions extends GeneratorOptions {
10
+ declare const typescriptClientGenerator: _arrirpc_codegen_utils.GeneratorPlugin<TypescriptGeneratorOptions>;
11
+ declare function createTypescriptClient(def: AppDefinition, options: TypescriptGeneratorOptions): Promise<string>;
12
+ interface RpcOptions extends TypescriptGeneratorOptions {
13
13
  versionNumber: string;
14
14
  typesNeedingParser: string[];
15
15
  hasSseProcedures: boolean;
@@ -35,7 +35,7 @@ interface TsProperty {
35
35
  declare function tsTypeFromJtdSchema(nodePath: string, def: Schema, options: RpcOptions, additionalOptions: AdditionalOptions): TsProperty;
36
36
  declare function maybeOptionalKey(keyName: string, isOptional?: boolean): string;
37
37
  declare function maybeNullType(typeName: string, isNullable?: boolean): string;
38
- declare function tsAnyFromJtdSchema(nodePath: string, def: Schema, options: GeneratorOptions, additionalOptions: AdditionalOptions): TsProperty;
38
+ declare function tsAnyFromJtdSchema(nodePath: string, def: Schema, options: TypescriptGeneratorOptions, additionalOptions: AdditionalOptions): TsProperty;
39
39
  declare function getJsDocComment(metadata: Schema["metadata"]): string;
40
40
  declare function tsScalarFromJtdSchema(nodePath: string, def: SchemaFormType, options: RpcOptions, additionalOptions: AdditionalOptions): TsProperty;
41
41
  declare function tsObjectFromJtdSchema(nodePath: string, def: SchemaFormProperties, options: RpcOptions, additionalOptions: AdditionalOptions & {
@@ -48,4 +48,4 @@ declare function tsDiscriminatedUnionFromJtdSchema(nodePath: string, def: Schema
48
48
  declare function tsRecordFromJtdSchema(nodePath: string, def: SchemaFormValues, options: RpcOptions, additionalOptions: AdditionalOptions): TsProperty;
49
49
  declare function tsRefFromJtdSchema(nodePath: string, def: SchemaFormRef, options: RpcOptions, additionalOptions: AdditionalOptions): TsProperty;
50
50
 
51
- export { createTypescriptClient, getJsDocComment, maybeNullType, maybeOptionalKey, tsAnyFromJtdSchema, tsArrayFromJtdSchema, tsDiscriminatedUnionFromJtdSchema, tsEnumFromJtdSchema, tsHttpRpcFromDefinition, tsObjectFromJtdSchema, tsRecordFromJtdSchema, tsRefFromJtdSchema, tsRpcFromDefinition, tsScalarFromJtdSchema, tsServiceFromDefinition, tsTypeFromJtdSchema, tsWsRpcFromDefinition, typescriptClientGenerator };
51
+ export { type TypescriptGeneratorOptions, createTypescriptClient, getJsDocComment, maybeNullType, maybeOptionalKey, tsAnyFromJtdSchema, tsArrayFromJtdSchema, tsDiscriminatedUnionFromJtdSchema, tsEnumFromJtdSchema, tsHttpRpcFromDefinition, tsObjectFromJtdSchema, tsRecordFromJtdSchema, tsRefFromJtdSchema, tsRpcFromDefinition, tsScalarFromJtdSchema, tsServiceFromDefinition, tsTypeFromJtdSchema, tsWsRpcFromDefinition, typescriptClientGenerator };
package/dist/index.mjs CHANGED
@@ -1,9 +1,9 @@
1
- import { defineClientGeneratorPlugin, pascalCase, unflattenProcedures, isRpcDefinition, isServiceDefinition, isSchemaFormProperties, isSchemaFormDiscriminator, isSchemaFormType, isSchemaFormEnum, isSchemaFormElements, isSchemaFormValues, isSchemaFormRef, camelCase } from '@arrirpc/codegen-utils';
1
+ import { defineGeneratorPlugin, pascalCase, unflattenProcedures, isRpcDefinition, isServiceDefinition, isSchemaFormProperties, isSchemaFormDiscriminator, isSchemaFormType, isSchemaFormEnum, isSchemaFormElements, isSchemaFormValues, isSchemaFormRef, camelCase } from '@arrirpc/codegen-utils';
2
2
  import { getSchemaParsingCode, getSchemaSerializationCode } from '@arrirpc/schema';
3
3
  import { writeFileSync } from 'fs';
4
4
  import prettier from 'prettier';
5
5
 
6
- const typescriptClientGenerator = defineClientGeneratorPlugin(
6
+ const typescriptClientGenerator = defineGeneratorPlugin(
7
7
  (options) => ({
8
8
  generator: async (def) => {
9
9
  if (!options.clientName) {
@@ -100,12 +100,12 @@ import { ${importParts.join(", ")} } from '@arrirpc/client';
100
100
 
101
101
  interface ${clientName}Options {
102
102
  baseUrl?: string;
103
- headers?: Record<string, string> | (() => Record<string, string> | Promise<Record<string, string>>);
103
+ headers?: Record<string, string | undefined> | (() => Record<string, string | undefined> | Promise<Record<string, string | undefined>>);
104
104
  }
105
105
 
106
106
  export class ${clientName} {
107
107
  private readonly baseUrl: string;
108
- private readonly headers: Record<string, string> | (() => Record<string, string> | Promise<Record<string, string>>)
108
+ private readonly headers: Record<string, string | undefined> | (() => Record<string, string | undefined> | Promise<Record<string, string | undefined>>)
109
109
  private readonly clientVersion = '${rpcOptions.versionNumber}';
110
110
  ${serviceFieldParts.join("\n ")}
111
111
 
@@ -232,7 +232,7 @@ function tsServiceFromDefinition(name, schema, options) {
232
232
  });
233
233
  return `export class ${name}Service {
234
234
  private readonly baseUrl: string;
235
- private readonly headers: Record<string, string> | (() => Record<string, string> | Promise<Record<string, string>>);
235
+ private readonly headers: Record<string, string | undefined> | (() => Record<string, string | undefined> | Promise<Record<string, string | undefined>>);
236
236
  private readonly clientVersion = '${options.versionNumber}';
237
237
  ${serviceFieldParts.join("\n ")}
238
238
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@arrirpc/codegen-ts",
3
- "version": "0.50.0",
3
+ "version": "0.51.1",
4
4
  "type": "module",
5
5
  "license": "MIT",
6
6
  "author": {
@@ -23,10 +23,10 @@
23
23
  ],
24
24
  "dependencies": {
25
25
  "prettier": "^3.3.2",
26
- "@arrirpc/schema": "0.50.0",
27
- "@arrirpc/codegen-utils": "0.50.0"
26
+ "@arrirpc/codegen-utils": "0.51.1",
27
+ "@arrirpc/schema": "0.51.1"
28
28
  },
29
29
  "devDependencies": {
30
- "@arrirpc/client": "0.50.0"
30
+ "@arrirpc/client": "0.51.1"
31
31
  }
32
32
  }