@atproto/api 0.10.5 → 0.11.0-next

package/dist/mocker.d.ts

@@ -0,0 +1,57 @@
+import { ComAtprotoLabelDefs, AppBskyFeedDefs, AppBskyActorDefs, AppBskyFeedPost, AppBskyEmbedRecord, AppBskyGraphDefs, AppBskyNotificationListNotifications } from './client';
+export declare const mock: {
+    post({ text, reply, embed, }: {
+        text: string;
+        reply?: AppBskyFeedPost.ReplyRef | undefined;
+        embed?: AppBskyFeedPost.Record['embed'];
+    }): AppBskyFeedPost.Record;
+    postView({ record, author, embed, replyCount, repostCount, likeCount, viewer, labels, }: {
+        record: AppBskyFeedPost.Record;
+        author: AppBskyActorDefs.ProfileViewBasic;
+        embed?: AppBskyFeedDefs.PostView['embed'];
+        replyCount?: number | undefined;
+        repostCount?: number | undefined;
+        likeCount?: number | undefined;
+        viewer?: AppBskyFeedDefs.ViewerState | undefined;
+        labels?: ComAtprotoLabelDefs.Label[] | undefined;
+    }): AppBskyFeedDefs.PostView;
+    embedRecordView({ record, author, labels, }: {
+        record: AppBskyFeedPost.Record;
+        author: AppBskyActorDefs.ProfileViewBasic;
+        labels?: ComAtprotoLabelDefs.Label[] | undefined;
+    }): AppBskyEmbedRecord.View;
+    profileViewBasic({ handle, displayName, description, viewer, labels, }: {
+        handle: string;
+        displayName?: string | undefined;
+        description?: string | undefined;
+        viewer?: AppBskyActorDefs.ViewerState | undefined;
+        labels?: ComAtprotoLabelDefs.Label[] | undefined;
+    }): AppBskyActorDefs.ProfileViewBasic;
+    actorViewerState({ muted, mutedByList, blockedBy, blocking, blockingByList, following, followedBy, }: {
+        muted?: boolean | undefined;
+        mutedByList?: AppBskyGraphDefs.ListViewBasic | undefined;
+        blockedBy?: boolean | undefined;
+        blocking?: string | undefined;
+        blockingByList?: AppBskyGraphDefs.ListViewBasic | undefined;
+        following?: string | undefined;
+        followedBy?: string | undefined;
+    }): AppBskyActorDefs.ViewerState;
+    listViewBasic({ name }: {
+        name: string;
+    }): AppBskyGraphDefs.ListViewBasic;
+    replyNotification({ author, record, labels, }: {
+        record: AppBskyFeedPost.Record;
+        author: AppBskyActorDefs.ProfileViewBasic;
+        labels?: ComAtprotoLabelDefs.Label[] | undefined;
+    }): AppBskyNotificationListNotifications.Notification;
+    followNotification({ author, subjectDid, labels, }: {
+        author: AppBskyActorDefs.ProfileViewBasic;
+        subjectDid: string;
+        labels?: ComAtprotoLabelDefs.Label[] | undefined;
+    }): AppBskyNotificationListNotifications.Notification;
+    label({ val, uri, src, }: {
+        val: string;
+        uri: string;
+        src?: string | undefined;
+    }): ComAtprotoLabelDefs.Label;
+};

package/dist/moderation/const/labels.d.ts

@@ -1,2 +1,4 @@
-import { LabelDefinitionMap } from '../types';
-export declare const LABELS: LabelDefinitionMap;
+import { InterprettedLabelValueDefinition, LabelPreference } from '../types';
+export type KnownLabelValue = '!hide' | '!no-promote' | '!warn' | '!no-unauthenticated' | 'dmca-violation' | 'doxxing' | 'porn' | 'sexual' | 'nudity' | 'gore';
+export declare const DEFAULT_LABEL_SETTINGS: Record<string, LabelPreference>;
+export declare const LABELS: Record<KnownLabelValue, InterprettedLabelValueDefinition>;

package/dist/moderation/decision.d.ts

