@atproto/syntax 0.1.0

package/src/nsid.ts

@@ -0,0 +1,111 @@
+/*
+Grammar:
+
+alpha     = "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"
+number    = "1" / "2" / "3" / "4" / "5" / "6" / "7" / "8" / "9" / "0"
+delim     = "."
+segment   = alpha *( alpha / number / "-" )
+authority = segment *( delim segment )
+name      = alpha *( alpha )
+nsid      = authority delim name
+
+*/
+
+export class NSID {
+  segments: string[] = []
+
+  static parse(nsid: string): NSID {
+    return new NSID(nsid)
+  }
+
+  static create(authority: string, name: string): NSID {
+    const segments = [...authority.split('.').reverse(), name].join('.')
+    return new NSID(segments)
+  }
+
+  static isValid(nsid: string): boolean {
+    try {
+      NSID.parse(nsid)
+      return true
+    } catch (e) {
+      return false
+    }
+  }
+
+  constructor(nsid: string) {
+    ensureValidNsid(nsid)
+    this.segments = nsid.split('.')
+  }
+
+  get authority() {
+    return this.segments
+      .slice(0, this.segments.length - 1)
+      .reverse()
+      .join('.')
+  }
+
+  get name() {
+    return this.segments.at(this.segments.length - 1)
+  }
+
+  toString() {
+    return this.segments.join('.')
+  }
+}
+
+// Human readable constraints on NSID:
+// - a valid domain in reversed notation
+// - followed by an additional period-separated name, which is camel-case letters
+export const ensureValidNsid = (nsid: string): void => {
+  const toCheck = nsid
+
+  // check that all chars are boring ASCII
+  if (!/^[a-zA-Z0-9.-]*$/.test(toCheck)) {
+    throw new InvalidNsidError(
+      'Disallowed characters in NSID (ASCII letters, digits, dashes, periods only)',
+    )
+  }
+
+  if (toCheck.length > 253 + 1 + 63) {
+    throw new InvalidNsidError('NSID is too long (317 chars max)')
+  }
+  const labels = toCheck.split('.')
+  if (labels.length < 3) {
+    throw new InvalidNsidError('NSID needs at least three parts')
+  }
+  for (let i = 0; i < labels.length; i++) {
+    const l = labels[i]
+    if (l.length < 1) {
+      throw new InvalidNsidError('NSID parts can not be empty')
+    }
+    if (l.length > 63) {
+      throw new InvalidNsidError('NSID part too long (max 63 chars)')
+    }
+    if (l.endsWith('-') || l.startsWith('-')) {
+      throw new InvalidNsidError('NSID parts can not start or end with hyphen')
+    }
+    if (/^[0-9]/.test(l) && i == 0) {
+      throw new InvalidNsidError('NSID first part may not start with a digit')
+    }
+    if (!/^[a-zA-Z]+$/.test(l) && i + 1 == labels.length) {
+      throw new InvalidNsidError('NSID name part must be only letters')
+    }
+  }
+}
+
+export const ensureValidNsidRegex = (nsid: string): void => {
+  // simple regex to enforce most constraints via just regex and length.
+  // hand wrote this regex based on above constraints
+  if (
+    !/^[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-Z]{0,61}[a-zA-Z])?)$/.test(
+      nsid,
+    )
+  ) {
+    throw new InvalidNsidError("NSID didn't validate via regex")
+  }
+  if (nsid.length > 253 + 1 + 63) {
+    throw new InvalidNsidError('NSID is too long (317 chars max)')
+  }
+}
+
+export class InvalidNsidError extends Error {}

package/tests/aturi.test.ts

