kitty-agent 1.0.0

package/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "kitty-agent",
+  "type": "module",
+  "version": "1.0.0",
+  "description": "Helpers for @atcute/client",
+  "main": "src/index.js",
+  "scripts": {
+    "build": "tsc"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "@atcute/client": "^2.0.6"
+  },
+  "peerDependencies": {
+    "@atcute/client": "^2.0.6"
+  }
+}

package/src/index.ts

@@ -0,0 +1,311 @@
+/* eslint-disable @typescript-eslint/no-empty-object-type */
+
+import { XRPC, XRPCError, type XRPCOptions, type XRPCRequestOptions, type XRPCResponse } from "@atcute/client";
+import type { At, ComAtprotoRepoApplyWrites, ComAtprotoRepoCreateRecord, ComAtprotoRepoDeleteRecord, ComAtprotoRepoGetRecord, ComAtprotoRepoListRecords, ComAtprotoRepoPutRecord, ComAtprotoSyncGetBlob, ComAtprotoSyncListBlobs, ComAtprotoSyncListRepos, Procedures, Queries, Records } from "@atcute/client/lexicons";
+
+interface GetRecordParams<K extends keyof Records> extends ComAtprotoRepoGetRecord.Params { collection: K; }
+interface GetRecordOutput<K extends keyof Records> extends ComAtprotoRepoGetRecord.Output { value: Records[K]; }
+
+interface PutRecordParams<K extends keyof Records> extends ComAtprotoRepoPutRecord.Input { collection: K; record: Records[K]; }
+interface PutRecordOutput<K extends keyof Records> extends ComAtprotoRepoPutRecord.Output { }
+
+interface CreateRecordParams<K extends keyof Records> extends ComAtprotoRepoCreateRecord.Input { collection: K; record: Records[K]; }
+interface CreateRecordOutput<K extends keyof Records> extends ComAtprotoRepoCreateRecord.Output { }
+
+interface ListRecordsParams<K extends keyof Records> extends ComAtprotoRepoListRecords.Params { collection: K; }
+interface ListRecordsOutput<K extends keyof Records> extends ComAtprotoRepoListRecords.Output { records: ListRecordsRecord<K>[]; }
+interface ListRecordsRecord<K extends keyof Records> extends ComAtprotoRepoListRecords.Record { value: Records[K]; }
+
+export function isInvalidSwapError(err: unknown) {
+    return err instanceof XRPCError && err.kind === 'InvalidSwap';
+}
+
+export function isRecordNotFoundError(err: unknown) {
+    return err instanceof XRPCError && err.kind === 'RecordNotFound';
+}
+
+type OutputOf<T> = T extends { output: infer U; } ? U : void;
+
+// WARNING: Evil TypeScript crimes
+// This spread array nonsense allows .query and .call to have 1-3
+// parameters based on only the generic type.
+//
+// This cannot be done with overloads to my knowledge.
+type ParamsThenData<T>
+    = T extends { params: infer U }
+        ? T extends { input: infer V }
+            ? [params: U, data: V]
+            : [params: U]
+        : T extends { input: infer W }
+            ? [params: undefined, data: W]
+            : [];
+
+type DataThenParams<T>
+    = T extends { input: infer U }
+        ? T extends { params: infer V }
+            ? [data: U, params: V]
+            : [data: U]
+        : T extends { params: infer W }
+            ? [data: undefined, params: W]
+            : [];
+
+export class KittyAgent<X extends XRPC = XRPC> {
+    public readonly xrpc: X;
+
+    constructor(opts: XRPCOptions | X) {
+        this.xrpc = opts instanceof XRPC ? opts as X : new XRPC(opts) as X;
+    }
+
+    /** Makes a request to the XRPC service */
+    async request(options: XRPCRequestOptions): Promise<XRPCResponse> {
+        return await this.xrpc.request(options);
+    }
+
+    async query<K extends keyof Queries>(
+        nsid: K,
+        ...args: ParamsThenData<Queries[K]>
+    ): Promise<OutputOf<Queries[K]>> {
+        const [params, data] = args as unknown[];
+
+        const { data: outData } = await this.xrpc.get(nsid, { params, data, } as any);
+
+        return outData;
+    }
+
+    async call<K extends keyof Procedures>(
+        nsid: K,
+        ...args: DataThenParams<Procedures[K]>
+    ): Promise<OutputOf<Procedures[K]>> {
+        const [data, params] = args as unknown[];
+
+        const { data: outData } = await this.xrpc.call(nsid, { params, data } as any);
+
+        return outData;
+    }
+
+    async get<K extends keyof Records>(params: GetRecordParams<K>) {
+        const data = await this.query('com.atproto.repo.getRecord', params);
+
+        return data as GetRecordOutput<K>;
+    }
+
+    async getBlob(params: ComAtprotoSyncGetBlob.Params | { did: At.DID, cid: At.Blob }): Promise<Uint8Array> {
+        if (typeof params.cid !== 'string') {
+            params = {
+                cid: params.cid.ref.$link as At.CID,
+                did: params.did,
+            } satisfies ComAtprotoSyncGetBlob.Params;
+        }
+
+        const data = await this.query('com.atproto.sync.getBlob', params as ComAtprotoSyncGetBlob.Params);
+
+        return data;
+    }
+
+    async tryGet<K extends keyof Records>(params: GetRecordParams<K>) {
+        try {
+            return await this.get(params);
+        } catch (err) {
+            if (!isRecordNotFoundError(err)) throw err;
+            return {
+                uri: undefined,
+                value: undefined,
+                cid: undefined,
+            };
+        }
+    }
+
+    async list<K extends keyof Records>(params: ListRecordsParams<K>) {
+        const data = await this.query('com.atproto.repo.listRecords', params);
+
+        return data as ListRecordsOutput<K>;
+    }
+
+    async put<K extends keyof Records>(params: PutRecordParams<K>) {
+        const data = await this.call('com.atproto.repo.putRecord', params);
+
+        return data as PutRecordOutput<K>;
+    }
+
+    async uploadBlob(buf: Uint8Array | Blob) {
+        const data = await this.call('com.atproto.repo.uploadBlob', buf);
+
+        return data.blob;
+    }
+
+    async trySwap<K extends keyof Records>(params: PutRecordParams<K>) {
+        try {
+            await this.put(params);
+            return true;
+        } catch (err) {
+            if (!isInvalidSwapError(err)) {
+                throw err;
+            }
+            return false;
+        }
+    }
+
+    async create<K extends keyof Records>(params: CreateRecordParams<K>) {
+        const data = await this.call('com.atproto.repo.createRecord', params);
+
+        return data as CreateRecordOutput<K>;
+    }
+
+    async delete(params: ComAtprotoRepoDeleteRecord.Input) {
+        const data = await this.call('com.atproto.repo.deleteRecord', params);
+
+        return data;
+    }
+
+    async paginatedList<K extends keyof Records>(params: {
+        repo: string,
+        collection: K,
+        reverse?: boolean,
+        limit?: number;
+    }): Promise<ListRecordsOutput<K>> {
+        const PER_PAGE = 100;
+
+        const results: ListRecordsRecord<K>[] = [];
+
+        let limit = params.limit;
+
+        let cursor: string | undefined = undefined;
+        do {
+            const data: ComAtprotoRepoListRecords.Output
+                = await this.query('com.atproto.repo.listRecords', {
+                    repo: params.repo,
+                    collection: params.collection,
+                    limit: limit === undefined
+                        ? PER_PAGE
+                        : limit / PER_PAGE > 1
+                            ? PER_PAGE
+                            : limit,
+                    reverse: params.reverse ?? true,
+                    cursor
+                });
+
+            if (!data.records.length ||
+                data.records.every(
+                    e => results.find(e1 => e1.uri == e.uri)
+                )
+            ) {
+                break;
+            }
+
+            if (limit !== undefined) {
+                limit -= data.records.length;
+            }
+
+            results.push(...data.records as ListRecordsRecord<K>[]);
+
+            cursor = data.cursor;
+
+            if (!cursor) break;
+        } while (cursor);
+
+        return { records: results, cursor };
+    }
+
+    async paginatedListBlobs(params: {
+        did: At.DID,
+        limit?: number;
+    }) {
+        const PER_PAGE = 1000;
+
+        const cids: string[] = [];
+
+        let limit = params.limit;
+
+        let cursor: string | undefined = undefined;
+        do {
+            const data: ComAtprotoSyncListBlobs.Output
+                = await this.query('com.atproto.sync.listBlobs', {
+                    did: params.did,
+                    limit: limit === undefined
+                        ? PER_PAGE
+                        : limit / PER_PAGE > 1
+                            ? PER_PAGE
+                            : limit,
+                    cursor
+                });
+
+            if (!data.cids.length ||
+                data.cids.every(
+                    e => cids.find(e1 => e1 == e)
+                )
+            ) {
+                break;
+            }
+
+            if (limit !== undefined) {
+                limit -= data.cids.length;
+            }
+
+            cids.push(...data.cids);
+
+            cursor = data.cursor;
+
+            if (!cursor) break;
+        } while (cursor);
+
+        return { cids, cursor };
+    }
+
+    async paginatedListRepos(params: {
+        did: At.DID,
+        limit?: number;
+    }) {
+        const PER_PAGE = 1000;
+
+        const repos: ComAtprotoSyncListRepos.Repo[] = [];
+
+        let limit = params.limit;
+
+        let cursor: string | undefined = undefined;
+        do {
+            const data: ComAtprotoSyncListRepos.Output
+                = await this.query('com.atproto.sync.listRepos', {
+                    limit: limit === undefined
+                        ? PER_PAGE
+                        : limit / PER_PAGE > 1
+                            ? PER_PAGE
+                            : limit,
+                    cursor
+                });
+
+            if (!data.repos.length ||
+                data.repos.every(
+                    e => repos.find(e1 => e1.did == e.did)
+                )
+            ) {
+                break;
+            }
+
+            if (limit !== undefined) {
+                limit -= data.repos.length;
+            }
+
+            repos.push(...data.repos);
+
+            cursor = data.cursor;
+
+            if (!cursor) break;
+        } while (cursor);
+
+        return { repos, cursor };
+    }
+
+    async batchWrite(params: ComAtprotoRepoApplyWrites.Input) {
+        return await this.call('com.atproto.repo.applyWrites', params);
+    }
+
+    async resolveHandle(handle: string): Promise<At.DID> {
+        if (handle.startsWith('did:')) return handle as At.DID;
+
+        const { did } = await this.query('com.atproto.identity.resolveHandle', {
+            handle
+        });
+
+        return did;
+    }
+}

