npm - @atproto/api - Versions diffs - 0.4.4 → 0.5.1 - Mend

@atproto/api 0.4.4 → 0.5.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (64) hide show

package/README.md +81 -0
package/definitions/labels.json +212 -0
package/definitions/locale/en/label-groups.json +38 -0
package/definitions/locale/en/labels.json +366 -0
package/definitions/locale/en/proposed-label-groups.json +38 -0
package/definitions/locale/en/proposed-labels.json +632 -0
package/definitions/moderation-behaviors.d.ts +48 -0
package/definitions/post-moderation-behaviors.json +879 -0
package/definitions/profile-moderation-behaviors.json +447 -0
package/definitions/proposed-labels.json +326 -0
package/dist/client/index.d.ts +3 -0
package/dist/client/lexicons.d.ts +27 -1
package/dist/client/types/app/bsky/unspecced/applyLabels.d.ts +18 -0
package/dist/index.d.ts +4 -0
package/dist/index.js +1401 -12
package/dist/index.js.map +4 -4
package/dist/moderation/accumulator.d.ts +14 -0
package/dist/moderation/const/label-groups.d.ts +2 -0
package/dist/moderation/const/labels.d.ts +2 -0
package/dist/moderation/index.d.ts +44 -0
package/dist/moderation/subjects/account.d.ts +3 -0
package/dist/moderation/subjects/feed-generator.d.ts +2 -0
package/dist/moderation/subjects/post.d.ts +2 -0
package/dist/moderation/subjects/profile.d.ts +3 -0
package/dist/moderation/subjects/quoted-post.d.ts +6 -0
package/dist/moderation/subjects/user-list.d.ts +2 -0
package/dist/moderation/types.d.ts +97 -0
package/dist/moderation/util.d.ts +12 -0
package/docs/labels.md +522 -0
package/docs/moderation-behaviors/posts.md +1919 -0
package/docs/moderation-behaviors/profiles.md +907 -0
package/docs/moderation.md +144 -0
package/package.json +5 -3
package/scripts/code/label-groups.mjs +68 -0
package/scripts/code/labels.mjs +68 -0
package/scripts/docs/labels.mjs +164 -0
package/scripts/docs/post-moderation-behaviors.mjs +122 -0
package/scripts/docs/profile-moderation-behaviors.mjs +122 -0
package/scripts/generate-code.mjs +4 -0
package/scripts/generate-docs.mjs +5 -0
package/src/client/index.ts +13 -0
package/src/client/lexicons.ts +29 -3
package/src/client/types/app/bsky/unspecced/applyLabels.ts +33 -0
package/src/client/types/com/atproto/admin/enableAccountInvites.ts +1 -1
package/src/client/types/com/atproto/moderation/defs.ts +1 -1
package/src/index.ts +4 -0
package/src/moderation/accumulator.ts +181 -0
package/src/moderation/const/label-groups.ts +143 -0
package/src/moderation/const/labels.ts +798 -0
package/src/moderation/index.ts +343 -0
package/src/moderation/subjects/account.ts +40 -0
package/src/moderation/subjects/feed-generator.ts +13 -0
package/src/moderation/subjects/post.ts +23 -0
package/src/moderation/subjects/profile.ts +31 -0
package/src/moderation/subjects/quoted-post.ts +62 -0
package/src/moderation/subjects/user-list.ts +13 -0
package/src/moderation/types.ts +141 -0
package/src/moderation/util.ts +98 -0
package/tests/post-moderation.test.ts +46 -0
package/tests/profile-moderation.test.ts +46 -0
package/tests/util/index.ts +176 -0
package/tests/util/moderation-behavior.ts +180 -0
package/tsconfig.build.tsbuildinfo +1 -1
package/tests/_util.ts +0 -26

package/docs/moderation-behaviors/posts.md ADDED Viewed

