@arrirpc/typebox-adapter 0.45.0

package/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright 2024 Joshua Sosso
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,42 @@
+# Arri Typebox Adapter
+
+Let's you reuse your [Typebox](https://github.com/sinclairzx81/typebox) schemas with Arri-RPC
+
+## Installation
+
+```bash
+npm install @arrirpc/typebox-adapter
+
+pnpm install @arrirpc/typebox-adapter
+```
+
+## Usage
+
+Simply wrap your typebox schemas with `typeboxAdapter()` to use them with arrirpc. Additionally metadata such as `$id` and `description` will be converted over.
+
+```ts
+// updateUser.rpc.ts
+import { defineRpc } from "@arrirpc/server";
+import { typeboxAdapter } from "@arrripc/typebox-adapter";
+import { Type } from "typebox";
+
+const User = Type.Object(
+    {
+        id: Type.String(),
+        name: Type.String(),
+    },
+    {
+        $id: "User",
+    },
+);
+
+export default defineRpc({
+    params: typeboxAdapter(User),
+    response: typeboxAdapter(User),
+    handler({ params }) {
+        // typebox keys are now available
+        console.log(params.id);
+        return params;
+    },
+});
+```

package/dist/index.cjs

@@ -0,0 +1,66 @@
+'use strict';
+
+const schema = require('@arrirpc/schema');
+const typebox = require('@sinclair/typebox');
+const compiler = require('@sinclair/typebox/compiler');
+const value = require('@sinclair/typebox/value');
+const jsonSchemaToJtd = require('json-schema-to-jtd');
+
+function typeboxAdapter(input) {
+  const schema$1 = jsonSchemaToJtd.jsonSchemaToJtdSchema(input);
+  const compiled = compiler.TypeCompiler.Compile(input);
+  return {
+    ...schema$1,
+    metadata: {
+      id: input.$id ?? input.title,
+      description: input.description,
+      [schema.SCHEMA_METADATA]: {
+        _isAdaptedSchema: true,
+        output: {},
+        optional: input[typebox.OptionalKind] === "Optional",
+        parse(val) {
+          if (typeof val === "string") {
+            const parsedVal = JSON.parse(val);
+            if (compiled.Check(parsedVal)) {
+              return parsedVal;
+            }
+            throw typeboxErrorsToArriError(
+              compiled.Errors(parsedVal)
+            );
+          }
+          if (compiled.Check(val)) {
+            return val;
+          }
+          throw typeboxErrorsToArriError(compiled.Errors(val));
+        },
+        coerce(val) {
+          return value.Value.Cast(input, val);
+        },
+        validate(val) {
+          return compiled.Check(val);
+        },
+        serialize(val) {
+          return compiled.Encode(val);
+        }
+      }
+    }
+  };
+}
+function typeboxErrorsToArriError(errs) {
+  const mappedErrs = [];
+  for (const err of errs) {
+    const obj = {
+      message: err.message,
+      instancePath: err.path,
+      schemaPath: "",
+      data: err.value
+    };
+    mappedErrs.push(obj);
+  }
+  return new schema.ValidationError({
+    message: "Error validating input",
+    errors: mappedErrs
+  });
+}
+
+exports.typeboxAdapter = typeboxAdapter;

package/dist/index.d.cts

@@ -0,0 +1,6 @@
+import { AAdaptedObjectSchema, AAdaptedRecordSchema, AAdaptedSchema } from '@arrirpc/schema';
+import { TSchema, TObject, Static, TRecord } from '@sinclair/typebox';
+
+declare function typeboxAdapter<TInput extends TSchema>(input: TInput): TInput extends TObject ? AAdaptedObjectSchema<Static<TInput>> : TInput extends TRecord ? AAdaptedRecordSchema<Static<TInput> extends Record<string, any> ? Static<TInput>[string] : any> : AAdaptedSchema<Static<TInput>>;
+
+export { typeboxAdapter };

package/dist/index.d.mts

