@atproto/xrpc 0.4.3 → 0.5.1-rc.0

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @atproto/xrpc
 
+## 0.5.0
+
+### Minor Changes
+
+- [#2169](https://github.com/bluesky-social/atproto/pull/2169) [`f689bd51a`](https://github.com/bluesky-social/atproto/commit/f689bd51a2f4e02d4eca40eb2568a1fcb95494e9) Thanks [@matthieusieben](https://github.com/matthieusieben)! - Build system rework, stop bundling dependencies.
+
+### Patch Changes
+
+- Updated dependencies [[`f689bd51a`](https://github.com/bluesky-social/atproto/commit/f689bd51a2f4e02d4eca40eb2568a1fcb95494e9)]:
+  - @atproto/lexicon@0.4.0
+
 ## 0.4.3
 
 ### Patch Changes

package/README.md

@@ -9,9 +9,9 @@ TypeScript client library for talking to [atproto](https://atproto.com) services
 
 ```typescript
 import { LexiconDoc } from '@atproto/lexicon'
-import xrpc from '@atproto/xrpc'
+import { XrpcClient } from '@atproto/xrpc'
 
-const pingLexicon: LexiconDoc = {
+const pingLexicon = {
   lexicon: 1,
   id: 'io.example.ping',
   defs: {
@@ -32,44 +32,69 @@ const pingLexicon: LexiconDoc = {
       },
     },
   },
-}
-xrpc.addLexicon(pingLexicon)
+} satisfies LexiconDoc
+
+const xrpc = new XrpcClient('https://ping.example.com', [
+  // Any number of lexicon here
+  pingLexicon,
+])
 
-const res1 = await xrpc.call('https://example.com', 'io.example.ping', {
+const res1 = await xrpc.call('io.example.ping', {
   message: 'hello world',
 })
 res1.encoding // => 'application/json'
 res1.body // => {message: 'hello world'}
-const res2 = await xrpc
-  .service('https://example.com')
-  .call('io.example.ping', { message: 'hello world' })
-res2.encoding // => 'application/json'
-res2.body // => {message: 'hello world'}
+```
 
-const writeJsonLexicon: LexiconDoc = {
-  lexicon: 1,
-  id: 'io.example.writeJsonFile',
-  defs: {
-    main: {
-      type: 'procedure',
-      description: 'Write a JSON file',
-      parameters: {
-        type: 'params',
-        properties: { fileName: { type: 'string' } },
-      },
-      input: {
-        encoding: 'application/json',
-      },
-    },
+### With a custom fetch handler
+
+```typescript
+import { XrpcClient } from '@atproto/xrpc'
+
+const session = {
+  serviceUrl: 'https://ping.example.com',
+  token: '<my-token>',
+  async refreshToken() {
+    const { token } = await fetch('https://auth.example.com/refresh', {
+      method: 'POST',
+      headers: { Authorization: `Bearer ${this.token}` },
+    }).then((res) => res.json())
+
+    this.token = token
+
+    return token
   },
 }
-xrpc.addLexicon(writeJsonLexicon)
 
-const res3 = await xrpc.service('https://example.com').call(
-  'io.example.writeJsonFile',
-  { fileName: 'foo.json' }, // query parameters
-  { hello: 'world', thisIs: 'the file to write' }, // input body
-)
+const sessionBasedFetch: FetchHandler = async (
+  url: string,
+  init: RequestInit,
+) => {
+  const headers = new Headers(init.headers)
+
+  headers.set('Authorization', `Bearer ${session.token}`)
+
+  const response = await fetch(new URL(url, session.serviceUrl), {
+    ...init,
+    headers,
+  })
+
+  if (response.status === 401) {
+    // Refresh token, then try again.
+    const newToken = await session.refreshToken()
+    headers.set('Authorization', `Bearer ${newToken}`)
+    return fetch(new URL(url, session.serviceUrl), { ...init, headers })
+  }
+
+  return response
+}
+
+const xrpc = new XrpcClient(sessionBasedFetch, [
+  // Any number of lexicon here
+  pingLexicon,
+])
+
+//
 ```
 
 ## License

package/dist/client.d.ts

@@ -1,21 +1,26 @@
 import { LexiconDoc, Lexicons } from '@atproto/lexicon';
-import { FetchHandler, FetchHandlerResponse, Headers, CallOptions, QueryParams, XRPCResponse } from './types';
+import { CallOptions, QueryParams } from './types';
+import { XrpcClient } from './xrpc-client';
+/** @deprecated Use {@link XrpcClient} instead */
 export declare class Client {
-    fetch: FetchHandler;
+    /** @deprecated */
+    get fetch(): never;
+    /** @deprecated */
+    set fetch(_: never);
     lex: Lexicons;
-    call(serviceUri: string | URL, methodNsid: string, params?: QueryParams, data?: unknown, opts?: CallOptions): Promise<XRPCResponse>;
+    call(serviceUri: string | URL, methodNsid: string, params?: QueryParams, data?: BodyInit | null, opts?: CallOptions): Promise<import("./types").XRPCResponse>;
     service(serviceUri: string | URL): ServiceClient;
     addLexicon(doc: LexiconDoc): void;
     addLexicons(docs: LexiconDoc[]): void;
     removeLexicon(uri: string): void;
 }
-export declare class ServiceClient {
+/** @deprecated Use {@link XrpcClient} instead */
+export declare class ServiceClient extends XrpcClient {
     baseClient: Client;
     uri: URL;
     headers: Record<string, string>;
     constructor(baseClient: Client, serviceUri: string | URL);
     setHeader(key: string, value: string): void;
     unsetHeader(key: string): void;
-    call(methodNsid: string, params?: QueryParams, data?: unknown, opts?: CallOptions): Promise<XRPCResponse>;
 }
-export declare function defaultFetchHandler(httpUri: string, httpMethod: string, httpHeaders: Headers, httpReqBody: unknown): Promise<FetchHandlerResponse>;
+//# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAA;AACvD,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AAClD,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAA;AAG1C,iDAAiD;AACjD,qBAAa,MAAM;IACjB,kBAAkB;IAClB,IAAI,KAAK,IAAI,KAAK,CAIjB;IAED,kBAAkB;IAClB,IAAI,KAAK,CAAC,CAAC,EAAE,KAAK,EAIjB;IAED,GAAG,WAAiB;IAKd,IAAI,CACR,UAAU,EAAE,MAAM,GAAG,GAAG,EACxB,UAAU,EAAE,MAAM,EAClB,MAAM,CAAC,EAAE,WAAW,EACpB,IAAI,CAAC,EAAE,QAAQ,GAAG,IAAI,EACtB,IAAI,CAAC,EAAE,WAAW;IAKpB,OAAO,CAAC,UAAU,EAAE,MAAM,GAAG,GAAG;IAOhC,UAAU,CAAC,GAAG,EAAE,UAAU;IAI1B,WAAW,CAAC,IAAI,EAAE,UAAU,EAAE;IAM9B,aAAa,CAAC,GAAG,EAAE,MAAM;CAG1B;AAED,iDAAiD;AACjD,qBAAa,aAAc,SAAQ,UAAU;IAKlC,UAAU,EAAE,MAAM;IAJ3B,GAAG,EAAE,GAAG,CAAA;IACR,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAK;gBAG3B,UAAU,EAAE,MAAM,EACzB,UAAU,EAAE,MAAM,GAAG,GAAG;IAS1B,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAI3C,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;CAG/B"}

package/dist/client.js

@@ -0,0 +1,83 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ServiceClient = exports.Client = void 0;
+const lexicon_1 = require("@atproto/lexicon");
+const xrpc_client_1 = require("./xrpc-client");
+const util_1 = require("./util");
+/** @deprecated Use {@link XrpcClient} instead */
+class Client {
+    constructor() {
+        Object.defineProperty(this, "lex", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: new lexicon_1.Lexicons()
+        });
+    }
+    /** @deprecated */
+    get fetch() {
+        throw new Error('Client.fetch is no longer supported. Use an XrpcClient instead.');
+    }
+    /** @deprecated */
+    set fetch(_) {
+        throw new Error('Client.fetch is no longer supported. Use an XrpcClient instead.');
+    }
+    // method calls
+    //
+    async call(serviceUri, methodNsid, params, data, opts) {
+        return this.service(serviceUri).call(methodNsid, params, data, opts);
+    }
+    service(serviceUri) {
+        return new ServiceClient(this, serviceUri);
+    }
+    // schemas
+    // =
+    addLexicon(doc) {
+        this.lex.add(doc);
+    }
+    addLexicons(docs) {
+        for (const doc of docs) {
+            this.addLexicon(doc);
+        }
+    }
+    removeLexicon(uri) {
+        this.lex.remove(uri);
+    }
+}
+exports.Client = Client;
+/** @deprecated Use {@link XrpcClient} instead */
+class ServiceClient extends xrpc_client_1.XrpcClient {
+    constructor(baseClient, serviceUri) {
+        super(async (input, init) => {
+            const headers = (0, util_1.combineHeaders)(init.headers, Object.entries(this.headers));
+            return fetch(new URL(input, this.uri), { ...init, headers });
+        }, baseClient.lex);
+        Object.defineProperty(this, "baseClient", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: baseClient
+        });
+        Object.defineProperty(this, "uri", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "headers", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: {}
+        });
+        this.uri = typeof serviceUri === 'string' ? new URL(serviceUri) : serviceUri;
+    }
+    setHeader(key, value) {
+        this.headers[key] = value;
+    }
+    unsetHeader(key) {
+        delete this.headers[key];
+    }
+}
+exports.ServiceClient = ServiceClient;
+//# sourceMappingURL=client.js.map

package/dist/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":";;;AAAA,8CAAuD;AAEvD,+CAA0C;AAC1C,iCAAuC;AAEvC,iDAAiD;AACjD,MAAa,MAAM;IAAnB;QAeE;;;;mBAAM,IAAI,kBAAQ,EAAE;WAAA;IAmCtB,CAAC;IAjDC,kBAAkB;IAClB,IAAI,KAAK;QACP,MAAM,IAAI,KAAK,CACb,iEAAiE,CAClE,CAAA;IACH,CAAC;IAED,kBAAkB;IAClB,IAAI,KAAK,CAAC,CAAQ;QAChB,MAAM,IAAI,KAAK,CACb,iEAAiE,CAClE,CAAA;IACH,CAAC;IAID,eAAe;IACf,EAAE;IAEF,KAAK,CAAC,IAAI,CACR,UAAwB,EACxB,UAAkB,EAClB,MAAoB,EACpB,IAAsB,EACtB,IAAkB;QAElB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,CAAA;IACtE,CAAC;IAED,OAAO,CAAC,UAAwB;QAC9B,OAAO,IAAI,aAAa,CAAC,IAAI,EAAE,UAAU,CAAC,CAAA;IAC5C,CAAC;IAED,UAAU;IACV,IAAI;IAEJ,UAAU,CAAC,GAAe;QACxB,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;IACnB,CAAC;IAED,WAAW,CAAC,IAAkB;QAC5B,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACvB,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAA;QACtB,CAAC;IACH,CAAC;IAED,aAAa,CAAC,GAAW;QACvB,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;IACtB,CAAC;CACF;AAlDD,wBAkDC;AAED,iDAAiD;AACjD,MAAa,aAAc,SAAQ,wBAAU;IAI3C,YACS,UAAkB,EACzB,UAAwB;QAExB,KAAK,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;YAC1B,MAAM,OAAO,GAAG,IAAA,qBAAc,EAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAA;YAC1E,OAAO,KAAK,CAAC,IAAI,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,CAAC,CAAA;QAC9D,CAAC,EAAE,UAAU,CAAC,GAAG,CAAC,CAAA;QANlB;;;;mBAAO,UAAU;WAAQ;QAJ3B;;;;;WAAQ;QACR;;;;mBAAkC,EAAE;WAAA;QAUlC,IAAI,CAAC,GAAG,GAAG,OAAO,UAAU,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAA;IAC9E,CAAC;IAED,SAAS,CAAC,GAAW,EAAE,KAAa;QAClC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;IAC3B,CAAC;IAED,WAAW,CAAC,GAAW;QACrB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;IAC1B,CAAC;CACF;AAtBD,sCAsBC"}

package/dist/fetch-handler.d.ts

@@ -0,0 +1,33 @@
+import { Gettable } from './types';
+export type FetchHandler = (this: void, 
+/**
+ * The URL (pathname + query parameters) to make the request to, without the
+ * origin. The origin (protocol, hostname, and port) must be added by this
+ * {@link FetchHandler}, typically based on authentication or other factors.
+ */
+url: string, init: RequestInit) => Promise<Response>;
+export type FetchHandlerOptions = BuildFetchHandlerOptions | string | URL;
+export type BuildFetchHandlerOptions = {
+    /**
+     * The service URL to make requests to. This can be a string, URL, or a
+     * function that returns a string or URL. This is useful for dynamic URLs,
+     * such as a service URL that changes based on authentication.
+     */
+    service: Gettable<string | URL>;
+    /**
+     * Headers to be added to every request. If a function is provided, it will be
+     * called on each request to get the headers. This is useful for dynamic
+     * headers, such as authentication tokens that may expire.
+     */
+    headers?: {
+        [_ in string]?: Gettable<null | string>;
+    };
+    /**
+     * Bring your own fetch implementation. Typically useful for testing, logging,
+     * mocking, or adding retries, session management, signatures, proof of
+     * possession (DPoP), etc. Defaults to the global `fetch` function.
+     */
+    fetch?: typeof globalThis.fetch;
+};
+export declare function buildFetchHandler(options: FetchHandler | FetchHandlerOptions): FetchHandler;
+//# sourceMappingURL=fetch-handler.d.ts.map

package/dist/fetch-handler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetch-handler.d.ts","sourceRoot":"","sources":["../src/fetch-handler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAA;AAGlC,MAAM,MAAM,YAAY,GAAG,CACzB,IAAI,EAAE,IAAI;AACV;;;;GAIG;AACH,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,WAAW,KACd,OAAO,CAAC,QAAQ,CAAC,CAAA;AAEtB,MAAM,MAAM,mBAAmB,GAAG,wBAAwB,GAAG,MAAM,GAAG,GAAG,CAAA;AAEzE,MAAM,MAAM,wBAAwB,GAAG;IACrC;;;;OAIG;IACH,OAAO,EAAE,QAAQ,CAAC,MAAM,GAAG,GAAG,CAAC,CAAA;IAE/B;;;;OAIG;IACH,OAAO,CAAC,EAAE;SACP,CAAC,IAAI,MAAM,CAAC,CAAC,EAAE,QAAQ,CAAC,IAAI,GAAG,MAAM,CAAC;KACxC,CAAA;IAED;;;;OAIG;IACH,KAAK,CAAC,EAAE,OAAO,UAAU,CAAC,KAAK,CAAA;CAChC,CAAA;AAED,wBAAgB,iBAAiB,CAC/B,OAAO,EAAE,YAAY,GAAG,mBAAmB,GAC1C,YAAY,CA6Bd"}

package/dist/fetch-handler.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildFetchHandler = void 0;
+const util_1 = require("./util");
+function buildFetchHandler(options) {
+    // Already a fetch handler (allowed for convenience)
+    if (typeof options === 'function')
+        return options;
+    const { service, headers: defaultHeaders = undefined, fetch = globalThis.fetch, } = typeof options === 'string' || options instanceof URL
+        ? { service: options }
+        : options;
+    if (typeof fetch !== 'function') {
+        throw new TypeError('XrpcDispatcher requires fetch() to be available in your environment.');
+    }
+    const defaultHeadersEntries = defaultHeaders != null ? Object.entries(defaultHeaders) : undefined;
+    return async function (url, init) {
+        const base = typeof service === 'function' ? service() : service;
+        const fullUrl = new URL(url, base);
+        const headers = (0, util_1.combineHeaders)(init.headers, defaultHeadersEntries);
+        return fetch(fullUrl, { ...init, headers });
+    };
+}
+exports.buildFetchHandler = buildFetchHandler;
+//# sourceMappingURL=fetch-handler.js.map

package/dist/fetch-handler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetch-handler.js","sourceRoot":"","sources":["../src/fetch-handler.ts"],"names":[],"mappings":";;;AACA,iCAAuC;AAwCvC,SAAgB,iBAAiB,CAC/B,OAA2C;IAE3C,oDAAoD;IACpD,IAAI,OAAO,OAAO,KAAK,UAAU;QAAE,OAAO,OAAO,CAAA;IAEjD,MAAM,EACJ,OAAO,EACP,OAAO,EAAE,cAAc,GAAG,SAAS,EACnC,KAAK,GAAG,UAAU,CAAC,KAAK,GACzB,GAAG,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,YAAY,GAAG;QACvD,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE;QACtB,CAAC,CAAC,OAAO,CAAA;IAEX,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE,CAAC;QAChC,MAAM,IAAI,SAAS,CACjB,sEAAsE,CACvE,CAAA;IACH,CAAC;IAED,MAAM,qBAAqB,GACzB,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IAErE,OAAO,KAAK,WAAW,GAAG,EAAE,IAAI;QAC9B,MAAM,IAAI,GAAG,OAAO,OAAO,KAAK,UAAU,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,OAAO,CAAA;QAChE,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAA;QAElC,MAAM,OAAO,GAAG,IAAA,qBAAc,EAAC,IAAI,CAAC,OAAO,EAAE,qBAAqB,CAAC,CAAA;QAEnE,OAAO,KAAK,CAAC,OAAO,EAAE,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,CAAC,CAAA;IAC7C,CAAC,CAAA;AACH,CAAC;AA/BD,8CA+BC"}

package/dist/index.d.ts

@@ -1,5 +1,10 @@
-export * from './types';
 export * from './client';
+export * from './fetch-handler';
+export * from './types';
+export * from './util';
+export * from './xrpc-client';
 import { Client } from './client';
+/** @deprecated create a local {@link XrpcClient} instance instead */
 declare const defaultInst: Client;
 export default defaultInst;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,iBAAiB,CAAA;AAC/B,cAAc,SAAS,CAAA;AACvB,cAAc,QAAQ,CAAA;AACtB,cAAc,eAAe,CAAA;AAE7B,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AACjC,qEAAqE;AACrE,QAAA,MAAM,WAAW,QAAe,CAAA;AAChC,eAAe,WAAW,CAAA"}