@atcute/client 2.0.9 → 3.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.
@@ -3,7 +3,7 @@
3
3
  * Contains type declarations for AT Protocol lexicons
4
4
  */
5
5
  type ObjectOmit<T, K extends keyof any> = Omit<T, K>;
6
- /** Handles type branding in objects */
6
+ /** handles type branding in objects */
7
7
  export declare namespace Brand {
8
8
  /** Symbol used to brand objects, this does not actually exist in runtime */
9
9
  const Type: unique symbol;
@@ -22,25 +22,73 @@ export declare namespace Brand {
22
22
  [Type]?: string;
23
23
  }> = ObjectOmit<T, typeof Type>;
24
24
  }
25
- /** Base AT Protocol schema types */
25
+ /** base AT Protocol schema types */
26
26
  export declare namespace At {
27
- /** CID string */
28
- type CID = string;
29
- /** DID of a user */
30
- type DID = `did:${string}`;
31
- /** User handle */
32
- type Handle = string;
33
- /** URI string */
34
- type Uri = string;
35
- /** Object containing a CID string */
36
- interface CIDLink {
37
- $link: CID;
38
- }
39
- /** Object containing a base64-encoded bytes */
27
+ /**
28
+ * represents a Content Identifier (CID) string
29
+ */
30
+ type Cid = string;
31
+ /**
32
+ * represents a Decentralized Identifier (DID).
33
+ */
34
+ type Did<Method extends string = string> = `did:${Method}:${string}`;
35
+ /**
36
+ * represents an account's handle, using domains as a human-friendly
37
+ * identifier.
38
+ */
39
+ type Handle = `${string}.${string}`;
40
+ /**
41
+ * represents an account's identifier, either a {@link Did} or a
42
+ * {@link Handle}
43
+ */
44
+ type Identifier = Did | Handle;
45
+ /**
46
+ * represents a Namespace Identifier (NSID)
47
+ */
48
+ type Nsid = `${string}.${string}.${string}`;
49
+ /**
50
+ * represents the unique key identifying a specific record within a
51
+ * repository's collection. this is usually a {@link Tid}.
52
+ */
53
+ type RecordKey = string;
54
+ /**
55
+ * represents a Timestamp Identifier (TID)
56
+ */
57
+ type Tid = string;
58
+ /**
59
+ * represents a general AT Protocol URI, representing either an entire
60
+ * repository, a specific collection within a repository, or a record.
61
+ *
62
+ * it allows using handles over DIDs, but this means that it won't be stable.
63
+ */
64
+ type ResourceUri = `at://${Identifier}` | `at://${Identifier}/${Nsid}` | `at://${Identifier}/${Nsid}/${RecordKey}`;
65
+ /**
66
+ * represents a canonical AT Protocol URI for a specific record.
67
+ *
68
+ * this URI format uses the account's DID as the authority, ensuring that
69
+ * the URI remains valid even as the account changes handles, uniquely
70
+ * identifying a specific piece of record within AT Protocol.
71
+ */
72
+ type CanonicalResourceUri = `at://${Did}/${Nsid}/${RecordKey}`;
73
+ /**
74
+ * represents a generic URI
75
+ */
76
+ type GenericUri = `${string}:${string}`;
77
+ /**
78
+ * represents a Content Identifier (CID) reference
79
+ */
80
+ interface CidLink {
81
+ $link: Cid;
82
+ }
83
+ /**
84
+ * represents an object containing raw binary data encoded as a base64 string
85
+ */
40
86
  interface Bytes {
41
87
  $bytes: string;
42
88
  }
43
- /** Blob interface */
89
+ /**
90
+ * represents a reference to a data blob
91
+ */
44
92
  interface Blob<T extends string = string> {
45
93
  $type: 'blob';
46
94
  mimeType: T;
@@ -53,7 +101,7 @@ export declare namespace At {
53
101
  export declare namespace ComAtprotoAdminDefs {
54
102
  interface AccountView {
55
103
  [Brand.Type]?: 'com.atproto.admin.defs#accountView';
56
- did: At.DID;
104
+ did: At.Did;
57
105
  handle: At.Handle;
58
106
  indexedAt: string;
59
107
  deactivatedAt?: string;
@@ -68,13 +116,13 @@ export declare namespace ComAtprotoAdminDefs {
68
116
  }
69
117
  interface RepoBlobRef {
70
118
  [Brand.Type]?: 'com.atproto.admin.defs#repoBlobRef';
71
- cid: At.CID;
72
- did: At.DID;
73
- recordUri?: At.Uri;
119
+ cid: At.Cid;
120
+ did: At.Did;
121
+ recordUri?: At.ResourceUri;
74
122
  }
75
123
  interface RepoRef {
76
124
  [Brand.Type]?: 'com.atproto.admin.defs#repoRef';
77
- did: At.DID;
125
+ did: At.Did;
78
126
  }
79
127
  interface StatusAttr {
80
128
  [Brand.Type]?: 'com.atproto.admin.defs#statusAttr';
@@ -92,7 +140,7 @@ export declare namespace ComAtprotoAdminDeleteAccount {
92
140
  interface Params {
93
141
  }
94
142
  interface Input {
95
- did: At.DID;
143
+ did: At.Did;
96
144
  }
97
145
  type Output = undefined;
98
146
  }
@@ -101,7 +149,7 @@ export declare namespace ComAtprotoAdminDisableAccountInvites {
101
149
  interface Params {
102
150
  }
103
151
  interface Input {
104
- account: At.DID;
152
+ account: At.Did;
105
153
  /** Optional reason for disabled invites. */
106
154
  note?: string;
107
155
  }
@@ -122,7 +170,7 @@ export declare namespace ComAtprotoAdminEnableAccountInvites {
122
170
  interface Params {
123
171
  }
124
172
  interface Input {
125
- account: At.DID;
173
+ account: At.Did;
126
174
  /** Optional reason for enabled invites. */
127
175
  note?: string;
128
176
  }
@@ -131,7 +179,7 @@ export declare namespace ComAtprotoAdminEnableAccountInvites {
131
179
  /** Get details about an account. */
132
180
  export declare namespace ComAtprotoAdminGetAccountInfo {
133
181
  interface Params {
134
- did: At.DID;
182
+ did: At.Did;
135
183
  }
136
184
  type Input = undefined;
137
185
  type Output = ComAtprotoAdminDefs.AccountView;
@@ -139,7 +187,7 @@ export declare namespace ComAtprotoAdminGetAccountInfo {
139
187
  /** Get details about some accounts. */
140
188
  export declare namespace ComAtprotoAdminGetAccountInfos {
141
189
  interface Params {
142
- dids: At.DID[];
190
+ dids: At.Did[];
143
191
  }
144
192
  type Input = undefined;
145
193
  interface Output {
@@ -168,9 +216,9 @@ export declare namespace ComAtprotoAdminGetInviteCodes {
168
216
  /** Get the service-specific admin status of a subject (account, record, or blob). */
169
217
  export declare namespace ComAtprotoAdminGetSubjectStatus {
170
218
  interface Params {
171
- blob?: At.CID;
172
- did?: At.DID;
173
- uri?: At.Uri;
219
+ blob?: At.Cid;
220
+ did?: At.Did;
221
+ uri?: At.ResourceUri;
174
222
  }
175
223
  type Input = undefined;
176
224
  interface Output {
@@ -203,8 +251,8 @@ export declare namespace ComAtprotoAdminSendEmail {
203
251
  }
204
252
  interface Input {
205
253
  content: string;
206
- recipientDid: At.DID;
207
- senderDid: At.DID;
254
+ recipientDid: At.Did;
255
+ senderDid: At.Did;
208
256
  /** Additional comment by the sender that won't be used in the email itself but helpful to provide more context for moderators/reviewers */
209
257
  comment?: string;
210
258
  subject?: string;
@@ -219,7 +267,7 @@ export declare namespace ComAtprotoAdminUpdateAccountEmail {
219
267
  }
220
268
  interface Input {
221
269
  /** The handle or DID of the repo. */
222
- account: string;
270
+ account: At.Identifier;
223
271
  email: string;
224
272
  }
225
273
  type Output = undefined;
@@ -229,7 +277,7 @@ export declare namespace ComAtprotoAdminUpdateAccountHandle {
229
277
  interface Params {
230
278
  }
231
279
  interface Input {
232
- did: At.DID;
280
+ did: At.Did;
233
281
  handle: At.Handle;
234
282
  }
235
283
  type Output = undefined;
@@ -239,11 +287,22 @@ export declare namespace ComAtprotoAdminUpdateAccountPassword {
239
287
  interface Params {
240
288
  }
241
289
  interface Input {
242
- did: At.DID;
290
+ did: At.Did;
243
291
  password: string;
244
292
  }
245
293
  type Output = undefined;
246
294
  }
295
+ /** Administrative action to update an account's signing key in their Did document. */
296
+ export declare namespace ComAtprotoAdminUpdateAccountSigningKey {
297
+ interface Params {
298
+ }
299
+ interface Input {
300
+ did: At.Did;
301
+ /** Did-key formatted public key */
302
+ signingKey: At.Did;
303
+ }
304
+ type Output = undefined;
305
+ }
247
306
  /** Update the service-specific admin status of a subject (account, record, or blob). */
248
307
  export declare namespace ComAtprotoAdminUpdateSubjectStatus {
249
308
  interface Params {
@@ -261,7 +320,7 @@ export declare namespace ComAtprotoAdminUpdateSubjectStatus {
261
320
  export declare namespace ComAtprotoIdentityDefs {
262
321
  interface IdentityInfo {
263
322
  [Brand.Type]?: 'com.atproto.identity.defs#identityInfo';
264
- did: At.DID;
323
+ did: At.Did;
265
324
  /** The complete DID document for the identity. */
266
325
  didDoc: unknown;
267
326
  /** The validated handle of the account; or 'handle.invalid' if the handle did not bi-directionally match the DID document. */
@@ -286,7 +345,7 @@ export declare namespace ComAtprotoIdentityRefreshIdentity {
286
345
  interface Params {
287
346
  }
288
347
  interface Input {
289
- identifier: string;
348
+ identifier: At.Identifier;
290
349
  }
291
350
  type Output = ComAtprotoIdentityDefs.IdentityInfo;
292
351
  interface Errors {
@@ -306,7 +365,7 @@ export declare namespace ComAtprotoIdentityRequestPlcOperationSignature {
306
365
  export declare namespace ComAtprotoIdentityResolveDid {
307
366
  interface Params {
308
367
  /** DID to resolve. */
309
- did: At.DID;
368
+ did: At.Did;
310
369
  }
311
370
  type Input = undefined;
312
371
  interface Output {
@@ -326,7 +385,7 @@ export declare namespace ComAtprotoIdentityResolveHandle {
326
385
  }
327
386
  type Input = undefined;
328
387
  interface Output {
329
- did: At.DID;
388
+ did: At.Did;
330
389
  }
331
390
  interface Errors {
332
391
  HandleNotFound: {};
@@ -336,7 +395,7 @@ export declare namespace ComAtprotoIdentityResolveHandle {
336
395
  export declare namespace ComAtprotoIdentityResolveIdentity {
337
396
  interface Params {
338
397
  /** Handle or DID to resolve. */
339
- identifier: string;
398
+ identifier: At.Identifier;
340
399
  }
341
400
  type Input = undefined;
342
401
  type Output = ComAtprotoIdentityDefs.IdentityInfo;
@@ -389,16 +448,16 @@ export declare namespace ComAtprotoLabelDefs {
389
448
  /** Timestamp when this label was created. */
390
449
  cts: string;
391
450
  /** DID of the actor who created this label. */
392
- src: At.DID;
451
+ src: At.Did;
393
452
  /** AT URI of the record, repository (account), or other resource that this label applies to. */
394
- uri: string;
453
+ uri: At.GenericUri;
395
454
  /**
396
455
  * The short string name of the value or type of this label. \
397
456
  * Maximum string length: 128
398
457
  */
399
458
  val: string;
400
459
  /** Optionally, CID specifying the specific version of 'uri' resource this label applies to. */
401
- cid?: At.CID;
460
+ cid?: At.Cid;
402
461
  /** Timestamp at which this label expires (no longer applies). */
403
462
  exp?: string;
404
463
  /** If true, this is a negation label, overwriting a previous label. */
@@ -478,7 +537,7 @@ export declare namespace ComAtprotoLabelQueryLabels {
478
537
  */
479
538
  limit?: number;
480
539
  /** Optional list of label sources (DIDs) to filter on. */
481
- sources?: At.DID[];
540
+ sources?: At.Did[];
482
541
  }
483
542
  type Input = undefined;
484
543
  interface Output {
@@ -525,7 +584,7 @@ export declare namespace ComAtprotoModerationCreateReport {
525
584
  createdAt: string;
526
585
  id: number;
527
586
  reasonType: ComAtprotoModerationDefs.ReasonType;
528
- reportedBy: At.DID;
587
+ reportedBy: At.Did;
529
588
  subject: Brand.Union<ComAtprotoAdminDefs.RepoRef | ComAtprotoRepoStrongRef.Main>;
530
589
  /**
531
590
  * Maximum string length: 20000 \
@@ -552,10 +611,10 @@ export declare namespace ComAtprotoRepoApplyWrites {
552
611
  }
553
612
  interface Input {
554
613
  /** The handle or DID of the repo (aka, current account). */
555
- repo: string;
614
+ repo: At.Identifier;
556
615
  writes: Brand.Union<Create | Delete | Update>[];
557
616
  /** If provided, the entire operation will fail if the current repo commit CID does not match this value. Used to prevent conflicting repo mutations. */
558
- swapCommit?: At.CID;
617
+ swapCommit?: At.Cid;
559
618
  /** 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. */
560
619
  validate?: boolean;
561
620
  }
@@ -569,22 +628,22 @@ export declare namespace ComAtprotoRepoApplyWrites {
569
628
  /** Operation which creates a new record. */
570
629
  interface Create {
571
630
  [Brand.Type]?: 'com.atproto.repo.applyWrites#create';
572
- collection: string;
631
+ collection: At.Nsid;
573
632
  value: unknown;
574
633
  /** NOTE: maxLength is redundant with record-key format. Keeping it temporarily to ensure backwards compatibility. */
575
- rkey?: string;
634
+ rkey?: At.RecordKey;
576
635
  }
577
636
  interface CreateResult {
578
637
  [Brand.Type]?: 'com.atproto.repo.applyWrites#createResult';
579
- cid: At.CID;
580
- uri: At.Uri;
638
+ cid: At.Cid;
639
+ uri: At.ResourceUri;
581
640
  validationStatus?: 'unknown' | 'valid' | (string & {});
582
641
  }
583
642
  /** Operation which deletes an existing record. */
584
643
  interface Delete {
585
644
  [Brand.Type]?: 'com.atproto.repo.applyWrites#delete';
586
- collection: string;
587
- rkey: string;
645
+ collection: At.Nsid;
646
+ rkey: At.RecordKey;
588
647
  }
589
648
  interface DeleteResult {
590
649
  [Brand.Type]?: 'com.atproto.repo.applyWrites#deleteResult';
@@ -592,14 +651,14 @@ export declare namespace ComAtprotoRepoApplyWrites {
592
651
  /** Operation which updates an existing record. */
593
652
  interface Update {
594
653
  [Brand.Type]?: 'com.atproto.repo.applyWrites#update';
595
- collection: string;
596
- rkey: string;
654
+ collection: At.Nsid;
655
+ rkey: At.RecordKey;
597
656
  value: unknown;
598
657
  }
599
658
  interface UpdateResult {
600
659
  [Brand.Type]?: 'com.atproto.repo.applyWrites#updateResult';
601
- cid: At.CID;
602
- uri: At.Uri;
660
+ cid: At.Cid;
661
+ uri: At.ResourceUri;
603
662
  validationStatus?: 'unknown' | 'valid' | (string & {});
604
663
  }
605
664
  }
@@ -609,21 +668,21 @@ export declare namespace ComAtprotoRepoCreateRecord {
609
668
  }
610
669
  interface Input {
611
670
  /** The NSID of the record collection. */
612
- collection: string;
671
+ collection: At.Nsid;
613
672
  /** The record itself. Must contain a $type field. */
614
673
  record: unknown;
615
674
  /** The handle or DID of the repo (aka, current account). */
616
- repo: string;
675
+ repo: At.Identifier;
617
676
  /** The Record Key. */
618
- rkey?: string;
677
+ rkey?: At.RecordKey;
619
678
  /** Compare and swap with the previous commit by CID. */
620
- swapCommit?: At.CID;
679
+ swapCommit?: At.Cid;
621
680
  /** 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. */
622
681
  validate?: boolean;
623
682
  }
624
683
  interface Output {
625
- cid: At.CID;
626
- uri: At.Uri;
684
+ cid: At.Cid;
685
+ uri: At.ResourceUri;
627
686
  commit?: ComAtprotoRepoDefs.CommitMeta;
628
687
  validationStatus?: 'unknown' | 'valid' | (string & {});
629
688
  }
@@ -634,8 +693,8 @@ export declare namespace ComAtprotoRepoCreateRecord {
634
693
  export declare namespace ComAtprotoRepoDefs {
635
694
  interface CommitMeta {
636
695
  [Brand.Type]?: 'com.atproto.repo.defs#commitMeta';
637
- cid: At.CID;
638
- rev: string;
696
+ cid: At.Cid;
697
+ rev: At.Tid;
639
698
  }
640
699
  }
641
700
  /** Delete a repository record, or ensure it doesn't exist. Requires auth, implemented by PDS. */
@@ -644,15 +703,15 @@ export declare namespace ComAtprotoRepoDeleteRecord {
644
703
  }
645
704
  interface Input {
646
705
  /** The NSID of the record collection. */
647
- collection: string;
706
+ collection: At.Nsid;
648
707
  /** The handle or DID of the repo (aka, current account). */
649
- repo: string;
708
+ repo: At.Identifier;
650
709
  /** The Record Key. */
651
- rkey: string;
710
+ rkey: At.RecordKey;
652
711
  /** Compare and swap with the previous commit by CID. */
653
- swapCommit?: At.CID;
712
+ swapCommit?: At.Cid;
654
713
  /** Compare and swap with the previous record by CID. */
655
- swapRecord?: At.CID;
714
+ swapRecord?: At.Cid;
656
715
  }
657
716
  interface Output {
658
717
  commit?: ComAtprotoRepoDefs.CommitMeta;
@@ -665,13 +724,13 @@ export declare namespace ComAtprotoRepoDeleteRecord {
665
724
  export declare namespace ComAtprotoRepoDescribeRepo {
666
725
  interface Params {
667
726
  /** The handle or DID of the repo. */
668
- repo: string;
727
+ repo: At.Identifier;
669
728
  }
670
729
  type Input = undefined;
671
730
  interface Output {
672
731
  /** List of all the collections (NSIDs) for which this repo contains at least one record. */
673
- collections: string[];
674
- did: At.DID;
732
+ collections: At.Nsid[];
733
+ did: At.Did;
675
734
  /** The complete DID document for this account. */
676
735
  didDoc: unknown;
677
736
  handle: At.Handle;
@@ -683,19 +742,19 @@ export declare namespace ComAtprotoRepoDescribeRepo {
683
742
  export declare namespace ComAtprotoRepoGetRecord {
684
743
  interface Params {
685
744
  /** The NSID of the record collection. */
686
- collection: string;
745
+ collection: At.Nsid;
687
746
  /** The handle or DID of the repo. */
688
- repo: string;
747
+ repo: At.Identifier;
689
748
  /** The Record Key. */
690
- rkey: string;
749
+ rkey: At.RecordKey;
691
750
  /** The CID of the version of the record. If not specified, then return the most recent version. */
692
- cid?: At.CID;
751
+ cid?: At.Cid;
693
752
  }
694
753
  type Input = undefined;
695
754
  interface Output {
696
- uri: At.Uri;
755
+ uri: At.ResourceUri;
697
756
  value: unknown;
698
- cid?: At.CID;
757
+ cid?: At.Cid;
699
758
  }
700
759
  interface Errors {
701
760
  RecordNotFound: {};
@@ -705,7 +764,7 @@ export declare namespace ComAtprotoRepoGetRecord {
705
764
  export declare namespace ComAtprotoRepoImportRepo {
706
765
  interface Params {
707
766
  }
708
- type Input = Blob | ArrayBufferView;
767
+ type Input = Blob | BufferSource | ReadableStream;
709
768
  type Output = undefined;
710
769
  }
711
770
  /** Returns a list of missing blobs for the requesting account. Intended to be used in the account migration flow. */
@@ -726,17 +785,17 @@ export declare namespace ComAtprotoRepoListMissingBlobs {
726
785
  }
727
786
  interface RecordBlob {
728
787
  [Brand.Type]?: 'com.atproto.repo.listMissingBlobs#recordBlob';
729
- cid: At.CID;
730
- recordUri: At.Uri;
788
+ cid: At.Cid;
789
+ recordUri: At.ResourceUri;
731
790
  }
732
791
  }
733
792
  /** List a range of records in a repository, matching a specific collection. Does not require auth. */
734
793
  export declare namespace ComAtprotoRepoListRecords {
735
794
  interface Params {
736
795
  /** The NSID of the record type. */
737
- collection: string;
796
+ collection: At.Nsid;
738
797
  /** The handle or DID of the repo. */
739
- repo: string;
798
+ repo: At.Identifier;
740
799
  cursor?: string;
741
800
  /**
742
801
  * The number of records to return. \
@@ -755,8 +814,8 @@ export declare namespace ComAtprotoRepoListRecords {
755
814
  }
756
815
  interface Record {
757
816
  [Brand.Type]?: 'com.atproto.repo.listRecords#record';
758
- cid: At.CID;
759
- uri: At.Uri;
817
+ cid: At.Cid;
818
+ uri: At.ResourceUri;
760
819
  value: unknown;
761
820
  }
762
821
  }
@@ -766,23 +825,23 @@ export declare namespace ComAtprotoRepoPutRecord {
766
825
  }
767
826
  interface Input {
768
827
  /** The NSID of the record collection. */
769
- collection: string;
828
+ collection: At.Nsid;
770
829
  /** The record to write. */
771
830
  record: unknown;
772
831
  /** The handle or DID of the repo (aka, current account). */
773
- repo: string;
832
+ repo: At.Identifier;
774
833
  /** The Record Key. */
775
- rkey: string;
834
+ rkey: At.RecordKey;
776
835
  /** Compare and swap with the previous commit by CID. */
777
- swapCommit?: At.CID;
836
+ swapCommit?: At.Cid;
778
837
  /** Compare and swap with the previous record by CID. WARNING: nullable and optional field; may cause problems with golang implementation */
779
- swapRecord?: At.CID | null;
838
+ swapRecord?: At.Cid | null;
780
839
  /** 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. */
781
840
  validate?: boolean;
782
841
  }
783
842
  interface Output {
784
- cid: At.CID;
785
- uri: At.Uri;
843
+ cid: At.Cid;
844
+ uri: At.ResourceUri;
786
845
  commit?: ComAtprotoRepoDefs.CommitMeta;
787
846
  validationStatus?: 'unknown' | 'valid' | (string & {});
788
847
  }
@@ -793,15 +852,15 @@ export declare namespace ComAtprotoRepoPutRecord {
793
852
  export declare namespace ComAtprotoRepoStrongRef {
794
853
  interface Main {
795
854
  [Brand.Type]?: 'com.atproto.repo.strongRef';
796
- cid: At.CID;
797
- uri: At.Uri;
855
+ cid: At.Cid;
856
+ uri: At.ResourceUri;
798
857
  }
799
858
  }
800
859
  /** 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. */
801
860
  export declare namespace ComAtprotoRepoUploadBlob {
802
861
  interface Params {
803
862
  }
804
- type Input = Blob | ArrayBufferView;
863
+ type Input = Blob | BufferSource | ReadableStream;
805
864
  interface Output {
806
865
  blob: At.Blob;
807
866
  }
@@ -825,7 +884,7 @@ export declare namespace ComAtprotoServerCheckAccountStatus {
825
884
  indexedRecords: number;
826
885
  privateStateValues: number;
827
886
  repoBlocks: number;
828
- repoCommit: At.CID;
887
+ repoCommit: At.Cid;
829
888
  repoRev: string;
830
889
  validDid: boolean;
831
890
  }
@@ -854,7 +913,7 @@ export declare namespace ComAtprotoServerCreateAccount {
854
913
  /** Requested handle for the account. */
855
914
  handle: At.Handle;
856
915
  /** Pre-existing atproto DID, being imported to a new account. */
857
- did?: At.DID;
916
+ did?: At.Did;
858
917
  email?: string;
859
918
  inviteCode?: string;
860
919
  /** Initial account password. May need to meet instance-specific password strength requirements. */
@@ -870,7 +929,7 @@ export declare namespace ComAtprotoServerCreateAccount {
870
929
  interface Output {
871
930
  accessJwt: string;
872
931
  /** The DID of the new account. */
873
- did: At.DID;
932
+ did: At.Did;
874
933
  handle: At.Handle;
875
934
  refreshJwt: string;
876
935
  /** Complete DID document. */
@@ -914,7 +973,7 @@ export declare namespace ComAtprotoServerCreateInviteCode {
914
973
  }
915
974
  interface Input {
916
975
  useCount: number;
917
- forAccount?: At.DID;
976
+ forAccount?: At.Did;
918
977
  }
919
978
  interface Output {
920
979
  code: string;
@@ -928,7 +987,7 @@ export declare namespace ComAtprotoServerCreateInviteCodes {
928
987
  /** @default 1 */
929
988
  codeCount: number;
930
989
  useCount: number;
931
- forAccounts?: At.DID[];
990
+ forAccounts?: At.Did[];
932
991
  }
933
992
  interface Output {
934
993
  codes: AccountCodes[];
@@ -953,7 +1012,7 @@ export declare namespace ComAtprotoServerCreateSession {
953
1012
  }
954
1013
  interface Output {
955
1014
  accessJwt: string;
956
- did: At.DID;
1015
+ did: At.Did;
957
1016
  handle: At.Handle;
958
1017
  refreshJwt: string;
959
1018
  active?: boolean;
@@ -993,7 +1052,7 @@ export declare namespace ComAtprotoServerDefs {
993
1052
  interface InviteCodeUse {
994
1053
  [Brand.Type]?: 'com.atproto.server.defs#inviteCodeUse';
995
1054
  usedAt: string;
996
- usedBy: At.DID;
1055
+ usedBy: At.Did;
997
1056
  }
998
1057
  }
999
1058
  /** Delete an actor's account with a token and password. Can only be called after requesting a deletion token. Requires auth. */
@@ -1001,7 +1060,7 @@ export declare namespace ComAtprotoServerDeleteAccount {
1001
1060
  interface Params {
1002
1061
  }
1003
1062
  interface Input {
1004
- did: At.DID;
1063
+ did: At.Did;
1005
1064
  password: string;
1006
1065
  token: string;
1007
1066
  }
@@ -1026,7 +1085,7 @@ export declare namespace ComAtprotoServerDescribeServer {
1026
1085
  interface Output {
1027
1086
  /** List of domain suffixes that can be used in account handles. */
1028
1087
  availableUserDomains: string[];
1029
- did: At.DID;
1088
+ did: At.Did;
1030
1089
  /** Contact information */
1031
1090
  contact?: Contact;
1032
1091
  /** If true, an invite code must be supplied to create an account on this instance. */
@@ -1042,8 +1101,8 @@ export declare namespace ComAtprotoServerDescribeServer {
1042
1101
  }
1043
1102
  interface Links {
1044
1103
  [Brand.Type]?: 'com.atproto.server.describeServer#links';
1045
- privacyPolicy?: string;
1046
- termsOfService?: string;
1104
+ privacyPolicy?: At.GenericUri;
1105
+ termsOfService?: At.GenericUri;
1047
1106
  }
1048
1107
  }
1049
1108
  /** Get all invite codes for the current account. Requires auth. */
@@ -1069,11 +1128,11 @@ export declare namespace ComAtprotoServerGetAccountInviteCodes {
1069
1128
  export declare namespace ComAtprotoServerGetServiceAuth {
1070
1129
  interface Params {
1071
1130
  /** The DID of the service that the token will be used to authenticate with */
1072
- aud: At.DID;
1131
+ aud: At.Did;
1073
1132
  /** 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. */
1074
1133
  exp?: number;
1075
1134
  /** Lexicon (XRPC) method to bind the requested token to */
1076
- lxm?: string;
1135
+ lxm?: At.Nsid;
1077
1136
  }
1078
1137
  type Input = undefined;
1079
1138
  interface Output {
@@ -1089,7 +1148,7 @@ export declare namespace ComAtprotoServerGetSession {
1089
1148
  }
1090
1149
  type Input = undefined;
1091
1150
  interface Output {
1092
- did: At.DID;
1151
+ did: At.Did;
1093
1152
  handle: At.Handle;
1094
1153
  active?: boolean;
1095
1154
  didDoc?: unknown;
@@ -1125,7 +1184,7 @@ export declare namespace ComAtprotoServerRefreshSession {
1125
1184
  type Input = undefined;
1126
1185
  interface Output {
1127
1186
  accessJwt: string;
1128
- did: At.DID;
1187
+ did: At.Did;
1129
1188
  handle: At.Handle;
1130
1189
  refreshJwt: string;
1131
1190
  active?: boolean;
@@ -1175,7 +1234,7 @@ export declare namespace ComAtprotoServerReserveSigningKey {
1175
1234
  }
1176
1235
  interface Input {
1177
1236
  /** The DID to reserve a key for. */
1178
- did?: At.DID;
1237
+ did?: At.Did;
1179
1238
  }
1180
1239
  interface Output {
1181
1240
  /** The public key for the reserved signing key, in did:key serialization. */
@@ -1222,13 +1281,16 @@ export declare namespace ComAtprotoServerUpdateEmail {
1222
1281
  TokenRequired: {};
1223
1282
  }
1224
1283
  }
1284
+ export declare namespace ComAtprotoSyncDefs {
1285
+ type HostStatus = 'active' | 'banned' | 'idle' | 'offline' | 'throttled' | (string & {});
1286
+ }
1225
1287
  /** Get a blob associated with a given account. Returns the full blob as originally uploaded. Does not require auth; implemented by PDS. */
1226
1288
  export declare namespace ComAtprotoSyncGetBlob {
1227
1289
  interface Params {
1228
1290
  /** The CID of the blob to fetch */
1229
- cid: At.CID;
1291
+ cid: At.Cid;
1230
1292
  /** The DID of the account. */
1231
- did: At.DID;
1293
+ did: At.Did;
1232
1294
  }
1233
1295
  type Input = undefined;
1234
1296
  type Output = Uint8Array;
@@ -1243,9 +1305,9 @@ export declare namespace ComAtprotoSyncGetBlob {
1243
1305
  /** Get data blocks from a given repo, by CID. For example, intermediate MST nodes, or records. Does not require auth; implemented by PDS. */
1244
1306
  export declare namespace ComAtprotoSyncGetBlocks {
1245
1307
  interface Params {
1246
- cids: At.CID[];
1308
+ cids: At.Cid[];
1247
1309
  /** The DID of the repo. */
1248
- did: At.DID;
1310
+ did: At.Did;
1249
1311
  }
1250
1312
  type Input = undefined;
1251
1313
  type Output = Uint8Array;
@@ -1264,7 +1326,7 @@ export declare namespace ComAtprotoSyncGetBlocks {
1264
1326
  export declare namespace ComAtprotoSyncGetCheckout {
1265
1327
  interface Params {
1266
1328
  /** The DID of the repo. */
1267
- did: At.DID;
1329
+ did: At.Did;
1268
1330
  }
1269
1331
  type Input = undefined;
1270
1332
  type Output = Uint8Array;
@@ -1276,26 +1338,45 @@ export declare namespace ComAtprotoSyncGetCheckout {
1276
1338
  export declare namespace ComAtprotoSyncGetHead {
1277
1339
  interface Params {
1278
1340
  /** The DID of the repo. */
1279
- did: At.DID;
1341
+ did: At.Did;
1280
1342
  }
1281
1343
  type Input = undefined;
1282
1344
  interface Output {
1283
- root: At.CID;
1345
+ root: At.Cid;
1284
1346
  }
1285
1347
  interface Errors {
1286
1348
  HeadNotFound: {};
1287
1349
  }
1288
1350
  }
1351
+ /** Returns information about a specified upstream host, as consumed by the server. Implemented by relays. */
1352
+ export declare namespace ComAtprotoSyncGetHostStatus {
1353
+ interface Params {
1354
+ /** Hostname of the host (eg, PDS or relay) being queried. */
1355
+ hostname: string;
1356
+ }
1357
+ type Input = undefined;
1358
+ interface Output {
1359
+ hostname: string;
1360
+ /** Number of accounts on the server which are associated with the upstream host. Note that the upstream may actually have more accounts. */
1361
+ accountCount?: number;
1362
+ /** Recent repo stream event sequence number. May be delayed from actual stream processing (eg, persisted cursor not in-memory cursor). */
1363
+ seq?: number;
1364
+ status?: ComAtprotoSyncDefs.HostStatus;
1365
+ }
1366
+ interface Errors {
1367
+ HostNotFound: {};
1368
+ }
1369
+ }
1289
1370
  /** Get the current commit CID & revision of the specified repo. Does not require auth. */
1290
1371
  export declare namespace ComAtprotoSyncGetLatestCommit {
1291
1372
  interface Params {
1292
1373
  /** The DID of the repo. */
1293
- did: At.DID;
1374
+ did: At.Did;
1294
1375
  }
1295
1376
  type Input = undefined;
1296
1377
  interface Output {
1297
- cid: At.CID;
1298
- rev: string;
1378
+ cid: At.Cid;
1379
+ rev: At.Tid;
1299
1380
  }
1300
1381
  interface Errors {
1301
1382
  RepoNotFound: {};
@@ -1307,11 +1388,11 @@ export declare namespace ComAtprotoSyncGetLatestCommit {
1307
1388
  /** Get data blocks needed to prove the existence or non-existence of record in the current version of repo. Does not require auth. */
1308
1389
  export declare namespace ComAtprotoSyncGetRecord {
1309
1390
  interface Params {
1310
- collection: string;
1391
+ collection: At.Nsid;
1311
1392
  /** The DID of the repo. */
1312
- did: At.DID;
1393
+ did: At.Did;
1313
1394
  /** Record Key */
1314
- rkey: string;
1395
+ rkey: At.RecordKey;
1315
1396
  }
1316
1397
  type Input = undefined;
1317
1398
  type Output = Uint8Array;
@@ -1327,9 +1408,9 @@ export declare namespace ComAtprotoSyncGetRecord {
1327
1408
  export declare namespace ComAtprotoSyncGetRepo {
1328
1409
  interface Params {
1329
1410
  /** The DID of the repo. */
1330
- did: At.DID;
1411
+ did: At.Did;
1331
1412
  /** The revision ('rev') of the repo to create a diff from. */
1332
- since?: string;
1413
+ since?: At.Tid;
1333
1414
  }
1334
1415
  type Input = undefined;
1335
1416
  type Output = Uint8Array;
@@ -1344,14 +1425,14 @@ export declare namespace ComAtprotoSyncGetRepo {
1344
1425
  export declare namespace ComAtprotoSyncGetRepoStatus {
1345
1426
  interface Params {
1346
1427
  /** The DID of the repo. */
1347
- did: At.DID;
1428
+ did: At.Did;
1348
1429
  }
1349
1430
  type Input = undefined;
1350
1431
  interface Output {
1351
1432
  active: boolean;
1352
- did: At.DID;
1433
+ did: At.Did;
1353
1434
  /** Optional field, the current rev of the repo, if active=true */
1354
- rev?: string;
1435
+ rev?: At.Tid;
1355
1436
  /** 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. */
1356
1437
  status?: 'deactivated' | 'deleted' | 'desynchronized' | 'suspended' | 'takendown' | 'throttled' | (string & {});
1357
1438
  }
@@ -1363,7 +1444,7 @@ export declare namespace ComAtprotoSyncGetRepoStatus {
1363
1444
  export declare namespace ComAtprotoSyncListBlobs {
1364
1445
  interface Params {
1365
1446
  /** The DID of the repo. */
1366
- did: At.DID;
1447
+ did: At.Did;
1367
1448
  cursor?: string;
1368
1449
  /**
1369
1450
  * Minimum: 1 \
@@ -1372,11 +1453,11 @@ export declare namespace ComAtprotoSyncListBlobs {
1372
1453
  */
1373
1454
  limit?: number;
1374
1455
  /** Optional revision of the repo to list blobs since. */
1375
- since?: string;
1456
+ since?: At.Tid;
1376
1457
  }
1377
1458
  type Input = undefined;
1378
1459
  interface Output {
1379
- cids: At.CID[];
1460
+ cids: At.Cid[];
1380
1461
  cursor?: string;
1381
1462
  }
1382
1463
  interface Errors {
@@ -1386,6 +1467,33 @@ export declare namespace ComAtprotoSyncListBlobs {
1386
1467
  RepoDeactivated: {};
1387
1468
  }
1388
1469
  }
1470
+ /** Enumerates upstream hosts (eg, PDS or relay instances) that this service consumes from. Implemented by relays. */
1471
+ export declare namespace ComAtprotoSyncListHosts {
1472
+ interface Params {
1473
+ cursor?: string;
1474
+ /**
1475
+ * Minimum: 1 \
1476
+ * Maximum: 1000
1477
+ * @default 200
1478
+ */
1479
+ limit?: number;
1480
+ }
1481
+ type Input = undefined;
1482
+ interface Output {
1483
+ /** Sort order is not formally specified. Recommended order is by time host was first seen by the server, with oldest first. */
1484
+ hosts: Host[];
1485
+ cursor?: string;
1486
+ }
1487
+ interface Host {
1488
+ [Brand.Type]?: 'com.atproto.sync.listHosts#host';
1489
+ /** hostname of server; not a URL (no scheme) */
1490
+ hostname: string;
1491
+ accountCount?: number;
1492
+ /** Recent repo stream event sequence number. May be delayed from actual stream processing (eg, persisted cursor not in-memory cursor). */
1493
+ seq?: number;
1494
+ status?: ComAtprotoSyncDefs.HostStatus;
1495
+ }
1496
+ }
1389
1497
  /** Enumerates all the DID, rev, and commit CID for all repos hosted by this service. Does not require auth; implemented by PDS and Relay. */
1390
1498
  export declare namespace ComAtprotoSyncListRepos {
1391
1499
  interface Params {
@@ -1404,10 +1512,10 @@ export declare namespace ComAtprotoSyncListRepos {
1404
1512
  }
1405
1513
  interface Repo {
1406
1514
  [Brand.Type]?: 'com.atproto.sync.listRepos#repo';
1407
- did: At.DID;
1515
+ did: At.Did;
1408
1516
  /** Current repo commit CID */
1409
- head: At.CID;
1410
- rev: string;
1517
+ head: At.Cid;
1518
+ rev: At.Tid;
1411
1519
  active?: boolean;
1412
1520
  /** 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. */
1413
1521
  status?: 'deactivated' | 'deleted' | 'desynchronized' | 'suspended' | 'takendown' | 'throttled' | (string & {});
@@ -1416,7 +1524,7 @@ export declare namespace ComAtprotoSyncListRepos {
1416
1524
  /** Enumerates all the DIDs which have records with the given collection NSID. */
1417
1525
  export declare namespace ComAtprotoSyncListReposByCollection {
1418
1526
  interface Params {
1419
- collection: string;
1527
+ collection: At.Nsid;
1420
1528
  cursor?: string;
1421
1529
  /**
1422
1530
  * Maximum size of response set. Recommend setting a large maximum (1000+) when enumerating large DID lists. \
@@ -1433,7 +1541,7 @@ export declare namespace ComAtprotoSyncListReposByCollection {
1433
1541
  }
1434
1542
  interface Repo {
1435
1543
  [Brand.Type]?: 'com.atproto.sync.listReposByCollection#repo';
1436
- did: At.DID;
1544
+ did: At.Did;
1437
1545
  }
1438
1546
  }
1439
1547
  /** 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 */
@@ -1455,6 +1563,9 @@ export declare namespace ComAtprotoSyncRequestCrawl {
1455
1563
  hostname: string;
1456
1564
  }
1457
1565
  type Output = undefined;
1566
+ interface Errors {
1567
+ HostBanned: {};
1568
+ }
1458
1569
  }
1459
1570
  export declare namespace ComAtprotoSyncSubscribeRepos {
1460
1571
  /** 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. */
@@ -1462,7 +1573,7 @@ export declare namespace ComAtprotoSyncSubscribeRepos {
1462
1573
  [Brand.Type]?: 'com.atproto.sync.subscribeRepos#account';
1463
1574
  /** Indicates that the account has a repository which can be fetched from the host that emitted this event. */
1464
1575
  active: boolean;
1465
- did: At.DID;
1576
+ did: At.Did;
1466
1577
  seq: number;
1467
1578
  time: string;
1468
1579
  /** If active=false, this optional field indicates a reason for why the account is not active. */
@@ -1475,11 +1586,11 @@ export declare namespace ComAtprotoSyncSubscribeRepos {
1475
1586
  * DEPRECATED -- will soon always be empty. List of new blobs (by CID) referenced by records in this commit.
1476
1587
  * @deprecated
1477
1588
  */
1478
- blobs: At.CIDLink[];
1589
+ blobs: At.CidLink[];
1479
1590
  /** 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. */
1480
1591
  blocks: At.Bytes;
1481
1592
  /** Repo commit object CID. */
1482
- commit: At.CIDLink;
1593
+ commit: At.CidLink;
1483
1594
  /**
1484
1595
  * Maximum array length: 200 \
1485
1596
  * List of repo mutation operations in this commit (eg, records created, updated, or deleted).
@@ -1491,13 +1602,13 @@ export declare namespace ComAtprotoSyncSubscribeRepos {
1491
1602
  */
1492
1603
  rebase: boolean;
1493
1604
  /** The repo this event comes from. Note that all other message types name this field 'did'. */
1494
- repo: At.DID;
1605
+ repo: At.Did;
1495
1606
  /** 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. */
1496
- rev: string;
1607
+ rev: At.Tid;
1497
1608
  /** The stream sequence number of this message. */
1498
1609
  seq: number;
1499
1610
  /** The rev of the last emitted commit from this repo (if any). */
1500
- since: string | null;
1611
+ since: At.Tid | null;
1501
1612
  /** Timestamp of when this message was originally broadcast. */
1502
1613
  time: string;
1503
1614
  /**
@@ -1506,12 +1617,12 @@ export declare namespace ComAtprotoSyncSubscribeRepos {
1506
1617
  */
1507
1618
  tooBig: boolean;
1508
1619
  /** 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. */
1509
- prevData?: At.CIDLink;
1620
+ prevData?: At.CidLink;
1510
1621
  }
1511
1622
  /** 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. */
1512
1623
  interface Identity {
1513
1624
  [Brand.Type]?: 'com.atproto.sync.subscribeRepos#identity';
1514
- did: At.DID;
1625
+ did: At.Did;
1515
1626
  seq: number;
1516
1627
  time: string;
1517
1628
  /** 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. */
@@ -1527,10 +1638,10 @@ export declare namespace ComAtprotoSyncSubscribeRepos {
1527
1638
  [Brand.Type]?: 'com.atproto.sync.subscribeRepos#repoOp';
1528
1639
  action: 'create' | 'delete' | 'update' | (string & {});
1529
1640
  /** For creates and updates, the new record CID. For deletions, null. */
1530
- cid: At.CIDLink | null;
1641
+ cid: At.CidLink | null;
1531
1642
  path: string;
1532
1643
  /** For updates and deletes, the previous record CID (required for inductive firehose). For creations, field should not be defined. */
1533
- prev?: At.CIDLink;
1644
+ prev?: At.CidLink;
1534
1645
  }
1535
1646
  /** 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. */
1536
1647
  interface Sync {
@@ -1538,7 +1649,7 @@ export declare namespace ComAtprotoSyncSubscribeRepos {
1538
1649
  /** CAR file containing the commit, as a block. The CAR header must include the commit block CID as the first 'root'. */
1539
1650
  blocks: At.Bytes;
1540
1651
  /** The account this repo event corresponds to. Must match that in the commit object. */
1541
- did: At.DID;
1652
+ did: At.Did;
1542
1653
  /** The rev of the commit. This value must match that in the commit object. */
1543
1654
  rev: string;
1544
1655
  /** The stream sequence number of this message. */
@@ -1602,129 +1713,267 @@ export declare interface Records {
1602
1713
  export declare interface Queries {
1603
1714
  'com.atproto.admin.getAccountInfo': {
1604
1715
  params: ComAtprotoAdminGetAccountInfo.Params;
1716
+ /** @deprecated */
1605
1717
  output: ComAtprotoAdminGetAccountInfo.Output;
1718
+ response: {
1719
+ json: ComAtprotoAdminGetAccountInfo.Output;
1720
+ };
1606
1721
  };
1607
1722
  'com.atproto.admin.getAccountInfos': {
1608
1723
  params: ComAtprotoAdminGetAccountInfos.Params;
1724
+ /** @deprecated */
1609
1725
  output: ComAtprotoAdminGetAccountInfos.Output;
1726
+ response: {
1727
+ json: ComAtprotoAdminGetAccountInfos.Output;
1728
+ };
1610
1729
  };
1611
1730
  'com.atproto.admin.getInviteCodes': {
1612
1731
  params: ComAtprotoAdminGetInviteCodes.Params;
1732
+ /** @deprecated */
1613
1733
  output: ComAtprotoAdminGetInviteCodes.Output;
1734
+ response: {
1735
+ json: ComAtprotoAdminGetInviteCodes.Output;
1736
+ };
1614
1737
  };
1615
1738
  'com.atproto.admin.getSubjectStatus': {
1616
1739
  params: ComAtprotoAdminGetSubjectStatus.Params;
1740
+ /** @deprecated */
1617
1741
  output: ComAtprotoAdminGetSubjectStatus.Output;
1742
+ response: {
1743
+ json: ComAtprotoAdminGetSubjectStatus.Output;
1744
+ };
1618
1745
  };
1619
1746
  'com.atproto.admin.searchAccounts': {
1620
1747
  params: ComAtprotoAdminSearchAccounts.Params;
1748
+ /** @deprecated */
1621
1749
  output: ComAtprotoAdminSearchAccounts.Output;
1750
+ response: {
1751
+ json: ComAtprotoAdminSearchAccounts.Output;
1752
+ };
1622
1753
  };
1623
1754
  'com.atproto.identity.getRecommendedDidCredentials': {
1755
+ /** @deprecated */
1624
1756
  output: ComAtprotoIdentityGetRecommendedDidCredentials.Output;
1757
+ response: {
1758
+ json: ComAtprotoIdentityGetRecommendedDidCredentials.Output;
1759
+ };
1625
1760
  };
1626
1761
  'com.atproto.identity.resolveDid': {
1627
1762
  params: ComAtprotoIdentityResolveDid.Params;
1763
+ /** @deprecated */
1628
1764
  output: ComAtprotoIdentityResolveDid.Output;
1765
+ response: {
1766
+ json: ComAtprotoIdentityResolveDid.Output;
1767
+ };
1629
1768
  };
1630
1769
  'com.atproto.identity.resolveHandle': {
1631
1770
  params: ComAtprotoIdentityResolveHandle.Params;
1771
+ /** @deprecated */
1632
1772
  output: ComAtprotoIdentityResolveHandle.Output;
1773
+ response: {
1774
+ json: ComAtprotoIdentityResolveHandle.Output;
1775
+ };
1633
1776
  };
1634
1777
  'com.atproto.identity.resolveIdentity': {
1635
1778
  params: ComAtprotoIdentityResolveIdentity.Params;
1779
+ /** @deprecated */
1636
1780
  output: ComAtprotoIdentityResolveIdentity.Output;
1781
+ response: {
1782
+ json: ComAtprotoIdentityResolveIdentity.Output;
1783
+ };
1637
1784
  };
1638
1785
  'com.atproto.label.queryLabels': {
1639
1786
  params: ComAtprotoLabelQueryLabels.Params;
1787
+ /** @deprecated */
1640
1788
  output: ComAtprotoLabelQueryLabels.Output;
1789
+ response: {
1790
+ json: ComAtprotoLabelQueryLabels.Output;
1791
+ };
1641
1792
  };
1642
1793
  'com.atproto.repo.describeRepo': {
1643
1794
  params: ComAtprotoRepoDescribeRepo.Params;
1795
+ /** @deprecated */
1644
1796
  output: ComAtprotoRepoDescribeRepo.Output;
1797
+ response: {
1798
+ json: ComAtprotoRepoDescribeRepo.Output;
1799
+ };
1645
1800
  };
1646
1801
  'com.atproto.repo.getRecord': {
1647
1802
  params: ComAtprotoRepoGetRecord.Params;
1803
+ /** @deprecated */
1648
1804
  output: ComAtprotoRepoGetRecord.Output;
1805
+ response: {
1806
+ json: ComAtprotoRepoGetRecord.Output;
1807
+ };
1649
1808
  };
1650
1809
  'com.atproto.repo.listMissingBlobs': {
1651
1810
  params: ComAtprotoRepoListMissingBlobs.Params;
1811
+ /** @deprecated */
1652
1812
  output: ComAtprotoRepoListMissingBlobs.Output;
1813
+ response: {
1814
+ json: ComAtprotoRepoListMissingBlobs.Output;
1815
+ };
1653
1816
  };
1654
1817
  'com.atproto.repo.listRecords': {
1655
1818
  params: ComAtprotoRepoListRecords.Params;
1819
+ /** @deprecated */
1656
1820
  output: ComAtprotoRepoListRecords.Output;
1821
+ response: {
1822
+ json: ComAtprotoRepoListRecords.Output;
1823
+ };
1657
1824
  };
1658
1825
  'com.atproto.server.checkAccountStatus': {
1826
+ /** @deprecated */
1659
1827
  output: ComAtprotoServerCheckAccountStatus.Output;
1828
+ response: {
1829
+ json: ComAtprotoServerCheckAccountStatus.Output;
1830
+ };
1660
1831
  };
1661
1832
  'com.atproto.server.describeServer': {
1833
+ /** @deprecated */
1662
1834
  output: ComAtprotoServerDescribeServer.Output;
1835
+ response: {
1836
+ json: ComAtprotoServerDescribeServer.Output;
1837
+ };
1663
1838
  };
1664
1839
  'com.atproto.server.getAccountInviteCodes': {
1665
1840
  params: ComAtprotoServerGetAccountInviteCodes.Params;
1841
+ /** @deprecated */
1666
1842
  output: ComAtprotoServerGetAccountInviteCodes.Output;
1843
+ response: {
1844
+ json: ComAtprotoServerGetAccountInviteCodes.Output;
1845
+ };
1667
1846
  };
1668
1847
  'com.atproto.server.getServiceAuth': {
1669
1848
  params: ComAtprotoServerGetServiceAuth.Params;
1849
+ /** @deprecated */
1670
1850
  output: ComAtprotoServerGetServiceAuth.Output;
1851
+ response: {
1852
+ json: ComAtprotoServerGetServiceAuth.Output;
1853
+ };
1671
1854
  };
1672
1855
  'com.atproto.server.getSession': {
1856
+ /** @deprecated */
1673
1857
  output: ComAtprotoServerGetSession.Output;
1858
+ response: {
1859
+ json: ComAtprotoServerGetSession.Output;
1860
+ };
1674
1861
  };
1675
1862
  'com.atproto.server.listAppPasswords': {
1863
+ /** @deprecated */
1676
1864
  output: ComAtprotoServerListAppPasswords.Output;
1865
+ response: {
1866
+ json: ComAtprotoServerListAppPasswords.Output;
1867
+ };
1677
1868
  };
1678
1869
  'com.atproto.sync.getBlob': {
1679
1870
  params: ComAtprotoSyncGetBlob.Params;
1871
+ /** @deprecated */
1680
1872
  output: ComAtprotoSyncGetBlob.Output;
1873
+ response: {};
1681
1874
  };
1682
1875
  'com.atproto.sync.getBlocks': {
1683
1876
  params: ComAtprotoSyncGetBlocks.Params;
1877
+ /** @deprecated */
1684
1878
  output: ComAtprotoSyncGetBlocks.Output;
1879
+ response: {};
1685
1880
  };
1686
1881
  'com.atproto.sync.getCheckout': {
1687
1882
  params: ComAtprotoSyncGetCheckout.Params;
1883
+ /** @deprecated */
1688
1884
  output: ComAtprotoSyncGetCheckout.Output;
1885
+ response: {};
1689
1886
  };
1690
1887
  'com.atproto.sync.getHead': {
1691
1888
  params: ComAtprotoSyncGetHead.Params;
1889
+ /** @deprecated */
1692
1890
  output: ComAtprotoSyncGetHead.Output;
1891
+ response: {
1892
+ json: ComAtprotoSyncGetHead.Output;
1893
+ };
1894
+ };
1895
+ 'com.atproto.sync.getHostStatus': {
1896
+ params: ComAtprotoSyncGetHostStatus.Params;
1897
+ /** @deprecated */
1898
+ output: ComAtprotoSyncGetHostStatus.Output;
1899
+ response: {
1900
+ json: ComAtprotoSyncGetHostStatus.Output;
1901
+ };
1693
1902
  };
1694
1903
  'com.atproto.sync.getLatestCommit': {
1695
1904
  params: ComAtprotoSyncGetLatestCommit.Params;
1905
+ /** @deprecated */
1696
1906
  output: ComAtprotoSyncGetLatestCommit.Output;
1907
+ response: {
1908
+ json: ComAtprotoSyncGetLatestCommit.Output;
1909
+ };
1697
1910
  };
1698
1911
  'com.atproto.sync.getRecord': {
1699
1912
  params: ComAtprotoSyncGetRecord.Params;
1913
+ /** @deprecated */
1700
1914
  output: ComAtprotoSyncGetRecord.Output;
1915
+ response: {};
1701
1916
  };
1702
1917
  'com.atproto.sync.getRepo': {
1703
1918
  params: ComAtprotoSyncGetRepo.Params;
1919
+ /** @deprecated */
1704
1920
  output: ComAtprotoSyncGetRepo.Output;
1921
+ response: {};
1705
1922
  };
1706
1923
  'com.atproto.sync.getRepoStatus': {
1707
1924
  params: ComAtprotoSyncGetRepoStatus.Params;
1925
+ /** @deprecated */
1708
1926
  output: ComAtprotoSyncGetRepoStatus.Output;
1927
+ response: {
1928
+ json: ComAtprotoSyncGetRepoStatus.Output;
1929
+ };
1709
1930
  };
1710
1931
  'com.atproto.sync.listBlobs': {
1711
1932
  params: ComAtprotoSyncListBlobs.Params;
1933
+ /** @deprecated */
1712
1934
  output: ComAtprotoSyncListBlobs.Output;
1935
+ response: {
1936
+ json: ComAtprotoSyncListBlobs.Output;
1937
+ };
1938
+ };
1939
+ 'com.atproto.sync.listHosts': {
1940
+ params: ComAtprotoSyncListHosts.Params;
1941
+ /** @deprecated */
1942
+ output: ComAtprotoSyncListHosts.Output;
1943
+ response: {
1944
+ json: ComAtprotoSyncListHosts.Output;
1945
+ };
1713
1946
  };
1714
1947
  'com.atproto.sync.listRepos': {
1715
1948
  params: ComAtprotoSyncListRepos.Params;
1949
+ /** @deprecated */
1716
1950
  output: ComAtprotoSyncListRepos.Output;
1951
+ response: {
1952
+ json: ComAtprotoSyncListRepos.Output;
1953
+ };
1717
1954
  };
1718
1955
  'com.atproto.sync.listReposByCollection': {
1719
1956
  params: ComAtprotoSyncListReposByCollection.Params;
1957
+ /** @deprecated */
1720
1958
  output: ComAtprotoSyncListReposByCollection.Output;
1959
+ response: {
1960
+ json: ComAtprotoSyncListReposByCollection.Output;
1961
+ };
1721
1962
  };
1722
1963
  'com.atproto.temp.checkSignupQueue': {
1964
+ /** @deprecated */
1723
1965
  output: ComAtprotoTempCheckSignupQueue.Output;
1966
+ response: {
1967
+ json: ComAtprotoTempCheckSignupQueue.Output;
1968
+ };
1724
1969
  };
1725
1970
  'com.atproto.temp.fetchLabels': {
1726
1971
  params: ComAtprotoTempFetchLabels.Params;
1972
+ /** @deprecated */
1727
1973
  output: ComAtprotoTempFetchLabels.Output;
1974
+ response: {
1975
+ json: ComAtprotoTempFetchLabels.Output;
1976
+ };
1728
1977
  };
1729
1978
  }
1730
1979
  export declare interface Procedures {
@@ -1742,7 +1991,11 @@ export declare interface Procedures {
1742
1991
  };
1743
1992
  'com.atproto.admin.sendEmail': {
1744
1993
  input: ComAtprotoAdminSendEmail.Input;
1994
+ /** @deprecated */
1745
1995
  output: ComAtprotoAdminSendEmail.Output;
1996
+ response: {
1997
+ json: ComAtprotoAdminSendEmail.Output;
1998
+ };
1746
1999
  };
1747
2000
  'com.atproto.admin.updateAccountEmail': {
1748
2001
  input: ComAtprotoAdminUpdateAccountEmail.Input;
@@ -1753,18 +2006,33 @@ export declare interface Procedures {
1753
2006
  'com.atproto.admin.updateAccountPassword': {
1754
2007
  input: ComAtprotoAdminUpdateAccountPassword.Input;
1755
2008
  };
2009
+ 'com.atproto.admin.updateAccountSigningKey': {
2010
+ input: ComAtprotoAdminUpdateAccountSigningKey.Input;
2011
+ };
1756
2012
  'com.atproto.admin.updateSubjectStatus': {
1757
2013
  input: ComAtprotoAdminUpdateSubjectStatus.Input;
2014
+ /** @deprecated */
1758
2015
  output: ComAtprotoAdminUpdateSubjectStatus.Output;
2016
+ response: {
2017
+ json: ComAtprotoAdminUpdateSubjectStatus.Output;
2018
+ };
1759
2019
  };
1760
2020
  'com.atproto.identity.refreshIdentity': {
1761
2021
  input: ComAtprotoIdentityRefreshIdentity.Input;
2022
+ /** @deprecated */
1762
2023
  output: ComAtprotoIdentityRefreshIdentity.Output;
2024
+ response: {
2025
+ json: ComAtprotoIdentityRefreshIdentity.Output;
2026
+ };
1763
2027
  };
1764
2028
  'com.atproto.identity.requestPlcOperationSignature': {};
1765
2029
  'com.atproto.identity.signPlcOperation': {
1766
2030
  input: ComAtprotoIdentitySignPlcOperation.Input;
2031
+ /** @deprecated */
1767
2032
  output: ComAtprotoIdentitySignPlcOperation.Output;
2033
+ response: {
2034
+ json: ComAtprotoIdentitySignPlcOperation.Output;
2035
+ };
1768
2036
  };
1769
2037
  'com.atproto.identity.submitPlcOperation': {
1770
2038
  input: ComAtprotoIdentitySubmitPlcOperation.Input;
@@ -1774,30 +2042,54 @@ export declare interface Procedures {
1774
2042
  };
1775
2043
  'com.atproto.moderation.createReport': {
1776
2044
  input: ComAtprotoModerationCreateReport.Input;
2045
+ /** @deprecated */
1777
2046
  output: ComAtprotoModerationCreateReport.Output;
2047
+ response: {
2048
+ json: ComAtprotoModerationCreateReport.Output;
2049
+ };
1778
2050
  };
1779
2051
  'com.atproto.repo.applyWrites': {
1780
2052
  input: ComAtprotoRepoApplyWrites.Input;
2053
+ /** @deprecated */
1781
2054
  output: ComAtprotoRepoApplyWrites.Output;
2055
+ response: {
2056
+ json: ComAtprotoRepoApplyWrites.Output;
2057
+ };
1782
2058
  };
1783
2059
  'com.atproto.repo.createRecord': {
1784
2060
  input: ComAtprotoRepoCreateRecord.Input;
2061
+ /** @deprecated */
1785
2062
  output: ComAtprotoRepoCreateRecord.Output;
2063
+ response: {
2064
+ json: ComAtprotoRepoCreateRecord.Output;
2065
+ };
1786
2066
  };
1787
2067
  'com.atproto.repo.deleteRecord': {
1788
2068
  input: ComAtprotoRepoDeleteRecord.Input;
2069
+ /** @deprecated */
1789
2070
  output: ComAtprotoRepoDeleteRecord.Output;
2071
+ response: {
2072
+ json: ComAtprotoRepoDeleteRecord.Output;
2073
+ };
1790
2074
  };
1791
2075
  'com.atproto.repo.importRepo': {
1792
2076
  input: ComAtprotoRepoImportRepo.Input;
1793
2077
  };
1794
2078
  'com.atproto.repo.putRecord': {
1795
2079
  input: ComAtprotoRepoPutRecord.Input;
2080
+ /** @deprecated */
1796
2081
  output: ComAtprotoRepoPutRecord.Output;
2082
+ response: {
2083
+ json: ComAtprotoRepoPutRecord.Output;
2084
+ };
1797
2085
  };
1798
2086
  'com.atproto.repo.uploadBlob': {
1799
2087
  input: ComAtprotoRepoUploadBlob.Input;
2088
+ /** @deprecated */
1800
2089
  output: ComAtprotoRepoUploadBlob.Output;
2090
+ response: {
2091
+ json: ComAtprotoRepoUploadBlob.Output;
2092
+ };
1801
2093
  };
1802
2094
  'com.atproto.server.activateAccount': {};
1803
2095
  'com.atproto.server.confirmEmail': {
@@ -1805,23 +2097,43 @@ export declare interface Procedures {
1805
2097
  };
1806
2098
  'com.atproto.server.createAccount': {
1807
2099
  input: ComAtprotoServerCreateAccount.Input;
2100
+ /** @deprecated */
1808
2101
  output: ComAtprotoServerCreateAccount.Output;
2102
+ response: {
2103
+ json: ComAtprotoServerCreateAccount.Output;
2104
+ };
1809
2105
  };
1810
2106
  'com.atproto.server.createAppPassword': {
1811
2107
  input: ComAtprotoServerCreateAppPassword.Input;
2108
+ /** @deprecated */
1812
2109
  output: ComAtprotoServerCreateAppPassword.Output;
2110
+ response: {
2111
+ json: ComAtprotoServerCreateAppPassword.Output;
2112
+ };
1813
2113
  };
1814
2114
  'com.atproto.server.createInviteCode': {
1815
2115
  input: ComAtprotoServerCreateInviteCode.Input;
2116
+ /** @deprecated */
1816
2117
  output: ComAtprotoServerCreateInviteCode.Output;
2118
+ response: {
2119
+ json: ComAtprotoServerCreateInviteCode.Output;
2120
+ };
1817
2121
  };
1818
2122
  'com.atproto.server.createInviteCodes': {
1819
2123
  input: ComAtprotoServerCreateInviteCodes.Input;
2124
+ /** @deprecated */
1820
2125
  output: ComAtprotoServerCreateInviteCodes.Output;
2126
+ response: {
2127
+ json: ComAtprotoServerCreateInviteCodes.Output;
2128
+ };
1821
2129
  };
1822
2130
  'com.atproto.server.createSession': {
1823
2131
  input: ComAtprotoServerCreateSession.Input;
2132
+ /** @deprecated */
1824
2133
  output: ComAtprotoServerCreateSession.Output;
2134
+ response: {
2135
+ json: ComAtprotoServerCreateSession.Output;
2136
+ };
1825
2137
  };
1826
2138
  'com.atproto.server.deactivateAccount': {
1827
2139
  input: ComAtprotoServerDeactivateAccount.Input;
@@ -1831,19 +2143,31 @@ export declare interface Procedures {
1831
2143
  };
1832
2144
  'com.atproto.server.deleteSession': {};
1833
2145
  'com.atproto.server.refreshSession': {
2146
+ /** @deprecated */
1834
2147
  output: ComAtprotoServerRefreshSession.Output;
2148
+ response: {
2149
+ json: ComAtprotoServerRefreshSession.Output;
2150
+ };
1835
2151
  };
1836
2152
  'com.atproto.server.requestAccountDelete': {};
1837
2153
  'com.atproto.server.requestEmailConfirmation': {};
1838
2154
  'com.atproto.server.requestEmailUpdate': {
2155
+ /** @deprecated */
1839
2156
  output: ComAtprotoServerRequestEmailUpdate.Output;
2157
+ response: {
2158
+ json: ComAtprotoServerRequestEmailUpdate.Output;
2159
+ };
1840
2160
  };
1841
2161
  'com.atproto.server.requestPasswordReset': {
1842
2162
  input: ComAtprotoServerRequestPasswordReset.Input;
1843
2163
  };
1844
2164
  'com.atproto.server.reserveSigningKey': {
1845
2165
  input: ComAtprotoServerReserveSigningKey.Input;
2166
+ /** @deprecated */
1846
2167
  output: ComAtprotoServerReserveSigningKey.Output;
2168
+ response: {
2169
+ json: ComAtprotoServerReserveSigningKey.Output;
2170
+ };
1847
2171
  };
1848
2172
  'com.atproto.server.resetPassword': {
1849
2173
  input: ComAtprotoServerResetPassword.Input;
@@ -1862,7 +2186,11 @@ export declare interface Procedures {
1862
2186
  };
1863
2187
  'com.atproto.temp.addReservedHandle': {
1864
2188
  input: ComAtprotoTempAddReservedHandle.Input;
2189
+ /** @deprecated */
1865
2190
  output: ComAtprotoTempAddReservedHandle.Output;
2191
+ response: {
2192
+ json: ComAtprotoTempAddReservedHandle.Output;
2193
+ };
1866
2194
  };
1867
2195
  'com.atproto.temp.requestPhoneVerification': {
1868
2196
  input: ComAtprotoTempRequestPhoneVerification.Input;