@@ -0,0 +1,26 @@
+import { AppBskyGraphDefs } from '../client/index';
+import { Label, ModerationCause, ModerationOpts, LabelTarget, ModerationBehavior } from './types';
+import { ModerationUI } from './ui';
+export declare class ModerationDecision {
+    did: string;
+    isMe: boolean;
+    causes: ModerationCause[];
+    constructor();
+    static merge(...decisions: (ModerationDecision | undefined)[]): ModerationDecision;
+    get blocked(): boolean;
+    get muted(): boolean;
+    get blockCause(): ModerationCause | undefined;
+    get muteCause(): ModerationCause | undefined;
+    get labelCauses(): ModerationCause[];
+    ui(context: keyof ModerationBehavior): ModerationUI;
+    setDid(did: string): void;
+    setIsMe(isMe: boolean): void;
+    addHidden(hidden: boolean): void;
+    addBlocking(blocking: string | undefined): void;
+    addBlockingByList(blockingByList: AppBskyGraphDefs.ListViewBasic | undefined): void;
+    addBlockedBy(blockedBy: boolean | undefined): void;
+    addBlockOther(blockOther: boolean | undefined): void;
+    addLabel(target: LabelTarget, label: Label, opts: ModerationOpts): void;
+    addMuted(muted: boolean | undefined): void;
+    addMutedByList(mutedByList: AppBskyGraphDefs.ListViewBasic | undefined): void;
+}

package/dist/moderation/index.d.ts

@@ -1,44 +1,10 @@
-import { ModerationSubjectProfile, ModerationSubjectPost, ModerationSubjectFeedGenerator, ModerationSubjectUserList, ModerationOpts, ModerationDecision, ModerationUI } from './types';
-export interface ProfileModeration {
-    decisions: {
-        account: ModerationDecision;
-        profile: ModerationDecision;
-    };
-    account: ModerationUI;
-    profile: ModerationUI;
-    avatar: ModerationUI;
-}
-export declare function moderateProfile(subject: ModerationSubjectProfile, opts: ModerationOpts): ProfileModeration;
-export interface PostModeration {
-    decisions: {
-        post: ModerationDecision;
-        account: ModerationDecision;
-        profile: ModerationDecision;
-        quote?: ModerationDecision;
-        quotedAccount?: ModerationDecision;
-    };
-    content: ModerationUI;
-    avatar: ModerationUI;
-    embed: ModerationUI;
-}
-export declare function moderatePost(subject: ModerationSubjectPost, opts: ModerationOpts): PostModeration;
-export interface FeedGeneratorModeration {
-    decisions: {
-        feedGenerator: ModerationDecision;
-        account: ModerationDecision;
-        profile: ModerationDecision;
-    };
-    content: ModerationUI;
-    avatar: ModerationUI;
-}
-export declare function moderateFeedGenerator(subject: ModerationSubjectFeedGenerator, opts: ModerationOpts): FeedGeneratorModeration;
-export interface UserListModeration {
-    decisions: {
-        userList: ModerationDecision;
-        account: ModerationDecision;
-        profile: ModerationDecision;
-    };
-    content: ModerationUI;
-    avatar: ModerationUI;
-}
-export declare function moderateUserList(subject: ModerationSubjectUserList, opts: ModerationOpts): UserListModeration;
+import { ModerationSubjectProfile, ModerationSubjectPost, ModerationSubjectNotification, ModerationSubjectFeedGenerator, ModerationSubjectUserList, ModerationOpts } from './types';
+import { ModerationDecision } from './decision';
+export { ModerationUI } from './ui';
+export { ModerationDecision } from './decision';
+export { interpretLabelValueDefinition, interpretLabelValueDefinitions, } from './util';
+export declare function moderateProfile(subject: ModerationSubjectProfile, opts: ModerationOpts): ModerationDecision;
+export declare function moderatePost(subject: ModerationSubjectPost, opts: ModerationOpts): ModerationDecision;
+export declare function moderateNotification(subject: ModerationSubjectNotification, opts: ModerationOpts): ModerationDecision;
+export declare function moderateFeedGenerator(subject: ModerationSubjectFeedGenerator, opts: ModerationOpts): ModerationDecision;
+export declare function moderateUserList(subject: ModerationSubjectUserList, opts: ModerationOpts): ModerationDecision;

package/dist/moderation/subjects/account.d.ts

@@ -1,3 +1,4 @@
-import { Label, ModerationSubjectProfile, ModerationOpts, ModerationDecision } from '../types';
+import { ModerationDecision } from '../decision';
+import { Label, ModerationSubjectProfile, ModerationOpts } from '../types';
 export declare function decideAccount(subject: ModerationSubjectProfile, opts: ModerationOpts): ModerationDecision;
 export declare function filterAccountLabels(labels?: Label[]): Label[];

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

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

package/dist/moderation/subjects/notification.d.ts

@@ -0,0 +1,3 @@
+import { ModerationDecision } from '../decision';
+import { ModerationSubjectNotification, ModerationOpts } from '../types';
+export declare function decideNotification(subject: ModerationSubjectNotification, opts: ModerationOpts): ModerationDecision;

package/dist/moderation/subjects/post.d.ts

