@atproto/api 0.6.7 → 0.6.8

package/dist/mixins/bsky.d.ts

@@ -0,0 +1,23 @@
+import { AtpAgentType } from '../types';
+export declare function addBsky<TBase extends AtpAgentType>(Base: TBase): {
+    new (...args: any[]): {
+        like(uri: string, cid: string): Promise<{
+            uri: string;
+            cid: string;
+        }>;
+        unlike(likeUri: string): Promise<void>;
+        repost(uri: string, cid: string): Promise<{
+            uri: string;
+            cid: string;
+        }>;
+        unrepost(repostUri: string): Promise<void>;
+        follow(subjectDid: string): Promise<{
+            uri: string;
+            cid: string;
+        }>;
+        unfollow(followUri: string): Promise<void>;
+        service: URL;
+        api: import("..").AtpServiceClient;
+        session?: import("../types").AtpSessionData | undefined;
+    };
+} & TBase;

package/dist/rich-text/detection.d.ts

@@ -1,4 +1,4 @@
-import { AppBskyRichtextFacet } from '../client'
-import { UnicodeString } from './unicode'
-export declare type Facet = AppBskyRichtextFacet.Main
-export declare function detectFacets(text: UnicodeString): Facet[] | undefined
+import { AppBskyRichtextFacet } from '../client';
+import { UnicodeString } from './unicode';
+export declare type Facet = AppBskyRichtextFacet.Main;
+export declare function detectFacets(text: UnicodeString): Facet[] | undefined;

package/dist/rich-text/rich-text.d.ts

@@ -1,39 +1,39 @@
-import { AtpAgent } from '../agent'
-import { AppBskyFeedPost, AppBskyRichtextFacet } from '../client'
-import { UnicodeString } from './unicode'
-export declare type Facet = AppBskyRichtextFacet.Main
-export declare type FacetLink = AppBskyRichtextFacet.Link
-export declare type FacetMention = AppBskyRichtextFacet.Mention
-export declare type Entity = AppBskyFeedPost.Entity
+import { AtpAgent } from '../agent';
+import { AppBskyFeedPost, AppBskyRichtextFacet } from '../client';
+import { UnicodeString } from './unicode';
+export declare type Facet = AppBskyRichtextFacet.Main;
+export declare type FacetLink = AppBskyRichtextFacet.Link;
+export declare type FacetMention = AppBskyRichtextFacet.Mention;
+export declare type Entity = AppBskyFeedPost.Entity;
 export interface RichTextProps {
-  text: string
-  facets?: Facet[]
-  entities?: Entity[]
+    text: string;
+    facets?: Facet[];
+    entities?: Entity[];
 }
 export interface RichTextOpts {
-  cleanNewlines?: boolean
+    cleanNewlines?: boolean;
 }
 export declare class RichTextSegment {
-  text: string
-  facet?: AppBskyRichtextFacet.Main | undefined
-  constructor(text: string, facet?: AppBskyRichtextFacet.Main | undefined)
-  get link(): FacetLink | undefined
-  isLink(): boolean
-  get mention(): FacetMention | undefined
-  isMention(): boolean
+    text: string;
+    facet?: AppBskyRichtextFacet.Main | undefined;
+    constructor(text: string, facet?: AppBskyRichtextFacet.Main | undefined);
+    get link(): FacetLink | undefined;
+    isLink(): boolean;
+    get mention(): FacetMention | undefined;
+    isMention(): boolean;
 }
 export declare class RichText {
-  unicodeText: UnicodeString
-  facets?: Facet[]
-  constructor(props: RichTextProps, opts?: RichTextOpts)
-  get text(): string
-  get length(): number
-  get graphemeLength(): number
-  clone(): RichText
-  copyInto(target: RichText): void
-  segments(): Generator<RichTextSegment, void, void>
-  insert(insertIndex: number, insertText: string): this
-  delete(removeStartIndex: number, removeEndIndex: number): this
-  detectFacets(agent: AtpAgent): Promise<void>
-  detectFacetsWithoutResolution(): void
+    unicodeText: UnicodeString;
+    facets?: Facet[];
+    constructor(props: RichTextProps, opts?: RichTextOpts);
+    get text(): string;
+    get length(): number;
+    get graphemeLength(): number;
+    clone(): RichText;
+    copyInto(target: RichText): void;
+    segments(): Generator<RichTextSegment, void, void>;
+    insert(insertIndex: number, insertText: string): this;
+    delete(removeStartIndex: number, removeEndIndex: number): this;
+    detectFacets(agent: AtpAgent): Promise<void>;
+    detectFacetsWithoutResolution(): void;
 }

