@atproto/api 0.6.10 → 0.6.12

package/docs/moderation.md

@@ -80,7 +80,7 @@ interface LabelerSettings {
 Applications need to produce the [Post Moderation Behaviors](./moderation-behaviors/posts.md) using the `moderatePost()` API.
 
 ```typescript
-import {moderatePost} from '@atproto/api'
+import { moderatePost } from '@atproto/api'
 
 const postMod = moderatePost(postView, getOpts())
 
@@ -119,7 +119,7 @@ if (postMod.avatar.alert) {
 Applications need to produce the [Profile Moderation Behaviors](./moderation-behaviors/profiles.md) using the `moderateProfile()` API.
 
 ```typescript
-import {moderateProfile} from '@atproto/api'
+import { moderateProfile } from '@atproto/api'
 
 const profileMod = moderateProfile(profileView, getOpts())
 
@@ -150,4 +150,4 @@ if (profileMod.avatar.blur) {
 if (profileMod.avatar.alert) {
   // render an alert on the avatar
 }
-```
+```

package/package.json

@@ -1,20 +1,7 @@
 {
   "name": "@atproto/api",
-  "version": "0.6.10",
+  "version": "0.6.12",
   "main": "dist/index.js",
-  "scripts": {
-    "codegen": "yarn docgen && node ./scripts/generate-code.mjs && lex gen-api ./src/client ../../lexicons/com/atproto/*/* ../../lexicons/app/bsky/*/*",
-    "docgen": "node ./scripts/generate-docs.mjs",
-    "build": "node ./build.js",
-    "postbuild": "tsc --build tsconfig.build.json",
-    "update-main-to-dist": "node ./update-pkg.js --update-main-to-dist",
-    "update-main-to-src": "node ./update-pkg.js --update-main-to-src",
-    "prepublish": "npm run update-main-to-dist",
-    "postpublish": "npm run update-main-to-src",
-    "test": "jest",
-    "bench": "jest --config jest.bench.config.js",
-    "bench:profile": "node --inspect-brk ../../node_modules/.bin/jest --config jest.bench.config.js"
-  },
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -22,15 +9,28 @@
     "directory": "packages/api"
   },
   "dependencies": {
-    "@atproto/common-web": "*",
-    "@atproto/syntax": "*",
-    "@atproto/xrpc": "*",
+    "multiformats": "^9.9.0",
     "tlds": "^1.234.0",
-    "typed-emitter": "^2.1.0"
+    "typed-emitter": "^2.1.0",
+    "@atproto/common-web": "^0.2.0",
+    "@atproto/syntax": "^0.1.0",
+    "@atproto/lexicon": "^0.2.0",
+    "@atproto/xrpc": "^0.3.0"
   },
   "devDependencies": {
-    "@atproto/lex-cli": "*",
-    "@atproto/pds": "*",
-    "common-tags": "^1.8.2"
-  }
-}
+    "common-tags": "^1.8.2",
+    "@atproto/pds": "^0.1.12",
+    "@atproto/lex-cli": "^0.2.0"
+  },
+  "scripts": {
+    "codegen": "pnpm docgen && node ./scripts/generate-code.mjs && lex gen-api ./src/client ../../lexicons/com/atproto/*/* ../../lexicons/app/bsky/*/*",
+    "docgen": "node ./scripts/generate-docs.mjs",
+    "build": "node ./build.js",
+    "postbuild": "tsc --build tsconfig.build.json",
+    "update-main-to-dist": "node ../../update-main-to-dist.js packages/api",
+    "test": "jest",
+    "bench": "jest --config jest.bench.config.js",
+    "bench:profile": "node --inspect-brk ../../node_modules/.bin/jest --config jest.bench.config.js"
+  },
+  "types": "dist/index.d.ts"
+}

package/src/bsky-agent.ts

@@ -8,6 +8,15 @@ import {
 } from './client'
 import { BskyPreferences, BskyLabelPreference } from './types'
 
