@atproto/api 0.18.4 → 0.18.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atproto/api",
-  "version": "0.18.4",
+  "version": "0.18.5",
   "license": "MIT",
   "description": "Client library for atproto and Bluesky",
   "keywords": [
@@ -21,17 +21,17 @@
     "multiformats": "^9.9.0",
     "tlds": "^1.234.0",
     "zod": "^3.23.8",
-    "@atproto/common-web": "^0.4.6",
-    "@atproto/lexicon": "^0.5.2",
+    "@atproto/common-web": "^0.4.7",
+    "@atproto/lexicon": "^0.6.0",
     "@atproto/syntax": "^0.4.2",
-    "@atproto/xrpc": "^0.7.6"
+    "@atproto/xrpc": "^0.7.7"
   },
   "devDependencies": {
     "@jest/globals": "^28.1.3",
     "jest": "^28.1.2",
     "prettier": "^3.2.5",
     "typescript": "^5.6.3",
-    "@atproto/lex-cli": "^0.9.7"
+    "@atproto/lex-cli": "^0.9.8"
   },
   "scripts": {
     "codegen": "node ./scripts/generate-code.mjs && lex gen-api --yes ./src/client ../../lexicons/com/atproto/*/* ../../lexicons/app/bsky/*/* ../../lexicons/chat/bsky/*/* ../../lexicons/tools/ozone/*/*",

package/src/client/index.ts

@@ -27,6 +27,14 @@ import * as AppBskyBookmarkCreateBookmark from './types/app/bsky/bookmark/create
 import * as AppBskyBookmarkDefs from './types/app/bsky/bookmark/defs.js'
 import * as AppBskyBookmarkDeleteBookmark from './types/app/bsky/bookmark/deleteBookmark.js'
 import * as AppBskyBookmarkGetBookmarks from './types/app/bsky/bookmark/getBookmarks.js'
+import * as AppBskyContactDefs from './types/app/bsky/contact/defs.js'
+import * as AppBskyContactDismissMatch from './types/app/bsky/contact/dismissMatch.js'
+import * as AppBskyContactGetMatches from './types/app/bsky/contact/getMatches.js'
+import * as AppBskyContactGetSyncStatus from './types/app/bsky/contact/getSyncStatus.js'
+import * as AppBskyContactImportContacts from './types/app/bsky/contact/importContacts.js'
+import * as AppBskyContactRemoveData from './types/app/bsky/contact/removeData.js'
+import * as AppBskyContactStartPhoneVerification from './types/app/bsky/contact/startPhoneVerification.js'
+import * as AppBskyContactVerifyPhone from './types/app/bsky/contact/verifyPhone.js'
 import * as AppBskyEmbedDefs from './types/app/bsky/embed/defs.js'
 import * as AppBskyEmbedExternal from './types/app/bsky/embed/external.js'
 import * as AppBskyEmbedImages from './types/app/bsky/embed/images.js'
@@ -325,6 +333,14 @@ export * as AppBskyBookmarkCreateBookmark from './types/app/bsky/bookmark/create
 export * as AppBskyBookmarkDefs from './types/app/bsky/bookmark/defs.js'
 export * as AppBskyBookmarkDeleteBookmark from './types/app/bsky/bookmark/deleteBookmark.js'
 export * as AppBskyBookmarkGetBookmarks from './types/app/bsky/bookmark/getBookmarks.js'
+export * as AppBskyContactDefs from './types/app/bsky/contact/defs.js'
+export * as AppBskyContactDismissMatch from './types/app/bsky/contact/dismissMatch.js'
+export * as AppBskyContactGetMatches from './types/app/bsky/contact/getMatches.js'
+export * as AppBskyContactGetSyncStatus from './types/app/bsky/contact/getSyncStatus.js'
+export * as AppBskyContactImportContacts from './types/app/bsky/contact/importContacts.js'
+export * as AppBskyContactRemoveData from './types/app/bsky/contact/removeData.js'
+export * as AppBskyContactStartPhoneVerification from './types/app/bsky/contact/startPhoneVerification.js'
+export * as AppBskyContactVerifyPhone from './types/app/bsky/contact/verifyPhone.js'
 export * as AppBskyEmbedDefs from './types/app/bsky/embed/defs.js'
 export * as AppBskyEmbedExternal from './types/app/bsky/embed/external.js'
 export * as AppBskyEmbedImages from './types/app/bsky/embed/images.js'
@@ -748,6 +764,7 @@ export class AppBskyNS {
   actor: AppBskyActorNS
   ageassurance: AppBskyAgeassuranceNS
   bookmark: AppBskyBookmarkNS
+  contact: AppBskyContactNS
   embed: AppBskyEmbedNS
   feed: AppBskyFeedNS
   graph: AppBskyGraphNS
@@ -762,6 +779,7 @@ export class AppBskyNS {
     this.actor = new AppBskyActorNS(client)
     this.ageassurance = new AppBskyAgeassuranceNS(client)
     this.bookmark = new AppBskyBookmarkNS(client)
+    this.contact = new AppBskyContactNS(client)
     this.embed = new AppBskyEmbedNS(client)
     this.feed = new AppBskyFeedNS(client)
     this.graph = new AppBskyGraphNS(client)
@@ -1122,6 +1140,91 @@ export class AppBskyBookmarkNS {
   }
 }
 
+export class AppBskyContactNS {
+  _client: XrpcClient
+
+  constructor(client: XrpcClient) {
+    this._client = client
+  }
+
+  dismissMatch(
+    data?: AppBskyContactDismissMatch.InputSchema,
+    opts?: AppBskyContactDismissMatch.CallOptions,
+  ): Promise<AppBskyContactDismissMatch.Response> {
+    return this._client
+      .call('app.bsky.contact.dismissMatch', opts?.qp, data, opts)
+      .catch((e) => {
+        throw AppBskyContactDismissMatch.toKnownErr(e)
+      })
+  }
+
+  getMatches(
+    params?: AppBskyContactGetMatches.QueryParams,
+    opts?: AppBskyContactGetMatches.CallOptions,
+  ): Promise<AppBskyContactGetMatches.Response> {
+    return this._client
+      .call('app.bsky.contact.getMatches', params, undefined, opts)
+      .catch((e) => {
+        throw AppBskyContactGetMatches.toKnownErr(e)
+      })
+  }
+
+  getSyncStatus(
+    params?: AppBskyContactGetSyncStatus.QueryParams,
+    opts?: AppBskyContactGetSyncStatus.CallOptions,
+  ): Promise<AppBskyContactGetSyncStatus.Response> {
+    return this._client
+      .call('app.bsky.contact.getSyncStatus', params, undefined, opts)
+      .catch((e) => {
+        throw AppBskyContactGetSyncStatus.toKnownErr(e)
+      })
+  }
+
+  importContacts(
+    data?: AppBskyContactImportContacts.InputSchema,
+    opts?: AppBskyContactImportContacts.CallOptions,
+  ): Promise<AppBskyContactImportContacts.Response> {
+    return this._client
+      .call('app.bsky.contact.importContacts', opts?.qp, data, opts)
+      .catch((e) => {
+        throw AppBskyContactImportContacts.toKnownErr(e)
+      })
+  }
+
+  removeData(
+    data?: AppBskyContactRemoveData.InputSchema,
+    opts?: AppBskyContactRemoveData.CallOptions,
+  ): Promise<AppBskyContactRemoveData.Response> {
+    return this._client
+      .call('app.bsky.contact.removeData', opts?.qp, data, opts)
+      .catch((e) => {
+        throw AppBskyContactRemoveData.toKnownErr(e)
+      })
+  }
+
+  startPhoneVerification(
+    data?: AppBskyContactStartPhoneVerification.InputSchema,
+    opts?: AppBskyContactStartPhoneVerification.CallOptions,
+  ): Promise<AppBskyContactStartPhoneVerification.Response> {
+    return this._client
+      .call('app.bsky.contact.startPhoneVerification', opts?.qp, data, opts)
+      .catch((e) => {
+        throw AppBskyContactStartPhoneVerification.toKnownErr(e)
+      })
+  }
+
+  verifyPhone(
+    data?: AppBskyContactVerifyPhone.InputSchema,
+    opts?: AppBskyContactVerifyPhone.CallOptions,
+  ): Promise<AppBskyContactVerifyPhone.Response> {
+    return this._client
+      .call('app.bsky.contact.verifyPhone', opts?.qp, data, opts)
+      .catch((e) => {
+        throw AppBskyContactVerifyPhone.toKnownErr(e)
+      })
+  }
+}
+
 export class AppBskyEmbedNS {
   _client: XrpcClient
 

package/src/client/lexicons.ts

@@ -1736,6 +1736,348 @@ export const schemaDict = {
       },
     },
   },
+  AppBskyContactDefs: {
+    lexicon: 1,
+    id: 'app.bsky.contact.defs',
+    defs: {
+      matchAndContactIndex: {
+        description:
+          'Associates a profile with the positional index of the contact import input in the call to `app.bsky.contact.importContacts`, so clients can know which phone caused a particular match.',
+        type: 'object',
+        required: ['match', 'contactIndex'],
+        properties: {
+          match: {
+            description: 'Profile of the matched user.',
+            type: 'ref',
+            ref: 'lex:app.bsky.actor.defs#profileView',
+          },
+          contactIndex: {
+            description: 'The index of this match in the import contact input.',
+            type: 'integer',
+            minimum: 0,
+            maximum: 999,
+          },
+        },
+      },
+      syncStatus: {
+        type: 'object',
+        required: ['syncedAt', 'matchesCount'],
+        properties: {
+          syncedAt: {
+            description: 'Last date when contacts where imported.',
+            type: 'string',
+            format: 'datetime',
+          },
+          matchesCount: {
+            description:
+              'Number of existing contact matches resulting of the user imports and of their imported contacts having imported the user. Matches stop being counted when the user either follows the matched contact or dismisses the match.',
+            type: 'integer',
+            minimum: 0,
+          },
+        },
+      },
+    },
+  },
+  AppBskyContactDismissMatch: {
+    lexicon: 1,
+    id: 'app.bsky.contact.dismissMatch',
+    defs: {
+      main: {
+        type: 'procedure',
+        description:
+          "WARNING: This is unstable and under active development, don't use it while this warning is here. Removes a match that was found via contact import. It shouldn't appear again if the same contact is re-imported. Requires authentication.",
+        input: {
+          encoding: 'application/json',
+          schema: {
+            type: 'object',
+            required: ['subject'],
+            properties: {
+              subject: {
+                description: "The subject's DID to dismiss the match with.",
+                type: 'string',
+                format: 'did',
+              },
+            },
+          },
+        },
+        output: {
+          encoding: 'application/json',
+          schema: {
+            type: 'object',
+            properties: {},
+          },
+        },
+        errors: [
+          {
+            name: 'TODO',
+            description: 'TODO',
+          },
+        ],
+      },
+    },
+  },
+  AppBskyContactGetMatches: {
+    lexicon: 1,
+    id: 'app.bsky.contact.getMatches',
+    defs: {
+      main: {
+        type: 'query',
+        description:
+          "WARNING: This is unstable and under active development, don't use it while this warning is here. Returns the matched contacts (contacts that were mutually imported). Excludes dismissed matches. Requires authentication.",
+        parameters: {
+          type: 'params',
+          properties: {
+            limit: {
+              type: 'integer',
+              minimum: 1,
+              maximum: 100,
+              default: 50,
+            },
+            cursor: {
+              type: 'string',
+            },
+          },
+        },
+        output: {
+          encoding: 'application/json',
+          schema: {
+            type: 'object',
+            required: ['matches'],
+            properties: {
+              cursor: {
+                type: 'string',
+              },
+              matches: {
+                type: 'array',
+                items: {
+                  type: 'ref',
+                  ref: 'lex:app.bsky.actor.defs#profileView',
+                },
+              },
+            },
+          },
+        },
+        errors: [
+          {
+            name: 'TODO',
+            description: 'TODO',
+          },
+        ],
+      },
+    },
+  },
+  AppBskyContactGetSyncStatus: {
+    lexicon: 1,
+    id: 'app.bsky.contact.getSyncStatus',
+    defs: {
+      main: {
+        type: 'query',
+        description:
+          "WARNING: This is unstable and under active development, don't use it while this warning is here. Gets the user's current contact import status. Requires authentication.",
+        parameters: {
+          type: 'params',
+          properties: {},
+        },
+        output: {
+          encoding: 'application/json',
+          schema: {
+            type: 'object',
+            properties: {
+              syncStatus: {
+                description:
+                  "If present, indicates the user has imported their contacts. If not present, indicates the user never used the feature or called `app.bsky.contact.removeData` and didn't import again since.",
+                type: 'ref',
+                ref: 'lex:app.bsky.contact.defs#syncStatus',
+              },
+            },
+          },
+        },
+        errors: [
+          {
+            name: 'TODO',
+            description: 'TODO',
+          },
+        ],
+      },
+    },
+  },
+  AppBskyContactImportContacts: {
+    lexicon: 1,
+    id: 'app.bsky.contact.importContacts',
+    defs: {
+      main: {
+        type: 'procedure',
+        description:
+          "WARNING: This is unstable and under active development, don't use it while this warning is here. Import contacts for securely matching with other users. This follows the protocol explained in https://docs.bsky.app/blog/contact-import-rfc. Requires authentication.",
+        input: {
+          encoding: 'application/json',
+          schema: {
+            type: 'object',
+            required: ['token', 'contacts'],
+            properties: {
+              token: {
+                description:
+                  'JWT to authenticate the call. Use the JWT received as a response to the call to `app.bsky.contact.verifyPhone`.',
+                type: 'string',
+              },
+              contacts: {
+                description:
+                  "List of phone numbers in global E.164 format (e.g., '+12125550123'). Phone numbers that cannot be normalized into a valid phone number will be discarded. Should not repeat the 'phone' input used in `app.bsky.contact.verifyPhone`.",
+                type: 'array',
+                items: {
+                  type: 'string',
+                },
+                minLength: 1,
+                maxLength: 1000,
+              },
+            },
+          },
+        },
+        output: {
+          encoding: 'application/json',
+          schema: {
+            type: 'object',
+            required: ['matchesAndContactIndexes'],
+            properties: {
+              matchesAndContactIndexes: {
+                description:
+                  'The users that matched during import and their indexes on the input contacts, so the client can correlate with its local list.',
+                type: 'array',
+                items: {
+                  type: 'ref',
+                  ref: 'lex:app.bsky.contact.defs#matchAndContactIndex',
+                },
+              },
+            },
+          },
+        },
+        errors: [
+          {
+            name: 'TODO',
+            description: 'TODO',
+          },
+        ],
+      },
+    },
+  },
+  AppBskyContactRemoveData: {
+    lexicon: 1,
+    id: 'app.bsky.contact.removeData',
+    defs: {
+      main: {
+        type: 'procedure',
+        description:
+          "WARNING: This is unstable and under active development, don't use it while this warning is here. Removes all stored hashes used for contact matching, existing matches, and sync status. Requires authentication.",
+        input: {
+          encoding: 'application/json',
+          schema: {
+            type: 'object',
+            properties: {},
+          },
+        },
+        output: {
+          encoding: 'application/json',
+          schema: {
+            type: 'object',
+            properties: {},
+          },
+        },
+        errors: [
+          {
+            name: 'TODO',
+            description: 'TODO',
+          },
+        ],
+      },
+    },
+  },
+  AppBskyContactStartPhoneVerification: {
+    lexicon: 1,
+    id: 'app.bsky.contact.startPhoneVerification',
+    defs: {
+      main: {
+        type: 'procedure',
+        description:
+          "WARNING: This is unstable and under active development, don't use it while this warning is here. Starts a phone verification flow. The phone passed will receive a code via SMS that should be passed to `app.bsky.contact.verifyPhone`. Requires authentication.",
+        input: {
+          encoding: 'application/json',
+          schema: {
+            type: 'object',
+            required: ['phone'],
+            properties: {
+              phone: {
+                description: 'The phone number to receive the code via SMS.',
+                type: 'string',
+              },
+            },
+          },
+        },
+        output: {
+          encoding: 'application/json',
+          schema: {
+            type: 'object',
+            properties: {},
+          },
+        },
+        errors: [
+          {
+            name: 'TODO',
+            description: 'TODO',
+          },
+        ],
+      },
+    },
+  },
+  AppBskyContactVerifyPhone: {
+    lexicon: 1,
+    id: 'app.bsky.contact.verifyPhone',
+    defs: {
+      main: {
+        type: 'procedure',
+        description:
+          "WARNING: This is unstable and under active development, don't use it while this warning is here. Verifies control over a phone number with a code received via SMS and starts a contact import session. Requires authentication.",
+        input: {
+          encoding: 'application/json',
+          schema: {
+            type: 'object',
+            required: ['phone', 'code'],
+            properties: {
+              phone: {
+                description:
+                  'The phone number to verify. Should be the same as the one passed to `app.bsky.contact.startPhoneVerification`.',
+                type: 'string',
+              },
+              code: {
+                description:
+                  'The code received via SMS as a result of the call to `app.bsky.contact.startPhoneVerification`.',
+                type: 'string',
+              },
+            },
+          },
+        },
+        output: {
+          encoding: 'application/json',
+          schema: {
+            type: 'object',
+            required: ['token'],
+            properties: {
+              token: {
+                description:
+                  'JWT to be used in a call to `app.bsky.contact.importContacts`. It is only valid for a single call.',
+                type: 'string',
+              },
+            },
+          },
+        },
+        errors: [
+          {
+            name: 'TODO',
+            description: 'TODO',
+          },
+        ],
+      },
+    },
+  },
   AppBskyEmbedDefs: {
     lexicon: 1,
     id: 'app.bsky.embed.defs',
@@ -4461,6 +4803,30 @@ export const schemaDict = {
             description:
               'if the actor is followed by this DID, contains the AT-URI of the follow record',
           },
+          blocking: {
+            type: 'string',
+            format: 'at-uri',
+            description:
+              'if the actor blocks this DID, this is the AT-URI of the block record',
+          },
+          blockedBy: {
+            type: 'string',
+            format: 'at-uri',
+            description:
+              'if the actor is blocked by this DID, contains the AT-URI of the block record',
+          },
+          blockingByList: {
+            type: 'string',
+            format: 'at-uri',
+            description:
+              'if the actor blocks this DID via a block list, this is the AT-URI of the listblock record',
+          },
+          blockedByList: {
+            type: 'string',
+            format: 'at-uri',
+            description:
+              'if the actor is blocked by this DID via a block list, contains the AT-URI of the listblock record',
+          },
         },
       },
     },