package/dist/rich-text/sanitization.d.ts

@@ -1,7 +1,4 @@
-import { RichText } from './rich-text'
-export declare function sanitizeRichText(
-  richText: RichText,
-  opts: {
-    cleanNewlines?: boolean
-  },
-): RichText
+import { RichText } from './rich-text';
+export declare function sanitizeRichText(richText: RichText, opts: {
+    cleanNewlines?: boolean;
+}): RichText;

package/dist/rich-text/sanitize.d.ts

@@ -0,0 +1,4 @@
+import { RichText } from './rich-text';
+export declare function sanitizeRichText(richText: RichText, opts: {
+    cleanNewlines?: boolean;
+}): RichText;

package/dist/rich-text/unicode.d.ts

@@ -1,11 +1,11 @@
 export declare class UnicodeString {
-  utf16: string
-  utf8: Uint8Array
-  private _graphemeLen?
-  constructor(utf16: string)
-  get length(): number
-  get graphemeLength(): number
-  slice(start?: number, end?: number): string
-  utf16IndexToUtf8Index(i: number): number
-  toString(): string
+    utf16: string;
+    utf8: Uint8Array;
+    private _graphemeLen?;
+    constructor(utf16: string);
+    get length(): number;
+    get graphemeLength(): number;
+    slice(start?: number, end?: number): string;
+    utf16IndexToUtf8Index(i: number): number;
+    toString(): string;
 }

package/dist/session.d.ts

@@ -0,0 +1,42 @@
+import { CallOptions, Client as XrpcClient, ServiceClient as XrpcServiceClient, QueryParams, XRPCResponse } from '@atproto/xrpc';
+import TypedEmitter from 'typed-emitter';
+import { Client, ServiceClient } from './client';
+export declare class SessionClient extends Client {
+    service(serviceUri: string | URL): SessionServiceClient;
+}
+declare const defaultInst: SessionClient;
+export default defaultInst;
+export declare class SessionServiceClient extends ServiceClient {
+    xrpc: SessionXrpcServiceClient;
+    sessionManager: SessionManager;
+    constructor(baseClient: Client, xrpcService: SessionXrpcServiceClient);
+}
+export declare class SessionXrpcServiceClient extends XrpcServiceClient {
+    sessionManager: SessionManager;
+    refreshing?: Promise<XRPCResponse>;
+    constructor(baseClient: XrpcClient, serviceUri: string | URL);
+    call(methodNsid: string, params?: QueryParams, data?: unknown, opts?: CallOptions): Promise<XRPCResponse>;
+    refresh(opts?: CallOptions): Promise<XRPCResponse>;
+    private _refresh;
+}
+declare const SessionManager_base: new () => TypedEmitter<SessionEvents>;
+export declare class SessionManager extends SessionManager_base {
+    session?: Session;
+    get(): Session | undefined;
+    set(session: Session): void;
+    unset(): void;
+    active(): boolean;
+    accessHeaders(): {
+        authorization: string;
+    } | undefined;
+    refreshHeaders(): {
+        authorization: string;
+    } | undefined;
+}
+export declare type Session = {
+    refreshJwt: string;
+    accessJwt: string;
+};
+declare type SessionEvents = {
+    session: (session?: Session) => void;
+};

package/dist/types.d.ts

@@ -1,46 +1,44 @@
-export declare type AtpSessionEvent =
-  | 'create'
-  | 'create-failed'
-  | 'update'
-  | 'expired'
+import { LabelPreference } from './moderation/types';
+export declare type AtpSessionEvent = 'create' | 'create-failed' | 'update' | 'expired';
 export interface AtpSessionData {
-  refreshJwt: string
-  accessJwt: string
-  handle: string
-  did: string
-  email?: string
+    refreshJwt: string;
+    accessJwt: string;
+    handle: string;
+    did: string;
+    email?: string;
 }
-export declare type AtpPersistSessionHandler = (
-  evt: AtpSessionEvent,
-  session: AtpSessionData | undefined,
-) => void | Promise<void>
+export declare type AtpPersistSessionHandler = (evt: AtpSessionEvent, session: AtpSessionData | undefined) => void | Promise<void>;
 export interface AtpAgentOpts {
-  service: string | URL
-  persistSession?: AtpPersistSessionHandler
+    service: string | URL;
+    persistSession?: AtpPersistSessionHandler;
 }
 export interface AtpAgentCreateAccountOpts {
-  email: string
-  password: string
-  handle: string
-  inviteCode?: string
+    email: string;
+    password: string;
+    handle: string;
+    inviteCode?: string;
 }
 export interface AtpAgentLoginOpts {
-  identifier: string
-  password: string
+    identifier: string;
+    password: string;
 }
