@atproto/lex-client 0.0.2 → 0.0.4

package/src/lexicons/com/atproto/repo/listRecords.defs.ts

@@ -0,0 +1,63 @@
+/*
+ * THIS FILE WAS GENERATED BY "@atproto/lex". DO NOT EDIT.
+ */
+
+import { l } from '@atproto/lex-schema'
+
+const $nsid = 'com.atproto.repo.listRecords'
+
+export { $nsid }
+
+/**
+ * List a range of records in a repository, matching a specific collection. Does not require auth.
+ */
+const main =
+  /*#__PURE__*/
+  l.query(
+    $nsid,
+    /*#__PURE__*/ l.params({
+      repo: /*#__PURE__*/ l.string({ format: 'at-identifier' }),
+      collection: /*#__PURE__*/ l.string({ format: 'nsid' }),
+      limit: /*#__PURE__*/ l.optional(
+        /*#__PURE__*/ l.integer({ minimum: 1, maximum: 100, default: 50 }),
+      ),
+      cursor: /*#__PURE__*/ l.optional(/*#__PURE__*/ l.string()),
+      reverse: /*#__PURE__*/ l.optional(/*#__PURE__*/ l.boolean()),
+    }),
+    /*#__PURE__*/ l.payload(
+      'application/json',
+      /*#__PURE__*/ l.object({
+        cursor: /*#__PURE__*/ l.optional(/*#__PURE__*/ l.string()),
+        records: /*#__PURE__*/ l.array(
+          /*#__PURE__*/ l.ref<Def$0>((() => def$0) as any),
+        ),
+      }),
+    ),
+  )
+export { main }
+
+export const $params = main.parameters,
+  $output = main.output
+
+export type Params = l.InferQueryParameters<typeof main>
+export type Output = l.InferQueryOutputBody<typeof main>
+type Def$0 = {
+  $type?: 'com.atproto.repo.listRecords#record'
+  uri: l.AtUriString
+  cid: l.CidString
+  value: l.UnknownObject
+}
+
+export type { Def$0 as DefRecord }
+
+const def$0 = /*#__PURE__*/ l.typedObject<Def$0>(
+  $nsid,
+  'record',
+  /*#__PURE__*/ l.object({
+    uri: /*#__PURE__*/ l.string({ format: 'at-uri' }),
+    cid: /*#__PURE__*/ l.string({ format: 'cid' }),
+    value: /*#__PURE__*/ l.unknownObject(),
+  }),
+)
+
+export { def$0 as record }

package/src/lexicons/com/atproto/repo/listRecords.ts

@@ -0,0 +1,6 @@
+/*
+ * THIS FILE WAS GENERATED BY "@atproto/lex". DO NOT EDIT.
+ */
+
+export * from './listRecords.defs.js'
+export * as $defs from './listRecords.defs.js'

package/src/lexicons/com/atproto/repo/putRecord.defs.ts

@@ -0,0 +1,59 @@
+/*
+ * THIS FILE WAS GENERATED BY "@atproto/lex". DO NOT EDIT.
+ */
+
+import { l } from '@atproto/lex-schema'
+import * as RepoDefs from './defs.defs.js'
+
+const $nsid = 'com.atproto.repo.putRecord'
+
+export { $nsid }
+
+/**
+ * Write a repository record, creating or updating it as needed. Requires auth, implemented by PDS.
+ */
+const main =
+  /*#__PURE__*/
+  l.procedure(
+    $nsid,
+    /*#__PURE__*/ l.params({}),
+    /*#__PURE__*/ l.payload(
+      'application/json',
+      /*#__PURE__*/ l.object({
+        repo: /*#__PURE__*/ l.string({ format: 'at-identifier' }),
+        collection: /*#__PURE__*/ l.string({ format: 'nsid' }),
+        rkey: /*#__PURE__*/ l.string({ format: 'record-key', maxLength: 512 }),
+        validate: /*#__PURE__*/ l.optional(/*#__PURE__*/ l.boolean()),
+        record: /*#__PURE__*/ l.unknownObject(),
+        swapRecord: /*#__PURE__*/ l.optional(
+          /*#__PURE__*/ l.nullable(/*#__PURE__*/ l.string({ format: 'cid' })),
+        ),
+        swapCommit: /*#__PURE__*/ l.optional(
+          /*#__PURE__*/ l.string({ format: 'cid' }),
+        ),
+      }),
+    ),
+    /*#__PURE__*/ l.payload(
+      'application/json',
+      /*#__PURE__*/ l.object({
+        uri: /*#__PURE__*/ l.string({ format: 'at-uri' }),
+        cid: /*#__PURE__*/ l.string({ format: 'cid' }),
+        commit: /*#__PURE__*/ l.optional(
+          /*#__PURE__*/ l.ref<RepoDefs.CommitMeta>(
+            (() => RepoDefs.commitMeta) as any,
+          ),
+        ),
+        validationStatus: /*#__PURE__*/ l.optional(/*#__PURE__*/ l.string()),
+      }),
+    ),
+    ['InvalidSwap'],
+  )
+export { main }
+
+export const $params = /*#__PURE__*/ main.parameters,
+  $input = /*#__PURE__*/ main.input,
+  $output = /*#__PURE__*/ main.output
+
+export type Params = l.InferProcedureParameters<typeof main>
+export type Input = l.InferProcedureInputBody<typeof main>
+export type Output = l.InferProcedureOutputBody<typeof main>