+declare global {
+  interface Array<T> {
+    findLast(
+      predicate: (value: T, index: number, obj: T[]) => unknown,
+      thisArg?: any,
+    ): T
+  }
+}
+
 export class BskyAgent extends AtpAgent {
   get app() {
     return this.api.app
@@ -247,6 +256,7 @@ export class BskyAgent extends AtpAgent {
       },
       adultContentEnabled: false,
       contentLabels: {},
+      birthDate: undefined,
     }
     const res = await this.app.bsky.actor.getPreferences({})
     for (const pref of res.data.preferences) {
@@ -272,6 +282,13 @@ export class BskyAgent extends AtpAgent {
       ) {
         prefs.feeds.saved = pref.saved
         prefs.feeds.pinned = pref.pinned
+      } else if (
+        AppBskyActorDefs.isPersonalDetailsPref(pref) &&
+        AppBskyActorDefs.validatePersonalDetailsPref(pref).success
+      ) {
+        if (pref.birthDate) {
+          prefs.birthDate = new Date(pref.birthDate)
+        }
       }
     }
     return prefs
@@ -314,20 +331,22 @@ export class BskyAgent extends AtpAgent {
 
   async setAdultContentEnabled(v: boolean) {
     await updatePreferences(this, (prefs: AppBskyActorDefs.Preferences) => {
-      const existing = prefs.find(
+      let adultContentPref = prefs.findLast(
         (pref) =>
           AppBskyActorDefs.isAdultContentPref(pref) &&
           AppBskyActorDefs.validateAdultContentPref(pref).success,
       )
-      if (existing) {
-        existing.enabled = v
+      if (adultContentPref) {
+        adultContentPref.enabled = v
       } else {
-        prefs.push({
+        adultContentPref = {
           $type: 'app.bsky.actor.defs#adultContentPref',
           enabled: v,
-        })
+        }
       }
       return prefs
+        .filter((pref) => !AppBskyActorDefs.isAdultContentPref(pref))
+        .concat([adultContentPref])
     })
   }
 
@@ -338,22 +357,53 @@ export class BskyAgent extends AtpAgent {
     }
 
     await updatePreferences(this, (prefs: AppBskyActorDefs.Preferences) => {
-      const existing = prefs.find(
+      let labelPref = prefs.findLast(
         (pref) =>
           AppBskyActorDefs.isContentLabelPref(pref) &&
           AppBskyActorDefs.validateAdultContentPref(pref).success &&
           pref.label === key,
       )
-      if (existing) {
-        existing.visibility = value
+      if (labelPref) {
+        labelPref.visibility = value
       } else {
-        prefs.push({
+        labelPref = {
           $type: 'app.bsky.actor.defs#contentLabelPref',
           label: key,
           visibility: value,
-        })
+        }
+      }
+      return prefs
+        .filter(
+          (pref) =>
+            !AppBskyActorDefs.isContentLabelPref(pref) || pref.label !== key,
+        )
+        .concat([labelPref])
+    })
+  }
+
+  async setPersonalDetails({
+    birthDate,
+  }: {
+    birthDate: string | Date | undefined
+  }) {
+    birthDate = birthDate instanceof Date ? birthDate.toISOString() : birthDate
+    await updatePreferences(this, (prefs: AppBskyActorDefs.Preferences) => {
+      let personalDetailsPref = prefs.findLast(
+        (pref) =>
+          AppBskyActorDefs.isPersonalDetailsPref(pref) &&
+          AppBskyActorDefs.validatePersonalDetailsPref(pref).success,
+      )
+      if (personalDetailsPref) {
+        personalDetailsPref.birthDate = birthDate
+      } else {
+        personalDetailsPref = {
+          $type: 'app.bsky.actor.defs#personalDetailsPref',
+          birthDate,
+        }
       }
       return prefs
+        .filter((pref) => !AppBskyActorDefs.isPersonalDetailsPref(pref))
+        .concat([personalDetailsPref])
     })
   }
 }
@@ -394,7 +444,7 @@ async function updateFeedPreferences(
 ): Promise<{ saved: string[]; pinned: string[] }> {
   let res
   await updatePreferences(agent, (prefs: AppBskyActorDefs.Preferences) => {
-    let feedsPref = prefs.find(
+    let feedsPref = prefs.findLast(
       (pref) =>
         AppBskyActorDefs.isSavedFeedsPref(pref) &&
         AppBskyActorDefs.validateSavedFeedsPref(pref).success,

package/src/client/lexicons.ts

@@ -3714,6 +3714,7 @@ export const schemaDict = {
             'lex:app.bsky.actor.defs#adultContentPref',
             'lex:app.bsky.actor.defs#contentLabelPref',
             'lex:app.bsky.actor.defs#savedFeedsPref',
+            'lex:app.bsky.actor.defs#personalDetailsPref',
           ],
         },
       },
@@ -3760,6 +3761,16 @@ export const schemaDict = {
           },
         },
       },
+      personalDetailsPref: {
+        type: 'object',
+        properties: {
+          birthDate: {
+            type: 'string',
+            format: 'datetime',
+            description: 'The birth date of the owner of the account.',
+          },
+        },
+      },
     },
   },
   AppBskyActorGetPreferences: {
@@ -4145,6 +4156,26 @@ export const schemaDict = {
           alt: {
             type: 'string',
           },
+          aspectRatio: {
+            type: 'ref',
+            ref: 'lex:app.bsky.embed.images#aspectRatio',
+          },
+        },
+      },
+      aspectRatio: {
+        type: 'object',
+        description:
+          'width:height represents an aspect ratio. It may be approximate, and may not correspond to absolute dimensions in any given unit.',
+        required: ['width', 'height'],
+        properties: {
+          width: {
+            type: 'integer',
+            minimum: 1,
+          },
+          height: {
+            type: 'integer',
+            minimum: 1,
+          },
         },
       },
       view: {
@@ -4174,6 +4205,10 @@ export const schemaDict = {
           alt: {
             type: 'string',
           },
+          aspectRatio: {
+            type: 'ref',
+            ref: 'lex:app.bsky.embed.images#aspectRatio',
+          },
         },
       },
     },

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

@@ -108,6 +108,7 @@ export type Preferences = (
   | AdultContentPref
   | ContentLabelPref
   | SavedFeedsPref
+  | PersonalDetailsPref
   | { $type: string; [k: string]: unknown }
 )[]
 
@@ -163,3 +164,21 @@ export function isSavedFeedsPref(v: unknown): v is SavedFeedsPref {
 export function validateSavedFeedsPref(v: unknown): ValidationResult {
   return lexicons.validate('app.bsky.actor.defs#savedFeedsPref', v)
 }
+
+export interface PersonalDetailsPref {
+  /** The birth date of the owner of the account. */
+  birthDate?: string
+  [k: string]: unknown
+}
+
+export function isPersonalDetailsPref(v: unknown): v is PersonalDetailsPref {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'app.bsky.actor.defs#personalDetailsPref'
+  )
+}
+
+export function validatePersonalDetailsPref(v: unknown): ValidationResult {
+  return lexicons.validate('app.bsky.actor.defs#personalDetailsPref', v)
+}

package/src/client/types/app/bsky/embed/images.ts

@@ -27,6 +27,7 @@ export function validateMain(v: unknown): ValidationResult {
 export interface Image {
   image: BlobRef
   alt: string
+  aspectRatio?: AspectRatio
   [k: string]: unknown
 }
 
@@ -40,6 +41,25 @@ export function validateImage(v: unknown): ValidationResult {
   return lexicons.validate('app.bsky.embed.images#image', v)
 }
 
+/** width:height represents an aspect ratio. It may be approximate, and may not correspond to absolute dimensions in any given unit. */
+export interface AspectRatio {
+  width: number
+  height: number
+  [k: string]: unknown
+}
+
+export function isAspectRatio(v: unknown): v is AspectRatio {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'app.bsky.embed.images#aspectRatio'
+  )
+}
+
+export function validateAspectRatio(v: unknown): ValidationResult {
+  return lexicons.validate('app.bsky.embed.images#aspectRatio', v)
+}
+
 export interface View {
   images: ViewImage[]
   [k: string]: unknown
@@ -59,6 +79,7 @@ export interface ViewImage {
   thumb: string
   fullsize: string
   alt: string
+  aspectRatio?: AspectRatio
   [k: string]: unknown
 }
 

package/src/moderation/const/label-groups.ts

@@ -130,6 +130,7 @@ export const LABEL_GROUPS: LabelGroupDefinitionMap = {
       LABELS['net-abuse'],
       LABELS['impersonation'],
       LABELS['scam'],
+      LABELS['misleading'],
     ],
     strings: {
       settings: {

package/src/moderation/const/labels.ts

@@ -795,4 +795,34 @@ export const LABELS: LabelDefinitionMap = {
       },
     },
   },
+  misleading: {
+    id: 'misleading',
+    preferences: ['ignore', 'warn', 'hide'],
+    flags: [],
+    onwarn: 'alert',
+    groupId: 'misinfo',
+    configurable: true,
+    strings: {
+      settings: {
+        en: {
+          name: 'Misleading',
+          description: 'Accounts which share misleading information.',
+        },
+      },
+      account: {
+        en: {
+          name: 'Misleading',
+          description:
+            'The moderators believe this account is spreading misleading information.',
+        },
+      },
+      content: {
+        en: {
+          name: 'Misleading',
+          description:
+            'The moderators believe this account is spreading misleading information.',
+        },
+      },
+    },
+  },
 }

package/src/types.ts

@@ -89,4 +89,5 @@ export interface BskyPreferences {
   }
   adultContentEnabled: boolean
   contentLabels: Record<string, BskyLabelPreference>
+  birthDate: Date | undefined
 }

package/tests/bsky-agent.test.ts

@@ -215,6 +215,7 @@ describe('agent', () => {
         feeds: { pinned: undefined, saved: undefined },
         adultContentEnabled: false,
         contentLabels: {},
+        birthDate: undefined,
       })
 
       await agent.setAdultContentEnabled(true)
@@ -222,6 +223,7 @@ describe('agent', () => {
         feeds: { pinned: undefined, saved: undefined },
         adultContentEnabled: true,
         contentLabels: {},
+        birthDate: undefined,
       })
 
       await agent.setAdultContentEnabled(false)
@@ -229,6 +231,7 @@ describe('agent', () => {
         feeds: { pinned: undefined, saved: undefined },
         adultContentEnabled: false,
         contentLabels: {},
+        birthDate: undefined,
       })
 
       await agent.setContentLabelPref('impersonation', 'warn')
@@ -238,6 +241,7 @@ describe('agent', () => {
         contentLabels: {
           impersonation: 'warn',
         },
+        birthDate: undefined,
       })
 
       await agent.setContentLabelPref('spam', 'show') // will convert to 'ignore'
@@ -249,6 +253,7 @@ describe('agent', () => {
           impersonation: 'hide',
           spam: 'ignore',
         },
+        birthDate: undefined,
       })
 
       await agent.addSavedFeed('at://bob.com/app.bsky.feed.generator/fake')
