@atproto/api 0.7.4 → 0.9.0

package/dist/src/types/todo/social/getNotifications.d.ts

@@ -0,0 +1,31 @@
+import { Headers } from '@adxp/xrpc';
+export interface QueryParams {
+    limit?: number;
+    before?: string;
+}
+export interface CallOptions {
+    headers?: Headers;
+}
+export declare type InputSchema = undefined;
+export interface OutputSchema {
+    notifications: Notification[];
+}
+export interface Notification {
+    uri: string;
+    author: {
+        did: string;
+        name: string;
+        displayName?: string;
+    };
+    reason: string;
+    reasonSubject?: string;
+    record: {};
+    isRead: boolean;
+    indexedAt: string;
+}
+export interface Response {
+    success: boolean;
+    headers: Headers;
+    data: OutputSchema;
+}
+export declare function toKnownErr(e: any): any;

package/dist/src/types/todo/social/getPostThread.d.ts

@@ -0,0 +1,54 @@
+import { Headers } from '@adxp/xrpc';
+export interface QueryParams {
+    uri: string;
+    depth?: number;
+}
+export interface CallOptions {
+    headers?: Headers;
+}
+export declare type InputSchema = undefined;
+export interface OutputSchema {
+    thread: Post;
+}
+export interface Post {
+    uri: string;
+    author: User;
+    record: {};
+    embed?: RecordEmbed | ExternalEmbed | UnknownEmbed;
+    parent?: Post;
+    replyCount: number;
+    replies?: Post[];
+    likeCount: number;
+    repostCount: number;
+    indexedAt: string;
+    myState?: {
+        repost?: string;
+        like?: string;
+    };
+}
+export interface User {
+    did: string;
+    name: string;
+    displayName?: string;
+}
+export interface RecordEmbed {
+    type: 'record';
+    author: User;
+    record: {};
+}
+export interface ExternalEmbed {
+    type: 'external';
+    uri: string;
+    title: string;
+    description: string;
+    imageUri: string;
+}
+export interface UnknownEmbed {
+    type: string;
+}
+export interface Response {
+    success: boolean;
+    headers: Headers;
+    data: OutputSchema;
+}
+export declare function toKnownErr(e: any): any;

package/dist/src/types/todo/social/getProfile.d.ts

@@ -0,0 +1,40 @@
+import { Headers } from '@adxp/xrpc';
+export interface QueryParams {
+    user: string;
+}
+export interface CallOptions {
+    headers?: Headers;
+}
+export declare type InputSchema = undefined;
+export interface OutputSchema {
+    did: string;
+    name: string;
+    displayName?: string;
+    description?: string;
+    followersCount: number;
+    followsCount: number;
+    postsCount: number;
+    badges: Badge[];
+    myState?: {
+        follow?: string;
+    };
+}
+export interface Badge {
+    uri: string;
+    error?: string;
+    issuer?: {
+        did: string;
+        name: string;
+        displayName: string;
+    };
+    assertion?: {
+        type: string;
+    };
+    createdAt?: string;
+}
+export interface Response {
+    success: boolean;
+    headers: Headers;
+    data: OutputSchema;
+}
+export declare function toKnownErr(e: any): any;

package/dist/src/types/todo/social/getRepostedBy.d.ts

@@ -0,0 +1,26 @@
+import { Headers } from '@adxp/xrpc';
+export interface QueryParams {
+    uri: string;
+    limit?: number;
+    before?: string;
+}
+export interface CallOptions {
+    headers?: Headers;
+}
+export declare type InputSchema = undefined;
+export interface OutputSchema {
+    uri: string;
+    repostedBy: {
+        did: string;
+        name: string;
+        displayName?: string;
+        createdAt?: string;
+        indexedAt: string;
+    }[];
+}
+export interface Response {
+    success: boolean;
+    headers: Headers;
+    data: OutputSchema;
+}
+export declare function toKnownErr(e: any): any;

package/dist/src/types/todo/social/getUserFollowers.d.ts

@@ -0,0 +1,30 @@
+import { Headers } from '@adxp/xrpc';
+export interface QueryParams {
+    user: string;
+    limit?: number;
+    before?: string;
+}
+export interface CallOptions {
+    headers?: Headers;
+}
+export declare type InputSchema = undefined;
+export interface OutputSchema {
+    subject: {
+        did: string;
+        name: string;
+        displayName?: string;
+    };
+    followers: {
+        did: string;
+        name: string;
+        displayName?: string;
+        createdAt?: string;
+        indexedAt: string;
+    }[];
+}
+export interface Response {
+    success: boolean;
+    headers: Headers;
+    data: OutputSchema;
+}
+export declare function toKnownErr(e: any): any;

