@atproto/api 0.5.4 → 0.6.0

package/dist/moderation/types.d.ts

@@ -37,7 +37,7 @@ interface Labeler {
 }
 export interface LabelerSettings {
     labeler: Labeler;
-    settings: Record<string, LabelPreference>;
+    labels: Record<string, LabelPreference>;
 }
 export declare type ModerationSubjectProfile = AppBskyActorDefs.ProfileViewBasic | AppBskyActorDefs.ProfileView | AppBskyActorDefs.ProfileViewDetailed;
 export declare type ModerationSubjectPost = AppBskyFeedDefs.PostView;
@@ -49,6 +49,9 @@ export declare type ModerationCauseSource = {
 } | {
     type: 'list';
     list: AppBskyGraphDefs.ListViewBasic;
+} | {
+    type: 'labeler';
+    labeler: Labeler;
 };
 export declare type ModerationCause = {
     type: 'blocking';
@@ -60,7 +63,7 @@ export declare type ModerationCause = {
     priority: 4;
 } | {
     type: 'label';
-    labeler: Labeler;
+    source: ModerationCauseSource;
     label: Label;
     labelDef: LabelDefinition;
     setting: LabelPreference;
@@ -73,7 +76,8 @@ export declare type ModerationCause = {
 export interface ModerationOpts {
     userDid: string;
     adultContentEnabled: boolean;
-    labelerSettings: LabelerSettings[];
+    labels: Record<string, LabelPreference>;
+    labelers: LabelerSettings[];
 }
 export declare class ModerationDecision {
     cause: ModerationCause | undefined;

package/docs/moderation.md

@@ -26,14 +26,22 @@ Every moderation function takes a set of options which look like this:
   // is adult content allowed?
   adultContentEnabled: true,
 
-  // the user's labeler settings
-  labelerSettings: [
+  // 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'
       },
-      settings: {
+      labels: {
         porn: 'hide',
         sexual: 'warn',
         nudity: 'ignore',
@@ -50,7 +58,8 @@ This should match the following interfaces:
 interface ModerationOpts {
   userDid: string
   adultContentEnabled: boolean
-  labelerSettings: LabelerSettings[]
+  labels: Record<string, LabelPreference>
+  labelers: LabelerSettings[]
 }
 
 interface Labeler {
@@ -62,7 +71,7 @@ type LabelPreference = 'ignore' | 'warn' | 'hide'
 
 interface LabelerSettings {
   labeler: Labeler
-  settings: Record<string, LabelPreference>
+  labels: Record<string, LabelPreference>
 }
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atproto/api",
-  "version": "0.5.4",
+  "version": "0.6.0",
   "main": "dist/index.js",
   "scripts": {
     "codegen": "yarn docgen && node ./scripts/generate-code.mjs && lex gen-api ./src/client ../../lexicons/com/atproto/*/* ../../lexicons/app/bsky/*/*",

package/src/client/lexicons.ts

@@ -1441,6 +1441,36 @@ export const schemaDict = {
           },
         },
       },
+      selfLabels: {
+        type: 'object',
+        description:
+          'Metadata tags on an atproto record, published by the author within the record.',
+        required: ['values'],
+        properties: {
+          values: {
+            type: 'array',
+            items: {
+              type: 'ref',
+              ref: 'lex:com.atproto.label.defs#selfLabel',
+            },
+            maxLength: 10,
+          },
+        },
+      },
+      selfLabel: {
+        type: 'object',
+        description:
+          'Metadata tag on an atproto record, published by the author within the record. Note -- schemas should use #selfLabels, not #selfLabel.',
+        required: ['val'],
+        properties: {
+          val: {
+            type: 'string',
+            maxLength: 128,
+            description:
+              'the short string name of the value or type of this label',
+          },
+        },
+      },
     },
   },
   ComAtprotoLabelQueryLabels: {
@@ -3925,6 +3955,10 @@ export const schemaDict = {
               accept: ['image/png', 'image/jpeg'],
               maxSize: 1000000,
             },
+            labels: {
+              type: 'union',
+              refs: ['lex:com.atproto.label.defs#selfLabels'],
+            },
           },
         },
       },
@@ -4671,6 +4705,10 @@ export const schemaDict = {
               accept: ['image/png', 'image/jpeg'],
               maxSize: 1000000,
             },
+            labels: {
+              type: 'union',
+              refs: ['lex:com.atproto.label.defs#selfLabels'],
+            },
             createdAt: {
               type: 'string',
               format: 'datetime',
@@ -4752,6 +4790,15 @@ export const schemaDict = {
             cursor: {
               type: 'string',
             },
+            filter: {
+              type: 'string',
+              knownValues: [
+                'posts_with_replies',
+                'posts_no_replies',
+                'posts_with_media',
+              ],
+              default: 'posts_with_replies',
+            },
           },
         },
         output: {
@@ -5321,6 +5368,10 @@ export const schemaDict = {
                 format: 'language',
               },
             },
+            labels: {
+              type: 'union',
+              refs: ['lex:com.atproto.label.defs#selfLabels'],
+            },
             createdAt: {
               type: 'string',
               format: 'datetime',
@@ -5940,6 +5991,10 @@ export const schemaDict = {
               accept: ['image/png', 'image/jpeg'],
               maxSize: 1000000,
             },
+            labels: {
+              type: 'union',
+              refs: ['lex:com.atproto.label.defs#selfLabels'],
+            },
             createdAt: {
               type: 'string',
               format: 'datetime',

package/src/client/types/app/bsky/actor/profile.ts

@@ -5,12 +5,16 @@ import { ValidationResult, BlobRef } from '@atproto/lexicon'
 import { isObj, hasProp } from '../../../../util'
 import { lexicons } from '../../../../lexicons'
 import { CID } from 'multiformats/cid'
+import * as ComAtprotoLabelDefs from '../../../com/atproto/label/defs'
 
 export interface Record {
   displayName?: string
   description?: string
   avatar?: BlobRef
   banner?: BlobRef
+  labels?:
+    | ComAtprotoLabelDefs.SelfLabels
+    | { $type: string; [k: string]: unknown }
   [k: string]: unknown
 }
 

package/src/client/types/app/bsky/feed/generator.ts

@@ -6,6 +6,7 @@ import { isObj, hasProp } from '../../../../util'
 import { lexicons } from '../../../../lexicons'
 import { CID } from 'multiformats/cid'
 import * as AppBskyRichtextFacet from '../richtext/facet'
+import * as ComAtprotoLabelDefs from '../../../com/atproto/label/defs'
 
 export interface Record {
   did: string
@@ -13,6 +14,9 @@ export interface Record {
   description?: string
   descriptionFacets?: AppBskyRichtextFacet.Main[]
   avatar?: BlobRef
+  labels?:
+    | ComAtprotoLabelDefs.SelfLabels
+    | { $type: string; [k: string]: unknown }
   createdAt: string
   [k: string]: unknown
 }

package/src/client/types/app/bsky/feed/getAuthorFeed.ts

@@ -12,6 +12,11 @@ export interface QueryParams {
   actor: string
   limit?: number
   cursor?: string
+  filter?:
+    | 'posts_with_replies'
+    | 'posts_no_replies'
+    | 'posts_with_media'
+    | (string & {})
 }
 
 export type InputSchema = undefined

package/src/client/types/app/bsky/feed/post.ts

@@ -10,6 +10,7 @@ import * as AppBskyEmbedImages from '../embed/images'
 import * as AppBskyEmbedExternal from '../embed/external'
 import * as AppBskyEmbedRecord from '../embed/record'
 import * as AppBskyEmbedRecordWithMedia from '../embed/recordWithMedia'
+import * as ComAtprotoLabelDefs from '../../../com/atproto/label/defs'
 import * as ComAtprotoRepoStrongRef from '../../../com/atproto/repo/strongRef'
 
 export interface Record {
@@ -25,6 +26,9 @@ export interface Record {
     | AppBskyEmbedRecordWithMedia.Main
     | { $type: string; [k: string]: unknown }
   langs?: string[]
+  labels?:
+    | ComAtprotoLabelDefs.SelfLabels
+    | { $type: string; [k: string]: unknown }
   createdAt: string
   [k: string]: unknown
 }

package/src/client/types/app/bsky/graph/list.ts

@@ -7,6 +7,7 @@ import { lexicons } from '../../../../lexicons'
 import { CID } from 'multiformats/cid'
 import * as AppBskyGraphDefs from './defs'
 import * as AppBskyRichtextFacet from '../richtext/facet'
+import * as ComAtprotoLabelDefs from '../../../com/atproto/label/defs'
 
 export interface Record {
   purpose: AppBskyGraphDefs.ListPurpose
@@ -14,6 +15,9 @@ export interface Record {
   description?: string
   descriptionFacets?: AppBskyRichtextFacet.Main[]
   avatar?: BlobRef
+  labels?:
+    | ComAtprotoLabelDefs.SelfLabels
+    | { $type: string; [k: string]: unknown }
   createdAt: string
   [k: string]: unknown
 }

package/src/client/types/com/atproto/label/defs.ts

@@ -34,3 +34,40 @@ export function isLabel(v: unknown): v is Label {
 export function validateLabel(v: unknown): ValidationResult {
   return lexicons.validate('com.atproto.label.defs#label', v)
 }
+
+/** Metadata tags on an atproto record, published by the author within the record. */
+export interface SelfLabels {
+  values: SelfLabel[]
+  [k: string]: unknown
+}
+
+export function isSelfLabels(v: unknown): v is SelfLabels {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'com.atproto.label.defs#selfLabels'
+  )
+}
+
+export function validateSelfLabels(v: unknown): ValidationResult {
+  return lexicons.validate('com.atproto.label.defs#selfLabels', v)
+}
+
+/** Metadata tag on an atproto record, published by the author within the record. Note -- schemas should use #selfLabels, not #selfLabel. */
+export interface SelfLabel {
+  /** the short string name of the value or type of this label */
+  val: string
+  [k: string]: unknown
+}
+
+export function isSelfLabel(v: unknown): v is SelfLabel {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'com.atproto.label.defs#selfLabel'
+  )
+}
+
+export function validateSelfLabel(v: unknown): ValidationResult {
+  return lexicons.validate('com.atproto.label.defs#selfLabel', v)
+}

package/src/moderation/accumulator.ts

@@ -47,15 +47,15 @@ export class ModerationCauseAccumulator {
     }
 
     // look up the label preference
-    // TODO use the find() when 3P labelers support lands
-    // const labelerSettings = opts.labelerSettings.find(
-    //   (s) => s.labeler.did === label.src,
-    // )
-    const labelerSettings = opts.labelerSettings[0]
-    if (!labelerSettings) {
-      // ignore labels from labelers we don't use
-      return
-    }
+    const isSelf = label.src === this.did
+    const labeler = isSelf
+      ? undefined
+      : opts.labelers.find((s) => s.labeler.did === label.src)
+
+    /* TODO when 3P labelers are supported
+    if (!isSelf && !labeler) {
+      return // skip labelers not configured by the user
+    }*/
 
     // establish the label preference for interpretation
     let labelPref: LabelPreference = 'ignore'
@@ -63,8 +63,10 @@ export class ModerationCauseAccumulator {
       labelPref = labelDef.preferences[0]
     } else if (labelDef.flags.includes('adult') && !opts.adultContentEnabled) {
       labelPref = 'hide'
-    } else if (labelerSettings.settings[label.val]) {
-      labelPref = labelerSettings.settings[label.val]
+    } else if (labeler?.labels[label.val]) {
+      labelPref = labeler.labels[label.val]
+    } else if (opts.labels[label.val]) {
+      labelPref = opts.labels[label.val]
     }
 
     // ignore labels the user has asked to ignore
@@ -88,9 +90,12 @@ export class ModerationCauseAccumulator {
 
     this.causes.push({
       type: 'label',
+      source:
+        isSelf || !labeler
+          ? { type: 'user' }
+          : { type: 'labeler', labeler: labeler.labeler },
       label,
       labelDef,
-      labeler: labelerSettings.labeler,
       setting: labelPref,
       priority,
     })

package/src/moderation/types.ts

@@ -64,7 +64,7 @@ interface Labeler {
 
 export interface LabelerSettings {
   labeler: Labeler
-  settings: Record<string, LabelPreference>
+  labels: Record<string, LabelPreference>
 }
 
 // subjects
@@ -95,13 +95,14 @@ export type ModerationSubject =
 export type ModerationCauseSource =
   | { type: 'user' }
   | { type: 'list'; list: AppBskyGraphDefs.ListViewBasic }
+  | { type: 'labeler'; labeler: Labeler }
 
 export type ModerationCause =
   | { type: 'blocking'; source: ModerationCauseSource; priority: 3 }
   | { type: 'blocked-by'; source: ModerationCauseSource; priority: 4 }
   | {
       type: 'label'
-      labeler: Labeler
+      source: ModerationCauseSource
       label: Label
       labelDef: LabelDefinition
       setting: LabelPreference
@@ -112,7 +113,8 @@ export type ModerationCause =
 export interface ModerationOpts {
   userDid: string
   adultContentEnabled: boolean
-  labelerSettings: LabelerSettings[]
+  labels: Record<string, LabelPreference>
+  labelers: LabelerSettings[]
 }
 
 export class ModerationDecision {