-declare type AtpAgentFetchHeaders = Record<string, string>
+declare type AtpAgentFetchHeaders = Record<string, string>;
 export interface AtpAgentFetchHandlerResponse {
-  status: number
-  headers: Record<string, string>
-  body: any
+    status: number;
+    headers: Record<string, string>;
+    body: any;
 }
-export declare type AtpAgentFetchHandler = (
-  httpUri: string,
-  httpMethod: string,
-  httpHeaders: AtpAgentFetchHeaders,
-  httpReqBody: any,
-) => Promise<AtpAgentFetchHandlerResponse>
+export declare type AtpAgentFetchHandler = (httpUri: string, httpMethod: string, httpHeaders: AtpAgentFetchHeaders, httpReqBody: any) => Promise<AtpAgentFetchHandlerResponse>;
 export interface AtpAgentGlobalOpts {
-  fetch: AtpAgentFetchHandler
+    fetch: AtpAgentFetchHandler;
 }
-export {}
+export declare type BskyLabelPreference = LabelPreference | 'show';
+export interface BskyPreferences {
+    feeds: {
+        saved?: string[];
+        pinned?: string[];
+    };
+    adultContentEnabled: boolean;
+    contentLabels: Record<string, BskyLabelPreference>;
+}
+export {};

package/package.json

@@ -1,7 +1,20 @@
 {
   "name": "@atproto/api",
-  "version": "0.6.7",
+  "version": "0.6.8",
   "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",
@@ -9,27 +22,15 @@
     "directory": "packages/api"
   },
   "dependencies": {
-    "multiformats": "^9.9.0",
+    "@atproto/common-web": "*",
+    "@atproto/syntax": "*",
+    "@atproto/xrpc": "*",
     "tlds": "^1.234.0",
-    "typed-emitter": "^2.1.0",
-    "@atproto/common-web": "^0.2.0",
-    "@atproto/lexicon": "^0.2.0",
-    "@atproto/uri": "^0.1.0",
-    "@atproto/xrpc": "^0.2.0"
+    "typed-emitter": "^2.1.0"
   },
   "devDependencies": {
-    "common-tags": "^1.8.2",
-    "@atproto/lex-cli": "^0.2.0",
-    "@atproto/pds": "^0.1.12"
-  },
-  "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",
-    "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"
-}
+    "@atproto/lex-cli": "*",
+    "@atproto/pds": "*",
+    "common-tags": "^1.8.2"
+  }
+}

package/src/bsky-agent.ts

@@ -1,10 +1,12 @@
-import { AtUri } from '@atproto/uri'
+import { AtUri } from '@atproto/syntax'
 import { AtpAgent } from './agent'
 import {
   AppBskyFeedPost,
   AppBskyActorProfile,
+  AppBskyActorDefs,
   ComAtprotoRepoPutRecord,
 } from './client'
+import { BskyPreferences, BskyLabelPreference } from './types'
 
 export class BskyAgent extends AtpAgent {
   get app() {
@@ -236,4 +238,182 @@ export class BskyAgent extends AtpAgent {
       seenAt,
     })
   }