@@ -0,0 +1,506 @@
+import { AtUri, ensureValidAtUri, ensureValidAtUriRegex } from '../src/index'
+
+describe('At Uris', () => {
+  it('parses valid at uris', () => {
+    //                 input   host    path    query   hash
+    type AtUriTest = [string, string, string, string, string]
+    const TESTS: AtUriTest[] = [
+      ['foo.com', 'foo.com', '', '', ''],
+      ['at://foo.com', 'foo.com', '', '', ''],
+      ['at://foo.com/', 'foo.com', '/', '', ''],
+      ['at://foo.com/foo', 'foo.com', '/foo', '', ''],
+      ['at://foo.com/foo/', 'foo.com', '/foo/', '', ''],
+      ['at://foo.com/foo/bar', 'foo.com', '/foo/bar', '', ''],
+      ['at://foo.com?foo=bar', 'foo.com', '', 'foo=bar', ''],
+      ['at://foo.com?foo=bar&baz=buux', 'foo.com', '', 'foo=bar&baz=buux', ''],
+      ['at://foo.com/?foo=bar', 'foo.com', '/', 'foo=bar', ''],
+      ['at://foo.com/foo?foo=bar', 'foo.com', '/foo', 'foo=bar', ''],
+      ['at://foo.com/foo/?foo=bar', 'foo.com', '/foo/', 'foo=bar', ''],
+      ['at://foo.com#hash', 'foo.com', '', '', '#hash'],
+      ['at://foo.com/#hash', 'foo.com', '/', '', '#hash'],
+      ['at://foo.com/foo#hash', 'foo.com', '/foo', '', '#hash'],
+      ['at://foo.com/foo/#hash', 'foo.com', '/foo/', '', '#hash'],
+      ['at://foo.com?foo=bar#hash', 'foo.com', '', 'foo=bar', '#hash'],
+
+      [
+        'did:example:EiAnKD8-jfdd0MDcZUjAbRgaThBrMxPTFOxcnfJhI7Ukaw',
+        'did:example:EiAnKD8-jfdd0MDcZUjAbRgaThBrMxPTFOxcnfJhI7Ukaw',
+        '',
+        '',
+        '',
+      ],
+      [
+        'at://did:example:EiAnKD8-jfdd0MDcZUjAbRgaThBrMxPTFOxcnfJhI7Ukaw',
+        'did:example:EiAnKD8-jfdd0MDcZUjAbRgaThBrMxPTFOxcnfJhI7Ukaw',
+        '',
+        '',
+        '',
+      ],
+      [
+        'at://did:example:EiAnKD8-jfdd0MDcZUjAbRgaThBrMxPTFOxcnfJhI7Ukaw/',
+        'did:example:EiAnKD8-jfdd0MDcZUjAbRgaThBrMxPTFOxcnfJhI7Ukaw',
+        '/',
+        '',
+        '',
+      ],
+      [
+        'at://did:example:EiAnKD8-jfdd0MDcZUjAbRgaThBrMxPTFOxcnfJhI7Ukaw/foo',
+        'did:example:EiAnKD8-jfdd0MDcZUjAbRgaThBrMxPTFOxcnfJhI7Ukaw',
+        '/foo',
+        '',
+        '',
+      ],
+      [
+        'at://did:example:EiAnKD8-jfdd0MDcZUjAbRgaThBrMxPTFOxcnfJhI7Ukaw/foo/',
+        'did:example:EiAnKD8-jfdd0MDcZUjAbRgaThBrMxPTFOxcnfJhI7Ukaw',
+        '/foo/',
+        '',
+        '',
+      ],
+      [
+        'at://did:example:EiAnKD8-jfdd0MDcZUjAbRgaThBrMxPTFOxcnfJhI7Ukaw/foo/bar',
+        'did:example:EiAnKD8-jfdd0MDcZUjAbRgaThBrMxPTFOxcnfJhI7Ukaw',
+        '/foo/bar',
+        '',
+        '',
+      ],
+      [
+        'at://did:example:EiAnKD8-jfdd0MDcZUjAbRgaThBrMxPTFOxcnfJhI7Ukaw?foo=bar',
+        'did:example:EiAnKD8-jfdd0MDcZUjAbRgaThBrMxPTFOxcnfJhI7Ukaw',
+        '',
+        'foo=bar',
+        '',
+      ],
+      [
+        'at://did:example:EiAnKD8-jfdd0MDcZUjAbRgaThBrMxPTFOxcnfJhI7Ukaw?foo=bar&baz=buux',
+        'did:example:EiAnKD8-jfdd0MDcZUjAbRgaThBrMxPTFOxcnfJhI7Ukaw',
+        '',
+        'foo=bar&baz=buux',
+        '',
+      ],
+      [
+        'at://did:example:EiAnKD8-jfdd0MDcZUjAbRgaThBrMxPTFOxcnfJhI7Ukaw/?foo=bar',
+        'did:example:EiAnKD8-jfdd0MDcZUjAbRgaThBrMxPTFOxcnfJhI7Ukaw',
+        '/',
+        'foo=bar',
+        '',
+      ],
+      [
+        'at://did:example:EiAnKD8-jfdd0MDcZUjAbRgaThBrMxPTFOxcnfJhI7Ukaw/foo?foo=bar',
+        'did:example:EiAnKD8-jfdd0MDcZUjAbRgaThBrMxPTFOxcnfJhI7Ukaw',
+        '/foo',
+        'foo=bar',
+        '',
+      ],
+      [
+        'at://did:example:EiAnKD8-jfdd0MDcZUjAbRgaThBrMxPTFOxcnfJhI7Ukaw/foo/?foo=bar',
+        'did:example:EiAnKD8-jfdd0MDcZUjAbRgaThBrMxPTFOxcnfJhI7Ukaw',
+        '/foo/',
+        'foo=bar',
+        '',
+      ],
+      [
+        'at://did:example:EiAnKD8-jfdd0MDcZUjAbRgaThBrMxPTFOxcnfJhI7Ukaw#hash',
+        'did:example:EiAnKD8-jfdd0MDcZUjAbRgaThBrMxPTFOxcnfJhI7Ukaw',
+        '',
+        '',
+        '#hash',
+      ],
+      [
+        'at://did:example:EiAnKD8-jfdd0MDcZUjAbRgaThBrMxPTFOxcnfJhI7Ukaw/#hash',
+        'did:example:EiAnKD8-jfdd0MDcZUjAbRgaThBrMxPTFOxcnfJhI7Ukaw',
+        '/',
+        '',
+        '#hash',
+      ],
+      [
+        'at://did:example:EiAnKD8-jfdd0MDcZUjAbRgaThBrMxPTFOxcnfJhI7Ukaw/foo#hash',
+        'did:example:EiAnKD8-jfdd0MDcZUjAbRgaThBrMxPTFOxcnfJhI7Ukaw',
+        '/foo',
+        '',
+        '#hash',
+      ],
+      [
+        'at://did:example:EiAnKD8-jfdd0MDcZUjAbRgaThBrMxPTFOxcnfJhI7Ukaw/foo/#hash',
+        'did:example:EiAnKD8-jfdd0MDcZUjAbRgaThBrMxPTFOxcnfJhI7Ukaw',
+        '/foo/',
+        '',
+        '#hash',
+      ],
+      [
+        'at://did:example:EiAnKD8-jfdd0MDcZUjAbRgaThBrMxPTFOxcnfJhI7Ukaw?foo=bar#hash',
+        'did:example:EiAnKD8-jfdd0MDcZUjAbRgaThBrMxPTFOxcnfJhI7Ukaw',
+        '',
+        'foo=bar',
+        '#hash',
+      ],
+
+      ['did:web:localhost%3A1234', 'did:web:localhost%3A1234', '', '', ''],
+      ['at://did:web:localhost%3A1234', 'did:web:localhost%3A1234', '', '', ''],
+      [
+        'at://did:web:localhost%3A1234/',
+        'did:web:localhost%3A1234',
+        '/',
+        '',
+        '',
+      ],
+      [
+        'at://did:web:localhost%3A1234/foo',
+        'did:web:localhost%3A1234',
+        '/foo',
+        '',
+        '',
+      ],
+      [
+        'at://did:web:localhost%3A1234/foo/',
+        'did:web:localhost%3A1234',
+        '/foo/',
+        '',
+        '',
+      ],
+      [
+        'at://did:web:localhost%3A1234/foo/bar',
+        'did:web:localhost%3A1234',
+        '/foo/bar',
+        '',
+        '',
+      ],
+      [
+        'at://did:web:localhost%3A1234?foo=bar',
+        'did:web:localhost%3A1234',
+        '',
+        'foo=bar',
+        '',
+      ],
+      [
+        'at://did:web:localhost%3A1234?foo=bar&baz=buux',
+        'did:web:localhost%3A1234',
+        '',
+        'foo=bar&baz=buux',
+        '',
+      ],
+      [
+        'at://did:web:localhost%3A1234/?foo=bar',
+        'did:web:localhost%3A1234',
+        '/',
+        'foo=bar',
+        '',
+      ],
+      [
+        'at://did:web:localhost%3A1234/foo?foo=bar',
+        'did:web:localhost%3A1234',
+        '/foo',
+        'foo=bar',
+        '',
+      ],
+      [
+        'at://did:web:localhost%3A1234/foo/?foo=bar',
+        'did:web:localhost%3A1234',
+        '/foo/',
+        'foo=bar',
+        '',
+      ],
+      [
+        'at://did:web:localhost%3A1234#hash',
+        'did:web:localhost%3A1234',
+        '',
+        '',
+        '#hash',
+      ],
+      [
+        'at://did:web:localhost%3A1234/#hash',
+        'did:web:localhost%3A1234',
+        '/',
+        '',
+        '#hash',
+      ],
+      [
+        'at://did:web:localhost%3A1234/foo#hash',
+        'did:web:localhost%3A1234',
+        '/foo',
+        '',
+        '#hash',
+      ],
+      [
+        'at://did:web:localhost%3A1234/foo/#hash',
+        'did:web:localhost%3A1234',
+        '/foo/',
+        '',
+        '#hash',
+      ],
+      [
+        'at://did:web:localhost%3A1234?foo=bar#hash',
+        'did:web:localhost%3A1234',
+        '',
+        'foo=bar',
+        '#hash',
+      ],
+      [
+        'at://4513echo.bsky.social/app.bsky.feed.post/3jsrpdyf6ss23',
+        '4513echo.bsky.social',
+        '/app.bsky.feed.post/3jsrpdyf6ss23',
+        '',
+        '',
+      ],
+    ]
+    for (const [uri, hostname, pathname, search, hash] of TESTS) {
+      const urip = new AtUri(uri)
+      expect(urip.protocol).toBe('at:')
+      expect(urip.host).toBe(hostname)
+      expect(urip.hostname).toBe(hostname)
+      expect(urip.origin).toBe(`at://${hostname}`)
+      expect(urip.pathname).toBe(pathname)
+      expect(urip.search).toBe(search)
+      expect(urip.hash).toBe(hash)
+    }
+  })
+
+  it('handles ATP-specific parsing', () => {
+    {
+      const urip = new AtUri('at://foo.com')
+      expect(urip.collection).toBe('')
+      expect(urip.rkey).toBe('')
+    }
+    {
+      const urip = new AtUri('at://foo.com/com.example.foo')
+      expect(urip.collection).toBe('com.example.foo')
+      expect(urip.rkey).toBe('')
+    }
+    {
+      const urip = new AtUri('at://foo.com/com.example.foo/123')
+      expect(urip.collection).toBe('com.example.foo')
+      expect(urip.rkey).toBe('123')
+    }
+  })
+
+  it('supports modifications', () => {
+    const urip = new AtUri('at://foo.com')
+    expect(urip.toString()).toBe('at://foo.com/')
+
+    urip.host = 'bar.com'
+    expect(urip.toString()).toBe('at://bar.com/')
+    urip.host = 'did:web:localhost%3A1234'
+    expect(urip.toString()).toBe('at://did:web:localhost%3A1234/')
+    urip.host = 'foo.com'
+
+    urip.pathname = '/'
+    expect(urip.toString()).toBe('at://foo.com/')
+    urip.pathname = '/foo'
+    expect(urip.toString()).toBe('at://foo.com/foo')
+    urip.pathname = 'foo'
+    expect(urip.toString()).toBe('at://foo.com/foo')
+
+    urip.collection = 'com.example.foo'
+    urip.rkey = '123'
+    expect(urip.toString()).toBe('at://foo.com/com.example.foo/123')
+    urip.rkey = '124'
+    expect(urip.toString()).toBe('at://foo.com/com.example.foo/124')
+    urip.collection = 'com.other.foo'
+    expect(urip.toString()).toBe('at://foo.com/com.other.foo/124')
+    urip.pathname = ''
+    urip.rkey = '123'
+    expect(urip.toString()).toBe('at://foo.com/undefined/123')
+    urip.pathname = 'foo'
+
+    urip.search = '?foo=bar'
+    expect(urip.toString()).toBe('at://foo.com/foo?foo=bar')
+    urip.searchParams.set('baz', 'buux')
+    expect(urip.toString()).toBe('at://foo.com/foo?foo=bar&baz=buux')
+
+    urip.hash = '#hash'
+    expect(urip.toString()).toBe('at://foo.com/foo?foo=bar&baz=buux#hash')
+    urip.hash = 'hash'
+    expect(urip.toString()).toBe('at://foo.com/foo?foo=bar&baz=buux#hash')
+  })
+
+  it('supports relative URIs', () => {
+    //                 input   path    query   hash
+    type AtUriTest = [string, string, string, string]
+    const TESTS: AtUriTest[] = [
+      // input hostname pathname query hash
+      ['', '', '', ''],
+      ['/', '/', '', ''],
+      ['/foo', '/foo', '', ''],
+      ['/foo/', '/foo/', '', ''],
+      ['/foo/bar', '/foo/bar', '', ''],
+      ['?foo=bar', '', 'foo=bar', ''],
+      ['?foo=bar&baz=buux', '', 'foo=bar&baz=buux', ''],
+      ['/?foo=bar', '/', 'foo=bar', ''],
+      ['/foo?foo=bar', '/foo', 'foo=bar', ''],
+      ['/foo/?foo=bar', '/foo/', 'foo=bar', ''],
+      ['#hash', '', '', '#hash'],
+      ['/#hash', '/', '', '#hash'],
+      ['/foo#hash', '/foo', '', '#hash'],
+      ['/foo/#hash', '/foo/', '', '#hash'],
+      ['?foo=bar#hash', '', 'foo=bar', '#hash'],
+    ]
+    const BASES: string[] = [
+      'did:web:localhost%3A1234',
+      'at://did:web:localhost%3A1234',
+      'at://did:web:localhost%3A1234/foo/bar?foo=bar&baz=buux#hash',
+      'did:web:localhost%3A1234',
+      'at://did:web:localhost%3A1234',
+      'at://did:web:localhost%3A1234/foo/bar?foo=bar&baz=buux#hash',
+    ]
+
+    for (const base of BASES) {
+      const basep = new AtUri(base)
+      for (const [relative, pathname, search, hash] of TESTS) {
+        const urip = new AtUri(relative, base)
+        expect(urip.protocol).toBe('at:')
+        expect(urip.host).toBe(basep.host)
+        expect(urip.hostname).toBe(basep.hostname)
+        expect(urip.origin).toBe(basep.origin)
+        expect(urip.pathname).toBe(pathname)
+        expect(urip.search).toBe(search)
+        expect(urip.hash).toBe(hash)
+      }
+    }
+  })
+})
+
+describe('AtUri validation', () => {
+  const expectValid = (h: string) => {
+    ensureValidAtUri(h)
+    ensureValidAtUriRegex(h)
+  }
+  const expectInvalid = (h: string) => {
+    expect(() => ensureValidAtUri(h)).toThrow()
+    expect(() => ensureValidAtUriRegex(h)).toThrow()
+  }
+
+  it('enforces spec basics', () => {
+    expectValid('at://did:plc:asdf123')
+    expectValid('at://user.bsky.social')
+    expectValid('at://did:plc:asdf123/com.atproto.feed.post')
+    expectValid('at://did:plc:asdf123/com.atproto.feed.post/record')
+
+    expectValid('at://did:plc:asdf123#/frag')
+    expectValid('at://user.bsky.social#/frag')
+    expectValid('at://did:plc:asdf123/com.atproto.feed.post#/frag')
+    expectValid('at://did:plc:asdf123/com.atproto.feed.post/record#/frag')
+
+    expectInvalid('a://did:plc:asdf123')
+    expectInvalid('at//did:plc:asdf123')
+    expectInvalid('at:/a/did:plc:asdf123')
+    expectInvalid('at:/did:plc:asdf123')
+    expectInvalid('AT://did:plc:asdf123')
+    expectInvalid('http://did:plc:asdf123')
+    expectInvalid('://did:plc:asdf123')
+    expectInvalid('at:did:plc:asdf123')
+    expectInvalid('at:/did:plc:asdf123')
+    expectInvalid('at:///did:plc:asdf123')
+    expectInvalid('at://:/did:plc:asdf123')
+    expectInvalid('at:/ /did:plc:asdf123')
+    expectInvalid('at://did:plc:asdf123 ')
+    expectInvalid('at://did:plc:asdf123/ ')
+    expectInvalid(' at://did:plc:asdf123')
+    expectInvalid('at://did:plc:asdf123/com.atproto.feed.post ')
+    expectInvalid('at://did:plc:asdf123/com.atproto.feed.post# ')
+    expectInvalid('at://did:plc:asdf123/com.atproto.feed.post#/ ')
+    expectInvalid('at://did:plc:asdf123/com.atproto.feed.post#/frag ')
+    expectInvalid('at://did:plc:asdf123/com.atproto.feed.post#fr ag')
+    expectInvalid('//did:plc:asdf123')
+    expectInvalid('at://name')
+    expectInvalid('at://name.0')
+    expectInvalid('at://diD:plc:asdf123')
+    expectInvalid('at://did:plc:asdf123/com.atproto.feed.p@st')
+    expectInvalid('at://did:plc:asdf123/com.atproto.feed.p$st')
+    expectInvalid('at://did:plc:asdf123/com.atproto.feed.p%st')
+    expectInvalid('at://did:plc:asdf123/com.atproto.feed.p&st')
+    expectInvalid('at://did:plc:asdf123/com.atproto.feed.p()t')
+    expectInvalid('at://did:plc:asdf123/com.atproto.feed_post')
+    expectInvalid('at://did:plc:asdf123/-com.atproto.feed.post')
+    expectInvalid('at://did:plc:asdf@123/com.atproto.feed.post')
+
+    expectInvalid('at://DID:plc:asdf123')
+    expectInvalid('at://user.bsky.123')
+    expectInvalid('at://bsky')
+    expectInvalid('at://did:plc:')
+    expectInvalid('at://did:plc:')
+    expectInvalid('at://frag')
+
+    expectValid('at://did:plc:asdf123/com.atproto.feed.post/' + 'o'.repeat(800))
+    expectInvalid(
+      'at://did:plc:asdf123/com.atproto.feed.post/' + 'o'.repeat(8200),
+    )
+  })
+
+  it('has specified behavior on edge cases', () => {
+    expectInvalid('at://user.bsky.social//')
+    expectInvalid('at://user.bsky.social//com.atproto.feed.post')
+    expectInvalid('at://user.bsky.social/com.atproto.feed.post//')
+    expectInvalid(
+      'at://did:plc:asdf123/com.atproto.feed.post/asdf123/more/more',
+    )
+    expectInvalid('at://did:plc:asdf123/short/stuff')
+    expectInvalid('at://did:plc:asdf123/12345')
+  })
+
+  it('enforces no trailing slashes', () => {
+    expectValid('at://did:plc:asdf123')
+    expectInvalid('at://did:plc:asdf123/')
+
+    expectValid('at://user.bsky.social')
+    expectInvalid('at://user.bsky.social/')
+
+    expectValid('at://did:plc:asdf123/com.atproto.feed.post')
+    expectInvalid('at://did:plc:asdf123/com.atproto.feed.post/')
+
+    expectValid('at://did:plc:asdf123/com.atproto.feed.post/record')
+    expectInvalid('at://did:plc:asdf123/com.atproto.feed.post/record/')
+    expectInvalid('at://did:plc:asdf123/com.atproto.feed.post/record/#/frag')
+  })
+
+  it('enforces strict paths', () => {
+    expectValid('at://did:plc:asdf123/com.atproto.feed.post/asdf123')
+    expectInvalid('at://did:plc:asdf123/com.atproto.feed.post/asdf123/asdf')
+  })
+
+  it('is very permissive about record keys', () => {
+    expectValid('at://did:plc:asdf123/com.atproto.feed.post/asdf123')
+    expectValid('at://did:plc:asdf123/com.atproto.feed.post/a')
+    expectValid('at://did:plc:asdf123/com.atproto.feed.post/%23')
+
+    expectValid('at://did:plc:asdf123/com.atproto.feed.post/$@!*)(:,;~.sdf123')
+    expectValid("at://did:plc:asdf123/com.atproto.feed.post/~'sdf123")
+
+    expectValid('at://did:plc:asdf123/com.atproto.feed.post/$')
+    expectValid('at://did:plc:asdf123/com.atproto.feed.post/@')
+    expectValid('at://did:plc:asdf123/com.atproto.feed.post/!')
+    expectValid('at://did:plc:asdf123/com.atproto.feed.post/*')
+    expectValid('at://did:plc:asdf123/com.atproto.feed.post/(')
+    expectValid('at://did:plc:asdf123/com.atproto.feed.post/,')
+    expectValid('at://did:plc:asdf123/com.atproto.feed.post/;')
+    expectValid('at://did:plc:asdf123/com.atproto.feed.post/abc%30123')
+  })
+
+  it('is probably too permissive about URL encoding', () => {
+    expectValid('at://did:plc:asdf123/com.atproto.feed.post/%30')
+    expectValid('at://did:plc:asdf123/com.atproto.feed.post/%3')
+    expectValid('at://did:plc:asdf123/com.atproto.feed.post/%')
+    expectValid('at://did:plc:asdf123/com.atproto.feed.post/%zz')
+    expectValid('at://did:plc:asdf123/com.atproto.feed.post/%%%')
+  })
+
+  it('is very permissive about fragments', () => {
+    expectValid('at://did:plc:asdf123#/frac')
+
+    expectInvalid('at://did:plc:asdf123#')
+    expectInvalid('at://did:plc:asdf123##')
+    expectInvalid('#at://did:plc:asdf123')
+    expectInvalid('at://did:plc:asdf123#/asdf#/asdf')
+
+    expectValid('at://did:plc:asdf123#/com.atproto.feed.post')
+    expectValid('at://did:plc:asdf123#/com.atproto.feed.post/')
+    expectValid('at://did:plc:asdf123#/asdf/')
+
+    expectValid('at://did:plc:asdf123/com.atproto.feed.post#/$@!*():,;~.sdf123')
+    expectValid('at://did:plc:asdf123#/[asfd]')
+
+    expectValid('at://did:plc:asdf123#/$')
+    expectValid('at://did:plc:asdf123#/*')
+    expectValid('at://did:plc:asdf123#/;')
+    expectValid('at://did:plc:asdf123#/,')
+  })
+})

