@atcute/client 3.1.0 → 4.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/lib/lexicons.ts DELETED
@@ -1,2204 +0,0 @@
1
- /* eslint-disable */
2
- // This file is automatically generated, do not edit!
3
-
4
- /**
5
- * @module
6
- * Contains type declarations for AT Protocol lexicons
7
- */
8
-
9
- type ObjectOmit<T, K extends keyof any> = Omit<T, K>;
10
-
11
- /** handles type branding in objects */
12
- export declare namespace Brand {
13
- /** Symbol used to brand objects, this does not actually exist in runtime */
14
- const Type: unique symbol;
15
-
16
- /** Get the intended `$type` field */
17
- type GetType<T extends { [Type]?: string }> = NonNullable<T[typeof Type]>;
18
-
19
- /** Creates a union of objects where it's discriminated by `$type` field. */
20
- type Union<T extends { [Type]?: string }> = T extends any ? T & { $type: GetType<T> } : never;
21
-
22
- /** Omits the type branding from object */
23
- type Omit<T extends { [Type]?: string }> = ObjectOmit<T, typeof Type>;
24
- }
25
-
26
- /** base AT Protocol schema types */
27
- export declare namespace At {
28
- /**
29
- * represents a Content Identifier (CID) string
30
- */
31
- type Cid = string;
32
-
33
- /**
34
- * represents a Decentralized Identifier (DID).
35
- */
36
- type Did<Method extends string = string> = `did:${Method}:${string}`;
37
-
38
- /**
39
- * represents an account's handle, using domains as a human-friendly
40
- * identifier.
41
- */
42
- type Handle = `${string}.${string}`;
43
-
44
- /**
45
- * represents an account's identifier, either a {@link Did} or a
46
- * {@link Handle}
47
- */
48
- type Identifier = Did | Handle;
49
-
50
- /**
51
- * represents a Namespace Identifier (NSID)
52
- */
53
- type Nsid = `${string}.${string}.${string}`;
54
-
55
- /**
56
- * represents the unique key identifying a specific record within a
57
- * repository's collection. this is usually a {@link Tid}.
58
- */
59
- type RecordKey = string;
60
-
61
- /**
62
- * represents a Timestamp Identifier (TID)
63
- */
64
- type Tid = string;
65
-
66
- /**
67
- * represents a general AT Protocol URI, representing either an entire
68
- * repository, a specific collection within a repository, or a record.
69
- *
70
- * it allows using handles over DIDs, but this means that it won't be stable.
71
- */
72
- type ResourceUri =
73
- | `at://${Identifier}`
74
- | `at://${Identifier}/${Nsid}`
75
- | `at://${Identifier}/${Nsid}/${RecordKey}`;
76
-
77
- /**
78
- * represents a canonical AT Protocol URI for a specific record.
79
- *
80
- * this URI format uses the account's DID as the authority, ensuring that
81
- * the URI remains valid even as the account changes handles, uniquely
82
- * identifying a specific piece of record within AT Protocol.
83
- */
84
- type CanonicalResourceUri = `at://${Did}/${Nsid}/${RecordKey}`;
85
-
86
- /**
87
- * represents a generic URI
88
- */
89
- type GenericUri = `${string}:${string}`;
90
-
91
- /**
92
- * represents a Content Identifier (CID) reference
93
- */
94
- interface CidLink {
95
- $link: Cid;
96
- }
97
-
98
- /**
99
- * represents an object containing raw binary data encoded as a base64 string
100
- */
101
- interface Bytes {
102
- $bytes: string;
103
- }
104
-
105
- /**
106
- * represents a reference to a data blob
107
- */
108
- interface Blob<T extends string = string> {
109
- $type: 'blob';
110
- mimeType: T;
111
- ref: {
112
- $link: string;
113
- };
114
- size: number;
115
- }
116
- }
117
- export declare namespace ComAtprotoAdminDefs {
118
- interface AccountView {
119
- [Brand.Type]?: 'com.atproto.admin.defs#accountView';
120
- did: At.Did;
121
- handle: At.Handle;
122
- indexedAt: string;
123
- deactivatedAt?: string;
124
- email?: string;
125
- emailConfirmedAt?: string;
126
- invitedBy?: ComAtprotoServerDefs.InviteCode;
127
- inviteNote?: string;
128
- invites?: ComAtprotoServerDefs.InviteCode[];
129
- invitesDisabled?: boolean;
130
- relatedRecords?: unknown[];
131
- threatSignatures?: ThreatSignature[];
132
- }
133
- interface RepoBlobRef {
134
- [Brand.Type]?: 'com.atproto.admin.defs#repoBlobRef';
135
- cid: At.Cid;
136
- did: At.Did;
137
- recordUri?: At.ResourceUri;
138
- }
139
- interface RepoRef {
140
- [Brand.Type]?: 'com.atproto.admin.defs#repoRef';
141
- did: At.Did;
142
- }
143
- interface StatusAttr {
144
- [Brand.Type]?: 'com.atproto.admin.defs#statusAttr';
145
- applied: boolean;
146
- ref?: string;
147
- }
148
- interface ThreatSignature {
149
- [Brand.Type]?: 'com.atproto.admin.defs#threatSignature';
150
- property: string;
151
- value: string;
152
- }
153
- }
154
-
155
- /** Delete a user account as an administrator. */
156
- export declare namespace ComAtprotoAdminDeleteAccount {
157
- interface Params {}
158
- interface Input {
159
- did: At.Did;
160
- }
161
- type Output = undefined;
162
- }
163
-
164
- /** Disable an account from receiving new invite codes, but does not invalidate existing codes. */
165
- export declare namespace ComAtprotoAdminDisableAccountInvites {
166
- interface Params {}
167
- interface Input {
168
- account: At.Did;
169
- /** Optional reason for disabled invites. */
170
- note?: string;
171
- }
172
- type Output = undefined;
173
- }
174
-
175
- /** Disable some set of codes and/or all codes associated with a set of users. */
176
- export declare namespace ComAtprotoAdminDisableInviteCodes {
177
- interface Params {}
178
- interface Input {
179
- accounts?: string[];
180
- codes?: string[];
181
- }
182
- type Output = undefined;
183
- }
184
-
185
- /** Re-enable an account's ability to receive invite codes. */
186
- export declare namespace ComAtprotoAdminEnableAccountInvites {
187
- interface Params {}
188
- interface Input {
189
- account: At.Did;
190
- /** Optional reason for enabled invites. */
191
- note?: string;
192
- }
193
- type Output = undefined;
194
- }
195
-
196
- /** Get details about an account. */
197
- export declare namespace ComAtprotoAdminGetAccountInfo {
198
- interface Params {
199
- did: At.Did;
200
- }
201
- type Input = undefined;
202
- type Output = ComAtprotoAdminDefs.AccountView;
203
- }
204
-
205
- /** Get details about some accounts. */
206
- export declare namespace ComAtprotoAdminGetAccountInfos {
207
- interface Params {
208
- dids: At.Did[];
209
- }
210
- type Input = undefined;
211
- interface Output {
212
- infos: ComAtprotoAdminDefs.AccountView[];
213
- }
214
- }
215
-
216
- /** Get an admin view of invite codes. */
217
- export declare namespace ComAtprotoAdminGetInviteCodes {
218
- interface Params {
219
- cursor?: string;
220
- /**
221
- * Minimum: 1 \
222
- * Maximum: 500
223
- * @default 100
224
- */
225
- limit?: number;
226
- /** @default "recent" */
227
- sort?: 'recent' | 'usage' | (string & {});
228
- }
229
- type Input = undefined;
230
- interface Output {
231
- codes: ComAtprotoServerDefs.InviteCode[];
232
- cursor?: string;
233
- }
234
- }
235
-
236
- /** Get the service-specific admin status of a subject (account, record, or blob). */
237
- export declare namespace ComAtprotoAdminGetSubjectStatus {
238
- interface Params {
239
- blob?: At.Cid;
240
- did?: At.Did;
241
- uri?: At.ResourceUri;
242
- }
243
- type Input = undefined;
244
- interface Output {
245
- subject: Brand.Union<
246
- ComAtprotoAdminDefs.RepoBlobRef | ComAtprotoAdminDefs.RepoRef | ComAtprotoRepoStrongRef.Main
247
- >;
248
- deactivated?: ComAtprotoAdminDefs.StatusAttr;
249
- takedown?: ComAtprotoAdminDefs.StatusAttr;
250
- }
251
- }
252
-
253
- /** Get list of accounts that matches your search query. */
254
- export declare namespace ComAtprotoAdminSearchAccounts {
255
- interface Params {
256
- cursor?: string;
257
- email?: string;
258
- /**
259
- * Minimum: 1 \
260
- * Maximum: 100
261
- * @default 50
262
- */
263
- limit?: number;
264
- }
265
- type Input = undefined;
266
- interface Output {
267
- accounts: ComAtprotoAdminDefs.AccountView[];
268
- cursor?: string;
269
- }
270
- }
271
-
272
- /** Send email to a user's account email address. */
273
- export declare namespace ComAtprotoAdminSendEmail {
274
- interface Params {}
275
- interface Input {
276
- content: string;
277
- recipientDid: At.Did;
278
- senderDid: At.Did;
279
- /** Additional comment by the sender that won't be used in the email itself but helpful to provide more context for moderators/reviewers */
280
- comment?: string;
281
- subject?: string;
282
- }
283
- interface Output {
284
- sent: boolean;
285
- }
286
- }
287
-
288
- /** Administrative action to update an account's email. */
289
- export declare namespace ComAtprotoAdminUpdateAccountEmail {
290
- interface Params {}
291
- interface Input {
292
- /** The handle or DID of the repo. */
293
- account: At.Identifier;
294
- email: string;
295
- }
296
- type Output = undefined;
297
- }
298
-
299
- /** Administrative action to update an account's handle. */
300
- export declare namespace ComAtprotoAdminUpdateAccountHandle {
301
- interface Params {}
302
- interface Input {
303
- did: At.Did;
304
- handle: At.Handle;
305
- }
306
- type Output = undefined;
307
- }
308
-
309
- /** Update the password for a user account as an administrator. */
310
- export declare namespace ComAtprotoAdminUpdateAccountPassword {
311
- interface Params {}
312
- interface Input {
313
- did: At.Did;
314
- password: string;
315
- }
316
- type Output = undefined;
317
- }
318
-
319
- /** Administrative action to update an account's signing key in their Did document. */
320
- export declare namespace ComAtprotoAdminUpdateAccountSigningKey {
321
- interface Params {}
322
- interface Input {
323
- did: At.Did;
324
- /** Did-key formatted public key */
325
- signingKey: At.Did;
326
- }
327
- type Output = undefined;
328
- }
329
-
330
- /** Update the service-specific admin status of a subject (account, record, or blob). */
331
- export declare namespace ComAtprotoAdminUpdateSubjectStatus {
332
- interface Params {}
333
- interface Input {
334
- subject: Brand.Union<
335
- ComAtprotoAdminDefs.RepoBlobRef | ComAtprotoAdminDefs.RepoRef | ComAtprotoRepoStrongRef.Main
336
- >;
337
- deactivated?: ComAtprotoAdminDefs.StatusAttr;
338
- takedown?: ComAtprotoAdminDefs.StatusAttr;
339
- }
340
- interface Output {
341
- subject: Brand.Union<
342
- ComAtprotoAdminDefs.RepoBlobRef | ComAtprotoAdminDefs.RepoRef | ComAtprotoRepoStrongRef.Main
343
- >;
344
- takedown?: ComAtprotoAdminDefs.StatusAttr;
345
- }
346
- }
347
-
348
- export declare namespace ComAtprotoIdentityDefs {
349
- interface IdentityInfo {
350
- [Brand.Type]?: 'com.atproto.identity.defs#identityInfo';
351
- did: At.Did;
352
- /** The complete DID document for the identity. */
353
- didDoc: unknown;
354
- /** The validated handle of the account; or 'handle.invalid' if the handle did not bi-directionally match the DID document. */
355
- handle: At.Handle;
356
- }
357
- }
358
-
359
- /** Describe the credentials that should be included in the DID doc of an account that is migrating to this service. */
360
- export declare namespace ComAtprotoIdentityGetRecommendedDidCredentials {
361
- interface Params {}
362
- type Input = undefined;
363
- interface Output {
364
- alsoKnownAs?: string[];
365
- /** Recommended rotation keys for PLC dids. Should be undefined (or ignored) for did:webs. */
366
- rotationKeys?: string[];
367
- services?: unknown;
368
- verificationMethods?: unknown;
369
- }
370
- }
371
-
372
- /** Request that the server re-resolve an identity (DID and handle). The server may ignore this request, or require authentication, depending on the role, implementation, and policy of the server. */
373
- export declare namespace ComAtprotoIdentityRefreshIdentity {
374
- interface Params {}
375
- interface Input {
376
- identifier: At.Identifier;
377
- }
378
- type Output = ComAtprotoIdentityDefs.IdentityInfo;
379
- interface Errors {
380
- HandleNotFound: {};
381
- DidNotFound: {};
382
- DidDeactivated: {};
383
- }
384
- }
385
-
386
- /** Request an email with a code to in order to request a signed PLC operation. Requires Auth. */
387
- export declare namespace ComAtprotoIdentityRequestPlcOperationSignature {
388
- interface Params {}
389
- type Input = undefined;
390
- type Output = undefined;
391
- }
392
-
393
- /** Resolves DID to DID document. Does not bi-directionally verify handle. */
394
- export declare namespace ComAtprotoIdentityResolveDid {
395
- interface Params {
396
- /** DID to resolve. */
397
- did: At.Did;
398
- }
399
- type Input = undefined;
400
- interface Output {
401
- /** The complete DID document for the identity. */
402
- didDoc: unknown;
403
- }
404
- interface Errors {
405
- DidNotFound: {};
406
- DidDeactivated: {};
407
- }
408
- }
409
-
410
- /** Resolves an atproto handle (hostname) to a DID. Does not necessarily bi-directionally verify against the the DID document. */
411
- export declare namespace ComAtprotoIdentityResolveHandle {
412
- interface Params {
413
- /** The handle to resolve. */
414
- handle: At.Handle;
415
- }
416
- type Input = undefined;
417
- interface Output {
418
- did: At.Did;
419
- }
420
- interface Errors {
421
- HandleNotFound: {};
422
- }
423
- }
424
-
425
- /** Resolves an identity (DID or Handle) to a full identity (DID document and verified handle). */
426
- export declare namespace ComAtprotoIdentityResolveIdentity {
427
- interface Params {
428
- /** Handle or DID to resolve. */
429
- identifier: At.Identifier;
430
- }
431
- type Input = undefined;
432
- type Output = ComAtprotoIdentityDefs.IdentityInfo;
433
- interface Errors {
434
- HandleNotFound: {};
435
- DidNotFound: {};
436
- DidDeactivated: {};
437
- }
438
- }
439
-
440
- /** Signs a PLC operation to update some value(s) in the requesting DID's document. */
441
- export declare namespace ComAtprotoIdentitySignPlcOperation {
442
- interface Params {}
443
- interface Input {
444
- alsoKnownAs?: string[];
445
- rotationKeys?: string[];
446
- services?: unknown;
447
- /** A token received through com.atproto.identity.requestPlcOperationSignature */
448
- token?: string;
449
- verificationMethods?: unknown;
450
- }
451
- interface Output {
452
- /** A signed DID PLC operation. */
453
- operation: unknown;
454
- }
455
- }
456
-
457
- /** Validates a PLC operation to ensure that it doesn't violate a service's constraints or get the identity into a bad state, then submits it to the PLC registry */
458
- export declare namespace ComAtprotoIdentitySubmitPlcOperation {
459
- interface Params {}
460
- interface Input {
461
- operation: unknown;
462
- }
463
- type Output = undefined;
464
- }
465
-
466
- /** Updates the current account's handle. Verifies handle validity, and updates did:plc document if necessary. Implemented by PDS, and requires auth. */
467
- export declare namespace ComAtprotoIdentityUpdateHandle {
468
- interface Params {}
469
- interface Input {
470
- /** The new handle. */
471
- handle: At.Handle;
472
- }
473
- type Output = undefined;
474
- }
475
-
476
- export declare namespace ComAtprotoLabelDefs {
477
- /** Metadata tag on an atproto resource (eg, repo or record). */
478
- interface Label {
479
- [Brand.Type]?: 'com.atproto.label.defs#label';
480
- /** Timestamp when this label was created. */
481
- cts: string;
482
- /** DID of the actor who created this label. */
483
- src: At.Did;
484
- /** AT URI of the record, repository (account), or other resource that this label applies to. */
485
- uri: At.GenericUri;
486
- /**
487
- * The short string name of the value or type of this label. \
488
- * Maximum string length: 128
489
- */
490
- val: string;
491
- /** Optionally, CID specifying the specific version of 'uri' resource this label applies to. */
492
- cid?: At.Cid;
493
- /** Timestamp at which this label expires (no longer applies). */
494
- exp?: string;
495
- /** If true, this is a negation label, overwriting a previous label. */
496
- neg?: boolean;
497
- /** Signature of dag-cbor encoded label. */
498
- sig?: At.Bytes;
499
- /** The AT Protocol version of the label object. */
500
- ver?: number;
501
- }
502
- type LabelValue =
503
- | '!hide'
504
- | '!no-promote'
505
- | '!no-unauthenticated'
506
- | '!warn'
507
- | 'dmca-violation'
508
- | 'doxxing'
509
- | 'gore'
510
- | 'nsfl'
511
- | 'nudity'
512
- | 'porn'
513
- | 'sexual'
514
- | (string & {});
515
- /** Declares a label value and its expected interpretations and behaviors. */
516
- interface LabelValueDefinition {
517
- [Brand.Type]?: 'com.atproto.label.defs#labelValueDefinition';
518
- /** What should this label hide in the UI, if applied? 'content' hides all of the target; 'media' hides the images/video/audio; 'none' hides nothing. */
519
- blurs: 'content' | 'media' | 'none' | (string & {});
520
- /**
521
- * The value of the label being defined. Must only include lowercase ascii and the '-' character ([a-z-]+). \
522
- * Maximum string length: 100 \
523
- * Maximum grapheme length: 100
524
- */
525
- identifier: string;
526
- locales: LabelValueDefinitionStrings[];
527
- /** How should a client visually convey this label? 'inform' means neutral and informational; 'alert' means negative and warning; 'none' means show nothing. */
528
- severity: 'alert' | 'inform' | 'none' | (string & {});
529
- /** Does the user need to have adult content enabled in order to configure this label? */
530
- adultOnly?: boolean;
531
- /**
532
- * The default setting for this label.
533
- * @default "warn"
534
- */
535
- defaultSetting?: 'hide' | 'ignore' | 'warn' | (string & {});
536
- }
537
- /** Strings which describe the label in the UI, localized into a specific language. */
538
- interface LabelValueDefinitionStrings {
539
- [Brand.Type]?: 'com.atproto.label.defs#labelValueDefinitionStrings';
540
- /**
541
- * A longer description of what the label means and why it might be applied. \
542
- * Maximum string length: 100000 \
543
- * Maximum grapheme length: 10000
544
- */
545
- description: string;
546
- /** The code of the language these strings are written in. */
547
- lang: string;
548
- /**
549
- * A short human-readable name for the label. \
550
- * Maximum string length: 640 \
551
- * Maximum grapheme length: 64
552
- */
553
- name: string;
554
- }
555
- /** Metadata tag on an atproto record, published by the author within the record. Note that schemas should use #selfLabels, not #selfLabel. */
556
- interface SelfLabel {
557
- [Brand.Type]?: 'com.atproto.label.defs#selfLabel';
558
- /**
559
- * The short string name of the value or type of this label. \
560
- * Maximum string length: 128
561
- */
562
- val: string;
563
- }
564
- /** Metadata tags on an atproto record, published by the author within the record. */
565
- interface SelfLabels {
566
- [Brand.Type]?: 'com.atproto.label.defs#selfLabels';
567
- /** Maximum array length: 10 */
568
- values: SelfLabel[];
569
- }
570
- }
571
-
572
- /** Find labels relevant to the provided AT-URI patterns. Public endpoint for moderation services, though may return different or additional results with auth. */
573
- export declare namespace ComAtprotoLabelQueryLabels {
574
- interface Params {
575
- /** List of AT URI patterns to match (boolean 'OR'). Each may be a prefix (ending with '*'; will match inclusive of the string leading to '*'), or a full URI. */
576
- uriPatterns: string[];
577
- cursor?: string;
578
- /**
579
- * Minimum: 1 \
580
- * Maximum: 250
581
- * @default 50
582
- */
583
- limit?: number;
584
- /** Optional list of label sources (DIDs) to filter on. */
585
- sources?: At.Did[];
586
- }
587
- type Input = undefined;
588
- interface Output {
589
- labels: ComAtprotoLabelDefs.Label[];
590
- cursor?: string;
591
- }
592
- }
593
-
594
- export declare namespace ComAtprotoLabelSubscribeLabels {
595
- interface Info {
596
- [Brand.Type]?: 'com.atproto.label.subscribeLabels#info';
597
- name: 'OutdatedCursor' | (string & {});
598
- message?: string;
599
- }
600
- interface Labels {
601
- [Brand.Type]?: 'com.atproto.label.subscribeLabels#labels';
602
- labels: ComAtprotoLabelDefs.Label[];
603
- seq: number;
604
- }
605
- }
606
-
607
- export declare namespace ComAtprotoLexiconSchema {
608
- /** Representation of Lexicon schemas themselves, when published as atproto records. Note that the schema language is not defined in Lexicon; this meta schema currently only includes a single version field ('lexicon'). See the atproto specifications for description of the other expected top-level fields ('id', 'defs', etc). */
609
- interface Record {
610
- $type: 'com.atproto.lexicon.schema';
611
- /** Indicates the 'version' of the Lexicon language. Must be '1' for the current atproto/Lexicon schema system. */
612
- lexicon: number;
613
- }
614
- }
615
-
616
- /** Submit a moderation report regarding an atproto account or record. Implemented by moderation services (with PDS proxying), and requires auth. */
617
- export declare namespace ComAtprotoModerationCreateReport {
618
- interface Params {}
619
- interface Input {
620
- /** Indicates the broad category of violation the report is for. */
621
- reasonType: ComAtprotoModerationDefs.ReasonType;
622
- subject: Brand.Union<ComAtprotoAdminDefs.RepoRef | ComAtprotoRepoStrongRef.Main>;
623
- /**
624
- * Additional context about the content and violation. \
625
- * Maximum string length: 20000 \
626
- * Maximum grapheme length: 2000
627
- */
628
- reason?: string;
629
- }
630
- interface Output {
631
- createdAt: string;
632
- id: number;
633
- reasonType: ComAtprotoModerationDefs.ReasonType;
634
- reportedBy: At.Did;
635
- subject: Brand.Union<ComAtprotoAdminDefs.RepoRef | ComAtprotoRepoStrongRef.Main>;
636
- /**
637
- * Maximum string length: 20000 \
638
- * Maximum grapheme length: 2000
639
- */
640
- reason?: string;
641
- }
642
- }
643
-
644
- export declare namespace ComAtprotoModerationDefs {
645
- type ReasonAppeal = 'com.atproto.moderation.defs#reasonAppeal';
646
- type ReasonMisleading = 'com.atproto.moderation.defs#reasonMisleading';
647
- type ReasonOther = 'com.atproto.moderation.defs#reasonOther';
648
- type ReasonRude = 'com.atproto.moderation.defs#reasonRude';
649
- type ReasonSexual = 'com.atproto.moderation.defs#reasonSexual';
650
- type ReasonSpam = 'com.atproto.moderation.defs#reasonSpam';
651
- type ReasonType =
652
- | 'com.atproto.moderation.defs#reasonAppeal'
653
- | 'com.atproto.moderation.defs#reasonMisleading'
654
- | 'com.atproto.moderation.defs#reasonOther'
655
- | 'com.atproto.moderation.defs#reasonRude'
656
- | 'com.atproto.moderation.defs#reasonSexual'
657
- | 'com.atproto.moderation.defs#reasonSpam'
658
- | 'com.atproto.moderation.defs#reasonViolation'
659
- | (string & {});
660
- type ReasonViolation = 'com.atproto.moderation.defs#reasonViolation';
661
- /** Tag describing a type of subject that might be reported. */
662
- type SubjectType = 'account' | 'chat' | 'record' | (string & {});
663
- }
664
-
665
- /** Apply a batch transaction of repository creates, updates, and deletes. Requires auth, implemented by PDS. */
666
- export declare namespace ComAtprotoRepoApplyWrites {
667
- interface Params {}
668
- interface Input {
669
- /** The handle or DID of the repo (aka, current account). */
670
- repo: At.Identifier;
671
- writes: Brand.Union<Create | Delete | Update>[];
672
- /** If provided, the entire operation will fail if the current repo commit CID does not match this value. Used to prevent conflicting repo mutations. */
673
- swapCommit?: At.Cid;
674
- /** Can be set to 'false' to skip Lexicon schema validation of record data across all operations, 'true' to require it, or leave unset to validate only for known Lexicons. */
675
- validate?: boolean;
676
- }
677
- interface Output {
678
- commit?: ComAtprotoRepoDefs.CommitMeta;
679
- results?: Brand.Union<CreateResult | DeleteResult | UpdateResult>[];
680
- }
681
- interface Errors {
682
- InvalidSwap: {};
683
- }
684
- /** Operation which creates a new record. */
685
- interface Create {
686
- [Brand.Type]?: 'com.atproto.repo.applyWrites#create';
687
- collection: At.Nsid;
688
- value: unknown;
689
- /** NOTE: maxLength is redundant with record-key format. Keeping it temporarily to ensure backwards compatibility. */
690
- rkey?: At.RecordKey;
691
- }
692
- interface CreateResult {
693
- [Brand.Type]?: 'com.atproto.repo.applyWrites#createResult';
694
- cid: At.Cid;
695
- uri: At.ResourceUri;
696
- validationStatus?: 'unknown' | 'valid' | (string & {});
697
- }
698
- /** Operation which deletes an existing record. */
699
- interface Delete {
700
- [Brand.Type]?: 'com.atproto.repo.applyWrites#delete';
701
- collection: At.Nsid;
702
- rkey: At.RecordKey;
703
- }
704
- interface DeleteResult {
705
- [Brand.Type]?: 'com.atproto.repo.applyWrites#deleteResult';
706
- }
707
- /** Operation which updates an existing record. */
708
- interface Update {
709
- [Brand.Type]?: 'com.atproto.repo.applyWrites#update';
710
- collection: At.Nsid;
711
- rkey: At.RecordKey;
712
- value: unknown;
713
- }
714
- interface UpdateResult {
715
- [Brand.Type]?: 'com.atproto.repo.applyWrites#updateResult';
716
- cid: At.Cid;
717
- uri: At.ResourceUri;
718
- validationStatus?: 'unknown' | 'valid' | (string & {});
719
- }
720
- }
721
-
722
- /** Create a single new repository record. Requires auth, implemented by PDS. */
723
- export declare namespace ComAtprotoRepoCreateRecord {
724
- interface Params {}
725
- interface Input {
726
- /** The NSID of the record collection. */
727
- collection: At.Nsid;
728
- /** The record itself. Must contain a $type field. */
729
- record: unknown;
730
- /** The handle or DID of the repo (aka, current account). */
731
- repo: At.Identifier;
732
- /** The Record Key. */
733
- rkey?: At.RecordKey;
734
- /** Compare and swap with the previous commit by CID. */
735
- swapCommit?: At.Cid;
736
- /** Can be set to 'false' to skip Lexicon schema validation of record data, 'true' to require it, or leave unset to validate only for known Lexicons. */
737
- validate?: boolean;
738
- }
739
- interface Output {
740
- cid: At.Cid;
741
- uri: At.ResourceUri;
742
- commit?: ComAtprotoRepoDefs.CommitMeta;
743
- validationStatus?: 'unknown' | 'valid' | (string & {});
744
- }
745
- interface Errors {
746
- InvalidSwap: {};
747
- }
748
- }
749
-
750
- export declare namespace ComAtprotoRepoDefs {
751
- interface CommitMeta {
752
- [Brand.Type]?: 'com.atproto.repo.defs#commitMeta';
753
- cid: At.Cid;
754
- rev: At.Tid;
755
- }
756
- }
757
-
758
- /** Delete a repository record, or ensure it doesn't exist. Requires auth, implemented by PDS. */
759
- export declare namespace ComAtprotoRepoDeleteRecord {
760
- interface Params {}
761
- interface Input {
762
- /** The NSID of the record collection. */
763
- collection: At.Nsid;
764
- /** The handle or DID of the repo (aka, current account). */
765
- repo: At.Identifier;
766
- /** The Record Key. */
767
- rkey: At.RecordKey;
768
- /** Compare and swap with the previous commit by CID. */
769
- swapCommit?: At.Cid;
770
- /** Compare and swap with the previous record by CID. */
771
- swapRecord?: At.Cid;
772
- }
773
- interface Output {
774
- commit?: ComAtprotoRepoDefs.CommitMeta;
775
- }
776
- interface Errors {
777
- InvalidSwap: {};
778
- }
779
- }
780
-
781
- /** Get information about an account and repository, including the list of collections. Does not require auth. */
782
- export declare namespace ComAtprotoRepoDescribeRepo {
783
- interface Params {
784
- /** The handle or DID of the repo. */
785
- repo: At.Identifier;
786
- }
787
- type Input = undefined;
788
- interface Output {
789
- /** List of all the collections (NSIDs) for which this repo contains at least one record. */
790
- collections: At.Nsid[];
791
- did: At.Did;
792
- /** The complete DID document for this account. */
793
- didDoc: unknown;
794
- handle: At.Handle;
795
- /** Indicates if handle is currently valid (resolves bi-directionally) */
796
- handleIsCorrect: boolean;
797
- }
798
- }
799
-
800
- /** Get a single record from a repository. Does not require auth. */
801
- export declare namespace ComAtprotoRepoGetRecord {
802
- interface Params {
803
- /** The NSID of the record collection. */
804
- collection: At.Nsid;
805
- /** The handle or DID of the repo. */
806
- repo: At.Identifier;
807
- /** The Record Key. */
808
- rkey: At.RecordKey;
809
- /** The CID of the version of the record. If not specified, then return the most recent version. */
810
- cid?: At.Cid;
811
- }
812
- type Input = undefined;
813
- interface Output {
814
- uri: At.ResourceUri;
815
- value: unknown;
816
- cid?: At.Cid;
817
- }
818
- interface Errors {
819
- RecordNotFound: {};
820
- }
821
- }
822
-
823
- /** Import a repo in the form of a CAR file. Requires Content-Length HTTP header to be set. */
824
- export declare namespace ComAtprotoRepoImportRepo {
825
- interface Params {}
826
- type Input = Blob | BufferSource | ReadableStream;
827
- type Output = undefined;
828
- }
829
-
830
- /** Returns a list of missing blobs for the requesting account. Intended to be used in the account migration flow. */
831
- export declare namespace ComAtprotoRepoListMissingBlobs {
832
- interface Params {
833
- cursor?: string;
834
- /**
835
- * Minimum: 1 \
836
- * Maximum: 1000
837
- * @default 500
838
- */
839
- limit?: number;
840
- }
841
- type Input = undefined;
842
- interface Output {
843
- blobs: RecordBlob[];
844
- cursor?: string;
845
- }
846
- interface RecordBlob {
847
- [Brand.Type]?: 'com.atproto.repo.listMissingBlobs#recordBlob';
848
- cid: At.Cid;
849
- recordUri: At.ResourceUri;
850
- }
851
- }
852
-
853
- /** List a range of records in a repository, matching a specific collection. Does not require auth. */
854
- export declare namespace ComAtprotoRepoListRecords {
855
- interface Params {
856
- /** The NSID of the record type. */
857
- collection: At.Nsid;
858
- /** The handle or DID of the repo. */
859
- repo: At.Identifier;
860
- cursor?: string;
861
- /**
862
- * The number of records to return. \
863
- * Minimum: 1 \
864
- * Maximum: 100
865
- * @default 50
866
- */
867
- limit?: number;
868
- /** Flag to reverse the order of the returned records. */
869
- reverse?: boolean;
870
- }
871
- type Input = undefined;
872
- interface Output {
873
- records: Record[];
874
- cursor?: string;
875
- }
876
- interface Record {
877
- [Brand.Type]?: 'com.atproto.repo.listRecords#record';
878
- cid: At.Cid;
879
- uri: At.ResourceUri;
880
- value: unknown;
881
- }
882
- }
883
-
884
- /** Write a repository record, creating or updating it as needed. Requires auth, implemented by PDS. */
885
- export declare namespace ComAtprotoRepoPutRecord {
886
- interface Params {}
887
- interface Input {
888
- /** The NSID of the record collection. */
889
- collection: At.Nsid;
890
- /** The record to write. */
891
- record: unknown;
892
- /** The handle or DID of the repo (aka, current account). */
893
- repo: At.Identifier;
894
- /** The Record Key. */
895
- rkey: At.RecordKey;
896
- /** Compare and swap with the previous commit by CID. */
897
- swapCommit?: At.Cid;
898
- /** Compare and swap with the previous record by CID. WARNING: nullable and optional field; may cause problems with golang implementation */
899
- swapRecord?: At.Cid | null;
900
- /** Can be set to 'false' to skip Lexicon schema validation of record data, 'true' to require it, or leave unset to validate only for known Lexicons. */
901
- validate?: boolean;
902
- }
903
- interface Output {
904
- cid: At.Cid;
905
- uri: At.ResourceUri;
906
- commit?: ComAtprotoRepoDefs.CommitMeta;
907
- validationStatus?: 'unknown' | 'valid' | (string & {});
908
- }
909
- interface Errors {
910
- InvalidSwap: {};
911
- }
912
- }
913
-
914
- export declare namespace ComAtprotoRepoStrongRef {
915
- interface Main {
916
- [Brand.Type]?: 'com.atproto.repo.strongRef';
917
- cid: At.Cid;
918
- uri: At.ResourceUri;
919
- }
920
- }
921
-
922
- /** 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. */
923
- export declare namespace ComAtprotoRepoUploadBlob {
924
- interface Params {}
925
- type Input = Blob | BufferSource | ReadableStream;
926
- interface Output {
927
- blob: At.Blob;
928
- }
929
- }
930
-
931
- /** Activates a currently deactivated account. Used to finalize account migration after the account's repo is imported and identity is setup. */
932
- export declare namespace ComAtprotoServerActivateAccount {
933
- interface Params {}
934
- type Input = undefined;
935
- type Output = undefined;
936
- }
937
-
938
- /** Returns the status of an account, especially as pertaining to import or recovery. Can be called many times over the course of an account migration. Requires auth and can only be called pertaining to oneself. */
939
- export declare namespace ComAtprotoServerCheckAccountStatus {
940
- interface Params {}
941
- type Input = undefined;
942
- interface Output {
943
- activated: boolean;
944
- expectedBlobs: number;
945
- importedBlobs: number;
946
- indexedRecords: number;
947
- privateStateValues: number;
948
- repoBlocks: number;
949
- repoCommit: At.Cid;
950
- repoRev: string;
951
- validDid: boolean;
952
- }
953
- }
954
-
955
- /** Confirm an email using a token from com.atproto.server.requestEmailConfirmation. */
956
- export declare namespace ComAtprotoServerConfirmEmail {
957
- interface Params {}
958
- interface Input {
959
- email: string;
960
- token: string;
961
- }
962
- type Output = undefined;
963
- interface Errors {
964
- AccountNotFound: {};
965
- ExpiredToken: {};
966
- InvalidToken: {};
967
- InvalidEmail: {};
968
- }
969
- }
970
-
971
- /** Create an account. Implemented by PDS. */
972
- export declare namespace ComAtprotoServerCreateAccount {
973
- interface Params {}
974
- interface Input {
975
- /** Requested handle for the account. */
976
- handle: At.Handle;
977
- /** Pre-existing atproto DID, being imported to a new account. */
978
- did?: At.Did;
979
- email?: string;
980
- inviteCode?: string;
981
- /** Initial account password. May need to meet instance-specific password strength requirements. */
982
- password?: string;
983
- /** A signed DID PLC operation to be submitted as part of importing an existing account to this instance. NOTE: this optional field may be updated when full account migration is implemented. */
984
- plcOp?: unknown;
985
- /** DID PLC rotation key (aka, recovery key) to be included in PLC creation operation. */
986
- recoveryKey?: string;
987
- verificationCode?: string;
988
- verificationPhone?: string;
989
- }
990
- /** Account login session returned on successful account creation. */
991
- interface Output {
992
- accessJwt: string;
993
- /** The DID of the new account. */
994
- did: At.Did;
995
- handle: At.Handle;
996
- refreshJwt: string;
997
- /** Complete DID document. */
998
- didDoc?: unknown;
999
- }
1000
- interface Errors {
1001
- InvalidHandle: {};
1002
- InvalidPassword: {};
1003
- InvalidInviteCode: {};
1004
- HandleNotAvailable: {};
1005
- UnsupportedDomain: {};
1006
- UnresolvableDid: {};
1007
- IncompatibleDidDoc: {};
1008
- }
1009
- }
1010
-
1011
- /** Create an App Password. */
1012
- export declare namespace ComAtprotoServerCreateAppPassword {
1013
- interface Params {}
1014
- interface Input {
1015
- /** A short name for the App Password, to help distinguish them. */
1016
- name: string;
1017
- /** If an app password has 'privileged' access to possibly sensitive account state. Meant for use with trusted clients. */
1018
- privileged?: boolean;
1019
- }
1020
- type Output = AppPassword;
1021
- interface Errors {
1022
- AccountTakedown: {};
1023
- }
1024
- interface AppPassword {
1025
- [Brand.Type]?: 'com.atproto.server.createAppPassword#appPassword';
1026
- createdAt: string;
1027
- name: string;
1028
- password: string;
1029
- privileged?: boolean;
1030
- }
1031
- }
1032
-
1033
- /** Create an invite code. */
1034
- export declare namespace ComAtprotoServerCreateInviteCode {
1035
- interface Params {}
1036
- interface Input {
1037
- useCount: number;
1038
- forAccount?: At.Did;
1039
- }
1040
- interface Output {
1041
- code: string;
1042
- }
1043
- }
1044
-
1045
- /** Create invite codes. */
1046
- export declare namespace ComAtprotoServerCreateInviteCodes {
1047
- interface Params {}
1048
- interface Input {
1049
- /** @default 1 */
1050
- codeCount: number;
1051
- useCount: number;
1052
- forAccounts?: At.Did[];
1053
- }
1054
- interface Output {
1055
- codes: AccountCodes[];
1056
- }
1057
- interface AccountCodes {
1058
- [Brand.Type]?: 'com.atproto.server.createInviteCodes#accountCodes';
1059
- account: string;
1060
- codes: string[];
1061
- }
1062
- }
1063
-
1064
- /** Create an authentication session. */
1065
- export declare namespace ComAtprotoServerCreateSession {
1066
- interface Params {}
1067
- interface Input {
1068
- /** Handle or other identifier supported by the server for the authenticating user. */
1069
- identifier: string;
1070
- password: string;
1071
- /** When true, instead of throwing error for takendown accounts, a valid response with a narrow scoped token will be returned */
1072
- allowTakendown?: boolean;
1073
- authFactorToken?: string;
1074
- }
1075
- interface Output {
1076
- accessJwt: string;
1077
- did: At.Did;
1078
- handle: At.Handle;
1079
- refreshJwt: string;
1080
- active?: boolean;
1081
- didDoc?: unknown;
1082
- email?: string;
1083
- emailAuthFactor?: boolean;
1084
- emailConfirmed?: boolean;
1085
- /** If active=false, this optional field indicates a possible reason for why the account is not active. If active=false and no status is supplied, then the host makes no claim for why the repository is no longer being hosted. */
1086
- status?: 'deactivated' | 'suspended' | 'takendown' | (string & {});
1087
- }
1088
- interface Errors {
1089
- AccountTakedown: {};
1090
- AuthFactorTokenRequired: {};
1091
- }
1092
- }
1093
-
1094
- /** Deactivates a currently active account. Stops serving of repo, and future writes to repo until reactivated. Used to finalize account migration with the old host after the account has been activated on the new host. */
1095
- export declare namespace ComAtprotoServerDeactivateAccount {
1096
- interface Params {}
1097
- interface Input {
1098
- /** A recommendation to server as to how long they should hold onto the deactivated account before deleting. */
1099
- deleteAfter?: string;
1100
- }
1101
- type Output = undefined;
1102
- }
1103
-
1104
- export declare namespace ComAtprotoServerDefs {
1105
- interface InviteCode {
1106
- [Brand.Type]?: 'com.atproto.server.defs#inviteCode';
1107
- available: number;
1108
- code: string;
1109
- createdAt: string;
1110
- createdBy: string;
1111
- disabled: boolean;
1112
- forAccount: string;
1113
- uses: InviteCodeUse[];
1114
- }
1115
- interface InviteCodeUse {
1116
- [Brand.Type]?: 'com.atproto.server.defs#inviteCodeUse';
1117
- usedAt: string;
1118
- usedBy: At.Did;
1119
- }
1120
- }
1121
-
1122
- /** Delete an actor's account with a token and password. Can only be called after requesting a deletion token. Requires auth. */
1123
- export declare namespace ComAtprotoServerDeleteAccount {
1124
- interface Params {}
1125
- interface Input {
1126
- did: At.Did;
1127
- password: string;
1128
- token: string;
1129
- }
1130
- type Output = undefined;
1131
- interface Errors {
1132
- ExpiredToken: {};
1133
- InvalidToken: {};
1134
- }
1135
- }
1136
-
1137
- /** Delete the current session. Requires auth. */
1138
- export declare namespace ComAtprotoServerDeleteSession {
1139
- interface Params {}
1140
- type Input = undefined;
1141
- type Output = undefined;
1142
- }
1143
-
1144
- /** Describes the server's account creation requirements and capabilities. Implemented by PDS. */
1145
- export declare namespace ComAtprotoServerDescribeServer {
1146
- interface Params {}
1147
- type Input = undefined;
1148
- interface Output {
1149
- /** List of domain suffixes that can be used in account handles. */
1150
- availableUserDomains: string[];
1151
- did: At.Did;
1152
- /** Contact information */
1153
- contact?: Contact;
1154
- /** If true, an invite code must be supplied to create an account on this instance. */
1155
- inviteCodeRequired?: boolean;
1156
- /** URLs of service policy documents. */
1157
- links?: Links;
1158
- /** If true, a phone verification token must be supplied to create an account on this instance. */
1159
- phoneVerificationRequired?: boolean;
1160
- }
1161
- interface Contact {
1162
- [Brand.Type]?: 'com.atproto.server.describeServer#contact';
1163
- email?: string;
1164
- }
1165
- interface Links {
1166
- [Brand.Type]?: 'com.atproto.server.describeServer#links';
1167
- privacyPolicy?: At.GenericUri;
1168
- termsOfService?: At.GenericUri;
1169
- }
1170
- }
1171
-
1172
- /** Get all invite codes for the current account. Requires auth. */
1173
- export declare namespace ComAtprotoServerGetAccountInviteCodes {
1174
- interface Params {
1175
- /**
1176
- * Controls whether any new 'earned' but not 'created' invites should be created.
1177
- * @default true
1178
- */
1179
- createAvailable?: boolean;
1180
- /** @default true */
1181
- includeUsed?: boolean;
1182
- }
1183
- type Input = undefined;
1184
- interface Output {
1185
- codes: ComAtprotoServerDefs.InviteCode[];
1186
- }
1187
- interface Errors {
1188
- DuplicateCreate: {};
1189
- }
1190
- }
1191
-
1192
- /** Get a signed token on behalf of the requesting DID for the requested service. */
1193
- export declare namespace ComAtprotoServerGetServiceAuth {
1194
- interface Params {
1195
- /** The DID of the service that the token will be used to authenticate with */
1196
- aud: At.Did;
1197
- /** The time in Unix Epoch seconds that the JWT expires. Defaults to 60 seconds in the future. The service may enforce certain time bounds on tokens depending on the requested scope. */
1198
- exp?: number;
1199
- /** Lexicon (XRPC) method to bind the requested token to */
1200
- lxm?: At.Nsid;
1201
- }
1202
- type Input = undefined;
1203
- interface Output {
1204
- token: string;
1205
- }
1206
- interface Errors {
1207
- BadExpiration: {};
1208
- }
1209
- }
1210
-
1211
- /** Get information about the current auth session. Requires auth. */
1212
- export declare namespace ComAtprotoServerGetSession {
1213
- interface Params {}
1214
- type Input = undefined;
1215
- interface Output {
1216
- did: At.Did;
1217
- handle: At.Handle;
1218
- active?: boolean;
1219
- didDoc?: unknown;
1220
- email?: string;
1221
- emailAuthFactor?: boolean;
1222
- emailConfirmed?: boolean;
1223
- /** If active=false, this optional field indicates a possible reason for why the account is not active. If active=false and no status is supplied, then the host makes no claim for why the repository is no longer being hosted. */
1224
- status?: 'deactivated' | 'suspended' | 'takendown' | (string & {});
1225
- }
1226
- }
1227
-
1228
- /** List all App Passwords. */
1229
- export declare namespace ComAtprotoServerListAppPasswords {
1230
- interface Params {}
1231
- type Input = undefined;
1232
- interface Output {
1233
- passwords: AppPassword[];
1234
- }
1235
- interface Errors {
1236
- AccountTakedown: {};
1237
- }
1238
- interface AppPassword {
1239
- [Brand.Type]?: 'com.atproto.server.listAppPasswords#appPassword';
1240
- createdAt: string;
1241
- name: string;
1242
- privileged?: boolean;
1243
- }
1244
- }
1245
-
1246
- /** Refresh an authentication session. Requires auth using the 'refreshJwt' (not the 'accessJwt'). */
1247
- export declare namespace ComAtprotoServerRefreshSession {
1248
- interface Params {}
1249
- type Input = undefined;
1250
- interface Output {
1251
- accessJwt: string;
1252
- did: At.Did;
1253
- handle: At.Handle;
1254
- refreshJwt: string;
1255
- active?: boolean;
1256
- didDoc?: unknown;
1257
- /** Hosting status of the account. If not specified, then assume 'active'. */
1258
- status?: 'deactivated' | 'suspended' | 'takendown' | (string & {});
1259
- }
1260
- interface Errors {
1261
- AccountTakedown: {};
1262
- }
1263
- }
1264
-
1265
- /** Initiate a user account deletion via email. */
1266
- export declare namespace ComAtprotoServerRequestAccountDelete {
1267
- interface Params {}
1268
- type Input = undefined;
1269
- type Output = undefined;
1270
- }
1271
-
1272
- /** Request an email with a code to confirm ownership of email. */
1273
- export declare namespace ComAtprotoServerRequestEmailConfirmation {
1274
- interface Params {}
1275
- type Input = undefined;
1276
- type Output = undefined;
1277
- }
1278
-
1279
- /** Request a token in order to update email. */
1280
- export declare namespace ComAtprotoServerRequestEmailUpdate {
1281
- interface Params {}
1282
- type Input = undefined;
1283
- interface Output {
1284
- tokenRequired: boolean;
1285
- }
1286
- }
1287
-
1288
- /** Initiate a user account password reset via email. */
1289
- export declare namespace ComAtprotoServerRequestPasswordReset {
1290
- interface Params {}
1291
- interface Input {
1292
- email: string;
1293
- }
1294
- type Output = undefined;
1295
- }
1296
-
1297
- /** Reserve a repo signing key, for use with account creation. Necessary so that a DID PLC update operation can be constructed during an account migraiton. Public and does not require auth; implemented by PDS. NOTE: this endpoint may change when full account migration is implemented. */
1298
- export declare namespace ComAtprotoServerReserveSigningKey {
1299
- interface Params {}
1300
- interface Input {
1301
- /** The DID to reserve a key for. */
1302
- did?: At.Did;
1303
- }
1304
- interface Output {
1305
- /** The public key for the reserved signing key, in did:key serialization. */
1306
- signingKey: string;
1307
- }
1308
- }
1309
-
1310
- /** Reset a user account password using a token. */
1311
- export declare namespace ComAtprotoServerResetPassword {
1312
- interface Params {}
1313
- interface Input {
1314
- password: string;
1315
- token: string;
1316
- }
1317
- type Output = undefined;
1318
- interface Errors {
1319
- ExpiredToken: {};
1320
- InvalidToken: {};
1321
- }
1322
- }
1323
-
1324
- /** Revoke an App Password by name. */
1325
- export declare namespace ComAtprotoServerRevokeAppPassword {
1326
- interface Params {}
1327
- interface Input {
1328
- name: string;
1329
- }
1330
- type Output = undefined;
1331
- }
1332
-
1333
- /** Update an account's email. */
1334
- export declare namespace ComAtprotoServerUpdateEmail {
1335
- interface Params {}
1336
- interface Input {
1337
- email: string;
1338
- emailAuthFactor?: boolean;
1339
- /** Requires a token from com.atproto.sever.requestEmailUpdate if the account's email has been confirmed. */
1340
- token?: string;
1341
- }
1342
- type Output = undefined;
1343
- interface Errors {
1344
- ExpiredToken: {};
1345
- InvalidToken: {};
1346
- TokenRequired: {};
1347
- }
1348
- }
1349
-
1350
- export declare namespace ComAtprotoSyncDefs {
1351
- type HostStatus = 'active' | 'banned' | 'idle' | 'offline' | 'throttled' | (string & {});
1352
- }
1353
-
1354
- /** Get a blob associated with a given account. Returns the full blob as originally uploaded. Does not require auth; implemented by PDS. */
1355
- export declare namespace ComAtprotoSyncGetBlob {
1356
- interface Params {
1357
- /** The CID of the blob to fetch */
1358
- cid: At.Cid;
1359
- /** The DID of the account. */
1360
- did: At.Did;
1361
- }
1362
- type Input = undefined;
1363
- type Output = Uint8Array;
1364
- interface Errors {
1365
- BlobNotFound: {};
1366
- RepoNotFound: {};
1367
- RepoTakendown: {};
1368
- RepoSuspended: {};
1369
- RepoDeactivated: {};
1370
- }
1371
- }
1372
-
1373
- /** Get data blocks from a given repo, by CID. For example, intermediate MST nodes, or records. Does not require auth; implemented by PDS. */
1374
- export declare namespace ComAtprotoSyncGetBlocks {
1375
- interface Params {
1376
- cids: At.Cid[];
1377
- /** The DID of the repo. */
1378
- did: At.Did;
1379
- }
1380
- type Input = undefined;
1381
- type Output = Uint8Array;
1382
- interface Errors {
1383
- BlockNotFound: {};
1384
- RepoNotFound: {};
1385
- RepoTakendown: {};
1386
- RepoSuspended: {};
1387
- RepoDeactivated: {};
1388
- }
1389
- }
1390
-
1391
- /**
1392
- * DEPRECATED - please use com.atproto.sync.getRepo instead
1393
- * @deprecated
1394
- */
1395
- export declare namespace ComAtprotoSyncGetCheckout {
1396
- interface Params {
1397
- /** The DID of the repo. */
1398
- did: At.Did;
1399
- }
1400
- type Input = undefined;
1401
- type Output = Uint8Array;
1402
- }
1403
-
1404
- /**
1405
- * DEPRECATED - please use com.atproto.sync.getLatestCommit instead
1406
- * @deprecated
1407
- */
1408
- export declare namespace ComAtprotoSyncGetHead {
1409
- interface Params {
1410
- /** The DID of the repo. */
1411
- did: At.Did;
1412
- }
1413
- type Input = undefined;
1414
- interface Output {
1415
- root: At.Cid;
1416
- }
1417
- interface Errors {
1418
- HeadNotFound: {};
1419
- }
1420
- }
1421
-
1422
- /** Returns information about a specified upstream host, as consumed by the server. Implemented by relays. */
1423
- export declare namespace ComAtprotoSyncGetHostStatus {
1424
- interface Params {
1425
- /** Hostname of the host (eg, PDS or relay) being queried. */
1426
- hostname: string;
1427
- }
1428
- type Input = undefined;
1429
- interface Output {
1430
- hostname: string;
1431
- /** Number of accounts on the server which are associated with the upstream host. Note that the upstream may actually have more accounts. */
1432
- accountCount?: number;
1433
- /** Recent repo stream event sequence number. May be delayed from actual stream processing (eg, persisted cursor not in-memory cursor). */
1434
- seq?: number;
1435
- status?: ComAtprotoSyncDefs.HostStatus;
1436
- }
1437
- interface Errors {
1438
- HostNotFound: {};
1439
- }
1440
- }
1441
-
1442
- /** Get the current commit CID & revision of the specified repo. Does not require auth. */
1443
- export declare namespace ComAtprotoSyncGetLatestCommit {
1444
- interface Params {
1445
- /** The DID of the repo. */
1446
- did: At.Did;
1447
- }
1448
- type Input = undefined;
1449
- interface Output {
1450
- cid: At.Cid;
1451
- rev: At.Tid;
1452
- }
1453
- interface Errors {
1454
- RepoNotFound: {};
1455
- RepoTakendown: {};
1456
- RepoSuspended: {};
1457
- RepoDeactivated: {};
1458
- }
1459
- }
1460
-
1461
- /** Get data blocks needed to prove the existence or non-existence of record in the current version of repo. Does not require auth. */
1462
- export declare namespace ComAtprotoSyncGetRecord {
1463
- interface Params {
1464
- collection: At.Nsid;
1465
- /** The DID of the repo. */
1466
- did: At.Did;
1467
- /** Record Key */
1468
- rkey: At.RecordKey;
1469
- }
1470
- type Input = undefined;
1471
- type Output = Uint8Array;
1472
- interface Errors {
1473
- RecordNotFound: {};
1474
- RepoNotFound: {};
1475
- RepoTakendown: {};
1476
- RepoSuspended: {};
1477
- RepoDeactivated: {};
1478
- }
1479
- }
1480
-
1481
- /** Download a repository export as CAR file. Optionally only a 'diff' since a previous revision. Does not require auth; implemented by PDS. */
1482
- export declare namespace ComAtprotoSyncGetRepo {
1483
- interface Params {
1484
- /** The DID of the repo. */
1485
- did: At.Did;
1486
- /** The revision ('rev') of the repo to create a diff from. */
1487
- since?: At.Tid;
1488
- }
1489
- type Input = undefined;
1490
- type Output = Uint8Array;
1491
- interface Errors {
1492
- RepoNotFound: {};
1493
- RepoTakendown: {};
1494
- RepoSuspended: {};
1495
- RepoDeactivated: {};
1496
- }
1497
- }
1498
-
1499
- /** Get the hosting status for a repository, on this server. Expected to be implemented by PDS and Relay. */
1500
- export declare namespace ComAtprotoSyncGetRepoStatus {
1501
- interface Params {
1502
- /** The DID of the repo. */
1503
- did: At.Did;
1504
- }
1505
- type Input = undefined;
1506
- interface Output {
1507
- active: boolean;
1508
- did: At.Did;
1509
- /** Optional field, the current rev of the repo, if active=true */
1510
- rev?: At.Tid;
1511
- /** If active=false, this optional field indicates a possible reason for why the account is not active. If active=false and no status is supplied, then the host makes no claim for why the repository is no longer being hosted. */
1512
- status?:
1513
- | 'deactivated'
1514
- | 'deleted'
1515
- | 'desynchronized'
1516
- | 'suspended'
1517
- | 'takendown'
1518
- | 'throttled'
1519
- | (string & {});
1520
- }
1521
- interface Errors {
1522
- RepoNotFound: {};
1523
- }
1524
- }
1525
-
1526
- /** List blob CIDs for an account, since some repo revision. Does not require auth; implemented by PDS. */
1527
- export declare namespace ComAtprotoSyncListBlobs {
1528
- interface Params {
1529
- /** The DID of the repo. */
1530
- did: At.Did;
1531
- cursor?: string;
1532
- /**
1533
- * Minimum: 1 \
1534
- * Maximum: 1000
1535
- * @default 500
1536
- */
1537
- limit?: number;
1538
- /** Optional revision of the repo to list blobs since. */
1539
- since?: At.Tid;
1540
- }
1541
- type Input = undefined;
1542
- interface Output {
1543
- cids: At.Cid[];
1544
- cursor?: string;
1545
- }
1546
- interface Errors {
1547
- RepoNotFound: {};
1548
- RepoTakendown: {};
1549
- RepoSuspended: {};
1550
- RepoDeactivated: {};
1551
- }
1552
- }
1553
-
1554
- /** Enumerates upstream hosts (eg, PDS or relay instances) that this service consumes from. Implemented by relays. */
1555
- export declare namespace ComAtprotoSyncListHosts {
1556
- interface Params {
1557
- cursor?: string;
1558
- /**
1559
- * Minimum: 1 \
1560
- * Maximum: 1000
1561
- * @default 200
1562
- */
1563
- limit?: number;
1564
- }
1565
- type Input = undefined;
1566
- interface Output {
1567
- /** Sort order is not formally specified. Recommended order is by time host was first seen by the server, with oldest first. */
1568
- hosts: Host[];
1569
- cursor?: string;
1570
- }
1571
- interface Host {
1572
- [Brand.Type]?: 'com.atproto.sync.listHosts#host';
1573
- /** hostname of server; not a URL (no scheme) */
1574
- hostname: string;
1575
- accountCount?: number;
1576
- /** Recent repo stream event sequence number. May be delayed from actual stream processing (eg, persisted cursor not in-memory cursor). */
1577
- seq?: number;
1578
- status?: ComAtprotoSyncDefs.HostStatus;
1579
- }
1580
- }
1581
-
1582
- /** Enumerates all the DID, rev, and commit CID for all repos hosted by this service. Does not require auth; implemented by PDS and Relay. */
1583
- export declare namespace ComAtprotoSyncListRepos {
1584
- interface Params {
1585
- cursor?: string;
1586
- /**
1587
- * Minimum: 1 \
1588
- * Maximum: 1000
1589
- * @default 500
1590
- */
1591
- limit?: number;
1592
- }
1593
- type Input = undefined;
1594
- interface Output {
1595
- repos: Repo[];
1596
- cursor?: string;
1597
- }
1598
- interface Repo {
1599
- [Brand.Type]?: 'com.atproto.sync.listRepos#repo';
1600
- did: At.Did;
1601
- /** Current repo commit CID */
1602
- head: At.Cid;
1603
- rev: At.Tid;
1604
- active?: boolean;
1605
- /** If active=false, this optional field indicates a possible reason for why the account is not active. If active=false and no status is supplied, then the host makes no claim for why the repository is no longer being hosted. */
1606
- status?:
1607
- | 'deactivated'
1608
- | 'deleted'
1609
- | 'desynchronized'
1610
- | 'suspended'
1611
- | 'takendown'
1612
- | 'throttled'
1613
- | (string & {});
1614
- }
1615
- }
1616
-
1617
- /** Enumerates all the DIDs which have records with the given collection NSID. */
1618
- export declare namespace ComAtprotoSyncListReposByCollection {
1619
- interface Params {
1620
- collection: At.Nsid;
1621
- cursor?: string;
1622
- /**
1623
- * Maximum size of response set. Recommend setting a large maximum (1000+) when enumerating large DID lists. \
1624
- * Minimum: 1 \
1625
- * Maximum: 2000
1626
- * @default 500
1627
- */
1628
- limit?: number;
1629
- }
1630
- type Input = undefined;
1631
- interface Output {
1632
- repos: Repo[];
1633
- cursor?: string;
1634
- }
1635
- interface Repo {
1636
- [Brand.Type]?: 'com.atproto.sync.listReposByCollection#repo';
1637
- did: At.Did;
1638
- }
1639
- }
1640
-
1641
- /** Notify a crawling service of a recent update, and that crawling should resume. Intended use is after a gap between repo stream events caused the crawling service to disconnect. Does not require auth; implemented by Relay. DEPRECATED: just use com.atproto.sync.requestCrawl */
1642
- export declare namespace ComAtprotoSyncNotifyOfUpdate {
1643
- interface Params {}
1644
- interface Input {
1645
- /** Hostname of the current service (usually a PDS) that is notifying of update. */
1646
- hostname: string;
1647
- }
1648
- type Output = undefined;
1649
- }
1650
-
1651
- /** Request a service to persistently crawl hosted repos. Expected use is new PDS instances declaring their existence to Relays. Does not require auth. */
1652
- export declare namespace ComAtprotoSyncRequestCrawl {
1653
- interface Params {}
1654
- interface Input {
1655
- /** Hostname of the current service (eg, PDS) that is requesting to be crawled. */
1656
- hostname: string;
1657
- }
1658
- type Output = undefined;
1659
- interface Errors {
1660
- HostBanned: {};
1661
- }
1662
- }
1663
-
1664
- export declare namespace ComAtprotoSyncSubscribeRepos {
1665
- /** Represents a change to an account's status on a host (eg, PDS or Relay). The semantics of this event are that the status is at the host which emitted the event, not necessarily that at the currently active PDS. Eg, a Relay takedown would emit a takedown with active=false, even if the PDS is still active. */
1666
- interface Account {
1667
- [Brand.Type]?: 'com.atproto.sync.subscribeRepos#account';
1668
- /** Indicates that the account has a repository which can be fetched from the host that emitted this event. */
1669
- active: boolean;
1670
- did: At.Did;
1671
- seq: number;
1672
- time: string;
1673
- /** If active=false, this optional field indicates a reason for why the account is not active. */
1674
- status?:
1675
- | 'deactivated'
1676
- | 'deleted'
1677
- | 'desynchronized'
1678
- | 'suspended'
1679
- | 'takendown'
1680
- | 'throttled'
1681
- | (string & {});
1682
- }
1683
- /** Represents an update of repository state. Note that empty commits are allowed, which include no repo data changes, but an update to rev and signature. */
1684
- interface Commit {
1685
- [Brand.Type]?: 'com.atproto.sync.subscribeRepos#commit';
1686
- /**
1687
- * DEPRECATED -- will soon always be empty. List of new blobs (by CID) referenced by records in this commit.
1688
- * @deprecated
1689
- */
1690
- blobs: At.CidLink[];
1691
- /** CAR file containing relevant blocks, as a diff since the previous repo state. The commit must be included as a block, and the commit block CID must be the first entry in the CAR header 'roots' list. */
1692
- blocks: At.Bytes;
1693
- /** Repo commit object CID. */
1694
- commit: At.CidLink;
1695
- /**
1696
- * Maximum array length: 200 \
1697
- * List of repo mutation operations in this commit (eg, records created, updated, or deleted).
1698
- */
1699
- ops: RepoOp[];
1700
- /**
1701
- * DEPRECATED -- unused
1702
- * @deprecated
1703
- */
1704
- rebase: boolean;
1705
- /** The repo this event comes from. Note that all other message types name this field 'did'. */
1706
- repo: At.Did;
1707
- /** The rev of the emitted commit. Note that this information is also in the commit object included in blocks, unless this is a tooBig event. */
1708
- rev: At.Tid;
1709
- /** The stream sequence number of this message. */
1710
- seq: number;
1711
- /** The rev of the last emitted commit from this repo (if any). */
1712
- since: At.Tid | null;
1713
- /** Timestamp of when this message was originally broadcast. */
1714
- time: string;
1715
- /**
1716
- * DEPRECATED -- replaced by #sync event and data limits. Indicates that this commit contained too many ops, or data size was too large. Consumers will need to make a separate request to get missing data.
1717
- * @deprecated
1718
- */
1719
- tooBig: boolean;
1720
- /** The root CID of the MST tree for the previous commit from this repo (indicated by the 'since' revision field in this message). Corresponds to the 'data' field in the repo commit object. NOTE: this field is effectively required for the 'inductive' version of firehose. */
1721
- prevData?: At.CidLink;
1722
- }
1723
- /** Represents a change to an account's identity. Could be an updated handle, signing key, or pds hosting endpoint. Serves as a prod to all downstream services to refresh their identity cache. */
1724
- interface Identity {
1725
- [Brand.Type]?: 'com.atproto.sync.subscribeRepos#identity';
1726
- did: At.Did;
1727
- seq: number;
1728
- time: string;
1729
- /** The current handle for the account, or 'handle.invalid' if validation fails. This field is optional, might have been validated or passed-through from an upstream source. Semantics and behaviors for PDS vs Relay may evolve in the future; see atproto specs for more details. */
1730
- handle?: At.Handle;
1731
- }
1732
- interface Info {
1733
- [Brand.Type]?: 'com.atproto.sync.subscribeRepos#info';
1734
- name: 'OutdatedCursor' | (string & {});
1735
- message?: string;
1736
- }
1737
- /** A repo operation, ie a mutation of a single record. */
1738
- interface RepoOp {
1739
- [Brand.Type]?: 'com.atproto.sync.subscribeRepos#repoOp';
1740
- action: 'create' | 'delete' | 'update' | (string & {});
1741
- /** For creates and updates, the new record CID. For deletions, null. */
1742
- cid: At.CidLink | null;
1743
- path: string;
1744
- /** For updates and deletes, the previous record CID (required for inductive firehose). For creations, field should not be defined. */
1745
- prev?: At.CidLink;
1746
- }
1747
- /** Updates the repo to a new state, without necessarily including that state on the firehose. Used to recover from broken commit streams, data loss incidents, or in situations where upstream host does not know recent state of the repository. */
1748
- interface Sync {
1749
- [Brand.Type]?: 'com.atproto.sync.subscribeRepos#sync';
1750
- /** CAR file containing the commit, as a block. The CAR header must include the commit block CID as the first 'root'. */
1751
- blocks: At.Bytes;
1752
- /** The account this repo event corresponds to. Must match that in the commit object. */
1753
- did: At.Did;
1754
- /** The rev of the commit. This value must match that in the commit object. */
1755
- rev: string;
1756
- /** The stream sequence number of this message. */
1757
- seq: number;
1758
- /** Timestamp of when this message was originally broadcast. */
1759
- time: string;
1760
- }
1761
- }
1762
-
1763
- /** Add a handle to the set of reserved handles. */
1764
- export declare namespace ComAtprotoTempAddReservedHandle {
1765
- interface Params {}
1766
- interface Input {
1767
- handle: string;
1768
- }
1769
- interface Output {}
1770
- }
1771
-
1772
- /** Check accounts location in signup queue. */
1773
- export declare namespace ComAtprotoTempCheckSignupQueue {
1774
- interface Params {}
1775
- type Input = undefined;
1776
- interface Output {
1777
- activated: boolean;
1778
- estimatedTimeMs?: number;
1779
- placeInQueue?: number;
1780
- }
1781
- }
1782
-
1783
- /**
1784
- * DEPRECATED: use queryLabels or subscribeLabels instead -- Fetch all labels from a labeler created after a certain date.
1785
- * @deprecated
1786
- */
1787
- export declare namespace ComAtprotoTempFetchLabels {
1788
- interface Params {
1789
- /**
1790
- * Minimum: 1 \
1791
- * Maximum: 250
1792
- * @default 50
1793
- */
1794
- limit?: number;
1795
- since?: number;
1796
- }
1797
- type Input = undefined;
1798
- interface Output {
1799
- labels: ComAtprotoLabelDefs.Label[];
1800
- }
1801
- }
1802
-
1803
- /** Request a verification code to be sent to the supplied phone number */
1804
- export declare namespace ComAtprotoTempRequestPhoneVerification {
1805
- interface Params {}
1806
- interface Input {
1807
- phoneNumber: string;
1808
- }
1809
- type Output = undefined;
1810
- }
1811
-
1812
- export declare interface Records {
1813
- 'com.atproto.lexicon.schema': ComAtprotoLexiconSchema.Record;
1814
- }
1815
-
1816
- export declare interface Queries {
1817
- 'com.atproto.admin.getAccountInfo': {
1818
- params: ComAtprotoAdminGetAccountInfo.Params;
1819
- /** @deprecated */
1820
- output: ComAtprotoAdminGetAccountInfo.Output;
1821
- response: { json: ComAtprotoAdminGetAccountInfo.Output };
1822
- };
1823
- 'com.atproto.admin.getAccountInfos': {
1824
- params: ComAtprotoAdminGetAccountInfos.Params;
1825
- /** @deprecated */
1826
- output: ComAtprotoAdminGetAccountInfos.Output;
1827
- response: { json: ComAtprotoAdminGetAccountInfos.Output };
1828
- };
1829
- 'com.atproto.admin.getInviteCodes': {
1830
- params: ComAtprotoAdminGetInviteCodes.Params;
1831
- /** @deprecated */
1832
- output: ComAtprotoAdminGetInviteCodes.Output;
1833
- response: { json: ComAtprotoAdminGetInviteCodes.Output };
1834
- };
1835
- 'com.atproto.admin.getSubjectStatus': {
1836
- params: ComAtprotoAdminGetSubjectStatus.Params;
1837
- /** @deprecated */
1838
- output: ComAtprotoAdminGetSubjectStatus.Output;
1839
- response: { json: ComAtprotoAdminGetSubjectStatus.Output };
1840
- };
1841
- 'com.atproto.admin.searchAccounts': {
1842
- params: ComAtprotoAdminSearchAccounts.Params;
1843
- /** @deprecated */
1844
- output: ComAtprotoAdminSearchAccounts.Output;
1845
- response: { json: ComAtprotoAdminSearchAccounts.Output };
1846
- };
1847
- 'com.atproto.identity.getRecommendedDidCredentials': {
1848
- /** @deprecated */
1849
- output: ComAtprotoIdentityGetRecommendedDidCredentials.Output;
1850
- response: { json: ComAtprotoIdentityGetRecommendedDidCredentials.Output };
1851
- };
1852
- 'com.atproto.identity.resolveDid': {
1853
- params: ComAtprotoIdentityResolveDid.Params;
1854
- /** @deprecated */
1855
- output: ComAtprotoIdentityResolveDid.Output;
1856
- response: { json: ComAtprotoIdentityResolveDid.Output };
1857
- };
1858
- 'com.atproto.identity.resolveHandle': {
1859
- params: ComAtprotoIdentityResolveHandle.Params;
1860
- /** @deprecated */
1861
- output: ComAtprotoIdentityResolveHandle.Output;
1862
- response: { json: ComAtprotoIdentityResolveHandle.Output };
1863
- };
1864
- 'com.atproto.identity.resolveIdentity': {
1865
- params: ComAtprotoIdentityResolveIdentity.Params;
1866
- /** @deprecated */
1867
- output: ComAtprotoIdentityResolveIdentity.Output;
1868
- response: { json: ComAtprotoIdentityResolveIdentity.Output };
1869
- };
1870
- 'com.atproto.label.queryLabels': {
1871
- params: ComAtprotoLabelQueryLabels.Params;
1872
- /** @deprecated */
1873
- output: ComAtprotoLabelQueryLabels.Output;
1874
- response: { json: ComAtprotoLabelQueryLabels.Output };
1875
- };
1876
- 'com.atproto.repo.describeRepo': {
1877
- params: ComAtprotoRepoDescribeRepo.Params;
1878
- /** @deprecated */
1879
- output: ComAtprotoRepoDescribeRepo.Output;
1880
- response: { json: ComAtprotoRepoDescribeRepo.Output };
1881
- };
1882
- 'com.atproto.repo.getRecord': {
1883
- params: ComAtprotoRepoGetRecord.Params;
1884
- /** @deprecated */
1885
- output: ComAtprotoRepoGetRecord.Output;
1886
- response: { json: ComAtprotoRepoGetRecord.Output };
1887
- };
1888
- 'com.atproto.repo.listMissingBlobs': {
1889
- params: ComAtprotoRepoListMissingBlobs.Params;
1890
- /** @deprecated */
1891
- output: ComAtprotoRepoListMissingBlobs.Output;
1892
- response: { json: ComAtprotoRepoListMissingBlobs.Output };
1893
- };
1894
- 'com.atproto.repo.listRecords': {
1895
- params: ComAtprotoRepoListRecords.Params;
1896
- /** @deprecated */
1897
- output: ComAtprotoRepoListRecords.Output;
1898
- response: { json: ComAtprotoRepoListRecords.Output };
1899
- };
1900
- 'com.atproto.server.checkAccountStatus': {
1901
- /** @deprecated */
1902
- output: ComAtprotoServerCheckAccountStatus.Output;
1903
- response: { json: ComAtprotoServerCheckAccountStatus.Output };
1904
- };
1905
- 'com.atproto.server.describeServer': {
1906
- /** @deprecated */
1907
- output: ComAtprotoServerDescribeServer.Output;
1908
- response: { json: ComAtprotoServerDescribeServer.Output };
1909
- };
1910
- 'com.atproto.server.getAccountInviteCodes': {
1911
- params: ComAtprotoServerGetAccountInviteCodes.Params;
1912
- /** @deprecated */
1913
- output: ComAtprotoServerGetAccountInviteCodes.Output;
1914
- response: { json: ComAtprotoServerGetAccountInviteCodes.Output };
1915
- };
1916
- 'com.atproto.server.getServiceAuth': {
1917
- params: ComAtprotoServerGetServiceAuth.Params;
1918
- /** @deprecated */
1919
- output: ComAtprotoServerGetServiceAuth.Output;
1920
- response: { json: ComAtprotoServerGetServiceAuth.Output };
1921
- };
1922
- 'com.atproto.server.getSession': {
1923
- /** @deprecated */
1924
- output: ComAtprotoServerGetSession.Output;
1925
- response: { json: ComAtprotoServerGetSession.Output };
1926
- };
1927
- 'com.atproto.server.listAppPasswords': {
1928
- /** @deprecated */
1929
- output: ComAtprotoServerListAppPasswords.Output;
1930
- response: { json: ComAtprotoServerListAppPasswords.Output };
1931
- };
1932
- 'com.atproto.sync.getBlob': {
1933
- params: ComAtprotoSyncGetBlob.Params;
1934
- /** @deprecated */
1935
- output: ComAtprotoSyncGetBlob.Output;
1936
- response: {};
1937
- };
1938
- 'com.atproto.sync.getBlocks': {
1939
- params: ComAtprotoSyncGetBlocks.Params;
1940
- /** @deprecated */
1941
- output: ComAtprotoSyncGetBlocks.Output;
1942
- response: {};
1943
- };
1944
- 'com.atproto.sync.getCheckout': {
1945
- params: ComAtprotoSyncGetCheckout.Params;
1946
- /** @deprecated */
1947
- output: ComAtprotoSyncGetCheckout.Output;
1948
- response: {};
1949
- };
1950
- 'com.atproto.sync.getHead': {
1951
- params: ComAtprotoSyncGetHead.Params;
1952
- /** @deprecated */
1953
- output: ComAtprotoSyncGetHead.Output;
1954
- response: { json: ComAtprotoSyncGetHead.Output };
1955
- };
1956
- 'com.atproto.sync.getHostStatus': {
1957
- params: ComAtprotoSyncGetHostStatus.Params;
1958
- /** @deprecated */
1959
- output: ComAtprotoSyncGetHostStatus.Output;
1960
- response: { json: ComAtprotoSyncGetHostStatus.Output };
1961
- };
1962
- 'com.atproto.sync.getLatestCommit': {
1963
- params: ComAtprotoSyncGetLatestCommit.Params;
1964
- /** @deprecated */
1965
- output: ComAtprotoSyncGetLatestCommit.Output;
1966
- response: { json: ComAtprotoSyncGetLatestCommit.Output };
1967
- };
1968
- 'com.atproto.sync.getRecord': {
1969
- params: ComAtprotoSyncGetRecord.Params;
1970
- /** @deprecated */
1971
- output: ComAtprotoSyncGetRecord.Output;
1972
- response: {};
1973
- };
1974
- 'com.atproto.sync.getRepo': {
1975
- params: ComAtprotoSyncGetRepo.Params;
1976
- /** @deprecated */
1977
- output: ComAtprotoSyncGetRepo.Output;
1978
- response: {};
1979
- };
1980
- 'com.atproto.sync.getRepoStatus': {
1981
- params: ComAtprotoSyncGetRepoStatus.Params;
1982
- /** @deprecated */
1983
- output: ComAtprotoSyncGetRepoStatus.Output;
1984
- response: { json: ComAtprotoSyncGetRepoStatus.Output };
1985
- };
1986
- 'com.atproto.sync.listBlobs': {
1987
- params: ComAtprotoSyncListBlobs.Params;
1988
- /** @deprecated */
1989
- output: ComAtprotoSyncListBlobs.Output;
1990
- response: { json: ComAtprotoSyncListBlobs.Output };
1991
- };
1992
- 'com.atproto.sync.listHosts': {
1993
- params: ComAtprotoSyncListHosts.Params;
1994
- /** @deprecated */
1995
- output: ComAtprotoSyncListHosts.Output;
1996
- response: { json: ComAtprotoSyncListHosts.Output };
1997
- };
1998
- 'com.atproto.sync.listRepos': {
1999
- params: ComAtprotoSyncListRepos.Params;
2000
- /** @deprecated */
2001
- output: ComAtprotoSyncListRepos.Output;
2002
- response: { json: ComAtprotoSyncListRepos.Output };
2003
- };
2004
- 'com.atproto.sync.listReposByCollection': {
2005
- params: ComAtprotoSyncListReposByCollection.Params;
2006
- /** @deprecated */
2007
- output: ComAtprotoSyncListReposByCollection.Output;
2008
- response: { json: ComAtprotoSyncListReposByCollection.Output };
2009
- };
2010
- 'com.atproto.temp.checkSignupQueue': {
2011
- /** @deprecated */
2012
- output: ComAtprotoTempCheckSignupQueue.Output;
2013
- response: { json: ComAtprotoTempCheckSignupQueue.Output };
2014
- };
2015
- 'com.atproto.temp.fetchLabels': {
2016
- params: ComAtprotoTempFetchLabels.Params;
2017
- /** @deprecated */
2018
- output: ComAtprotoTempFetchLabels.Output;
2019
- response: { json: ComAtprotoTempFetchLabels.Output };
2020
- };
2021
- }
2022
-
2023
- export declare interface Procedures {
2024
- 'com.atproto.admin.deleteAccount': {
2025
- input: ComAtprotoAdminDeleteAccount.Input;
2026
- };
2027
- 'com.atproto.admin.disableAccountInvites': {
2028
- input: ComAtprotoAdminDisableAccountInvites.Input;
2029
- };
2030
- 'com.atproto.admin.disableInviteCodes': {
2031
- input: ComAtprotoAdminDisableInviteCodes.Input;
2032
- };
2033
- 'com.atproto.admin.enableAccountInvites': {
2034
- input: ComAtprotoAdminEnableAccountInvites.Input;
2035
- };
2036
- 'com.atproto.admin.sendEmail': {
2037
- input: ComAtprotoAdminSendEmail.Input;
2038
- /** @deprecated */
2039
- output: ComAtprotoAdminSendEmail.Output;
2040
- response: { json: ComAtprotoAdminSendEmail.Output };
2041
- };
2042
- 'com.atproto.admin.updateAccountEmail': {
2043
- input: ComAtprotoAdminUpdateAccountEmail.Input;
2044
- };
2045
- 'com.atproto.admin.updateAccountHandle': {
2046
- input: ComAtprotoAdminUpdateAccountHandle.Input;
2047
- };
2048
- 'com.atproto.admin.updateAccountPassword': {
2049
- input: ComAtprotoAdminUpdateAccountPassword.Input;
2050
- };
2051
- 'com.atproto.admin.updateAccountSigningKey': {
2052
- input: ComAtprotoAdminUpdateAccountSigningKey.Input;
2053
- };
2054
- 'com.atproto.admin.updateSubjectStatus': {
2055
- input: ComAtprotoAdminUpdateSubjectStatus.Input;
2056
- /** @deprecated */
2057
- output: ComAtprotoAdminUpdateSubjectStatus.Output;
2058
- response: { json: ComAtprotoAdminUpdateSubjectStatus.Output };
2059
- };
2060
- 'com.atproto.identity.refreshIdentity': {
2061
- input: ComAtprotoIdentityRefreshIdentity.Input;
2062
- /** @deprecated */
2063
- output: ComAtprotoIdentityRefreshIdentity.Output;
2064
- response: { json: ComAtprotoIdentityRefreshIdentity.Output };
2065
- };
2066
- 'com.atproto.identity.requestPlcOperationSignature': {};
2067
- 'com.atproto.identity.signPlcOperation': {
2068
- input: ComAtprotoIdentitySignPlcOperation.Input;
2069
- /** @deprecated */
2070
- output: ComAtprotoIdentitySignPlcOperation.Output;
2071
- response: { json: ComAtprotoIdentitySignPlcOperation.Output };
2072
- };
2073
- 'com.atproto.identity.submitPlcOperation': {
2074
- input: ComAtprotoIdentitySubmitPlcOperation.Input;
2075
- };
2076
- 'com.atproto.identity.updateHandle': {
2077
- input: ComAtprotoIdentityUpdateHandle.Input;
2078
- };
2079
- 'com.atproto.moderation.createReport': {
2080
- input: ComAtprotoModerationCreateReport.Input;
2081
- /** @deprecated */
2082
- output: ComAtprotoModerationCreateReport.Output;
2083
- response: { json: ComAtprotoModerationCreateReport.Output };
2084
- };
2085
- 'com.atproto.repo.applyWrites': {
2086
- input: ComAtprotoRepoApplyWrites.Input;
2087
- /** @deprecated */
2088
- output: ComAtprotoRepoApplyWrites.Output;
2089
- response: { json: ComAtprotoRepoApplyWrites.Output };
2090
- };
2091
- 'com.atproto.repo.createRecord': {
2092
- input: ComAtprotoRepoCreateRecord.Input;
2093
- /** @deprecated */
2094
- output: ComAtprotoRepoCreateRecord.Output;
2095
- response: { json: ComAtprotoRepoCreateRecord.Output };
2096
- };
2097
- 'com.atproto.repo.deleteRecord': {
2098
- input: ComAtprotoRepoDeleteRecord.Input;
2099
- /** @deprecated */
2100
- output: ComAtprotoRepoDeleteRecord.Output;
2101
- response: { json: ComAtprotoRepoDeleteRecord.Output };
2102
- };
2103
- 'com.atproto.repo.importRepo': {
2104
- input: ComAtprotoRepoImportRepo.Input;
2105
- };
2106
- 'com.atproto.repo.putRecord': {
2107
- input: ComAtprotoRepoPutRecord.Input;
2108
- /** @deprecated */
2109
- output: ComAtprotoRepoPutRecord.Output;
2110
- response: { json: ComAtprotoRepoPutRecord.Output };
2111
- };
2112
- 'com.atproto.repo.uploadBlob': {
2113
- input: ComAtprotoRepoUploadBlob.Input;
2114
- /** @deprecated */
2115
- output: ComAtprotoRepoUploadBlob.Output;
2116
- response: { json: ComAtprotoRepoUploadBlob.Output };
2117
- };
2118
- 'com.atproto.server.activateAccount': {};
2119
- 'com.atproto.server.confirmEmail': {
2120
- input: ComAtprotoServerConfirmEmail.Input;
2121
- };
2122
- 'com.atproto.server.createAccount': {
2123
- input: ComAtprotoServerCreateAccount.Input;
2124
- /** @deprecated */
2125
- output: ComAtprotoServerCreateAccount.Output;
2126
- response: { json: ComAtprotoServerCreateAccount.Output };
2127
- };
2128
- 'com.atproto.server.createAppPassword': {
2129
- input: ComAtprotoServerCreateAppPassword.Input;
2130
- /** @deprecated */
2131
- output: ComAtprotoServerCreateAppPassword.Output;
2132
- response: { json: ComAtprotoServerCreateAppPassword.Output };
2133
- };
2134
- 'com.atproto.server.createInviteCode': {
2135
- input: ComAtprotoServerCreateInviteCode.Input;
2136
- /** @deprecated */
2137
- output: ComAtprotoServerCreateInviteCode.Output;
2138
- response: { json: ComAtprotoServerCreateInviteCode.Output };
2139
- };
2140
- 'com.atproto.server.createInviteCodes': {
2141
- input: ComAtprotoServerCreateInviteCodes.Input;
2142
- /** @deprecated */
2143
- output: ComAtprotoServerCreateInviteCodes.Output;
2144
- response: { json: ComAtprotoServerCreateInviteCodes.Output };
2145
- };
2146
- 'com.atproto.server.createSession': {
2147
- input: ComAtprotoServerCreateSession.Input;
2148
- /** @deprecated */
2149
- output: ComAtprotoServerCreateSession.Output;
2150
- response: { json: ComAtprotoServerCreateSession.Output };
2151
- };
2152
- 'com.atproto.server.deactivateAccount': {
2153
- input: ComAtprotoServerDeactivateAccount.Input;
2154
- };
2155
- 'com.atproto.server.deleteAccount': {
2156
- input: ComAtprotoServerDeleteAccount.Input;
2157
- };
2158
- 'com.atproto.server.deleteSession': {};
2159
- 'com.atproto.server.refreshSession': {
2160
- /** @deprecated */
2161
- output: ComAtprotoServerRefreshSession.Output;
2162
- response: { json: ComAtprotoServerRefreshSession.Output };
2163
- };
2164
- 'com.atproto.server.requestAccountDelete': {};
2165
- 'com.atproto.server.requestEmailConfirmation': {};
2166
- 'com.atproto.server.requestEmailUpdate': {
2167
- /** @deprecated */
2168
- output: ComAtprotoServerRequestEmailUpdate.Output;
2169
- response: { json: ComAtprotoServerRequestEmailUpdate.Output };
2170
- };
2171
- 'com.atproto.server.requestPasswordReset': {
2172
- input: ComAtprotoServerRequestPasswordReset.Input;
2173
- };
2174
- 'com.atproto.server.reserveSigningKey': {
2175
- input: ComAtprotoServerReserveSigningKey.Input;
2176
- /** @deprecated */
2177
- output: ComAtprotoServerReserveSigningKey.Output;
2178
- response: { json: ComAtprotoServerReserveSigningKey.Output };
2179
- };
2180
- 'com.atproto.server.resetPassword': {
2181
- input: ComAtprotoServerResetPassword.Input;
2182
- };
2183
- 'com.atproto.server.revokeAppPassword': {
2184
- input: ComAtprotoServerRevokeAppPassword.Input;
2185
- };
2186
- 'com.atproto.server.updateEmail': {
2187
- input: ComAtprotoServerUpdateEmail.Input;
2188
- };
2189
- 'com.atproto.sync.notifyOfUpdate': {
2190
- input: ComAtprotoSyncNotifyOfUpdate.Input;
2191
- };
2192
- 'com.atproto.sync.requestCrawl': {
2193
- input: ComAtprotoSyncRequestCrawl.Input;
2194
- };
2195
- 'com.atproto.temp.addReservedHandle': {
2196
- input: ComAtprotoTempAddReservedHandle.Input;
2197
- /** @deprecated */
2198
- output: ComAtprotoTempAddReservedHandle.Output;
2199
- response: { json: ComAtprotoTempAddReservedHandle.Output };
2200
- };
2201
- 'com.atproto.temp.requestPhoneVerification': {
2202
- input: ComAtprotoTempRequestPhoneVerification.Input;
2203
- };
2204
- }