@atproto/api 0.2.6 → 0.2.7

package/dist/agent.d.ts

@@ -0,0 +1,27 @@
+import { AtpServiceClient, ComAtprotoServerCreateAccount, ComAtprotoServerCreateSession, ComAtprotoServerGetSession } from './client';
+import { AtpSessionData, AtpAgentCreateAccountOpts, AtpAgentLoginOpts, AtpAgentFetchHandler, AtpAgentGlobalOpts, AtpPersistSessionHandler, AtpAgentOpts } from './types';
+export declare class AtpAgent {
+    service: URL;
+    api: AtpServiceClient;
+    session?: AtpSessionData;
+    private _baseClient;
+    private _persistSession?;
+    private _refreshSessionPromise;
+    get com(): import("./client").ComNS;
+    static fetch: AtpAgentFetchHandler | undefined;
+    static configure(opts: AtpAgentGlobalOpts): void;
+    constructor(opts: AtpAgentOpts);
+    get hasSession(): boolean;
+    setPersistSessionHandler(handler?: AtpPersistSessionHandler): void;
+    createAccount(opts: AtpAgentCreateAccountOpts): Promise<ComAtprotoServerCreateAccount.Response>;
+    login(opts: AtpAgentLoginOpts): Promise<ComAtprotoServerCreateSession.Response>;
+    resumeSession(session: AtpSessionData): Promise<ComAtprotoServerGetSession.Response>;
+    private _addAuthHeader;
+    private _fetch;
+    private _refreshSession;
+    private _refreshSessionInner;
+    uploadBlob: typeof this.api.com.atproto.repo.uploadBlob;
+    resolveHandle: typeof this.api.com.atproto.identity.resolveHandle;
+    updateHandle: typeof this.api.com.atproto.identity.updateHandle;
+    createModerationReport: typeof this.api.com.atproto.moderation.createReport;
+}

package/dist/bsky-agent.d.ts

@@ -0,0 +1,43 @@
+import { AtpAgent } from './agent';
+import { AppBskyFeedPost, AppBskyActorProfile } from './client';
+export declare class BskyAgent extends AtpAgent {
+    get app(): import("./client").AppNS;
+    getTimeline: typeof this.api.app.bsky.feed.getTimeline;
+    getAuthorFeed: typeof this.api.app.bsky.feed.getAuthorFeed;
+    getPostThread: typeof this.api.app.bsky.feed.getPostThread;
+    getPost: typeof this.api.app.bsky.feed.post.get;
+    getLikes: typeof this.api.app.bsky.feed.getLikes;
+    getRepostedBy: typeof this.api.app.bsky.feed.getRepostedBy;
+    getFollows: typeof this.api.app.bsky.graph.getFollows;
+    getFollowers: typeof this.api.app.bsky.graph.getFollowers;
+    getProfile: typeof this.api.app.bsky.actor.getProfile;
+    getProfiles: typeof this.api.app.bsky.actor.getProfiles;
+    searchActors: typeof this.api.app.bsky.actor.searchActors;
+    searchActorsTypeahead: typeof this.api.app.bsky.actor.searchActorsTypeahead;
+    listNotifications: typeof this.api.app.bsky.notification.listNotifications;
+    countUnreadNotifications: typeof this.api.app.bsky.notification.getUnreadCount;
+    post(record: Partial<AppBskyFeedPost.Record> & Omit<AppBskyFeedPost.Record, 'createdAt'>): Promise<{
+        uri: string;
+        cid: string;
+    }>;
+    deletePost(postUri: string): Promise<void>;
+    like(uri: string, cid: string): Promise<{
+        uri: string;
+        cid: string;
+    }>;
+    deleteLike(likeUri: string): Promise<void>;
+    repost(uri: string, cid: string): Promise<{
+        uri: string;
+        cid: string;
+    }>;
+    deleteRepost(repostUri: string): Promise<void>;
+    follow(subjectDid: string): Promise<{
+        uri: string;
+        cid: string;
+    }>;
+    deleteFollow(followUri: string): Promise<void>;
+    upsertProfile(updateFn: (existing: AppBskyActorProfile.Record | undefined) => AppBskyActorProfile.Record | Promise<AppBskyActorProfile.Record>): Promise<void>;
+    mute(actor: string): Promise<import("./client/types/app/bsky/graph/muteActor").Response>;
+    unmute(actor: string): Promise<import("./client/types/app/bsky/graph/unmuteActor").Response>;
+    updateSeenNotifications(seenAt?: string): Promise<import("./client/types/app/bsky/notification/updateSeen").Response>;
+}