package/tsconfig.json

@@ -0,0 +1,111 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig to read more about this file */
+
+    /* Projects */
+    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
+    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
+    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+    /* Language and Environment */
+    "target": "ES2022",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+    // "experimentalDecorators": true,                   /* Enable experimental support for legacy experimental decorators. */
+    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
+    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
+    // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
+    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
+
+    /* Modules */
+    "module": "NodeNext",                                /* Specify what module code is generated. */
+    "rootDir": "./src",                                  /* Specify the root folder within your source files. */
+    "moduleResolution": "nodenext",                     /* Specify how TypeScript looks up a file from a given module specifier. */
+    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+    // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
+    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
+    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+    // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
+    // "allowImportingTsExtensions": true,               /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
+    // "rewriteRelativeImportExtensions": true,          /* Rewrite '.ts', '.tsx', '.mts', and '.cts' file extensions in relative import paths to their JavaScript equivalent in output files. */
+    // "resolvePackageJsonExports": true,                /* Use the package.json 'exports' field when resolving package imports. */
+    // "resolvePackageJsonImports": true,                /* Use the package.json 'imports' field when resolving imports. */
+    // "customConditions": [],                           /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
+    // "noUncheckedSideEffectImports": true,             /* Check side effect imports. */
+    // "resolveJsonModule": true,                        /* Enable importing .json files. */
+    // "allowArbitraryExtensions": true,                 /* Enable importing files with any extension, provided a declaration file is present. */
+    // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
+
+    /* JavaScript Support */
+    // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
+    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
+
+    /* Emit */
+    "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+    "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
+    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
+    "outDir": "./out",                                   /* Specify an output folder for all emitted files. */
+    // "removeComments": true,                           /* Disable emitting comments. */
+    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+    // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
+    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
+    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+    // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
+    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+
+    /* Interop Constraints */
+    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+    // "verbatimModuleSyntax": true,                     /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
+    // "isolatedDeclarations": true,                     /* Require sufficient annotation on exports so other tools can trivially generate declaration files. */
+    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
+
+    /* Type Checking */
+    "strict": true,                                      /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */
+    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+    // "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
+    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+    // "strictBuiltinIteratorReturn": true,              /* Built-in iterators are instantiated with a 'TReturn' type of 'undefined' instead of 'any'. */
+    // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
+    // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
+    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    // "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
+    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */
+    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+    // "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
+    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
+    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
+  }
+}