@@ -262,6 +267,7 @@ describe('agent', () => {
           impersonation: 'hide',
           spam: 'ignore',
         },
+        birthDate: undefined,
       })
 
       await agent.addPinnedFeed('at://bob.com/app.bsky.feed.generator/fake')
@@ -275,6 +281,7 @@ describe('agent', () => {
           impersonation: 'hide',
           spam: 'ignore',
         },
+        birthDate: undefined,
       })
 
       await agent.removePinnedFeed('at://bob.com/app.bsky.feed.generator/fake')
@@ -288,6 +295,7 @@ describe('agent', () => {
           impersonation: 'hide',
           spam: 'ignore',
         },
+        birthDate: undefined,
       })
 
       await agent.removeSavedFeed('at://bob.com/app.bsky.feed.generator/fake')
@@ -301,6 +309,7 @@ describe('agent', () => {
           impersonation: 'hide',
           spam: 'ignore',
         },
+        birthDate: undefined,
       })
 
       await agent.addPinnedFeed('at://bob.com/app.bsky.feed.generator/fake')
@@ -314,6 +323,7 @@ describe('agent', () => {
           impersonation: 'hide',
           spam: 'ignore',
         },
+        birthDate: undefined,
       })
 
       await agent.addPinnedFeed('at://bob.com/app.bsky.feed.generator/fake2')