package/src/lexicons/com/atproto/repo/putRecord.ts

@@ -0,0 +1,6 @@
+/*
+ * THIS FILE WAS GENERATED BY "@atproto/lex". DO NOT EDIT.
+ */
+
+export * from './putRecord.defs.js'
+export * as $defs from './putRecord.defs.js'

package/src/lexicons/com/atproto/repo/uploadBlob.defs.ts

@@ -0,0 +1,35 @@
+/*
+ * THIS FILE WAS GENERATED BY "@atproto/lex". DO NOT EDIT.
+ */
+
+import { l } from '@atproto/lex-schema'
+
+const $nsid = 'com.atproto.repo.uploadBlob'
+
+export { $nsid }
+
+/**
+ * Upload a new blob, to be referenced from a repository record. The blob will be deleted if it is not referenced within a time window (eg, minutes). Blob restrictions (mimetype, size, etc) are enforced when the reference is created. Requires auth, implemented by PDS.
+ */
+const main =
+  /*#__PURE__*/
+  l.procedure(
+    $nsid,
+    /*#__PURE__*/ l.params({}),
+    /*#__PURE__*/ l.payload('*/*'),
+    /*#__PURE__*/ l.payload(
+      'application/json',
+      /*#__PURE__*/ l.object({
+        blob: /*#__PURE__*/ l.blob({ allowLegacy: false }),
+      }),
+    ),
+  )
+export { main }
+
+export const $params = /*#__PURE__*/ main.parameters,
+  $input = /*#__PURE__*/ main.input,
+  $output = /*#__PURE__*/ main.output
+
+export type Params = l.InferProcedureParameters<typeof main>
+export type Input = l.InferProcedureInputBody<typeof main>
+export type Output = l.InferProcedureOutputBody<typeof main>

package/src/lexicons/com/atproto/repo/uploadBlob.ts

@@ -0,0 +1,6 @@
+/*
+ * THIS FILE WAS GENERATED BY "@atproto/lex". DO NOT EDIT.
+ */
+
+export * from './uploadBlob.defs.js'
+export * as $defs from './uploadBlob.defs.js'

package/src/lexicons/com/atproto/repo.ts

@@ -0,0 +1,11 @@
+/*
+ * THIS FILE WAS GENERATED BY "@atproto/lex". DO NOT EDIT.
+ */
+
+export * as createRecord from './repo/createRecord.js'
+export * as deleteRecord from './repo/deleteRecord.js'
+export * as getRecord from './repo/getRecord.js'
+export * as listRecords from './repo/listRecords.js'
+export * as putRecord from './repo/putRecord.js'
+export * as uploadBlob from './repo/uploadBlob.js'
+export * as defs from './repo/defs.js'

package/src/lexicons/com/atproto.ts

@@ -0,0 +1,5 @@
+/*
+ * THIS FILE WAS GENERATED BY "@atproto/lex". DO NOT EDIT.
+ */
+
+export * as repo from './atproto/repo.js'

