@atproto/api 0.2.3 → 0.2.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atproto/api",
-  "version": "0.2.3",
+  "version": "0.2.5",
   "main": "dist/index.js",
   "scripts": {
     "codegen": "lex gen-api ./src/client ../../lexicons/com/atproto/*/* ../../lexicons/app/bsky/*/*",

package/src/client/index.ts

@@ -8,6 +8,8 @@ import {
 import { schemas } from './lexicons'
 import { CID } from 'multiformats/cid'
 import * as ComAtprotoAdminDefs from './types/com/atproto/admin/defs'
+import * as ComAtprotoAdminDisableInviteCodes from './types/com/atproto/admin/disableInviteCodes'
+import * as ComAtprotoAdminGetInviteCodes from './types/com/atproto/admin/getInviteCodes'
 import * as ComAtprotoAdminGetModerationAction from './types/com/atproto/admin/getModerationAction'
 import * as ComAtprotoAdminGetModerationActions from './types/com/atproto/admin/getModerationActions'
 import * as ComAtprotoAdminGetModerationReport from './types/com/atproto/admin/getModerationReport'
@@ -34,9 +36,11 @@ import * as ComAtprotoRepoUploadBlob from './types/com/atproto/repo/uploadBlob'
 import * as ComAtprotoServerCreateAccount from './types/com/atproto/server/createAccount'
 import * as ComAtprotoServerCreateInviteCode from './types/com/atproto/server/createInviteCode'
 import * as ComAtprotoServerCreateSession from './types/com/atproto/server/createSession'
+import * as ComAtprotoServerDefs from './types/com/atproto/server/defs'
 import * as ComAtprotoServerDeleteAccount from './types/com/atproto/server/deleteAccount'
 import * as ComAtprotoServerDeleteSession from './types/com/atproto/server/deleteSession'
 import * as ComAtprotoServerDescribeServer from './types/com/atproto/server/describeServer'
+import * as ComAtprotoServerGetAccountInviteCodes from './types/com/atproto/server/getAccountInviteCodes'
 import * as ComAtprotoServerGetSession from './types/com/atproto/server/getSession'
 import * as ComAtprotoServerRefreshSession from './types/com/atproto/server/refreshSession'
 import * as ComAtprotoServerRequestAccountDelete from './types/com/atproto/server/requestAccountDelete'
@@ -86,6 +90,8 @@ import * as AppBskyRichtextFacet from './types/app/bsky/richtext/facet'
 import * as AppBskyUnspeccedGetPopular from './types/app/bsky/unspecced/getPopular'
 
 export * as ComAtprotoAdminDefs from './types/com/atproto/admin/defs'
+export * as ComAtprotoAdminDisableInviteCodes from './types/com/atproto/admin/disableInviteCodes'
+export * as ComAtprotoAdminGetInviteCodes from './types/com/atproto/admin/getInviteCodes'
 export * as ComAtprotoAdminGetModerationAction from './types/com/atproto/admin/getModerationAction'
 export * as ComAtprotoAdminGetModerationActions from './types/com/atproto/admin/getModerationActions'
 export * as ComAtprotoAdminGetModerationReport from './types/com/atproto/admin/getModerationReport'
@@ -112,9 +118,11 @@ export * as ComAtprotoRepoUploadBlob from './types/com/atproto/repo/uploadBlob'
 export * as ComAtprotoServerCreateAccount from './types/com/atproto/server/createAccount'
 export * as ComAtprotoServerCreateInviteCode from './types/com/atproto/server/createInviteCode'
 export * as ComAtprotoServerCreateSession from './types/com/atproto/server/createSession'
+export * as ComAtprotoServerDefs from './types/com/atproto/server/defs'
 export * as ComAtprotoServerDeleteAccount from './types/com/atproto/server/deleteAccount'
 export * as ComAtprotoServerDeleteSession from './types/com/atproto/server/deleteSession'
 export * as ComAtprotoServerDescribeServer from './types/com/atproto/server/describeServer'
+export * as ComAtprotoServerGetAccountInviteCodes from './types/com/atproto/server/getAccountInviteCodes'
 export * as ComAtprotoServerGetSession from './types/com/atproto/server/getSession'
 export * as ComAtprotoServerRefreshSession from './types/com/atproto/server/refreshSession'
 export * as ComAtprotoServerRequestAccountDelete from './types/com/atproto/server/requestAccountDelete'
@@ -240,6 +248,28 @@ export class AdminNS {
     this._service = service
   }
 
+  disableInviteCodes(
+    data?: ComAtprotoAdminDisableInviteCodes.InputSchema,
+    opts?: ComAtprotoAdminDisableInviteCodes.CallOptions,
+  ): Promise<ComAtprotoAdminDisableInviteCodes.Response> {
+    return this._service.xrpc
+      .call('com.atproto.admin.disableInviteCodes', opts?.qp, data, opts)
+      .catch((e) => {
+        throw ComAtprotoAdminDisableInviteCodes.toKnownErr(e)
+      })
+  }
+
+  getInviteCodes(
+    params?: ComAtprotoAdminGetInviteCodes.QueryParams,
+    opts?: ComAtprotoAdminGetInviteCodes.CallOptions,
+  ): Promise<ComAtprotoAdminGetInviteCodes.Response> {
+    return this._service.xrpc
+      .call('com.atproto.admin.getInviteCodes', params, undefined, opts)
+      .catch((e) => {
+        throw ComAtprotoAdminGetInviteCodes.toKnownErr(e)
+      })
+  }
+
   getModerationAction(
     params?: ComAtprotoAdminGetModerationAction.QueryParams,
     opts?: ComAtprotoAdminGetModerationAction.CallOptions,
@@ -569,6 +599,17 @@ export class ServerNS {
       })
   }
 
+  getAccountInviteCodes(
+    params?: ComAtprotoServerGetAccountInviteCodes.QueryParams,
+    opts?: ComAtprotoServerGetAccountInviteCodes.CallOptions,
+  ): Promise<ComAtprotoServerGetAccountInviteCodes.Response> {
+    return this._service.xrpc
+      .call('com.atproto.server.getAccountInviteCodes', params, undefined, opts)
+      .catch((e) => {
+        throw ComAtprotoServerGetAccountInviteCodes.toKnownErr(e)
+      })
+  }
+
   getSession(
     params?: ComAtprotoServerGetSession.QueryParams,
     opts?: ComAtprotoServerGetSession.CallOptions,

package/src/client/lexicons.ts

@@ -299,6 +299,17 @@ export const schemaDict = {
             type: 'ref',
             ref: 'lex:com.atproto.admin.defs#moderation',
           },
+          invitedBy: {
+            type: 'ref',
+            ref: 'lex:com.atproto.server.defs#inviteCode',
+          },
+          invites: {
+            type: 'array',
+            items: {
+              type: 'ref',
+              ref: 'lex:com.atproto.server.defs#inviteCode',
+            },
+          },
         },
       },
       repoViewDetail: {
@@ -336,6 +347,17 @@ export const schemaDict = {
             type: 'ref',
             ref: 'lex:com.atproto.admin.defs#moderationDetail',
           },
+          invitedBy: {
+            type: 'ref',
+            ref: 'lex:com.atproto.server.defs#inviteCode',
+          },
+          invites: {
+            type: 'array',
+            items: {
+              type: 'ref',
+              ref: 'lex:com.atproto.server.defs#inviteCode',
+            },
+          },
         },
       },
       repoRef: {
@@ -530,6 +552,85 @@ export const schemaDict = {
       },
     },
   },