package/dist/client/types/app/bsky/actor/createScene.d.ts

@@ -0,0 +1,32 @@
+import { Headers, XRPCError } from '@atproto/xrpc';
+import * as AppBskySystemDeclRef from '../system/declRef';
+export interface QueryParams {
+}
+export interface InputSchema {
+    handle: string;
+    recoveryKey?: string;
+    [k: string]: unknown;
+}
+export interface OutputSchema {
+    handle: string;
+    did: string;
+    declaration: AppBskySystemDeclRef.Main;
+    [k: string]: unknown;
+}
+export interface CallOptions {
+    headers?: Headers;
+    qp?: QueryParams;
+    encoding: 'application/json';
+}
+export interface Response {
+    success: boolean;
+    headers: Headers;
+    data: OutputSchema;
+}
+export declare class InvalidHandleError extends XRPCError {
+    constructor(src: XRPCError);
+}
+export declare class HandleNotAvailableError extends XRPCError {
+    constructor(src: XRPCError);
+}
+export declare function toKnownErr(e: any): any;

package/dist/client/types/app/bsky/actor/getProfile.d.ts

@@ -0,0 +1,16 @@
+import { Headers } from '@atproto/xrpc';
+import * as AppBskyActorDefs from './defs';
+export interface QueryParams {
+    actor: string;
+}
+export declare type InputSchema = undefined;
+export declare type OutputSchema = AppBskyActorDefs.ProfileViewDetailed;
+export interface CallOptions {
+    headers?: Headers;
+}
+export interface Response {
+    success: boolean;
+    headers: Headers;
+    data: OutputSchema;
+}
+export declare function toKnownErr(e: any): any;

package/dist/client/types/app/bsky/actor/getProfiles.d.ts

@@ -0,0 +1,19 @@
+import { Headers } from '@atproto/xrpc';
+import * as AppBskyActorDefs from './defs';
+export interface QueryParams {
+    actors: string[];
+}
+export declare type InputSchema = undefined;
+export interface OutputSchema {
+    profiles: AppBskyActorDefs.ProfileViewDetailed[];
+    [k: string]: unknown;
+}
+export interface CallOptions {
+    headers?: Headers;
+}
+export interface Response {
+    success: boolean;
+    headers: Headers;
+    data: OutputSchema;
+}
+export declare function toKnownErr(e: any): any;

package/dist/client/types/app/bsky/actor/getSuggestions.d.ts

@@ -0,0 +1,21 @@
+import { Headers } from '@atproto/xrpc';
+import * as AppBskyActorDefs from './defs';
+export interface QueryParams {
+    limit?: number;
+    cursor?: string;
+}
+export declare type InputSchema = undefined;
+export interface OutputSchema {
+    cursor?: string;
+    actors: AppBskyActorDefs.ProfileView[];
+    [k: string]: unknown;
+}
+export interface CallOptions {
+    headers?: Headers;
+}
+export interface Response {
+    success: boolean;
+    headers: Headers;
+    data: OutputSchema;
+}
+export declare function toKnownErr(e: any): any;

package/dist/client/types/app/bsky/actor/profile.d.ts

@@ -0,0 +1,10 @@
+import { ValidationResult, BlobRef } from '@atproto/lexicon';
+export interface Record {
+    displayName?: string;
+    description?: string;
+    avatar?: BlobRef;
+    banner?: BlobRef;
+    [k: string]: unknown;
+}
+export declare function isRecord(v: unknown): v is Record;
+export declare function validateRecord(v: unknown): ValidationResult;

package/dist/client/types/app/bsky/actor/ref.d.ts

