@atproto/api 0.4.3 → 0.5.0

package/README.md

@@ -160,6 +160,87 @@ console.log(rt3.length) // => 25
 console.log(rt3.graphemeLength) // => 1
 ```
 
+### Moderation
+
+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:
+
+- User muting (including mutelists)
+- User blocking
+- Moderator labeling
+
+For more information, see the [Moderation Documentation](./docs/moderation.md) or the associated [Labels Reference](./docs/labels.md).
+
+```typescript
+import {moderatePost, moderateProfile} from '@atproto/api'
+
+// We call the appropriate moderation function for the content
+// =
+
+const postMod    = moderatePost(postView, getOpts())
+const profileMod = moderateProfile(profileView, getOpts())
+
+// We then use the output to decide how to affect rendering
+// =
+
+if (postMod.content.filter) {
+  // dont render in feeds or similar
+  // in contexts where this is disruptive (eg threads) you should ignore this and instead check blur
+}
+if (postMod.content.blur) {
+  // render the whole object behind a cover (use postMod.content.cause to explain)
+  if (postMod.content.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.embed.blur) {
+  // render the embedded media behind a cover (use postMod.embed.cause to explain)
+  if (postMod.embed.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
+}
+
+// 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 user's labeler settings
+    labelerSettings: [
+      {
+        labeler: {
+          did: '...',
+          displayName: 'My mod service'
+        },
+        settings: {
+          porn: 'hide',
+          sexual: 'warn',
+          nudity: 'ignore',
+          // ...
+        }
+      }
+    ]
+  }
+}
+```
+
 ## Advanced
 
 ### Advanced API calls

package/definitions/labels.json

@@ -0,0 +1,212 @@
+[
+  {
+    "id": "system",
+    "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": "legal",
+    "configurable": false,
+    "labels": [
+      {
+        "id": "dmca-violation",
+        "preferences": ["hide"],
+        "flags": ["no-override"],
+        "onwarn": "blur"
+      },
+      {
+        "id": "doxxing",
+        "preferences": ["hide"],
+        "flags": ["no-override"],
+        "onwarn": "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"
+      }
+    ]
+  },
+  {
+    "id": "rude",
+    "configurable": true,
+    "labels": [
+      {
+        "id": "threat",
+        "preferences": ["ignore", "warn", "hide"],
+        "flags": [],
+        "onwarn": "blur"
+      }
+    ]
+  },
+  {
+    "id": "curation",
+    "configurable": true,
+    "labels": [
+      {
+        "id": "spoiler",
+        "preferences": ["ignore", "warn", "hide"],
+        "flags": [],
+        "onwarn": "blur"
+      }
+    ]
+  },
+  {
+    "id": "spam",
+    "configurable": true,
+    "labels": [
+      {
+        "id": "spam",
+        "preferences": ["ignore", "warn", "hide"],
+        "flags": [],
+        "onwarn": "blur"
+      }
+    ]
+  },
+  {
+    "id": "misinfo",
+    "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"
+      }
+    ]
+  }
+]

package/definitions/locale/en/label-groups.json

@@ -0,0 +1,38 @@
+{
+  "system": {
+    "name": "System",
+    "description": "Moderator overrides for special cases."
+  },
+  "legal": {
+    "name": "Legal",
+    "description": "Content removed for legal reasons."
+  },
+  "sexual": {
+    "name": "Adult Content",
+    "description": "Content which is sexual in nature."
+  },
+  "violence": {
+    "name": "Violence",
+    "description": "Content which is violent or deeply disturbing."
+  },
+  "intolerance": {
+    "name": "Intolerance",
+    "description": "Content or behavior which is hateful or intolerant toward a group of people."
+  },
+  "rude": {
+    "name": "Rude",
+    "description": "Behavior which is rude toward other users."
+  },
+  "curation": {
+    "name": "Curational",
+    "description": "Subjective moderation geared towards curating a more positive environment."
+  },
+  "spam": {
+    "name": "Spam",
+    "description": "Content which doesn't add to the conversation."
+  },
+  "misinfo": {
+    "name": "Misinformation",
+    "description": "Content which misleads or defrauds users."
+  }
+}