package/dist/src/types/todo/social/getUserFollows.d.ts

@@ -0,0 +1,30 @@
+import { Headers } from '@adxp/xrpc';
+export interface QueryParams {
+    user: string;
+    limit?: number;
+    before?: string;
+}
+export interface CallOptions {
+    headers?: Headers;
+}
+export declare type InputSchema = undefined;
+export interface OutputSchema {
+    subject: {
+        did: string;
+        name: string;
+        displayName?: string;
+    };
+    follows: {
+        did: string;
+        name: string;
+        displayName?: string;
+        createdAt?: string;
+        indexedAt: string;
+    }[];
+}
+export interface Response {
+    success: boolean;
+    headers: Headers;
+    data: OutputSchema;
+}
+export declare function toKnownErr(e: any): any;

package/dist/src/types/todo/social/like.d.ts

@@ -0,0 +1,5 @@
+export interface Record {
+    subject: string;
+    createdAt: string;
+    [k: string]: unknown;
+}

package/dist/src/types/todo/social/mediaEmbed.d.ts

@@ -0,0 +1,15 @@
+export interface Record {
+    media: MediaEmbed[];
+    [k: string]: unknown;
+}
+export interface MediaEmbed {
+    alt?: string;
+    thumb?: MediaEmbedBlob;
+    original: MediaEmbedBlob;
+    [k: string]: unknown;
+}
+export interface MediaEmbedBlob {
+    mimeType: string;
+    blobId: string;
+    [k: string]: unknown;
+}

package/dist/src/types/todo/social/post.d.ts

@@ -0,0 +1,18 @@
+export declare type TextSlice = [number, number];
+export declare type Entity = {
+    index: TextSlice;
+    type: string;
+    value: string;
+    [k: string]: unknown;
+}[];
+export interface Record {
+    text: string;
+    entities?: Entity;
+    reply?: {
+        root: string;
+        parent?: string;
+        [k: string]: unknown;
+    };
+    createdAt: string;
+    [k: string]: unknown;
+}

package/dist/src/types/todo/social/postNotificationsSeen.d.ts

@@ -0,0 +1,19 @@
+import { Headers } from '@adxp/xrpc';
+export interface QueryParams {
+}
+export interface CallOptions {
+    headers?: Headers;
+    encoding: 'application/json';
+}
+export interface InputSchema {
+    seenAt: string;
+}
+export interface OutputSchema {
+    [k: string]: unknown;
+}
+export interface Response {
+    success: boolean;
+    headers: Headers;
+    data: OutputSchema;
+}
+export declare function toKnownErr(e: any): any;

package/dist/src/types/todo/social/profile.d.ts

@@ -0,0 +1,10 @@
+export interface Record {
+    displayName: string;
+    description?: string;
+    badges?: BadgeRef[];
+    [k: string]: unknown;
+}
+export interface BadgeRef {
+    uri: string;
+    [k: string]: unknown;
+}

package/dist/src/types/todo/social/repost.d.ts

@@ -0,0 +1,5 @@
+export interface Record {
+    subject: string;
+    createdAt: string;
+    [k: string]: unknown;
+}

package/dist/types.d.ts

@@ -1,5 +1,5 @@
 import { LabelPreference } from './moderation/types';
