@trpc/client 10.0.0-alpha.4 → 10.0.0-alpha.40

package/README.md

@@ -1,3 +1,60 @@
+<p align="center">
+  <a href="https://trpc.io/"><img src="../../www/static/img/logo-text.svg" alt="tRPC" height="130"/></a>
+</p>
+
+<p align="center">
+  <strong>End-to-end typesafe APIs made easy</strong>
+</p>
+
+<p align="center">
+  <!-- TODO: replace with new version GIF -->
+  <img src="https://storage.googleapis.com/trpc/trpcgif.gif" alt="Demo" />
+</p>
+
 # `@trpc/client`
 
-https://trpc.io
+> Communicate with a tRPC server on the client side.
+
+## Documentation
+
+Full documentation for `@trpc/client` can be found [here](https://trpc.io/docs/vanilla)
+
+## Installation
+
+```bash
+# npm
+npm install @trpc/client
+
+# Yarn
+yarn add @trpc/client
+
+# pnpm
+pnpm add @trpc/client
+```
+
+## Basic Example
+
+```ts
+import { createTRPCClient, createTRPCClientProxy } from '@trpc/client';
+// Importing the router type from the server file
+import type { AppRouter } from './server';
+
+// Initializing the tRPC client
+const client = createTRPCClient<AppRouter>({
+  url: 'http://localhost:2022',
+});
+
+// Creating a proxy, this allows for cmd+click to the backend function.
+const proxy = createTRPCClientProxy(client);
+
+async function main() {
+  // Querying the greeting
+  const helloResponse = await proxy.greeting.query({
+    name: 'world',
+  });
+
+  console.log('helloResponse', helloResponse); // Hello world
+}
+
+main();
+```

package/dist/TRPCClientError.d.ts

@@ -1,4 +1,4 @@
-import { AnyRouter, inferRouterError, Maybe } from '@trpc/server';
+import { AnyRouter, Maybe, inferRouterError } from '@trpc/server';
 import { TRPCErrorResponse } from '@trpc/server/rpc';
 export interface TRPCClientErrorLike<TRouter extends AnyRouter> {
     readonly message: string;
@@ -6,21 +6,13 @@ export interface TRPCClientErrorLike<TRouter extends AnyRouter> {
     readonly data: Maybe<inferRouterError<TRouter>['data']>;
 }
 export declare class TRPCClientError<TRouter extends AnyRouter> extends Error implements TRPCClientErrorLike<TRouter> {
-    /**
-     * @deprecated use `cause`
-     */
-    readonly originalError: Maybe<Error>;
-    readonly cause: Maybe<Error>;
+    readonly cause: Error | undefined;
     readonly shape: Maybe<inferRouterError<TRouter>>;
     readonly data: Maybe<inferRouterError<TRouter>['data']>;
     readonly meta: Record<string, unknown> | undefined;
     constructor(message: string, opts?: {
         result: Maybe<TRPCErrorResponse<inferRouterError<TRouter>>>;
-        /**
-         * @deprecated use `cause`
-         **/
-        originalError?: Maybe<Error>;
-        cause?: Maybe<Error>;
+        cause?: Error;
         meta?: Record<string, unknown>;
     });
     static from<TRouter extends AnyRouter>(cause: Error | TRPCErrorResponse<any>, opts?: {

package/dist/TRPCClientError.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TRPCClientError.d.ts","sourceRoot":"","sources":["../src/TRPCClientError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,gBAAgB,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAClE,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAErD,MAAM,WAAW,mBAAmB,CAAC,OAAO,SAAS,SAAS;IAC5D,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAC;IACjD,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;CACzD;AAED,qBAAa,eAAe,CAAC,OAAO,SAAS,SAAS,CACpD,SAAQ,KACR,YAAW,mBAAmB,CAAC,OAAO,CAAC;IAEvC;;OAEG;IACH,SAAgB,aAAa,eAAC;IAC9B,SAAgB,KAAK,eAAC;IACtB,SAAgB,KAAK,EAAE,KAAK,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAC;IACxD,SAAgB,IAAI,EAAE,KAAK,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;IAC/D,SAAgB,IAAI,sCAAC;gBAGnB,OAAO,EAAE,MAAM,EACf,IAAI,CAAC,EAAE;QACL,MAAM,EAAE,KAAK,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QAC5D;;YAEI;QACJ,aAAa,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;QAC7B,KAAK,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;QACrB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KAChC;WAkBW,IAAI,CAAC,OAAO,SAAS,SAAS,EAC1C,KAAK,EAAE,KAAK,GAAG,iBAAiB,CAAC,GAAG,CAAC,EACrC,IAAI,GAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAO,GAC5C,eAAe,CAAC,OAAO,CAAC;CAkB5B"}
+{"version":3,"file":"TRPCClientError.d.ts","sourceRoot":"","sources":["../src/TRPCClientError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAClE,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAErD,MAAM,WAAW,mBAAmB,CAAC,OAAO,SAAS,SAAS;IAC5D,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAC;IACjD,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;CACzD;AAED,qBAAa,eAAe,CAAC,OAAO,SAAS,SAAS,CACpD,SAAQ,KACR,YAAW,mBAAmB,CAAC,OAAO,CAAC;IAEvC,SAAgB,KAAK,oBAAC;IACtB,SAAgB,KAAK,EAAE,KAAK,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAC;IACxD,SAAgB,IAAI,EAAE,KAAK,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;IAC/D,SAAgB,IAAI,sCAAC;gBAGnB,OAAO,EAAE,MAAM,EACf,IAAI,CAAC,EAAE;QACL,MAAM,EAAE,KAAK,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QAC5D,KAAK,CAAC,EAAE,KAAK,CAAC;QACd,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KAChC;WAkBW,IAAI,CAAC,OAAO,SAAS,SAAS,EAC1C,KAAK,EAAE,KAAK,GAAG,iBAAiB,CAAC,GAAG,CAAC,EACrC,IAAI,GAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAO,GAC5C,eAAe,CAAC,OAAO,CAAC;CAkB5B"}

package/dist/createTRPCClient.d.ts

@@ -1,6 +1,5 @@
 import type { AnyRouter } from '@trpc/server';
-import { CreateTRPCClientOptions, TRPCClient as Client } from './internals/TRPCClient';
+import { TRPCClient as Client, CreateTRPCClientOptions } from './internals/TRPCClient';
 export declare function createTRPCClient<TRouter extends AnyRouter>(opts: CreateTRPCClientOptions<TRouter>): Client<TRouter>;
-export declare type TRPCClient<TRouter extends AnyRouter> = Client<TRouter>;
-export type { TRPCRequestOptions, CreateTRPCClientOptions, } from './internals/TRPCClient';
+export type { TRPCRequestOptions, CreateTRPCClientOptions, TRPCClient, } from './internals/TRPCClient';
 //# sourceMappingURL=createTRPCClient.d.ts.map

package/dist/createTRPCClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"createTRPCClient.d.ts","sourceRoot":"","sources":["../src/createTRPCClient.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,EACL,uBAAuB,EACvB,UAAU,IAAI,MAAM,EACrB,MAAM,wBAAwB,CAAC;AAEhC,wBAAgB,gBAAgB,CAAC,OAAO,SAAS,SAAS,EACxD,IAAI,EAAE,uBAAuB,CAAC,OAAO,CAAC,mBAGvC;AAED,oBAAY,UAAU,CAAC,OAAO,SAAS,SAAS,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC;AAEpE,YAAY,EACV,kBAAkB,EAClB,uBAAuB,GACxB,MAAM,wBAAwB,CAAC"}
+{"version":3,"file":"createTRPCClient.d.ts","sourceRoot":"","sources":["../src/createTRPCClient.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,EACL,UAAU,IAAI,MAAM,EACpB,uBAAuB,EACxB,MAAM,wBAAwB,CAAC;AAEhC,wBAAgB,gBAAgB,CAAC,OAAO,SAAS,SAAS,EACxD,IAAI,EAAE,uBAAuB,CAAC,OAAO,CAAC,mBAIvC;AAID,YAAY,EACV,kBAAkB,EAClB,uBAAuB,EACvB,UAAU,GACX,MAAM,wBAAwB,CAAC"}

package/dist/createTRPCClientProxy.d.ts

@@ -0,0 +1,24 @@
+import type { AnyRouter, OmitNeverKeys, Procedure, ProcedureArgs, ProcedureRouterRecord, inferProcedureOutput } from '@trpc/server';
+import { TRPCClient as Client } from './internals/TRPCClient';
+declare type Resolver<TProcedure extends Procedure<any>> = (...args: ProcedureArgs<TProcedure['_def']>) => Promise<inferProcedureOutput<TProcedure>>;
+declare type DecorateProcedure<TProcedure extends Procedure<any>> = OmitNeverKeys<{
+    query: TProcedure extends {
+        _query: true;
+    } ? Resolver<TProcedure> : never;
+    mutate: TProcedure extends {
+        _mutation: true;
+    } ? Resolver<TProcedure> : never;
+    subscribe: TProcedure extends {
+        _subscription: true;
+    } ? Resolver<TProcedure> : never;
+}>;
+declare type assertProcedure<T> = T extends Procedure<any> ? T : never;
+/**
+ * @internal
+ */
+declare type DecoratedProcedureRecord<TProcedures extends ProcedureRouterRecord> = {
+    [TKey in keyof TProcedures]: TProcedures[TKey] extends AnyRouter ? DecoratedProcedureRecord<TProcedures[TKey]['_def']['record']> : DecorateProcedure<assertProcedure<TProcedures[TKey]>>;
+};
+export declare function createTRPCClientProxy<TRouter extends AnyRouter>(client: Client<TRouter>): DecoratedProcedureRecord<TRouter["_def"]["record"]>;
+export {};
+//# sourceMappingURL=createTRPCClientProxy.d.ts.map

package/dist/createTRPCClientProxy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createTRPCClientProxy.d.ts","sourceRoot":"","sources":["../src/createTRPCClientProxy.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACV,SAAS,EACT,aAAa,EACb,SAAS,EACT,aAAa,EACb,qBAAqB,EAErB,oBAAoB,EACrB,MAAM,cAAc,CAAC;AAEtB,OAAO,EAAE,UAAU,IAAI,MAAM,EAAE,MAAM,wBAAwB,CAAC;AAE9D,aAAK,QAAQ,CAAC,UAAU,SAAS,SAAS,CAAC,GAAG,CAAC,IAAI,CACjD,GAAG,IAAI,EAAE,aAAa,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,KACvC,OAAO,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC,CAAC;AAE/C,aAAK,iBAAiB,CAAC,UAAU,SAAS,SAAS,CAAC,GAAG,CAAC,IAAI,aAAa,CAAC;IACxE,KAAK,EAAE,UAAU,SAAS;QAAE,MAAM,EAAE,IAAI,CAAA;KAAE,GAAG,QAAQ,CAAC,UAAU,CAAC,GAAG,KAAK,CAAC;IAE1E,MAAM,EAAE,UAAU,SAAS;QAAE,SAAS,EAAE,IAAI,CAAA;KAAE,GAAG,QAAQ,CAAC,UAAU,CAAC,GAAG,KAAK,CAAC;IAE9E,SAAS,EAAE,UAAU,SAAS;QAAE,aAAa,EAAE,IAAI,CAAA;KAAE,GACjD,QAAQ,CAAC,UAAU,CAAC,GACpB,KAAK,CAAC;CACX,CAAC,CAAC;AAEH,aAAK,eAAe,CAAC,CAAC,IAAI,CAAC,SAAS,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AAE/D;;GAEG;AACH,aAAK,wBAAwB,CAAC,WAAW,SAAS,qBAAqB,IAAI;KACxE,IAAI,IAAI,MAAM,WAAW,GAAG,WAAW,CAAC,IAAI,CAAC,SAAS,SAAS,GAC5D,wBAAwB,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,CAAC,GAC7D,iBAAiB,CAAC,eAAe,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;CAC1D,CAAC;AAQF,wBAAgB,qBAAqB,CAAC,OAAO,SAAS,SAAS,EAC7D,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,uDAWxB"}

package/dist/{httpUtils-c09d7b79.mjs → httpUtils-089853f6.mjs}

@@ -21,48 +21,56 @@ var METHOD = {
   mutation: 'POST',
   subscription: 'PATCH'
 };
-function httpRequest(props) {
-  var type = props.type,
-      rt = props.runtime,
-      path = props.path;
-  var ac = rt.AbortController ? new rt.AbortController() : null;
-  var input = 'input' in props ? props.input : arrayToDict(props.inputs);
-
-  function getUrl() {
-    var url = props.url + '/' + path;
-    var queryParts = [];
-
-    if ('inputs' in props) {
-      queryParts.push('batch=1');
-    }
 
-    if (type === 'query' && input !== undefined) {
-      queryParts.push("input=".concat(encodeURIComponent(JSON.stringify(input))));
-    }
+function getInput(opts) {
+  return 'input' in opts ? opts.runtime.transformer.serialize(opts.input) : arrayToDict(opts.inputs.map(function (_input) {
+    return opts.runtime.transformer.serialize(_input);
+  }));
+}
 
-    if (queryParts.length) {
-      url += '?' + queryParts.join('&');
-    }
+function getUrl(opts) {
+  var url = opts.url + '/' + opts.path;
+  var queryParts = [];
 
-    return url;
+  if ('inputs' in opts) {
+    queryParts.push('batch=1');
   }
 
-  function getBody() {
-    if (type === 'query') {
-      return undefined;
+  if (opts.type === 'query') {
+    var input = getInput(opts);
+
+    if (input !== undefined) {
+      queryParts.push("input=".concat(encodeURIComponent(JSON.stringify(input))));
     }
+  }
+
+  if (queryParts.length) {
+    url += '?' + queryParts.join('&');
+  }
 
-    return input !== undefined ? JSON.stringify(input) : undefined;
+  return url;
+}
+function getBody(opts) {
+  if (opts.type === 'query') {
+    return undefined;
   }
 
+  var input = getInput(opts);
+  return input !== undefined ? JSON.stringify(input) : undefined;
+}
+function httpRequest(opts) {
+  var type = opts.type,
+      runtime = opts.runtime;
+  var ac = runtime.AbortController ? new runtime.AbortController() : null;
   var promise = new Promise(function (resolve, reject) {
-    var url = getUrl();
+    var url = getUrl(opts);
+    var body = getBody(opts);
     var meta = {};
-    Promise.resolve(rt.headers()).then(function (headers) {
-      return rt.fetch(url, {
+    Promise.resolve(runtime.headers()).then(function (headers) {
+      return runtime.fetch(url, {
         method: METHOD[type],
         signal: ac === null || ac === void 0 ? void 0 : ac.signal,
-        body: getBody(),
+        body: body,
         headers: _objectSpread({
           'content-type': 'application/json'
         }, headers)
@@ -88,4 +96,4 @@ function httpRequest(props) {
   };
 }
 
-export { httpRequest as h };
+export { getUrl as g, httpRequest as h };

package/dist/{httpUtils-1f9e4e3c.js → httpUtils-a0169eef.js}

@@ -27,48 +27,56 @@ var METHOD = {
   mutation: 'POST',
   subscription: 'PATCH'
 };
-function httpRequest(props) {
-  var type = props.type,
-      rt = props.runtime,
-      path = props.path;
-  var ac = rt.AbortController ? new rt.AbortController() : null;
-  var input = 'input' in props ? props.input : arrayToDict(props.inputs);
-
-  function getUrl() {
-    var url = props.url + '/' + path;
-    var queryParts = [];
-
-    if ('inputs' in props) {
-      queryParts.push('batch=1');
-    }
 
-    if (type === 'query' && input !== undefined) {
-      queryParts.push("input=".concat(encodeURIComponent(JSON.stringify(input))));
-    }
+function getInput(opts) {
+  return 'input' in opts ? opts.runtime.transformer.serialize(opts.input) : arrayToDict(opts.inputs.map(function (_input) {
+    return opts.runtime.transformer.serialize(_input);
+  }));
+}
 
-    if (queryParts.length) {
-      url += '?' + queryParts.join('&');
-    }
+function getUrl(opts) {
+  var url = opts.url + '/' + opts.path;
+  var queryParts = [];
 
-    return url;
+  if ('inputs' in opts) {
+    queryParts.push('batch=1');
   }
 
-  function getBody() {
-    if (type === 'query') {
-      return undefined;
+  if (opts.type === 'query') {
+    var input = getInput(opts);
+
+    if (input !== undefined) {
+      queryParts.push("input=".concat(encodeURIComponent(JSON.stringify(input))));
     }
+  }
+
+  if (queryParts.length) {
+    url += '?' + queryParts.join('&');
+  }
 
-    return input !== undefined ? JSON.stringify(input) : undefined;
+  return url;
+}
+function getBody(opts) {
+  if (opts.type === 'query') {
+    return undefined;
   }
 
+  var input = getInput(opts);
+  return input !== undefined ? JSON.stringify(input) : undefined;
+}
+function httpRequest(opts) {
+  var type = opts.type,
+      runtime = opts.runtime;
+  var ac = runtime.AbortController ? new runtime.AbortController() : null;
   var promise = new Promise(function (resolve, reject) {
-    var url = getUrl();
+    var url = getUrl(opts);
+    var body = getBody(opts);
     var meta = {};
-    Promise.resolve(rt.headers()).then(function (headers) {
-      return rt.fetch(url, {
+    Promise.resolve(runtime.headers()).then(function (headers) {
+      return runtime.fetch(url, {
         method: METHOD[type],
         signal: ac === null || ac === void 0 ? void 0 : ac.signal,
-        body: getBody(),
+        body: body,
         headers: _objectSpread({
           'content-type': 'application/json'
         }, headers)
@@ -94,4 +102,5 @@ function httpRequest(props) {
   };
 }
 
+exports.getUrl = getUrl;
 exports.httpRequest = httpRequest;

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 export * from './createTRPCClient';
+export * from './createTRPCClientProxy';
 export * from './getFetch';
-export * from './links/types';
 export * from './TRPCClientError';
+export * from './links';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,mBAAmB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,yBAAyB,CAAC;AACxC,cAAc,YAAY,CAAC;AAC3B,cAAc,mBAAmB,CAAC;AAClC,cAAc,SAAS,CAAC"}