@@ -1,2 +1,3 @@
-import { ModerationSubjectPost, ModerationOpts, ModerationDecision } from '../types';
+import { ModerationDecision } from '../decision';
+import { ModerationSubjectPost, ModerationOpts } from '../types';
 export declare function decidePost(subject: ModerationSubjectPost, opts: ModerationOpts): ModerationDecision;

package/dist/moderation/subjects/profile.d.ts

@@ -1,3 +1,4 @@
-import { Label, ModerationSubjectProfile, ModerationOpts, ModerationDecision } from '../types';
+import { ModerationDecision } from '../decision';
+import { Label, ModerationSubjectProfile, ModerationOpts } from '../types';
 export declare function decideProfile(subject: ModerationSubjectProfile, opts: ModerationOpts): ModerationDecision;
 export declare function filterProfileLabels(labels?: Label[]): Label[];

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

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

package/dist/moderation/types.d.ts

@@ -1,49 +1,41 @@
-import { AppBskyActorDefs, AppBskyFeedDefs, AppBskyGraphDefs, ComAtprotoLabelDefs } from '../client/index';
+import { AppBskyActorDefs, AppBskyFeedDefs, AppBskyNotificationListNotifications, AppBskyGraphDefs, ComAtprotoLabelDefs } from '../client/index';
+import { KnownLabelValue } from './const/labels';
+export declare const CUSTOM_LABEL_VALUE_RE: RegExp;
+export interface ModerationBehavior {
+    profileList?: 'blur' | 'alert' | 'inform';
+    profileView?: 'blur' | 'alert' | 'inform';
+    avatar?: 'blur' | 'alert';
+    banner?: 'blur';
+    displayName?: 'blur';
+    contentList?: 'blur' | 'alert' | 'inform';
+    contentView?: 'blur' | 'alert' | 'inform';
+    contentMedia?: 'blur';
+}
+export declare const BLOCK_BEHAVIOR: ModerationBehavior;
+export declare const MUTE_BEHAVIOR: ModerationBehavior;
+export declare const HIDE_BEHAVIOR: ModerationBehavior;
+export declare const NOOP_BEHAVIOR: ModerationBehavior;
 export type Label = ComAtprotoLabelDefs.Label;
+export type LabelTarget = 'account' | 'profile' | 'content';
 export type LabelPreference = 'ignore' | 'warn' | 'hide';
