@atproto/api 0.4.4 → 0.5.1

package/dist/moderation/accumulator.d.ts

@@ -0,0 +1,14 @@
+import { AppBskyGraphDefs } from '../client/index';
+import { Label, ModerationCause, ModerationOpts, ModerationDecision } from './types';
+export declare class ModerationCauseAccumulator {
+    did: string;
+    causes: ModerationCause[];
+    constructor();
+    setDid(did: string): void;
+    addBlocking(blocking: string | undefined): void;
+    addBlockedBy(blockedBy: boolean | undefined): void;
+    addLabel(label: Label, opts: ModerationOpts): void;
+    addMuted(muted: boolean | undefined): void;
+    addMutedByList(mutedByList: AppBskyGraphDefs.ListViewBasic | undefined): void;
+    finalizeDecision(opts: ModerationOpts): ModerationDecision;
+}

package/dist/moderation/const/label-groups.d.ts

@@ -0,0 +1,2 @@
+import { LabelGroupDefinitionMap } from '../types';
+export declare const LABEL_GROUPS: LabelGroupDefinitionMap;

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

@@ -0,0 +1,2 @@
+import { LabelDefinitionMap } from '../types';
+export declare const LABELS: LabelDefinitionMap;

package/dist/moderation/index.d.ts

@@ -0,0 +1,44 @@
+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;

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

@@ -0,0 +1,3 @@
+import { Label, ModerationSubjectProfile, ModerationOpts, ModerationDecision } 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

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

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

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

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

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

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

@@ -0,0 +1,6 @@
+import { AppBskyEmbedRecord, AppBskyEmbedRecordWithMedia } from '../../client';
+import { ModerationOpts, ModerationDecision } from '../types';
+export declare function decideQuotedPost(subject: AppBskyEmbedRecord.View, opts: ModerationOpts): ModerationDecision;
+export declare function decideQuotedPostAccount(subject: AppBskyEmbedRecord.View, opts: ModerationOpts): ModerationDecision;
+export declare function decideQuotedPostWithMedia(subject: AppBskyEmbedRecordWithMedia.View, opts: ModerationOpts): ModerationDecision;
+export declare function decideQuotedPostWithMediaAccount(subject: AppBskyEmbedRecordWithMedia.View, opts: ModerationOpts): ModerationDecision;

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

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

package/dist/moderation/types.d.ts

@@ -0,0 +1,97 @@
+import { AppBskyActorDefs, AppBskyFeedDefs, AppBskyGraphDefs, ComAtprotoLabelDefs } from '../client/index';
+export declare type Label = ComAtprotoLabelDefs.Label;
+export declare type LabelPreference = 'ignore' | 'warn' | 'hide';
+export declare type LabelDefinitionFlag = 'no-override' | 'adult';
+export declare type LabelDefinitionOnWarnBehavior = 'blur' | 'blur-media' | 'alert' | null;
+export interface LabelDefinitionLocalizedStrings {
+    name: string;
+    description: string;
+}
+export declare 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;
+    configurable: boolean;
+    labels: LabelDefinition[];
+    strings: {
+        settings: LabelDefinitionLocalizedStringsMap;
+    };
+}
+export declare type LabelDefinitionMap = Record<string, LabelDefinition>;
+export declare type LabelGroupDefinitionMap = Record<string, LabelGroupDefinition>;
+interface Labeler {
+    did: string;
+    displayName: string;
+}
+export interface LabelerSettings {
+    labeler: Labeler;
+    settings: Record<string, LabelPreference>;
+}
+export declare type ModerationSubjectProfile = AppBskyActorDefs.ProfileViewBasic | AppBskyActorDefs.ProfileView | AppBskyActorDefs.ProfileViewDetailed;
+export declare type ModerationSubjectPost = AppBskyFeedDefs.PostView;
+export declare type ModerationSubjectFeedGenerator = AppBskyFeedDefs.GeneratorView;
+export declare type ModerationSubjectUserList = AppBskyGraphDefs.ListViewBasic | AppBskyGraphDefs.ListView;
+export declare type ModerationSubject = ModerationSubjectProfile | ModerationSubjectPost | ModerationSubjectFeedGenerator | ModerationSubjectUserList;
+export declare type ModerationCauseSource = {
+    type: 'user';
+} | {
+    type: 'list';
+    list: AppBskyGraphDefs.ListViewBasic;
+};
+export declare type ModerationCause = {
+    type: 'blocking';
+    source: ModerationCauseSource;
+    priority: 3;
+} | {
+    type: 'blocked-by';
+    source: ModerationCauseSource;
+    priority: 4;
+} | {
+    type: 'label';
+    labeler: Labeler;
+    label: Label;
+    labelDef: LabelDefinition;
+    setting: LabelPreference;
+    priority: 1 | 2 | 5 | 7 | 8;
+} | {
+    type: 'muted';
+    source: ModerationCauseSource;
+    priority: 6;
+};
+export interface ModerationOpts {
+    userDid: string;
+    adultContentEnabled: boolean;
+    labelerSettings: 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 ModerationUI {
+    filter?: boolean;
+    blur?: boolean;
+    alert?: boolean;
+    cause?: ModerationCause;
+    noOverride?: boolean;
+}
+export {};

package/dist/moderation/util.d.ts

@@ -0,0 +1,12 @@
+import { AppBskyEmbedRecord, AppBskyEmbedRecordWithMedia } from '../client';
+import { ModerationDecision, ModerationUI } from './types';
+export declare function takeHighestPriorityDecision(...decisions: (ModerationDecision | undefined)[]): ModerationDecision;
+export declare function downgradeDecision(decision: ModerationDecision, { alert }: {
+    alert: boolean;
+}): void;
+export declare function isModerationDecisionNoop(decision: ModerationDecision | undefined, { ignoreFilter }?: {
+    ignoreFilter: boolean;
+}): boolean;
+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;