@atproto/common-web 0.2.4 → 0.3.1

package/jest.config.js

@@ -1,6 +1,6 @@
-const base = require('../../jest.config.base.js')
-
+/** @type {import('jest').Config} */
 module.exports = {
-  ...base,
   displayName: 'Common Web',
+  transform: { '^.+\\.(t|j)s$': '@swc/jest' },
+  setupFiles: ['<rootDir>/../../jest.setup.ts'],
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atproto/common-web",
-  "version": "0.2.4",
+  "version": "0.3.1",
   "license": "MIT",
   "description": "Shared web-platform-friendly code for atproto libraries",
   "keywords": [
@@ -13,17 +13,18 @@
     "directory": "packages/common-web"
   },
   "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "dependencies": {
     "graphemer": "^1.4.0",
     "multiformats": "^9.9.0",
     "uint8arrays": "3.0.0",
-    "zod": "^3.21.4"
+    "zod": "^3.23.8"
+  },
+  "devDependencies": {
+    "jest": "^28.1.2"
   },
   "scripts": {
     "test": "jest",
-    "build": "node ./build.js",
-    "postbuild": "tsc --build tsconfig.build.json",
-    "update-main-to-dist": "node ../../update-main-to-dist.js packages/common-web"
-  },
-  "types": "dist/index.d.ts"
+    "build": "tsc --build tsconfig.build.json"
+  }
 }

package/src/arrays.ts