@@ -0,0 +1,28 @@
+import { ValidationResult } from '@atproto/lexicon';
+import * as AppBskySystemDeclRef from '../system/declRef';
+export interface Main {
+    did: string;
+    declarationCid: string;
+    [k: string]: unknown;
+}
+export declare function isMain(v: unknown): v is Main;
+export declare function validateMain(v: unknown): ValidationResult;
+export interface WithInfo {
+    did: string;
+    declaration: AppBskySystemDeclRef.Main;
+    handle: string;
+    displayName?: string;
+    avatar?: string;
+    viewer?: ViewerState;
+    [k: string]: unknown;
+}
+export declare function isWithInfo(v: unknown): v is WithInfo;
+export declare function validateWithInfo(v: unknown): ValidationResult;
+export interface ViewerState {
+    muted?: boolean;
+    following?: string;
+    followedBy?: string;
+    [k: string]: unknown;
+}
+export declare function isViewerState(v: unknown): v is ViewerState;
+export declare function validateViewerState(v: unknown): ValidationResult;

package/dist/client/types/app/bsky/actor/search.d.ts

@@ -0,0 +1,22 @@
+import { Headers } from '@atproto/xrpc';
+import * as AppBskyActorProfile from './profile';
+export interface QueryParams {
+    term?: string;
+    limit?: number;
+    before?: string;
+}
+export declare type InputSchema = undefined;
+export interface OutputSchema {
+    cursor?: string;
+    users: AppBskyActorProfile.ViewBasic[];
+    [k: string]: unknown;
+}
+export interface CallOptions {
+    headers?: Headers;
+}
+export interface Response {
+    success: boolean;
+    headers: Headers;
+    data: OutputSchema;
+}
+export declare function toKnownErr(e: any): any;

package/dist/client/types/app/bsky/actor/searchActors.d.ts

@@ -0,0 +1,22 @@
+import { Headers } from '@atproto/xrpc';
+import * as AppBskyActorDefs from './defs';
+export interface QueryParams {
+    term?: string;
+    limit?: number;
+    cursor?: string;
+}
+export declare type InputSchema = undefined;
+export interface OutputSchema {
+    cursor?: string;
+    actors: AppBskyActorDefs.ProfileView[];
+    [k: string]: unknown;
+}
+export interface CallOptions {
+    headers?: Headers;
+}
+export interface Response {
+    success: boolean;
+    headers: Headers;
+    data: OutputSchema;
+}
+export declare function toKnownErr(e: any): any;

package/dist/client/types/app/bsky/actor/searchActorsTypeahead.d.ts

@@ -0,0 +1,20 @@
+import { Headers } from '@atproto/xrpc';
+import * as AppBskyActorDefs from './defs';
+export interface QueryParams {
+    term?: string;
+    limit?: number;
+}
+export declare type InputSchema = undefined;
+export interface OutputSchema {
+    actors: AppBskyActorDefs.ProfileViewBasic[];
+    [k: string]: unknown;
+}
+export interface CallOptions {
+    headers?: Headers;
+}
+export interface Response {
+    success: boolean;
+    headers: Headers;
+    data: OutputSchema;
+}
+export declare function toKnownErr(e: any): any;

package/dist/client/types/app/bsky/actor/searchTypeahead.d.ts

@@ -0,0 +1,20 @@
+import { Headers } from '@atproto/xrpc';
+import * as AppBskyActorRef from './ref';
+export interface QueryParams {
+    term?: string;
+    limit?: number;
+}
+export declare type InputSchema = undefined;
+export interface OutputSchema {
+    users: AppBskyActorRef.WithInfo[];
+    [k: string]: unknown;
+}
+export interface CallOptions {
+    headers?: Headers;
+}
+export interface Response {
+    success: boolean;
+    headers: Headers;
+    data: OutputSchema;
+}
+export declare function toKnownErr(e: any): any;

package/dist/client/types/app/bsky/actor/updateProfile.d.ts

@@ -0,0 +1,40 @@
+import { Headers, XRPCError } from '@atproto/xrpc';
+import { BlobRef } from '@atproto/lexicon';
+export interface QueryParams {
+}
+export interface InputSchema {
+    displayName?: string;
+    description?: string | null;
+    avatar?: BlobRef | null;
+    banner?: BlobRef | null;
+    [k: string]: unknown;
+}
+export interface OutputSchema {
+    uri: string;
+    cid: string;
+    record: {};
+    [k: string]: unknown;
+}
+export interface CallOptions {
+    headers?: Headers;
+    qp?: QueryParams;
+    encoding: 'application/json';
+}
+export interface Response {
+    success: boolean;
+    headers: Headers;
+    data: OutputSchema;
+}
+export declare class InvalidBlobError extends XRPCError {
+    constructor(src: XRPCError);
+}
+export declare class BlobTooLargeError extends XRPCError {
+    constructor(src: XRPCError);
+}
+export declare class InvalidMimeTypeError extends XRPCError {
+    constructor(src: XRPCError);
+}
+export declare class InvalidImageDimensionsError extends XRPCError {
+    constructor(src: XRPCError);
+}
+export declare function toKnownErr(e: any): any;

