@arrirpc/codegen-ts 0.45.4 → 0.45.6

package/README.md

@@ -1,11 +1,104 @@
-# arri-codegen-ts
+# Arri Typescript Codegen
 
-This library was generated with [Nx](https://nx.dev).
+## Setup
+
+### 1) Add the generator to your arri config
+
+```ts
+// arri.config.ts
+import { defineConfig, typescriptClientGenerator } from "arri";
+
+export default defineConfig({
+    generators: [
+        typescriptClientGenerator({
+            clientName: "MyClient",
+            outputFile: "./client/src/myClient.g.ts",
+        }),
+    ],
+});
+```
+
+**Options:**
+
+| Name                  | Description                                          |
+| --------------------- | ---------------------------------------------------- |
+| clientName (required) | The name of the generated client                     |
+| outputFile (required) | Path to a file that will be created by the generator |
+| prettierOptions       | Formatting options for the generated code            |
+
+### 2) Install the TS client library
+
+Make sure that the project that will be using the generated code has the client library installed. The version number should match your arri cli version.
+
+```bash
+# npm
+npm i @arrirpc/client
+
+# pnpm
+pnpm i --save @arrirpc/client
+```
+
+## Using the Generated Code
+
+### Initialize the client
+
+```ts
+// This will match whatever you put in the arri config
+import { MyClient } from "./myClient.g";
+
+const client = new MyClient({
+    baseUrl: "https://example.com",
+    headers: () => {
+        return {
+            Authorization: "<some-token>",
+        };
+    },
+});
+
+await client.myProcedure();
+```
+
+The root client will be a class containing all of the services and procedures in a single class. If you only need a particular service. You can also import just that service.
+
+For example if we have a some procedures grouped under `"users"` we can import just that service like so.
+
+```ts
+import { MyClientUsersService } from "./myClient.g";
+
+const usersService = new MyClientUsersService({
+    baseUrl: "https://example.com",
+    headers: () => {
+        return {
+            Authorization: "<some-token>",
+        };
+    },
+});
+
+usersService.someProcedure();
+```
+
+### Importing and using types
+
+All generated types and serializers/parsers can be imported from the generated code as well. Types will match the ID given to them in the schema. Serialization and parsing helpers will be prefixed with a `$$`
+
+```ts
+// import the user type and the user helper
+import { type User, $$User } from "./myClient.g";
+
+const bob: User = {
+    // field
+};
+
+$$User.serialize(bob); // outputs valid JSON
+$$User.parse("<some-json-string>"); // outputs a User
+```
+
+# Development
 
 ## Building
 
-Run `nx build arri-codegen-ts` to build the library.
+Run `nx build ts-codegen` to build the library.
 
 ## Running unit tests
 
-Run `nx test arri-codegen-ts` to execute the unit tests via [Vitest](https://vitest.dev).
+Run `nx test ts-codegen` to execute the unit tests via [Vitest](https://vitest.dev).

package/dist/index.cjs

@@ -1,8 +1,8 @@
 'use strict';
 
-const fs = require('fs');
 const codegenUtils = require('@arrirpc/codegen-utils');
 const schema = require('@arrirpc/schema');
+const fs = require('fs');
 const prettier = require('prettier');
 
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e.default : e; }

package/dist/index.mjs

@@ -1,6 +1,6 @@
-import { writeFileSync } from 'fs';
 import { defineClientGeneratorPlugin, pascalCase, unflattenProcedures, isRpcDefinition, isServiceDefinition, isSchemaFormProperties, isSchemaFormDiscriminator, isSchemaFormType, isSchemaFormEnum, isSchemaFormElements, isSchemaFormValues, isSchemaFormRef, camelCase } from '@arrirpc/codegen-utils';
 import { getSchemaParsingCode, getSchemaSerializationCode } from '@arrirpc/schema';
+import { writeFileSync } from 'fs';
 import prettier from 'prettier';
 
 const typescriptClientGenerator = defineClientGeneratorPlugin(

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arrirpc/codegen-ts",
-  "version": "0.45.4",
+  "version": "0.45.6",
   "type": "module",
   "license": "MIT",
   "author": {
@@ -22,12 +22,11 @@
     "dist"
   ],
   "dependencies": {
-    "ajv": "^8.13.0",
     "prettier": "^3.2.5",
-    "@arrirpc/schema": "0.45.4",
-    "@arrirpc/codegen-utils": "0.45.4"
+    "@arrirpc/codegen-utils": "0.45.6",
+    "@arrirpc/schema": "0.45.6"
   },
   "devDependencies": {
-    "@arrirpc/client": "0.45.4"
+    "@arrirpc/client": "0.45.6"
   }
 }