+  ComAtprotoAdminDisableInviteCodes: {
+    lexicon: 1,
+    id: 'com.atproto.admin.disableInviteCodes',
+    defs: {
+      main: {
+        type: 'procedure',
+        description:
+          'Disable some set of codes and/or all codes associated with a set of users',
+        input: {
+          encoding: 'application/json',
+          schema: {
+            type: 'object',
+            properties: {
+              codes: {
+                type: 'array',
+                items: {
+                  type: 'string',
+                },
+              },
+              accounts: {
+                type: 'array',
+                items: {
+                  type: 'string',
+                },
+              },
+            },
+          },
+        },
+      },
+    },
+  },
+  ComAtprotoAdminGetInviteCodes: {
+    lexicon: 1,
+    id: 'com.atproto.admin.getInviteCodes',
+    defs: {
+      main: {
+        type: 'query',
+        description: 'Admin view of invite codes',
+        parameters: {
+          type: 'params',
+          properties: {
+            sort: {
+              type: 'string',
+              knownValues: ['recent', 'usage'],
+              default: 'recent',
+            },
+            limit: {
+              type: 'integer',
+              minimum: 1,
+              maximum: 500,
+              default: 100,
+            },
+            cursor: {
+              type: 'string',
+            },
+          },
+        },
+        output: {
+          encoding: 'application/json',
+          schema: {
+            type: 'object',
+            required: ['codes'],
+            properties: {
+              cursor: {
+                type: 'string',
+              },
+              codes: {
+                type: 'array',
+                items: {
+                  type: 'ref',
+                  ref: 'lex:com.atproto.server.defs#inviteCode',
+                },
+              },
+            },
+          },
+        },
+      },
+    },
+  },
   ComAtprotoAdminGetModerationAction: {
     lexicon: 1,
     id: 'com.atproto.admin.getModerationAction',
@@ -823,6 +924,9 @@ export const schemaDict = {
             term: {
               type: 'string',
             },
+            invitedBy: {
+              type: 'string',
+            },
             limit: {
               type: 'integer',
               minimum: 1,
@@ -1701,6 +1805,10 @@ export const schemaDict = {
               useCount: {
                 type: 'integer',
               },
+              forAccount: {
+                type: 'string',
+                format: 'did',
+              },
             },
           },
         },
@@ -1777,6 +1885,66 @@ export const schemaDict = {
       },
     },
   },
