@atproto/lex-client 0.0.4 → 0.0.5

package/dist/lexicons/com/atproto/sync/getBlob.defs.js

@@ -0,0 +1,27 @@
+"use strict";
+/*
+ * THIS FILE WAS GENERATED BY "@atproto/lex". DO NOT EDIT.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.$output = exports.$params = exports.$lxm = exports.main = exports.$nsid = void 0;
+const lex_schema_1 = require("@atproto/lex-schema");
+const $nsid = 'com.atproto.sync.getBlob';
+exports.$nsid = $nsid;
+/** Get a blob associated with a given account. Returns the full blob as originally uploaded. Does not require auth; implemented by PDS. */
+const main = 
+/*#__PURE__*/
+lex_schema_1.l.query($nsid, 
+/*#__PURE__*/ lex_schema_1.l.params({
+    did: /*#__PURE__*/ lex_schema_1.l.string({ format: 'did' }),
+    cid: /*#__PURE__*/ lex_schema_1.l.string({ format: 'cid' }),
+}), 
+/*#__PURE__*/ lex_schema_1.l.payload('*/*'), [
+    'BlobNotFound',
+    'RepoNotFound',
+    'RepoTakendown',
+    'RepoSuspended',
+    'RepoDeactivated',
+]);
+exports.main = main;
+exports.$lxm = main.nsid, exports.$params = main.parameters, exports.$output = main.output;
+//# sourceMappingURL=getBlob.defs.js.map

package/dist/lexicons/com/atproto/sync/getBlob.defs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getBlob.defs.js","sourceRoot":"","sources":["../../../../../src/lexicons/com/atproto/sync/getBlob.defs.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,oDAAuC;AAEvC,MAAM,KAAK,GAAG,0BAA0B,CAAA;AAE/B,sBAAK;AAEd,2IAA2I;AAC3I,MAAM,IAAI;AACR,aAAa;AACb,cAAC,CAAC,KAAK,CACL,KAAK;AACL,aAAa,CAAC,cAAC,CAAC,MAAM,CAAC;IACrB,GAAG,EAAE,aAAa,CAAC,cAAC,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;IAC9C,GAAG,EAAE,aAAa,CAAC,cAAC,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;CAC/C,CAAC;AACF,aAAa,CAAC,cAAC,CAAC,OAAO,CAAC,KAAK,CAAC,EAC9B;IACE,cAAc;IACd,cAAc;IACd,eAAe;IACf,eAAe;IACf,iBAAiB;CAClB,CACF,CAAA;AACM,oBAAI;AAMA,QAAA,IAAI,GAAiB,IAAI,CAAC,IAAI,EACzC,QAAA,OAAO,GAAG,IAAI,CAAC,UAAU,EACzB,QAAA,OAAO,GAAG,IAAI,CAAC,MAAM,CAAA","sourcesContent":["/*\n * THIS FILE WAS GENERATED BY \"@atproto/lex\". DO NOT EDIT.\n */\n\nimport { l } from '@atproto/lex-schema'\n\nconst $nsid = 'com.atproto.sync.getBlob'\n\nexport { $nsid }\n\n/** Get a blob associated with a given account. Returns the full blob as originally uploaded. Does not require auth; implemented by PDS. */\nconst main =\n  /*#__PURE__*/\n  l.query(\n    $nsid,\n    /*#__PURE__*/ l.params({\n      did: /*#__PURE__*/ l.string({ format: 'did' }),\n      cid: /*#__PURE__*/ l.string({ format: 'cid' }),\n    }),\n    /*#__PURE__*/ l.payload('*/*'),\n    [\n      'BlobNotFound',\n      'RepoNotFound',\n      'RepoTakendown',\n      'RepoSuspended',\n      'RepoDeactivated',\n    ],\n  )\nexport { main }\n\nexport type Params = l.InferMethodParams<typeof main>\nexport type Output = l.InferMethodOutput<typeof main>\nexport type OutputBody = l.InferMethodOutputBody<typeof main>\n\nexport const $lxm = /*#__PURE__*/ main.nsid,\n  $params = main.parameters,\n  $output = main.output\n"]}

package/dist/lexicons/com/atproto/sync/getBlob.js

@@ -0,0 +1,10 @@
+"use strict";
+/*
+ * THIS FILE WAS GENERATED BY "@atproto/lex". DO NOT EDIT.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.$defs = void 0;
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./getBlob.defs.js"), exports);
+exports.$defs = tslib_1.__importStar(require("./getBlob.defs.js"));
+//# sourceMappingURL=getBlob.js.map

package/dist/lexicons/com/atproto/sync/getBlob.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getBlob.js","sourceRoot":"","sources":["../../../../../src/lexicons/com/atproto/sync/getBlob.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;AAEH,4DAAiC;AACjC,mEAA0C","sourcesContent":["/*\n * THIS FILE WAS GENERATED BY \"@atproto/lex\". DO NOT EDIT.\n */\n\nexport * from './getBlob.defs.js'\nexport * as $defs from './getBlob.defs.js'\n"]}

package/dist/lexicons/com/atproto/sync.d.ts

@@ -0,0 +1,2 @@
+export * as getBlob from './sync/getBlob.js';
+//# sourceMappingURL=sync.d.ts.map

package/dist/lexicons/com/atproto/sync.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sync.d.ts","sourceRoot":"","sources":["../../../../src/lexicons/com/atproto/sync.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,OAAO,MAAM,mBAAmB,CAAA"}

package/dist/lexicons/com/atproto/sync.js

@@ -0,0 +1,9 @@
+"use strict";
+/*
+ * THIS FILE WAS GENERATED BY "@atproto/lex". DO NOT EDIT.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getBlob = void 0;
+const tslib_1 = require("tslib");
+exports.getBlob = tslib_1.__importStar(require("./sync/getBlob.js"));
+//# sourceMappingURL=sync.js.map

package/dist/lexicons/com/atproto/sync.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sync.js","sourceRoot":"","sources":["../../../../src/lexicons/com/atproto/sync.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;AAEH,qEAA4C","sourcesContent":["/*\n * THIS FILE WAS GENERATED BY \"@atproto/lex\". DO NOT EDIT.\n */\n\nexport * as getBlob from './sync/getBlob.js'\n"]}

package/dist/lexicons/com/atproto.d.ts

@@ -1,2 +1,3 @@
 export * as repo from './atproto/repo.js';
+export * as sync from './atproto/sync.js';
 //# sourceMappingURL=atproto.d.ts.map

