@atproto/api 0.20.23 → 0.20.25

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @atproto/api
 
+## 0.20.25
+
+### Patch Changes
+
+- [#5179](https://github.com/bluesky-social/atproto/pull/5179) [`f6409db`](https://github.com/bluesky-social/atproto/commit/f6409dbcefdd5565b1ba23c52dc71ec7e791e2e9) Thanks [@estrattonbailey](https://github.com/estrattonbailey)! - Support the new timestamp field, along with transactionId and errorCode, on KWS age verification status payloads. Add additionalVerificationMethods to Age Assurance config.
+
+## 0.20.24
+
+### 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).
+
+- Updated dependencies [[`28a0b58`](https://github.com/bluesky-social/atproto/commit/28a0b588147863eaef948cd2bb8fc0f19d08cda9), [`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), [`b43ec31`](https://github.com/bluesky-social/atproto/commit/b43ec31f247f4461725b01226885f88bd430ca07)]:
+  - @atproto/syntax@0.6.4
+  - @atproto/common-web@0.5.3
+  - @atproto/lexicon@0.7.4
+  - @atproto/xrpc@0.8.3
+
 ## 0.20.23
 
 ### Patch Changes

package/package.json

@@ -1,9 +1,6 @@
 {
   "name": "@atproto/api",
-  "version": "0.20.23",
-  "engines": {
-    "node": ">=22"
-  },
+  "version": "0.20.25",
   "license": "MIT",
   "description": "Client library for atproto and Bluesky",
   "keywords": [
@@ -17,29 +14,38 @@
     "url": "https://github.com/bluesky-social/atproto",
     "directory": "packages/api"
   },
+  "files": [
+    "./dist",
+    "./OAUTH.md",
+    "./README.md",
+    "./CHANGELOG.md"
+  ],
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "engines": {
+    "node": ">=22"
+  },
   "dependencies": {
     "await-lock": "^3.0.0",
     "multiformats": "^13.0.0",
     "tlds": "^1.234.0",
     "zod": "^3.23.8",
-    "@atproto/lexicon": "^0.7.3",
-    "@atproto/common-web": "^0.5.2",
-    "@atproto/syntax": "^0.6.3",
-    "@atproto/xrpc": "^0.8.2"
+    "@atproto/common-web": "^0.5.3",
+    "@atproto/syntax": "^0.6.4",
+    "@atproto/xrpc": "^0.8.3",
+    "@atproto/lexicon": "^0.7.4"
   },
   "devDependencies": {
     "@jest/globals": "^28.1.3",
     "http-terminator": "^3.2.0",
     "jest": "^30.0.0",
     "prettier": "^3.2.5",
-    "@atproto/lex-cli": "^0.10.2"
-  },
-  "type": "module",
-  "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "default": "./dist/index.js"
-    }
+    "@atproto/lex-cli": "^0.10.3"
   },
   "scripts": {
     "codegen:lex": "lex gen-api --yes ./src/client ../../lexicons/com/atproto/*/* ../../lexicons/app/bsky/*/* ../../lexicons/chat/bsky/*/* ../../lexicons/tools/ozone/*/* ../../lexicons/com/germnetwork/*",

package/definitions/labels.json

@@ -1,170 +0,0 @@
-[
-  {
-    "identifier": "!hide",
-    "configurable": false,
-    "defaultSetting": "hide",
-    "flags": ["no-override", "no-self"],
-    "severity": "alert",
-    "blurs": "content",
-    "behaviors": {
-      "account": {
-        "profileList": "blur",
-        "profileView": "blur",
-        "avatar": "blur",
-        "banner": "blur",
-        "displayName": "blur",
-        "contentList": "blur",
-        "contentView": "blur"
-      },
-      "profile": {
-        "avatar": "blur",
-        "banner": "blur",
-        "displayName": "blur"
-      },
-      "content": {
-        "contentList": "blur",
-        "contentView": "blur"
-      }
-    }
-  },
-  {
-    "identifier": "!warn",
-    "configurable": false,
-    "defaultSetting": "warn",
-    "flags": ["no-self"],
-    "severity": "none",
-    "blurs": "content",
-    "behaviors": {
-      "account": {
-        "profileList": "blur",
-        "profileView": "blur",
-        "avatar": "blur",
-        "banner": "blur",
-        "contentList": "blur",
-        "contentView": "blur"
-      },
-      "profile": {
-        "avatar": "blur",
-        "banner": "blur",
-        "displayName": "blur"
-      },
-      "content": {
-        "contentList": "blur",
-        "contentView": "blur"
-      }
-    }
-  },
-  {
-    "identifier": "!no-unauthenticated",
-    "configurable": false,
-    "defaultSetting": "hide",
-    "flags": ["no-override", "unauthed"],
-    "severity": "none",
-    "blurs": "content",
-    "behaviors": {
-      "account": {
-        "profileList": "blur",
-        "profileView": "blur",
-        "avatar": "blur",
-        "banner": "blur",
-        "displayName": "blur",
-        "contentList": "blur",
-        "contentView": "blur"
-      },
-      "profile": {
-        "avatar": "blur",
-        "banner": "blur",
-        "displayName": "blur"
-      },
-      "content": {
-        "contentList": "blur",
-        "contentView": "blur"
-      }
-    }
-  },
-  {
-    "identifier": "porn",
-    "configurable": true,
-    "defaultSetting": "hide",
-    "flags": ["adult"],
-    "severity": "none",
-    "blurs": "media",
-    "behaviors": {
-      "account": {
-        "avatar": "blur",
-        "banner": "blur"
-      },
-      "profile": {
-        "avatar": "blur",
-        "banner": "blur"
-      },
-      "content": {
-        "contentMedia": "blur"
-      }
-    }
-  },
-  {
-    "identifier": "sexual",
-    "configurable": true,
-    "defaultSetting": "warn",
-    "flags": ["adult"],
-    "severity": "none",
-    "blurs": "media",
-    "behaviors": {
-      "account": {
-        "avatar": "blur",
-        "banner": "blur"
-      },
-      "profile": {
-        "avatar": "blur",
-        "banner": "blur"
-      },
-      "content": {
-        "contentMedia": "blur"
-      }
-    }
-  },
-  {
-    "identifier": "nudity",
-    "configurable": true,
-    "defaultSetting": "ignore",
-    "flags": [],
-    "severity": "none",
-    "blurs": "media",
-    "behaviors": {
-      "account": {
-        "avatar": "blur",
-        "banner": "blur"
-      },
-      "profile": {
-        "avatar": "blur",
-        "banner": "blur"
-      },
-      "content": {
-        "contentMedia": "blur"
-      }
-    }
-  },
-  {
-    "identifier": "graphic-media",
-    "alias": ["gore"],
-    "flags": ["adult"],
-    "configurable": true,
-    "defaultSetting": "warn",
-    "severity": "none",
-    "blurs": "media",
-    "behaviors": {
-      "account": {
-        "avatar": "blur",
-        "banner": "blur"
-      },
-      "profile": {
-        "avatar": "blur",
-        "banner": "blur"
-      },
-      "content": {
-        "contentMedia": "blur"
-      }
-    }
-  }
-]

package/docs/moderation.md

@@ -1,260 +0,0 @@
-# Moderation API
-
-Applying the moderation system is a challenging task, but we've done our best to simplify it for you. The Moderation API helps handle a wide range of tasks, including:
-
-- Moderator labeling
-- User muting (including mutelists)
-- User blocking
-- Mutewords
-- Hidden posts
-
-## Configuration
-
-Every moderation function takes a set of options which look like this:
-
-```typescript
-{
-  // the logged-in user's DID
-  userDid: 'did:plc:1234...',
-
-  moderationPrefs: {
-    // is adult content allowed?
-    adultContentEnabled: true,
-
-    // the global label settings (used on self-labels)
-    labels: {
-      porn: 'hide',
-      sexual: 'warn',
-      nudity: 'ignore',
-      // ...
-    },
-
-    // the subscribed labelers and their label settings
-    labelers: [
-      {
-        did: 'did:plc:1234...',
-        labels: {
-          porn: 'hide',
-          sexual: 'warn',
-          nudity: 'ignore',
-          // ...
-        }
-      }
-    ],
-
-    mutedWords: [/* ... */],
-    hiddenPosts: [/* ... */]
-  },
-
-  // custom label definitions
-  labelDefs: {
-    // labelerDid => defs[]
-    'did:plc:1234...': [
-      /* ... */
-    ]
-  }
-}
-```
-
-This should match the following interfaces:
-
-```typescript
-export interface ModerationPrefsLabeler {
-  did: string
-  labels: Record<string, LabelPreference>
-}
-
-export interface ModerationPrefs {
-  adultContentEnabled: boolean
-  labels: Record<string, LabelPreference>
-  labelers: ModerationPrefsLabeler[]
-  mutedWords: AppBskyActorDefs.MutedWord[]
-  hiddenPosts: string[]
-}
-
-export interface ModerationOpts {
-  userDid: string | undefined
-  prefs: ModerationPrefs
-  /**
-   * Map of labeler did -> custom definitions
-   */
-  labelDefs?: Record<string, InterpretedLabelValueDefinition[]>
-}
-```
-
-You can quickly grab the `ModerationPrefs` using the `agent.getPreferences()` method:
-
-```typescript
-const prefs = await agent.getPreferences()
-moderatePost(post, {
-  userDid: /*...*/,
-  prefs: prefs.moderationPrefs,
-  labelDefs: /*...*/
-})
-```
-
-To gather the label definitions (`labelDefs`) see the _Labelers_ section below.
-
-## Labelers
-
-Labelers are services that provide moderation labels. Your application will typically have 1+ top-level labelers set with the ability to do "takedowns" on content. This is controlled via this static function, though the default is to use Bluesky's moderation:
-
-```typescript
-BskyAgent.configure({
-  appLabelers: ['did:web:my-labeler.com'],
-})
-```
-
-Users may also add their own labelers. The active labelers are controlled via an HTTP header which is automatically set by the agent when `getPreferences` is called, or when the labeler preferences are changed.
-
-Labelers publish a `app.bsky.labeler.service` record that looks like this:
-
-```js
-{
-  $type: 'app.bsky.labeler.service',
-  policies: {
-    // the list of label values the labeler will publish
-    labelValues: [
-      'rude',
-    ],
-    // any custom definitions the labeler will be using
-    labelValueDefinitions: [
-      {
-        identifier: 'rude',
-        blurs: 'content',
-        severity: 'alert',
-        defaultSetting: 'warn',
-        adultOnly: false,
-        locales: [
-          {
-            lang: 'en',
-            name: 'Rude',
-            description: 'Not keeping things civil.',
-          },
-        ],
-      },
-    ],
-  },
-  createdAt: '2024-03-12T17:17:17.215Z'
-}
-```
-
-The label value definition are custom labels which only apply to that labeler. Your client needs to sync those definitions in order to correctly interpret them. To do that, call `app.bsky.labeler.getService()` (or the `getServices` batch variant) periodically to fetch their definitions. We recommend caching the response (at time our writing the official client uses a TTL of 6 hours).
-
-Here is how to do this:
-
-```typescript
-import { AtpAgent } from '@atproto/api'
-
-const agent = new AtpAgent({ service: 'https://example.com' })
-// assume `agent` is a signed in session
-const prefs = await agent.getPreferences()
-const labelDefs = await agent.getLabelDefinitions(prefs)
-
-moderatePost(post, {
-  userDid: agent.session.did,
-  prefs: prefs.moderationPrefs,
-  labelDefs,
-})
-```
-
-## The `moderate*()` APIs
-
-The SDK exports methods to moderate the different kinds of content on the network.
-
-```typescript
-import {
-  moderateProfile,
-  moderatePost,
-  moderateNotification,
-  moderateFeedGen,
-  moderateUserList,
-  moderateLabeler,
-} from '@atproto/api'
-```
-
-Each of these follows the same API signature:
-
-```typescript
-const res = moderatePost(post, moderationOptions)
-```
-
-The response object provides an API for figuring out what your UI should do in different contexts.
-
-```typescript
-res.ui(context) /* =>
-
-ModerationUI {
-  filter: boolean // should the content be removed from the interface?
-  blur: boolean // should the content be put behind a cover?
-  alert: boolean // should an alert be put on the content? (negative)
-  inform: boolean // should an informational notice be put on the content? (neutral)
-  noOverride: boolean // if blur=true, should the UI disable opening the cover?
-
-  // the reasons for each of the flags:
-  filters: ModerationCause[]
-  blurs: ModerationCause[]
-  alerts: ModerationCause[]
-  informs: ModerationCause[]
-}
-*/
-```
-
-There are multiple UI contexts available:
-
-- `profileList` A profile being listed, eg in search or a follower list
-- `profileView` A profile being viewed directly
-- `avatar` The user's avatar in any context
-- `banner` The user's banner in any context
-- `displayName` The user's display name in any context
-- `contentList` Content being listed, eg posts in a feed, posts as replies, a user list list, a feed generator list, etc
-- `contentView` Content being viewed direct, eg an opened post, the user list page, the feedgen page, etc
-- `contentMedia ` Media inside the content, eg a picture embedded in a post
-
-Here's how a post in a feed would use these tools to make a decision:
-
-```typescript
-const mod = moderatePost(post, moderationOptions)
-
-if (mod.ui('contentList').filter) {
-  // dont show the post
-}
-if (mod.ui('contentList').blur) {
-  // cover the post with the explanation from mod.ui('contentList').blurs[0]
-  if (mod.ui('contentList').noOverride) {
-    // dont allow the cover to be removed
-  }
-}
-if (mod.ui('contentMedia').blur) {
-  // cover the post's embedded images with the explanation from mod.ui('contentMedia').blurs[0]
-  if (mod.ui('contentMedia').noOverride) {
-    // dont allow the cover to be removed
-  }
-}
-if (mod.ui('avatar').blur) {
-  // cover the avatar with the explanation from mod.ui('avatar').blurs[0]
-  if (mod.ui('avatar').noOverride) {
-    // dont allow the cover to be removed
-  }
-}
-for (const alert of mod.ui('contentList').alerts) {
-  // render this alert
-}
-for (const inform of mod.ui('contentList').informs) {
-  // render this inform
-}
-```
-
-## Sending moderation reports
-
-Any Labeler is capable of receiving moderation reports. As a result, you need to specify which labeler should receive the report. You do this with the `Atproto-Proxy` header:
-
-```typescript
-agent
-  .withProxy('atproto_labeler', 'did:web:my-labeler.com')
-  .createModerationReport({
-    reasonType: 'com.atproto.moderation.defs#reasonViolation',
-    reason: 'They were being such a jerk to me!',
-    subject: { did: 'did:web:bob.com' },
-  })
-```

package/jest.config.cjs

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

package/jest.d.ts

@@ -1,20 +0,0 @@
-declare namespace jest {
-  // eslint-disable-next-line
-  interface Matchers<R, T = {}> {
-    toBeModerationResult(
-      expected: ModerationTestSuiteResultFlag[] | undefined,
-      context?: string,
-      stringifiedResult?: string,
-      ignoreCause?: boolean,
-    ): R
-  }
-
-  interface Expect {
-    toBeModerationResult(
-      expected: ModerationTestSuiteResultFlag[] | undefined,
-      context?: string,
-      stringifiedResult?: string,
-      ignoreCause?: boolean,
-    ): void
-  }
-}

package/jest.setup.ts

@@ -1,97 +0,0 @@
-import { ModerationUI } from './src/index.js'
-import { ModerationTestSuiteResultFlag } from './tests/util/moderation-behavior.js'
-
-expect.extend({
-  toBeModerationResult(
-    actual: ModerationUI,
-    expected: ModerationTestSuiteResultFlag[] | undefined,
-    context = '',
-    stringifiedResult: string | undefined = undefined,
-    _ignoreCause = false,
-  ) {
-    const fail = (msg: string) => ({
-      pass: false,
-      message: () =>
-        `${msg}.${
-          stringifiedResult ? ` Full result: ${stringifiedResult}` : ''
-        }`,
-    })
-    // let cause = actual.causes?.type as string
-    // if (actual.cause?.type === 'label') {
-    //   cause = `label:${actual.cause.labelDef.id}`
-    // } else if (actual.cause?.type === 'muted') {
-    //   if (actual.cause.source.type === 'list') {
-    //     cause = 'muted-by-list'
-    //   }
-    // } else if (actual.cause?.type === 'blocking') {
-    //   if (actual.cause.source.type === 'list') {
-    //     cause = 'blocking-by-list'
-    //   }
-    // }
-    if (!expected) {
-      // if (!ignoreCause && actual.cause) {
-      //   return fail(`${context} expected to be a no-op, got ${cause}`)
-      // }
-      if (actual.inform) {
-        return fail(`${context} expected to be a no-op, got inform=true`)
-      }
-      if (actual.alert) {
-        return fail(`${context} expected to be a no-op, got alert=true`)
-      }
-      if (actual.blur) {
-        return fail(`${context} expected to be a no-op, got blur=true`)
-      }
-      if (actual.filter) {
-        return fail(`${context} expected to be a no-op, got filter=true`)
-      }
-      if (actual.noOverride) {
-        return fail(`${context} expected to be a no-op, got noOverride=true`)
-      }
-    } else {
-      // if (!ignoreCause && cause !== expected.cause) {
-      //   return fail(`${context} expected to be ${expected.cause}, got ${cause}`)
-      // }
-      const expectedInform = expected.includes('inform')
-      if (!!actual.inform !== expectedInform) {
-        return fail(
-          `${context} expected to be inform=${expectedInform}, got ${
-            actual.inform || false
-          }`,
-        )
-      }
-      const expectedAlert = expected.includes('alert')
-      if (!!actual.alert !== expectedAlert) {
-        return fail(
-          `${context} expected to be alert=${expectedAlert}, got ${
-            actual.alert || false
-          }`,
-        )
-      }
-      const expectedBlur = expected.includes('blur')
-      if (!!actual.blur !== expectedBlur) {
-        return fail(
-          `${context} expected to be blur=${expectedBlur}, got ${
-            actual.blur || false
-          }`,
-        )
-      }
-      const expectedFilter = expected.includes('filter')
-      if (!!actual.filter !== expectedFilter) {
-        return fail(
-          `${context} expected to be filter=${expectedFilter}, got ${
-            actual.filter || false
-          }`,
-        )
-      }
-      const expectedNoOverride = expected.includes('noOverride')
-      if (!!actual.noOverride !== expectedNoOverride) {
-        return fail(
-          `${context} expected to be noOverride=${expectedNoOverride}, got ${
-            actual.noOverride || false
-          }`,
-        )
-      }
-    }
-    return { pass: true, message: () => '' }
-  },
-})