-export type LabelDefinitionFlag = 'no-override' | 'adult' | 'unauthed';
-export type LabelDefinitionOnWarnBehavior = 'blur' | 'blur-media' | 'alert' | null;
-export interface LabelDefinitionLocalizedStrings {
-    name: string;
-    description: string;
-}
-export type LabelDefinitionLocalizedStringsMap = Record<string, LabelDefinitionLocalizedStrings>;
-export interface LabelDefinition {
-    id: string;
-    groupId: string;
-    configurable: boolean;
-    preferences: LabelPreference[];
-    flags: LabelDefinitionFlag[];
-    onwarn: LabelDefinitionOnWarnBehavior;
-    strings: {
-        settings: LabelDefinitionLocalizedStringsMap;
-        account: LabelDefinitionLocalizedStringsMap;
-        content: LabelDefinitionLocalizedStringsMap;
-    };
-}
-export interface LabelGroupDefinition {
-    id: string;
+export type LabelValueDefinitionFlag = 'no-override' | 'adult' | 'unauthed' | 'no-self';
+export interface InterprettedLabelValueDefinition extends ComAtprotoLabelDefs.LabelValueDefinition {
     configurable: boolean;
-    labels: LabelDefinition[];
-    strings: {
-        settings: LabelDefinitionLocalizedStringsMap;
+    defaultSetting: LabelPreference;
+    flags: LabelValueDefinitionFlag[];
+    behaviors: {
+        account?: ModerationBehavior;
+        profile?: ModerationBehavior;
+        content?: ModerationBehavior;
     };
 }
-export type LabelDefinitionMap = Record<string, LabelDefinition>;
-export type LabelGroupDefinitionMap = Record<string, LabelGroupDefinition>;
-interface Labeler {
-    did: string;
-    displayName: string;
-}
-export interface LabelerSettings {
-    labeler: Labeler;
-    labels: Record<string, LabelPreference>;
-}
+export type LabelDefinitionMap = Record<KnownLabelValue, InterprettedLabelValueDefinition>;
 export type ModerationSubjectProfile = AppBskyActorDefs.ProfileViewBasic | AppBskyActorDefs.ProfileView | AppBskyActorDefs.ProfileViewDetailed;
 export type ModerationSubjectPost = AppBskyFeedDefs.PostView;
+export type ModerationSubjectNotification = AppBskyNotificationListNotifications.Notification;
 export type ModerationSubjectFeedGenerator = AppBskyFeedDefs.GeneratorView;
 export type ModerationSubjectUserList = AppBskyGraphDefs.ListViewBasic | AppBskyGraphDefs.ListView;
-export type ModerationSubject = ModerationSubjectProfile | ModerationSubjectPost | ModerationSubjectFeedGenerator | ModerationSubjectUserList;
+export type ModerationSubject = ModerationSubjectProfile | ModerationSubjectPost | ModerationSubjectNotification | ModerationSubjectFeedGenerator | ModerationSubjectUserList;
 export type ModerationCauseSource = {
     type: 'user';
 } | {
@@ -51,7 +43,7 @@ export type ModerationCauseSource = {
     list: AppBskyGraphDefs.ListViewBasic;
 } | {
     type: 'labeler';
-    labeler: Labeler;
+    did: string;
 };
 export type ModerationCause = {
     type: 'blocking';
@@ -69,37 +61,31 @@ export type ModerationCause = {
     type: 'label';
     source: ModerationCauseSource;
     label: Label;
-    labelDef: LabelDefinition;
+    labelDef: InterprettedLabelValueDefinition;
     setting: LabelPreference;
+    behavior: ModerationBehavior;
+    noOverride: boolean;
     priority: 1 | 2 | 5 | 7 | 8;
 } | {
     type: 'muted';
     source: ModerationCauseSource;
     priority: 6;
+} | {
+    type: 'hidden';
+    source: ModerationCauseSource;
+    priority: 6;
 };
-export interface ModerationOpts {
-    userDid: string;
-    adultContentEnabled: boolean;
+export interface ModerationPrefsModerator {
+    did: string;
     labels: Record<string, LabelPreference>;
-    labelers: LabelerSettings[];
 }
-export declare class ModerationDecision {
-    cause: ModerationCause | undefined;
-    alert: boolean;
-    blur: boolean;
-    blurMedia: boolean;
-    filter: boolean;
-    noOverride: boolean;
-    additionalCauses: ModerationCause[];
-    did: string;
-    static noop(): ModerationDecision;
-    constructor(cause?: ModerationCause | undefined, alert?: boolean, blur?: boolean, blurMedia?: boolean, filter?: boolean, noOverride?: boolean, additionalCauses?: ModerationCause[], did?: string);
+export interface ModerationPrefs {
+    adultContentEnabled: boolean;
+    labels: Record<string, LabelPreference>;
+    mods: ModerationPrefsModerator[];
 }
-export interface ModerationUI {
-    filter?: boolean;
-    blur?: boolean;
-    alert?: boolean;
-    cause?: ModerationCause;
-    noOverride?: boolean;
+export interface ModerationOpts {
+    userDid: string | undefined;
+    prefs: ModerationPrefs;
+    labelDefs?: Record<string, InterprettedLabelValueDefinition[]>;
 }
-export {};

package/dist/moderation/ui.d.ts

@@ -0,0 +1,12 @@
+import { ModerationCause } from './types';
+export declare class ModerationUI {
+    noOverride: boolean;
+    filters: ModerationCause[];
+    blurs: ModerationCause[];
+    alerts: ModerationCause[];
+    informs: ModerationCause[];
+    get filter(): boolean;
+    get blur(): boolean;
+    get alert(): boolean;
+    get inform(): boolean;
+}

package/dist/moderation/util.d.ts

@@ -1,10 +1,6 @@
-import { AppBskyEmbedRecord, AppBskyEmbedRecordWithMedia } from '../client';
-import { ModerationDecision, ModerationUI } from './types';
-export declare function takeHighestPriorityDecision(...decisions: (ModerationDecision | undefined)[]): ModerationDecision;
-export declare function downgradeDecision(decision: ModerationDecision, to: 'blur' | 'alert' | 'noop'): void;
-export declare function isModerationDecisionNoop(decision: ModerationDecision | undefined, { ignoreFilter }?: {
-    ignoreFilter: boolean;
-}): boolean;
+import { AppBskyEmbedRecord, AppBskyEmbedRecordWithMedia, AppBskyLabelerDefs, ComAtprotoLabelDefs } from '../client';
+import { InterprettedLabelValueDefinition } from './types';
 export declare function isQuotedPost(embed: unknown): embed is AppBskyEmbedRecord.View;
 export declare function isQuotedPostWithMedia(embed: unknown): embed is AppBskyEmbedRecordWithMedia.View;
-export declare function toModerationUI(decision: ModerationDecision): ModerationUI;
+export declare function interpretLabelValueDefinition(def: ComAtprotoLabelDefs.LabelValueDefinition): InterprettedLabelValueDefinition;
+export declare function interpretLabelValueDefinitions(modserviceView: AppBskyLabelerDefs.LabelerViewDetailed): InterprettedLabelValueDefinition[];

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;
+};