@atcute/client 2.0.8 → 2.0.9

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.
@@ -258,6 +258,16 @@ export declare namespace ComAtprotoAdminUpdateSubjectStatus {
258
258
  takedown?: ComAtprotoAdminDefs.StatusAttr;
259
259
  }
260
260
  }
261
+ export declare namespace ComAtprotoIdentityDefs {
262
+ interface IdentityInfo {
263
+ [Brand.Type]?: 'com.atproto.identity.defs#identityInfo';
264
+ did: At.DID;
265
+ /** The complete DID document for the identity. */
266
+ didDoc: unknown;
267
+ /** The validated handle of the account; or 'handle.invalid' if the handle did not bi-directionally match the DID document. */
268
+ handle: At.Handle;
269
+ }
270
+ }
261
271
  /** Describe the credentials that should be included in the DID doc of an account that is migrating to this service. */
262
272
  export declare namespace ComAtprotoIdentityGetRecommendedDidCredentials {
263
273
  interface Params {
@@ -271,6 +281,20 @@ export declare namespace ComAtprotoIdentityGetRecommendedDidCredentials {
271
281
  verificationMethods?: unknown;
272
282
  }
273
283
  }
284
+ /** 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. */
285
+ export declare namespace ComAtprotoIdentityRefreshIdentity {
286
+ interface Params {
287
+ }
288
+ interface Input {
289
+ identifier: string;
290
+ }
291
+ type Output = ComAtprotoIdentityDefs.IdentityInfo;
292
+ interface Errors {
293
+ HandleNotFound: {};
294
+ DidNotFound: {};
295
+ DidDeactivated: {};
296
+ }
297
+ }
274
298
  /** Request an email with a code to in order to request a signed PLC operation. Requires Auth. */
275
299
  export declare namespace ComAtprotoIdentityRequestPlcOperationSignature {
276
300
  interface Params {
@@ -278,7 +302,23 @@ export declare namespace ComAtprotoIdentityRequestPlcOperationSignature {
278
302
  type Input = undefined;
279
303
  type Output = undefined;
280
304
  }
281
- /** Resolves a handle (domain name) to a DID. */
305
+ /** Resolves DID to DID document. Does not bi-directionally verify handle. */
306
+ export declare namespace ComAtprotoIdentityResolveDid {
307
+ interface Params {
308
+ /** DID to resolve. */
309
+ did: At.DID;
310
+ }
311
+ type Input = undefined;
312
+ interface Output {
313
+ /** The complete DID document for the identity. */
314
+ didDoc: unknown;
315
+ }
316
+ interface Errors {
317
+ DidNotFound: {};
318
+ DidDeactivated: {};
319
+ }
320
+ }
321
+ /** Resolves an atproto handle (hostname) to a DID. Does not necessarily bi-directionally verify against the the DID document. */
282
322
  export declare namespace ComAtprotoIdentityResolveHandle {
283
323
  interface Params {
284
324
  /** The handle to resolve. */
@@ -288,6 +328,23 @@ export declare namespace ComAtprotoIdentityResolveHandle {
288
328
  interface Output {
289
329
  did: At.DID;
290
330
  }
331
+ interface Errors {
332
+ HandleNotFound: {};
333
+ }
334
+ }
335
+ /** Resolves an identity (DID or Handle) to a full identity (DID document and verified handle). */
336
+ export declare namespace ComAtprotoIdentityResolveIdentity {
337
+ interface Params {
338
+ /** Handle or DID to resolve. */
339
+ identifier: string;
340
+ }
341
+ type Input = undefined;
342
+ type Output = ComAtprotoIdentityDefs.IdentityInfo;
343
+ interface Errors {
344
+ HandleNotFound: {};
345
+ DidNotFound: {};
346
+ DidDeactivated: {};
347
+ }
291
348
  }
292
349
  /** Signs a PLC operation to update some value(s) in the requesting DID's document. */
293
350
  export declare namespace ComAtprotoIdentitySignPlcOperation {
@@ -486,6 +543,8 @@ export declare namespace ComAtprotoModerationDefs {
486
543
  type ReasonSpam = 'com.atproto.moderation.defs#reasonSpam';
487
544
  type ReasonType = 'com.atproto.moderation.defs#reasonAppeal' | 'com.atproto.moderation.defs#reasonMisleading' | 'com.atproto.moderation.defs#reasonOther' | 'com.atproto.moderation.defs#reasonRude' | 'com.atproto.moderation.defs#reasonSexual' | 'com.atproto.moderation.defs#reasonSpam' | 'com.atproto.moderation.defs#reasonViolation' | (string & {});
488
545
  type ReasonViolation = 'com.atproto.moderation.defs#reasonViolation';
546
+ /** Tag describing a type of subject that might be reported. */
547
+ type SubjectType = 'account' | 'chat' | 'record' | (string & {});
489
548
  }
490
549
  /** Apply a batch transaction of repository creates, updates, and deletes. Requires auth, implemented by PDS. */
491
550
  export declare namespace ComAtprotoRepoApplyWrites {
@@ -688,16 +747,6 @@ export declare namespace ComAtprotoRepoListRecords {
688
747
  limit?: number;
689
748
  /** Flag to reverse the order of the returned records. */
690
749
  reverse?: boolean;
691
- /**
692
- * DEPRECATED: The highest sort-ordered rkey to stop at (exclusive)
693
- * @deprecated
694
- */
695
- rkeyEnd?: string;
696
- /**
697
- * DEPRECATED: The lowest sort-ordered rkey to start from (exclusive)
698
- * @deprecated
699
- */
700
- rkeyStart?: string;
701
750
  }
702
751
  type Input = undefined;
703
752
  interface Output {
@@ -1263,11 +1312,6 @@ export declare namespace ComAtprotoSyncGetRecord {
1263
1312
  did: At.DID;
1264
1313
  /** Record Key */
1265
1314
  rkey: string;
1266
- /**
1267
- * DEPRECATED: referenced a repo commit by CID, and retrieved record as of that commit
1268
- * @deprecated
1269
- */
1270
- commit?: At.CID;
1271
1315
  }
1272
1316
  type Input = undefined;
1273
1317
  type Output = Uint8Array;
@@ -1392,7 +1436,7 @@ export declare namespace ComAtprotoSyncListReposByCollection {
1392
1436
  did: At.DID;
1393
1437
  }
1394
1438
  }
1395
- /** 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. */
1439
+ /** 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 */
1396
1440
  export declare namespace ComAtprotoSyncNotifyOfUpdate {
1397
1441
  interface Params {
1398
1442
  }
@@ -1464,17 +1508,6 @@ export declare namespace ComAtprotoSyncSubscribeRepos {
1464
1508
  /** 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. */
1465
1509
  prevData?: At.CIDLink;
1466
1510
  }
1467
- /**
1468
- * DEPRECATED -- Use #identity event instead
1469
- * @deprecated
1470
- */
1471
- interface Handle {
1472
- [Brand.Type]?: 'com.atproto.sync.subscribeRepos#handle';
1473
- did: At.DID;
1474
- handle: At.Handle;
1475
- seq: number;
1476
- time: string;
1477
- }
1478
1511
  /** 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. */
1479
1512
  interface Identity {
1480
1513
  [Brand.Type]?: 'com.atproto.sync.subscribeRepos#identity';
@@ -1489,17 +1522,6 @@ export declare namespace ComAtprotoSyncSubscribeRepos {
1489
1522
  name: 'OutdatedCursor' | (string & {});
1490
1523
  message?: string;
1491
1524
  }
1492
- /**
1493
- * DEPRECATED -- Use #account event instead
1494
- * @deprecated
1495
- */
1496
- interface Migrate {
1497
- [Brand.Type]?: 'com.atproto.sync.subscribeRepos#migrate';
1498
- did: At.DID;
1499
- migrateTo: string | null;
1500
- seq: number;
1501
- time: string;
1502
- }
1503
1525
  /** A repo operation, ie a mutation of a single record. */
1504
1526
  interface RepoOp {
1505
1527
  [Brand.Type]?: 'com.atproto.sync.subscribeRepos#repoOp';
@@ -1524,16 +1546,6 @@ export declare namespace ComAtprotoSyncSubscribeRepos {
1524
1546
  /** Timestamp of when this message was originally broadcast. */
1525
1547
  time: string;
1526
1548
  }
1527
- /**
1528
- * DEPRECATED -- Use #account event instead
1529
- * @deprecated
1530
- */
1531
- interface Tombstone {
1532
- [Brand.Type]?: 'com.atproto.sync.subscribeRepos#tombstone';
1533
- did: At.DID;
1534
- seq: number;
1535
- time: string;
1536
- }
1537
1549
  }
1538
1550
  /** Add a handle to the set of reserved handles. */
1539
1551
  export declare namespace ComAtprotoTempAddReservedHandle {
@@ -1611,10 +1623,18 @@ export declare interface Queries {
1611
1623
  'com.atproto.identity.getRecommendedDidCredentials': {
1612
1624
  output: ComAtprotoIdentityGetRecommendedDidCredentials.Output;
1613
1625
  };
1626
+ 'com.atproto.identity.resolveDid': {
1627
+ params: ComAtprotoIdentityResolveDid.Params;
1628
+ output: ComAtprotoIdentityResolveDid.Output;
1629
+ };
1614
1630
  'com.atproto.identity.resolveHandle': {
1615
1631
  params: ComAtprotoIdentityResolveHandle.Params;
1616
1632
  output: ComAtprotoIdentityResolveHandle.Output;
1617
1633
  };
1634
+ 'com.atproto.identity.resolveIdentity': {
1635
+ params: ComAtprotoIdentityResolveIdentity.Params;
1636
+ output: ComAtprotoIdentityResolveIdentity.Output;
1637
+ };
1618
1638
  'com.atproto.label.queryLabels': {
1619
1639
  params: ComAtprotoLabelQueryLabels.Params;
1620
1640
  output: ComAtprotoLabelQueryLabels.Output;
@@ -1737,6 +1757,10 @@ export declare interface Procedures {
1737
1757
  input: ComAtprotoAdminUpdateSubjectStatus.Input;
1738
1758
  output: ComAtprotoAdminUpdateSubjectStatus.Output;
1739
1759
  };
1760
+ 'com.atproto.identity.refreshIdentity': {
1761
+ input: ComAtprotoIdentityRefreshIdentity.Input;
1762
+ output: ComAtprotoIdentityRefreshIdentity.Output;
1763
+ };
1740
1764
  'com.atproto.identity.requestPlcOperationSignature': {};
1741
1765
  'com.atproto.identity.signPlcOperation': {
1742
1766
  input: ComAtprotoIdentitySignPlcOperation.Input;
package/lib/lexicons.ts CHANGED
@@ -277,6 +277,17 @@ export declare namespace ComAtprotoAdminUpdateSubjectStatus {
277
277
  }
278
278
  }
279
279
 
280
+ export declare namespace ComAtprotoIdentityDefs {
281
+ interface IdentityInfo {
282
+ [Brand.Type]?: 'com.atproto.identity.defs#identityInfo';
283
+ did: At.DID;
284
+ /** The complete DID document for the identity. */
285
+ didDoc: unknown;
286
+ /** The validated handle of the account; or 'handle.invalid' if the handle did not bi-directionally match the DID document. */
287
+ handle: At.Handle;
288
+ }
289
+ }
290
+
280
291
  /** Describe the credentials that should be included in the DID doc of an account that is migrating to this service. */
281
292
  export declare namespace ComAtprotoIdentityGetRecommendedDidCredentials {
282
293
  interface Params {}
@@ -290,6 +301,20 @@ export declare namespace ComAtprotoIdentityGetRecommendedDidCredentials {
290
301
  }
291
302
  }
292
303
 
304
+ /** 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. */
305
+ export declare namespace ComAtprotoIdentityRefreshIdentity {
306
+ interface Params {}
307
+ interface Input {
308
+ identifier: string;
309
+ }
310
+ type Output = ComAtprotoIdentityDefs.IdentityInfo;
311
+ interface Errors {
312
+ HandleNotFound: {};
313
+ DidNotFound: {};
314
+ DidDeactivated: {};
315
+ }
316
+ }
317
+
293
318
  /** Request an email with a code to in order to request a signed PLC operation. Requires Auth. */
294
319
  export declare namespace ComAtprotoIdentityRequestPlcOperationSignature {
295
320
  interface Params {}
@@ -297,7 +322,24 @@ export declare namespace ComAtprotoIdentityRequestPlcOperationSignature {
297
322
  type Output = undefined;
298
323
  }
299
324
 
300
- /** Resolves a handle (domain name) to a DID. */
325
+ /** Resolves DID to DID document. Does not bi-directionally verify handle. */
326
+ export declare namespace ComAtprotoIdentityResolveDid {
327
+ interface Params {
328
+ /** DID to resolve. */
329
+ did: At.DID;
330
+ }
331
+ type Input = undefined;
332
+ interface Output {
333
+ /** The complete DID document for the identity. */
334
+ didDoc: unknown;
335
+ }
336
+ interface Errors {
337
+ DidNotFound: {};
338
+ DidDeactivated: {};
339
+ }
340
+ }
341
+
342
+ /** Resolves an atproto handle (hostname) to a DID. Does not necessarily bi-directionally verify against the the DID document. */
301
343
  export declare namespace ComAtprotoIdentityResolveHandle {
302
344
  interface Params {
303
345
  /** The handle to resolve. */
@@ -307,6 +349,24 @@ export declare namespace ComAtprotoIdentityResolveHandle {
307
349
  interface Output {
308
350
  did: At.DID;
309
351
  }
352
+ interface Errors {
353
+ HandleNotFound: {};
354
+ }
355
+ }
356
+
357
+ /** Resolves an identity (DID or Handle) to a full identity (DID document and verified handle). */
358
+ export declare namespace ComAtprotoIdentityResolveIdentity {
359
+ interface Params {
360
+ /** Handle or DID to resolve. */
361
+ identifier: string;
362
+ }
363
+ type Input = undefined;
364
+ type Output = ComAtprotoIdentityDefs.IdentityInfo;
365
+ interface Errors {
366
+ HandleNotFound: {};
367
+ DidNotFound: {};
368
+ DidDeactivated: {};
369
+ }
310
370
  }
311
371
 
312
372
  /** Signs a PLC operation to update some value(s) in the requesting DID's document. */
@@ -530,6 +590,8 @@ export declare namespace ComAtprotoModerationDefs {
530
590
  | 'com.atproto.moderation.defs#reasonViolation'
531
591
  | (string & {});
532
592
  type ReasonViolation = 'com.atproto.moderation.defs#reasonViolation';
593
+ /** Tag describing a type of subject that might be reported. */
594
+ type SubjectType = 'account' | 'chat' | 'record' | (string & {});
533
595
  }
534
596
 
535
597
  /** Apply a batch transaction of repository creates, updates, and deletes. Requires auth, implemented by PDS. */
@@ -737,16 +799,6 @@ export declare namespace ComAtprotoRepoListRecords {
737
799
  limit?: number;
738
800
  /** Flag to reverse the order of the returned records. */
739
801
  reverse?: boolean;
740
- /**
741
- * DEPRECATED: The highest sort-ordered rkey to stop at (exclusive)
742
- * @deprecated
743
- */
744
- rkeyEnd?: string;
745
- /**
746
- * DEPRECATED: The lowest sort-ordered rkey to start from (exclusive)
747
- * @deprecated
748
- */
749
- rkeyStart?: string;
750
802
  }
751
803
  type Input = undefined;
752
804
  interface Output {
@@ -1322,11 +1374,6 @@ export declare namespace ComAtprotoSyncGetRecord {
1322
1374
  did: At.DID;
1323
1375
  /** Record Key */
1324
1376
  rkey: string;
1325
- /**
1326
- * DEPRECATED: referenced a repo commit by CID, and retrieved record as of that commit
1327
- * @deprecated
1328
- */
1329
- commit?: At.CID;
1330
1377
  }
1331
1378
  type Input = undefined;
1332
1379
  type Output = Uint8Array;
@@ -1471,7 +1518,7 @@ export declare namespace ComAtprotoSyncListReposByCollection {
1471
1518
  }
1472
1519
  }
1473
1520
 
1474
- /** 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. */
1521
+ /** 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 */
1475
1522
  export declare namespace ComAtprotoSyncNotifyOfUpdate {
1476
1523
  interface Params {}
1477
1524
  interface Input {
@@ -1550,17 +1597,6 @@ export declare namespace ComAtprotoSyncSubscribeRepos {
1550
1597
  /** 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. */
1551
1598
  prevData?: At.CIDLink;
1552
1599
  }
1553
- /**
1554
- * DEPRECATED -- Use #identity event instead
1555
- * @deprecated
1556
- */
1557
- interface Handle {
1558
- [Brand.Type]?: 'com.atproto.sync.subscribeRepos#handle';
1559
- did: At.DID;
1560
- handle: At.Handle;
1561
- seq: number;
1562
- time: string;
1563
- }
1564
1600
  /** 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. */
1565
1601
  interface Identity {
1566
1602
  [Brand.Type]?: 'com.atproto.sync.subscribeRepos#identity';
@@ -1575,17 +1611,6 @@ export declare namespace ComAtprotoSyncSubscribeRepos {
1575
1611
  name: 'OutdatedCursor' | (string & {});
1576
1612
  message?: string;
1577
1613
  }
1578
- /**
1579
- * DEPRECATED -- Use #account event instead
1580
- * @deprecated
1581
- */
1582
- interface Migrate {
1583
- [Brand.Type]?: 'com.atproto.sync.subscribeRepos#migrate';
1584
- did: At.DID;
1585
- migrateTo: string | null;
1586
- seq: number;
1587
- time: string;
1588
- }
1589
1614
  /** A repo operation, ie a mutation of a single record. */
1590
1615
  interface RepoOp {
1591
1616
  [Brand.Type]?: 'com.atproto.sync.subscribeRepos#repoOp';
@@ -1610,16 +1635,6 @@ export declare namespace ComAtprotoSyncSubscribeRepos {
1610
1635
  /** Timestamp of when this message was originally broadcast. */
1611
1636
  time: string;
1612
1637
  }
1613
- /**
1614
- * DEPRECATED -- Use #account event instead
1615
- * @deprecated
1616
- */
1617
- interface Tombstone {
1618
- [Brand.Type]?: 'com.atproto.sync.subscribeRepos#tombstone';
1619
- did: At.DID;
1620
- seq: number;
1621
- time: string;
1622
- }
1623
1638
  }
1624
1639
 
1625
1640
  /** Add a handle to the set of reserved handles. */
@@ -1699,10 +1714,18 @@ export declare interface Queries {
1699
1714
  'com.atproto.identity.getRecommendedDidCredentials': {
1700
1715
  output: ComAtprotoIdentityGetRecommendedDidCredentials.Output;
1701
1716
  };
1717
+ 'com.atproto.identity.resolveDid': {
1718
+ params: ComAtprotoIdentityResolveDid.Params;
1719
+ output: ComAtprotoIdentityResolveDid.Output;
1720
+ };
1702
1721
  'com.atproto.identity.resolveHandle': {
1703
1722
  params: ComAtprotoIdentityResolveHandle.Params;
1704
1723
  output: ComAtprotoIdentityResolveHandle.Output;
1705
1724
  };
1725
+ 'com.atproto.identity.resolveIdentity': {
1726
+ params: ComAtprotoIdentityResolveIdentity.Params;
1727
+ output: ComAtprotoIdentityResolveIdentity.Output;
1728
+ };
1706
1729
  'com.atproto.label.queryLabels': {
1707
1730
  params: ComAtprotoLabelQueryLabels.Params;
1708
1731
  output: ComAtprotoLabelQueryLabels.Output;
@@ -1826,6 +1849,10 @@ export declare interface Procedures {
1826
1849
  input: ComAtprotoAdminUpdateSubjectStatus.Input;
1827
1850
  output: ComAtprotoAdminUpdateSubjectStatus.Output;
1828
1851
  };
1852
+ 'com.atproto.identity.refreshIdentity': {
1853
+ input: ComAtprotoIdentityRefreshIdentity.Input;
1854
+ output: ComAtprotoIdentityRefreshIdentity.Output;
1855
+ };
1829
1856
  'com.atproto.identity.requestPlcOperationSignature': {};
1830
1857
  'com.atproto.identity.signPlcOperation': {
1831
1858
  input: ComAtprotoIdentitySignPlcOperation.Input;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "type": "module",
3
3
  "name": "@atcute/client",
4
- "version": "2.0.8",
4
+ "version": "2.0.9",
5
5
  "description": "lightweight and cute API client for AT Protocol",
6
6
  "license": "MIT",
7
7
  "repository": {
@@ -24,8 +24,8 @@
24
24
  "devDependencies": {
25
25
  "@vitest/coverage-v8": "^3.0.4",
26
26
  "vitest": "^3.0.4",
27
- "@atcute/internal-dev-env": "^1.0.1",
28
- "@atcute/lex-cli": "^1.0.4"
27
+ "@atcute/lex-cli": "^1.0.4",
28
+ "@atcute/internal-dev-env": "^1.0.1"
29
29
  },
30
30
  "scripts": {
31
31
  "build": "tsc --project tsconfig.build.json",