package/dist/client/types/app/bsky/embed/external.d.ts

@@ -0,0 +1,31 @@
+import { ValidationResult, BlobRef } from '@atproto/lexicon';
+export interface Main {
+    external: External;
+    [k: string]: unknown;
+}
+export declare function isMain(v: unknown): v is Main;
+export declare function validateMain(v: unknown): ValidationResult;
+export interface External {
+    uri: string;
+    title: string;
+    description: string;
+    thumb?: BlobRef;
+    [k: string]: unknown;
+}
+export declare function isExternal(v: unknown): v is External;
+export declare function validateExternal(v: unknown): ValidationResult;
+export interface View {
+    external: ViewExternal;
+    [k: string]: unknown;
+}
+export declare function isView(v: unknown): v is View;
+export declare function validateView(v: unknown): ValidationResult;
+export interface ViewExternal {
+    uri: string;
+    title: string;
+    description: string;
+    thumb?: string;
+    [k: string]: unknown;
+}
+export declare function isViewExternal(v: unknown): v is ViewExternal;
+export declare function validateViewExternal(v: unknown): ValidationResult;

package/dist/client/types/app/bsky/embed/images.d.ts

@@ -0,0 +1,28 @@
+import { ValidationResult, BlobRef } from '@atproto/lexicon';
+export interface Main {
+    images: Image[];
+    [k: string]: unknown;
+}
+export declare function isMain(v: unknown): v is Main;
+export declare function validateMain(v: unknown): ValidationResult;
+export interface Image {
+    image: BlobRef;
+    alt: string;
+    [k: string]: unknown;
+}
+export declare function isImage(v: unknown): v is Image;
+export declare function validateImage(v: unknown): ValidationResult;
+export interface View {
+    images: ViewImage[];
+    [k: string]: unknown;
+}
+export declare function isView(v: unknown): v is View;
+export declare function validateView(v: unknown): ValidationResult;
+export interface ViewImage {
+    thumb: string;
+    fullsize: string;
+    alt: string;
+    [k: string]: unknown;
+}
+export declare function isViewImage(v: unknown): v is ViewImage;
+export declare function validateViewImage(v: unknown): ValidationResult;

package/dist/client/types/app/bsky/embed/record.d.ts

@@ -0,0 +1,41 @@
+import { ValidationResult } from '@atproto/lexicon';
+import * as ComAtprotoRepoStrongRef from '../../../com/atproto/repo/strongRef';
+import * as AppBskyActorDefs from '../actor/defs';
+import * as AppBskyEmbedImages from './images';
+import * as AppBskyEmbedExternal from './external';
+import * as AppBskyEmbedRecordWithMedia from './recordWithMedia';
+export interface Main {
+    record: ComAtprotoRepoStrongRef.Main;
+    [k: string]: unknown;
+}
+export declare function isMain(v: unknown): v is Main;
+export declare function validateMain(v: unknown): ValidationResult;
+export interface View {
+    record: ViewRecord | ViewNotFound | {
+        $type: string;
+        [k: string]: unknown;
+    };
+    [k: string]: unknown;
+}
+export declare function isView(v: unknown): v is View;
+export declare function validateView(v: unknown): ValidationResult;
+export interface ViewRecord {
+    uri: string;
+    cid: string;
+    author: AppBskyActorDefs.ProfileViewBasic;
+    value: {};
+    embeds?: (AppBskyEmbedImages.View | AppBskyEmbedExternal.View | View | AppBskyEmbedRecordWithMedia.View | {
+        $type: string;
+        [k: string]: unknown;
+    })[];
+    indexedAt: string;
+    [k: string]: unknown;
+}
+export declare function isViewRecord(v: unknown): v is ViewRecord;
+export declare function validateViewRecord(v: unknown): ValidationResult;
+export interface ViewNotFound {
+    uri: string;
+    [k: string]: unknown;
+}
+export declare function isViewNotFound(v: unknown): v is ViewNotFound;
+export declare function validateViewNotFound(v: unknown): ValidationResult;

