@atproto/syntax 0.4.1 → 0.4.3

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.
Files changed (77) hide show
  1. package/CHANGELOG.md +18 -0
  2. package/LICENSE.txt +1 -1
  3. package/dist/at-identifier.d.ts +6 -0
  4. package/dist/at-identifier.d.ts.map +1 -0
  5. package/dist/at-identifier.js +28 -0
  6. package/dist/at-identifier.js.map +1 -0
  7. package/dist/aturi.d.ts +8 -6
  8. package/dist/aturi.d.ts.map +1 -1
  9. package/dist/aturi.js +41 -83
  10. package/dist/aturi.js.map +1 -1
  11. package/dist/aturi_validation.d.ts +6 -2
  12. package/dist/aturi_validation.d.ts.map +1 -1
  13. package/dist/aturi_validation.js +66 -60
  14. package/dist/aturi_validation.js.map +1 -1
  15. package/dist/datetime.d.ts +11 -4
  16. package/dist/datetime.d.ts.map +1 -1
  17. package/dist/datetime.js +22 -25
  18. package/dist/datetime.js.map +1 -1
  19. package/dist/did.d.ts +4 -2
  20. package/dist/did.d.ts.map +1 -1
  21. package/dist/did.js +24 -19
  22. package/dist/did.js.map +1 -1
  23. package/dist/handle.d.ts +7 -6
  24. package/dist/handle.d.ts.map +1 -1
  25. package/dist/handle.js +32 -35
  26. package/dist/handle.js.map +1 -1
  27. package/dist/index.d.ts +10 -7
  28. package/dist/index.d.ts.map +1 -1
  29. package/dist/index.js +11 -21
  30. package/dist/index.js.map +1 -1
  31. package/dist/language.d.ts +18 -0
  32. package/dist/language.d.ts.map +1 -0
  33. package/dist/language.js +30 -0
  34. package/dist/language.js.map +1 -0
  35. package/dist/nsid.d.ts +6 -5
  36. package/dist/nsid.d.ts.map +1 -1
  37. package/dist/nsid.js +6 -11
  38. package/dist/nsid.js.map +1 -1
  39. package/dist/recordkey.d.ts +3 -2
  40. package/dist/recordkey.d.ts.map +1 -1
  41. package/dist/recordkey.js +33 -22
  42. package/dist/recordkey.js.map +1 -1
  43. package/dist/tid.d.ts +3 -2
  44. package/dist/tid.d.ts.map +1 -1
  45. package/dist/tid.js +10 -10
  46. package/dist/tid.js.map +1 -1
  47. package/dist/uri.d.ts +3 -0
  48. package/dist/uri.d.ts.map +1 -0
  49. package/dist/uri.js +7 -0
  50. package/dist/uri.js.map +1 -0
  51. package/package.json +7 -4
  52. package/src/at-identifier.ts +33 -0
  53. package/src/aturi.ts +59 -46
  54. package/src/aturi_validation.ts +78 -51
  55. package/src/datetime.ts +26 -14
  56. package/src/did.ts +28 -15
  57. package/src/handle.ts +29 -26
  58. package/src/index.ts +10 -7
  59. package/src/language.ts +39 -0
  60. package/src/nsid.ts +14 -8
  61. package/src/recordkey.ts +42 -17
  62. package/src/tid.ts +9 -5
  63. package/src/uri.ts +5 -0
  64. package/tests/aturi.test.ts +3 -2
  65. package/tests/datetime.test.ts +1 -0
  66. package/tests/did.test.ts +1 -0
  67. package/tests/handle.test.ts +1 -0
  68. package/tests/language.test.ts +88 -0
  69. package/tests/nsid.test.ts +1 -0
  70. package/tests/recordkey.test.ts +1 -0
  71. package/tests/tid.test.ts +1 -0
  72. package/tsconfig.build.json +6 -2
  73. package/tsconfig.build.tsbuildinfo +1 -1
  74. package/tsconfig.tests.json +6 -4
  75. package/vitest.config.ts +5 -0
  76. package/jest.config.js +0 -7
  77. package/tsconfig.tests.tsbuildinfo +0 -1
package/dist/nsid.js CHANGED
@@ -20,6 +20,7 @@ exports.validateNsid = validateNsid;
20
20
  exports.ensureValidNsidRegex = ensureValidNsidRegex;
21
21
  exports.validateNsidRegex = validateNsidRegex;