@@ -15485,6 +15851,7 @@ export const schemaDict = {
           },
           comment: {
             type: 'string',
+            minLength: 1,
             description: 'Comment describing the reason for the override.',
           },
         },
@@ -15496,6 +15863,7 @@ export const schemaDict = {
         required: ['comment'],
         properties: {
           comment: {
+            minLength: 1,
             type: 'string',
             description: 'Comment describing the reason for the revocation.',
           },
@@ -19575,6 +19943,15 @@ export const ids = {
   AppBskyBookmarkDefs: 'app.bsky.bookmark.defs',
   AppBskyBookmarkDeleteBookmark: 'app.bsky.bookmark.deleteBookmark',
   AppBskyBookmarkGetBookmarks: 'app.bsky.bookmark.getBookmarks',
+  AppBskyContactDefs: 'app.bsky.contact.defs',
+  AppBskyContactDismissMatch: 'app.bsky.contact.dismissMatch',
+  AppBskyContactGetMatches: 'app.bsky.contact.getMatches',
+  AppBskyContactGetSyncStatus: 'app.bsky.contact.getSyncStatus',
+  AppBskyContactImportContacts: 'app.bsky.contact.importContacts',
+  AppBskyContactRemoveData: 'app.bsky.contact.removeData',
+  AppBskyContactStartPhoneVerification:
+    'app.bsky.contact.startPhoneVerification',
+  AppBskyContactVerifyPhone: 'app.bsky.contact.verifyPhone',
   AppBskyEmbedDefs: 'app.bsky.embed.defs',
   AppBskyEmbedExternal: 'app.bsky.embed.external',
   AppBskyEmbedImages: 'app.bsky.embed.images',

package/src/client/types/app/bsky/contact/defs.ts

@@ -0,0 +1,52 @@
+/**
+ * GENERATED CODE - DO NOT MODIFY
+ */
+import { type ValidationResult, BlobRef } from '@atproto/lexicon'
+import { CID } from 'multiformats/cid'
+import { validate as _validate } from '../../../../lexicons'
+import {
+  type $Typed,
+  is$typed as _is$typed,
+  type OmitKey,
+} from '../../../../util'
+import type * as AppBskyActorDefs from '../actor/defs.js'
+
+const is$typed = _is$typed,
+  validate = _validate
+const id = 'app.bsky.contact.defs'
+
+/** Associates a profile with the positional index of the contact import input in the call to `app.bsky.contact.importContacts`, so clients can know which phone caused a particular match. */
+export interface MatchAndContactIndex {
+  $type?: 'app.bsky.contact.defs#matchAndContactIndex'
+  match: AppBskyActorDefs.ProfileView
+  /** The index of this match in the import contact input. */
+  contactIndex: number
+}
+
+const hashMatchAndContactIndex = 'matchAndContactIndex'
+
+export function isMatchAndContactIndex<V>(v: V) {
+  return is$typed(v, id, hashMatchAndContactIndex)
+}
+
+export function validateMatchAndContactIndex<V>(v: V) {
+  return validate<MatchAndContactIndex & V>(v, id, hashMatchAndContactIndex)
+}
+
+export interface SyncStatus {
+  $type?: 'app.bsky.contact.defs#syncStatus'
+  /** Last date when contacts where imported. */
+  syncedAt: string
+  /** Number of existing contact matches resulting of the user imports and of their imported contacts having imported the user. Matches stop being counted when the user either follows the matched contact or dismisses the match. */
+  matchesCount: number
+}
+
+const hashSyncStatus = 'syncStatus'
+
+export function isSyncStatus<V>(v: V) {
+  return is$typed(v, id, hashSyncStatus)
+}
+
+export function validateSyncStatus<V>(v: V) {
+  return validate<SyncStatus & V>(v, id, hashSyncStatus)
+}

package/src/client/types/app/bsky/contact/dismissMatch.ts

@@ -0,0 +1,52 @@
+/**
+ * GENERATED CODE - DO NOT MODIFY
+ */
+import { HeadersMap, XRPCError } from '@atproto/xrpc'
+import { type ValidationResult, BlobRef } from '@atproto/lexicon'
+import { CID } from 'multiformats/cid'
+import { validate as _validate } from '../../../../lexicons'
+import {
+  type $Typed,
+  is$typed as _is$typed,
+  type OmitKey,
+} from '../../../../util'
+
+const is$typed = _is$typed,
+  validate = _validate
+const id = 'app.bsky.contact.dismissMatch'
+
+export type QueryParams = {}
+
+export interface InputSchema {
+  /** The subject's DID to dismiss the match with. */
+  subject: string
+}
+
+export interface OutputSchema {}
+
+export interface CallOptions {
+  signal?: AbortSignal
+  headers?: HeadersMap
+  qp?: QueryParams
+  encoding?: 'application/json'
+}
+
+export interface Response {
+  success: boolean
+  headers: HeadersMap
+  data: OutputSchema
+}
+
+export class TODOError extends XRPCError {
+  constructor(src: XRPCError) {
+    super(src.status, src.error, src.message, src.headers, { cause: src })
+  }
+}
+
+export function toKnownErr(e: any) {
+  if (e instanceof XRPCError) {
+    if (e.error === 'TODO') return new TODOError(e)
+  }
+
+  return e
+}