@@ -333,6 +343,7 @@ describe('agent', () => {
           impersonation: 'hide',
           spam: 'ignore',
         },
+        birthDate: undefined,
       })
 
       await agent.removeSavedFeed('at://bob.com/app.bsky.feed.generator/fake')
@@ -346,7 +357,178 @@ describe('agent', () => {
           impersonation: 'hide',
           spam: 'ignore',
         },
+        birthDate: undefined,
       })
+
+      await agent.setPersonalDetails({ birthDate: '2023-09-11T18:05:42.556Z' })
+      await expect(agent.getPreferences()).resolves.toStrictEqual({
+        feeds: {
+          pinned: ['at://bob.com/app.bsky.feed.generator/fake2'],
+          saved: ['at://bob.com/app.bsky.feed.generator/fake2'],
+        },
+        adultContentEnabled: false,
+        contentLabels: {
+          impersonation: 'hide',
+          spam: 'ignore',
+        },
+        birthDate: new Date('2023-09-11T18:05:42.556Z'),
+      })
+    })
+
+    it('resolves duplicates correctly', async () => {
+      const agent = new BskyAgent({ service: server.url })
+
+      await agent.createAccount({
+        handle: 'user6.test',
+        email: 'user6@test.com',
+        password: 'password',
+      })
+
+      await agent.app.bsky.actor.putPreferences({
+        preferences: [
+          {
+            $type: 'app.bsky.actor.defs#contentLabelPref',
+            label: 'nsfw',
+            visibility: 'show',
+          },
+          {
+            $type: 'app.bsky.actor.defs#contentLabelPref',
+            label: 'nsfw',
+            visibility: 'hide',
+          },
+          {
+            $type: 'app.bsky.actor.defs#contentLabelPref',
+            label: 'nsfw',
+            visibility: 'show',
+          },
+          {
+            $type: 'app.bsky.actor.defs#contentLabelPref',
+            label: 'nsfw',
+            visibility: 'warn',
+          },
+          {
+            $type: 'app.bsky.actor.defs#adultContentPref',
+            enabled: true,
+          },
+          {
+            $type: 'app.bsky.actor.defs#adultContentPref',
+            enabled: false,
+          },
+          {
+            $type: 'app.bsky.actor.defs#adultContentPref',
+            enabled: true,
+          },
+          {
+            $type: 'app.bsky.actor.defs#savedFeedsPref',
+            pinned: [
+              'at://bob.com/app.bsky.feed.generator/fake',
+              'at://bob.com/app.bsky.feed.generator/fake2',
+            ],
+            saved: [
+              'at://bob.com/app.bsky.feed.generator/fake',
+              'at://bob.com/app.bsky.feed.generator/fake2',
+            ],
+          },
+          {
+            $type: 'app.bsky.actor.defs#savedFeedsPref',
+            pinned: [],
+            saved: [],
+          },
+          {
+            $type: 'app.bsky.actor.defs#personalDetailsPref',
+            birthDate: '2023-09-11T18:05:42.556Z',
+          },
+          {
+            $type: 'app.bsky.actor.defs#personalDetailsPref',
+            birthDate: '2021-09-11T18:05:42.556Z',
+          },
+        ],
+      })
+      await expect(agent.getPreferences()).resolves.toStrictEqual({
+        feeds: {
+          pinned: [],
+          saved: [],
+        },
+        adultContentEnabled: true,
+        contentLabels: {
+          nsfw: 'warn',
+        },
+        birthDate: new Date('2021-09-11T18:05:42.556Z'),
+      })
+
+      await agent.setAdultContentEnabled(false)
+      await expect(agent.getPreferences()).resolves.toStrictEqual({
+        feeds: {
+          pinned: [],
+          saved: [],
+        },
+        adultContentEnabled: false,
+        contentLabels: {
+          nsfw: 'warn',
+        },
+        birthDate: new Date('2021-09-11T18:05:42.556Z'),
+      })
+
+      await agent.setContentLabelPref('nsfw', 'hide')
+      await expect(agent.getPreferences()).resolves.toStrictEqual({
+        feeds: {
+          pinned: [],
+          saved: [],
+        },
+        adultContentEnabled: false,
+        contentLabels: {
+          nsfw: 'hide',
+        },
+        birthDate: new Date('2021-09-11T18:05:42.556Z'),
+      })
+
+      await agent.addPinnedFeed('at://bob.com/app.bsky.feed.generator/fake')
+      await expect(agent.getPreferences()).resolves.toStrictEqual({
+        feeds: {
+          pinned: ['at://bob.com/app.bsky.feed.generator/fake'],
+          saved: ['at://bob.com/app.bsky.feed.generator/fake'],
+        },
+        adultContentEnabled: false,
+        contentLabels: {
+          nsfw: 'hide',
+        },
+        birthDate: new Date('2021-09-11T18:05:42.556Z'),
+      })
+
+      await agent.setPersonalDetails({ birthDate: '2023-09-11T18:05:42.556Z' })
+      await expect(agent.getPreferences()).resolves.toStrictEqual({
+        feeds: {
+          pinned: ['at://bob.com/app.bsky.feed.generator/fake'],
+          saved: ['at://bob.com/app.bsky.feed.generator/fake'],
+        },
+        adultContentEnabled: false,
+        contentLabels: {
+          nsfw: 'hide',
+        },
+        birthDate: new Date('2023-09-11T18:05:42.556Z'),
+      })
+
+      const res = await agent.app.bsky.actor.getPreferences()
+      await expect(res.data.preferences).toStrictEqual([
+        {
+          $type: 'app.bsky.actor.defs#adultContentPref',
+          enabled: false,
+        },
+        {
+          $type: 'app.bsky.actor.defs#contentLabelPref',
+          label: 'nsfw',
+          visibility: 'hide',
+        },
+        {
+          $type: 'app.bsky.actor.defs#savedFeedsPref',
+          pinned: ['at://bob.com/app.bsky.feed.generator/fake'],
+          saved: ['at://bob.com/app.bsky.feed.generator/fake'],
+        },
+        {
+          $type: 'app.bsky.actor.defs#personalDetailsPref',
+          birthDate: '2023-09-11T18:05:42.556Z',
+        },
+      ])
     })
   })
 })

package/tsconfig.build.json

@@ -1,4 +1,4 @@
 {
   "extends": "./tsconfig.json",
   "exclude": ["**/*.spec.ts", "**/*.test.ts"]
-}
+}

package/update-pkg.js

@@ -1,14 +0,0 @@
-const pkgJson = require('@npmcli/package-json')
-
-if (process.argv.includes('--update-main-to-dist')) {
-  return pkgJson
-    .load(__dirname)
-    .then((pkg) => pkg.update({ main: 'dist/index.js' }))
-    .then((pkg) => pkg.save())
-}
-if (process.argv.includes('--update-main-to-src')) {
-  return pkgJson
-    .load(__dirname)
-    .then((pkg) => pkg.update({ main: 'src/index.ts' }))
-    .then((pkg) => pkg.save())
-}