@@ -0,0 +1,6 @@
+import { AAdaptedObjectSchema, AAdaptedRecordSchema, AAdaptedSchema } from '@arrirpc/schema';
+import { TSchema, TObject, Static, TRecord } from '@sinclair/typebox';
+
+declare function typeboxAdapter<TInput extends TSchema>(input: TInput): TInput extends TObject ? AAdaptedObjectSchema<Static<TInput>> : TInput extends TRecord ? AAdaptedRecordSchema<Static<TInput> extends Record<string, any> ? Static<TInput>[string] : any> : AAdaptedSchema<Static<TInput>>;
+
+export { typeboxAdapter };

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+import { AAdaptedObjectSchema, AAdaptedRecordSchema, AAdaptedSchema } from '@arrirpc/schema';
+import { TSchema, TObject, Static, TRecord } from '@sinclair/typebox';
+
+declare function typeboxAdapter<TInput extends TSchema>(input: TInput): TInput extends TObject ? AAdaptedObjectSchema<Static<TInput>> : TInput extends TRecord ? AAdaptedRecordSchema<Static<TInput> extends Record<string, any> ? Static<TInput>[string] : any> : AAdaptedSchema<Static<TInput>>;
+
+export { typeboxAdapter };

package/dist/index.mjs

@@ -0,0 +1,64 @@
+import { SCHEMA_METADATA, ValidationError } from '@arrirpc/schema';
+import { OptionalKind } from '@sinclair/typebox';
+import { TypeCompiler } from '@sinclair/typebox/compiler';
+import { Value } from '@sinclair/typebox/value';
+import { jsonSchemaToJtdSchema } from 'json-schema-to-jtd';
+
+function typeboxAdapter(input) {
+  const schema = jsonSchemaToJtdSchema(input);
+  const compiled = TypeCompiler.Compile(input);
+  return {
+    ...schema,
+    metadata: {
+      id: input.$id ?? input.title,
+      description: input.description,
+      [SCHEMA_METADATA]: {
+        _isAdaptedSchema: true,
+        output: {},
+        optional: input[OptionalKind] === "Optional",
+        parse(val) {
+          if (typeof val === "string") {
+            const parsedVal = JSON.parse(val);
+            if (compiled.Check(parsedVal)) {
+              return parsedVal;
+            }
+            throw typeboxErrorsToArriError(
+              compiled.Errors(parsedVal)
+            );
+          }
+          if (compiled.Check(val)) {
+            return val;
+          }
+          throw typeboxErrorsToArriError(compiled.Errors(val));
+        },
+        coerce(val) {
+          return Value.Cast(input, val);
+        },
+        validate(val) {
+          return compiled.Check(val);
+        },
+        serialize(val) {
+          return compiled.Encode(val);
+        }
+      }
+    }
+  };
+}
+function typeboxErrorsToArriError(errs) {
+  const mappedErrs = [];
+  for (const err of errs) {
+    const obj = {
+      message: err.message,
+      instancePath: err.path,
+      schemaPath: "",
+      data: err.value
+    };
+    mappedErrs.push(obj);
+  }
+  return new ValidationError({
+    message: "Error validating input",
+    errors: mappedErrs
+  });
+}
+
+export { typeboxAdapter };

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@arrirpc/typebox-adapter",
+  "version": "0.45.0",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "license": "MIT",
+  "author": {
+    "name": "joshmossas",
+    "url": "https://github.com/joshmossas"
+  },
+  "bugs": {
+    "url": "https://github.com/modiimedia/arri/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/modiimedia/arri.git",
+    "directory": "tooling/schema-typebox-adapter"
+  },
+  "dependencies": {
+    "@arrirpc/schema": "0.45.0",
+    "json-schema-to-jtd": "0.45.0"
+  },
+  "devDependencies": {
+    "@arrirpc/server": "0.45.0"
+  },
+  "peerDependencies": {
+    "@sinclair/typebox": "^0.32"
+  }
+}