package/dist/client/types/app/bsky/embed/recordWithMedia.d.ts

@@ -0,0 +1,24 @@
+import { ValidationResult } from '@atproto/lexicon';
+import * as AppBskyEmbedRecord from './record';
+import * as AppBskyEmbedImages from './images';
+import * as AppBskyEmbedExternal from './external';
+export interface Main {
+    record: AppBskyEmbedRecord.Main;
+    media: AppBskyEmbedImages.Main | AppBskyEmbedExternal.Main | {
+        $type: string;
+        [k: string]: unknown;
+    };
+    [k: string]: unknown;
+}
+export declare function isMain(v: unknown): v is Main;
+export declare function validateMain(v: unknown): ValidationResult;
+export interface View {
+    record: AppBskyEmbedRecord.View;
+    media: AppBskyEmbedImages.View | AppBskyEmbedExternal.View | {
+        $type: string;
+        [k: string]: unknown;
+    };
+    [k: string]: unknown;
+}
+export declare function isView(v: unknown): v is View;
+export declare function validateView(v: unknown): ValidationResult;

package/dist/client/types/app/bsky/feed/feedViewPost.d.ts

@@ -0,0 +1,28 @@
+import { ValidationResult } from '@atproto/lexicon';
+import * as AppBskyFeedPost from './post';
+import * as AppBskyActorRef from '../actor/ref';
+export interface Main {
+    post: AppBskyFeedPost.View;
+    reply?: ReplyRef;
+    reason?: ReasonRepost | {
+        $type: string;
+        [k: string]: unknown;
+    };
+    [k: string]: unknown;
+}
+export declare function isMain(v: unknown): v is Main;
+export declare function validateMain(v: unknown): ValidationResult;
+export interface ReplyRef {
+    root: AppBskyFeedPost.View;
+    parent: AppBskyFeedPost.View;
+    [k: string]: unknown;
+}
+export declare function isReplyRef(v: unknown): v is ReplyRef;
+export declare function validateReplyRef(v: unknown): ValidationResult;
+export interface ReasonRepost {
+    by: AppBskyActorRef.WithInfo;
+    indexedAt: string;
+    [k: string]: unknown;
+}
+export declare function isReasonRepost(v: unknown): v is ReasonRepost;
+export declare function validateReasonRepost(v: unknown): ValidationResult;

package/dist/client/types/app/bsky/feed/getAuthorFeed.d.ts

@@ -0,0 +1,22 @@
+import { Headers } from '@atproto/xrpc';
+import * as AppBskyFeedDefs from './defs';
+export interface QueryParams {
+    actor: string;
+    limit?: number;
+    cursor?: string;
+}
+export declare type InputSchema = undefined;
+export interface OutputSchema {
+    cursor?: string;
+    feed: AppBskyFeedDefs.FeedViewPost[];
+    [k: string]: unknown;
+}
+export interface CallOptions {
+    headers?: Headers;
+}
+export interface Response {
+    success: boolean;
+    headers: Headers;
+    data: OutputSchema;
+}
+export declare function toKnownErr(e: any): any;

package/dist/client/types/app/bsky/feed/getLikes.d.ts

@@ -0,0 +1,34 @@
+import { Headers } from '@atproto/xrpc';
+import { ValidationResult } from '@atproto/lexicon';
+import * as AppBskyActorDefs from '../actor/defs';
+export interface QueryParams {
+    uri: string;
+    cid?: string;
+    limit?: number;
+    cursor?: string;
+}
+export declare type InputSchema = undefined;
+export interface OutputSchema {
+    uri: string;
+    cid?: string;
+    cursor?: string;
+    likes: Like[];
+    [k: string]: unknown;
+}
+export interface CallOptions {
+    headers?: Headers;
+}
+export interface Response {
+    success: boolean;
+    headers: Headers;
+    data: OutputSchema;
+}
+export declare function toKnownErr(e: any): any;
+export interface Like {
+    indexedAt: string;
+    createdAt: string;
+    actor: AppBskyActorDefs.ProfileView;
+    [k: string]: unknown;
+}
+export declare function isLike(v: unknown): v is Like;
+export declare function validateLike(v: unknown): ValidationResult;