+  ComAtprotoServerDefs: {
+    lexicon: 1,
+    id: 'com.atproto.server.defs',
+    defs: {
+      inviteCode: {
+        type: 'object',
+        required: [
+          'code',
+          'available',
+          'disabled',
+          'forAccount',
+          'createdBy',
+          'createdAt',
+          'uses',
+        ],
+        properties: {
+          code: {
+            type: 'string',
+          },
+          available: {
+            type: 'integer',
+          },
+          disabled: {
+            type: 'boolean',
+          },
+          forAccount: {
+            type: 'string',
+          },
+          createdBy: {
+            type: 'string',
+          },
+          createdAt: {
+            type: 'string',
+            format: 'datetime',
+          },
+          uses: {
+            type: 'array',
+            items: {
+              type: 'ref',
+              ref: 'lex:com.atproto.server.defs#inviteCodeUse',
+            },
+          },
+        },
+      },
+      inviteCodeUse: {
+        type: 'object',
+        required: ['usedBy', 'usedAt'],
+        properties: {
+          usedBy: {
+            type: 'string',
+            format: 'did',
+          },
+          usedAt: {
+            type: 'string',
+            format: 'datetime',
+          },
+        },
+      },
+    },
+  },
   ComAtprotoServerDeleteAccount: {
     lexicon: 1,
     id: 'com.atproto.server.deleteAccount',
@@ -1868,6 +2036,50 @@ export const schemaDict = {
       },
     },
   },
