@atproto/syntax 0.4.3 → 0.5.1

package/CHANGELOG.md

@@ -1,5 +1,31 @@
 # @atproto/syntax
 
+## 0.5.1
+
+### Patch Changes
+
+- [`67eb0c1`](https://github.com/bluesky-social/atproto/commit/67eb0c19ac415e762e221b2ccda9f0bcf7b3dd6f) Thanks [@matthieusieben](https://github.com/matthieusieben)! - Improve efficiency of `AtUri` `did` getter and typing of `hostname` property
+
+## 0.5.0
+
+### Minor Changes
+
+- [#4689](https://github.com/bluesky-social/atproto/pull/4689) [`f7c2610`](https://github.com/bluesky-social/atproto/commit/f7c26103a6d4e24e5bedbb6fd908be140420e0dd) Thanks [@matthieusieben](https://github.com/matthieusieben)! - Remove global `Date.toISOString()` overload and replace with more accurate, less permissive, `AtprotoDate` interface. This change prevent using any `Date` instance to generate a `DatetimeString`, since some JS dates can actually not be safely stringified to a `DatetimeString`.
+
+### Patch Changes
+
+- [#4689](https://github.com/bluesky-social/atproto/pull/4689) [`f7c2610`](https://github.com/bluesky-social/atproto/commit/f7c26103a6d4e24e5bedbb6fd908be140420e0dd) Thanks [@matthieusieben](https://github.com/matthieusieben)! - Add type safe accessors to read and write `AtUri`'s `did`, `collection` and `rkey` properties
+
+- [#4689](https://github.com/bluesky-social/atproto/pull/4689) [`f7c2610`](https://github.com/bluesky-social/atproto/commit/f7c26103a6d4e24e5bedbb6fd908be140420e0dd) Thanks [@matthieusieben](https://github.com/matthieusieben)! - Test `ensureValidDatetime`, `isValidDatetime` and `normalizeDatetime` individually, for expected failures.
+
+- [#4689](https://github.com/bluesky-social/atproto/pull/4689) [`f7c2610`](https://github.com/bluesky-social/atproto/commit/f7c26103a6d4e24e5bedbb6fd908be140420e0dd) Thanks [@matthieusieben](https://github.com/matthieusieben)! - Allow calling `DatetimeString` validation utilities with `unknown` values (instead of only `string`)
+
+- [#4689](https://github.com/bluesky-social/atproto/pull/4689) [`f7c2610`](https://github.com/bluesky-social/atproto/commit/f7c26103a6d4e24e5bedbb6fd908be140420e0dd) Thanks [@matthieusieben](https://github.com/matthieusieben)! - Preserve input type when normalizing a valid `HandleString`
+
+- [#4688](https://github.com/bluesky-social/atproto/pull/4688) [`52834ab`](https://github.com/bluesky-social/atproto/commit/52834aba182da8df3611fd9dff924e6c6a3973a7) Thanks [@matthieusieben](https://github.com/matthieusieben)! - Minor optimization in regex based NSID string validation
+
+- [#4689](https://github.com/bluesky-social/atproto/pull/4689) [`f7c2610`](https://github.com/bluesky-social/atproto/commit/f7c26103a6d4e24e5bedbb6fd908be140420e0dd) Thanks [@matthieusieben](https://github.com/matthieusieben)! - Improve type strictness of `NSID`'s `authority` and `toString()` properties
+
 ## 0.4.3
 
 ### Patch Changes

package/dist/at-identifier.d.ts

@@ -1,6 +1,53 @@
 import { DidString } from './did.js';
 import { HandleString } from './handle.js';
+/**
+ * An "at-identifier" string - either a {@link DidString} or a {@link HandleString}
+ *
+ * @example `"did:plc:1234..."`, `"did:web:example.com"` or `"alice.bsky.social"`
+ */
 export type AtIdentifierString = DidString | HandleString;
-export declare function ensureValidAtIdentifier(input: string): asserts input is AtIdentifierString;
-export declare function isValidAtIdentifier<I extends string>(input: I): input is I & AtIdentifierString;
+/**
+ * Discriminates {@link HandleString} from a valid {@link AtIdentifierString}.
+ *
+ * @return `true` if the identifier is a handle, `false` otherwise
+ */
+export declare function isHandleIdentifier(id: AtIdentifierString): id is HandleString;
+/**
+ * Discriminates {@link DidString} from a valid {@link AtIdentifierString}.
+ *
+ * @return `true` if the identifier is a DID, `false` otherwise
+ */
+export declare function isDidIdentifier(id: AtIdentifierString): id is DidString;
+/**
+ * Validates that a string is a valid {@link AtIdentifierString} format string,
+ * throwing an error if it is not.
+ *
+ * @throws InvalidHandleError if the input string does not meet the atproto 'datetime' format requirements.
+ * @see {@link AtIdentifierString}
+ */
+export declare function assertAtIdentifierString<I>(input: I): asserts input is I & AtIdentifierString;
+/**
+ * Casts a string to a {@link AtIdentifierString} if it is a valid at-identifier
+ * string, throwing an error if it is not.
+ *
+ * @throws InvalidHandleError if the input string does not meet the atproto 'at-identifier' format requirements.
+ * @see {@link AtIdentifierString}
+ */
+export declare function asAtIdentifierString<I>(input: I): I & AtIdentifierString;
+/**
+ * Type guard that checks if a value is a valid AT identifier (DID or handle).
+ *
+ * @param value - The value to check
+ * @returns `true` if the value is a valid AT identifier
+ * @see {@link AtIdentifierString}
+ */
+export declare function isAtIdentifierString<I>(input: I): input is I & AtIdentifierString;
+/**
+ * Returns the input if it is a valid {@link AtIdentifierString} format string, or
+ * `undefined` if it is not.
+ *
+ * @see {@link AtIdentifierString}
+ */
+export declare function ifAtIdentifierString<I>(input: I): undefined | (I & AtIdentifierString);
+export { assertAtIdentifierString as ensureValidAtIdentifier, isAtIdentifierString as isValidAtIdentifier, };
 //# sourceMappingURL=at-identifier.d.ts.map

package/dist/at-identifier.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"at-identifier.d.ts","sourceRoot":"","sources":["../src/at-identifier.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAmC,MAAM,UAAU,CAAA;AACrE,OAAO,EACL,YAAY,EAIb,MAAM,aAAa,CAAA;AAEpB,MAAM,MAAM,kBAAkB,GAAG,SAAS,GAAG,YAAY,CAAA;AAEzD,wBAAgB,uBAAuB,CACrC,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,KAAK,IAAI,kBAAkB,CAUrC;AAED,wBAAgB,mBAAmB,CAAC,CAAC,SAAS,MAAM,EAClD,KAAK,EAAE,CAAC,GACP,KAAK,IAAI,CAAC,GAAG,kBAAkB,CAMjC"}
+{"version":3,"file":"at-identifier.d.ts","sourceRoot":"","sources":["../src/at-identifier.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAmC,MAAM,UAAU,CAAA;AACrE,OAAO,EACL,YAAY,EAIb,MAAM,aAAa,CAAA;AAEpB;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG,SAAS,GAAG,YAAY,CAAA;AAEzD;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,EAAE,EAAE,kBAAkB,GAAG,EAAE,IAAI,YAAY,CAE7E;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,EAAE,EAAE,kBAAkB,GAAG,EAAE,IAAI,SAAS,CAEvE;AAED;;;;;;GAMG;AACH,wBAAgB,wBAAwB,CAAC,CAAC,EACxC,KAAK,EAAE,CAAC,GACP,OAAO,CAAC,KAAK,IAAI,CAAC,GAAG,kBAAkB,CAYzC;AAED;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,GAAG,kBAAkB,CAGxE;AAED;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAAC,CAAC,EACpC,KAAK,EAAE,CAAC,GACP,KAAK,IAAI,CAAC,GAAG,kBAAkB,CAQjC;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,CAAC,EACpC,KAAK,EAAE,CAAC,GACP,SAAS,GAAG,CAAC,CAAC,GAAG,kBAAkB,CAAC,CAEtC;AAGD,OAAO,EACL,wBAAwB,IAAI,uBAAuB,EACnD,oBAAoB,IAAI,mBAAmB,GAC5C,CAAA"}

package/dist/at-identifier.js

@@ -1,12 +1,44 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ensureValidAtIdentifier = ensureValidAtIdentifier;
-exports.isValidAtIdentifier = isValidAtIdentifier;
+exports.isHandleIdentifier = isHandleIdentifier;
+exports.isDidIdentifier = isDidIdentifier;
+exports.assertAtIdentifierString = assertAtIdentifierString;
+exports.ensureValidAtIdentifier = assertAtIdentifierString;
+exports.asAtIdentifierString = asAtIdentifierString;
+exports.isAtIdentifierString = isAtIdentifierString;
+exports.isValidAtIdentifier = isAtIdentifierString;
+exports.ifAtIdentifierString = ifAtIdentifierString;
 const did_js_1 = require("./did.js");
 const handle_js_1 = require("./handle.js");
-function ensureValidAtIdentifier(input) {
+/**
+ * Discriminates {@link HandleString} from a valid {@link AtIdentifierString}.
+ *
+ * @return `true` if the identifier is a handle, `false` otherwise
+ */
+function isHandleIdentifier(id) {
+    return !isDidIdentifier(id);
+}
+/**
+ * Discriminates {@link DidString} from a valid {@link AtIdentifierString}.
+ *
+ * @return `true` if the identifier is a DID, `false` otherwise
+ */
+function isDidIdentifier(id) {
+    return id.startsWith('did:');
+}
+/**
+ * Validates that a string is a valid {@link AtIdentifierString} format string,
+ * throwing an error if it is not.
+ *
+ * @throws InvalidHandleError if the input string does not meet the atproto 'datetime' format requirements.
+ * @see {@link AtIdentifierString}
+ */
+function assertAtIdentifierString(input) {
     try {
-        if (input.startsWith('did:')) {
+        if (!input || typeof input !== 'string') {
+            throw new TypeError('Identifier must be a non-empty string');
+        }
+        else if (input.startsWith('did:')) {
             (0, did_js_1.ensureValidDidRegex)(input);
         }
         else {
@@ -17,12 +49,42 @@ function ensureValidAtIdentifier(input) {
         throw new handle_js_1.InvalidHandleError('Invalid DID or handle', { cause });
     }
 }
-function isValidAtIdentifier(input) {
-    if (input.startsWith('did:')) {
+/**
+ * Casts a string to a {@link AtIdentifierString} if it is a valid at-identifier
+ * string, throwing an error if it is not.
+ *
+ * @throws InvalidHandleError if the input string does not meet the atproto 'at-identifier' format requirements.
+ * @see {@link AtIdentifierString}
+ */
+function asAtIdentifierString(input) {
+    assertAtIdentifierString(input);
+    return input;
+}
+/**
+ * Type guard that checks if a value is a valid AT identifier (DID or handle).
+ *
+ * @param value - The value to check
+ * @returns `true` if the value is a valid AT identifier
+ * @see {@link AtIdentifierString}
+ */
+function isAtIdentifierString(input) {
+    if (!input || typeof input !== 'string') {
+        return false;
+    }
+    else if (input.startsWith('did:')) {
         return (0, did_js_1.isValidDid)(input);
     }
     else {
         return (0, handle_js_1.isValidHandle)(input);
     }
 }
+/**
+ * Returns the input if it is a valid {@link AtIdentifierString} format string, or
+ * `undefined` if it is not.
+ *
+ * @see {@link AtIdentifierString}
+ */
+function ifAtIdentifierString(input) {
+    return isAtIdentifierString(input) ? input : undefined;
+}
 //# sourceMappingURL=at-identifier.js.map

package/dist/at-identifier.js.map

@@ -1 +1 @@
-{"version":3,"file":"at-identifier.js","sourceRoot":"","sources":["../src/at-identifier.ts"],"names":[],"mappings":";;AAUA,0DAYC;AAED,kDAQC;AAhCD,qCAAqE;AACrE,2CAKoB;AAIpB,SAAgB,uBAAuB,CACrC,KAAa;IAEb,IAAI,CAAC;QACH,IAAI,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;YAC7B,IAAA,4BAAmB,EAAC,KAAK,CAAC,CAAA;QAC5B,CAAC;aAAM,CAAC;YACN,IAAA,kCAAsB,EAAC,KAAK,CAAC,CAAA;QAC/B,CAAC;IACH,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,8BAAkB,CAAC,uBAAuB,EAAE,EAAE,KAAK,EAAE,CAAC,CAAA;IAClE,CAAC;AACH,CAAC;AAED,SAAgB,mBAAmB,CACjC,KAAQ;IAER,IAAI,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;QAC7B,OAAO,IAAA,mBAAU,EAAC,KAAK,CAAC,CAAA;IAC1B,CAAC;SAAM,CAAC;QACN,OAAO,IAAA,yBAAa,EAAC,KAAK,CAAC,CAAA;IAC7B,CAAC;AACH,CAAC","sourcesContent":["import { DidString, ensureValidDidRegex, isValidDid } from './did.js'\nimport {\n  HandleString,\n  InvalidHandleError,\n  ensureValidHandleRegex,\n  isValidHandle,\n} from './handle.js'\n\nexport type AtIdentifierString = DidString | HandleString\n\nexport function ensureValidAtIdentifier(\n  input: string,\n): asserts input is AtIdentifierString {\n  try {\n    if (input.startsWith('did:')) {\n      ensureValidDidRegex(input)\n    } else {\n      ensureValidHandleRegex(input)\n    }\n  } catch (cause) {\n    throw new InvalidHandleError('Invalid DID or handle', { cause })\n  }\n}\n\nexport function isValidAtIdentifier<I extends string>(\n  input: I,\n): input is I & AtIdentifierString {\n  if (input.startsWith('did:')) {\n    return isValidDid(input)\n  } else {\n    return isValidHandle(input)\n  }\n}\n"]}
+{"version":3,"file":"at-identifier.js","sourceRoot":"","sources":["../src/at-identifier.ts"],"names":[],"mappings":";;AAoBA,gDAEC;AAOD,0CAEC;AASD,4DAcC;AA+C6B,2DAAuB;AAtCrD,oDAGC;AASD,oDAUC;AAiByB,mDAAmB;AAT7C,oDAIC;AAjGD,qCAAqE;AACrE,2CAKoB;AASpB;;;;GAIG;AACH,SAAgB,kBAAkB,CAAC,EAAsB;IACvD,OAAO,CAAC,eAAe,CAAC,EAAE,CAAC,CAAA;AAC7B,CAAC;AAED;;;;GAIG;AACH,SAAgB,eAAe,CAAC,EAAsB;IACpD,OAAO,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,CAAA;AAC9B,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,wBAAwB,CACtC,KAAQ;IAER,IAAI,CAAC;QACH,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YACxC,MAAM,IAAI,SAAS,CAAC,uCAAuC,CAAC,CAAA;QAC9D,CAAC;aAAM,IAAI,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;YACpC,IAAA,4BAAmB,EAAC,KAAK,CAAC,CAAA;QAC5B,CAAC;aAAM,CAAC;YACN,IAAA,kCAAsB,EAAC,KAAK,CAAC,CAAA;QAC/B,CAAC;IACH,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,8BAAkB,CAAC,uBAAuB,EAAE,EAAE,KAAK,EAAE,CAAC,CAAA;IAClE,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,oBAAoB,CAAI,KAAQ;IAC9C,wBAAwB,CAAC,KAAK,CAAC,CAAA;IAC/B,OAAO,KAAK,CAAA;AACd,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,oBAAoB,CAClC,KAAQ;IAER,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QACxC,OAAO,KAAK,CAAA;IACd,CAAC;SAAM,IAAI,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;QACpC,OAAO,IAAA,mBAAU,EAAC,KAAK,CAAC,CAAA;IAC1B,CAAC;SAAM,CAAC;QACN,OAAO,IAAA,yBAAa,EAAC,KAAK,CAAC,CAAA;IAC7B,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,SAAgB,oBAAoB,CAClC,KAAQ;IAER,OAAO,oBAAoB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAA;AACxD,CAAC","sourcesContent":["import { DidString, ensureValidDidRegex, isValidDid } from './did.js'\nimport {\n  HandleString,\n  InvalidHandleError,\n  ensureValidHandleRegex,\n  isValidHandle,\n} from './handle.js'\n\n/**\n * An \"at-identifier\" string - either a {@link DidString} or a {@link HandleString}\n *\n * @example `\"did:plc:1234...\"`, `\"did:web:example.com\"` or `\"alice.bsky.social\"`\n */\nexport type AtIdentifierString = DidString | HandleString\n\n/**\n * Discriminates {@link HandleString} from a valid {@link AtIdentifierString}.\n *\n * @return `true` if the identifier is a handle, `false` otherwise\n */\nexport function isHandleIdentifier(id: AtIdentifierString): id is HandleString {\n  return !isDidIdentifier(id)\n}\n\n/**\n * Discriminates {@link DidString} from a valid {@link AtIdentifierString}.\n *\n * @return `true` if the identifier is a DID, `false` otherwise\n */\nexport function isDidIdentifier(id: AtIdentifierString): id is DidString {\n  return id.startsWith('did:')\n}\n\n/**\n * Validates that a string is a valid {@link AtIdentifierString} format string,\n * throwing an error if it is not.\n *\n * @throws InvalidHandleError if the input string does not meet the atproto 'datetime' format requirements.\n * @see {@link AtIdentifierString}\n */\nexport function assertAtIdentifierString<I>(\n  input: I,\n): asserts input is I & AtIdentifierString {\n  try {\n    if (!input || typeof input !== 'string') {\n      throw new TypeError('Identifier must be a non-empty string')\n    } else if (input.startsWith('did:')) {\n      ensureValidDidRegex(input)\n    } else {\n      ensureValidHandleRegex(input)\n    }\n  } catch (cause) {\n    throw new InvalidHandleError('Invalid DID or handle', { cause })\n  }\n}\n\n/**\n * Casts a string to a {@link AtIdentifierString} if it is a valid at-identifier\n * string, throwing an error if it is not.\n *\n * @throws InvalidHandleError if the input string does not meet the atproto 'at-identifier' format requirements.\n * @see {@link AtIdentifierString}\n */\nexport function asAtIdentifierString<I>(input: I): I & AtIdentifierString {\n  assertAtIdentifierString(input)\n  return input\n}\n\n/**\n * Type guard that checks if a value is a valid AT identifier (DID or handle).\n *\n * @param value - The value to check\n * @returns `true` if the value is a valid AT identifier\n * @see {@link AtIdentifierString}\n */\nexport function isAtIdentifierString<I>(\n  input: I,\n): input is I & AtIdentifierString {\n  if (!input || typeof input !== 'string') {\n    return false\n  } else if (input.startsWith('did:')) {\n    return isValidDid(input)\n  } else {\n    return isValidHandle(input)\n  }\n}\n\n/**\n * Returns the input if it is a valid {@link AtIdentifierString} format string, or\n * `undefined` if it is not.\n *\n * @see {@link AtIdentifierString}\n */\nexport function ifAtIdentifierString<I>(\n  input: I,\n): undefined | (I & AtIdentifierString) {\n  return isAtIdentifierString(input) ? input : undefined\n}\n\n// Legacy exports (should we deprecate these ?)\nexport {\n  assertAtIdentifierString as ensureValidAtIdentifier,\n  isAtIdentifierString as isValidAtIdentifier,\n}\n"]}

package/dist/aturi.d.ts

@@ -1,6 +1,10 @@
 import { AtIdentifierString } from './at-identifier.js';
 import { AtUriString } from './aturi_validation.js';
+import { DidString } from './did.js';
+import { NsidString } from './nsid.js';
+import { RecordKeyString } from './recordkey.js';
 export * from './aturi_validation.js';
+export type { AtIdentifierString, AtUriString, DidString, NsidString, RecordKeyString, };
 export declare const ATP_URI_REGEX: RegExp;
 export declare class AtUri {
     hash: string;
@@ -11,14 +15,19 @@ export declare class AtUri {
     static make(handleOrDid: string, collection?: string, rkey?: string): AtUri;
     get protocol(): string;
     get origin(): `at://did:${string}:${string}` | `at://${string}.${string}`;
-    get hostname(): string;
+    get did(): DidString;
+    get hostname(): AtIdentifierString;
     set hostname(v: string);
     get search(): string;
     set search(v: string);
     get collection(): string;
+    get collectionSafe(): NsidString;
     set collection(v: string);
+    unsafelySetCollection(v: string): void;
     get rkey(): string;
+    get rkeySafe(): RecordKeyString;
     set rkey(v: string);
+    unsafelySetRkey(v: string): void;
     get href(): AtUriString;
     toString(): AtUriString;
 }

package/dist/aturi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"aturi.d.ts","sourceRoot":"","sources":["../src/aturi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAA2B,MAAM,oBAAoB,CAAA;AAChF,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAGnD,cAAc,uBAAuB,CAAA;AAErC,eAAO,MAAM,aAAa,QAEyE,CAAA;AAInG,qBAAa,KAAK;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,kBAAkB,CAAA;IACxB,QAAQ,EAAE,MAAM,CAAA;IAChB,YAAY,EAAE,eAAe,CAAA;gBAEjB,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,KAAK;IAgB9C,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM;IAOnE,IAAI,QAAQ,WAEX;IAED,IAAI,MAAM,gEAET;IAED,IAAI,QAAQ,IAII,MAAM,CAFrB;IAED,IAAI,QAAQ,CAAC,CAAC,EAAE,MAAM,EAGrB;IAED,IAAI,MAAM,IAII,MAAM,CAFnB;IAED,IAAI,MAAM,CAAC,CAAC,EAAE,MAAM,EAEnB;IAED,IAAI,UAAU,IAII,MAAM,CAFvB;IAED,IAAI,UAAU,CAAC,CAAC,EAAE,MAAM,EAKvB;IAED,IAAI,IAAI,IAII,MAAM,CAFjB;IAED,IAAI,IAAI,CAAC,CAAC,EAAE,MAAM,EAKjB;IAED,IAAI,IAAI,gBAEP;IAED,QAAQ,IAAI,WAAW;CAexB"}
+{"version":3,"file":"aturi.d.ts","sourceRoot":"","sources":["../src/aturi.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,kBAAkB,EAGnB,MAAM,oBAAoB,CAAA;AAC3B,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACnD,OAAO,EAAE,SAAS,EAAmB,MAAM,UAAU,CAAA;AACrD,OAAO,EAAE,UAAU,EAAmB,MAAM,WAAW,CAAA;AACvD,OAAO,EAAE,eAAe,EAAwB,MAAM,gBAAgB,CAAA;AAEtE,cAAc,uBAAuB,CAAA;AAGrC,YAAY,EACV,kBAAkB,EAClB,WAAW,EACX,SAAS,EACT,UAAU,EACV,eAAe,GAChB,CAAA;AAED,eAAO,MAAM,aAAa,QAEyE,CAAA;AAInG,qBAAa,KAAK;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,kBAAkB,CAAA;IACxB,QAAQ,EAAE,MAAM,CAAA;IAChB,YAAY,EAAE,eAAe,CAAA;gBAEjB,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,KAAK;IAgB9C,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM;IAOnE,IAAI,QAAQ,WAEX;IAED,IAAI,MAAM,gEAET;IAED,IAAI,GAAG,IAAI,SAAS,CAInB;IAED,IAAI,QAAQ,IAAI,kBAAkB,CAEjC;IAED,IAAI,QAAQ,CAAC,CAAC,EAAE,MAAM,EAGrB;IAED,IAAI,MAAM,IAII,MAAM,CAFnB;IAED,IAAI,MAAM,CAAC,CAAC,EAAE,MAAM,EAEnB;IAED,IAAI,UAAU,IAUI,MAAM,CARvB;IAED,IAAI,cAAc,IAAI,UAAU,CAI/B;IAED,IAAI,UAAU,CAAC,CAAC,EAAE,MAAM,EAGvB;IAED,qBAAqB,CAAC,CAAC,EAAE,MAAM;IAM/B,IAAI,IAAI,IAUI,MAAM,CARjB;IAED,IAAI,QAAQ,IAAI,eAAe,CAI9B;IAED,IAAI,IAAI,CAAC,CAAC,EAAE,MAAM,EAGjB;IAED,eAAe,CAAC,CAAC,EAAE,MAAM;IAOzB,IAAI,IAAI,gBAEP;IAED,QAAQ,IAAI,WAAW;CAexB"}

package/dist/aturi.js

@@ -3,7 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.AtUri = exports.ATP_URI_REGEX = void 0;
 const tslib_1 = require("tslib");
 const at_identifier_js_1 = require("./at-identifier.js");
+const did_js_1 = require("./did.js");
 const nsid_js_1 = require("./nsid.js");
+const recordkey_js_1 = require("./recordkey.js");
 tslib_1.__exportStar(require("./aturi_validation.js"), exports);
 exports.ATP_URI_REGEX = 
 // proto-    --did--------------   --name----------------   --path----   --query--   --hash--
@@ -41,6 +43,12 @@ class AtUri {
     get origin() {
         return `at://${this.host}`;
     }
+    get did() {
+        const { host } = this;
+        if ((0, at_identifier_js_1.isDidIdentifier)(host))
+            return host;
+        throw new did_js_1.InvalidDidError(`AtUri "${this}" does not have a DID hostname`);
+    }
     get hostname() {
         return this.host;
     }
@@ -57,8 +65,16 @@ class AtUri {
     get collection() {
         return this.pathname.split('/').filter(Boolean)[0] || '';
     }
+    get collectionSafe() {
+        const { collection } = this;
+        (0, nsid_js_1.ensureValidNsid)(collection);
+        return collection;
+    }
     set collection(v) {
         (0, nsid_js_1.ensureValidNsid)(v);
+        this.unsafelySetCollection(v);
+    }
+    unsafelySetCollection(v) {
         const parts = this.pathname.split('/').filter(Boolean);
         parts[0] = v;
         this.pathname = parts.join('/');
@@ -66,7 +82,16 @@ class AtUri {
     get rkey() {
         return this.pathname.split('/').filter(Boolean)[1] || '';
     }
+    get rkeySafe() {
+        const { rkey } = this;
+        (0, recordkey_js_1.ensureValidRecordKey)(rkey);
+        return rkey;
+    }
     set rkey(v) {
+        (0, recordkey_js_1.ensureValidRecordKey)(v);
+        this.unsafelySetRkey(v);
+    }
+    unsafelySetRkey(v) {
         const parts = this.pathname.split('/').filter(Boolean);
         parts[0] ||= 'undefined';
         parts[1] = v;

package/dist/aturi.js.map

@@ -1 +1 @@
-{"version":3,"file":"aturi.js","sourceRoot":"","sources":["../src/aturi.ts"],"names":[],"mappings":";;;;AAAA,yDAAgF;AAEhF,uCAA2C;AAE3C,gEAAqC;AAExB,QAAA,aAAa;AACxB,6FAA6F;AAC7F,iGAAiG,CAAA;AACnG,0DAA0D;AAC1D,MAAM,cAAc,GAAG,wCAAwC,CAAA;AAE/D,MAAa,KAAK;IAChB,IAAI,CAAQ;IACZ,IAAI,CAAoB;IACxB,QAAQ,CAAQ;IAChB,YAAY,CAAiB;IAE7B,YAAY,GAAW,EAAE,IAAqB;QAC5C,MAAM,MAAM,GACV,IAAI,KAAK,SAAS;YAChB,CAAC,CAAC,OAAO,IAAI,KAAK,QAAQ;gBACxB,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,aAAa,CAAC,GAAG,CAAC,CAAC;gBAChD,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,EAAE,aAAa,CAAC,GAAG,CAAC,CAAC;YAC1D,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QAEhB,IAAA,0CAAuB,EAAC,MAAM,CAAC,IAAI,CAAC,CAAA;QAEpC,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,IAAI,EAAE,CAAA;QAC7B,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAA;QACvB,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,IAAI,EAAE,CAAA;QACrC,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,CAAA;IACzC,CAAC;IAED,MAAM,CAAC,IAAI,CAAC,WAAmB,EAAE,UAAmB,EAAE,IAAa;QACjE,IAAI,GAAG,GAAG,WAAW,CAAA;QACrB,IAAI,UAAU;YAAE,GAAG,IAAI,GAAG,GAAG,UAAU,CAAA;QACvC,IAAI,IAAI;YAAE,GAAG,IAAI,GAAG,GAAG,IAAI,CAAA;QAC3B,OAAO,IAAI,KAAK,CAAC,GAAG,CAAC,CAAA;IACvB,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,KAAK,CAAA;IACd,CAAC;IAED,IAAI,MAAM;QACR,OAAO,QAAQ,IAAI,CAAC,IAAI,EAAW,CAAA;IACrC,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,IAAI,CAAA;IAClB,CAAC;IAED,IAAI,QAAQ,CAAC,CAAS;QACpB,IAAA,0CAAuB,EAAC,CAAC,CAAC,CAAA;QAC1B,IAAI,CAAC,IAAI,GAAG,CAAC,CAAA;IACf,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAA;IACrC,CAAC;IAED,IAAI,MAAM,CAAC,CAAS;QAClB,IAAI,CAAC,YAAY,GAAG,IAAI,eAAe,CAAC,CAAC,CAAC,CAAA;IAC5C,CAAC;IAED,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAA;IAC1D,CAAC;IAED,IAAI,UAAU,CAAC,CAAS;QACtB,IAAA,yBAAe,EAAC,CAAC,CAAC,CAAA;QAClB,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;QACtD,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;QACZ,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IACjC,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAA;IAC1D,CAAC;IAED,IAAI,IAAI,CAAC,CAAS;QAChB,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;QACtD,KAAK,CAAC,CAAC,CAAC,KAAK,WAAW,CAAA;QACxB,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;QACZ,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IACjC,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAA;IACxB,CAAC;IAED,QAAQ;QACN,IAAI,IAAI,GAAG,IAAI,CAAC,QAAQ,IAAI,GAAG,CAAA;QAC/B,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YAC1B,IAAI,GAAG,IAAI,IAAI,EAAE,CAAA;QACnB,CAAC;QACD,IAAI,EAAE,GAAG,EAAE,CAAA;QACX,IAAI,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC;YAC3B,EAAE,GAAG,IAAI,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,EAAE,CAAA;QACzC,CAAC;QACD,IAAI,IAAI,GAAG,IAAI,CAAC,IAAI,CAAA;QACpB,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YAClC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAA;QACnB,CAAC;QACD,OAAO,QAAQ,IAAI,CAAC,IAAI,GAAG,IAAI,GAAG,EAAE,GAAG,IAAI,EAAiB,CAAA;IAC9D,CAAC;CACF;AA/FD,sBA+FC;AAED,SAAS,KAAK,CAAC,GAAW;IACxB,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,qBAAa,CAOpC,CAAA;IAED,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,MAAM,IAAI,KAAK,CAAC,mBAAmB,GAAG,EAAE,CAAC,CAAA;IAC3C,CAAC;IAED,OAAO;QACL,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;QACd,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;QACd,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC;QAClB,YAAY,EAAE,IAAI,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;KAC5C,CAAA;AACH,CAAC;AAED,SAAS,aAAa,CAAC,GAAW;IAChC,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,cAAc,CAKrC,CAAA;IAED,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,MAAM,IAAI,KAAK,CAAC,iBAAiB,GAAG,EAAE,CAAC,CAAA;IACzC,CAAC;IAED,OAAO;QACL,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;QACd,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC;QAClB,YAAY,EAAE,IAAI,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;KAC5C,CAAA;AACH,CAAC","sourcesContent":["import { AtIdentifierString, ensureValidAtIdentifier } from './at-identifier.js'\nimport { AtUriString } from './aturi_validation.js'\nimport { ensureValidNsid } from './nsid.js'\n\nexport * from './aturi_validation.js'\n\nexport const ATP_URI_REGEX =\n  // proto-    --did--------------   --name----------------   --path----   --query--   --hash--\n  /^(at:\\/\\/)?((?:did:[a-z0-9:%-]+)|(?:[a-z0-9][a-z0-9.:-]*))(\\/[^?#\\s]*)?(\\?[^#\\s]+)?(#[^\\s]+)?$/i\n//                       --path-----   --query--  --hash--\nconst RELATIVE_REGEX = /^(\\/[^?#\\s]*)?(\\?[^#\\s]+)?(#[^\\s]+)?$/i\n\nexport class AtUri {\n  hash: string\n  host: AtIdentifierString\n  pathname: string\n  searchParams: URLSearchParams\n\n  constructor(uri: string, base?: string | AtUri) {\n    const parsed =\n      base !== undefined\n        ? typeof base === 'string'\n          ? Object.assign(parse(base), parseRelative(uri))\n          : Object.assign({ host: base.host }, parseRelative(uri))\n        : parse(uri)\n\n    ensureValidAtIdentifier(parsed.host)\n\n    this.hash = parsed.hash ?? ''\n    this.host = parsed.host\n    this.pathname = parsed.pathname ?? ''\n    this.searchParams = parsed.searchParams\n  }\n\n  static make(handleOrDid: string, collection?: string, rkey?: string) {\n    let str = handleOrDid\n    if (collection) str += '/' + collection\n    if (rkey) str += '/' + rkey\n    return new AtUri(str)\n  }\n\n  get protocol() {\n    return 'at:'\n  }\n\n  get origin() {\n    return `at://${this.host}` as const\n  }\n\n  get hostname() {\n    return this.host\n  }\n\n  set hostname(v: string) {\n    ensureValidAtIdentifier(v)\n    this.host = v\n  }\n\n  get search() {\n    return this.searchParams.toString()\n  }\n\n  set search(v: string) {\n    this.searchParams = new URLSearchParams(v)\n  }\n\n  get collection() {\n    return this.pathname.split('/').filter(Boolean)[0] || ''\n  }\n\n  set collection(v: string) {\n    ensureValidNsid(v)\n    const parts = this.pathname.split('/').filter(Boolean)\n    parts[0] = v\n    this.pathname = parts.join('/')\n  }\n\n  get rkey() {\n    return this.pathname.split('/').filter(Boolean)[1] || ''\n  }\n\n  set rkey(v: string) {\n    const parts = this.pathname.split('/').filter(Boolean)\n    parts[0] ||= 'undefined'\n    parts[1] = v\n    this.pathname = parts.join('/')\n  }\n\n  get href() {\n    return this.toString()\n  }\n\n  toString(): AtUriString {\n    let path = this.pathname || '/'\n    if (!path.startsWith('/')) {\n      path = `/${path}`\n    }\n    let qs = ''\n    if (this.searchParams.size) {\n      qs = `?${this.searchParams.toString()}`\n    }\n    let hash = this.hash\n    if (hash && !hash.startsWith('#')) {\n      hash = `#${hash}`\n    }\n    return `at://${this.host}${path}${qs}${hash}` as AtUriString\n  }\n}\n\nfunction parse(str: string) {\n  const match = str.match(ATP_URI_REGEX) as null | {\n    0: string\n    1: string | undefined // proto\n    2: string // host\n    3: string | undefined // path\n    4: string | undefined // query\n    5: string | undefined // hash\n  }\n\n  if (!match) {\n    throw new Error(`Invalid AT uri: ${str}`)\n  }\n\n  return {\n    host: match[2],\n    hash: match[5],\n    pathname: match[3],\n    searchParams: new URLSearchParams(match[4]),\n  }\n}\n\nfunction parseRelative(str: string) {\n  const match = str.match(RELATIVE_REGEX) as null | {\n    0: string\n    1: string | undefined // path\n    2: string | undefined // query\n    3: string | undefined // hash\n  }\n\n  if (!match) {\n    throw new Error(`Invalid path: ${str}`)\n  }\n\n  return {\n    hash: match[3],\n    pathname: match[1],\n    searchParams: new URLSearchParams(match[2]),\n  }\n}\n"]}
+{"version":3,"file":"aturi.js","sourceRoot":"","sources":["../src/aturi.ts"],"names":[],"mappings":";;;;AAAA,yDAI2B;AAE3B,qCAAqD;AACrD,uCAAuD;AACvD,iDAAsE;AAEtE,gEAAqC;AAWxB,QAAA,aAAa;AACxB,6FAA6F;AAC7F,iGAAiG,CAAA;AACnG,0DAA0D;AAC1D,MAAM,cAAc,GAAG,wCAAwC,CAAA;AAE/D,MAAa,KAAK;IAChB,IAAI,CAAQ;IACZ,IAAI,CAAoB;IACxB,QAAQ,CAAQ;IAChB,YAAY,CAAiB;IAE7B,YAAY,GAAW,EAAE,IAAqB;QAC5C,MAAM,MAAM,GACV,IAAI,KAAK,SAAS;YAChB,CAAC,CAAC,OAAO,IAAI,KAAK,QAAQ;gBACxB,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,aAAa,CAAC,GAAG,CAAC,CAAC;gBAChD,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,EAAE,aAAa,CAAC,GAAG,CAAC,CAAC;YAC1D,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QAEhB,IAAA,0CAAuB,EAAC,MAAM,CAAC,IAAI,CAAC,CAAA;QAEpC,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,IAAI,EAAE,CAAA;QAC7B,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAA;QACvB,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,IAAI,EAAE,CAAA;QACrC,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,CAAA;IACzC,CAAC;IAED,MAAM,CAAC,IAAI,CAAC,WAAmB,EAAE,UAAmB,EAAE,IAAa;QACjE,IAAI,GAAG,GAAG,WAAW,CAAA;QACrB,IAAI,UAAU;YAAE,GAAG,IAAI,GAAG,GAAG,UAAU,CAAA;QACvC,IAAI,IAAI;YAAE,GAAG,IAAI,GAAG,GAAG,IAAI,CAAA;QAC3B,OAAO,IAAI,KAAK,CAAC,GAAG,CAAC,CAAA;IACvB,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,KAAK,CAAA;IACd,CAAC;IAED,IAAI,MAAM;QACR,OAAO,QAAQ,IAAI,CAAC,IAAI,EAAW,CAAA;IACrC,CAAC;IAED,IAAI,GAAG;QACL,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAA;QACrB,IAAI,IAAA,kCAAe,EAAC,IAAI,CAAC;YAAE,OAAO,IAAI,CAAA;QACtC,MAAM,IAAI,wBAAe,CAAC,UAAU,IAAI,gCAAgC,CAAC,CAAA;IAC3E,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,IAAI,CAAA;IAClB,CAAC;IAED,IAAI,QAAQ,CAAC,CAAS;QACpB,IAAA,0CAAuB,EAAC,CAAC,CAAC,CAAA;QAC1B,IAAI,CAAC,IAAI,GAAG,CAAC,CAAA;IACf,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAA;IACrC,CAAC;IAED,IAAI,MAAM,CAAC,CAAS;QAClB,IAAI,CAAC,YAAY,GAAG,IAAI,eAAe,CAAC,CAAC,CAAC,CAAA;IAC5C,CAAC;IAED,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAA;IAC1D,CAAC;IAED,IAAI,cAAc;QAChB,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,CAAA;QAC3B,IAAA,yBAAe,EAAC,UAAU,CAAC,CAAA;QAC3B,OAAO,UAAU,CAAA;IACnB,CAAC;IAED,IAAI,UAAU,CAAC,CAAS;QACtB,IAAA,yBAAe,EAAC,CAAC,CAAC,CAAA;QAClB,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;IAC/B,CAAC;IAED,qBAAqB,CAAC,CAAS;QAC7B,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;QACtD,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;QACZ,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IACjC,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAA;IAC1D,CAAC;IAED,IAAI,QAAQ;QACV,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAA;QACrB,IAAA,mCAAoB,EAAC,IAAI,CAAC,CAAA;QAC1B,OAAO,IAAI,CAAA;IACb,CAAC;IAED,IAAI,IAAI,CAAC,CAAS;QAChB,IAAA,mCAAoB,EAAC,CAAC,CAAC,CAAA;QACvB,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAA;IACzB,CAAC;IAED,eAAe,CAAC,CAAS;QACvB,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;QACtD,KAAK,CAAC,CAAC,CAAC,KAAK,WAAW,CAAA;QACxB,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;QACZ,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IACjC,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAA;IACxB,CAAC;IAED,QAAQ;QACN,IAAI,IAAI,GAAG,IAAI,CAAC,QAAQ,IAAI,GAAG,CAAA;QAC/B,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YAC1B,IAAI,GAAG,IAAI,IAAI,EAAE,CAAA;QACnB,CAAC;QACD,IAAI,EAAE,GAAG,EAAE,CAAA;QACX,IAAI,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC;YAC3B,EAAE,GAAG,IAAI,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,EAAE,CAAA;QACzC,CAAC;QACD,IAAI,IAAI,GAAG,IAAI,CAAC,IAAI,CAAA;QACpB,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YAClC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAA;QACnB,CAAC;QACD,OAAO,QAAQ,IAAI,CAAC,IAAI,GAAG,IAAI,GAAG,EAAE,GAAG,IAAI,EAAiB,CAAA;IAC9D,CAAC;CACF;AA1HD,sBA0HC;AAED,SAAS,KAAK,CAAC,GAAW;IACxB,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,qBAAa,CAOpC,CAAA;IAED,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,MAAM,IAAI,KAAK,CAAC,mBAAmB,GAAG,EAAE,CAAC,CAAA;IAC3C,CAAC;IAED,OAAO;QACL,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;QACd,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;QACd,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC;QAClB,YAAY,EAAE,IAAI,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;KAC5C,CAAA;AACH,CAAC;AAED,SAAS,aAAa,CAAC,GAAW;IAChC,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,cAAc,CAKrC,CAAA;IAED,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,MAAM,IAAI,KAAK,CAAC,iBAAiB,GAAG,EAAE,CAAC,CAAA;IACzC,CAAC;IAED,OAAO;QACL,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;QACd,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC;QAClB,YAAY,EAAE,IAAI,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;KAC5C,CAAA;AACH,CAAC","sourcesContent":["import {\n  AtIdentifierString,\n  ensureValidAtIdentifier,\n  isDidIdentifier,\n} from './at-identifier.js'\nimport { AtUriString } from './aturi_validation.js'\nimport { DidString, InvalidDidError } from './did.js'\nimport { NsidString, ensureValidNsid } from './nsid.js'\nimport { RecordKeyString, ensureValidRecordKey } from './recordkey.js'\n\nexport * from './aturi_validation.js'\n\n// Re-export types used in public interface\nexport type {\n  AtIdentifierString,\n  AtUriString,\n  DidString,\n  NsidString,\n  RecordKeyString,\n}\n\nexport const ATP_URI_REGEX =\n  // proto-    --did--------------   --name----------------   --path----   --query--   --hash--\n  /^(at:\\/\\/)?((?:did:[a-z0-9:%-]+)|(?:[a-z0-9][a-z0-9.:-]*))(\\/[^?#\\s]*)?(\\?[^#\\s]+)?(#[^\\s]+)?$/i\n//                       --path-----   --query--  --hash--\nconst RELATIVE_REGEX = /^(\\/[^?#\\s]*)?(\\?[^#\\s]+)?(#[^\\s]+)?$/i\n\nexport class AtUri {\n  hash: string\n  host: AtIdentifierString\n  pathname: string\n  searchParams: URLSearchParams\n\n  constructor(uri: string, base?: string | AtUri) {\n    const parsed =\n      base !== undefined\n        ? typeof base === 'string'\n          ? Object.assign(parse(base), parseRelative(uri))\n          : Object.assign({ host: base.host }, parseRelative(uri))\n        : parse(uri)\n\n    ensureValidAtIdentifier(parsed.host)\n\n    this.hash = parsed.hash ?? ''\n    this.host = parsed.host\n    this.pathname = parsed.pathname ?? ''\n    this.searchParams = parsed.searchParams\n  }\n\n  static make(handleOrDid: string, collection?: string, rkey?: string) {\n    let str = handleOrDid\n    if (collection) str += '/' + collection\n    if (rkey) str += '/' + rkey\n    return new AtUri(str)\n  }\n\n  get protocol() {\n    return 'at:'\n  }\n\n  get origin() {\n    return `at://${this.host}` as const\n  }\n\n  get did(): DidString {\n    const { host } = this\n    if (isDidIdentifier(host)) return host\n    throw new InvalidDidError(`AtUri \"${this}\" does not have a DID hostname`)\n  }\n\n  get hostname(): AtIdentifierString {\n    return this.host\n  }\n\n  set hostname(v: string) {\n    ensureValidAtIdentifier(v)\n    this.host = v\n  }\n\n  get search() {\n    return this.searchParams.toString()\n  }\n\n  set search(v: string) {\n    this.searchParams = new URLSearchParams(v)\n  }\n\n  get collection() {\n    return this.pathname.split('/').filter(Boolean)[0] || ''\n  }\n\n  get collectionSafe(): NsidString {\n    const { collection } = this\n    ensureValidNsid(collection)\n    return collection\n  }\n\n  set collection(v: string) {\n    ensureValidNsid(v)\n    this.unsafelySetCollection(v)\n  }\n\n  unsafelySetCollection(v: string) {\n    const parts = this.pathname.split('/').filter(Boolean)\n    parts[0] = v\n    this.pathname = parts.join('/')\n  }\n\n  get rkey() {\n    return this.pathname.split('/').filter(Boolean)[1] || ''\n  }\n\n  get rkeySafe(): RecordKeyString {\n    const { rkey } = this\n    ensureValidRecordKey(rkey)\n    return rkey\n  }\n\n  set rkey(v: string) {\n    ensureValidRecordKey(v)\n    this.unsafelySetRkey(v)\n  }\n\n  unsafelySetRkey(v: string) {\n    const parts = this.pathname.split('/').filter(Boolean)\n    parts[0] ||= 'undefined'\n    parts[1] = v\n    this.pathname = parts.join('/')\n  }\n\n  get href() {\n    return this.toString()\n  }\n\n  toString(): AtUriString {\n    let path = this.pathname || '/'\n    if (!path.startsWith('/')) {\n      path = `/${path}`\n    }\n    let qs = ''\n    if (this.searchParams.size) {\n      qs = `?${this.searchParams.toString()}`\n    }\n    let hash = this.hash\n    if (hash && !hash.startsWith('#')) {\n      hash = `#${hash}`\n    }\n    return `at://${this.host}${path}${qs}${hash}` as AtUriString\n  }\n}\n\nfunction parse(str: string) {\n  const match = str.match(ATP_URI_REGEX) as null | {\n    0: string\n    1: string | undefined // proto\n    2: string // host\n    3: string | undefined // path\n    4: string | undefined // query\n    5: string | undefined // hash\n  }\n\n  if (!match) {\n    throw new Error(`Invalid AT uri: ${str}`)\n  }\n\n  return {\n    host: match[2],\n    hash: match[5],\n    pathname: match[3],\n    searchParams: new URLSearchParams(match[4]),\n  }\n}\n\nfunction parseRelative(str: string) {\n  const match = str.match(RELATIVE_REGEX) as null | {\n    0: string\n    1: string | undefined // path\n    2: string | undefined // query\n    3: string | undefined // hash\n  }\n\n  if (!match) {\n    throw new Error(`Invalid path: ${str}`)\n  }\n\n  return {\n    hash: match[3],\n    pathname: match[1],\n    searchParams: new URLSearchParams(match[2]),\n  }\n}\n"]}

package/dist/datetime.d.ts

@@ -1,14 +1,131 @@
-/** An ISO 8601 formatted datetime string (YYYY-MM-DDTHH:mm:ss.sssZ) */
-export type DatetimeString = `${string}-${string}-${string}T${string}:${string}:${string}${'Z' | `+${string}` | `-${string}`}`;
-declare global {
-    interface Date {
-        toISOString(): `${string}-${string}-${string}T${string}:${string}:${string}Z`;
-    }
-}
-export declare function ensureValidDatetime<I extends string>(input: I): asserts input is I & DatetimeString;
-export declare function isValidDatetime<I extends string>(input: I): input is I & DatetimeString;
-export declare function normalizeDatetime(dtStr: string): DatetimeString;
-export declare const normalizeDatetimeAlways: (dtStr: string) => DatetimeString;
+/**
+ * Indicates a date or string is not a valid representation of a datetime
+ * according to the atproto
+ * {@link https://atproto.com/specs/lexicon#datetime specification}.
+ */
 export declare class InvalidDatetimeError extends Error {
 }
+/**
+ * A subset of {@link DatetimeString} that represent valid datetime strings with
+ * the format: `YYYY-MM-DDTHH:mm:ss.sssZ`, as returned by `Date.toISOString()
+ * for dates between the years 0000 and 9999.
+ *
+ * @see {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString}
+ */
+export type ISODatetimeString = `${string}-${string}-${string}T${string}:${string}:${string}.${string}Z`;
+/**
+ * Represents a {@link Date} that can be safely stringified into a valid atproto
+ * {@link DatetimeString} using the {@link Date.toISOString toISOString()}
+ * method.
+ */
+export interface AtprotoDate extends Date {
+    toISOString(): ISODatetimeString;
+}
+/**
+ * @see {@link AtprotoDate}
+ */
+export declare function assertAtprotoDate(date: Date): asserts date is AtprotoDate;
+/**
+ * @see {@link AtprotoDate}
+ */
+export declare function asAtprotoDate(date: Date): AtprotoDate;
+/**
+ * @see {@link AtprotoDate}
+ */
+export declare function isAtprotoDate(date: Date): date is AtprotoDate;
+/**
+ * @see {@link AtprotoDate}
+ */
+export declare function ifAtprotoDate(date: Date): AtprotoDate | undefined;
+/**
+ * Datetime strings in atproto data structures and API calls should meet the
+ * {@link https://ijmacd.github.io/rfc3339-iso8601/ intersecting} requirements
+ * of the RFC 3339, ISO 8601, and WHATWG HTML datetime standards.
+ *
+ * @note This literal template type is not accurate enough to ensure that a
+ * string is a valid atproto datetime. The {@link DatetimeString} validation
+ * functions ({@link assertDatetimeString}, {@link isDatetimeString}, etc)
+ * should be used to validate that a string meets the atproto datetime
+ * requirements, and the {@link toDatetimeString} function should be used to
+ * convert a {@link Date} object into a valid {@link DatetimeString} string.
+ *
+ * @example "2024-01-15T12:30:00Z"
+ * @example "2024-01-15T12:30:00.000Z"
+ * @example "2024-01-15T12:30:00+00:00"
+ * @example "2024-01-15T11:30:00-01:00"
+ * @see {@link https://atproto.com/specs/lexicon#datetime atproto Lexicon datetime format}
+ * @see {@link https://www.rfc-editor.org/rfc/rfc3339 RFC 3339}
+ * @see {@link https://www.iso.org/iso-8601-date-and-time-format.html ISO 8601}
+ */
+export type DatetimeString = `${string}-${string}-${string}T${string}:${string}:${string}Z` | `${string}-${string}-${string}T${string}:${string}:${string}${'+' | '-'}${string}:${string}`;
+/**
+ * Validates that a string is a valid {@link DatetimeString} format string,
+ * throwing an error if it is not.
+ *
+ * @throws InvalidDatetimeError if the input string does not meet the atproto 'datetime' format requirements.
+ * @see {@link DatetimeString}
+ */
+export declare function assertDatetimeString<I>(input: I): asserts input is I & DatetimeString;
+/**
+ * Casts a string to a {@link DatetimeString} if it is a valid datetime format
+ * string, throwing an error if it is not.
+ *
+ * @throws InvalidDatetimeError if the input string does not meet the atproto 'datetime' format requirements.
+ * @see {@link DatetimeString}
+ */
+export declare function asDatetimeString<I>(input: I): I & DatetimeString;
+/**
+ * Checks if a string is a valid {@link DatetimeString} format string.
+ *
+ * @see {@link DatetimeString}
+ */
+export declare function isDatetimeString<I>(input: I): input is I & DatetimeString;
+/**
+ * Returns the input if it is a valid {@link DatetimeString} format string, or
+ * `undefined` if it is not.
+ *
+ * @see {@link DatetimeString}
+ */
+export declare function ifDatetimeString<I>(input: I): undefined | (I & DatetimeString);
+/**
+ * Returns the current date and time as a {@link DatetimeString}.
+ *
+ * @see {@link DatetimeString}
+ */
+export declare function currentDatetimeString(): DatetimeString;
+/**
+ * Converts any {@link Date} into a {@link DatetimeString} if possible, throwing
+ * an error if the date is not a valid atproto datetime.
+ *
+ * This is short-hand for `asAtprotoDate(date).toISOString()`.
+ *
+ * @throws InvalidDatetimeError if the input date is not a valid atproto datetime (eg, it is too far in the future or past, or it normalizes to a negative year).
+ * @see {@link DatetimeString}
+ */
+export declare function toDatetimeString(date: Date): DatetimeString;
+/**
+ * Takes a flexible datetime string and normalizes its representation.
+ *
+ * This function will work with any valid value that can be parsed as a date. It
+ * *additionally* is more flexible about accepting datetimes that are missing
+ * timezone information, and normalizing them to a valid atproto datetime.
+ *
+ * One use-case is a consistent, sortable string. Another is to work with older
+ * invalid createdAt datetimes.
+ *
+ * @returns ISODatetimeString - a valid atproto datetime with millisecond precision (3 sub-second digits) and UTC timezone with trailing 'Z' syntax.
+ * @throws InvalidDatetimeError - if the input string could not be parsed as a datetime, even with permissive parsing.
+ */
+export declare function normalizeDatetime(dtStr: string): ISODatetimeString;
+/**
+ * Variant of {@link normalizeDatetime} which always returns a valid datetime
+ * string.
+ *
+ * If a {@link InvalidDatetimeError} is encountered, returns the UNIX epoch time
+ * as a UTC datetime (`1970-01-01T00:00:00.000Z`).
+ *
+ * @see {@link normalizeDatetime}
+ */
+export declare function normalizeDatetimeAlways(dtStr: string): ISODatetimeString;
+export { assertDatetimeString as ensureValidDatetime, isDatetimeString as isValidDatetime, };
 //# sourceMappingURL=datetime.d.ts.map

package/dist/datetime.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"datetime.d.ts","sourceRoot":"","sources":["../src/datetime.ts"],"names":[],"mappings":"AAAA,uEAAuE;AACvE,MAAM,MAAM,cAAc,GACxB,GAAG,MAAM,IAAI,MAAM,IAAI,MAAM,IAAI,MAAM,IAAI,MAAM,IAAI,MAAM,GAAG,GAAG,GAAG,IAAI,MAAM,EAAE,GAAG,IAAI,MAAM,EAAE,EAAE,CAAA;AAGnG,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,IAAI;QACZ,WAAW,IAAI,GAAG,MAAM,IAAI,MAAM,IAAI,MAAM,IAAI,MAAM,IAAI,MAAM,IAAI,MAAM,GAAG,CAAA;KAC9E;CACF;AAKD,wBAAgB,mBAAmB,CAAC,CAAC,SAAS,MAAM,EAClD,KAAK,EAAE,CAAC,GACP,OAAO,CAAC,KAAK,IAAI,CAAC,GAAG,cAAc,CA4BrC;AAID,wBAAgB,eAAe,CAAC,CAAC,SAAS,MAAM,EAC9C,KAAK,EAAE,CAAC,GACP,KAAK,IAAI,CAAC,GAAG,cAAc,CAQ7B;AAYD,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,cAAc,CAkC/D;AAMD,eAAO,MAAM,uBAAuB,GAAI,OAAO,MAAM,KAAG,cASvD,CAAA;AAID,qBAAa,oBAAqB,SAAQ,KAAK;CAAG"}
+{"version":3,"file":"datetime.d.ts","sourceRoot":"","sources":["../src/datetime.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,qBAAa,oBAAqB,SAAQ,KAAK;CAAG;AAElD;;;;;;GAMG;AACH,MAAM,MAAM,iBAAiB,GAE3B,GAAG,MAAM,IAAI,MAAM,IAAI,MAAM,IAAI,MAAM,IAAI,MAAM,IAAI,MAAM,IAAI,MAAM,GAAG,CAAA;AAE1E;;;;GAIG;AACH,MAAM,WAAW,WAAY,SAAQ,IAAI;IACvC,WAAW,IAAI,iBAAiB,CAAA;CACjC;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,WAAW,CAKzE;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,IAAI,GAAG,WAAW,CAGrD;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,IAAI,WAAW,CAE7D;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,IAAI,GAAG,WAAW,GAAG,SAAS,CAEjE;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,MAAM,cAAc,GAEtB,GAAG,MAAM,IAAI,MAAM,IAAI,MAAM,IAAI,MAAM,IAAI,MAAM,IAAI,MAAM,GAAG,GAC9D,GAAG,MAAM,IAAI,MAAM,IAAI,MAAM,IAAI,MAAM,IAAI,MAAM,IAAI,MAAM,GAAG,GAAG,GAAG,GAAG,GAAG,MAAM,IAAI,MAAM,EAAE,CAAA;AAEhG;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAAC,CAAC,EACpC,KAAK,EAAE,CAAC,GACP,OAAO,CAAC,KAAK,IAAI,CAAC,GAAG,cAAc,CAKrC;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,GAAG,cAAc,CAGhE;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,KAAK,IAAI,CAAC,GAAG,cAAc,CAEzE;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,EAChC,KAAK,EAAE,CAAC,GACP,SAAS,GAAG,CAAC,CAAC,GAAG,cAAc,CAAC,CAElC;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,IAAI,cAAc,CAEtD;AAED;;;;;;;;GAQG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,IAAI,GAAG,cAAc,CAE3D;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,iBAAiB,CAkBlE;AAED;;;;;;;;GAQG;AACH,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,MAAM,GAAG,iBAAiB,CAMxE;AAGD,OAAO,EACL,oBAAoB,IAAI,mBAAmB,EAC3C,gBAAgB,IAAI,eAAe,GACpC,CAAA"}