+
+  async getPreferences(): Promise<BskyPreferences> {
+    const prefs: BskyPreferences = {
+      feeds: {
+        saved: undefined,
+        pinned: undefined,
+      },
+      adultContentEnabled: false,
+      contentLabels: {},
+    }
+    const res = await this.app.bsky.actor.getPreferences({})
+    for (const pref of res.data.preferences) {
+      if (
+        AppBskyActorDefs.isAdultContentPref(pref) &&
+        AppBskyActorDefs.validateAdultContentPref(pref).success
+      ) {
+        prefs.adultContentEnabled = pref.enabled
+      } else if (
+        AppBskyActorDefs.isContentLabelPref(pref) &&
+        AppBskyActorDefs.validateAdultContentPref(pref).success
+      ) {
+        let value = pref.visibility
+        if (value === 'show') {
+          value = 'ignore'
+        }
+        if (value === 'ignore' || value === 'warn' || value === 'hide') {
+          prefs.contentLabels[pref.label] = value as BskyLabelPreference
+        }
+      } else if (
+        AppBskyActorDefs.isSavedFeedsPref(pref) &&
+        AppBskyActorDefs.validateSavedFeedsPref(pref).success
+      ) {
+        prefs.feeds.saved = pref.saved
+        prefs.feeds.pinned = pref.pinned
+      }
+    }
+    return prefs
+  }
+
+  async setSavedFeeds(saved: string[], pinned: string[]) {
+    return updateFeedPreferences(this, () => ({
+      saved,
+      pinned,
+    }))
+  }
+
+  async addSavedFeed(v: string) {
+    return updateFeedPreferences(this, (saved: string[], pinned: string[]) => ({
+      saved: [...saved.filter((uri) => uri !== v), v],
+      pinned,
+    }))
+  }
+
+  async removeSavedFeed(v: string) {
+    return updateFeedPreferences(this, (saved: string[], pinned: string[]) => ({
+      saved: saved.filter((uri) => uri !== v),
+      pinned: pinned.filter((uri) => uri !== v),
+    }))
+  }
+
+  async addPinnedFeed(v: string) {
+    return updateFeedPreferences(this, (saved: string[], pinned: string[]) => ({
+      saved: [...saved.filter((uri) => uri !== v), v],
+      pinned: [...pinned.filter((uri) => uri !== v), v],
+    }))
+  }
+
+  async removePinnedFeed(v: string) {
+    return updateFeedPreferences(this, (saved: string[], pinned: string[]) => ({
+      saved,
+      pinned: pinned.filter((uri) => uri !== v),
+    }))
+  }
+
+  async setAdultContentEnabled(v: boolean) {
+    await updatePreferences(this, (prefs: AppBskyActorDefs.Preferences) => {
+      const existing = prefs.find(
+        (pref) =>
+          AppBskyActorDefs.isAdultContentPref(pref) &&
+          AppBskyActorDefs.validateAdultContentPref(pref).success,
+      )
+      if (existing) {
+        existing.enabled = v
+      } else {
+        prefs.push({
+          $type: 'app.bsky.actor.defs#adultContentPref',
+          enabled: v,
+        })
+      }
+      return prefs
+    })
+  }
+
+  async setContentLabelPref(key: string, value: BskyLabelPreference) {
+    // TEMP update old value
+    if (value === 'show') {
+      value = 'ignore'
+    }
+
+    await updatePreferences(this, (prefs: AppBskyActorDefs.Preferences) => {
+      const existing = prefs.find(
+        (pref) =>
+          AppBskyActorDefs.isContentLabelPref(pref) &&
+          AppBskyActorDefs.validateAdultContentPref(pref).success &&
+          pref.label === key,
+      )
+      if (existing) {
+        existing.visibility = value
+      } else {
+        prefs.push({
+          $type: 'app.bsky.actor.defs#contentLabelPref',
+          label: key,
+          visibility: value,
+        })
+      }
+      return prefs
+    })
+  }
+}
+
+/**
+ * This function updates the preferences of a user and allows for a callback function to be executed
+ * before the update.
+ * @param cb - cb is a callback function that takes in a single parameter of type
+ * AppBskyActorDefs.Preferences and returns either a boolean or void. This callback function is used to
+ * update the preferences of the user. The function is called with the current preferences as an
+ * argument and if the callback returns false, the preferences are not updated.
+ */
+async function updatePreferences(
+  agent: BskyAgent,
+  cb: (
+    prefs: AppBskyActorDefs.Preferences,
+  ) => AppBskyActorDefs.Preferences | false,
+) {
+  const res = await agent.app.bsky.actor.getPreferences({})
+  const newPrefs = cb(res.data.preferences)
+  if (newPrefs === false) {
+    return
+  }
+  await agent.app.bsky.actor.putPreferences({
+    preferences: newPrefs,
+  })
+}
+
+/**
+ * A helper specifically for updating feed preferences
+ */
+async function updateFeedPreferences(
+  agent: BskyAgent,
+  cb: (
+    saved: string[],
+    pinned: string[],
+  ) => { saved: string[]; pinned: string[] },
+): Promise<{ saved: string[]; pinned: string[] }> {
+  let res
+  await updatePreferences(agent, (prefs: AppBskyActorDefs.Preferences) => {
+    let feedsPref = prefs.find(
+      (pref) =>
+        AppBskyActorDefs.isSavedFeedsPref(pref) &&
+        AppBskyActorDefs.validateSavedFeedsPref(pref).success,
+    ) as AppBskyActorDefs.SavedFeedsPref | undefined
+    if (feedsPref) {
+      res = cb(feedsPref.saved, feedsPref.pinned)
+      feedsPref.saved = res.saved
+      feedsPref.pinned = res.pinned
+    } else {
+      res = cb([], [])
+      feedsPref = {
+        $type: 'app.bsky.actor.defs#savedFeedsPref',
+        saved: res.saved,
+        pinned: res.pinned,
+      }
+    }
+    return prefs
+      .filter((pref) => !AppBskyActorDefs.isSavedFeedsPref(pref))
+      .concat([feedsPref])
+  })
+  return res
 }