@atproto/syntax 0.6.2 → 0.6.4

package/src/nsid.ts

@@ -1,182 +0,0 @@
-import { Result, failure, success } from './lib/result.js'
-
-/*
-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 / number )
-nsid      = authority delim name
-
-*/
-
-export type NsidString = `${string}.${string}.${string}`
-
-export class NSID {
-  readonly segments: readonly string[]
-
-  static parse(input: string): NSID {
-    return new NSID(input)
-  }
-
-  static create(authority: string, name: string): NSID {
-    const input = [...authority.split('.').reverse(), name].join('.')
-    return new NSID(input)
-  }
-
-  static isValid(nsid: string) {
-    return isValidNsid(nsid)
-  }
-
-  static from(input: { toString: () => string }): NSID {
-    if (input instanceof NSID) {
-      // No need to clone, NSID is immutable
-      return input
-    }
-    if (Array.isArray(input)) {
-      return new NSID((input as string[]).join('.'))
-    }
-    return new NSID(String(input))
-  }
-
-  constructor(nsid: string) {
-    this.segments = parseNsid(nsid)
-  }
-
-  get authority() {
-    return this.segments
-      .slice(0, this.segments.length - 1)
-      .reverse()
-      .join('.') as `${string}.${string}`
-  }
-
-  get name() {
-    return this.segments.at(this.segments.length - 1)
-  }
-
-  toString(): NsidString {
-    return this.segments.join('.') as NsidString
-  }
-}
-
-export function ensureValidNsid<I extends string>(
-  input: I,
-): asserts input is I & NsidString {
-  const result = validateNsid(input)
-  if (!result.success) throw new InvalidNsidError(result.message)
-}
-
-export function parseNsid(nsid: string): string[] {
-  const result = validateNsid(nsid)
-  if (!result.success) throw new InvalidNsidError(result.message)
-  return result.value
-}
-
-export function isValidNsid<I extends string>(
-  input: I,
-): input is I & NsidString {
-  // Since the regex version is more performant for valid NSIDs, we use it when
-  // we don't care about error details.
-  return validateNsidRegex(input).success
-}
-
-// Human readable constraints on NSID:
-// - a valid domain in reversed notation
-// - followed by an additional period-separated name, which is camel-case letters
-export function validateNsid(input: string): Result<string[]> {
-  if (input.length > 253 + 1 + 63) {
-    return failure('NSID is too long (317 chars max)')
-  }
-  if (hasDisallowedCharacters(input)) {
-    return failure(
-      'Disallowed characters in NSID (ASCII letters, digits, dashes, periods only)',
-    )
-  }
-  const segments = input.split('.')
-  if (segments.length < 3) {
-    return failure('NSID needs at least three parts')
-  }
-  for (const l of segments) {
-    if (l.length < 1) {
-      return failure('NSID parts can not be empty')
-    }
-    if (l.length > 63) {
-      return failure('NSID part too long (max 63 chars)')
-    }
-    if (startsWithHyphen(l) || endsWithHyphen(l)) {
-      return failure('NSID parts can not start or end with hyphen')
-    }
-  }
-  if (startsWithNumber(segments[0])) {
-    return failure('NSID first part may not start with a digit')
-  }
-  if (!isValidIdentifier(segments[segments.length - 1])) {
-    return failure(
-      'NSID name part must be only letters and digits (and no leading digit)',
-    )
-  }
-  return success(segments)
-}
-
-function hasDisallowedCharacters(v: string) {
-  return !/^[a-zA-Z0-9.-]*$/.test(v)
-}
-
-function startsWithNumber(v: string) {
-  const charCode = v.charCodeAt(0)
-  return charCode >= 48 && charCode <= 57
-}
-
-function startsWithHyphen(v: string) {
-  return v.charCodeAt(0) === 45 /* - */
-}
-
-function endsWithHyphen(v: string) {
-  return v.charCodeAt(v.length - 1) === 45 /* - */
-}
-
-function isValidIdentifier(v: string) {
-  // Note, since we already know that "v" only contains [a-zA-Z0-9-], we can
-  // simplify the following regex by checking only the first char and presence
-  // of "-".
-
-  // return /^[a-zA-Z][a-zA-Z0-9]*$/.test(v)
-  return !startsWithNumber(v) && !v.includes('-')
-}
-
-/**
- * @deprecated Use {@link ensureValidNsid} if you care about error details,
- * {@link parseNsid}/{@link NSID.parse} if you need the parsed segments, or
- * {@link isValidNsid} if you just want a boolean.
- */
-export function ensureValidNsidRegex(nsid: string): asserts nsid is NsidString {
-  const result = validateNsidRegex(nsid)
-  if (!result.success) throw new InvalidNsidError(result.message)
-}
-
-/**
- * Regexp based validation that behaves identically to the previous code but
- * provides less detailed error messages (while being 20% to 50% faster).
- */
-export function validateNsidRegex(value: string): Result<NsidString> {
-  if (value.length > 253 + 1 + 63) {
-    return failure('NSID is too long (317 chars max)')
-  }
-
-  if (
-    // Fast check for small values
-    value.length < 5 ||
-    !/^[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(
-      value,
-    )
-  ) {
-    return failure("NSID didn't validate via regex")
-  }
-
-  return success(value as NsidString)
-}
-
-export class InvalidNsidError extends Error {}

package/src/recordkey.ts

@@ -1,51 +0,0 @@
-export type RecordKeyString = string
-
-const RECORD_KEY_MAX_LENGTH = 512
-const RECORD_KEY_MIN_LENGTH = 1
-const RECORD_KEY_INVALID_VALUES = new Set(['.', '..'])
-const RECORD_KEY_REGEX = /^[a-zA-Z0-9_~.:-]{1,512}$/
-
-// https://atproto.com/specs/record-key#record-key-syntax
-// Regardless of the type, Record Keys must fulfill some baseline syntax constraints:
-// - restricted to a subset of ASCII characters -- the allowed characters are
-//   alphanumeric (A-Za-z0-9), period, dash, underscore, colon, or tilde (.-_:~)
-// - must have at least 1 and at most 512 characters
-// - the specific record key values . and .. are not allowed
-// - must be a permissible part of repository MST path string (the above
-//   constraints satisfy this condition)
-// - must be permissible to include in a path component of a URI (following
-//   RFC-3986, section 3.3). The above constraints satisfy this condition, by
-//   matching the "unreserved" characters allowed in generic URI paths.
-
-export function ensureValidRecordKey<I extends string>(
-  input: I,
-): asserts input is I & RecordKeyString {
-  if (
-    input.length > RECORD_KEY_MAX_LENGTH ||
-    input.length < RECORD_KEY_MIN_LENGTH
-  ) {
-    throw new InvalidRecordKeyError(
-      `record key must be ${RECORD_KEY_MIN_LENGTH} to ${RECORD_KEY_MAX_LENGTH} characters`,
-    )
-  }
-  if (RECORD_KEY_INVALID_VALUES.has(input)) {
-    throw new InvalidRecordKeyError('record key can not be "." or ".."')
-  }
-  // simple regex to enforce most constraints via just regex and length.
-  if (!RECORD_KEY_REGEX.test(input)) {
-    throw new InvalidRecordKeyError('record key syntax not valid (regex)')
-  }
-}
-
-export function isValidRecordKey<I extends string>(
-  input: I,
-): input is I & RecordKeyString {
-  return (
-    input.length >= RECORD_KEY_MIN_LENGTH &&
-    input.length <= RECORD_KEY_MAX_LENGTH &&
-    RECORD_KEY_REGEX.test(input) &&
-    !RECORD_KEY_INVALID_VALUES.has(input)
-  )
-}
-
-export class InvalidRecordKeyError extends Error {}

package/src/tid.ts

@@ -1,22 +0,0 @@
-export type TidString = string
-
-const TID_LENGTH = 13
-const TID_REGEX = /^[234567abcdefghij][234567abcdefghijklmnopqrstuvwxyz]{12}$/
-
-export function ensureValidTid<I extends string>(
-  input: I,
-): asserts input is I & TidString {
-  if (input.length !== TID_LENGTH) {
-    throw new InvalidTidError(`TID must be ${TID_LENGTH} characters`)
-  }
-  // simple regex to enforce most constraints via just regex and length.
-  if (!TID_REGEX.test(input)) {
-    throw new InvalidTidError('TID syntax not valid (regex)')
-  }
-}
-
-export function isValidTid<I extends string>(input: I): input is I & TidString {
-  return input.length === TID_LENGTH && TID_REGEX.test(input)
-}
-
-export class InvalidTidError extends Error {}

package/src/uri.ts

@@ -1,5 +0,0 @@
-export type UriString = `${string}:${string}`
-
-export function isValidUri<I extends string>(input: I): input is I & UriString {
-  return /^\w+:(?:\/\/)?[^\s/][^\s]*$/.test(input)
-}

package/tests/aturi-string.test.ts

@@ -1,223 +0,0 @@
-import { readFileSync } from 'node:fs'
-import { describe, expect, test } from 'vitest'
-import {
-  InvalidAtUriError,
-  assertAtUriString,
-  isAtUriString,
-} from '../src/index.js'
-
-describe('valid interop', () => {
-  test.each(
-    readLines(
-      `${__dirname}/../../../interop-test-files/syntax/aturi_syntax_valid.txt`,
-    ),
-  )('%s', (value) => {
-    expect(isAtUriString(value)).toBe(true)
-    expect(isAtUriString(value, { strict: false })).toBe(true)
-    expect(() => assertAtUriString(value)).not.toThrow()
-    expect(() => assertAtUriString(value, { strict: false })).not.toThrow()
-  })
-})
-
-describe('invalid interop', () => {
-  test.each(
-    readLines(
-      `${__dirname}/../../../interop-test-files/syntax/aturi_syntax_invalid.txt`,
-    ),
-  )('%s', (value) => {
-    expect(isAtUriString(value)).toBe(false)
-    expect(() => assertAtUriString(value)).toThrow(InvalidAtUriError)
-  })
-})
-
-describe('custom cases', () => {
-  describe('valid spec basics', () => {
-    testValid('at://did:plc:asdf123')
-    testValid('at://user.bsky.social')
-    testValid('at://did:plc:asdf123/com.atproto.feed.post')
-    testValid('at://did:plc:asdf123/com.atproto.feed.post/record')
-
-    testValid('at://did:plc:asdf123#/frag')
-    testValid('at://user.bsky.social#/frag')
-    testValid('at://did:plc:asdf123/com.atproto.feed.post#/frag')
-    testValid('at://did:plc:asdf123/com.atproto.feed.post/record#/frag')
-  })
-
-  describe('invalid spec basics', () => {
-    testInvalid('a://did:plc:asdf123')
-    testInvalid('at//did:plc:asdf123')
-    testInvalid('at:/a/did:plc:asdf123')
-    testInvalid('at:/did:plc:asdf123')
-    testInvalid('AT://did:plc:asdf123')
-    testInvalid('http://did:plc:asdf123')
-    testInvalid('://did:plc:asdf123')
-    testInvalid('at:did:plc:asdf123')
-    testInvalid('at:/did:plc:asdf123')
-    testInvalid('at:///did:plc:asdf123')
-    testInvalid('at://:/did:plc:asdf123')
-    testInvalid('at:/ /did:plc:asdf123')
-    testInvalid('at://did:plc:asdf123 ')
-    testInvalid('at://did:plc:asdf123/ ')
-    testInvalid(' at://did:plc:asdf123')
-    testInvalid('at://did:plc:asdf123/com.atproto.feed.post ')
-    testInvalid('at://did:plc:asdf123/com.atproto.feed.post# ')
-    testInvalid('at://did:plc:asdf123/com.atproto.feed.post#/ ')
-    testInvalid('at://did:plc:asdf123/com.atproto.feed.post#/frag ')
-    testInvalid('at://did:plc:asdf123/com.atproto.feed.post#fr ag')
-    testInvalid('//did:plc:asdf123')
-    testInvalid('at://name')
-    testInvalid('at://name.0')
-    testInvalid('at://diD:plc:asdf123')
-    testInvalid('at://did:plc:asdf123/com.atproto.feed.p@st')
-    testInvalid('at://did:plc:asdf123/com.atproto.feed.p$st')
-    testInvalid('at://did:plc:asdf123/com.atproto.feed.p%st')
-    testInvalid('at://did:plc:asdf123/com.atproto.feed.p&st')
-    testInvalid('at://did:plc:asdf123/com.atproto.feed.p()t')
-    testInvalid('at://did:plc:asdf123/com.atproto.feed_post')
-    testInvalid('at://did:plc:asdf123/-com.atproto.feed.post')
-    testInvalid('at://did:plc:asdf@123/com.atproto.feed.post')
-
-    testInvalid('at://did:plc:asdf123?a')
-    testInvalid('at://user.bsky.social?a=B')
-    testInvalid('at://did:plc:asdf123/com.atproto.feed.post?foo=bar')
-    testInvalid('at://did:plc:asdf123/com.atproto.feed.post/record?q=3')
-
-    testInvalid('at://did:plc:asdf123?a=b#/frag')
-    testInvalid('at://user.bsky.social?a=b#/frag')
-    testInvalid('at://did:plc:asdf123/com.atproto.feed.post?a=b#/frag')
-    testInvalid('at://did:plc:asdf123/com.atproto.feed.post/record?a=b#/frag')
-
-    testInvalid('at://DID:plc:asdf123')
-    testInvalid('at://user.bsky.123')
-    testInvalid('at://bsky')
-    testInvalid('at://did:plc:')
-    testInvalid('at://did:plc:')
-    testInvalid('at://frag')
-  })
-
-  describe('very long strings', () => {
-    testValid('at://did:plc:asdf123/com.atproto.feed.post/' + 'o'.repeat(512))
-    testValid(`at://did:web:x${'.y'.repeat(100)}/com.atproto.feed.post/record`)
-    testInvalid(`at://did:plc:${'o'.repeat(8200)}/com.atproto.feed.post/record`)
-    testInvalid('at://did:plc:asdf123/com.atproto.feed.post/' + 'o'.repeat(513))
-    testInvalid('at://did:plc:asdf123/com.atproto.feed.post/' + 'o'.repeat(800))
-  })
-
-  describe('invalid collection', () => {
-    testInvalid('at://did:plc:asdf123/short/stuff')
-    testInvalid('at://did:plc:asdf123/12345')
-  })
-
-  describe('invalid repeated slashes', () => {
-    testInvalid('at://user.bsky.social//')
-    testInvalid('at://user.bsky.social//com.atproto.feed.post')
-    testInvalid('at://user.bsky.social/com.atproto.feed.post//')
-  })
-
-  describe('invalid trailing slashes', () => {
-    testInvalid('at://did:plc:asdf123/')
-    testInvalid('at://user.bsky.social/')
-    testInvalid('at://did:plc:asdf123/com.atproto.feed.post/')
-    testInvalid('at://did:plc:asdf123/com.atproto.feed.post/record/')
-    testInvalid('at://did:plc:asdf123/com.atproto.feed.post/record/#/frag')
-  })
-
-  describe('invalid segment count', () => {
-    testInvalid('at://did:plc:asdf123/com.atproto.feed.post/asdf123/asdf')
-    testInvalid('at://did:plc:asdf123/com.atproto.feed.post/asdf123/more/more')
-  })
-
-  describe('valid record key', () => {
-    testValid('at://did:plc:asdf123/com.atproto.feed.post/a')
-    testValid('at://did:plc:asdf123/com.atproto.feed.post/asdf123')
-  })
-
-  describe('loosely valid trailing slash', () => {
-    testLoose('at://did:plc:asdf123/')
-    testLoose('at://user.bsky.social/')
-    testLoose('at://did:plc:asdf123/com.atproto.feed.post/')
-    testLoose('at://did:plc:asdf123/com.atproto.feed.post/record/')
-    testLoose('at://did:plc:asdf123/com.atproto.feed.post/record/#/frag')
-  })
-
-  describe('loosely valid record keys', () => {
-    testLoose('at://did:plc:asdf123/com.atproto.feed.post/%23')
-
-    testLoose('at://did:plc:asdf123/com.atproto.feed.post/$@!*)(:,;~.sdf123')
-    testLoose("at://did:plc:asdf123/com.atproto.feed.post/~'sdf123")
-
-    testLoose('at://did:plc:asdf123/com.atproto.feed.post/$')
-    testLoose('at://did:plc:asdf123/com.atproto.feed.post/@')
-    testLoose('at://did:plc:asdf123/com.atproto.feed.post/!')
-    testLoose('at://did:plc:asdf123/com.atproto.feed.post/*')
-    testLoose('at://did:plc:asdf123/com.atproto.feed.post/(')
-    testLoose('at://did:plc:asdf123/com.atproto.feed.post/,')
-    testLoose('at://did:plc:asdf123/com.atproto.feed.post/;')
-    testLoose('at://did:plc:asdf123/com.atproto.feed.post/abc%30123')
-
-    testLoose('at://did:plc:asdf123/com.atproto.feed.post/%30')
-    testLoose('at://did:plc:asdf123/com.atproto.feed.post/%3')
-    testLoose('at://did:plc:asdf123/com.atproto.feed.post/%')
-    testLoose('at://did:plc:asdf123/com.atproto.feed.post/%zz')
-    testLoose('at://did:plc:asdf123/com.atproto.feed.post/%%%')
-
-    testLoose('at://did:plc:asdf123/com.atproto.feed.post/[]')
-    testLoose('at://did:plc:asdf123/com.atproto.feed.post/foo[')
-    testLoose('at://did:plc:asdf123/com.atproto.feed.post/bar]')
-    testLoose('at://did:plc:asdf123/com.atproto.feed.post/[baz]')
-  })
-
-  describe('valid fragment', () => {
-    testValid('at://did:plc:asdf123#/frac')
-  })
-
-  describe('invalid fragment', () => {
-    testValid('at://did:plc:asdf123#/com.atproto.feed.post')
-    testValid('at://did:plc:asdf123#/com.atproto.feed.post/')
-    testValid('at://did:plc:asdf123#/asdf/')
-
-    testValid('at://did:plc:asdf123/com.atproto.feed.post#/$@!*():,;~.sdf123')
-    testValid('at://did:plc:asdf123#/[asfd]')
-
-    testValid('at://did:plc:asdf123#/$')
-    testValid('at://did:plc:asdf123#/*')
-    testValid('at://did:plc:asdf123#/;')
-    testValid('at://did:plc:asdf123#/,')
-
-    testInvalid('at://did:plc:asdf123#')
-    testInvalid('at://did:plc:asdf123##')
-    testInvalid('#at://did:plc:asdf123')
-    testInvalid('at://did:plc:asdf123#/asdf#/asdf')
-  })
-})
-
-function testValid(value: string) {
-  test(value, () => {
-    expect(isAtUriString(value)).toBe(true)
-    expect(isAtUriString(value, { strict: false })).toBe(true)
-    expect(() => assertAtUriString(value)).not.toThrow()
-    expect(() => assertAtUriString(value, { strict: false })).not.toThrow()
-  })
-}
-
-function testInvalid(value: string) {
-  test(value, () => {
-    expect(isAtUriString(value)).toBe(false)
-    expect(() => assertAtUriString(value)).toThrow(InvalidAtUriError)
-  })
-}
-
-function testLoose(value: string) {
-  test(value, () => {
-    expect(isAtUriString(value)).toBe(false)
-    expect(isAtUriString(value, { strict: false })).toBe(true)
-    expect(() => assertAtUriString(value)).toThrow()
-    expect(() => assertAtUriString(value, { strict: false })).not.toThrow()
-  })
-}
-
-function readLines(filePath: string): string[] {
-  return readFileSync(filePath, 'utf-8')
-    .split(/\r?\n/)
-    .filter((line) => !line.startsWith('#') && line.length > 0)
-}