@atproto/api 0.6.15 → 0.6.17

package/dist/moderation/subjects/feed-generator.d.ts

@@ -1,2 +1,2 @@
 import { ModerationSubjectFeedGenerator, ModerationDecision, ModerationOpts } from '../types';
-export declare function decideFeedGenerator(subject: ModerationSubjectFeedGenerator, opts: ModerationOpts): ModerationDecision;
+export declare function decideFeedGenerator(_subject: ModerationSubjectFeedGenerator, _opts: ModerationOpts): ModerationDecision;

package/dist/moderation/subjects/user-list.d.ts

@@ -1,2 +1,2 @@
 import { ModerationSubjectUserList, ModerationOpts, ModerationDecision } from '../types';
-export declare function decideUserList(subject: ModerationSubjectUserList, opts: ModerationOpts): ModerationDecision;
+export declare function decideUserList(_subject: ModerationSubjectUserList, _opts: ModerationOpts): ModerationDecision;

package/dist/types.d.ts

@@ -1,5 +1,4 @@
 import { LabelPreference } from './moderation/types';
-import { AppBskyActorDefs } from './client';
 export declare type AtpSessionEvent = 'create' | 'create-failed' | 'update' | 'expired';
 export interface AtpSessionData {
     refreshJwt: string;
@@ -34,13 +33,26 @@ export interface AtpAgentGlobalOpts {
     fetch: AtpAgentFetchHandler;
 }
 export declare type BskyLabelPreference = LabelPreference | 'show';
+export interface BskyFeedViewPreference {
+    hideReplies: boolean;
+    hideRepliesByUnfollowed: boolean;
+    hideRepliesByLikeCount: number;
+    hideReposts: boolean;
+    hideQuotePosts: boolean;
+    [key: string]: any;
+}
+export interface BskyThreadViewPreference {
+    sort: string;
+    prioritizeFollowedUsers: boolean;
+    [key: string]: any;
+}
 export interface BskyPreferences {
     feeds: {
         saved?: string[];
         pinned?: string[];
     };
-    feedViewPrefs: Record<string, Omit<AppBskyActorDefs.FeedViewPref, '$type'>>;
-    threadViewPrefs: Omit<AppBskyActorDefs.ThreadViewPref, '$type'>;
+    feedViewPrefs: Record<string, BskyFeedViewPreference>;
+    threadViewPrefs: BskyThreadViewPreference;
     adultContentEnabled: boolean;
     contentLabels: Record<string, BskyLabelPreference>;
     birthDate: Date | undefined;

package/package.json

@@ -1,13 +1,20 @@
 {
   "name": "@atproto/api",
-  "version": "0.6.15",
-  "main": "dist/index.js",
+  "version": "0.6.17",
   "license": "MIT",
+  "description": "Client library for atproto and Bluesky",
+  "keywords": [
+    "atproto",
+    "bluesky",
+    "api"
+  ],
+  "homepage": "https://atproto.com",
   "repository": {
     "type": "git",
-    "url": "https://github.com/bluesky-social/atproto.git",
+    "url": "https://github.com/bluesky-social/atproto",
     "directory": "packages/api"
   },
+  "main": "dist/index.js",
   "dependencies": {
     "multiformats": "^9.9.0",
     "tlds": "^1.234.0",
@@ -20,7 +27,7 @@
   "devDependencies": {
     "common-tags": "^1.8.2",
     "@atproto/lex-cli": "^0.2.1",
-    "@atproto/pds": "^0.1.15"
+    "@atproto/pds": "^0.1.17"
   },
   "scripts": {
     "codegen": "pnpm docgen && node ./scripts/generate-code.mjs && lex gen-api ./src/client ../../lexicons/com/atproto/*/* ../../lexicons/app/bsky/*/*",

package/src/agent.ts

@@ -7,7 +7,6 @@ import {
   ComAtprotoServerCreateSession,
   ComAtprotoServerGetSession,
   ComAtprotoServerRefreshSession,
-  ComAtprotoRepoUploadBlob,
 } from './client'
 import {
   AtpSessionData,

package/src/bsky-agent.ts

@@ -6,7 +6,12 @@ import {
   AppBskyActorDefs,
   ComAtprotoRepoPutRecord,
 } from './client'
-import { BskyPreferences, BskyLabelPreference } from './types'
+import {
+  BskyPreferences,
+  BskyLabelPreference,
+  BskyFeedViewPreference,
+  BskyThreadViewPreference,
+} from './types'
 
 const FEED_VIEW_PREF_DEFAULTS = {
   hideReplies: false,
@@ -311,12 +316,14 @@ export class BskyAgent extends AtpAgent {
         AppBskyActorDefs.isFeedViewPref(pref) &&
         AppBskyActorDefs.validateFeedViewPref(pref).success
       ) {
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
         const { $type, feed, ...v } = pref
         prefs.feedViewPrefs[pref.feed] = { ...FEED_VIEW_PREF_DEFAULTS, ...v }
       } else if (
         AppBskyActorDefs.isThreadViewPref(pref) &&
         AppBskyActorDefs.validateThreadViewPref(pref).success
       ) {
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
         const { $type, ...v } = pref
         prefs.threadViewPrefs = { ...prefs.threadViewPrefs, ...v }
       }
@@ -437,10 +444,7 @@ export class BskyAgent extends AtpAgent {
     })
   }
 
-  async setFeedViewPrefs(
-    feed: string,
-    pref: Omit<AppBskyActorDefs.FeedViewPref, '$type' | 'feed'>,
-  ) {
+  async setFeedViewPrefs(feed: string, pref: Partial<BskyFeedViewPreference>) {
     await updatePreferences(this, (prefs: AppBskyActorDefs.Preferences) => {
       const existing = prefs.findLast(
         (pref) =>
@@ -459,9 +463,7 @@ export class BskyAgent extends AtpAgent {
     })
   }
 
-  async setThreadViewPrefs(
-    pref: Omit<AppBskyActorDefs.ThreadViewPref, '$type'>,
-  ) {
+  async setThreadViewPrefs(pref: Partial<BskyThreadViewPreference>) {
     await updatePreferences(this, (prefs: AppBskyActorDefs.Preferences) => {
       const existing = prefs.findLast(
         (pref) =>

package/src/client/lexicons.ts

@@ -5622,6 +5622,16 @@ export const schemaDict = {
               type: 'union',
               refs: ['lex:com.atproto.label.defs#selfLabels'],
             },
+            tags: {
+              type: 'array',
+              maxLength: 8,
+              items: {
+                type: 'string',
+                maxLength: 640,
+                maxGraphemes: 64,
+              },
+              description: 'Additional non-inline tags describing this post.',
+            },
             createdAt: {
               type: 'string',
               format: 'datetime',
@@ -6761,6 +6771,7 @@ export const schemaDict = {
               refs: [
                 'lex:app.bsky.richtext.facet#mention',
                 'lex:app.bsky.richtext.facet#link',
+                'lex:app.bsky.richtext.facet#tag',
               ],
             },
           },
@@ -6788,6 +6799,18 @@ export const schemaDict = {
           },
         },
       },
+      tag: {
+        type: 'object',
+        description: 'A hashtag.',
+        required: ['tag'],
+        properties: {
+          tag: {
+            type: 'string',
+            maxLength: 640,
+            maxGraphemes: 64,
+          },
+        },
+      },
       byteSlice: {
         type: 'object',
         description:
@@ -6838,7 +6861,8 @@ export const schemaDict = {
     defs: {
       main: {
         type: 'query',
-        description: 'An unspecced view of globally popular items',
+        description:
+          'DEPRECATED: will be removed soon, please find a feed generator alternative',
         parameters: {
           type: 'params',
           properties: {

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

@@ -29,6 +29,8 @@ export interface Record {
   labels?:
     | ComAtprotoLabelDefs.SelfLabels
     | { $type: string; [k: string]: unknown }
+  /** Additional non-inline tags describing this post. */
+  tags?: string[]
   createdAt: string
   [k: string]: unknown
 }

package/src/client/types/app/bsky/richtext/facet.ts

@@ -8,7 +8,7 @@ import { CID } from 'multiformats/cid'
 
 export interface Main {
   index: ByteSlice
-  features: (Mention | Link | { $type: string; [k: string]: unknown })[]
+  features: (Mention | Link | Tag | { $type: string; [k: string]: unknown })[]
   [k: string]: unknown
 }
 
@@ -61,6 +61,22 @@ export function validateLink(v: unknown): ValidationResult {
   return lexicons.validate('app.bsky.richtext.facet#link', v)
 }
 
+/** A hashtag. */
+export interface Tag {
+  tag: string
+  [k: string]: unknown
+}
+
+export function isTag(v: unknown): v is Tag {
+  return (
+    isObj(v) && hasProp(v, '$type') && v.$type === 'app.bsky.richtext.facet#tag'
+  )
+}
+
+export function validateTag(v: unknown): ValidationResult {
+  return lexicons.validate('app.bsky.richtext.facet#tag', v)
+}
+
 /** A text segment. Start is inclusive, end is exclusive. Indices are for utf8-encoded strings. */
 export interface ByteSlice {
   byteStart: number

package/src/moderation/subjects/feed-generator.ts

@@ -5,8 +5,8 @@ import {
 } from '../types'
 
 export function decideFeedGenerator(
-  subject: ModerationSubjectFeedGenerator,
-  opts: ModerationOpts,
+  _subject: ModerationSubjectFeedGenerator,
+  _opts: ModerationOpts,
 ): ModerationDecision {
   // TODO handle labels applied on the feed generator itself
   return ModerationDecision.noop()

package/src/moderation/subjects/user-list.ts

@@ -5,8 +5,8 @@ import {
 } from '../types'
 
 export function decideUserList(
-  subject: ModerationSubjectUserList,
-  opts: ModerationOpts,
+  _subject: ModerationSubjectUserList,
+  _opts: ModerationOpts,
 ): ModerationDecision {
   // TODO handle labels applied on the list itself
   return ModerationDecision.noop()

package/src/moderation/util.ts

@@ -1,8 +1,4 @@
-import {
-  AppBskyEmbedRecord,
-  AppBskyEmbedRecordWithMedia,
-  AppBskyFeedPost,
-} from '../client'
+import { AppBskyEmbedRecord, AppBskyEmbedRecordWithMedia } from '../client'
 import { ModerationDecision, ModerationUI } from './types'
 
 export function takeHighestPriorityDecision(

package/src/rich-text/sanitization.ts

@@ -1,6 +1,8 @@
 import { RichText } from './rich-text'
 import { UnicodeString } from './unicode'
 
+// this regex is intentionally matching on the zero-with-separator codepoint
+// eslint-disable-next-line no-misleading-character-class
 const EXCESS_SPACE_RE = /[\r\n]([\u00AD\u2060\u200D\u200C\u200B\s]*[\r\n]){2,}/
 const REPLACEMENT_STR = '\n\n'
 

package/src/types.ts

@@ -1,5 +1,4 @@
 import { LabelPreference } from './moderation/types'
-import { AppBskyActorDefs } from './client'
 
 /**
  * Used by the PersistSessionHandler to indicate what change occurred
@@ -81,15 +80,37 @@ export type BskyLabelPreference = LabelPreference | 'show'
 // TEMP we need to permanently convert 'show' to 'ignore', for now we manually convert -prf
 
 /**
- * Bluesky preferences object
+ * Bluesky feed view preferences
+ */
+
+export interface BskyFeedViewPreference {
+  hideReplies: boolean
+  hideRepliesByUnfollowed: boolean
+  hideRepliesByLikeCount: number
+  hideReposts: boolean
+  hideQuotePosts: boolean
+  [key: string]: any
+}
+
+/**
+ * Bluesky thread view preferences
+ */
+export interface BskyThreadViewPreference {
+  sort: string
+  prioritizeFollowedUsers: boolean
+  [key: string]: any
+}
+
+/**
+ * Bluesky preferences
  */
 export interface BskyPreferences {
   feeds: {
     saved?: string[]
     pinned?: string[]
   }
-  feedViewPrefs: Record<string, Omit<AppBskyActorDefs.FeedViewPref, '$type'>>
-  threadViewPrefs: Omit<AppBskyActorDefs.ThreadViewPref, '$type'>
+  feedViewPrefs: Record<string, BskyFeedViewPreference>
+  threadViewPrefs: BskyThreadViewPreference
   adultContentEnabled: boolean
   contentLabels: Record<string, BskyLabelPreference>
   birthDate: Date | undefined

package/tests/agent.test.ts

@@ -197,7 +197,7 @@ describe('agent', () => {
 
     // put the agent through the auth flow
     AtpAgent.configure({ fetch: tokenExpiredFetchHandler })
-    const res1 = await agent.api.app.bsky.feed.getTimeline()
+    const res1 = await createPost(agent)
     AtpAgent.configure({ fetch: defaultFetchHandler })
 
     expect(res1.success).toEqual(true)
@@ -267,9 +267,9 @@ describe('agent', () => {
     // put the agent through the auth flow
     AtpAgent.configure({ fetch: tokenExpiredFetchHandler })
     const [res1, res2, res3] = await Promise.all([
-      agent.api.app.bsky.feed.getTimeline(),
-      agent.api.app.bsky.feed.getTimeline(),
-      agent.api.app.bsky.feed.getTimeline(),
+      createPost(agent),
+      createPost(agent),
+      createPost(agent),
     ])
     AtpAgent.configure({ fetch: defaultFetchHandler })
 
@@ -462,3 +462,14 @@ describe('agent', () => {
     })
   })
 })
+
+const createPost = async (agent: AtpAgent) => {
+  return agent.api.com.atproto.repo.createRecord({
+    repo: agent.session?.did ?? '',
+    collection: 'app.bsky.feed.post',
+    record: {
+      text: 'hello there',
+      createdAt: new Date().toISOString(),
+    },
+  })
+}

package/tests/bsky-agent.test.ts

@@ -20,6 +20,20 @@ describe('agent', () => {
     await close()
   })
 
+  const getProfileDisplayName = async (
+    agent: BskyAgent,
+  ): Promise<string | undefined> => {
+    try {
+      const res = await agent.api.app.bsky.actor.profile.get({
+        repo: agent.session?.did || '',
+        rkey: 'self',
+      })
+      return res.value.displayName ?? ''
+    } catch (err) {
+      return undefined
+    }
+  }
+
   it('upsertProfile correctly creates and updates profiles.', async () => {
     const agent = new BskyAgent({ service: server.url })
 
@@ -28,9 +42,8 @@ describe('agent', () => {
       email: 'user1@test.com',
       password: 'password',
     })
-
-    const profile1 = await agent.getProfile({ actor: agent.session?.did || '' })
-    expect(profile1.data.displayName).toBeFalsy()
+    const displayName1 = await getProfileDisplayName(agent)
+    expect(displayName1).toBeFalsy()
 
     await agent.upsertProfile((existing) => {
       expect(existing).toBeFalsy()
@@ -39,8 +52,8 @@ describe('agent', () => {
       }
     })
 
-    const profile2 = await agent.getProfile({ actor: agent.session?.did || '' })
-    expect(profile2.data.displayName).toBe('Bob')
+    const displayName2 = await getProfileDisplayName(agent)
+    expect(displayName2).toBe('Bob')
 
     await agent.upsertProfile((existing) => {
       expect(existing).toBeTruthy()
@@ -49,8 +62,8 @@ describe('agent', () => {
       }
     })
 
-    const profile3 = await agent.getProfile({ actor: agent.session?.did || '' })
-    expect(profile3.data.displayName).toBe('BOB')
+    const displayName3 = await getProfileDisplayName(agent)
+    expect(displayName3).toBe('BOB')
   })
 
   it('upsertProfile correctly handles CAS failures.', async () => {
@@ -62,12 +75,12 @@ describe('agent', () => {
       password: 'password',
     })
 
-    const profile1 = await agent.getProfile({ actor: agent.session?.did || '' })
-    expect(profile1.data.displayName).toBeFalsy()
+    const displayName1 = await getProfileDisplayName(agent)
+    expect(displayName1).toBeFalsy()
 
     let hasConflicted = false
     let ranTwice = false
-    await agent.upsertProfile(async (existing) => {
+    await agent.upsertProfile(async (_existing) => {
       if (!hasConflicted) {
         await agent.com.atproto.repo.putRecord({
           repo: agent.session?.did || '',
@@ -88,8 +101,8 @@ describe('agent', () => {
     })
     expect(ranTwice).toBe(true)
 
-    const profile2 = await agent.getProfile({ actor: agent.session?.did || '' })
-    expect(profile2.data.displayName).toBe('Bob')
+    const displayName2 = await getProfileDisplayName(agent)
+    expect(displayName2).toBe('Bob')
   })
 
   it('upsertProfile wont endlessly retry CAS failures.', async () => {
@@ -101,10 +114,10 @@ describe('agent', () => {
       password: 'password',
     })
 
-    const profile1 = await agent.getProfile({ actor: agent.session?.did || '' })
-    expect(profile1.data.displayName).toBeFalsy()
+    const displayName1 = await getProfileDisplayName(agent)
+    expect(displayName1).toBeFalsy()
 
-    const p = agent.upsertProfile(async (existing) => {
+    const p = agent.upsertProfile(async (_existing) => {
       await agent.com.atproto.repo.putRecord({
         repo: agent.session?.did || '',
         collection: 'app.bsky.actor.profile',
@@ -130,7 +143,7 @@ describe('agent', () => {
       password: 'password',
     })
 
-    const p = agent.upsertProfile((existing) => {
+    const p = agent.upsertProfile((_existing) => {
       return {
         displayName: { string: 'Bob' },
       } as unknown as AppBskyActorProfile.Record