22
22
  class NSID {
23
+ segments;
23
24
  static parse(input) {
24
25
  return new NSID(input);
25
26
  }
@@ -41,12 +42,6 @@ class NSID {
41
42
  return new NSID(String(input));
42
43
  }
43
44
  constructor(nsid) {
44
- Object.defineProperty(this, "segments", {
45
- enumerable: true,
46
- configurable: true,
47
- writable: true,
48
- value: void 0
49
- });
50
45
  this.segments = parseNsid(nsid);
51
46
  }
52
47
  get authority() {
@@ -63,8 +58,8 @@ class NSID {
63
58
  }
64
59
  }
65
60
  exports.NSID = NSID;
66
- function ensureValidNsid(nsid) {
67
- const result = validateNsid(nsid);
61
+ function ensureValidNsid(input) {
62
+ const result = validateNsid(input);
68
63
  if (!result.success)
69
64
  throw new InvalidNsidError(result.message);
70
65
  }
@@ -74,10 +69,10 @@ function parseNsid(nsid) {
74
69
  throw new InvalidNsidError(result.message);
75
70
  return result.value;
76
71
  }
77
- function isValidNsid(nsid) {
72
+ function isValidNsid(input) {
78
73
  // Since the regex version is more performant for valid NSIDs, we use it when
79
74
  // we don't care about error details.
80
- return validateNsidRegex(nsid).success;
75
+ return validateNsidRegex(input).success;
81
76
  }
82
77
  // Human readable constraints on NSID:
83
78
  // - a valid domain in reversed notation
@@ -188,7 +183,7 @@ function validateNsidRegex(value) {
188
183
  }
189
184
  return {
190
185
  success: true,
191
- value,
186
+ value: value,
192
187
  };
193
188
  }
194
189
  class InvalidNsidError extends Error {
package/dist/nsid.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"nsid.js","sourceRoot":"","sources":["../src/nsid.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;EAWE;;;AAiDF,0CAGC;AAED,8BAIC;AAED,kCAIC;AASD,oCA0DC;AAiCD,oDAGC;AAMD,8CAuBC;AAlMD,MAAa,IAAI;IAGf,MAAM,CAAC,KAAK,CAAC,KAAa;QACxB,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,CAAA;IACxB,CAAC;IAED,MAAM,CAAC,MAAM,CAAC,SAAiB,EAAE,IAAY;QAC3C,MAAM,KAAK,GAAG,CAAC,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;QACjE,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,CAAA;IACxB,CAAC;IAED,MAAM,CAAC,OAAO,CAAC,IAAY;QACzB,OAAO,WAAW,CAAC,IAAI,CAAC,CAAA;IAC1B,CAAC;IAED,MAAM,CAAC,IAAI,CAAC,KAAiC;QAC3C,IAAI,KAAK,YAAY,IAAI,EAAE,CAAC;YAC1B,sCAAsC;YACtC,OAAO,KAAK,CAAA;QACd,CAAC;QACD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,OAAO,IAAI,IAAI,CAAE,KAAkB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAA;QAChD,CAAC;QACD,OAAO,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;IAChC,CAAC;IAED,YAAY,IAAY;QA1Bf;;;;;WAA2B;QA2BlC,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC,IAAI,CAAC,CAAA;IACjC,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,QAAQ;aACjB,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC;aAClC,OAAO,EAAE;aACT,IAAI,CAAC,GAAG,CAAC,CAAA;IACd,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;IACnD,CAAC;IAED,QAAQ;QACN,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IAChC,CAAC;CACF;AA7CD,oBA6CC;AAED,SAAgB,eAAe,CAAC,IAAY;IAC1C,MAAM,MAAM,GAAG,YAAY,CAAC,IAAI,CAAC,CAAA;IACjC,IAAI,CAAC,MAAM,CAAC,OAAO;QAAE,MAAM,IAAI,gBAAgB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;AACjE,CAAC;AAED,SAAgB,SAAS,CAAC,IAAY;IACpC,MAAM,MAAM,GAAG,YAAY,CAAC,IAAI,CAAC,CAAA;IACjC,IAAI,CAAC,MAAM,CAAC,OAAO;QAAE,MAAM,IAAI,gBAAgB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;IAC/D,OAAO,MAAM,CAAC,KAAK,CAAA;AACrB,CAAC;AAED,SAAgB,WAAW,CAAC,IAAY;IACtC,6EAA6E;IAC7E,qCAAqC;IACrC,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAC,OAAO,CAAA;AACxC,CAAC;AAMD,sCAAsC;AACtC,wCAAwC;AACxC,iFAAiF;AACjF,SAAgB,YAAY,CAAC,KAAa;IACxC,IAAI,KAAK,CAAC,MAAM,GAAG,GAAG,GAAG,CAAC,GAAG,EAAE,EAAE,CAAC;QAChC,OAAO;YACL,OAAO,EAAE,KAAK;YACd,OAAO,EAAE,kCAAkC;SAC5C,CAAA;IACH,CAAC;IACD,IAAI,uBAAuB,CAAC,KAAK,CAAC,EAAE,CAAC;QACnC,OAAO;YACL,OAAO,EAAE,KAAK;YACd,OAAO,EACL,6EAA6E;SAChF,CAAA;IACH,CAAC;IACD,MAAM,QAAQ,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IACjC,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACxB,OAAO;YACL,OAAO,EAAE,KAAK;YACd,OAAO,EAAE,iCAAiC;SAC3C,CAAA;IACH,CAAC;IACD,KAAK,MAAM,CAAC,IAAI,QAAQ,EAAE,CAAC;QACzB,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACjB,OAAO;gBACL,OAAO,EAAE,KAAK;gBACd,OAAO,EAAE,6BAA6B;aACvC,CAAA;QACH,CAAC;QACD,IAAI,CAAC,CAAC,MAAM,GAAG,EAAE,EAAE,CAAC;YAClB,OAAO;gBACL,OAAO,EAAE,KAAK;gBACd,OAAO,EAAE,mCAAmC;aAC7C,CAAA;QACH,CAAC;QACD,IAAI,gBAAgB,CAAC,CAAC,CAAC,IAAI,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC;YAC7C,OAAO;gBACL,OAAO,EAAE,KAAK;gBACd,OAAO,EAAE,6CAA6C;aACvD,CAAA;QACH,CAAC;IACH,CAAC;IACD,IAAI,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAClC,OAAO;YACL,OAAO,EAAE,KAAK;YACd,OAAO,EAAE,4CAA4C;SACtD,CAAA;IACH,CAAC;IACD,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;QACtD,OAAO;YACL,OAAO,EAAE,KAAK;YACd,OAAO,EACL,uEAAuE;SAC1E,CAAA;IACH,CAAC;IACD,OAAO;QACL,OAAO,EAAE,IAAI;QACb,KAAK,EAAE,QAAQ;KAChB,CAAA;AACH,CAAC;AAED,SAAS,uBAAuB,CAAC,CAAC;IAChC,OAAO,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;AACpC,CAAC;AAED,SAAS,gBAAgB,CAAC,CAAS;IACjC,MAAM,QAAQ,GAAG,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAA;IAChC,OAAO,QAAQ,IAAI,EAAE,IAAI,QAAQ,IAAI,EAAE,CAAA;AACzC,CAAC;AAED,SAAS,gBAAgB,CAAC,CAAS;IACjC,OAAO,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,EAAE,CAAA,CAAC,OAAO;AACvC,CAAC;AAED,SAAS,cAAc,CAAC,CAAS;IAC/B,OAAO,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,EAAE,CAAA,CAAC,OAAO;AAClD,CAAC;AAED,SAAS,iBAAiB,CAAC,CAAS;IAClC,0EAA0E;IAC1E,4EAA4E;IAC5E,UAAU;IAEV,0CAA0C;IAC1C,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAA;AACjD,CAAC;AAED;;;;GAIG;AACH,SAAgB,oBAAoB,CAAC,IAAY;IAC/C,MAAM,MAAM,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAA;IACtC,IAAI,CAAC,MAAM,CAAC,OAAO;QAAE,MAAM,IAAI,gBAAgB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;AACjE,CAAC;AAED;;;GAGG;AACH,SAAgB,iBAAiB,CAAC,KAAa;IAC7C,IAAI,KAAK,CAAC,MAAM,GAAG,GAAG,GAAG,CAAC,GAAG,EAAE,EAAE,CAAC;QAChC,OAAO;YACL,OAAO,EAAE,KAAK;YACd,OAAO,EAAE,kCAAkC;SAC5C,CAAA;IACH,CAAC;IAED,IACE,CAAC,sIAAsI,CAAC,IAAI,CAC1I,KAAK,CACN,EACD,CAAC;QACD,OAAO;YACL,OAAO,EAAE,KAAK;YACd,OAAO,EAAE,gCAAgC;SAC1C,CAAA;IACH,CAAC;IAED,OAAO;QACL,OAAO,EAAE,IAAI;QACb,KAAK;KACN,CAAA;AACH,CAAC;AAED,MAAa,gBAAiB,SAAQ,KAAK;CAAG;AAA9C,4CAA8C"}
1
+ {"version":3,"file":"nsid.js","sourceRoot":"","sources":["../src/nsid.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;EAWE;;;AAmDF,0CAKC;AAED,8BAIC;AAED,kCAMC;AASD,oCA0DC;AAiCD,oDAGC;AAMD,8CAuBC;AAtMD,MAAa,IAAI;IACN,QAAQ,CAAmB;IAEpC,MAAM,CAAC,KAAK,CAAC,KAAa;QACxB,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,CAAA;IACxB,CAAC;IAED,MAAM,CAAC,MAAM,CAAC,SAAiB,EAAE,IAAY;QAC3C,MAAM,KAAK,GAAG,CAAC,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;QACjE,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,CAAA;IACxB,CAAC;IAED,MAAM,CAAC,OAAO,CAAC,IAAY;QACzB,OAAO,WAAW,CAAC,IAAI,CAAC,CAAA;IAC1B,CAAC;IAED,MAAM,CAAC,IAAI,CAAC,KAAiC;QAC3C,IAAI,KAAK,YAAY,IAAI,EAAE,CAAC;YAC1B,sCAAsC;YACtC,OAAO,KAAK,CAAA;QACd,CAAC;QACD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,OAAO,IAAI,IAAI,CAAE,KAAkB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAA;QAChD,CAAC;QACD,OAAO,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;IAChC,CAAC;IAED,YAAY,IAAY;QACtB,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC,IAAI,CAAC,CAAA;IACjC,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,QAAQ;aACjB,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC;aAClC,OAAO,EAAE;aACT,IAAI,CAAC,GAAG,CAAC,CAAA;IACd,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;IACnD,CAAC;IAED,QAAQ;QACN,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IAChC,CAAC;CACF;AA7CD,oBA6CC;AAED,SAAgB,eAAe,CAC7B,KAAQ;IAER,MAAM,MAAM,GAAG,YAAY,CAAC,KAAK,CAAC,CAAA;IAClC,IAAI,CAAC,MAAM,CAAC,OAAO;QAAE,MAAM,IAAI,gBAAgB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;AACjE,CAAC;AAED,SAAgB,SAAS,CAAC,IAAY;IACpC,MAAM,MAAM,GAAG,YAAY,CAAC,IAAI,CAAC,CAAA;IACjC,IAAI,CAAC,MAAM,CAAC,OAAO;QAAE,MAAM,IAAI,gBAAgB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;IAC/D,OAAO,MAAM,CAAC,KAAK,CAAA;AACrB,CAAC;AAED,SAAgB,WAAW,CACzB,KAAQ;IAER,6EAA6E;IAC7E,qCAAqC;IACrC,OAAO,iBAAiB,CAAC,KAAK,CAAC,CAAC,OAAO,CAAA;AACzC,CAAC;AAMD,sCAAsC;AACtC,wCAAwC;AACxC,iFAAiF;AACjF,SAAgB,YAAY,CAAC,KAAa;IACxC,IAAI,KAAK,CAAC,MAAM,GAAG,GAAG,GAAG,CAAC,GAAG,EAAE,EAAE,CAAC;QAChC,OAAO;YACL,OAAO,EAAE,KAAK;YACd,OAAO,EAAE,kCAAkC;SAC5C,CAAA;IACH,CAAC;IACD,IAAI,uBAAuB,CAAC,KAAK,CAAC,EAAE,CAAC;QACnC,OAAO;YACL,OAAO,EAAE,KAAK;YACd,OAAO,EACL,6EAA6E;SAChF,CAAA;IACH,CAAC;IACD,MAAM,QAAQ,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IACjC,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACxB,OAAO;YACL,OAAO,EAAE,KAAK;YACd,OAAO,EAAE,iCAAiC;SAC3C,CAAA;IACH,CAAC;IACD,KAAK,MAAM,CAAC,IAAI,QAAQ,EAAE,CAAC;QACzB,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACjB,OAAO;gBACL,OAAO,EAAE,KAAK;gBACd,OAAO,EAAE,6BAA6B;aACvC,CAAA;QACH,CAAC;QACD,IAAI,CAAC,CAAC,MAAM,GAAG,EAAE,EAAE,CAAC;YAClB,OAAO;gBACL,OAAO,EAAE,KAAK;gBACd,OAAO,EAAE,mCAAmC;aAC7C,CAAA;QACH,CAAC;QACD,IAAI,gBAAgB,CAAC,CAAC,CAAC,IAAI,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC;YAC7C,OAAO;gBACL,OAAO,EAAE,KAAK;gBACd,OAAO,EAAE,6CAA6C;aACvD,CAAA;QACH,CAAC;IACH,CAAC;IACD,IAAI,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAClC,OAAO;YACL,OAAO,EAAE,KAAK;YACd,OAAO,EAAE,4CAA4C;SACtD,CAAA;IACH,CAAC;IACD,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;QACtD,OAAO;YACL,OAAO,EAAE,KAAK;YACd,OAAO,EACL,uEAAuE;SAC1E,CAAA;IACH,CAAC;IACD,OAAO;QACL,OAAO,EAAE,IAAI;QACb,KAAK,EAAE,QAAQ;KAChB,CAAA;AACH,CAAC;AAED,SAAS,uBAAuB,CAAC,CAAS;IACxC,OAAO,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;AACpC,CAAC;AAED,SAAS,gBAAgB,CAAC,CAAS;IACjC,MAAM,QAAQ,GAAG,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAA;IAChC,OAAO,QAAQ,IAAI,EAAE,IAAI,QAAQ,IAAI,EAAE,CAAA;AACzC,CAAC;AAED,SAAS,gBAAgB,CAAC,CAAS;IACjC,OAAO,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,EAAE,CAAA,CAAC,OAAO;AACvC,CAAC;AAED,SAAS,cAAc,CAAC,CAAS;IAC/B,OAAO,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,EAAE,CAAA,CAAC,OAAO;AAClD,CAAC;AAED,SAAS,iBAAiB,CAAC,CAAS;IAClC,0EAA0E;IAC1E,4EAA4E;IAC5E,UAAU;IAEV,0CAA0C;IAC1C,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAA;AACjD,CAAC;AAED;;;;GAIG;AACH,SAAgB,oBAAoB,CAAC,IAAY;IAC/C,MAAM,MAAM,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAA;IACtC,IAAI,CAAC,MAAM,CAAC,OAAO;QAAE,MAAM,IAAI,gBAAgB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;AACjE,CAAC;AAED;;;GAGG;AACH,SAAgB,iBAAiB,CAAC,KAAa;IAC7C,IAAI,KAAK,CAAC,MAAM,GAAG,GAAG,GAAG,CAAC,GAAG,EAAE,EAAE,CAAC;QAChC,OAAO;YACL,OAAO,EAAE,KAAK;YACd,OAAO,EAAE,kCAAkC;SAC5C,CAAA;IACH,CAAC;IAED,IACE,CAAC,sIAAsI,CAAC,IAAI,CAC1I,KAAK,CACN,EACD,CAAC;QACD,OAAO;YACL,OAAO,EAAE,KAAK;YACd,OAAO,EAAE,gCAAgC;SAC1C,CAAA;IACH,CAAC;IAED,OAAO;QACL,OAAO,EAAE,IAAI;QACb,KAAK,EAAE,KAAmB;KAC3B,CAAA;AACH,CAAC;AAED,MAAa,gBAAiB,SAAQ,KAAK;CAAG;AAA9C,4CAA8C","sourcesContent":["/*\nGrammar:\n\nalpha = \"a\" / \"b\" / \"c\" / \"d\" / \"e\" / \"f\" / \"g\" / \"h\" / \"i\" / \"j\" / \"k\" / \"l\" / \"m\" / \"n\" / \"o\" / \"p\" / \"q\" / \"r\" / \"s\" / \"t\" / \"u\" / \"v\" / \"w\" / \"x\" / \"y\" / \"z\" / \"A\" / \"B\" / \"C\" / \"D\" / \"E\" / \"F\" / \"G\" / \"H\" / \"I\" / \"J\" / \"K\" / \"L\" / \"M\" / \"N\" / \"O\" / \"P\" / \"Q\" / \"R\" / \"S\" / \"T\" / \"U\" / \"V\" / \"W\" / \"X\" / \"Y\" / \"Z\"\nnumber = \"1\" / \"2\" / \"3\" / \"4\" / \"5\" / \"6\" / \"7\" / \"8\" / \"9\" / \"0\"\ndelim = \".\"\nsegment = alpha *( alpha / number / \"-\" )\nauthority = segment *( delim segment )\nname = alpha *( alpha / number )\nnsid = authority delim name\n\n*/\n\nexport type NsidString = `${string}.${string}.${string}`\n\nexport class NSID {\n readonly segments: readonly string[]\n\n static parse(input: string): NSID {\n return new NSID(input)\n }\n\n static create(authority: string, name: string): NSID {\n const input = [...authority.split('.').reverse(), name].join('.')\n return new NSID(input)\n }\n\n static isValid(nsid: string) {\n return isValidNsid(nsid)\n }\n\n static from(input: { toString: () => string }): NSID {\n if (input instanceof NSID) {\n // No need to clone, NSID is immutable\n return input\n }\n if (Array.isArray(input)) {\n return new NSID((input as string[]).join('.'))\n }\n return new NSID(String(input))\n }\n\n constructor(nsid: string) {\n this.segments = parseNsid(nsid)\n }\n\n get authority() {\n return this.segments\n .slice(0, this.segments.length - 1)\n .reverse()\n .join('.')\n }\n\n get name() {\n return this.segments.at(this.segments.length - 1)\n }\n\n toString() {\n return this.segments.join('.')\n }\n}\n\nexport function ensureValidNsid<I extends string>(\n input: I,\n): asserts input is I & NsidString {\n const result = validateNsid(input)\n if (!result.success) throw new InvalidNsidError(result.message)\n}\n\nexport function parseNsid(nsid: string): string[] {\n const result = validateNsid(nsid)\n if (!result.success) throw new InvalidNsidError(result.message)\n return result.value\n}\n\nexport function isValidNsid<I extends string>(\n input: I,\n): input is I & NsidString {\n // Since the regex version is more performant for valid NSIDs, we use it when\n // we don't care about error details.\n return validateNsidRegex(input).success\n}\n\ntype ValidateResult<T> =\n | { success: true; value: T }\n | { success: false; message: string }\n\n// Human readable constraints on NSID:\n// - a valid domain in reversed notation\n// - followed by an additional period-separated name, which is camel-case letters\nexport function validateNsid(input: string): ValidateResult<string[]> {\n if (input.length > 253 + 1 + 63) {\n return {\n success: false,\n message: 'NSID is too long (317 chars max)',\n }\n }\n if (hasDisallowedCharacters(input)) {\n return {\n success: false,\n message:\n 'Disallowed characters in NSID (ASCII letters, digits, dashes, periods only)',\n }\n }\n const segments = input.split('.')\n if (segments.length < 3) {\n return {\n success: false,\n message: 'NSID needs at least three parts',\n }\n }\n for (const l of segments) {\n if (l.length < 1) {\n return {\n success: false,\n message: 'NSID parts can not be empty',\n }\n }\n if (l.length > 63) {\n return {\n success: false,\n message: 'NSID part too long (max 63 chars)',\n }\n }\n if (startsWithHyphen(l) || endsWithHyphen(l)) {\n return {\n success: false,\n message: 'NSID parts can not start or end with hyphen',\n }\n }\n }\n if (startsWithNumber(segments[0])) {\n return {\n success: false,\n message: 'NSID first part may not start with a digit',\n }\n }\n if (!isValidIdentifier(segments[segments.length - 1])) {\n return {\n success: false,\n message:\n 'NSID name part must be only letters and digits (and no leading digit)',\n }\n }\n return {\n success: true,\n value: segments,\n }\n}\n\nfunction hasDisallowedCharacters(v: string) {\n return !/^[a-zA-Z0-9.-]*$/.test(v)\n}\n\nfunction startsWithNumber(v: string) {\n const charCode = v.charCodeAt(0)\n return charCode >= 48 && charCode <= 57\n}\n\nfunction startsWithHyphen(v: string) {\n return v.charCodeAt(0) === 45 /* - */\n}\n\nfunction endsWithHyphen(v: string) {\n return v.charCodeAt(v.length - 1) === 45 /* - */\n}\n\nfunction isValidIdentifier(v: string) {\n // Note, since we already know that \"v\" only contains [a-zA-Z0-9-], we can\n // simplify the following regex by checking only the first char and presence\n // of \"-\".\n\n // return /^[a-zA-Z][a-zA-Z0-9]*$/.test(v)\n return !startsWithNumber(v) && !v.includes('-')\n}\n\n/**\n * @deprecated Use {@link ensureValidNsid} if you care about error details,\n * {@link parseNsid}/{@link NSID.parse} if you need the parsed segments, or\n * {@link isValidNsid} if you just want a boolean.\n */\nexport function ensureValidNsidRegex(nsid: string): asserts nsid is NsidString {\n const result = validateNsidRegex(nsid)\n if (!result.success) throw new InvalidNsidError(result.message)\n}\n\n/**\n * Regexp based validation that behaves identically to the previous code but\n * provides less detailed error messages (while being 20% to 50% faster).\n */\nexport function validateNsidRegex(value: string): ValidateResult<NsidString> {\n if (value.length > 253 + 1 + 63) {\n return {\n success: false,\n message: 'NSID is too long (317 chars max)',\n }\n }\n\n if (\n !/^[a-zA-Z](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)+(?:\\.[a-zA-Z](?:[a-zA-Z0-9]{0,62})?)$/.test(\n value,\n )\n ) {\n return {\n success: false,\n message: \"NSID didn't validate via regex\",\n }\n }\n\n return {\n success: true,\n value: value as NsidString,\n }\n}\n\nexport class InvalidNsidError extends Error {}\n"]}
@@ -1,5 +1,6 @@
1
- export declare const ensureValidRecordKey: (rkey: string) => void;
2
- export declare const isValidRecordKey: (rkey: string) => boolean;
1
+ export type RecordKeyString = string;
2
+ export declare function ensureValidRecordKey<I extends string>(input: I): asserts input is I & RecordKeyString;
3
+ export declare function isValidRecordKey<I extends string>(input: I): input is I & RecordKeyString;
3
4
  export declare class InvalidRecordKeyError extends Error {
4
5
  }
5
6
  //# sourceMappingURL=recordkey.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"recordkey.d.ts","sourceRoot":"","sources":["../src/recordkey.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,oBAAoB,GAAI,MAAM,MAAM,KAAG,IAUnD,CAAA;AAED,eAAO,MAAM,gBAAgB,GAAI,MAAM,MAAM,KAAG,OAW/C,CAAA;AAED,qBAAa,qBAAsB,SAAQ,KAAK;CAAG"}
1
+ {"version":3,"file":"recordkey.d.ts","sourceRoot":"","sources":["../src/recordkey.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,eAAe,GAAG,MAAM,CAAA;AAmBpC,wBAAgB,oBAAoB,CAAC,CAAC,SAAS,MAAM,EACnD,KAAK,EAAE,CAAC,GACP,OAAO,CAAC,KAAK,IAAI,CAAC,GAAG,eAAe,CAgBtC;AAED,wBAAgB,gBAAgB,CAAC,CAAC,SAAS,MAAM,EAC/C,KAAK,EAAE,CAAC,GACP,KAAK,IAAI,CAAC,GAAG,eAAe,CAO9B;AAED,qBAAa,qBAAsB,SAAQ,KAAK;CAAG"}
package/dist/recordkey.js CHANGED
@@ -1,31 +1,42 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.InvalidRecordKeyError = exports.isValidRecordKey = exports.ensureValidRecordKey = void 0;
4
- const ensureValidRecordKey = (rkey) => {
5
- if (rkey.length > 512 || rkey.length < 1) {
6
- throw new InvalidRecordKeyError('record key must be 1 to 512 characters');
7
- }
8
- // simple regex to enforce most constraints via just regex and length.
9
- if (!/^[a-zA-Z0-9_~.:-]{1,512}$/.test(rkey)) {
10
- throw new InvalidRecordKeyError('record key syntax not valid (regex)');
3
+ exports.InvalidRecordKeyError = void 0;
4
+ exports.ensureValidRecordKey = ensureValidRecordKey;
5
+ exports.isValidRecordKey = isValidRecordKey;
6
+ const RECORD_KEY_MAX_LENGTH = 512;
7
+ const RECORD_KEY_MIN_LENGTH = 1;
8
+ const RECORD_KEY_INVALID_VALUES = new Set(['.', '..']);
9
+ const RECORD_KEY_REGEX = /^[a-zA-Z0-9_~.:-]{1,512}$/;
10
+ // https://atproto.com/specs/record-key#record-key-syntax
11
+ // Regardless of the type, Record Keys must fulfill some baseline syntax constraints:
12
+ // - restricted to a subset of ASCII characters -- the allowed characters are
13
+ // alphanumeric (A-Za-z0-9), period, dash, underscore, colon, or tilde (.-_:~)
14
+ // - must have at least 1 and at most 512 characters
15
+ // - the specific record key values . and .. are not allowed
16
+ // - must be a permissible part of repository MST path string (the above
17
+ // constraints satisfy this condition)
18
+ // - must be permissible to include in a path component of a URI (following
19
+ // RFC-3986, section 3.3). The above constraints satisfy this condition, by
20
+ // matching the "unreserved" characters allowed in generic URI paths.
21
+ function ensureValidRecordKey(input) {
22
+ if (input.length > RECORD_KEY_MAX_LENGTH ||
23
+ input.length < RECORD_KEY_MIN_LENGTH) {
24
+ throw new InvalidRecordKeyError(`record key must be ${RECORD_KEY_MIN_LENGTH} to ${RECORD_KEY_MAX_LENGTH} characters`);
11
25
  }
12
- if (rkey === '.' || rkey === '..')
26
+ if (RECORD_KEY_INVALID_VALUES.has(input)) {
13
27
  throw new InvalidRecordKeyError('record key can not be "." or ".."');
14
- };
15
- exports.ensureValidRecordKey = ensureValidRecordKey;
16
- const isValidRecordKey = (rkey) => {
17
- try {
18
- (0, exports.ensureValidRecordKey)(rkey);
19
28
  }
20
- catch (err) {
21
- if (err instanceof InvalidRecordKeyError) {
22
- return false;
23
- }
24
- throw err;
29
+ // simple regex to enforce most constraints via just regex and length.
30
+ if (!RECORD_KEY_REGEX.test(input)) {
31
+ throw new InvalidRecordKeyError('record key syntax not valid (regex)');
25
32
  }
26
- return true;
27
- };
28
- exports.isValidRecordKey = isValidRecordKey;
33
+ }
34
+ function isValidRecordKey(input) {
35
+ return (input.length >= RECORD_KEY_MIN_LENGTH &&
36
+ input.length <= RECORD_KEY_MAX_LENGTH &&
37
+ RECORD_KEY_REGEX.test(input) &&
38
+ !RECORD_KEY_INVALID_VALUES.has(input));
39
+ }
29
40
  class InvalidRecordKeyError extends Error {
30
41
  }
31
42
  exports.InvalidRecordKeyError = InvalidRecordKeyError;
@@ -1 +1 @@
1
- {"version":3,"file":"recordkey.js","sourceRoot":"","sources":["../src/recordkey.ts"],"names":[],"mappings":";;;AAAO,MAAM,oBAAoB,GAAG,CAAC,IAAY,EAAQ,EAAE;IACzD,IAAI,IAAI,CAAC,MAAM,GAAG,GAAG,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACzC,MAAM,IAAI,qBAAqB,CAAC,wCAAwC,CAAC,CAAA;IAC3E,CAAC;IACD,sEAAsE;IACtE,IAAI,CAAC,2BAA2B,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QAC5C,MAAM,IAAI,qBAAqB,CAAC,qCAAqC,CAAC,CAAA;IACxE,CAAC;IACD,IAAI,IAAI,KAAK,GAAG,IAAI,IAAI,KAAK,IAAI;QAC/B,MAAM,IAAI,qBAAqB,CAAC,mCAAmC,CAAC,CAAA;AACxE,CAAC,CAAA;AAVY,QAAA,oBAAoB,wBAUhC;AAEM,MAAM,gBAAgB,GAAG,CAAC,IAAY,EAAW,EAAE;IACxD,IAAI,CAAC;QACH,IAAA,4BAAoB,EAAC,IAAI,CAAC,CAAA;IAC5B,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,IAAI,GAAG,YAAY,qBAAqB,EAAE,CAAC;YACzC,OAAO,KAAK,CAAA;QACd,CAAC;QACD,MAAM,GAAG,CAAA;IACX,CAAC;IAED,OAAO,IAAI,CAAA;AACb,CAAC,CAAA;AAXY,QAAA,gBAAgB,oBAW5B;AAED,MAAa,qBAAsB,SAAQ,KAAK;CAAG;AAAnD,sDAAmD"}
1
+ {"version":3,"file":"recordkey.js","sourceRoot":"","sources":["../src/recordkey.ts"],"names":[],"mappings":";;;AAmBA,oDAkBC;AAED,4CASC;AA9CD,MAAM,qBAAqB,GAAG,GAAG,CAAA;AACjC,MAAM,qBAAqB,GAAG,CAAC,CAAA;AAC/B,MAAM,yBAAyB,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAA;AACtD,MAAM,gBAAgB,GAAG,2BAA2B,CAAA;AAEpD,yDAAyD;AACzD,qFAAqF;AACrF,6EAA6E;AAC7E,gFAAgF;AAChF,oDAAoD;AACpD,4DAA4D;AAC5D,wEAAwE;AACxE,wCAAwC;AACxC,2EAA2E;AAC3E,6EAA6E;AAC7E,uEAAuE;AAEvE,SAAgB,oBAAoB,CAClC,KAAQ;IAER,IACE,KAAK,CAAC,MAAM,GAAG,qBAAqB;QACpC,KAAK,CAAC,MAAM,GAAG,qBAAqB,EACpC,CAAC;QACD,MAAM,IAAI,qBAAqB,CAC7B,sBAAsB,qBAAqB,OAAO,qBAAqB,aAAa,CACrF,CAAA;IACH,CAAC;IACD,IAAI,yBAAyB,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;QACzC,MAAM,IAAI,qBAAqB,CAAC,mCAAmC,CAAC,CAAA;IACtE,CAAC;IACD,sEAAsE;IACtE,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QAClC,MAAM,IAAI,qBAAqB,CAAC,qCAAqC,CAAC,CAAA;IACxE,CAAC;AACH,CAAC;AAED,SAAgB,gBAAgB,CAC9B,KAAQ;IAER,OAAO,CACL,KAAK,CAAC,MAAM,IAAI,qBAAqB;QACrC,KAAK,CAAC,MAAM,IAAI,qBAAqB;QACrC,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC;QAC5B,CAAC,yBAAyB,CAAC,GAAG,CAAC,KAAK,CAAC,CACtC,CAAA;AACH,CAAC;AAED,MAAa,qBAAsB,SAAQ,KAAK;CAAG;AAAnD,sDAAmD","sourcesContent":["export type RecordKeyString = string\n\nconst RECORD_KEY_MAX_LENGTH = 512\nconst RECORD_KEY_MIN_LENGTH = 1\nconst RECORD_KEY_INVALID_VALUES = new Set(['.', '..'])\nconst RECORD_KEY_REGEX = /^[a-zA-Z0-9_~.:-]{1,512}$/\n\n// https://atproto.com/specs/record-key#record-key-syntax\n// Regardless of the type, Record Keys must fulfill some baseline syntax constraints:\n// - restricted to a subset of ASCII characters -- the allowed characters are\n// alphanumeric (A-Za-z0-9), period, dash, underscore, colon, or tilde (.-_:~)\n// - must have at least 1 and at most 512 characters\n// - the specific record key values . and .. are not allowed\n// - must be a permissible part of repository MST path string (the above\n// constraints satisfy this condition)\n// - must be permissible to include in a path component of a URI (following\n// RFC-3986, section 3.3). The above constraints satisfy this condition, by\n// matching the \"unreserved\" characters allowed in generic URI paths.\n\nexport function ensureValidRecordKey<I extends string>(\n input: I,\n): asserts input is I & RecordKeyString {\n if (\n input.length > RECORD_KEY_MAX_LENGTH ||\n input.length < RECORD_KEY_MIN_LENGTH\n ) {\n throw new InvalidRecordKeyError(\n `record key must be ${RECORD_KEY_MIN_LENGTH} to ${RECORD_KEY_MAX_LENGTH} characters`,\n )\n }\n if (RECORD_KEY_INVALID_VALUES.has(input)) {\n throw new InvalidRecordKeyError('record key can not be \".\" or \"..\"')\n }\n // simple regex to enforce most constraints via just regex and length.\n if (!RECORD_KEY_REGEX.test(input)) {\n throw new InvalidRecordKeyError('record key syntax not valid (regex)')\n }\n}\n\nexport function isValidRecordKey<I extends string>(\n input: I,\n): input is I & RecordKeyString {\n return (\n input.length >= RECORD_KEY_MIN_LENGTH &&\n input.length <= RECORD_KEY_MAX_LENGTH &&\n RECORD_KEY_REGEX.test(input) &&\n !RECORD_KEY_INVALID_VALUES.has(input)\n )\n}\n\nexport class InvalidRecordKeyError extends Error {}\n"]}
package/dist/tid.d.ts CHANGED
@@ -1,5 +1,6 @@
1
- export declare const ensureValidTid: (tid: string) => void;
2
- export declare const isValidTid: (tid: string) => boolean;
1
+ export type TidString = string;
2
+ export declare function ensureValidTid<I extends string>(input: I): asserts input is I & TidString;
3
+ export declare function isValidTid<I extends string>(input: I): input is I & TidString;
3
4
  export declare class InvalidTidError extends Error {
4
5
  }
5
6
  //# sourceMappingURL=tid.d.ts.map
package/dist/tid.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"tid.d.ts","sourceRoot":"","sources":["../src/tid.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,cAAc,GAAI,KAAK,MAAM,KAAG,IAQ5C,CAAA;AAED,eAAO,MAAM,UAAU,GAAI,KAAK,MAAM,KAAG,OAExC,CAAA;AAED,qBAAa,eAAgB,SAAQ,KAAK;CAAG"}
1
+ {"version":3,"file":"tid.d.ts","sourceRoot":"","sources":["../src/tid.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,SAAS,GAAG,MAAM,CAAA;AAK9B,wBAAgB,cAAc,CAAC,CAAC,SAAS,MAAM,EAC7C,KAAK,EAAE,CAAC,GACP,OAAO,CAAC,KAAK,IAAI,CAAC,GAAG,SAAS,CAQhC;AAED,wBAAgB,UAAU,CAAC,CAAC,SAAS,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,KAAK,IAAI,CAAC,GAAG,SAAS,CAE7E;AAED,qBAAa,eAAgB,SAAQ,KAAK;CAAG"}
package/dist/tid.js CHANGED
@@ -1,22 +1,22 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.InvalidTidError = exports.isValidTid = exports.ensureValidTid = void 0;
3
+ exports.InvalidTidError = void 0;
4
+ exports.ensureValidTid = ensureValidTid;
5
+ exports.isValidTid = isValidTid;
4
6
  const TID_LENGTH = 13;
5
7
  const TID_REGEX = /^[234567abcdefghij][234567abcdefghijklmnopqrstuvwxyz]{12}$/;
6
- const ensureValidTid = (tid) => {
7
- if (tid.length !== TID_LENGTH) {
8
+ function ensureValidTid(input) {
9
+ if (input.length !== TID_LENGTH) {
8
10
  throw new InvalidTidError(`TID must be ${TID_LENGTH} characters`);
9
11
  }
10
12
  // simple regex to enforce most constraints via just regex and length.
11
- if (!TID_REGEX.test(tid)) {
13
+ if (!TID_REGEX.test(input)) {
12
14
  throw new InvalidTidError('TID syntax not valid (regex)');
13
15
  }
14
- };
15
- exports.ensureValidTid = ensureValidTid;
16
- const isValidTid = (tid) => {
17
- return tid.length === TID_LENGTH && TID_REGEX.test(tid);
18
- };
19
- exports.isValidTid = isValidTid;
16
+ }
17
+ function isValidTid(input) {
18
+ return input.length === TID_LENGTH && TID_REGEX.test(input);
19
+ }
20
20
  class InvalidTidError extends Error {
21
21
  }
22
22
  exports.InvalidTidError = InvalidTidError;
package/dist/tid.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"tid.js","sourceRoot":"","sources":["../src/tid.ts"],"names":[],"mappings":";;;AAAA,MAAM,UAAU,GAAG,EAAE,CAAA;AACrB,MAAM,SAAS,GAAG,4DAA4D,CAAA;AAEvE,MAAM,cAAc,GAAG,CAAC,GAAW,EAAQ,EAAE;IAClD,IAAI,GAAG,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;QAC9B,MAAM,IAAI,eAAe,CAAC,eAAe,UAAU,aAAa,CAAC,CAAA;IACnE,CAAC;IACD,sEAAsE;IACtE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QACzB,MAAM,IAAI,eAAe,CAAC,8BAA8B,CAAC,CAAA;IAC3D,CAAC;AACH,CAAC,CAAA;AARY,QAAA,cAAc,kBAQ1B;AAEM,MAAM,UAAU,GAAG,CAAC,GAAW,EAAW,EAAE;IACjD,OAAO,GAAG,CAAC,MAAM,KAAK,UAAU,IAAI,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;AACzD,CAAC,CAAA;AAFY,QAAA,UAAU,cAEtB;AAED,MAAa,eAAgB,SAAQ,KAAK;CAAG;AAA7C,0CAA6C"}
1
+ {"version":3,"file":"tid.js","sourceRoot":"","sources":["../src/tid.ts"],"names":[],"mappings":";;;AAKA,wCAUC;AAED,gCAEC;AAjBD,MAAM,UAAU,GAAG,EAAE,CAAA;AACrB,MAAM,SAAS,GAAG,4DAA4D,CAAA;AAE9E,SAAgB,cAAc,CAC5B,KAAQ;IAER,IAAI,KAAK,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;QAChC,MAAM,IAAI,eAAe,CAAC,eAAe,UAAU,aAAa,CAAC,CAAA;IACnE,CAAC;IACD,sEAAsE;IACtE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QAC3B,MAAM,IAAI,eAAe,CAAC,8BAA8B,CAAC,CAAA;IAC3D,CAAC;AACH,CAAC;AAED,SAAgB,UAAU,CAAmB,KAAQ;IACnD,OAAO,KAAK,CAAC,MAAM,KAAK,UAAU,IAAI,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;AAC7D,CAAC;AAED,MAAa,eAAgB,SAAQ,KAAK;CAAG;AAA7C,0CAA6C","sourcesContent":["export type TidString = string\n\nconst TID_LENGTH = 13\nconst TID_REGEX = /^[234567abcdefghij][234567abcdefghijklmnopqrstuvwxyz]{12}$/\n\nexport function ensureValidTid<I extends string>(\n input: I,\n): asserts input is I & TidString {\n if (input.length !== TID_LENGTH) {\n throw new InvalidTidError(`TID must be ${TID_LENGTH} characters`)\n }\n // simple regex to enforce most constraints via just regex and length.\n if (!TID_REGEX.test(input)) {\n throw new InvalidTidError('TID syntax not valid (regex)')\n }\n}\n\nexport function isValidTid<I extends string>(input: I): input is I & TidString {\n return input.length === TID_LENGTH && TID_REGEX.test(input)\n}\n\nexport class InvalidTidError extends Error {}\n"]}
package/dist/uri.d.ts ADDED
@@ -0,0 +1,3 @@
1
+ export type UriString = `${string}:${string}`;
2
+ export declare function isValidUri<I extends string>(input: I): input is I & UriString;
3
+ //# sourceMappingURL=uri.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"uri.d.ts","sourceRoot":"","sources":["../src/uri.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,SAAS,GAAG,GAAG,MAAM,IAAI,MAAM,EAAE,CAAA;AAE7C,wBAAgB,UAAU,CAAC,CAAC,SAAS,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,KAAK,IAAI,CAAC,GAAG,SAAS,CAE7E"}
package/dist/uri.js ADDED
@@ -0,0 +1,7 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.isValidUri = isValidUri;
4
+ function isValidUri(input) {
5
+ return /^\w+:(?:\/\/)?[^\s/][^\s]*$/.test(input);
6
+ }
7
+ //# sourceMappingURL=uri.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"uri.js","sourceRoot":"","sources":["../src/uri.ts"],"names":[],"mappings":";;AAEA,gCAEC;AAFD,SAAgB,UAAU,CAAmB,KAAQ;IACnD,OAAO,6BAA6B,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;AAClD,CAAC","sourcesContent":["export type UriString = `${string}:${string}`\n\nexport function isValidUri<I extends string>(input: I): input is I & UriString {\n return /^\\w+:(?:\\/\\/)?[^\\s/][^\\s]*$/.test(input)\n}\n"]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atproto/syntax",
3
- "version": "0.4.1",
3
+ "version": "0.4.3",
4
4
  "license": "MIT",
5
5
  "description": "Validation for atproto identifiers and formats: DID, handle, NSID, AT URI, etc",
6
6
  "keywords": [
@@ -17,15 +17,18 @@
17
17
  },
18
18
  "main": "dist/index.js",
19
19
  "types": "dist/index.d.ts",
20
+ "dependencies": {
21
+ "tslib": "^2.8.1"
22
+ },
20
23
  "devDependencies": {
21
- "jest": "^28.1.2",
22
- "typescript": "^5.6.3"
24
+ "typescript": "^5.6.3",
25
+ "vitest": "^4.0.16"
23
26
  },
24
27
  "browser": {
25
28
  "dns/promises": false
26
29
  },
27
30
  "scripts": {
28
- "test": "jest",
31
+ "test": "vitest run",
29
32
  "build": "tsc --build tsconfig.build.json"
30
33
  }
31
34
  }
@@ -0,0 +1,33 @@
1
+ import { DidString, ensureValidDidRegex, isValidDid } from './did.js'
2
+ import {
3
+ HandleString,
4
+ InvalidHandleError,
5
+ ensureValidHandleRegex,
6
+ isValidHandle,
7
+ } from './handle.js'
8
+
9
+ export type AtIdentifierString = DidString | HandleString
10
+
11
+ export function ensureValidAtIdentifier(
12
+ input: string,
13
+ ): asserts input is AtIdentifierString {
14
+ try {
15
+ if (input.startsWith('did:')) {
16
+ ensureValidDidRegex(input)
17
+ } else {
18
+ ensureValidHandleRegex(input)
19
+ }
20
+ } catch (cause) {
21
+ throw new InvalidHandleError('Invalid DID or handle', { cause })
22
+ }
23
+ }
24
+
25
+ export function isValidAtIdentifier<I extends string>(
26
+ input: I,
27
+ ): input is I & AtIdentifierString {
28
+ if (input.startsWith('did:')) {
29
+ return isValidDid(input)
30
+ } else {
31
+ return isValidHandle(input)
32
+ }
33
+ }
package/src/aturi.ts CHANGED
@@ -1,4 +1,8 @@
1
- export * from './aturi_validation'
1
+ import { AtIdentifierString, ensureValidAtIdentifier } from './at-identifier.js'
2
+ import { AtUriString } from './aturi_validation.js'
3
+ import { ensureValidNsid } from './nsid.js'
4
+
5
+ export * from './aturi_validation.js'
2
6
 
3
7
  export const ATP_URI_REGEX =
4
8
  // proto- --did-------------- --name---------------- --path---- --query-- --hash--
@@ -8,32 +12,23 @@ const RELATIVE_REGEX = /^(\/[^?#\s]*)?(\?[^#\s]+)?(#[^\s]+)?$/i
8
12
 
9
13
  export class AtUri {
10
14
  hash: string
11
- host: string
15
+ host: AtIdentifierString
12
16
  pathname: string
13
17
  searchParams: URLSearchParams
14
18
 
15
- constructor(uri: string, base?: string) {
16
- let parsed
17
- if (base) {
18
- parsed = parse(base)
19
- if (!parsed) {
20
- throw new Error(`Invalid at uri: ${base}`)
21
- }
22
- const relativep = parseRelative(uri)
23
- if (!relativep) {
24
- throw new Error(`Invalid path: ${uri}`)
25
- }
26
- Object.assign(parsed, relativep)
27
- } else {
28
- parsed = parse(uri)
29
- if (!parsed) {
30
- throw new Error(`Invalid at uri: ${uri}`)
31
- }
32
- }
19
+ constructor(uri: string, base?: string | AtUri) {
20
+ const parsed =
21
+ base !== undefined
22
+ ? typeof base === 'string'
23
+ ? Object.assign(parse(base), parseRelative(uri))
24
+ : Object.assign({ host: base.host }, parseRelative(uri))
25
+ : parse(uri)
33
26
 
34
- this.hash = parsed.hash
27
+ ensureValidAtIdentifier(parsed.host)
28
+
29
+ this.hash = parsed.hash ?? ''
35
30
  this.host = parsed.host
36
- this.pathname = parsed.pathname
31
+ this.pathname = parsed.pathname ?? ''
37
32
  this.searchParams = parsed.searchParams
38
33
  }
39
34
 
@@ -49,7 +44,7 @@ export class AtUri {
49
44
  }
50
45
 
51
46
  get origin() {
52
- return `at://${this.host}`
47
+ return `at://${this.host}` as const
53
48
  }
54
49
 
55
50
  get hostname() {
@@ -57,6 +52,7 @@ export class AtUri {
57
52
  }
58
53
 
59
54
  set hostname(v: string) {
55
+ ensureValidAtIdentifier(v)
60
56
  this.host = v
61
57
  }
62
58
 
@@ -73,6 +69,7 @@ export class AtUri {
73
69
  }
74
70
 
75
71
  set collection(v: string) {
72
+ ensureValidNsid(v)
76
73
  const parts = this.pathname.split('/').filter(Boolean)
77
74
  parts[0] = v
78
75
  this.pathname = parts.join('/')
@@ -84,7 +81,7 @@ export class AtUri {
84
81
 
85
82
  set rkey(v: string) {
86
83
  const parts = this.pathname.split('/').filter(Boolean)
87
- if (!parts[0]) parts[0] = 'undefined'
84
+ parts[0] ||= 'undefined'
88
85
  parts[1] = v
89
86
  this.pathname = parts.join('/')
90
87
  }
@@ -93,44 +90,60 @@ export class AtUri {
93
90
  return this.toString()
94
91
  }
95
92
 
96
- toString() {
93
+ toString(): AtUriString {
97
94
  let path = this.pathname || '/'
98
95
  if (!path.startsWith('/')) {
99
96
  path = `/${path}`
100
97
  }
101
- let qs = this.searchParams.toString()
102
- if (qs && !qs.startsWith('?')) {
103
- qs = `?${qs}`
98
+ let qs = ''
99
+ if (this.searchParams.size) {
100
+ qs = `?${this.searchParams.toString()}`
104
101
  }
105
102
  let hash = this.hash
106
103
  if (hash && !hash.startsWith('#')) {
107
104
  hash = `#${hash}`
108
105
  }
109
- return `at://${this.host}${path}${qs}${hash}`
106
+ return `at://${this.host}${path}${qs}${hash}` as AtUriString
110
107
  }
111
108
  }
112
109
 
113
110
  function parse(str: string) {
114
- const match = ATP_URI_REGEX.exec(str)
115
- if (match) {
116
- return {
117
- hash: match[5] || '',
118
- host: match[2] || '',
119
- pathname: match[3] || '',
120
- searchParams: new URLSearchParams(match[4] || ''),
121
- }
111
+ const match = str.match(ATP_URI_REGEX) as null | {
112
+ 0: string
113
+ 1: string | undefined // proto
114
+ 2: string // host
115
+ 3: string | undefined // path
116
+ 4: string | undefined // query
117
+ 5: string | undefined // hash
118
+ }
119
+
120
+ if (!match) {
121
+ throw new Error(`Invalid AT uri: ${str}`)
122
+ }
123
+
124
+ return {
125
+ host: match[2],
126
+ hash: match[5],
127
+ pathname: match[3],
128
+ searchParams: new URLSearchParams(match[4]),
122
129
  }
123
- return undefined
124
130
  }
125
131
 
126
132
  function parseRelative(str: string) {
127
- const match = RELATIVE_REGEX.exec(str)
128
- if (match) {
129
- return {
130
- hash: match[3] || '',
131
- pathname: match[1] || '',
132
- searchParams: new URLSearchParams(match[2] || ''),
133
- }
133
+ const match = str.match(RELATIVE_REGEX) as null | {
134
+ 0: string
135
+ 1: string | undefined // path
136
+ 2: string | undefined // query
137
+ 3: string | undefined // hash
138
+ }
139
+
140
+ if (!match) {
141
+ throw new Error(`Invalid path: ${str}`)
142
+ }
143
+
144
+ return {
145
+ hash: match[3],
146
+ pathname: match[1],
147
+ searchParams: new URLSearchParams(match[2]),
134
148
  }
135
- return undefined
136
149
  }