@atproto/api 0.11.0-next.0 → 0.11.1

package/CHANGELOG.md

@@ -1,5 +1,77 @@
 # @atproto/api
 
+## 0.11.1
+
+### Patch Changes
+
+- [#2312](https://github.com/bluesky-social/atproto/pull/2312) [`219480764`](https://github.com/bluesky-social/atproto/commit/2194807644cbdb0021e867437693300c1b0e55f5) Thanks [@pfrazee](https://github.com/pfrazee)! - Fixed an issue that would cause agent clones to drop the PDS URI config.
+
+## 0.11.0
+
+### Minor Changes
+
+- [#2302](https://github.com/bluesky-social/atproto/pull/2302) [`4eaadc0ac`](https://github.com/bluesky-social/atproto/commit/4eaadc0acb6b73b9745dd7a2b929d02e58083ab0) Thanks [@dholms](https://github.com/dholms)! - - Breaking changes
+  - Redesigned the `moderate*` APIs which now output a `ModerationUI` object.
+  - `agent.getPreferences()` output object `BskyPreferences` has been modified.
+  - Moved Ozone routes from `com.atproto.admin` to `tools.ozone` namespace.
+  - Additions
+    - Added support for labeler configuration in `Agent.configure()` and `agent.configureLabelerHeader()`.
+    - Added `agent.addLabeler()` and `agent.removeLabeler()` preference methods.
+    - Muted words and hidden posts are now handled in the `moderate*` APIs.
+    - Added `agent.getLabelers()` and `agent.getLabelDefinitions()`.
+    - Added `agent.configureProxyHeader()` and `withProxy()` methods to support remote service proxying behaviors.
+
+### Patch Changes
+
+- Updated dependencies [[`4eaadc0ac`](https://github.com/bluesky-social/atproto/commit/4eaadc0acb6b73b9745dd7a2b929d02e58083ab0)]:
+  - @atproto/common-web@0.2.4
+  - @atproto/lexicon@0.3.3
+  - @atproto/syntax@0.2.1
+  - @atproto/xrpc@0.4.3
+
+## 0.10.5
+
+### Patch Changes
+
+- [#2279](https://github.com/bluesky-social/atproto/pull/2279) [`192223f12`](https://github.com/bluesky-social/atproto/commit/192223f127c0b226287df1ecfcd953636db08655) Thanks [@gaearon](https://github.com/gaearon)! - Change Following feed prefs to only show replies from people you follow by default
+
+## 0.10.4
+
+### Patch Changes
+
+- [#2260](https://github.com/bluesky-social/atproto/pull/2260) [`6ec885992`](https://github.com/bluesky-social/atproto/commit/6ec8859929a16f9725319cc398b716acf913b01f) Thanks [@estrattonbailey](https://github.com/estrattonbailey)! - Export regex from rich text detection
+
+- [#2260](https://github.com/bluesky-social/atproto/pull/2260) [`6ec885992`](https://github.com/bluesky-social/atproto/commit/6ec8859929a16f9725319cc398b716acf913b01f) Thanks [@estrattonbailey](https://github.com/estrattonbailey)! - Disallow rare unicode whitespace characters from tags
+
+- [#2260](https://github.com/bluesky-social/atproto/pull/2260) [`6ec885992`](https://github.com/bluesky-social/atproto/commit/6ec8859929a16f9725319cc398b716acf913b01f) Thanks [@estrattonbailey](https://github.com/estrattonbailey)! - Allow tags to lead with numbers
+
+## 0.10.3
+
+### Patch Changes
+
+- [#2247](https://github.com/bluesky-social/atproto/pull/2247) [`2a0ceb818`](https://github.com/bluesky-social/atproto/commit/2a0ceb8180faa17de8061d4fa6c361b57a2005ed) Thanks [@estrattonbailey](https://github.com/estrattonbailey)! - Fix double sanitization bug when editing muted words.
+
+- [#2247](https://github.com/bluesky-social/atproto/pull/2247) [`2a0ceb818`](https://github.com/bluesky-social/atproto/commit/2a0ceb8180faa17de8061d4fa6c361b57a2005ed) Thanks [@estrattonbailey](https://github.com/estrattonbailey)! - More sanitization of muted words, including newlines and leading/trailing whitespace
+
+- [#2247](https://github.com/bluesky-social/atproto/pull/2247) [`2a0ceb818`](https://github.com/bluesky-social/atproto/commit/2a0ceb8180faa17de8061d4fa6c361b57a2005ed) Thanks [@estrattonbailey](https://github.com/estrattonbailey)! - Add `sanitizeMutedWordValue` util
+
+- [#2247](https://github.com/bluesky-social/atproto/pull/2247) [`2a0ceb818`](https://github.com/bluesky-social/atproto/commit/2a0ceb8180faa17de8061d4fa6c361b57a2005ed) Thanks [@estrattonbailey](https://github.com/estrattonbailey)! - Handle hash emoji in mute words
+
+## 0.10.2
+
+### Patch Changes
+
+- [#2245](https://github.com/bluesky-social/atproto/pull/2245) [`61b3d2525`](https://github.com/bluesky-social/atproto/commit/61b3d25253353db2da1336004f94e7dc5adb0410) Thanks [@mary-ext](https://github.com/mary-ext)! - Prevent hashtag emoji from being parsed as a tag
+
+- [#2218](https://github.com/bluesky-social/atproto/pull/2218) [`43531905c`](https://github.com/bluesky-social/atproto/commit/43531905ce1aec6d36d9be5943782811ecca6e6d) Thanks [@estrattonbailey](https://github.com/estrattonbailey)! - Fix mute word upsert logic by ensuring we're comparing sanitized word values
+
+- [#2245](https://github.com/bluesky-social/atproto/pull/2245) [`61b3d2525`](https://github.com/bluesky-social/atproto/commit/61b3d25253353db2da1336004f94e7dc5adb0410) Thanks [@mary-ext](https://github.com/mary-ext)! - Properly calculate length of tag
+
+- Updated dependencies [[`0c815b964`](https://github.com/bluesky-social/atproto/commit/0c815b964c030aa0f277c40bf9786f130dc320f4)]:
+  - @atproto/syntax@0.2.0
+  - @atproto/lexicon@0.3.2
+  - @atproto/xrpc@0.4.2
+
 ## 0.10.1
 
 ### Patch Changes

package/README.md

@@ -178,87 +178,70 @@ console.log(rt3.graphemeLength) // => 1
 
 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
-- Moderator labeling
+- Mutewords
+- Hidden posts
 
-For more information, see the [Moderation Documentation](./docs/moderation.md) or the associated [Labels Reference](./docs/labels.md).
+For more information, see the [Moderation Documentation](./docs/moderation.md).
 
 ```typescript
-import { moderatePost, moderateProfile } from '@atproto/api'
+import { moderatePost } from '@atproto/api'
+
+// First get the user's moderation prefs and their label definitions
+// =
+
+const prefs = await agent.getPreferences()
+const labelDefs = await agent.getLabelDefinitions(prefs)
 
 // We call the appropriate moderation function for the content
 // =
 
-const postMod = moderatePost(postView, getOpts())
-const profileMod = moderateProfile(profileView, getOpts())
+const postMod = moderatePost(postView, {
+  userDid: agent.session.did,
+  moderationPrefs: prefs.moderationPrefs,
+  labelDefs,
+})
 
 // We then use the output to decide how to affect rendering
 // =
 
-if (postMod.content.filter) {
-  // don't render in feeds or similar
-  // in contexts where this is disruptive (eg threads) you should ignore this and instead check blur
+// in feeds
+if (postMod.ui('contentList').filter) {
+  // don't include in feeds
 }
-if (postMod.content.blur) {
-  // render the whole object behind a cover (use postMod.content.cause to explain)
-  if (postMod.content.noOverride) {
+if (postMod.ui('contentList').blur) {
+  // render the whole object behind a cover (use postMod.ui('contentList').blurs to explain)
+  if (postMod.ui('contentList').noOverride) {
     // do not allow the cover the be removed
   }
 }
-if (postMod.content.alert) {
-  // render a warning on the content (use postMod.content.cause to explain)
+if (postMod.ui('contentList').alert || postMod.ui('contentList').inform) {
+  // render warnings on the post
+  // find the warnings in postMod.ui('contentList').alerts and postMod.ui('contentList').informs
 }
-if (postMod.embed.blur) {
-  // render the embedded media behind a cover (use postMod.embed.cause to explain)
-  if (postMod.embed.noOverride) {
+
+// viewed directly
+if (postMod.ui('contentView').filter) {
+  // don't include in feeds
+}
+if (postMod.ui('contentView').blur) {
+  // render the whole object behind a cover (use postMod.ui('contentView').blurs to explain)
+  if (postMod.ui('contentView').noOverride) {
     // do not allow the cover the be removed
   }
 }
-if (postMod.embed.alert) {
-  // render a warning on the embedded media (use postMod.embed.cause to explain)
-}
-if (postMod.avatar.blur) {
-  // render the avatar behind a cover
-}
-if (postMod.avatar.alert) {
-  // render an alert on the avatar
+if (postMod.ui('contentView').alert || postMod.ui('contentView').inform) {
+  // render warnings on the post
+  // find the warnings in postMod.ui('contentView').alerts and postMod.ui('contentView').informs
 }
 
-// The options passed into `apply()` supply the user's preferences
-// =
-
-function getOpts() {
-  return {
-    // the logged-in user's DID
-    userDid: 'did:plc:1234...',
-
-    // is adult content allowed?
-    adultContentEnabled: true,
-
-    // the global label settings (used on self-labels)
-    labels: {
-      porn: 'hide',
-      sexual: 'warn',
-      nudity: 'ignore',
-      // ...
-    },
-
-    // the per-labeler settings
-    labelers: [
-      {
-        labeler: {
-          did: '...',
-          displayName: 'My mod service',
-        },
-        labels: {
-          porn: 'hide',
-          sexual: 'warn',
-          nudity: 'ignore',
-          // ...
-        },
-      },
-    ],
+// post embeds in all contexts
+if (postMod.ui('contentMedia').blur) {
+  // render the whole object behind a cover (use postMod.ui('contentMedia').blurs to explain)
+  if (postMod.ui('contentMedia').noOverride) {
+    // do not allow the cover the be removed
   }
 }
 ```

package/babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [['@babel/preset-env']],
+}

package/build.js

@@ -0,0 +1,15 @@
+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()] : [],
+})

package/definitions/labels.json

@@ -1,224 +1,169 @@
 [
   {
-    "id": "system",
+    "identifier": "!hide",
     "configurable": false,
-    "labels": [
-      {
-        "id": "!hide",
-        "preferences": ["hide"],
-        "flags": ["no-override"],
-        "onwarn": "blur"
-      },
-      {
-        "id": "!no-promote",
-        "preferences": ["hide"],
-        "flags": [],
-        "onwarn": null
-      },
-      {
-        "id": "!warn",
-        "preferences": ["warn"],
-        "flags": [],
-        "onwarn": "blur"
-      },
-      {
-        "id": "!no-unauthenticated",
-        "preferences": ["hide"],
-        "flags": ["no-override", "unauthed"],
-        "onwarn": "blur"
+    "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"
       }
-    ]
+    }
   },
   {
-    "id": "legal",
+    "identifier": "!warn",
     "configurable": false,
-    "labels": [
-      {
-        "id": "dmca-violation",
-        "preferences": ["hide"],
-        "flags": ["no-override"],
-        "onwarn": "blur"
-      },
-      {
-        "id": "doxxing",
-        "preferences": ["hide"],
-        "flags": ["no-override"],
-        "onwarn": "blur"
+    "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"
       }
-    ]
+    }
   },
   {
-    "id": "sexual",
-    "configurable": true,
-    "labels": [
-      {
-        "id": "porn",
-        "preferences": ["ignore", "warn", "hide"],
-        "flags": ["adult"],
-        "onwarn": "blur-media"
-      },
-      {
-        "id": "sexual",
-        "preferences": ["ignore", "warn", "hide"],
-        "flags": ["adult"],
-        "onwarn": "blur-media"
-      },
-      {
-        "id": "nudity",
-        "preferences": ["ignore", "warn", "hide"],
-        "flags": ["adult"],
-        "onwarn": "blur-media"
-      }
-    ]
-  },
-  {
-    "id": "violence",
-    "configurable": true,
-    "labels": [
-      {
-        "id": "nsfl",
-        "preferences": ["ignore", "warn", "hide"],
-        "flags": ["adult"],
-        "onwarn": "blur-media"
-      },
-      {
-        "id": "corpse",
-        "preferences": ["ignore", "warn", "hide"],
-        "flags": ["adult"],
-        "onwarn": "blur-media"
-      },
-      {
-        "id": "gore",
-        "preferences": ["ignore", "warn", "hide"],
-        "flags": ["adult"],
-        "onwarn": "blur-media"
-      },
-      {
-        "id": "torture",
-        "preferences": ["ignore", "warn", "hide"],
-        "flags": ["adult"],
-        "onwarn": "blur"
-      },
-      {
-        "id": "self-harm",
-        "preferences": ["ignore", "warn", "hide"],
-        "flags": ["adult"],
-        "onwarn": "blur-media"
-      }
-    ]
-  },
-  {
-    "id": "intolerance",
-    "configurable": true,
-    "labels": [
-      {
-        "id": "intolerant-race",
-        "preferences": ["ignore", "warn", "hide"],
-        "flags": [],
-        "onwarn": "blur"
-      },
-      {
-        "id": "intolerant-gender",
-        "preferences": ["ignore", "warn", "hide"],
-        "flags": [],
-        "onwarn": "blur"
-      },
-      {
-        "id": "intolerant-sexual-orientation",
-        "preferences": ["ignore", "warn", "hide"],
-        "flags": [],
-        "onwarn": "blur"
-      },
-      {
-        "id": "intolerant-religion",
-        "preferences": ["ignore", "warn", "hide"],
-        "flags": [],
-        "onwarn": "blur"
-      },
-      {
-        "id": "intolerant",
-        "preferences": ["ignore", "warn", "hide"],
-        "flags": [],
-        "onwarn": "blur"
-      },
-      {
-        "id": "icon-intolerant",
-        "preferences": ["ignore", "warn", "hide"],
-        "flags": [],
-        "onwarn": "blur-media"
+    "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"
       }
-    ]
+    }
   },
   {
-    "id": "rude",
+    "identifier": "porn",
     "configurable": true,
-    "labels": [
-      {
-        "id": "threat",
-        "preferences": ["ignore", "warn", "hide"],
-        "flags": [],
-        "onwarn": "blur"
+    "defaultSetting": "hide",
+    "flags": ["adult"],
+    "severity": "none",
+    "blurs": "media",
+    "behaviors": {
+      "account": {
+        "avatar": "blur",
+        "banner": "blur"
+      },
+      "profile": {
+        "avatar": "blur",
+        "banner": "blur"
+      },
+      "content": {
+        "contentMedia": "blur"
       }
-    ]
+    }
   },
   {
-    "id": "curation",
+    "identifier": "sexual",
     "configurable": true,
-    "labels": [
-      {
-        "id": "spoiler",
-        "preferences": ["ignore", "warn", "hide"],
-        "flags": [],
-        "onwarn": "blur"
+    "defaultSetting": "warn",
+    "flags": ["adult"],
+    "severity": "none",
+    "blurs": "media",
+    "behaviors": {
+      "account": {
+        "avatar": "blur",
+        "banner": "blur"
+      },
+      "profile": {
+        "avatar": "blur",
+        "banner": "blur"
+      },
+      "content": {
+        "contentMedia": "blur"
       }
-    ]
+    }
   },
   {
-    "id": "spam",
+    "identifier": "nudity",
     "configurable": true,
-    "labels": [
-      {
-        "id": "spam",
-        "preferences": ["ignore", "warn", "hide"],
-        "flags": [],
-        "onwarn": "blur"
+    "defaultSetting": "ignore",
+    "flags": [],
+    "severity": "none",
+    "blurs": "media",
+    "behaviors": {
+      "account": {
+        "avatar": "blur",
+        "banner": "blur"
+      },
+      "profile": {
+        "avatar": "blur",
+        "banner": "blur"
+      },
+      "content": {
+        "contentMedia": "blur"
       }
-    ]
+    }
   },
   {
-    "id": "misinfo",
+    "identifier": "graphic-media",
+    "flags": ["adult"],
     "configurable": true,
-    "labels": [
-      {
-        "id": "account-security",
-        "preferences": ["ignore", "warn", "hide"],
-        "flags": [],
-        "onwarn": "blur"
-      },
-      {
-        "id": "net-abuse",
-        "preferences": ["ignore", "warn", "hide"],
-        "flags": [],
-        "onwarn": "blur"
-      },
-      {
-        "id": "impersonation",
-        "preferences": ["ignore", "warn", "hide"],
-        "flags": [],
-        "onwarn": "alert"
-      },
-      {
-        "id": "scam",
-        "preferences": ["ignore", "warn", "hide"],
-        "flags": [],
-        "onwarn": "alert"
-      },
-      {
-        "id": "misleading",
-        "preferences": ["ignore", "warn", "hide"],
-        "flags": [],
-        "onwarn": "alert"
+    "defaultSetting": "warn",
+    "severity": "none",
+    "blurs": "media",
+    "behaviors": {
+      "account": {
+        "avatar": "blur",
+        "banner": "blur"
+      },
+      "profile": {
+        "avatar": "blur",
+        "banner": "blur"
+      },
+      "content": {
+        "contentMedia": "blur"
       }
-    ]
+    }
   }
 ]