@@ -1,8 +1,11 @@
 export const keyBy = <T>(arr: T[], key: string): Record<string, T> => {
-  return arr.reduce((acc, cur) => {
-    acc[cur[key]] = cur
-    return acc
-  }, {} as Record<string, T>)
+  return arr.reduce(
+    (acc, cur) => {
+      acc[cur[key]] = cur
+      return acc
+    },
+    {} as Record<string, T>,
+  )
 }
 
 export const mapDefined = <T, S>(

package/src/check.ts

@@ -1,10 +1,11 @@
-import { ZodError } from 'zod'
+// Explicitly not using "zod" types here to avoid mismatching types due to
+// version differences.
 
 export interface Checkable<T> {
   parse: (obj: unknown) => T
   safeParse: (
     obj: unknown,
-  ) => { success: true; data: T } | { success: false; error: ZodError }
+  ) => { success: true; data: T } | { success: false; error: Error }
 }
 
 export interface Def<T> {
@@ -16,6 +17,11 @@ export const is = <T>(obj: unknown, def: Checkable<T>): obj is T => {
   return def.safeParse(obj).success
 }
 
+export const create =
+  <T>(def: Checkable<T>) =>
+  (v: unknown): v is T =>
+    def.safeParse(v).success
+
 export const assure = <T>(def: Checkable<T>, obj: unknown): T => {
   return def.parse(obj)
 }

package/src/did-doc.ts

@@ -17,11 +17,16 @@ export const getDid = (doc: DidDocument): string => {
 
 export const getHandle = (doc: DidDocument): string | undefined => {
   const aka = doc.alsoKnownAs
-  if (!aka) return undefined
-  const found = aka.find((name) => name.startsWith('at://'))
-  if (!found) return undefined
-  // strip off at:// prefix
-  return found.slice(5)
+  if (aka) {
+    for (let i = 0; i < aka.length; i++) {
+      const alias = aka[i]
+      if (alias.startsWith('at://')) {
+        // strip off "at://" prefix
+        return alias.slice(5)
+      }
+    }
+  }
+  return undefined
 }
 
 // @NOTE we parse to type/publicKeyMultibase to avoid the dependency on @atproto/crypto
@@ -35,20 +40,20 @@ export const getVerificationMaterial = (
   doc: DidDocument,
   keyId: string,
 ): { type: string; publicKeyMultibase: string } | undefined => {
-  const did = getDid(doc)
-  let keys = doc.verificationMethod
-  if (!keys) return undefined
-  if (typeof keys !== 'object') return undefined
-  if (!Array.isArray(keys)) {
-    keys = [keys]
+  // /!\ Hot path
+
+  const key = findItemById(doc, 'verificationMethod', `#${keyId}`)
+  if (!key) {
+    return undefined
+  }
+
+  if (!key.publicKeyMultibase) {
+    return undefined
   }
-  const found = keys.find(
-    (key) => key.id === `#${keyId}` || key.id === `${did}#${keyId}`,
-  )
-  if (!found?.publicKeyMultibase) return undefined
+
   return {
-    type: found.type,
-    publicKeyMultibase: found.publicKeyMultibase,
+    type: key.type,
+    publicKeyMultibase: key.publicKeyMultibase,
   }
 }
 
@@ -83,43 +88,82 @@ export const getServiceEndpoint = (
   doc: DidDocument,
   opts: { id: string; type?: string },
 ) => {
-  const did = getDid(doc)
-  let services = doc.service
-  if (!services) return undefined
-  if (typeof services !== 'object') return undefined
-  if (!Array.isArray(services)) {
-    services = [services]
+  // /!\ Hot path
+
+  const service = findItemById(doc, 'service', opts.id)
+  if (!service) {
+    return undefined
   }
-  const found = services.find(
-    (service) => service.id === opts.id || service.id === `${did}${opts.id}`,
-  )
-  if (!found) return undefined
-  if (opts.type && found.type !== opts.type) {
+
+  if (opts.type && service.type !== opts.type) {
     return undefined
   }
-  if (typeof found.serviceEndpoint !== 'string') {
+
+  if (typeof service.serviceEndpoint !== 'string') {
     return undefined
   }
-  return validateUrl(found.serviceEndpoint)
+
+  return validateUrl(service.serviceEndpoint)
+}
+
+function findItemById<
+  D extends DidDocument,
+  T extends 'verificationMethod' | 'service',
+>(doc: D, type: T, id: string): NonNullable<D[T]>[number] | undefined
+function findItemById(
+  doc: DidDocument,
+  type: 'verificationMethod' | 'service',
+  id: string,
+) {
+  // /!\ Hot path
+
+  const items = doc[type]
+  if (items) {
+    for (let i = 0; i < items.length; i++) {
+      const item = items[i]
+      const itemId = item.id
+
+      if (
+        itemId[0] === '#'
+          ? itemId === id
+          : // Optimized version of: itemId === `${doc.id}${id}`
+            itemId.length === doc.id.length + id.length &&
+            itemId[doc.id.length] === '#' &&
+            itemId.endsWith(id) &&
+            itemId.startsWith(doc.id) // <== We could probably skip this check
+      ) {
+        return item
+      }
+    }
+  }
+  return undefined
 }
 
 // Check protocol and hostname to prevent potential SSRF
 const validateUrl = (urlStr: string): string | undefined => {
-  let url
-  try {
-    url = new URL(urlStr)
-  } catch {
+  if (!urlStr.startsWith('http://') && !urlStr.startsWith('https://')) {
     return undefined
   }
-  if (!['http:', 'https:'].includes(url.protocol)) {
-    return undefined
-  } else if (!url.hostname) {
+
+  if (!canParseUrl(urlStr)) {
     return undefined
-  } else {
-    return urlStr
   }
+
+  return urlStr
 }
 
+const canParseUrl =
+  URL.canParse ??
+  // URL.canParse is not available in Node.js < 18.17.0
+  ((urlStr: string): boolean => {
+    try {
+      new URL(urlStr)
+      return true
+    } catch {
+      return false
+    }
+  })
+
 // Types
 // --------
 

package/src/util.ts

@@ -9,6 +9,21 @@ export const noUndefinedVals = <T>(
   return obj as Record<string, T>
 }
 
+export function omit<
+  T extends undefined | Record<string, unknown>,
+  K extends keyof NonNullable<T>,
+>(obj: T, keys: readonly K[]): T extends undefined ? undefined : Omit<T, K>
+export function omit(
+  obj: Record<string, unknown>,
+  keys: readonly string[],
+): undefined | Record<string, unknown> {
+  if (!obj) return obj
+
+  return Object.fromEntries(
+    Object.entries(obj).filter((entry) => !keys.includes(entry[0])),
+  )
+}
+
 export const jitter = (maxMs: number) => {
   return Math.round((Math.random() - 0.5) * maxMs * 2)
 }

package/tsconfig.build.json

@@ -1,4 +1,8 @@
 {
-  "extends": "./tsconfig.json",
-  "exclude": ["**/*.spec.ts", "**/*.test.ts"]
+  "extends": "../../tsconfig/isomorphic.json",
+  "compilerOptions": {
+    "rootDir": "./src",
+    "outDir": "./dist"
+  },
+  "include": ["./src"]
 }

package/tsconfig.json

@@ -1,9 +1,7 @@
 {
-  "extends": "../../tsconfig.json",
-  "compilerOptions": {
-    "rootDir": "./src",
-    "outDir": "./dist", // Your outDir,
-    "emitDeclarationOnly": true
-  },
-  "include": ["./src", "__tests__/**/**.ts"]
+  "include": [],
+  "references": [
+    { "path": "./tsconfig.build.json" },
+    { "path": "./tsconfig.tests.json" }
+  ]
 }

package/tsconfig.tests.json

@@ -0,0 +1,7 @@
+{
+  "extends": "../../tsconfig/tests.json",
+  "compilerOptions": {
+    "rootDir": "."
+  },
+  "include": ["./tests"]
+}

package/babel.config.js

@@ -1 +0,0 @@
-module.exports = require('../../babel.config.js')

package/build.js

@@ -1,15 +0,0 @@
-const { nodeExternalsPlugin } = require('esbuild-node-externals')
-
-const buildShallow =
-  process.argv.includes('--shallow') || process.env.ATP_BUILD_SHALLOW === 'true'
-
-require('esbuild').build({
-  logLevel: 'info',
-  entryPoints: ['src/index.ts'],
-  bundle: true,
-  sourcemap: true,
-  outdir: 'dist',
-  platform: 'browser',
-  format: 'cjs',
-  plugins: buildShallow ? [nodeExternalsPlugin()] : [],
-})