package/dist/client/types/app/bsky/feed/getPostThread.d.ts

@@ -0,0 +1,26 @@
+import { Headers, XRPCError } from '@atproto/xrpc';
+import * as AppBskyFeedDefs from './defs';
+export interface QueryParams {
+    uri: string;
+    depth?: number;
+}
+export declare type InputSchema = undefined;
+export interface OutputSchema {
+    thread: AppBskyFeedDefs.ThreadViewPost | AppBskyFeedDefs.NotFoundPost | {
+        $type: string;
+        [k: string]: unknown;
+    };
+    [k: string]: unknown;
+}
+export interface CallOptions {
+    headers?: Headers;
+}
+export interface Response {
+    success: boolean;
+    headers: Headers;
+    data: OutputSchema;
+}
+export declare class NotFoundError extends XRPCError {
+    constructor(src: XRPCError);
+}
+export declare function toKnownErr(e: any): any;

package/dist/client/types/app/bsky/feed/getRepostedBy.d.ts

@@ -0,0 +1,25 @@
+import { Headers } from '@atproto/xrpc';
+import * as AppBskyActorDefs from '../actor/defs';
+export interface QueryParams {
+    uri: string;
+    cid?: string;
+    limit?: number;
+    cursor?: string;
+}
+export declare type InputSchema = undefined;
+export interface OutputSchema {
+    uri: string;
+    cid?: string;
+    cursor?: string;
+    repostedBy: AppBskyActorDefs.ProfileView[];
+    [k: string]: unknown;
+}
+export interface CallOptions {
+    headers?: Headers;
+}
+export interface Response {
+    success: boolean;
+    headers: Headers;
+    data: OutputSchema;
+}
+export declare function toKnownErr(e: any): any;

package/dist/client/types/app/bsky/feed/getTimeline.d.ts

@@ -0,0 +1,22 @@
+import { Headers } from '@atproto/xrpc';
+import * as AppBskyFeedDefs from './defs';
+export interface QueryParams {
+    algorithm?: string;
+    limit?: number;
+    cursor?: string;
+}
+export declare type InputSchema = undefined;
+export interface OutputSchema {
+    cursor?: string;
+    feed: AppBskyFeedDefs.FeedViewPost[];
+    [k: string]: unknown;
+}
+export interface CallOptions {
+    headers?: Headers;
+}
+export interface Response {
+    success: boolean;
+    headers: Headers;
+    data: OutputSchema;
+}
+export declare function toKnownErr(e: any): any;

package/dist/client/types/app/bsky/feed/getVotes.d.ts

@@ -0,0 +1,36 @@
+import { Headers } from '@atproto/xrpc';
+import { ValidationResult } from '@atproto/lexicon';
+import * as AppBskyActorRef from '../actor/ref';
+export interface QueryParams {
+    uri: string;
+    cid?: string;
+    direction?: 'up' | 'down';
+    limit?: number;
+    before?: string;
+}
+export declare type InputSchema = undefined;
+export interface OutputSchema {
+    uri: string;
+    cid?: string;
+    cursor?: string;
+    votes: Vote[];
+    [k: string]: unknown;
+}
+export interface CallOptions {
+    headers?: Headers;
+}
+export interface Response {
+    success: boolean;
+    headers: Headers;
+    data: OutputSchema;
+}
+export declare function toKnownErr(e: any): any;
+export interface Vote {
+    direction: 'up' | 'down';
+    indexedAt: string;
+    createdAt: string;
+    actor: AppBskyActorRef.WithInfo;
+    [k: string]: unknown;
+}
+export declare function isVote(v: unknown): v is Vote;
+export declare function validateVote(v: unknown): ValidationResult;

package/dist/client/types/app/bsky/feed/like.d.ts

@@ -0,0 +1,9 @@
+import { ValidationResult } from '@atproto/lexicon';
+import * as ComAtprotoRepoStrongRef from '../../../com/atproto/repo/strongRef';
+export interface Record {
+    subject: ComAtprotoRepoStrongRef.Main;
+    createdAt: string;
+    [k: string]: unknown;
+}
+export declare function isRecord(v: unknown): v is Record;
+export declare function validateRecord(v: unknown): ValidationResult;