@atcute/client 3.1.0 → 4.0.0

package/lib/rpc.ts

@@ -1,298 +0,0 @@
-import type { At, Procedures, Queries } from './lexicons.js';
-
-import { buildFetchHandler, type FetchHandler, type FetchHandlerObject } from './fetch-handler.js';
-import { mergeHeaders } from './utils/http.js';
-
-/**
- * @deprecated
- */
-export type HeadersObject = Record<string, string>;
-
-/**
- * Response from XRPC service
- * @deprecated
- */
-export interface XRPCResponse<T = any> {
-	data: T;
-	headers: HeadersObject;
-}
-
-/**
- * Options for constructing an XRPC error
- * @deprecated
- */
-export interface XRPCErrorOptions {
-	kind?: string;
-	description?: string;
-	headers?: HeadersObject;
-	cause?: unknown;
-}
-
-/**
- * Error coming from the XRPC service
- * @deprecated
- */
-export class XRPCError extends Error {
-	override name = 'XRPCError';
-
-	/** Response status */
-	status: number;
-	/** Response headers */
-	headers: HeadersObject;
-	/** Error kind */
-	kind?: string;
-	/** Error description */
-	description?: string;
-
-	constructor(
-		status: number,
-		{
-			kind = `HTTP error ${status}`,
-			description = `Unspecified error description`,
-			headers,
-			cause,
-		}: XRPCErrorOptions = {},
-	) {
-		super(`${kind} > ${description}`, { cause });
-
-		this.status = status;
-		this.kind = kind;
-		this.description = description;
-		this.headers = headers || {};
-	}
-}
-
-/**
- * Service proxy options
- * @deprecated
- */
-export interface XRPCProxyOptions {
-	type: 'atproto_pds' | 'atproto_labeler' | 'bsky_fg' | 'bsky_notif' | ({} & string);
-	service: At.Did;
-}
-
-/**
- * Options for constructing an XRPC
- * @deprecated
- */
-export interface XRPCOptions {
-	handler: FetchHandler | FetchHandlerObject;
-	proxy?: XRPCProxyOptions;
-}
-
-/**
- * XRPC request options
- * @deprecated
- */
-export interface XRPCRequestOptions {
-	type: 'get' | 'post';
-	nsid: string;
-	headers?: HeadersInit;
-	params?: Record<string, unknown>;
-	data?: FormData | Blob | ArrayBufferView | Record<string, unknown>;
-	signal?: AbortSignal;
-}
-
-/**
- * XRPC response
- * @deprecated
- */
-export interface XRPCResponse<T = any> {
-	data: T;
-	headers: HeadersObject;
-}
-
-/** Base options for the query/procedure request */
-interface BaseRPCOptions {
-	/** Request headers to make */
-	headers?: HeadersInit;
-	/** Signal for aborting the request */
-	signal?: AbortSignal;
-}
-
-/**
- * Options for the query/procedure request
- * @deprecated
- */
-export type RPCOptions<T> = BaseRPCOptions &
-	(T extends { params: any } ? { params: T['params'] } : {}) &
-	(T extends { input: any } ? { data: T['input'] } : {});
-
-type OutputOf<T> = T extends { output: any } ? T['output'] : never;
-
-/**
- * @deprecated
- */
-export class XRPC {
-	handle: FetchHandler;
-	proxy: XRPCProxyOptions | undefined;
-
-	constructor({ handler, proxy }: XRPCOptions) {
-		this.handle = buildFetchHandler(handler);
-		this.proxy = proxy;
-	}
-
-	/**
-	 * Makes a query (GET) request
-	 * @param nsid Namespace ID of a query endpoint
-	 * @param options Options to include like parameters
-	 * @returns The response of the request
-	 */
-	get<K extends keyof Queries>(
-		nsid: K,
-		options: RPCOptions<Queries[K]>,
-	): Promise<XRPCResponse<OutputOf<Queries[K]>>> {
-		return this.request({ type: 'get', nsid: nsid, ...(options as any) });
-	}
-
-	/**
-	 * Makes a procedure (POST) request
-	 * @param nsid Namespace ID of a procedure endpoint
-	 * @param options Options to include like input body or parameters
-	 * @returns The response of the request
-	 */
-	call<K extends keyof Procedures>(
-		nsid: K,
-		options: RPCOptions<Procedures[K]>,
-	): Promise<XRPCResponse<OutputOf<Procedures[K]>>> {
-		return this.request({ type: 'post', nsid: nsid, ...(options as any) });
-	}
-
-	/** Makes a request to the XRPC service */
-	async request(options: XRPCRequestOptions): Promise<XRPCResponse> {
-		const data = options.data;
-
-		const url = `/xrpc/${options.nsid}` + constructSearchParams(options.params);
-		const isInputJson = isJsonValue(data);
-
-		const response = await this.handle(url, {
-			method: options.type,
-			signal: options.signal,
-			body: isInputJson ? JSON.stringify(data) : data,
-			headers: mergeHeaders(options.headers, {
-				'content-type': isInputJson ? 'application/json' : null,
-				'atproto-proxy': constructProxyHeader(this.proxy),
-			}),
-		});
-
-		const responseStatus = response.status;
-		const responseHeaders = Object.fromEntries(response.headers);
-		const responseType = responseHeaders['content-type'];
-
-		let promise: Promise<unknown> | undefined;
-		let ret: unknown;
-
-		if (responseType) {
-			if (responseType.startsWith('application/json')) {
-				promise = response.json();
-			} else if (responseType.startsWith('text/')) {
-				promise = response.text();
-			}
-		}
-
-		try {
-			ret = await (promise || response.arrayBuffer().then((buffer) => new Uint8Array(buffer)));
-		} catch (err) {
-			throw new XRPCError(2, {
-				cause: err,
-				kind: 'InvalidResponse',
-				description: `Failed to parse response body`,
-				headers: responseHeaders,
-			});
-		}
-
-		if (responseStatus === 200) {
-			return {
-				data: ret,
-				headers: responseHeaders,
-			};
-		}
-
-		if (isErrorResponse(ret)) {
-			throw new XRPCError(responseStatus, {
-				kind: ret.error,
-				description: ret.message,
-				headers: responseHeaders,
-			});
-		}
-
-		throw new XRPCError(responseStatus, { headers: responseHeaders });
-	}
-}
-
-const constructProxyHeader = (proxy: XRPCProxyOptions | undefined): string | null => {
-	if (proxy) {
-		return `${proxy.service}#${proxy.type}`;
-	}
-
-	return null;
-};
-
-const constructSearchParams = (params: Record<string, unknown> | undefined): string => {
-	let searchParams: URLSearchParams | undefined;
-
-	for (const key in params) {
-		const value = params[key];
-
-		if (value !== undefined) {
-			searchParams ??= new URLSearchParams();
-
-			if (Array.isArray(value)) {
-				for (let idx = 0, len = value.length; idx < len; idx++) {
-					const val = value[idx];
-					searchParams.append(key, '' + val);
-				}
-			} else {
-				searchParams.set(key, '' + value);
-			}
-		}
-	}
-
-	return searchParams ? `?` + searchParams.toString() : '';
-};
-
-const isJsonValue = (o: unknown): o is Record<string, unknown> => {
-	if (typeof o !== 'object' || o === null) {
-		return false;
-	}
-
-	if ('toJSON' in o) {
-		return true;
-	}
-
-	const proto = Object.getPrototypeOf(o);
-	return proto === null || proto === Object.prototype;
-};
-
-const isErrorResponse = (value: any): value is ErrorResponseBody => {
-	if (typeof value !== 'object' || value === null) {
-		return false;
-	}
-
-	const kindType = typeof value.error;
-	const messageType = typeof value.message;
-
-	return (
-		(kindType === 'undefined' || kindType === 'string') &&
-		(messageType === 'undefined' || messageType === 'string')
-	);
-};
-
-interface ErrorResponseBody {
-	error?: string;
-	message?: string;
-}
-
-/**
- * @deprecated
- */
-export const clone = (rpc: XRPC): XRPC => {
-	return new XRPC({ handler: rpc.handle, proxy: rpc.proxy });
-};
-
-/**
- * @deprecated
- */
-export const withProxy = (rpc: XRPC, options: XRPCProxyOptions) => {
-	return new XRPC({ handler: rpc.handle, proxy: options });
-};