package/dist/lexicons/com/atproto.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"atproto.d.ts","sourceRoot":"","sources":["../../../src/lexicons/com/atproto.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,IAAI,MAAM,mBAAmB,CAAA"}
+{"version":3,"file":"atproto.d.ts","sourceRoot":"","sources":["../../../src/lexicons/com/atproto.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,IAAI,MAAM,mBAAmB,CAAA;AACzC,OAAO,KAAK,IAAI,MAAM,mBAAmB,CAAA"}

package/dist/lexicons/com/atproto.js

@@ -3,7 +3,8 @@
  * THIS FILE WAS GENERATED BY "@atproto/lex". DO NOT EDIT.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.repo = void 0;
+exports.sync = exports.repo = void 0;
 const tslib_1 = require("tslib");
 exports.repo = tslib_1.__importStar(require("./atproto/repo.js"));
+exports.sync = tslib_1.__importStar(require("./atproto/sync.js"));
 //# sourceMappingURL=atproto.js.map

package/dist/lexicons/com/atproto.js.map

@@ -1 +1 @@
-{"version":3,"file":"atproto.js","sourceRoot":"","sources":["../../../src/lexicons/com/atproto.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;AAEH,kEAAyC","sourcesContent":["/*\n * THIS FILE WAS GENERATED BY \"@atproto/lex\". DO NOT EDIT.\n */\n\nexport * as repo from './atproto/repo.js'\n"]}
+{"version":3,"file":"atproto.js","sourceRoot":"","sources":["../../../src/lexicons/com/atproto.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;AAEH,kEAAyC;AACzC,kEAAyC","sourcesContent":["/*\n * THIS FILE WAS GENERATED BY \"@atproto/lex\". DO NOT EDIT.\n */\n\nexport * as repo from './atproto/repo.js'\nexport * as sync from './atproto/sync.js'\n"]}

package/dist/lexicons.d.ts

@@ -0,0 +1,2 @@
+export * as com from './lexicons/com.js';
+//# sourceMappingURL=lexicons.d.ts.map

package/dist/lexicons.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lexicons.d.ts","sourceRoot":"","sources":["../src/lexicons.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,GAAG,MAAM,mBAAmB,CAAA"}

package/dist/lexicons.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.com = void 0;
+const tslib_1 = require("tslib");
+exports.com = tslib_1.__importStar(require("./lexicons/com.js"));
+//# sourceMappingURL=lexicons.js.map

package/dist/lexicons.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lexicons.js","sourceRoot":"","sources":["../src/lexicons.ts"],"names":[],"mappings":";;;;AAAA,iEAAwC","sourcesContent":["export * as com from './lexicons/com.js'\n"]}

package/dist/types.d.ts

@@ -7,9 +7,27 @@ export type CallOptions = {
     signal?: AbortSignal;
     headers?: HeadersInit;
     service?: Service;
+    /**
+     * Whether to validate the request against the method's input schema. Enabling
+     * this can help catch errors early but may have a performance cost. This
+     * would typically only be set to `true` in development or debugging
+     * scenarios.
+     *
+     * @default false
+     */
     validateRequest?: boolean;
+    /**
+     * Whether to validate the response against the method's output schema.
+     * Disabling this can improve performance but may lead to runtime errors if
+     * the response does not conform to the expected schema. Only set this to
+     * `false` if you are certain that the upstream service will always return
+     * valid responses.
+     *
+     * @default true
+     */
     validateResponse?: boolean;
 };
+export type BinaryBodyInit = Uint8Array | ArrayBuffer | Blob | ReadableStream<Uint8Array> | AsyncIterable<Uint8Array> | string;
 export type Namespace<T> = T | {
     main: T;
 };

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAE9D,YAAY,EAAE,SAAS,EAAE,aAAa,EAAE,CAAA;AAExC,MAAM,MAAM,oBAAoB,GAAG,iBAAiB,GAAG,aAAa,CAAA;AACpE,MAAM,MAAM,OAAO,GAAG,GAAG,SAAS,IAAI,oBAAoB,EAAE,CAAA;AAE5D,MAAM,MAAM,WAAW,GAAG;IACxB,QAAQ,CAAC,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAA;IAC9B,MAAM,CAAC,EAAE,WAAW,CAAA;IACpB,OAAO,CAAC,EAAE,WAAW,CAAA;IACrB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,gBAAgB,CAAC,EAAE,OAAO,CAAA;CAC3B,CAAA;AAED,MAAM,MAAM,SAAS,CAAC,CAAC,IAAI,CAAC,GAAG;IAAE,IAAI,EAAE,CAAC,CAAA;CAAE,CAAA;AAE1C,wBAAgB,OAAO,CAAC,CAAC,SAAS,MAAM,EAAE,EAAE,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAE7D"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAE9D,YAAY,EAAE,SAAS,EAAE,aAAa,EAAE,CAAA;AAExC,MAAM,MAAM,oBAAoB,GAAG,iBAAiB,GAAG,aAAa,CAAA;AACpE,MAAM,MAAM,OAAO,GAAG,GAAG,SAAS,IAAI,oBAAoB,EAAE,CAAA;AAE5D,MAAM,MAAM,WAAW,GAAG;IACxB,QAAQ,CAAC,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAA;IAC9B,MAAM,CAAC,EAAE,WAAW,CAAA;IACpB,OAAO,CAAC,EAAE,WAAW,CAAA;IACrB,OAAO,CAAC,EAAE,OAAO,CAAA;IAEjB;;;;;;;OAOG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;IAEzB;;;;;;;;OAQG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAA;CAC3B,CAAA;AAED,MAAM,MAAM,cAAc,GACtB,UAAU,GACV,WAAW,GACX,IAAI,GACJ,cAAc,CAAC,UAAU,CAAC,GAC1B,aAAa,CAAC,UAAU,CAAC,GACzB,MAAM,CAAA;AAEV,MAAM,MAAM,SAAS,CAAC,CAAC,IAAI,CAAC,GAAG;IAAE,IAAI,EAAE,CAAC,CAAA;CAAE,CAAA;AAE1C,wBAAgB,OAAO,CAAC,CAAC,SAAS,MAAM,EAAE,EAAE,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAE7D"}

package/dist/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;AAkBA,0BAEC;AAFD,SAAgB,OAAO,CAAmB,EAAgB;IACxD,OAAO,MAAM,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAA;AACpC,CAAC","sourcesContent":["import { DidString, UnknownString } from '@atproto/lex-schema'\n\nexport type { DidString, UnknownString }\n\nexport type DidServiceIdentifier = 'atproto_labeler' | UnknownString\nexport type Service = `${DidString}#${DidServiceIdentifier}`\n\nexport type CallOptions = {\n  labelers?: Iterable<DidString>\n  signal?: AbortSignal\n  headers?: HeadersInit\n  service?: Service\n  validateRequest?: boolean\n  validateResponse?: boolean\n}\n\nexport type Namespace<T> = T | { main: T }\n\nexport function getMain<T extends object>(ns: Namespace<T>): T {\n  return 'main' in ns ? ns.main : ns\n}\n"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;AA6CA,0BAEC;AAFD,SAAgB,OAAO,CAAmB,EAAgB;IACxD,OAAO,MAAM,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAA;AACpC,CAAC","sourcesContent":["import { DidString, UnknownString } from '@atproto/lex-schema'\n\nexport type { DidString, UnknownString }\n\nexport type DidServiceIdentifier = 'atproto_labeler' | UnknownString\nexport type Service = `${DidString}#${DidServiceIdentifier}`\n\nexport type CallOptions = {\n  labelers?: Iterable<DidString>\n  signal?: AbortSignal\n  headers?: HeadersInit\n  service?: Service\n\n  /**\n   * Whether to validate the request against the method's input schema. Enabling\n   * this can help catch errors early but may have a performance cost. This\n   * would typically only be set to `true` in development or debugging\n   * scenarios.\n   *\n   * @default false\n   */\n  validateRequest?: boolean\n\n  /**\n   * Whether to validate the response against the method's output schema.\n   * Disabling this can improve performance but may lead to runtime errors if\n   * the response does not conform to the expected schema. Only set this to\n   * `false` if you are certain that the upstream service will always return\n   * valid responses.\n   *\n   * @default true\n   */\n  validateResponse?: boolean\n}\n\nexport type BinaryBodyInit =\n  | Uint8Array\n  | ArrayBuffer\n  | Blob\n  | ReadableStream<Uint8Array>\n  | AsyncIterable<Uint8Array>\n  | string\n\nexport type Namespace<T> = T | { main: T }\n\nexport function getMain<T extends object>(ns: Namespace<T>): T {\n  return 'main' in ns ? ns.main : ns\n}\n"]}

package/dist/util.d.ts

@@ -0,0 +1,14 @@
+import { DidString } from '@atproto/lex-schema';
+export type Payload<B = unknown, E extends string = string> = {
+    body: B;
+    encoding: E;
+};
+export declare function isBlobLike(value: unknown): value is Blob;
+export declare function isAsyncIterable<T>(value: T): value is unknown extends T ? T & AsyncIterable<unknown> : Extract<T, AsyncIterable<any>>;
+export declare function buildAtprotoHeaders(options: {
+    headers?: HeadersInit;
+    service?: `${DidString}#${string}`;
+    labelers?: Iterable<DidString>;
+}): Headers;
+export declare function toReadableStream(data: AsyncIterable<Uint8Array>): ReadableStream<Uint8Array>;
+//# sourceMappingURL=util.d.ts.map

package/dist/util.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AAE/C,MAAM,MAAM,OAAO,CAAC,CAAC,GAAG,OAAO,EAAE,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI;IAC5D,IAAI,EAAE,CAAC,CAAA;IACP,QAAQ,EAAE,CAAC,CAAA;CACZ,CAAA;AAED,wBAAgB,UAAU,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,IAAI,CAexD;AAED,wBAAgB,eAAe,CAAC,CAAC,EAC/B,KAAK,EAAE,CAAC,GACP,KAAK,IAAI,OAAO,SAAS,CAAC,GACzB,CAAC,GAAG,aAAa,CAAC,OAAO,CAAC,GAC1B,OAAO,CAAC,CAAC,EAAE,aAAa,CAAC,GAAG,CAAC,CAAC,CAIjC;AAED,wBAAgB,mBAAmB,CAAC,OAAO,EAAE;IAC3C,OAAO,CAAC,EAAE,WAAW,CAAA;IACrB,OAAO,CAAC,EAAE,GAAG,SAAS,IAAI,MAAM,EAAE,CAAA;IAClC,QAAQ,CAAC,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAA;CAC/B,GAAG,OAAO,CAiBV;AAED,wBAAgB,gBAAgB,CAC9B,IAAI,EAAE,aAAa,CAAC,UAAU,CAAC,GAC9B,cAAc,CAAC,UAAU,CAAC,CAwB5B"}

package/dist/util.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isBlobLike = isBlobLike;
+exports.isAsyncIterable = isAsyncIterable;
+exports.buildAtprotoHeaders = buildAtprotoHeaders;
+exports.toReadableStream = toReadableStream;
+function isBlobLike(value) {
+    if (value == null)
+        return false;
+    if (typeof value !== 'object')
+        return false;
+    if (typeof Blob === 'function' && value instanceof Blob)
+        return true;
+    // Support for Blobs provided by libraries that don't use the native Blob
+    // (e.g. fetch-blob from node-fetch).
+    // https://github.com/node-fetch/fetch-blob/blob/a1a182e5978811407bef4ea1632b517567dda01f/index.js#L233-L244
+    const tag = value[Symbol.toStringTag];
+    if (tag === 'Blob' || tag === 'File') {
+        return 'stream' in value && typeof value.stream === 'function';
+    }
+    return false;
+}
+function isAsyncIterable(value) {
+    return (value != null && typeof value[Symbol.asyncIterator] === 'function');
+}
+function buildAtprotoHeaders(options) {
+    const headers = new Headers(options?.headers);
+    if (options.service && !headers.has('atproto-proxy')) {
+        headers.set('atproto-proxy', options.service);
+    }
+    if (options.labelers) {
+        headers.set('atproto-accept-labelers', [...options.labelers, headers.get('atproto-accept-labelers')?.trim()]
+            .filter(Boolean)
+            .join(', '));
+    }
+    return headers;
+}
+function toReadableStream(data) {
+    // Use the native ReadableStream.from() if available.
+    if ('from' in ReadableStream && typeof ReadableStream.from === 'function') {
+        return ReadableStream.from(data);
+    }
+    let iterator;
+    return new ReadableStream({
+        async pull(controller) {
+            try {
+                iterator ??= data[Symbol.asyncIterator]();
+                const result = await iterator.next();
+                if (result.done)
+                    controller.close();
+                else
+                    controller.enqueue(result.value);
+            }
+            catch (err) {
+                controller.error(err);
+                iterator = undefined;
+            }
+        },
+        async cancel() {
+            await iterator?.return?.();
+            iterator = undefined;
+        },
+    });
+}
+//# sourceMappingURL=util.js.map

package/dist/util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.js","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":";;AAOA,gCAeC;AAED,0CAQC;AAED,kDAqBC;AAED,4CA0BC;AA5ED,SAAgB,UAAU,CAAC,KAAc;IACvC,IAAI,KAAK,IAAI,IAAI;QAAE,OAAO,KAAK,CAAA;IAC/B,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAA;IAC3C,IAAI,OAAO,IAAI,KAAK,UAAU,IAAI,KAAK,YAAY,IAAI;QAAE,OAAO,IAAI,CAAA;IAEpE,yEAAyE;IACzE,qCAAqC;IACrC,4GAA4G;IAE5G,MAAM,GAAG,GAAI,KAAa,CAAC,MAAM,CAAC,WAAW,CAAC,CAAA;IAC9C,IAAI,GAAG,KAAK,MAAM,IAAI,GAAG,KAAK,MAAM,EAAE,CAAC;QACrC,OAAO,QAAQ,IAAI,KAAK,IAAI,OAAO,KAAK,CAAC,MAAM,KAAK,UAAU,CAAA;IAChE,CAAC;IAED,OAAO,KAAK,CAAA;AACd,CAAC;AAED,SAAgB,eAAe,CAC7B,KAAQ;IAIR,OAAO,CACL,KAAK,IAAI,IAAI,IAAI,OAAQ,KAAa,CAAC,MAAM,CAAC,aAAa,CAAC,KAAK,UAAU,CAC5E,CAAA;AACH,CAAC;AAED,SAAgB,mBAAmB,CAAC,OAInC;IACC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;IAE7C,IAAI,OAAO,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,EAAE,CAAC;QACrD,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,OAAO,CAAC,OAAO,CAAC,CAAA;IAC/C,CAAC;IAED,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;QACrB,OAAO,CAAC,GAAG,CACT,yBAAyB,EACzB,CAAC,GAAG,OAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,yBAAyB,CAAC,EAAE,IAAI,EAAE,CAAC;aAClE,MAAM,CAAC,OAAO,CAAC;aACf,IAAI,CAAC,IAAI,CAAC,CACd,CAAA;IACH,CAAC;IAED,OAAO,OAAO,CAAA;AAChB,CAAC;AAED,SAAgB,gBAAgB,CAC9B,IAA+B;IAE/B,qDAAqD;IACrD,IAAI,MAAM,IAAI,cAAc,IAAI,OAAO,cAAc,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;QAC1E,OAAO,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IAClC,CAAC;IAED,IAAI,QAA+C,CAAA;IACnD,OAAO,IAAI,cAAc,CAAC;QACxB,KAAK,CAAC,IAAI,CAAC,UAAU;YACnB,IAAI,CAAC;gBACH,QAAQ,KAAK,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,CAAA;gBACzC,MAAM,MAAM,GAAG,MAAM,QAAS,CAAC,IAAI,EAAE,CAAA;gBACrC,IAAI,MAAM,CAAC,IAAI;oBAAE,UAAU,CAAC,KAAK,EAAE,CAAA;;oBAC9B,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;YACvC,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;gBACrB,QAAQ,GAAG,SAAS,CAAA;YACtB,CAAC;QACH,CAAC;QACD,KAAK,CAAC,MAAM;YACV,MAAM,QAAQ,EAAE,MAAM,EAAE,EAAE,CAAA;YAC1B,QAAQ,GAAG,SAAS,CAAA;QACtB,CAAC;KACF,CAAC,CAAA;AACJ,CAAC","sourcesContent":["import { DidString } from '@atproto/lex-schema'\n\nexport type Payload<B = unknown, E extends string = string> = {\n  body: B\n  encoding: E\n}\n\nexport function isBlobLike(value: unknown): value is Blob {\n  if (value == null) return false\n  if (typeof value !== 'object') return false\n  if (typeof Blob === 'function' && value instanceof Blob) return true\n\n  // Support for Blobs provided by libraries that don't use the native Blob\n  // (e.g. fetch-blob from node-fetch).\n  // https://github.com/node-fetch/fetch-blob/blob/a1a182e5978811407bef4ea1632b517567dda01f/index.js#L233-L244\n\n  const tag = (value as any)[Symbol.toStringTag]\n  if (tag === 'Blob' || tag === 'File') {\n    return 'stream' in value && typeof value.stream === 'function'\n  }\n\n  return false\n}\n\nexport function isAsyncIterable<T>(\n  value: T,\n): value is unknown extends T\n  ? T & AsyncIterable<unknown>\n  : Extract<T, AsyncIterable<any>> {\n  return (\n    value != null && typeof (value as any)[Symbol.asyncIterator] === 'function'\n  )\n}\n\nexport function buildAtprotoHeaders(options: {\n  headers?: HeadersInit\n  service?: `${DidString}#${string}`\n  labelers?: Iterable<DidString>\n}): Headers {\n  const headers = new Headers(options?.headers)\n\n  if (options.service && !headers.has('atproto-proxy')) {\n    headers.set('atproto-proxy', options.service)\n  }\n\n  if (options.labelers) {\n    headers.set(\n      'atproto-accept-labelers',\n      [...options.labelers, headers.get('atproto-accept-labelers')?.trim()]\n        .filter(Boolean)\n        .join(', '),\n    )\n  }\n\n  return headers\n}\n\nexport function toReadableStream(\n  data: AsyncIterable<Uint8Array>,\n): ReadableStream<Uint8Array> {\n  // Use the native ReadableStream.from() if available.\n  if ('from' in ReadableStream && typeof ReadableStream.from === 'function') {\n    return ReadableStream.from(data)\n  }\n\n  let iterator: AsyncIterator<Uint8Array> | undefined\n  return new ReadableStream({\n    async pull(controller) {\n      try {\n        iterator ??= data[Symbol.asyncIterator]()\n        const result = await iterator!.next()\n        if (result.done) controller.close()\n        else controller.enqueue(result.value)\n      } catch (err) {\n        controller.error(err)\n        iterator = undefined\n      }\n    },\n    async cancel() {\n      await iterator?.return?.()\n      iterator = undefined\n    },\n  })\n}\n"]}

package/dist/xrpc-error.d.ts

@@ -0,0 +1,87 @@
+import { l } from '@atproto/lex-schema';
+import { Payload } from './util.js';
+export type XrpcErrorCode = string;
+export declare const xrpcErrorCodeSchema: l.Schema<XrpcErrorCode>;
+export declare class XrpcError<N extends XrpcErrorCode = XrpcErrorCode> extends Error {
+    readonly error: N;
+    name: string;
+    constructor(error: N, message?: string, options?: ErrorOptions);
+}
+export type XrpcErrorBody<N extends XrpcErrorCode = XrpcErrorCode> = {
+    error: N;
+    message?: string;
+};
+export type XrpcErrorPayload<N extends XrpcErrorCode = XrpcErrorCode> = {
+    encoding: 'application/json';
+    body: XrpcErrorBody<N>;
+};
+/**
+ * All unsuccessful responses should follow a standard error response
+ * schema. The Content-Type should be application/json, and the payload
+ * should be a JSON object with the following fields:
+ *
+ * - `error` (string, required): type name of the error (generic ASCII
+ *   constant, no whitespace)
+ * - `message` (string, optional): description of the error, appropriate for
+ *   display to humans
+ *
+ * This function checks whether a given payload matches this schema.
+ */
+export declare function isXrpcErrorPayload(payload: Payload | null): payload is XrpcErrorPayload;
+/**
+ * Interface representing a failed XRPC request result.
+ */
+type XrpcFailureResult<N extends XrpcErrorCode, E> = l.ResultFailure<E> & {
+    readonly error: N;
+    shouldRetry(): boolean;
+    matchesSchema(): boolean;
+};
+/**
+ * Class used to represent an HTTP request that resulted in an XRPC method error
+ * That is, a non-2xx response with a valid XRPC error payload.
+ */
+export declare class XrpcResponseError<M extends l.Procedure | l.Query = l.Procedure | l.Query, N extends XrpcErrorCode = XrpcErrorCode> extends XrpcError<N> implements XrpcFailureResult<N, XrpcResponseError<M, N>> {
+    readonly method: M;
+    readonly status: number;
+    readonly headers: Headers;
+    readonly payload: XrpcErrorPayload<N>;
+    name: "XrpcResponseError";
+    constructor(method: M, status: number, headers: Headers, payload: XrpcErrorPayload<N>, options?: ErrorOptions);
+    readonly success = false;
+    get reason(): this;
+    get body(): XrpcErrorBody;
+    matchesSchema(): this is M extends {
+        errors: readonly (infer E extends string)[];
+    } ? XrpcResponseError<M, E> : never;
+    shouldRetry(): boolean;
+}
+/**
+ * This class represents an invalid XRPC response from the server.
+ */
+export declare class XrpcInvalidResponseError extends XrpcError<'UpstreamFailure'> implements XrpcFailureResult<'UpstreamFailure', XrpcInvalidResponseError> {
+    name: "XrpcInvalidResponseError";
+    readonly response: {
+        status: number;
+        headers: Headers;
+        payload: Payload | null;
+    };
+    constructor(message: string, response: {
+        status: number;
+        headers: Headers;
+    }, payload: Payload | null, options?: ErrorOptions);
+    readonly success: false;
+    get reason(): this;
+    matchesSchema(): false;
+    shouldRetry(): boolean;
+}
+export declare class XrpcUnexpectedError extends XrpcError<'InternalServerError'> implements XrpcFailureResult<'InternalServerError', unknown> {
+    name: "XrpcUnexpectedError";
+    protected constructor(message: string, options: Required<ErrorOptions>);
+    readonly success = false;
+    get reason(): unknown;
+    matchesSchema(): false;
+    shouldRetry(): boolean;
+    static from(cause: unknown, message?: string): XrpcUnexpectedError;
+}
+export {};
+//# sourceMappingURL=xrpc-error.d.ts.map

package/dist/xrpc-error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"xrpc-error.d.ts","sourceRoot":"","sources":["../src/xrpc-error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,qBAAqB,CAAA;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AAEnC,MAAM,MAAM,aAAa,GAAG,MAAM,CAAA;AAClC,eAAO,MAAM,mBAAmB,EAAE,CAAC,CAAC,MAAM,CAAC,aAAa,CAEtD,CAAA;AAEF,qBAAa,SAAS,CAAC,CAAC,SAAS,aAAa,GAAG,aAAa,CAAE,SAAQ,KAAK;IAIzE,QAAQ,CAAC,KAAK,EAAE,CAAC;IAHnB,IAAI,SAAc;gBAGP,KAAK,EAAE,CAAC,EACjB,OAAO,GAAE,MAA2C,EACpD,OAAO,CAAC,EAAE,YAAY;CAIzB;AAED,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,aAAa,GAAG,aAAa,IAAI;IACnE,KAAK,EAAE,CAAC,CAAA;IACR,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,CAAA;AACD,MAAM,MAAM,gBAAgB,CAAC,CAAC,SAAS,aAAa,GAAG,aAAa,IAAI;IACtE,QAAQ,EAAE,kBAAkB,CAAA;IAC5B,IAAI,EAAE,aAAa,CAAC,CAAC,CAAC,CAAA;CACvB,CAAA;AAOD;;;;;;;;;;;GAWG;AACH,wBAAgB,kBAAkB,CAChC,OAAO,EAAE,OAAO,GAAG,IAAI,GACtB,OAAO,IAAI,gBAAgB,CAM7B;AAED;;GAEG;AACH,KAAK,iBAAiB,CAAC,CAAC,SAAS,aAAa,EAAE,CAAC,IAAI,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,GAAG;IACxE,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAA;IACjB,WAAW,IAAI,OAAO,CAAA;IACtB,aAAa,IAAI,OAAO,CAAA;CACzB,CAAA;AAED;;;GAGG;AACH,qBAAa,iBAAiB,CAC1B,CAAC,SAAS,CAAC,CAAC,SAAS,GAAG,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,SAAS,GAAG,CAAC,CAAC,KAAK,EACvD,CAAC,SAAS,aAAa,GAAG,aAAa,CAEzC,SAAQ,SAAS,CAAC,CAAC,CACnB,YAAW,iBAAiB,CAAC,CAAC,EAAE,iBAAiB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAKtD,QAAQ,CAAC,MAAM,EAAE,CAAC;IAClB,QAAQ,CAAC,MAAM,EAAE,MAAM;IACvB,QAAQ,CAAC,OAAO,EAAE,OAAO;IACzB,QAAQ,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC,CAAC;IANvC,IAAI,EAAG,mBAAmB,CAAS;gBAGxB,MAAM,EAAE,CAAC,EACT,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,gBAAgB,CAAC,CAAC,CAAC,EACrC,OAAO,CAAC,EAAE,YAAY;IAMxB,QAAQ,CAAC,OAAO,SAAQ;IAExB,IAAI,MAAM,IAAI,IAAI,CAEjB;IAED,IAAI,IAAI,IAAI,aAAa,CAExB;IAED,aAAa,IAAI,IAAI,IAAI,CAAC,SAAS;QACjC,MAAM,EAAE,SAAS,CAAC,MAAM,CAAC,SAAS,MAAM,CAAC,EAAE,CAAA;KAC5C,GACG,iBAAiB,CAAC,CAAC,EAAE,CAAC,CAAC,GACvB,KAAK;IAIT,WAAW,IAAI,OAAO;CAMvB;AAED;;GAEG;AACH,qBAAa,wBACX,SAAQ,SAAS,CAAC,iBAAiB,CACnC,YAAW,iBAAiB,CAAC,iBAAiB,EAAE,wBAAwB,CAAC;IAEzE,IAAI,EAAG,0BAA0B,CAAS;IAG1C,QAAQ,CAAC,QAAQ,EAAE;QACjB,MAAM,EAAE,MAAM,CAAA;QACd,OAAO,EAAE,OAAO,CAAA;QAChB,OAAO,EAAE,OAAO,GAAG,IAAI,CAAA;KACxB,CAAA;gBAGC,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,OAAO,CAAA;KAAE,EAC9C,OAAO,EAAE,OAAO,GAAG,IAAI,EACvB,OAAO,CAAC,EAAE,YAAY;IAUxB,QAAQ,CAAC,OAAO,EAAG,KAAK,CAAS;IAEjC,IAAI,MAAM,IAAI,IAAI,CAEjB;IAED,aAAa,IAAI,KAAK;IAItB,WAAW,IAAI,OAAO;CAIvB;AAED,qBAAa,mBACX,SAAQ,SAAS,CAAC,qBAAqB,CACvC,YAAW,iBAAiB,CAAC,qBAAqB,EAAE,OAAO,CAAC;IAE5D,IAAI,EAAG,qBAAqB,CAAS;IAErC,SAAS,aAAa,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,CAAC,YAAY,CAAC;IAItE,QAAQ,CAAC,OAAO,SAAQ;IAExB,IAAI,MAAM,YAET;IAED,aAAa,IAAI,KAAK;IAItB,WAAW,IAAI,OAAO;IAItB,MAAM,CAAC,IAAI,CACT,KAAK,EAAE,OAAO,EACd,OAAO,GAAE,MAEgB,GACxB,mBAAmB;CAIvB"}

package/dist/xrpc-error.js

@@ -0,0 +1,127 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.XrpcUnexpectedError = exports.XrpcInvalidResponseError = exports.XrpcResponseError = exports.XrpcError = exports.xrpcErrorCodeSchema = void 0;
+exports.isXrpcErrorPayload = isXrpcErrorPayload;
+const lex_schema_1 = require("@atproto/lex-schema");
+exports.xrpcErrorCodeSchema = lex_schema_1.l.string({
+    minLength: 1,
+});
+class XrpcError extends Error {
+    error;
+    name = 'XrpcError';
+    constructor(error, message = `An ${error} XRPC error occurred.`, options) {
+        super(message, options);
+        this.error = error;
+    }
+}
+exports.XrpcError = XrpcError;
+const xrpcErrorBodySchema = lex_schema_1.l.object({
+    error: exports.xrpcErrorCodeSchema,
+    message: lex_schema_1.l.optional(lex_schema_1.l.string()),
+});
+/**
+ * All unsuccessful responses should follow a standard error response
+ * schema. The Content-Type should be application/json, and the payload
+ * should be a JSON object with the following fields:
+ *
+ * - `error` (string, required): type name of the error (generic ASCII
+ *   constant, no whitespace)
+ * - `message` (string, optional): description of the error, appropriate for
+ *   display to humans
+ *
+ * This function checks whether a given payload matches this schema.
+ */
+function isXrpcErrorPayload(payload) {
+    return (payload !== null &&
+        payload.encoding === 'application/json' &&
+        xrpcErrorBodySchema.matches(payload.body));
+}
+/**
+ * Class used to represent an HTTP request that resulted in an XRPC method error
+ * That is, a non-2xx response with a valid XRPC error payload.
+ */
+class XrpcResponseError extends XrpcError {
+    method;
+    status;
+    headers;
+    payload;
+    name = 'XrpcResponseError';
+    constructor(method, status, headers, payload, options) {
+        const { error, message } = payload.body;
+        super(error, message, options);
+        this.method = method;
+        this.status = status;
+        this.headers = headers;
+        this.payload = payload;
+    }
+    success = false;
+    get reason() {
+        return this;
+    }
+    get body() {
+        return this.payload.body;
+    }
+    matchesSchema() {
+        return this.method.errors?.includes(this.error) ?? false;
+    }
+    shouldRetry() {
+        // Do not retry client errors
+        if (this.status < 500)
+            return false;
+        return true;
+    }
+}
+exports.XrpcResponseError = XrpcResponseError;
+/**
+ * This class represents an invalid XRPC response from the server.
+ */
+class XrpcInvalidResponseError extends XrpcError {
+    name = 'XrpcInvalidResponseError';
+    // For debugging purposes, we keep the response details here
+    response;
+    constructor(message, response, payload, options) {
+        super('UpstreamFailure', message, { cause: options?.cause });
+        this.response = {
+            status: response.status,
+            headers: response.headers,
+            payload,
+        };
+    }
+    success = false;
+    get reason() {
+        return this;
+    }
+    matchesSchema() {
+        return false;
+    }
+    shouldRetry() {
+        // Do not retry client errors
+        return this.response.status >= 500;
+    }
+}
+exports.XrpcInvalidResponseError = XrpcInvalidResponseError;
+class XrpcUnexpectedError extends XrpcError {
+    name = 'XrpcUnexpectedError';
+    constructor(message, options) {
+        super('InternalServerError', message, options);
+    }
+    success = false;
+    get reason() {
+        return this.cause;
+    }
+    matchesSchema() {
+        return false;
+    }
+    shouldRetry() {
+        return true;
+    }
+    static from(cause, message = cause instanceof XrpcError
+        ? cause.message
+        : 'XRPC request failed') {
+        if (cause instanceof XrpcUnexpectedError)
+            return cause;
+        return new XrpcUnexpectedError(message, { cause });
+    }
+}
+exports.XrpcUnexpectedError = XrpcUnexpectedError;
+//# sourceMappingURL=xrpc-error.js.map

package/dist/xrpc-error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"xrpc-error.js","sourceRoot":"","sources":["../src/xrpc-error.ts"],"names":[],"mappings":";;;AA8CA,gDAQC;AAtDD,oDAAuC;AAI1B,QAAA,mBAAmB,GAA4B,cAAC,CAAC,MAAM,CAAC;IACnE,SAAS,EAAE,CAAC;CACb,CAAC,CAAA;AAEF,MAAa,SAAmD,SAAQ,KAAK;IAIhE;IAHX,IAAI,GAAG,WAAW,CAAA;IAElB,YACW,KAAQ,EACjB,UAAkB,MAAM,KAAK,uBAAuB,EACpD,OAAsB;QAEtB,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;QAJd,UAAK,GAAL,KAAK,CAAG;IAKnB,CAAC;CACF;AAVD,8BAUC;AAWD,MAAM,mBAAmB,GAA4B,cAAC,CAAC,MAAM,CAAC;IAC5D,KAAK,EAAE,2BAAmB;IAC1B,OAAO,EAAE,cAAC,CAAC,QAAQ,CAAC,cAAC,CAAC,MAAM,EAAE,CAAC;CAChC,CAAC,CAAA;AAEF;;;;;;;;;;;GAWG;AACH,SAAgB,kBAAkB,CAChC,OAAuB;IAEvB,OAAO,CACL,OAAO,KAAK,IAAI;QAChB,OAAO,CAAC,QAAQ,KAAK,kBAAkB;QACvC,mBAAmB,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAC1C,CAAA;AACH,CAAC;AAWD;;;GAGG;AACH,MAAa,iBAIX,SAAQ,SAAY;IAMT;IACA;IACA;IACA;IANX,IAAI,GAAG,mBAA4B,CAAA;IAEnC,YACW,MAAS,EACT,MAAc,EACd,OAAgB,EAChB,OAA4B,EACrC,OAAsB;QAEtB,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,IAAI,CAAA;QACvC,KAAK,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAA;QAPrB,WAAM,GAAN,MAAM,CAAG;QACT,WAAM,GAAN,MAAM,CAAQ;QACd,YAAO,GAAP,OAAO,CAAS;QAChB,YAAO,GAAP,OAAO,CAAqB;IAKvC,CAAC;IAEQ,OAAO,GAAG,KAAK,CAAA;IAExB,IAAI,MAAM;QACR,OAAO,IAAY,CAAA;IACrB,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAA;IAC1B,CAAC;IAED,aAAa;QAKX,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,CAAA;IAC1D,CAAC;IAED,WAAW;QACT,6BAA6B;QAC7B,IAAI,IAAI,CAAC,MAAM,GAAG,GAAG;YAAE,OAAO,KAAK,CAAA;QAEnC,OAAO,IAAI,CAAA;IACb,CAAC;CACF;AA5CD,8CA4CC;AAED;;GAEG;AACH,MAAa,wBACX,SAAQ,SAA4B;IAGpC,IAAI,GAAG,0BAAmC,CAAA;IAE1C,4DAA4D;IACnD,QAAQ,CAIhB;IAED,YACE,OAAe,EACf,QAA8C,EAC9C,OAAuB,EACvB,OAAsB;QAEtB,KAAK,CAAC,iBAAiB,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAA;QAC5D,IAAI,CAAC,QAAQ,GAAG;YACd,MAAM,EAAE,QAAQ,CAAC,MAAM;YACvB,OAAO,EAAE,QAAQ,CAAC,OAAO;YACzB,OAAO;SACR,CAAA;IACH,CAAC;IAEQ,OAAO,GAAG,KAAc,CAAA;IAEjC,IAAI,MAAM;QACR,OAAO,IAAI,CAAA;IACb,CAAC;IAED,aAAa;QACX,OAAO,KAAK,CAAA;IACd,CAAC;IAED,WAAW;QACT,6BAA6B;QAC7B,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,IAAI,GAAG,CAAA;IACpC,CAAC;CACF;AAzCD,4DAyCC;AAED,MAAa,mBACX,SAAQ,SAAgC;IAGxC,IAAI,GAAG,qBAA8B,CAAA;IAErC,YAAsB,OAAe,EAAE,OAA+B;QACpE,KAAK,CAAC,qBAAqB,EAAE,OAAO,EAAE,OAAO,CAAC,CAAA;IAChD,CAAC;IAEQ,OAAO,GAAG,KAAK,CAAA;IAExB,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,KAAK,CAAA;IACnB,CAAC;IAED,aAAa;QACX,OAAO,KAAK,CAAA;IACd,CAAC;IAED,WAAW;QACT,OAAO,IAAI,CAAA;IACb,CAAC;IAED,MAAM,CAAC,IAAI,CACT,KAAc,EACd,UAAkB,KAAK,YAAY,SAAS;QAC1C,CAAC,CAAC,KAAK,CAAC,OAAO;QACf,CAAC,CAAC,qBAAqB;QAEzB,IAAI,KAAK,YAAY,mBAAmB;YAAE,OAAO,KAAK,CAAA;QACtD,OAAO,IAAI,mBAAmB,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,CAAA;IACpD,CAAC;CACF;AAjCD,kDAiCC","sourcesContent":["import { l } from '@atproto/lex-schema'\nimport { Payload } from './util.js'\n\nexport type XrpcErrorCode = string\nexport const xrpcErrorCodeSchema: l.Schema<XrpcErrorCode> = l.string({\n  minLength: 1,\n})\n\nexport class XrpcError<N extends XrpcErrorCode = XrpcErrorCode> extends Error {\n  name = 'XrpcError'\n\n  constructor(\n    readonly error: N,\n    message: string = `An ${error} XRPC error occurred.`,\n    options?: ErrorOptions,\n  ) {\n    super(message, options)\n  }\n}\n\nexport type XrpcErrorBody<N extends XrpcErrorCode = XrpcErrorCode> = {\n  error: N\n  message?: string\n}\nexport type XrpcErrorPayload<N extends XrpcErrorCode = XrpcErrorCode> = {\n  encoding: 'application/json'\n  body: XrpcErrorBody<N>\n}\n\nconst xrpcErrorBodySchema: l.Schema<XrpcErrorBody> = l.object({\n  error: xrpcErrorCodeSchema,\n  message: l.optional(l.string()),\n})\n\n/**\n * All unsuccessful responses should follow a standard error response\n * schema. The Content-Type should be application/json, and the payload\n * should be a JSON object with the following fields:\n *\n * - `error` (string, required): type name of the error (generic ASCII\n *   constant, no whitespace)\n * - `message` (string, optional): description of the error, appropriate for\n *   display to humans\n *\n * This function checks whether a given payload matches this schema.\n */\nexport function isXrpcErrorPayload(\n  payload: Payload | null,\n): payload is XrpcErrorPayload {\n  return (\n    payload !== null &&\n    payload.encoding === 'application/json' &&\n    xrpcErrorBodySchema.matches(payload.body)\n  )\n}\n\n/**\n * Interface representing a failed XRPC request result.\n */\ntype XrpcFailureResult<N extends XrpcErrorCode, E> = l.ResultFailure<E> & {\n  readonly error: N\n  shouldRetry(): boolean\n  matchesSchema(): boolean\n}\n\n/**\n * Class used to represent an HTTP request that resulted in an XRPC method error\n * That is, a non-2xx response with a valid XRPC error payload.\n */\nexport class XrpcResponseError<\n    M extends l.Procedure | l.Query = l.Procedure | l.Query,\n    N extends XrpcErrorCode = XrpcErrorCode,\n  >\n  extends XrpcError<N>\n  implements XrpcFailureResult<N, XrpcResponseError<M, N>>\n{\n  name = 'XrpcResponseError' as const\n\n  constructor(\n    readonly method: M,\n    readonly status: number,\n    readonly headers: Headers,\n    readonly payload: XrpcErrorPayload<N>,\n    options?: ErrorOptions,\n  ) {\n    const { error, message } = payload.body\n    super(error, message, options)\n  }\n\n  readonly success = false\n\n  get reason(): this {\n    return this as this\n  }\n\n  get body(): XrpcErrorBody {\n    return this.payload.body\n  }\n\n  matchesSchema(): this is M extends {\n    errors: readonly (infer E extends string)[]\n  }\n    ? XrpcResponseError<M, E>\n    : never {\n    return this.method.errors?.includes(this.error) ?? false\n  }\n\n  shouldRetry(): boolean {\n    // Do not retry client errors\n    if (this.status < 500) return false\n\n    return true\n  }\n}\n\n/**\n * This class represents an invalid XRPC response from the server.\n */\nexport class XrpcInvalidResponseError\n  extends XrpcError<'UpstreamFailure'>\n  implements XrpcFailureResult<'UpstreamFailure', XrpcInvalidResponseError>\n{\n  name = 'XrpcInvalidResponseError' as const\n\n  // For debugging purposes, we keep the response details here\n  readonly response: {\n    status: number\n    headers: Headers\n    payload: Payload | null\n  }\n\n  constructor(\n    message: string,\n    response: { status: number; headers: Headers },\n    payload: Payload | null,\n    options?: ErrorOptions,\n  ) {\n    super('UpstreamFailure', message, { cause: options?.cause })\n    this.response = {\n      status: response.status,\n      headers: response.headers,\n      payload,\n    }\n  }\n\n  readonly success = false as const\n\n  get reason(): this {\n    return this\n  }\n\n  matchesSchema(): false {\n    return false\n  }\n\n  shouldRetry(): boolean {\n    // Do not retry client errors\n    return this.response.status >= 500\n  }\n}\n\nexport class XrpcUnexpectedError\n  extends XrpcError<'InternalServerError'>\n  implements XrpcFailureResult<'InternalServerError', unknown>\n{\n  name = 'XrpcUnexpectedError' as const\n\n  protected constructor(message: string, options: Required<ErrorOptions>) {\n    super('InternalServerError', message, options)\n  }\n\n  readonly success = false\n\n  get reason() {\n    return this.cause\n  }\n\n  matchesSchema(): false {\n    return false\n  }\n\n  shouldRetry(): boolean {\n    return true\n  }\n\n  static from(\n    cause: unknown,\n    message: string = cause instanceof XrpcError\n      ? cause.message\n      : 'XRPC request failed',\n  ): XrpcUnexpectedError {\n    if (cause instanceof XrpcUnexpectedError) return cause\n    return new XrpcUnexpectedError(message, { cause })\n  }\n}\n"]}

package/dist/xrpc-response.d.ts

@@ -0,0 +1,35 @@
+import { InferMethodOutputBody, InferMethodOutputEncoding, Procedure, Query, ResultSuccess } from '@atproto/lex-schema';
+import { Payload } from './util.js';
+export type XrpcResponseBody<M extends Procedure | Query> = InferMethodOutputBody<M, Uint8Array>;
+export type XrpcResponsePayload<M extends Procedure | Query> = InferMethodOutputEncoding<M> extends infer E extends string ? Payload<XrpcResponseBody<M>, E> : null;
+/**
+ * Small container for XRPC response data.
+ *
+ * @implements {ResultSuccess<XrpcResponse<M>>} for convenience in result handling contexts.
+ */
+export declare class XrpcResponse<const M extends Procedure | Query> implements ResultSuccess<XrpcResponse<M>> {
+    readonly method: M;
+    readonly status: number;
+    readonly headers: Headers;
+    readonly payload: XrpcResponsePayload<M>;
+    /** @see {@link ResultSuccess.success} */
+    readonly success: true;
+    /** @see {@link ResultSuccess.value} */
+    get value(): this;
+    constructor(method: M, status: number, headers: Headers, payload: XrpcResponsePayload<M>);
+    /**
+     * Whether the response payload was parsed as {@link LexValue} (`true`) or is
+     * in binary form {@link Uint8Array} (`false`).
+     */
+    get isParsed(): boolean;
+    get encoding(): InferMethodOutputEncoding<M>;
+    get body(): XrpcResponseBody<M>;
+    /**
+     * @throws {XrpcInvalidResponseError} when the response is invalid according
+     * to the method schema.
+     */
+    static fromFetchResponse<const M extends Procedure | Query>(method: M, response: Response, options?: {
+        validateResponse?: boolean;
+    }): Promise<XrpcResponse<M>>;
+}
+//# sourceMappingURL=xrpc-response.d.ts.map

package/dist/xrpc-response.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"xrpc-response.d.ts","sourceRoot":"","sources":["../src/xrpc-response.ts"],"names":[],"mappings":"AACA,OAAO,EACL,qBAAqB,EACrB,yBAAyB,EACzB,SAAS,EACT,KAAK,EACL,aAAa,EACd,MAAM,qBAAqB,CAAA;AAC5B,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AAOnC,MAAM,MAAM,gBAAgB,CAAC,CAAC,SAAS,SAAS,GAAG,KAAK,IACtD,qBAAqB,CAAC,CAAC,EAAE,UAAU,CAAC,CAAA;AAEtC,MAAM,MAAM,mBAAmB,CAAC,CAAC,SAAS,SAAS,GAAG,KAAK,IACzD,yBAAyB,CAAC,CAAC,CAAC,SAAS,MAAM,CAAC,SAAS,MAAM,GACvD,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,GAC/B,IAAI,CAAA;AAEV;;;;GAIG;AACH,qBAAa,YAAY,CAAC,KAAK,CAAC,CAAC,SAAS,SAAS,GAAG,KAAK,CACzD,YAAW,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAWvC,QAAQ,CAAC,MAAM,EAAE,CAAC;IAClB,QAAQ,CAAC,MAAM,EAAE,MAAM;IACvB,QAAQ,CAAC,OAAO,EAAE,OAAO;IACzB,QAAQ,CAAC,OAAO,EAAE,mBAAmB,CAAC,CAAC,CAAC;IAZ1C,yCAAyC;IACzC,QAAQ,CAAC,OAAO,EAAG,IAAI,CAAS;IAEhC,uCAAuC;IACvC,IAAI,KAAK,IAAI,IAAI,CAEhB;gBAGU,MAAM,EAAE,CAAC,EACT,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,mBAAmB,CAAC,CAAC,CAAC;IAG1C;;;OAGG;IACH,IAAI,QAAQ,YAEX;IAED,IAAI,QAAQ,IACuB,yBAAyB,CAAC,CAAC,CAAC,CAC9D;IAED,IAAI,IAAI,IACuB,gBAAgB,CAAC,CAAC,CAAC,CACjD;IAED;;;OAGG;WACU,iBAAiB,CAAC,KAAK,CAAC,CAAC,SAAS,SAAS,GAAG,KAAK,EAC9D,MAAM,EAAE,CAAC,EACT,QAAQ,EAAE,QAAQ,EAClB,OAAO,CAAC,EAAE;QAAE,gBAAgB,CAAC,EAAE,OAAO,CAAA;KAAE,GACvC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;CAiF5B"}