package/src/lexicons/com.ts

@@ -0,0 +1,5 @@
+/*
+ * THIS FILE WAS GENERATED BY "@atproto/lex". DO NOT EDIT.
+ */
+
+export * as atproto from './com/atproto.js'

package/src/types.ts

@@ -1,12 +1,12 @@
-import { Did, UnknownString } from '@atproto/lex-schema'
+import { DidString, UnknownString } from '@atproto/lex-schema'
 
-export type { Did, UnknownString }
+export type { DidString, UnknownString }
 
 export type DidServiceIdentifier = 'atproto_labeler' | UnknownString
-export type Service = `${Did}#${DidServiceIdentifier}`
+export type Service = `${DidString}#${DidServiceIdentifier}`
 
 export type CallOptions = {
-  labelers?: Iterable<Did>
+  labelers?: Iterable<DidString>
   signal?: AbortSignal
   headers?: HeadersInit
   service?: Service

package/src/xrpc.ts

@@ -1,7 +1,7 @@
 import { LexValue } from '@atproto/lex-data'
 import { lexParse, lexStringify } from '@atproto/lex-json'
 import {
-  Did,
+  DidString,
   InferParamsSchema,
   InferPayloadBody,
   Params,
@@ -136,7 +136,7 @@ export function xrpcRequestInit<T extends Procedure | Query>(
 export function xrpcRequestHeaders(options: {
   headers?: HeadersInit
   service?: Service
-  labelers?: Iterable<Did>
+  labelers?: Iterable<DidString>
 }): Headers {
   const headers = new Headers(options.headers)
 
@@ -209,7 +209,7 @@ export async function xrpcResponseHandler<M extends Procedure | Query>(
     if (
       body != null &&
       encoding === 'application/json' &&
-      xrpcErrorBodySchema.check(body)
+      xrpcErrorBodySchema.matches(body)
     ) {
       throw new XrpcResponseError(
         response.status,

package/jest.config.js

@@ -1,5 +0,0 @@
-/** @type {import('jest').Config} */
-module.exports = {
-  transform: { '^.+\\.(t|j)s$': ['@swc/jest'] },
-  moduleNameMapper: { '^(\\.\\.?\\/.+)\\.js$': ['$1.ts', '$1.js'] },
-}

package/scripts/lex-build.mjs

@@ -1,40 +0,0 @@
-/* eslint-env node  */
-
-import { build } from '@atproto/lex-builder'
-
-Promise.all([
-  // For src
-  build({
-    lexicons: '../../../lexicons',
-    out: './src/lexicons',
-    override: true,
-    include: [
-      'com.atproto.repo.createRecord',
-      'com.atproto.repo.deleteRecord',
-      'com.atproto.repo.getRecord',
-      'com.atproto.repo.putRecord',
-      'com.atproto.repo.listRecords',
-      'com.atproto.repo.uploadBlob',
-    ],
-    lib: '@atproto/lex-schema',
-    pretty: true,
-    pureAnnotations: true,
-  }),
-
-  // For tests
-  build({
-    lexicons: '../../../lexicons',
-    out: './tests/lexicons',
-    override: true,
-    include: [
-      'app.bsky.*',
-      'com.atproto.repo.createRecord',
-      'com.atproto.repo.getRecord',
-    ],
-    lib: '@atproto/lex-schema',
-    pretty: true,
-  }),
-]).catch((err) => {
-  console.error('Error building lexicon schemas:', err)
-  process.exit(1)
-})

package/tests/client.test.ts

@@ -1,370 +0,0 @@
-import { LexValue, cidForLex } from '@atproto/lex-cbor'
-import { lexParse } from '@atproto/lex-json'
-import { Action, Client } from '..'
-import * as app from './lexicons/app.js'
-import * as com from './lexicons/com.js'
-
-type Preference = app.bsky.actor.defs.Preferences[number]
-
-describe('utils', () => {
-  describe('TypedObjectSchema', () => {
-    it('overrides $type when building an object', () => {
-      const _r = app.bsky.actor.defs.adultContentPref.build({
-        $type: 'foo',
-        enabled: true,
-      })
-      expect(_r.$type).toBe('app.bsky.actor.defs#adultContentPref')
-    })
-  })
-})
-
-describe('Client', () => {
-  describe('actions', () => {
-    it('updatePreferences', async () => {
-      const fetchHandler = jest.fn(
-        async (url: string, init?: RequestInit): Promise<Response> => {
-          if (url === '/xrpc/app.bsky.actor.getPreferences') {
-            return new Response(
-              JSON.stringify({ preferences: storedPreferences }),
-              {
-                status: 200,
-                headers: { 'Content-Type': 'application/json' },
-              },
-            )
-          } else if (url === '/xrpc/app.bsky.actor.putPreferences') {
-            expect(typeof init?.body).toBe('string')
-            const { preferences } =
-              app.bsky.actor.putPreferences.$input.schema.parse(
-                lexParse(init?.body as string),
-              )
-            storedPreferences = preferences
-            return new Response(null, { status: 204 })
-          } else {
-            return new Response('Not Found', { status: 404 })
-          }
-        },
-      )
-
-      const client = new Client({ fetchHandler })
-
-      const updatePreferences: Action<
-        (pref: Preference[]) => false | Preference[],
-        Preference[]
-      > = async function (client, updatePreferences, options) {
-        const data = await client.call(app.bsky.actor.getPreferences, options)
-
-        const preferences = updatePreferences(data.preferences)
-        if (preferences === false) return data.preferences
-
-        options?.signal?.throwIfAborted()
-
-        await client.call(
-          app.bsky.actor.putPreferences,
-          { preferences },
-          options,
-        )
-
-        return preferences
-      }
-
-      const upsertPreference: Action<Preference, Preference[]> =
-        async function (client, pref, options) {
-          return updatePreferences(
-            client,
-            (prefs) => [...prefs.filter((p) => p.$type !== pref.$type), pref],
-            options,
-          )
-        }
-
-      let storedPreferences: Preference[] = [
-        app.bsky.actor.defs.adultContentPref.build({
-          enabled: false,
-        }),
-        app.bsky.actor.defs.contentLabelPref.build({
-          label: 'my-label',
-          visibility: 'warn',
-        }),
-      ]
-
-      expect(fetchHandler).toHaveBeenCalledTimes(0)
-      expect(storedPreferences).toEqual([
-        {
-          $type: 'app.bsky.actor.defs#adultContentPref',
-          enabled: false,
-        },
-        {
-          $type: 'app.bsky.actor.defs#contentLabelPref',
-          label: 'my-label',
-          visibility: 'warn',
-        },
-      ])
-
-      // Upsert adult content preference
-      await client.call(
-        upsertPreference,
-        app.bsky.actor.defs.adultContentPref.build({
-          enabled: true,
-        }),
-      )
-
-      expect(fetchHandler).toHaveBeenCalledTimes(2)
-      expect(storedPreferences).toEqual([
-        {
-          $type: 'app.bsky.actor.defs#contentLabelPref',
-          label: 'my-label',
-          visibility: 'warn',
-        },
-        {
-          $type: 'app.bsky.actor.defs#adultContentPref',
-          enabled: true,
-        },
-      ])
-
-      // @ts-expect-error invalid preference value
-      await client.call(upsertPreference, {
-        $type: 'app.bsky.actor.defs#adultContentPref',
-        // enabled: true,
-      })
-
-      expect(fetchHandler).toHaveBeenCalledTimes(4)
-      expect(storedPreferences).toEqual([
-        {
-          $type: 'app.bsky.actor.defs#contentLabelPref',
-          label: 'my-label',
-          visibility: 'warn',
-        },
-        {
-          $type: 'app.bsky.actor.defs#adultContentPref',
-          enabled: false, // "false" default will be enforced when parsing the body
-        },
-      ])
-
-      expect(async () => {
-        // @ts-expect-error invalid preference value
-        await client.call(upsertPreference, {
-          $type: 'app.bsky.actor.defs#adultContentPref',
-          enabled: 'not-a-boolean',
-        })
-      }).rejects.toThrow()
-    })
-  })
-
-  describe('query', () => {
-    it('allows perfoming a GET request and parsing the response', async () => {
-      const fetchHandler = jest.fn(
-        async (url: string, init?: RequestInit): Promise<Response> => {
-          expect(url).toBe('/xrpc/app.bsky.actor.getPreferences')
-          expect(init?.method).toBe('GET')
-
-          const responsePayload = {
-            preferences: [
-              {
-                $type: 'app.bsky.actor.defs#adultContentPref',
-                enabled: false,
-              },
-              {
-                $type: 'app.bsky.actor.defs#someOtherPref',
-                otherField: 'some value',
-              },
-            ],
-          }
-
-          return new Response(JSON.stringify(responsePayload), {
-            status: 200,
-            headers: { 'Content-Type': 'application/json' },
-          })
-        },
-      )
-
-      const client = new Client({ fetchHandler })
-
-      const { preferences } = await client.call(app.bsky.actor.getPreferences)
-
-      expect(preferences).toEqual([
-        {
-          $type: 'app.bsky.actor.defs#adultContentPref',
-          enabled: false,
-        },
-        {
-          $type: 'app.bsky.actor.defs#someOtherPref',
-          otherField: 'some value',
-        },
-      ])
-
-      expect(fetchHandler).toHaveBeenCalledTimes(1)
-
-      const adultContentPref = preferences.find((p) =>
-        app.bsky.actor.defs.adultContentPref.isTypeOf(p),
-      )
-
-      expect(adultContentPref).toEqual({
-        $type: 'app.bsky.actor.defs#adultContentPref',
-        enabled: false,
-      })
-    })
-  })
-
-  describe('records', () => {
-    it('allows creating records', async () => {
-      let currentTid = 0
-      // Only works 8 times
-      const nextTid = jest.fn(() => `2222222222${2 + currentTid++}22`)
-
-      const did = 'did:plc:alice'
-      const fetchHandler = jest.fn(
-        async (url: string, init?: RequestInit): Promise<Response> => {
-          expect(url).toBe('/xrpc/com.atproto.repo.createRecord')
-          expect(init?.method).toBe('POST')
-          expect(typeof init?.body).toBe('string')
-          const payload = com.atproto.repo.createRecord.main.input.schema.parse(
-            lexParse(init?.body as string),
-          )
-
-          expect(payload).toMatchObject({
-            repo: did,
-            collection: expect.any(String),
-            record: expect.any(Object),
-          })
-
-          const rkey = payload.rkey || nextTid()
-          const cid = await cidForLex(payload.record as LexValue)
-
-          const responsePayload: com.atproto.repo.createRecord.Output = {
-            cid: cid.toString(),
-            uri: `at://${payload.repo}/${payload.collection}/${rkey}`,
-          }
-
-          return new Response(JSON.stringify(responsePayload), {
-            status: 200,
-            headers: { 'Content-Type': 'application/json' },
-          })
-        },
-      )
-
-      const client = new Client({ fetchHandler, did })
-
-      await expect(async () => {
-        await client.create(
-          app.bsky.feed.generator,
-          {
-            // @ts-expect-error invalid DID
-            did: 'not-a-did',
-            displayName: 'Alice Generator',
-            createdAt: '2024-01-01T00:00:00Z',
-          },
-          {
-            rkey: 'alice-generator',
-            validate: true,
-          },
-        )
-      }).rejects.toThrow()
-
-      // validate performs schema validation before making the request
-      expect(fetchHandler).toHaveBeenCalledTimes(0)
-
-      const newGenerator = await client.create(
-        app.bsky.feed.generator,
-        {
-          did,
-          displayName: 'Alice Generator',
-          createdAt: '2024-01-01T00:00:00Z',
-        },
-        {
-          rkey: 'alice-generator',
-          validate: true,
-        },
-      )
-
-      expect(fetchHandler).toHaveBeenCalledTimes(1)
-      expect(newGenerator.cid).toBe(
-        'bafyreihx5eurnmsnj6ulfby3icl4ebh6pliwuqaze25z4ejitnt23b4vw4',
-      )
-
-      const aliceGenerator = await client.create(
-        // @ts-expect-error an "rkey" option is required for feed generator records
-        app.bsky.feed.generator,
-        {
-          did: 'no-a-did',
-          displayName: 'Alice Generator',
-          createdAt: new Date().toISOString(),
-        },
-      )
-
-      expect(nextTid).toHaveBeenCalledTimes(1)
-      expect(aliceGenerator.uri).toBe(
-        `at://${did}/app.bsky.feed.generator/${'2'.repeat(13)}`,
-      )
-
-      const newProfile = await client.create(app.bsky.actor.profile, {
-        displayName: 'Alice',
-      })
-
-      expect(nextTid).toHaveBeenCalledTimes(1)
-      expect(fetchHandler).toHaveBeenCalledTimes(3)
-      expect(newProfile.uri).toBe(
-        'at://did:plc:alice/app.bsky.actor.profile/self',
-      )
-
-      const newPost = await client.create(app.bsky.feed.post, {
-        text: 'Hello, world!',
-        createdAt: new Date().toISOString(),
-      })
-
-      expect(nextTid).toHaveBeenCalledTimes(2)
-      expect(fetchHandler).toHaveBeenCalledTimes(4)
-      expect(newPost.uri).toBe(`at://${did}/app.bsky.feed.post/2222222222322`)
-    })
-
-    it('allows fetching records', async () => {
-      const did = 'did:plc:alice'
-      const fetchHandler = jest.fn(
-        async (url: string, init?: RequestInit): Promise<Response> => {
-          expect(init?.method).toBe('GET')
-          const urlObj = new URL(url, 'https://example.com')
-          expect(urlObj.pathname).toBe('/xrpc/com.atproto.repo.getRecord')
-
-          const repo = urlObj.searchParams.get('repo')
-          const collection = urlObj.searchParams.get('collection')
-          const rkey = urlObj.searchParams.get('rkey')
-
-          expect(repo).toBe(did)
-          expect(collection).toBe(app.bsky.feed.post.$type)
-          expect(rkey).toBe('2222222222222')
-
-          const record = app.bsky.feed.post.$build({
-            text: 'This is an old post',
-            createdAt: '2024-01-01T00:00:00Z',
-          })
-
-          const cid = await cidForLex(record)
-
-          const responsePayload: com.atproto.repo.getRecord.Output = {
-            cid: cid.toString(),
-            uri: `at://${repo!}/${collection!}/${rkey!}` as any,
-            value: record,
-          }
-
-          return new Response(JSON.stringify(responsePayload), {
-            status: 200,
-            headers: { 'Content-Type': 'application/json' },
-          })
-        },
-      )
-
-      const client = new Client({ fetchHandler, did })
-
-      const { value: post } = await client.get(app.bsky.feed.post, {
-        rkey: '2222222222222',
-      })
-
-      expect(fetchHandler).toHaveBeenCalledTimes(1)
-      expect(post).toMatchObject({
-        $type: 'app.bsky.feed.post',
-        text: 'This is an old post',
-        createdAt: '2024-01-01T00:00:00Z',
-      })
-
-      // @TODO: using getRecord method (to check we got the cid)
-    })
-  })
-})

package/tsconfig.build.tsbuildinfo

@@ -1 +0,0 @@
-{"root":["./src/agent.ts","./src/client.ts","./src/error.ts","./src/index.ts","./src/response.ts","./src/types.ts","./src/xrpc.ts","./src/lexicons/com.ts","./src/lexicons/com/atproto.ts","./src/lexicons/com/atproto/repo.ts","./src/lexicons/com/atproto/repo/createRecord.defs.ts","./src/lexicons/com/atproto/repo/createRecord.ts","./src/lexicons/com/atproto/repo/defs.defs.ts","./src/lexicons/com/atproto/repo/defs.ts","./src/lexicons/com/atproto/repo/deleteRecord.defs.ts","./src/lexicons/com/atproto/repo/deleteRecord.ts","./src/lexicons/com/atproto/repo/getRecord.defs.ts","./src/lexicons/com/atproto/repo/getRecord.ts","./src/lexicons/com/atproto/repo/listRecords.defs.ts","./src/lexicons/com/atproto/repo/listRecords.ts","./src/lexicons/com/atproto/repo/putRecord.defs.ts","./src/lexicons/com/atproto/repo/putRecord.ts","./src/lexicons/com/atproto/repo/uploadBlob.defs.ts","./src/lexicons/com/atproto/repo/uploadBlob.ts"],"version":"5.8.3"}