package/lib/utils/did.ts

@@ -1,73 +0,0 @@
-/**
- * @module
- * DID document-related functionalities.
- * This module is exported for convenience and is no way part of public API,
- * it can be removed at any time.
- */
-
-/**
- * Retrieves AT Protocol PDS endpoint from the DID document, if available
- * @param doc DID document
- * @returns The PDS endpoint, if available
- */
-export const getPdsEndpoint = (doc: DidDocument): string | undefined => {
-	return getServiceEndpoint(doc, '#atproto_pds', 'AtprotoPersonalDataServer');
-};
-
-/**
- * Retrieve a service endpoint from the DID document, if available
- * @param doc DID document
- * @param serviceId Service ID
- * @param serviceType Service type
- * @returns The requested service endpoint, if available
- */
-export const getServiceEndpoint = (
-	doc: DidDocument,
-	serviceId: string,
-	serviceType: string,
-): string | undefined => {
-	const did = doc.id;
-
-	const didServiceId = did + serviceId;
-	const found = doc.service?.find((service) => service.id === serviceId || service.id === didServiceId);
-
-	if (!found || found.type !== serviceType || typeof found.serviceEndpoint !== 'string') {
-		return undefined;
-	}
-
-	return validateUrl(found.serviceEndpoint);
-};
-
-const validateUrl = (urlStr: string): string | undefined => {
-	let url;
-	try {
-		url = new URL(urlStr);
-	} catch {
-		return undefined;
-	}
-
-	const proto = url.protocol;
-
-	if (url.hostname && (proto === 'http:' || proto === 'https:')) {
-		return urlStr;
-	}
-};
-
-/**
- * DID document
- */
-export interface DidDocument {
-	id: string;
-	alsoKnownAs?: string[];
-	verificationMethod?: Array<{
-		id: string;
-		type: string;
-		controller: string;
-		publicKeyMultibase?: string;
-	}>;
-	service?: Array<{
-		id: string;
-		type: string;
-		serviceEndpoint: string | Record<string, unknown>;
-	}>;
-}

package/lib/utils/http.ts

@@ -1,27 +0,0 @@
-/**
- * @module
- * Assortment of HTTP utilities
- * This module is exported for convenience and is no way part of public API,
- * it can be removed at any time.
- */
-
-export const mergeHeaders = (
-	init: HeadersInit | undefined,
-	defaults: Record<string, string | null>,
-): HeadersInit | undefined => {
-	let headers: Headers | undefined;
-
-	for (const name in defaults) {
-		const value = defaults[name];
-
-		if (value !== null) {
-			headers ??= new Headers(init);
-
-			if (!headers.has(name)) {
-				headers.set(name, value);
-			}
-		}
-	}
-
-	return headers ?? init;
-};