-export declare type AtpSessionEvent = 'create' | 'create-failed' | 'update' | 'expired';
+export type AtpSessionEvent = 'create' | 'create-failed' | 'update' | 'expired' | 'network-error';
 export interface AtpSessionData {
     refreshJwt: string;
     accessJwt: string;
@@ -8,7 +8,7 @@ export interface AtpSessionData {
     email?: string;
     emailConfirmed?: boolean;
 }
-export declare type AtpPersistSessionHandler = (evt: AtpSessionEvent, session: AtpSessionData | undefined) => void | Promise<void>;
+export type AtpPersistSessionHandler = (evt: AtpSessionEvent, session: AtpSessionData | undefined) => void | Promise<void>;
 export interface AtpAgentOpts {
     service: string | URL;
     persistSession?: AtpPersistSessionHandler;
@@ -23,17 +23,17 @@ export interface AtpAgentLoginOpts {
     identifier: string;
     password: string;
 }
-declare type AtpAgentFetchHeaders = Record<string, string>;
+type AtpAgentFetchHeaders = Record<string, string>;
 export interface AtpAgentFetchHandlerResponse {
     status: number;
     headers: Record<string, string>;
     body: any;
 }
-export declare type AtpAgentFetchHandler = (httpUri: string, httpMethod: string, httpHeaders: AtpAgentFetchHeaders, httpReqBody: any) => Promise<AtpAgentFetchHandlerResponse>;
+export type AtpAgentFetchHandler = (httpUri: string, httpMethod: string, httpHeaders: AtpAgentFetchHeaders, httpReqBody: any) => Promise<AtpAgentFetchHandlerResponse>;
 export interface AtpAgentGlobalOpts {
     fetch: AtpAgentFetchHandler;
 }
-export declare type BskyLabelPreference = LabelPreference | 'show';
+export type BskyLabelPreference = LabelPreference | 'show';
 export interface BskyFeedViewPreference {
     hideReplies: boolean;
     hideRepliesByUnfollowed: boolean;

package/docs/moderation.md

@@ -85,7 +85,7 @@ import { moderatePost } from '@atproto/api'
 const postMod = moderatePost(postView, getOpts())
 
 if (postMod.content.filter) {
-  // dont render in feeds or similar
+  // don't render in feeds or similar
   // in contexts where this is disruptive (eg threads) you should ignore this and instead check blur
 }
 if (postMod.content.blur) {
@@ -123,8 +123,8 @@ import { moderateProfile } from '@atproto/api'
 
 const profileMod = moderateProfile(profileView, getOpts())
 
-if (profileMod.acount.filter) {
-  // dont render in discovery
+if (profileMod.account.filter) {
+  // don't render in discovery
 }
 if (profileMod.account.blur) {
   // render the whole account behind a cover (use profileMod.account.cause to explain)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atproto/api",
-  "version": "0.7.4",
+  "version": "0.9.0",
   "license": "MIT",
   "description": "Client library for atproto and Bluesky",
   "keywords": [
@@ -20,15 +20,15 @@
     "tlds": "^1.234.0",
     "typed-emitter": "^2.1.0",
     "zod": "^3.21.4",
-    "@atproto/common-web": "^0.2.3",
-    "@atproto/lexicon": "^0.3.1",
+    "@atproto/xrpc": "^0.4.1",
     "@atproto/syntax": "^0.1.5",
-    "@atproto/xrpc": "^0.4.1"
+    "@atproto/lexicon": "^0.3.1",
+    "@atproto/common-web": "^0.2.3"
   },
   "devDependencies": {
     "common-tags": "^1.8.2",
-    "@atproto/lex-cli": "^0.2.5",
-    "@atproto/dev-env": "^0.2.21"
+    "@atproto/lex-cli": "^0.3.0",
+    "@atproto/dev-env": "^0.2.23"
   },
   "scripts": {
     "codegen": "pnpm docgen && node ./scripts/generate-code.mjs && lex gen-api ./src/client ../../lexicons/com/atproto/*/* ../../lexicons/app/bsky/*/*",

package/src/agent.ts

@@ -1,5 +1,5 @@
 import { ErrorResponseBody, errorResponseBody } from '@atproto/xrpc'
-import { defaultFetchHandler } from '@atproto/xrpc'
+import { defaultFetchHandler, XRPCError, ResponseType } from '@atproto/xrpc'
 import { isValidDidDoc, getPdsEndpoint } from '@atproto/common-web'
 import {
   AtpBaseClient,
@@ -159,23 +159,41 @@ export class AtpAgent {
     try {
       this.session = session
       const res = await this.api.com.atproto.server.getSession()
-      if (!res.success || res.data.did !== this.session.did) {
-        throw new Error('Invalid session')
+      if (res.data.did !== this.session.did) {
+        throw new XRPCError(
+          ResponseType.InvalidRequest,
+          'Invalid session',
+          'InvalidDID',
+        )
       }
       this.session.email = res.data.email
       this.session.handle = res.data.handle
       this.session.emailConfirmed = res.data.emailConfirmed
       this._updateApiEndpoint(res.data.didDoc)
+      this._persistSession?.('update', this.session)
       return res
     } catch (e) {
       this.session = undefined
-      throw e
-    } finally {
-      if (this.session) {
-        this._persistSession?.('create', this.session)
+
+      if (e instanceof XRPCError) {
+        /*
+         * `ExpiredToken` and `InvalidToken` are handled in
+         * `this_refreshSession`, and emit an `expired` event there.
+         *
+         * Everything else is handled here.
+         */
+        if (
+          [1, 408, 425, 429, 500, 502, 503, 504, 522, 524].includes(e.status)
+        ) {
+          this._persistSession?.('network-error', undefined)
+        } else {
+          this._persistSession?.('expired', undefined)
+        }
       } else {
-        this._persistSession?.('create-failed', undefined)
+        this._persistSession?.('network-error', undefined)
       }
+
+      throw e
     }
   }