@atproto/api 0.11.0-next → 0.11.0

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # @atproto/api
 
+## 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

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/definitions/labels.json

@@ -27,15 +27,6 @@
       }
     }
   },
-  {
-    "identifier": "!no-promote",
-    "configurable": false,
-    "defaultSetting": "hide",
-    "flags": ["no-self"],
-    "severity": "none",
-    "blurs": "none",
-    "behaviors": {}
-  },
   {
     "identifier": "!warn",
     "configurable": false,
@@ -91,54 +82,6 @@
       }
     }
   },
-  {
-    "identifier": "dmca-violation",
-    "configurable": false,
-    "defaultSetting": "hide",
-    "flags": ["no-override", "no-self"],
-    "severity": "none",
-    "blurs": "content",
-    "behaviors": {
-      "account": {
-        "profileList": "blur",
-        "profileView": "blur",
-        "contentList": "blur",
-        "contentView": "blur"
-      },
-      "profile": {
-        "profileList": "blur",
-        "profileView": "blur"
-      },
-      "content": {
-        "contentList": "blur",
-        "contentView": "blur"
-      }
-    }
-  },
-  {
-    "identifier": "doxxing",
-    "configurable": false,
-    "defaultSetting": "hide",
-    "flags": ["no-override", "no-self"],
-    "severity": "none",
-    "blurs": "content",
-    "behaviors": {
-      "account": {
-        "profileList": "blur",
-        "profileView": "blur",
-        "contentList": "blur",
-        "contentView": "blur"
-      },
-      "profile": {
-        "profileList": "blur",
-        "profileView": "blur"
-      },
-      "content": {
-        "contentList": "blur",
-        "contentView": "blur"
-      }
-    }
-  },
   {
     "identifier": "porn",
     "configurable": true,
@@ -184,8 +127,8 @@
   {
     "identifier": "nudity",
     "configurable": true,
-    "defaultSetting": "warn",
-    "flags": ["adult"],
+    "defaultSetting": "ignore",
+    "flags": [],
     "severity": "none",
     "blurs": "media",
     "behaviors": {
@@ -203,7 +146,7 @@
     }
   },
   {
-    "identifier": "gore",
+    "identifier": "graphic-media",
     "flags": ["adult"],
     "configurable": true,
     "defaultSetting": "warn",

package/dist/agent.d.ts

@@ -1,21 +1,27 @@
-import { AtpServiceClient, ComAtprotoServerCreateAccount, ComAtprotoServerCreateSession, ComAtprotoServerGetSession } from './client';
-import { AtpSessionData, AtpAgentLoginOpts, AtpAgentFetchHandler, AtpAgentGlobalOpts, AtpPersistSessionHandler, AtpAgentOpts } from './types';
+import { AtpBaseClient, AtpServiceClient, ComAtprotoServerCreateAccount, ComAtprotoServerCreateSession, ComAtprotoServerGetSession } from './client';
+import { AtpSessionData, AtpAgentLoginOpts, AtpAgentFetchHandler, AtpAgentGlobalOpts, AtpPersistSessionHandler, AtpAgentOpts, AtprotoServiceType } from './types';
 export declare class AtpAgent {
     service: URL;
     api: AtpServiceClient;
     session?: AtpSessionData;
     labelersHeader: string[];
+    proxyHeader: string | undefined;
     pdsUrl: URL | undefined;
-    private _baseClient;
-    private _persistSession?;
-    private _refreshSessionPromise;
+    protected _baseClient: AtpBaseClient;
+    protected _persistSession?: AtpPersistSessionHandler;
+    protected _refreshSessionPromise: Promise<void> | undefined;
     get com(): import("./client").ComNS;
     static fetch: AtpAgentFetchHandler | undefined;
+    static appLabelers: string[];
     static configure(opts: AtpAgentGlobalOpts): void;
     constructor(opts: AtpAgentOpts);
+    clone(): AtpAgent;
+    copyInto(inst: AtpAgent): void;
+    withProxy(serviceType: AtprotoServiceType, did: string): AtpAgent;
     get hasSession(): boolean;
     setPersistSessionHandler(handler?: AtpPersistSessionHandler): void;
     configureLabelersHeader(labelerDids: string[]): void;
+    configureProxyHeader(serviceType: AtprotoServiceType, did: string): void;
     createAccount(opts: ComAtprotoServerCreateAccount.InputSchema): Promise<ComAtprotoServerCreateAccount.Response>;
     login(opts: AtpAgentLoginOpts): Promise<ComAtprotoServerCreateSession.Response>;
     resumeSession(session: AtpSessionData): Promise<ComAtprotoServerGetSession.Response>;

package/dist/bsky-agent.d.ts

@@ -1,13 +1,14 @@
 import { AtpAgent } from './agent';
 import { AppBskyFeedPost, AppBskyActorProfile, AppBskyActorDefs } from './client';
 import { BskyPreferences, BskyFeedViewPreference, BskyThreadViewPreference, BskyInterestsPreference } from './types';
-import { LabelPreference } from './moderation/types';
+import { InterpretedLabelValueDefinition, LabelPreference, ModerationPrefs } from './moderation/types';
 declare global {
     interface Array<T> {
         findLast(predicate: (value: T, index: number, obj: T[]) => unknown, thisArg?: any): T;
     }
 }
 export declare class BskyAgent extends AtpAgent {
+    clone(): BskyAgent;
     get app(): import("./client").AppNS;
     getTimeline: typeof this.api.app.bsky.feed.getTimeline;
     getAuthorFeed: typeof this.api.app.bsky.feed.getAuthorFeed;
@@ -27,6 +28,7 @@ export declare class BskyAgent extends AtpAgent {
     listNotifications: typeof this.api.app.bsky.notification.listNotifications;
     countUnreadNotifications: typeof this.api.app.bsky.notification.getUnreadCount;
     getLabelers: typeof this.api.app.bsky.labeler.getServices;
+    getLabelDefinitions(prefs: BskyPreferences | ModerationPrefs | string[]): Promise<Record<string, InterpretedLabelValueDefinition[]>>;
     post(record: Partial<AppBskyFeedPost.Record> & Omit<AppBskyFeedPost.Record, 'createdAt'>): Promise<{
         uri: string;
         cid: string;
@@ -81,8 +83,8 @@ export declare class BskyAgent extends AtpAgent {
     }>;
     setAdultContentEnabled(v: boolean): Promise<void>;
     setContentLabelPref(key: string, value: LabelPreference, labelerDid?: string): Promise<void>;
-    addModService(did: string): Promise<void>;
-    removeModService(did: string): Promise<void>;
+    addLabeler(did: string): Promise<void>;
+    removeLabeler(did: string): Promise<void>;
     setPersonalDetails({ birthDate, }: {
         birthDate: string | Date | undefined;
     }): Promise<void>;

package/dist/client/lexicons.d.ts

@@ -813,6 +813,16 @@ export declare const schemaDict: {
                         description: string;
                         knownValues: string[];
                     };
+                    defaultSetting: {
+                        type: string;
+                        description: string;
+                        knownValues: string[];
+                        default: string;
+                    };
+                    adultOnly: {
+                        type: string;
+                        description: string;
+                    };
                     locales: {
                         type: string;
                         items: {
@@ -3643,11 +3653,11 @@ export declare const schemaDict: {
                     };
                 };
             };
-            modsPref: {
+            labelersPref: {
                 type: string;
                 required: string[];
                 properties: {
-                    mods: {
+                    labelers: {
                         type: string;
                         items: {
                             type: string;
@@ -3656,7 +3666,7 @@ export declare const schemaDict: {
                     };
                 };
             };
-            modPrefItem: {
+            labelerPrefItem: {
                 type: string;
                 required: string[];
                 properties: {
@@ -4490,6 +4500,13 @@ export declare const schemaDict: {
                         type: string;
                         minimum: number;
                     };
+                    labels: {
+                        type: string;
+                        items: {
+                            type: string;
+                            ref: string;
+                        };
+                    };
                     viewer: {
                         type: string;
                         ref: string;
@@ -5719,6 +5736,13 @@ export declare const schemaDict: {
                     avatar: {
                         type: string;
                     };
+                    labels: {
+                        type: string;
+                        items: {
+                            type: string;
+                            ref: string;
+                        };
+                    };
                     viewer: {
                         type: string;
                         ref: string;
@@ -5769,6 +5793,13 @@ export declare const schemaDict: {
                     avatar: {
                         type: string;
                     };
+                    labels: {
+                        type: string;
+                        items: {
+                            type: string;
+                            ref: string;
+                        };
+                    };
                     viewer: {
                         type: string;
                         ref: string;

package/dist/client/types/app/bsky/actor/defs.d.ts

@@ -139,15 +139,15 @@ export interface HiddenPostsPref {
 }
 export declare function isHiddenPostsPref(v: unknown): v is HiddenPostsPref;
 export declare function validateHiddenPostsPref(v: unknown): ValidationResult;
-export interface ModsPref {
-    mods: ModPrefItem[];
+export interface LabelersPref {
+    labelers: LabelerPrefItem[];
     [k: string]: unknown;
 }
-export declare function isModsPref(v: unknown): v is ModsPref;
-export declare function validateModsPref(v: unknown): ValidationResult;
-export interface ModPrefItem {
+export declare function isLabelersPref(v: unknown): v is LabelersPref;
+export declare function validateLabelersPref(v: unknown): ValidationResult;
+export interface LabelerPrefItem {
     did: string;
     [k: string]: unknown;
 }
-export declare function isModPrefItem(v: unknown): v is ModPrefItem;
-export declare function validateModPrefItem(v: unknown): ValidationResult;
+export declare function isLabelerPrefItem(v: unknown): v is LabelerPrefItem;
+export declare function validateLabelerPrefItem(v: unknown): ValidationResult;

package/dist/client/types/app/bsky/feed/defs.d.ts

@@ -112,6 +112,7 @@ export interface GeneratorView {
     descriptionFacets?: AppBskyRichtextFacet.Main[];
     avatar?: string;
     likeCount?: number;
+    labels?: ComAtprotoLabelDefs.Label[];
     viewer?: GeneratorViewerState;
     indexedAt: string;
     [k: string]: unknown;

package/dist/client/types/app/bsky/graph/defs.d.ts

@@ -1,4 +1,5 @@
 import { ValidationResult } from '@atproto/lexicon';
+import * as ComAtprotoLabelDefs from '../../../com/atproto/label/defs';
 import * as AppBskyActorDefs from '../actor/defs';
 import * as AppBskyRichtextFacet from '../richtext/facet';
 export interface ListViewBasic {
@@ -7,6 +8,7 @@ export interface ListViewBasic {
     name: string;
     purpose: ListPurpose;
     avatar?: string;
+    labels?: ComAtprotoLabelDefs.Label[];
     viewer?: ListViewerState;
     indexedAt?: string;
     [k: string]: unknown;
@@ -22,6 +24,7 @@ export interface ListView {
     description?: string;
     descriptionFacets?: AppBskyRichtextFacet.Main[];
     avatar?: string;
+    labels?: ComAtprotoLabelDefs.Label[];
     viewer?: ListViewerState;
     indexedAt: string;
     [k: string]: unknown;

package/dist/client/types/com/atproto/label/defs.d.ts

@@ -29,6 +29,8 @@ export interface LabelValueDefinition {
     identifier: string;
     severity: 'inform' | 'alert' | 'none' | (string & {});
     blurs: 'content' | 'media' | 'none' | (string & {});
+    defaultSetting: 'ignore' | 'warn' | 'hide' | (string & {});
+    adultOnly?: boolean;
     locales: LabelValueDefinitionStrings[];
     [k: string]: unknown;
 }

package/dist/const.d.ts

@@ -1 +1 @@
-export declare const BSKY_MODSERVICE_DID = "did:plc:ar7c4by46qjdydhdevvrndac";
+export declare const BSKY_LABELER_DID = "did:plc:ar7c4by46qjdydhdevvrndac";