@@ -0,0 +1,1919 @@
+<!-- this doc is generated by ./scripts/docs/post-moderation-behaviors.mjs -->
+# Post moderation behaviors
+This document is a reference for the expected behaviors for a post in the application based on some given scenarios. The <code>moderatePost()</code> command condense down to the following yes or no decisions:
+- <code>res.content.filter</code> Do not show the post in feeds.
+- <code>res.content.blur</code> Put the post behind a warning cover.
+- <code>res.content.noOverride</code> Do not allow the post's blur cover to be lifted.
+- <code>res.content.alert</code> Add a warning to the post but do not cover it.
+- <code>res.avatar.blur</code> Put the avatar behind a cover.
+- <code>res.avatar.noOverride</code> Do not allow the avatars's blur cover to be lifted.
+- <code>res.avatar.alert</code> Put a warning icon on the avatar.
+- <code>res.embed.blur</code> Put the embed content (media, quote post) behind a warning cover.
+- <code>res.embed.noOverride</code> Do not allow the embed's blur cover to be lifted.
+- <code>res.embed.alert</code> Put a warning on the embed content (media, quote post).
+Key:
+- ❌ = Filter Content
+- 🚫 = Blur (no-override)
+- ✋ = Blur
+- 🪧 = Alert
+## Scenarios
+<table>
+<tr><th>Scenario</th><th>Filter</th><th>Content</th><th>Avatar</th><th>Embed</th></tr>
+<tr>
+<td><strong>Imperative label ('!hide') on post</strong></td>
+<td>
+❌
+</td>
+<td>
+🚫
+</td>
+<td>
+</td>
+<td>
+</td>
+</tr>
+<tr>
+<td><strong>Imperative label ('!hide') on author profile</strong></td>
+<td>
+</td>
+<td>
+</td>
+<td>
+🚫
+</td>
+<td>
+</td>
+</tr>
+<tr>
+<td><strong>Imperative label ('!hide') on author account</strong></td>
+<td>
+❌
+</td>
+<td>
+🚫
+</td>
+<td>
+🚫
+</td>
+<td>
+</td>
+</tr>
+<tr>
+<td><strong>Imperative label ('!hide') on quoted post</strong></td>
+<td>
+❌
+</td>
+<td>
+</td>
+<td>
+</td>
+<td>
+🚫
+</td>
+</tr>
+<tr>
+<td><strong>Imperative label ('!hide') on quoted author account</strong></td>
+<td>
+❌
+</td>
+<td>
+</td>
+<td>
+</td>
+<td>
+🚫
+</td>
+</tr>
+<tr>
+<td><strong>Imperative label ('!no-promote') on post</strong></td>
+<td>
+❌
+</td>
+<td>
+</td>
+<td>
+</td>
+<td>
+</td>
+</tr>
+<tr>
+<td><strong>Imperative label ('!no-promote') on author profile</strong></td>
+<td>
+</td>
+<td>
+</td>
+<td>
+</td>
+<td>
+</td>
+</tr>
+<tr>
+<td><strong>Imperative label ('!no-promote') on author account</strong></td>
+<td>
+❌
+</td>
+<td>
+</td>
+<td>
+</td>
+<td>
+</td>
+</tr>
+<tr>
+<td><strong>Imperative label ('!no-promote') on quoted post</strong></td>
+<td>
+❌
+</td>
+<td>
+</td>
+<td>
+</td>
+<td>
+</td>
+</tr>
+<tr>
+<td><strong>Imperative label ('!no-promote') on quoted author account</strong></td>
+<td>
+❌
+</td>
+<td>
+</td>
+<td>
+</td>
+<td>
+</td>
+</tr>
+<tr>
+<td><strong>Imperative label ('!warn') on post</strong></td>
+<td>
+</td>
+<td>
+✋
+</td>
+<td>
+</td>
+<td>
+</td>
+</tr>
+<tr>
+<td><strong>Imperative label ('!warn') on author profile</strong></td>
+<td>
+</td>
+<td>
+</td>
+<td>
+✋
+</td>
+<td>
+</td>
+</tr>
+<tr>
+<td><strong>Imperative label ('!warn') on author account</strong></td>
+<td>
+</td>
+<td>
+✋
+</td>
+<td>
+✋
+</td>
+<td>
+</td>
+</tr>
+<tr>
+<td><strong>Imperative label ('!warn') on quoted post</strong></td>
+<td>
+</td>
+<td>
+</td>
+<td>
+</td>
+<td>
+✋
+</td>
+</tr>
+<tr>
+<td><strong>Imperative label ('!warn') on quoted author account</strong></td>
+<td>
+</td>
+<td>
+</td>
+<td>
+</td>
+<td>
+✋
+</td>
+</tr>
+<tr><th>Scenario</th><th>Filter</th><th>Content</th><th>Avatar</th><th>Embed</th></tr>
+<tr>
+<td><strong>Blur label ('intolerant') on post (hide)</strong></td>
+<td>
+❌
+</td>
+<td>
+✋
+</td>
+<td>
+</td>
+<td>
+</td>
+</tr>
+<tr>
+<td><strong>Blur label ('intolerant') on author profile (hide)</strong></td>
+<td>
+</td>
+<td>
+</td>
+<td>
+✋
+</td>
+<td>
+</td>
+</tr>
+<tr>
+<td><strong>Blur label ('intolerant') on author account (hide)</strong></td>
+<td>
+❌
+</td>
+<td>
+✋
+</td>
+<td>
+✋
+</td>
+<td>
+</td>
+</tr>
+<tr>
+<td><strong>Blur label ('intolerant') on quoted post (hide)</strong></td>
+<td>
+❌
+</td>
+<td>
+</td>
+<td>
+</td>
+<td>
+✋
+</td>
+</tr>
+<tr>
+<td><strong>Blur label ('intolerant') on quoted author account (hide)</strong></td>
+<td>
+❌
+</td>
+<td>
+</td>
+<td>
+</td>
+<td>
+✋
+</td>
+</tr>
+<tr>
+<td><strong>Blur label ('intolerant') on post (warn)</strong></td>
+<td>
+</td>
+<td>
+✋
+</td>
+<td>
+</td>
+<td>
+</td>
+</tr>
+<tr>
+<td><strong>Blur label ('intolerant') on author profile (warn)</strong></td>
+<td>
+</td>
+<td>
+</td>
+<td>
+✋
+</td>
+<td>
+</td>
+</tr>
+<tr>
+<td><strong>Blur label ('intolerant') on author account (warn)</strong></td>
+<td>
+</td>
+<td>
+✋
+</td>
+<td>
+✋
+</td>
+<td>
+</td>
+</tr>
+<tr>
+<td><strong>Blur label ('intolerant') on quoted post (warn)</strong></td>
+<td>
+</td>
+<td>
+</td>
+<td>
+</td>
+<td>
+✋
+</td>
+</tr>
+<tr>
+<td><strong>Blur label ('intolerant') on quoted author account (warn)</strong></td>
+<td>
+</td>
+<td>
+</td>
+<td>
+</td>
+<td>
+✋
+</td>
+</tr>
+<tr>
+<td><strong>Blur label ('intolerant') on post (ignore)</strong></td>
+<td>
+</td>
+<td>
+</td>
+<td>
+</td>
+<td>
+</td>
+</tr>
+<tr>
+<td><strong>Blur label ('intolerant') on author profile (ignore)</strong></td>
+<td>
+</td>
+<td>
+</td>
+<td>
+</td>
+<td>
+</td>
+</tr>
+<tr>
+<td><strong>Blur label ('intolerant') on author account (ignore)</strong></td>
+<td>
+</td>
+<td>
+</td>
+<td>
+</td>
+<td>
+</td>
+</tr>
+<tr>
+<td><strong>Blur label ('intolerant') on quoted post (ignore)</strong></td>
+<td>
+</td>
+<td>
+</td>
+<td>
+</td>
+<td>
+</td>
+</tr>
+<tr>
+<td><strong>Blur label ('intolerant') on quoted author account (ignore)</strong></td>
+<td>
+</td>
+<td>
+</td>
+<td>
+</td>
+<td>
+</td>
+</tr>
+<tr><th>Scenario</th><th>Filter</th><th>Content</th><th>Avatar</th><th>Embed</th></tr>
+<tr>
+<td><strong>Blur-media label ('porn') on post (hide)</strong></td>
+<td>
+❌
+</td>
+<td>
+</td>
+<td>
+</td>
+<td>
+✋
+</td>
+</tr>
+<tr>
+<td><strong>Blur-media label ('porn') on author profile (hide)</strong></td>
+<td>
+</td>
+<td>
+</td>
+<td>
+✋
+</td>
+<td>
+</td>
+</tr>
+<tr>
+<td><strong>Blur-media label ('porn') on author account (hide)</strong></td>
+<td>
+❌
+</td>
+<td>
+</td>
+<td>
+✋
+</td>
+<td>
+✋
+</td>
+</tr>
+<tr>
+<td><strong>Blur-media label ('porn') on quoted post (hide)</strong></td>
+<td>
+❌
+</td>
+<td>
+</td>
+<td>
+</td>
+<td>
+</td>
+</tr>
+<tr>
+<td><strong>Blur-media label ('porn') on quoted author account (hide)</strong></td>
+<td>
+❌
+</td>
+<td>
+</td>
+<td>
+</td>
+<td>
+</td>
+</tr>
+<tr>
+<td><strong>Blur-media label ('porn') on post (warn)</strong></td>
+<td>
+</td>
+<td>
+</td>
+<td>
+</td>
+<td>
+✋
+</td>
+</tr>
+<tr>
+<td><strong>Blur-media label ('porn') on author profile (warn)</strong></td>
+<td>
+</td>
+<td>
+</td>
+<td>
+✋
+</td>
+<td>
+</td>
+</tr>
+<tr>
+<td><strong>Blur-media label ('porn') on author account (warn)</strong></td>
+<td>
+</td>
+<td>
+</td>
+<td>
+✋
+</td>
+<td>
+✋
+</td>
+</tr>
+<tr>
+<td><strong>Blur-media label ('porn') on quoted post (warn)</strong></td>
+<td>
+</td>
+<td>
+</td>
+<td>
+</td>
+<td>
+</td>
+</tr>
+<tr>
+<td><strong>Blur-media label ('porn') on quoted author account (warn)</strong></td>
+<td>
+</td>
+<td>
+</td>
+<td>
+</td>
+<td>
+</td>
+</tr>
+<tr>
+<td><strong>Blur-media label ('porn') on post (ignore)</strong></td>
+<td>
+</td>
+<td>
+</td>
+<td>
+</td>
+<td>
+</td>
+</tr>
+<tr>
+<td><strong>Blur-media label ('porn') on author profile (ignore)</strong></td>
+<td>
+</td>
+<td>
+</td>
+<td>
+</td>
+<td>
+</td>
+</tr>
+<tr>
+<td><strong>Blur-media label ('porn') on author account (ignore)</strong></td>
+<td>
+</td>
+<td>
+</td>
+<td>
+</td>
+<td>
+</td>
+</tr>
+<tr>
+<td><strong>Blur-media label ('porn') on quoted post (ignore)</strong></td>
+<td>
+</td>
+<td>
+</td>
+<td>
+</td>
+<td>
+</td>
+</tr>
+<tr>
+<td><strong>Blur-media label ('porn') on quoted author account (ignore)</strong></td>
+<td>
+</td>
+<td>
+</td>
+<td>
+</td>
+<td>
+</td>
+</tr>
+<tr><th>Scenario</th><th>Filter</th><th>Content</th><th>Avatar</th><th>Embed</th></tr>
+<tr>
+<td><strong>Notice label ('scam') on post (hide)</strong></td>
+<td>
+❌
+</td>
+<td>
+🪧
+</td>
+<td>
+</td>
+<td>
+</td>
+</tr>
+<tr>
+<td><strong>Notice label ('scam') on author profile (hide)</strong></td>
+<td>
+</td>
+<td>
+</td>
+<td>
+🪧
+</td>
+<td>
+</td>
+</tr>
+<tr>
+<td><strong>Notice label ('scam') on author account (hide)</strong></td>
+<td>
+❌
+</td>
+<td>
+🪧
+</td>
+<td>
+🪧
+</td>
+<td>
+</td>
+</tr>
+<tr>
+<td><strong>Notice label ('scam') on quoted post (hide)</strong></td>
+<td>
+❌
+</td>
+<td>
+</td>
+<td>
+</td>
+<td>
+🪧
+</td>
+</tr>
+<tr>
+<td><strong>Notice label ('scam') on quoted author account (hide)</strong></td>
+<td>
+❌
+</td>
+<td>
+</td>
+<td>
+</td>
+<td>
+🪧
+</td>
+</tr>
+<tr>
+<td><strong>Notice label ('scam') on post (warn)</strong></td>
+<td>
+</td>
+<td>
+🪧
+</td>
+<td>
+</td>
+<td>
+</td>
+</tr>
+<tr>
+<td><strong>Notice label ('scam') on author profile (warn)</strong></td>
+<td>
+</td>
+<td>
+</td>
+<td>
+🪧
+</td>
+<td>
+</td>
+</tr>
+<tr>
+<td><strong>Notice label ('scam') on author account (warn)</strong></td>
+<td>
+</td>
+<td>
+🪧
+</td>
+<td>
+🪧
+</td>
+<td>
+</td>
+</tr>
+<tr>
+<td><strong>Notice label ('scam') on quoted post (warn)</strong></td>
+<td>
+</td>
+<td>
+</td>
+<td>
+</td>
+<td>
+🪧
+</td>
+</tr>
+<tr>
+<td><strong>Notice label ('scam') on quoted author account (warn)</strong></td>
+<td>
+</td>
+<td>
+</td>
+<td>
+</td>
+<td>
+🪧
+</td>
+</tr>
+<tr>
+<td><strong>Notice label ('scam') on post (ignore)</strong></td>
+<td>
+</td>
+<td>
+</td>
+<td>
+</td>
+<td>
+</td>
+</tr>
+<tr>
+<td><strong>Notice label ('scam') on author profile (ignore)</strong></td>
+<td>
+</td>
+<td>
+</td>
+<td>
+</td>
+<td>
+</td>
+</tr>
+<tr>
+<td><strong>Notice label ('scam') on author account (ignore)</strong></td>
+<td>
+</td>
+<td>
+</td>
+<td>
+</td>
+<td>
+</td>
+</tr>
+<tr>
+<td><strong>Notice label ('scam') on quoted post (ignore)</strong></td>
+<td>
+</td>
+<td>
+</td>
+<td>
+</td>
+<td>
+</td>
+</tr>
+<tr>
+<td><strong>Notice label ('scam') on quoted author account (ignore)</strong></td>
+<td>
+</td>
+<td>
+</td>
+<td>
+</td>
+<td>
+</td>
+</tr>
+<tr><th>Scenario</th><th>Filter</th><th>Content</th><th>Avatar</th><th>Embed</th></tr>
+<tr>
+<td><strong>Adult-only label on post when adult content is disabled</strong></td>
+<td>
+❌
+</td>
+<td>
+</td>
+<td>
+</td>
+<td>
+🚫
+</td>
+</tr>
+<tr>
+<td><strong>Adult-only label on author profile when adult content is disabled</strong></td>
+<td>
+</td>
+<td>
+</td>
+<td>
+🚫
+</td>
+<td>
+</td>
+</tr>
+<tr>
+<td><strong>Adult-only label on author account when adult content is disabled</strong></td>
+<td>
+❌
+</td>
+<td>
+</td>
+<td>
+🚫
+</td>
+<td>
+🚫
+</td>
+</tr>
+<tr>
+<td><strong>Adult-only label on quoted post when adult content is disabled</strong></td>
+<td>
+❌
+</td>
+<td>
+</td>
+<td>
+</td>
+<td>
+</td>
+</tr>
+<tr>
+<td><strong>Adult-only label on quoted author account when adult content is disabled</strong></td>
+<td>
+❌
+</td>
+<td>
+</td>
+<td>
+</td>
+<td>
+</td>
+</tr>
+<tr><th>Scenario</th><th>Filter</th><th>Content</th><th>Avatar</th><th>Embed</th></tr>
+<tr>
+<td><strong>Self-post: Imperative label ('!hide') on post</strong></td>
+<td>
+</td>
+<td>
+🪧
+</td>
+<td>
+</td>
+<td>
+</td>
+</tr>
+<tr>
+<td><strong>Self-post: Imperative label ('!hide') on author profile</strong></td>
+<td>
+</td>
+<td>
+</td>
+<td>
+</td>
+<td>
+</td>
+</tr>
+<tr>
+<td><strong>Self-post: Imperative label ('!hide') on author account</strong></td>
+<td>
+</td>
+<td>
+</td>
+<td>
+</td>
+<td>
+</td>
+</tr>
+<tr>
+<td><strong>Self-post: Imperative label ('!hide') on quoted post</strong></td>
+<td>
+</td>
+<td>
+</td>
+<td>
+</td>
+<td>
+🪧
+</td>
+</tr>
+<tr>
+<td><strong>Self-post: Imperative label ('!hide') on quoted author account</strong></td>
+<td>
+</td>
+<td>
+</td>
+<td>
+</td>
+<td>
+</td>
+</tr>
+<tr><th>Scenario</th><th>Filter</th><th>Content</th><th>Avatar</th><th>Embed</th></tr>
+<tr>
+<td><strong>Post with blocked author</strong></td>
+<td>
+❌
+</td>
+<td>
+🚫
+</td>
+<td>
+🚫
+</td>
+<td>
+</td>
+</tr>
+<tr>
+<td><strong>Post with blocked quoted author</strong></td>
+<td>
+❌
+</td>
+<td>
+</td>
+<td>
+</td>
+<td>
+🚫
+</td>
+</tr>
+<tr>
+<td><strong>Post with author blocking user</strong></td>
+<td>
+❌
+</td>
+<td>
+🚫
+</td>
+<td>
+🚫
+</td>
+<td>
+</td>
+</tr>
+<tr>
+<td><strong>Post with quoted author blocking user</strong></td>
+<td>
+❌
+</td>
+<td>
+</td>
+<td>
+</td>
+<td>
+🚫
+</td>
+</tr>
+<tr>
+<td><strong>Post with muted author</strong></td>
+<td>
+❌
+</td>
+<td>
+✋
+</td>
+<td>
+</td>
+<td>
+</td>
+</tr>
+<tr>
+<td><strong>Post with muted quoted author</strong></td>
+<td>
+❌
+</td>
+<td>
+</td>
+<td>
+</td>
+<td>
+✋
+</td>
+</tr>
+<tr>
+<td><strong>Post with muted-by-list author</strong></td>
+<td>
+❌
+</td>
+<td>
+✋
+</td>
+<td>
+</td>
+<td>
+</td>
+</tr>
+<tr>
+<td><strong>Post with muted-by-list quoted author</strong></td>
+<td>
+❌
+</td>
+<td>
+</td>
+<td>
+</td>
+<td>
+✋
+</td>
+</tr>
+<tr><th>Scenario</th><th>Filter</th><th>Content</th><th>Avatar</th><th>Embed</th></tr>
+<tr>
+<td><strong>Prioritization: post with blocking & blocked-by author</strong></td>
+<td>
+❌
+</td>
+<td>
+🚫
+</td>
+<td>
+🚫
+</td>
+<td>
+</td>
+</tr>
+<tr>
+<td><strong>Prioritization: post with blocking & blocked-by quoted author</strong></td>
+<td>
+❌
+</td>
+<td>
+</td>
+<td>
+</td>
+<td>
+🚫
+</td>
+</tr>
+<tr>
+<td><strong>Prioritization: '!hide' label on post by blocked user</strong></td>
+<td>
+❌
+</td>
+<td>
+🚫
+</td>
+<td>
+🚫
+</td>
+<td>
+</td>
+</tr>
+<tr>
+<td><strong>Prioritization: '!hide' label on quoted post, post by blocked user</strong></td>
+<td>
+❌
+</td>
+<td>
+🚫
+</td>
+<td>
+🚫
+</td>
+<td>
+🚫
+</td>
+</tr>
+<tr>
+<td><strong>Prioritization: '!hide' and 'intolerant' labels on post (hide)</strong></td>
+<td>
+❌
+</td>
+<td>
+🚫
+</td>
+<td>
+</td>
+<td>
+</td>
+</tr>
+<tr>
+<td><strong>Prioritization: '!warn' and 'intolerant' labels on post (hide)</strong></td>
+<td>
+❌
+</td>
+<td>
+✋
+</td>
+<td>
+</td>
+<td>
+</td>
+</tr>
+<tr>
+<td><strong>Prioritization: '!hide' and 'porn' labels on post (hide)</strong></td>
+<td>
+❌
+</td>
+<td>
+🚫
+</td>
+<td>
+</td>
+<td>
+</td>
+</tr>
+<tr>
+<td><strong>Prioritization: '!warn' and 'porn' labels on post (hide)</strong></td>
+<td>
+❌
+</td>
+<td>
+</td>
+<td>
+</td>
+<td>
+✋
+</td>
+</tr>
+</table>