@atproto/common 0.6.4 → 0.6.5

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @atproto/common
 
+## 0.6.5
+
+### Patch Changes
+
+- [#5099](https://github.com/bluesky-social/atproto/pull/5099) [`b43ec31`](https://github.com/bluesky-social/atproto/commit/b43ec31f247f4461725b01226885f88bd430ca07) Thanks [@matthieusieben](https://github.com/matthieusieben)! - Update TypeScript build to rely on references to composite internal projects
+
+- [#5099](https://github.com/bluesky-social/atproto/pull/5099) [`b43ec31`](https://github.com/bluesky-social/atproto/commit/b43ec31f247f4461725b01226885f88bd430ca07) Thanks [@matthieusieben](https://github.com/matthieusieben)! - Bundle only necessary files in the NPM tarball, including the `CHANGELOG.md` and `README.md` files (if present).
+
+- [#5099](https://github.com/bluesky-social/atproto/pull/5099) [`b43ec31`](https://github.com/bluesky-social/atproto/commit/b43ec31f247f4461725b01226885f88bd430ca07) Thanks [@matthieusieben](https://github.com/matthieusieben)! - Build with `noImplicitAny` enabled
+
+- Updated dependencies [[`b43ec31`](https://github.com/bluesky-social/atproto/commit/b43ec31f247f4461725b01226885f88bd430ca07), [`b43ec31`](https://github.com/bluesky-social/atproto/commit/b43ec31f247f4461725b01226885f88bd430ca07), [`b43ec31`](https://github.com/bluesky-social/atproto/commit/b43ec31f247f4461725b01226885f88bd430ca07)]:
+  - @atproto/lex-cbor@0.1.3
+  - @atproto/lex-data@0.1.4
+  - @atproto/common-web@0.5.3
+
 ## 0.6.4
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atproto/common",
-  "version": "0.6.4",
+  "version": "0.6.5",
   "license": "MIT",
   "description": "Shared web-platform-friendly code for atproto libraries",
   "keywords": [
@@ -12,27 +12,32 @@
     "url": "https://github.com/bluesky-social/atproto",
     "directory": "packages/common"
   },
+  "files": [
+    "./dist",
+    "./README.md",
+    "./CHANGELOG.md"
+  ],
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
   "engines": {
     "node": ">=22"
   },
   "dependencies": {
     "multiformats": "^13.0.0",
     "pino": "^10.3.1",
-    "@atproto/common-web": "^0.5.2",
-    "@atproto/lex-cbor": "^0.1.2",
-    "@atproto/lex-data": "^0.1.3"
+    "@atproto/lex-cbor": "^0.1.3",
+    "@atproto/lex-data": "^0.1.4",
+    "@atproto/common-web": "^0.5.3"
   },
   "devDependencies": {
     "jest": "^30.0.0",
     "uint8arrays": "^5.0.0"
   },
-  "type": "module",
-  "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "default": "./dist/index.js"
-    }
-  },
   "scripts": {
     "test": "NODE_OPTIONS=--experimental-vm-modules jest",
     "build": "tsgo --build tsconfig.build.json"

package/jest.config.cjs

@@ -1,21 +0,0 @@
-/** @type {import('jest').Config} */
-module.exports = {
-  displayName: 'Common',
-  transform: {
-    '^.+\\.(t|j)s$': [
-      '@swc/jest',
-      {
-        jsc: {
-          parser: { syntax: 'typescript', importAttributes: true },
-          experimental: { keepImportAttributes: true },
-          transform: {},
-        },
-        module: { type: 'es6' },
-      },
-    ],
-  },
-  extensionsToTreatAsEsm: ['.ts'],
-  transformIgnorePatterns: [],
-  setupFiles: ['<rootDir>/../../test.setup.ts'],
-  moduleNameMapper: { '^(\\.\\.?\\/.+)\\.js$': ['$1.ts', '$1.js'] },
-}

package/src/buffers.ts

@@ -1,14 +0,0 @@
-export function ui8ToBuffer(bytes: Uint8Array): Buffer {
-  return Buffer.from(bytes.buffer, bytes.byteOffset, bytes.byteLength)
-}
-
-export function ui8ToArrayBuffer(bytes: Uint8Array): ArrayBuffer {
-  if (bytes.buffer instanceof ArrayBuffer) {
-    return bytes.buffer.slice(
-      bytes.byteOffset,
-      bytes.byteLength + bytes.byteOffset,
-    )
-  }
-
-  return new Uint8Array(bytes).buffer
-}

package/src/dates.ts

@@ -1,20 +0,0 @@
-// Normalize date strings to simplified ISO so that the lexical sort preserves temporal sort.
-// Rather than failing on an invalid date format, returns valid unix epoch.
-export function toSimplifiedISOSafe(dateStr: string) {
-  const date = new Date(dateStr)
-  if (isNaN(date.getTime())) {
-    return new Date(0).toISOString()
-  }
-  const iso = date.toISOString()
-
-  // Date.toISOString() always returns `YYYY-MM-DDTHH:mm:ss.sssZ` or
-  // `±YYYYYY-MM-DDTHH:mm:ss.sssZ`
-  // (https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString)
-  // However, the leading `±` and 6 digit year can break lexical sorting, so we
-  // need to catch those cases and return a safe value.
-  if (iso.startsWith('-') || iso.startsWith('+')) {
-    return new Date(0).toISOString()
-  }
-
-  return iso // YYYY-MM-DDTHH:mm:ss.sssZ
-}

package/src/env.ts

@@ -1,25 +0,0 @@
-import { parseIntWithFallback } from '@atproto/common-web'
-
-export const envInt = (name: string): number | undefined => {
-  const str = process.env[name]
-  return parseIntWithFallback(str, undefined)
-}
-
-export const envStr = (name: string): string | undefined => {
-  const str = process.env[name]
-  if (str === undefined || str.length === 0) return undefined
-  return str
-}
-
-export const envBool = (name: string): boolean | undefined => {
-  const str = process.env[name]
-  if (str === 'true' || str === '1') return true
-  if (str === 'false' || str === '0') return false
-  return undefined
-}
-
-export const envList = (name: string): string[] => {
-  const str = process.env[name]
-  if (str === undefined || str.length === 0) return []
-  return str.split(',')
-}

package/src/fs.ts

@@ -1,54 +0,0 @@
-import { constants } from 'node:fs'
-import fs from 'node:fs/promises'
-import { isErrnoException } from '@atproto/common-web'
-
-export const fileExists = async (location: string): Promise<boolean> => {
-  try {
-    await fs.access(location, constants.F_OK)
-    return true
-  } catch (err) {
-    if (isErrnoException(err) && err.code === 'ENOENT') {
-      return false
-    }
-    throw err
-  }
-}
-
-export const readIfExists = async (
-  filepath: string,
-): Promise<Uint8Array | undefined> => {
-  try {
-    return await fs.readFile(filepath)
-  } catch (err) {
-    if (isErrnoException(err) && err.code === 'ENOENT') {
-      return
-    }
-    throw err
-  }
-}
-
-export const rmIfExists = async (
-  filepath: string,
-  recursive = false,
-): Promise<void> => {
-  await fs.rm(filepath, {
-    force: true, // ignore errors if the file/directory does not exist
-    recursive,
-    maxRetries: 5,
-    retryDelay: 50,
-  })
-}
-
-export const renameIfExists = async (
-  oldPath: string,
-  newPath: string,
-): Promise<void> => {
-  try {
-    await fs.rename(oldPath, newPath)
-  } catch (err) {
-    if (isErrnoException(err) && err.code === 'ENOENT') {
-      return
-    }
-    throw err
-  }
-}

package/src/index.ts

@@ -1,10 +0,0 @@
-export * from '@atproto/common-web'
-export * from './buffers.js'
-export * from './dates.js'
-export * from './env.js'
-export * from './fs.js'
-export * from './ipld.js'
-export * from './ipld-multi.js'
-export * from './logger.js'
-export * from './obfuscate.js'
-export * from './streams.js'

package/src/ipld-multi.ts

@@ -1,9 +0,0 @@
-import { decodeAll } from '@atproto/lex-cbor'
-import { LexValue } from '@atproto/lex-data'
-
-/**
- * @deprecated Use {@link decodeAll} from `@atproto/lex-cbor` instead.
- */
-export function cborDecodeMulti(encoded: Uint8Array): LexValue[] {
-  return Array.from(decodeAll(encoded))
-}

package/src/ipld.ts

@@ -1,138 +0,0 @@
-import { createHash } from 'node:crypto'
-import { Transform } from 'node:stream'
-import { encode as encodeBlock } from 'multiformats/block'
-import type { BlockView, ByteView } from 'multiformats/block/interface'
-import { sha256 as hasher } from 'multiformats/hashes/sha2'
-import { cidForLex, decode, encode } from '@atproto/lex-cbor'
-import {
-  CBOR_DATA_CODEC,
-  type CID,
-  Cid,
-  LexValue,
-  asMultiformatsCID,
-  // eslint-disable-next-line
-  cidForCbor,
-  cidForRawHash,
-  decodeCid,
-  isCidForBytes,
-  isTypedLexMap,
-  validateCidString,
-} from '@atproto/lex-data'
-
-/**
- * @deprecated Use {@link encode} from `@atproto/lex-cbor` instead.
- */
-const cborEncodeLegacy = encode as <T = unknown>(data: T) => ByteView<T>
-export { cborEncodeLegacy as cborEncode }
-
-/**
- * @deprecated Use {@link decode} from `@atproto/lex-cbor` instead.
- */
-const cborDecodeLegacy = decode as <T = unknown>(bytes: ByteView<T>) => T
-export { cborDecodeLegacy as cborDecode }
-
-/**
- * @deprecated Use {@link encode} and {@link cidForCbor} from `@atproto/lex-cbor` instead.
- */
-export async function dataToCborBlock<T>(
-  value: T,
-): Promise<BlockView<T, 0x71, 0x12, 1>> {
-  return encodeBlock<T, 0x71, 0x12>({
-    value,
-    codec: {
-      name: 'at-cbor', // Not actually used
-      code: CBOR_DATA_CODEC,
-      encode: encode as (data: T) => ByteView<T>,
-    },
-    hasher,
-  })
-}
-
-/**
- * @deprecated Use {@link cidForLex} from `@atproto/lex-cbor` instead.
- */
-async function cidForCborLegacy(data: unknown): Promise<CID> {
-  return asMultiformatsCID(await cidForLex(data as LexValue))
-}
-export { cidForCborLegacy as cidForCbor }
-
-/**
- * @deprecated Use {@link validateCidString} from '@atproto/lex-data' instead.
- */
-export async function isValidCid(cidStr: string): Promise<boolean> {
-  // @NOTE we keep the wrapper function to return a Promise (for backward
-  // compatibility).
-  return validateCidString(cidStr)
-}
-
-/**
- * @deprecated Use {@link decode} from `@atproto/lex-cbor`, and {@link isTypedLexMap} from `@atproto/lex-data` instead.
- */
-export function cborBytesToRecord(bytes: Uint8Array): Record<string, unknown> {
-  const data = decode(bytes) as LexValue
-  if (isTypedLexMap(data)) return data
-
-  throw new Error(`Expected record with $type property`)
-}
-
-/**
- * @deprecated Use {@link isCidForBytes} from `@atproto/lex-cbor` instead.
- */
-export async function verifyCidForBytes(
-  cid: Cid,
-  bytes: Uint8Array,
-): Promise<void> {
-  if (!(await isCidForBytes(cid, bytes))) {
-    throw new Error(`Not a valid CID for bytes (${cid.toString()})`)
-  }
-}
-
-/**
- * @deprecated Use {@link cidForRawHash} from `@atproto/lex-cbor` instead.
- */
-export function sha256RawToCid(hash: Uint8Array): CID {
-  return asMultiformatsCID(cidForRawHash(hash))
-}
-
-/**
- * @deprecated Use {@link decodeCid} from `@atproto/lex-cbor` instead.
- */
-export function parseCidFromBytes(bytes: Uint8Array): CID {
-  return asMultiformatsCID(decodeCid(bytes, { flavor: 'dasl' }))
-}
-
-export class VerifyCidTransform extends Transform {
-  constructor(public cid: Cid) {
-    const hasher = createHash('sha256')
-    super({
-      transform(chunk, encoding, callback) {
-        hasher.update(chunk)
-        callback(null, chunk)
-      },
-      flush(callback) {
-        try {
-          const actual = sha256RawToCid(hasher.digest())
-          if (actual.equals(cid)) {
-            return callback()
-          } else {
-            return callback(new VerifyCidError(cid, actual))
-          }
-        } catch (err) {
-          return callback(asError(err))
-        }
-      },
-    })
-  }
-}
-
-const asError = (err: unknown): Error =>
-  err instanceof Error ? err : new Error('Unexpected error', { cause: err })
-
-export class VerifyCidError extends Error {
-  constructor(
-    public expected: Cid,
-    public actual: Cid,
-  ) {
-    super('Bad cid check')
-  }
-}

package/src/logger.ts

@@ -1,29 +0,0 @@
-import { type Logger, destination, pino } from 'pino'
-
-const enabled = /^(true|t|1)$/i.test(process.env.LOG_ENABLED ?? '0')
-const dest = process.env.LOG_DESTINATION
-const level = process.env.LOG_LEVEL || 'info'
-const systems = process.env.LOG_SYSTEMS?.trim()
-  ? process.env.LOG_SYSTEMS.replace(',', ' ').split(/\s+/).filter(Boolean)
-  : null
-
-const rootLogger = pino(
-  { enabled, level },
-  dest ? destination(dest) : undefined,
-)
-
-const subsystems = new Map<string, Logger>()
-
-export const subsystemLogger = (name: string): Logger => {
-  if (subsystems.has(name)) return subsystems.get(name)!
-
-  // can't disable child loggers, so we just set their level to "silent"
-  // to effectively turn them off
-  const subsystemEnabled = !systems || systems.includes(name)
-  const subsystemLevel = enabled && subsystemEnabled ? level : 'silent'
-
-  const logger = rootLogger.child({ name }, { level: subsystemLevel })
-
-  subsystems.set(name, logger)
-  return logger
-}

package/src/obfuscate.ts

@@ -1,85 +0,0 @@
-export function obfuscateEmail(email: string) {
-  const [local, domain] = email.split('@')
-  return `${obfuscateWord(local)}@${obfuscateWord(domain)}`
-}
-
-export function obfuscateWord(word: string) {
-  return `${word.charAt(0)}***${word.charAt(word.length - 1)}`
-}
-
-export function obfuscateHeaders(headers: Record<string, string>) {
-  const obfuscatedHeaders: Record<string, string> = {}
-  for (const key in headers) {
-    if (key.toLowerCase() === 'authorization') {
-      obfuscatedHeaders[key] = obfuscateAuthHeader(headers[key])
-    } else if (key.toLowerCase() === 'dpop') {
-      obfuscatedHeaders[key] = obfuscateJwt(headers[key]) || 'Invalid'
-    } else {
-      obfuscatedHeaders[key] = headers[key]
-    }
-  }
-  return obfuscatedHeaders
-}
-
-export function obfuscateAuthHeader(authHeader: string): string {
-  // This is a hot path (runs on every request). Avoid using split() or regex.
-
-  const spaceIdx = authHeader.indexOf(' ')
-  if (spaceIdx === -1) return 'Invalid'
-
-  const type = authHeader.slice(0, spaceIdx)
-  switch (type.toLowerCase()) {
-    case 'bearer':
-    case 'dpop':
-      return `${type} ${obfuscateBearer(authHeader.slice(spaceIdx + 1))}`
-    case 'basic':
-      return `${type} ${obfuscateBasic(authHeader.slice(spaceIdx + 1)) || 'Invalid'}`
-    default:
-      return `Invalid`
-  }
-}
-
-export function obfuscateBasic(token: string): null | string {
-  if (!token) return null
-  const buffer = Buffer.from(token, 'base64')
-  if (!buffer.length) return null // Buffer.from will silently ignore invalid base64 chars
-  const authHeader = buffer.toString('utf8')
-  const colIdx = authHeader.indexOf(':')
-  if (colIdx === -1) return null
-  const username = authHeader.slice(0, colIdx)
-  return `${username}:***`
-}
-
-export function obfuscateBearer(token: string): string {
-  return obfuscateJwt(token) || obfuscateToken(token)
-}
-
-export function obfuscateToken(token: string): string {
-  if (token.length >= 12) return obfuscateWord(token)
-  return token ? '***' : ''
-}
-
-export function obfuscateJwt(token: string): null | string {
-  const firstDot = token.indexOf('.')
-  if (firstDot === -1) return null
-
-  const secondDot = token.indexOf('.', firstDot + 1)
-  if (secondDot === -1) return null
-
-  // Expected to be missing
-  const thirdDot = token.indexOf('.', secondDot + 1)
-  if (thirdDot !== -1) return null
-
-  try {
-    const payloadEnc = token.slice(firstDot + 1, secondDot)
-    const payloadJson = Buffer.from(payloadEnc, 'base64').toString('utf8')
-    const payload = JSON.parse(payloadJson)
-    if (typeof payload.sub === 'string') return payload.sub
-  } catch {
-    // Invalid JWT
-    return null
-  }
-
-  // Strip the signature
-  return token.slice(0, secondDot) + '.obfuscated'
-}