package/tests/did.test.ts

@@ -0,0 +1,67 @@
+import { ensureValidDid, ensureValidDidRegex, InvalidDidError } from '../src'
+
+describe('DID permissive validation', () => {
+  const expectValid = (h: string) => {
+    ensureValidDid(h)
+    ensureValidDidRegex(h)
+  }
+  const expectInvalid = (h: string) => {
+    expect(() => ensureValidDid(h)).toThrow(InvalidDidError)
+    expect(() => ensureValidDidRegex(h)).toThrow(InvalidDidError)
+  }
+
+  it('enforces spec details', () => {
+    expectValid('did:method:val')
+    expectValid('did:method:VAL')
+    expectValid('did:method:val123')
+    expectValid('did:method:123')
+    expectValid('did:method:val-two')
+    expectValid('did:method:val_two')
+    expectValid('did:method:val.two')
+    expectValid('did:method:val:two')
+    expectValid('did:method:val%BB')
+
+    expectInvalid('did')
+    expectInvalid('didmethodval')
+    expectInvalid('method:did:val')
+    expectInvalid('did:method:')
+    expectInvalid('didmethod:val')
+    expectInvalid('did:methodval')
+    expectInvalid(':did:method:val')
+    expectInvalid('did.method.val')
+    expectInvalid('did:method:val:')
+    expectInvalid('did:method:val%')
+    expectInvalid('DID:method:val')
+    expectInvalid('did:METHOD:val')
+    expectInvalid('did:m123:val')
+
+    expectValid('did:method:' + 'v'.repeat(240))
+    expectInvalid('did:method:' + 'v'.repeat(8500))
+
+    expectValid('did:m:v')
+    expectValid('did:method::::val')
+    expectValid('did:method:-')
+    expectValid('did:method:-:_:.:%ab')
+    expectValid('did:method:.')
+    expectValid('did:method:_')
+    expectValid('did:method::.')
+
+    expectInvalid('did:method:val/two')
+    expectInvalid('did:method:val?two')
+    expectInvalid('did:method:val#two')
+    expectInvalid('did:method:val%')
+
+    expectValid(
+      'did:onion:2gzyxa5ihm7nsggfxnu52rck2vv4rvmdlkiu3zzui5du4xyclen53wid',
+    )
+  })
+
+  it('allows some real DID values', () => {
+    expectValid('did:example:123456789abcdefghi')
+    expectValid('did:plc:7iza6de2dwap2sbkpav7c6c6')
+    expectValid('did:web:example.com')
+    expectValid('did:web:localhost%3A1234')
+    expectValid('did:key:zQ3shZc2QzApp2oymGvQbzP8eKheVshBHbU4ZYjeXqwSKEn6N')
+    expectValid('did:ethr:0xb9c5714089478a327f09197987f16f9e5d936e8a')
+  })
+})