+  ComAtprotoServerGetAccountInviteCodes: {
+    lexicon: 1,
+    id: 'com.atproto.server.getAccountInviteCodes',
+    defs: {
+      main: {
+        type: 'query',
+        description: 'Get all invite codes for a given account',
+        parameters: {
+          type: 'params',
+          properties: {
+            includeUsed: {
+              type: 'boolean',
+              default: true,
+            },
+            createAvailable: {
+              type: 'boolean',
+              default: true,
+            },
+          },
+        },
+        output: {
+          encoding: 'application/json',
+          schema: {
+            type: 'object',
+            required: ['codes'],
+            properties: {
+              codes: {
+                type: 'array',
+                items: {
+                  type: 'ref',
+                  ref: 'lex:com.atproto.server.defs#inviteCode',
+                },
+              },
+            },
+          },
+        },
+        errors: [
+          {
+            name: 'DuplicateCreate',
+          },
+        ],
+      },
+    },
+  },
   ComAtprotoServerGetSession: {
     lexicon: 1,
     id: 'com.atproto.server.getSession',
@@ -4174,6 +4386,8 @@ export const schemas: LexiconDoc[] = Object.values(schemaDict) as LexiconDoc[]
 export const lexicons: Lexicons = new Lexicons(schemas)
 export const ids = {
   ComAtprotoAdminDefs: 'com.atproto.admin.defs',
+  ComAtprotoAdminDisableInviteCodes: 'com.atproto.admin.disableInviteCodes',
+  ComAtprotoAdminGetInviteCodes: 'com.atproto.admin.getInviteCodes',
   ComAtprotoAdminGetModerationAction: 'com.atproto.admin.getModerationAction',
   ComAtprotoAdminGetModerationActions: 'com.atproto.admin.getModerationActions',
   ComAtprotoAdminGetModerationReport: 'com.atproto.admin.getModerationReport',
@@ -4202,9 +4416,12 @@ export const ids = {
   ComAtprotoServerCreateAccount: 'com.atproto.server.createAccount',
   ComAtprotoServerCreateInviteCode: 'com.atproto.server.createInviteCode',
   ComAtprotoServerCreateSession: 'com.atproto.server.createSession',
+  ComAtprotoServerDefs: 'com.atproto.server.defs',
   ComAtprotoServerDeleteAccount: 'com.atproto.server.deleteAccount',
   ComAtprotoServerDeleteSession: 'com.atproto.server.deleteSession',
   ComAtprotoServerDescribeServer: 'com.atproto.server.describeServer',
+  ComAtprotoServerGetAccountInviteCodes:
+    'com.atproto.server.getAccountInviteCodes',
   ComAtprotoServerGetSession: 'com.atproto.server.getSession',
   ComAtprotoServerRefreshSession: 'com.atproto.server.refreshSession',
   ComAtprotoServerRequestAccountDelete:

package/src/client/types/com/atproto/admin/defs.ts

@@ -7,6 +7,7 @@ import { lexicons } from '../../../../lexicons'
 import { CID } from 'multiformats/cid'
 import * as ComAtprotoRepoStrongRef from '../repo/strongRef'
 import * as ComAtprotoModerationDefs from '../moderation/defs'
+import * as ComAtprotoServerDefs from '../server/defs'
 
 export interface ActionView {
   id: number
@@ -167,6 +168,8 @@ export interface RepoView {
   relatedRecords: {}[]
   indexedAt: string
   moderation: Moderation
+  invitedBy?: ComAtprotoServerDefs.InviteCode
+  invites?: ComAtprotoServerDefs.InviteCode[]
   [k: string]: unknown
 }
 
@@ -189,6 +192,8 @@ export interface RepoViewDetail {
   relatedRecords: {}[]
   indexedAt: string
   moderation: ModerationDetail
+  invitedBy?: ComAtprotoServerDefs.InviteCode
+  invites?: ComAtprotoServerDefs.InviteCode[]
   [k: string]: unknown
 }
 

package/src/client/types/com/atproto/admin/disableInviteCodes.ts

@@ -0,0 +1,33 @@
+/**
+ * GENERATED CODE - DO NOT MODIFY
+ */
+import { Headers, XRPCError } from '@atproto/xrpc'
+import { ValidationResult, BlobRef } from '@atproto/lexicon'
+import { isObj, hasProp } from '../../../../util'
+import { lexicons } from '../../../../lexicons'
+import { CID } from 'multiformats/cid'
+
+export interface QueryParams {}
+
+export interface InputSchema {
+  codes?: string[]
+  accounts?: string[]
+  [k: string]: unknown
+}
+
+export interface CallOptions {
+  headers?: Headers
+  qp?: QueryParams
+  encoding: 'application/json'
+}
+
+export interface Response {
+  success: boolean
+  headers: Headers
+}
+
+export function toKnownErr(e: any) {
+  if (e instanceof XRPCError) {
+  }
+  return e
+}

package/src/client/types/com/atproto/admin/getInviteCodes.ts

@@ -0,0 +1,39 @@
+/**
+ * GENERATED CODE - DO NOT MODIFY
+ */
+import { Headers, XRPCError } from '@atproto/xrpc'
+import { ValidationResult, BlobRef } from '@atproto/lexicon'
+import { isObj, hasProp } from '../../../../util'
+import { lexicons } from '../../../../lexicons'
+import { CID } from 'multiformats/cid'
+import * as ComAtprotoServerDefs from '../server/defs'
+
+export interface QueryParams {
+  sort?: 'recent' | 'usage' | (string & {})
+  limit?: number
+  cursor?: string
+}
+
+export type InputSchema = undefined
+
+export interface OutputSchema {
+  cursor?: string
+  codes: ComAtprotoServerDefs.InviteCode[]
+  [k: string]: unknown
+}
+
+export interface CallOptions {
+  headers?: Headers
+}
+
+export interface Response {
+  success: boolean
+  headers: Headers
+  data: OutputSchema
+}
+
+export function toKnownErr(e: any) {
+  if (e instanceof XRPCError) {
+  }
+  return e
+}

package/src/client/types/com/atproto/admin/searchRepos.ts

@@ -10,6 +10,7 @@ import * as ComAtprotoAdminDefs from './defs'
 
 export interface QueryParams {
   term?: string
+  invitedBy?: string
   limit?: number
   cursor?: string
 }

package/src/client/types/com/atproto/server/createInviteCode.ts

@@ -11,6 +11,7 @@ export interface QueryParams {}
 
 export interface InputSchema {
   useCount: number
+  forAccount?: string
   [k: string]: unknown
 }
 

package/src/client/types/com/atproto/server/defs.ts

@@ -0,0 +1,48 @@
+/**
+ * GENERATED CODE - DO NOT MODIFY
+ */
+import { ValidationResult, BlobRef } from '@atproto/lexicon'
+import { isObj, hasProp } from '../../../../util'
+import { lexicons } from '../../../../lexicons'
+import { CID } from 'multiformats/cid'
+
+export interface InviteCode {
+  code: string
+  available: number
+  disabled: boolean
+  forAccount: string
+  createdBy: string
+  createdAt: string
+  uses: InviteCodeUse[]
+  [k: string]: unknown
+}
+
+export function isInviteCode(v: unknown): v is InviteCode {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'com.atproto.server.defs#inviteCode'
+  )
+}
+
+export function validateInviteCode(v: unknown): ValidationResult {
+  return lexicons.validate('com.atproto.server.defs#inviteCode', v)
+}
+
+export interface InviteCodeUse {
+  usedBy: string
+  usedAt: string
+  [k: string]: unknown
+}
+
+export function isInviteCodeUse(v: unknown): v is InviteCodeUse {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'com.atproto.server.defs#inviteCodeUse'
+  )
+}
+
+export function validateInviteCodeUse(v: unknown): ValidationResult {
+  return lexicons.validate('com.atproto.server.defs#inviteCodeUse', v)
+}

package/src/client/types/com/atproto/server/getAccountInviteCodes.ts

@@ -0,0 +1,44 @@
+/**
+ * GENERATED CODE - DO NOT MODIFY
+ */
+import { Headers, XRPCError } from '@atproto/xrpc'
+import { ValidationResult, BlobRef } from '@atproto/lexicon'
+import { isObj, hasProp } from '../../../../util'
+import { lexicons } from '../../../../lexicons'
+import { CID } from 'multiformats/cid'
+import * as ComAtprotoServerDefs from './defs'
+
+export interface QueryParams {
+  includeUsed?: boolean
+  createAvailable?: boolean
+}
+
+export type InputSchema = undefined
+
+export interface OutputSchema {
+  codes: ComAtprotoServerDefs.InviteCode[]
+  [k: string]: unknown
+}
+
+export interface CallOptions {
+  headers?: Headers
+}
+
+export interface Response {
+  success: boolean
+  headers: Headers
+  data: OutputSchema
+}
+
+export class DuplicateCreateError extends XRPCError {
+  constructor(src: XRPCError) {
+    super(src.status, src.error, src.message)
+  }
+}
+
+export function toKnownErr(e: any) {
+  if (e instanceof XRPCError) {
+    if (e.error === 'DuplicateCreate') return new DuplicateCreateError(e)
+  }
+  return e
+}