@atproto/ozone 0.0.2 → 0.0.4

package/src/lexicon/types/com/atproto/admin/deleteCommunicationTemplate.ts

@@ -0,0 +1,38 @@
+/**
+ * GENERATED CODE - DO NOT MODIFY
+ */
+import express from 'express'
+import { ValidationResult, BlobRef } from '@atproto/lexicon'
+import { lexicons } from '../../../../lexicons'
+import { isObj, hasProp } from '../../../../util'
+import { CID } from 'multiformats/cid'
+import { HandlerAuth } from '@atproto/xrpc-server'
+
+export interface QueryParams {}
+
+export interface InputSchema {
+  id: string
+  [k: string]: unknown
+}
+
+export interface HandlerInput {
+  encoding: 'application/json'
+  body: InputSchema
+}
+
+export interface HandlerError {
+  status: number
+  message?: string
+}
+
+export type HandlerOutput = HandlerError | void
+export type HandlerReqCtx<HA extends HandlerAuth = never> = {
+  auth: HA
+  params: QueryParams
+  input: HandlerInput
+  req: express.Request
+  res: express.Response
+}
+export type Handler<HA extends HandlerAuth = never> = (
+  ctx: HandlerReqCtx<HA>,
+) => Promise<HandlerOutput> | HandlerOutput

package/src/lexicon/types/com/atproto/admin/listCommunicationTemplates.ts

@@ -0,0 +1,44 @@
+/**
+ * GENERATED CODE - DO NOT MODIFY
+ */
+import express from 'express'
+import { ValidationResult, BlobRef } from '@atproto/lexicon'
+import { lexicons } from '../../../../lexicons'
+import { isObj, hasProp } from '../../../../util'
+import { CID } from 'multiformats/cid'
+import { HandlerAuth } from '@atproto/xrpc-server'
+import * as ComAtprotoAdminDefs from './defs'
+
+export interface QueryParams {}
+
+export type InputSchema = undefined
+
+export interface OutputSchema {
+  communicationTemplates: ComAtprotoAdminDefs.CommunicationTemplateView[]
+  [k: string]: unknown
+}
+
+export type HandlerInput = undefined
+
+export interface HandlerSuccess {
+  encoding: 'application/json'
+  body: OutputSchema
+  headers?: { [key: string]: string }
+}
+
+export interface HandlerError {
+  status: number
+  message?: string
+}
+
+export type HandlerOutput = HandlerError | HandlerSuccess
+export type HandlerReqCtx<HA extends HandlerAuth = never> = {
+  auth: HA
+  params: QueryParams
+  input: HandlerInput
+  req: express.Request
+  res: express.Response
+}
+export type Handler<HA extends HandlerAuth = never> = (
+  ctx: HandlerReqCtx<HA>,
+) => Promise<HandlerOutput> | HandlerOutput

package/src/lexicon/types/com/atproto/admin/updateCommunicationTemplate.ts

@@ -0,0 +1,57 @@
+/**
+ * GENERATED CODE - DO NOT MODIFY
+ */
+import express from 'express'
+import { ValidationResult, BlobRef } from '@atproto/lexicon'
+import { lexicons } from '../../../../lexicons'
+import { isObj, hasProp } from '../../../../util'
+import { CID } from 'multiformats/cid'
+import { HandlerAuth } from '@atproto/xrpc-server'
+import * as ComAtprotoAdminDefs from './defs'
+
+export interface QueryParams {}
+
+export interface InputSchema {
+  /** ID of the template to be updated. */
+  id: string
+  /** Name of the template. */
+  name?: string
+  /** Content of the template, markdown supported, can contain variable placeholders. */
+  contentMarkdown?: string
+  /** Subject of the message, used in emails. */
+  subject?: string
+  /** DID of the user who is updating the template. */
+  updatedBy?: string
+  disabled?: boolean
+  [k: string]: unknown
+}
+
+export type OutputSchema = ComAtprotoAdminDefs.CommunicationTemplateView
+
+export interface HandlerInput {
+  encoding: 'application/json'
+  body: InputSchema
+}
+
+export interface HandlerSuccess {
+  encoding: 'application/json'
+  body: OutputSchema
+  headers?: { [key: string]: string }
+}
+
+export interface HandlerError {
+  status: number
+  message?: string
+}
+
+export type HandlerOutput = HandlerError | HandlerSuccess
+export type HandlerReqCtx<HA extends HandlerAuth = never> = {
+  auth: HA
+  params: QueryParams
+  input: HandlerInput
+  req: express.Request
+  res: express.Response
+}
+export type Handler<HA extends HandlerAuth = never> = (
+  ctx: HandlerReqCtx<HA>,
+) => Promise<HandlerOutput> | HandlerOutput

package/tests/communication-templates.test.ts

@@ -0,0 +1,131 @@
+import { TestNetwork, SeedClient, basicSeed } from '@atproto/dev-env'
+import AtpAgent from '@atproto/api'
+
+describe('communication-templates', () => {
+  let network: TestNetwork
+  let agent: AtpAgent
+  let sc: SeedClient
+
+  beforeAll(async () => {
+    network = await TestNetwork.create({
+      dbPostgresSchema: 'ozone_communication_templates',
+    })
+    agent = network.ozone.getClient()
+    sc = network.getSeedClient()
+    await basicSeed(sc)
+    await network.processAll()
+  })
+
+  afterAll(async () => {
+    await network.close()
+  })
+
+  const templateOne = {
+    name: 'Test name 1',
+    subject: 'Test subject 1',
+    contentMarkdown: 'Test content 1',
+  }
+
+  const listTemplates = async () => {
+    const { data } =
+      await agent.api.com.atproto.admin.listCommunicationTemplates(
+        {},
+        {
+          headers: network.ozone.adminAuthHeaders('moderator'),
+        },
+      )
+    return data.communicationTemplates
+  }
+
+  describe('create templates', () => {
+    it('only allows admins to create new templates', async () => {
+      const moderatorReq =
+        agent.api.com.atproto.admin.createCommunicationTemplate(
+          { ...templateOne, createdBy: sc.dids.bob },
+          {
+            encoding: 'application/json',
+            headers: network.ozone.adminAuthHeaders('moderator'),
+          },
+        )
+      await expect(moderatorReq).rejects.toThrow(
+        'Must be an admin to create a communication template',
+      )
+      const modReq =
+        await agent.api.com.atproto.admin.createCommunicationTemplate(
+          { ...templateOne, createdBy: sc.dids.bob },
+          {
+            encoding: 'application/json',
+            headers: network.ozone.adminAuthHeaders('admin'),
+          },
+        )
+
+      expect(modReq.data).toMatchObject({
+        ...templateOne,
+        lastUpdatedBy: sc.dids.bob,
+      })
+    })
+  })
+  describe('list templates', () => {
+    it('returns all saved templates', async () => {
+      const listBefore = await listTemplates()
+      expect(listBefore.length).toEqual(1)
+      expect(listBefore[0]).toMatchObject(templateOne)
+
+      const templateTwo = {
+        ...templateOne,
+        name: 'Test template 2',
+      }
+      await agent.api.com.atproto.admin.createCommunicationTemplate(
+        { ...templateTwo, createdBy: sc.dids.bob },
+        {
+          encoding: 'application/json',
+          headers: network.ozone.adminAuthHeaders('admin'),
+        },
+      )
+
+      const listAfter = await listTemplates()
+      expect(listAfter.length).toEqual(2)
+      expect(listAfter[1]).toMatchObject(templateTwo)
+    })
+  })
+  describe('update template', () => {
+    it('allows moderators to update a template by id', async () => {
+      const { data } =
+        await agent.api.com.atproto.admin.updateCommunicationTemplate(
+          { id: '1', updatedBy: sc.dids.bob, name: '1 Test template' },
+          {
+            encoding: 'application/json',
+            headers: network.ozone.adminAuthHeaders('admin'),
+          },
+        )
+
+      expect(data.name).not.toEqual(templateOne.name)
+      expect(data.name).toEqual('1 Test template')
+    })
+  })
+  describe('delete template', () => {
+    it('allows admins to remove a template by id', async () => {
+      const modReq = agent.api.com.atproto.admin.deleteCommunicationTemplate(
+        { id: '1' },
+        {
+          encoding: 'application/json',
+          headers: network.ozone.adminAuthHeaders('moderator'),
+        },
+      )
+
+      await expect(modReq).rejects.toThrow(
+        'Must be an admin to delete a communication template',
+      )
+
+      await agent.api.com.atproto.admin.deleteCommunicationTemplate(
+        { id: '1' },
+        {
+          encoding: 'application/json',
+          headers: network.ozone.adminAuthHeaders('admin'),
+        },
+      )
+      const list = await listTemplates()
+      expect(list.length).toEqual(1)
+    })
+  })
+})

package/dist/api/com/atproto/admin/emitModerationEvent.d.ts

@@ -1,3 +0,0 @@
-import { Server } from '../../../../lexicon';
-import AppContext from '../../../../context';
-export default function (server: Server, ctx: AppContext): void;

package/dist/api/com/atproto/admin/getModerationEvent.d.ts

@@ -1,3 +0,0 @@
-import { Server } from '../../../../lexicon';
-import AppContext from '../../../../context';
-export default function (server: Server, ctx: AppContext): void;

package/dist/api/com/atproto/admin/getRecord.d.ts

@@ -1,3 +0,0 @@
-import { Server } from '../../../../lexicon';
-import AppContext from '../../../../context';
-export default function (server: Server, ctx: AppContext): void;

package/dist/api/com/atproto/admin/getRepo.d.ts

@@ -1,3 +0,0 @@
-import { Server } from '../../../../lexicon';
-import AppContext from '../../../../context';
-export default function (server: Server, ctx: AppContext): void;

package/dist/api/com/atproto/admin/queryModerationEvents.d.ts

@@ -1,3 +0,0 @@
-import { Server } from '../../../../lexicon';
-import AppContext from '../../../../context';
-export default function (server: Server, ctx: AppContext): void;

package/dist/api/com/atproto/admin/queryModerationStatuses.d.ts

@@ -1,3 +0,0 @@
-import { Server } from '../../../../lexicon';
-import AppContext from '../../../../context';
-export default function (server: Server, ctx: AppContext): void;

package/dist/api/com/atproto/admin/searchRepos.d.ts

@@ -1,3 +0,0 @@
-import { Server } from '../../../../lexicon';
-import AppContext from '../../../../context';
-export default function (server: Server, ctx: AppContext): void;

package/dist/api/com/atproto/admin/util.d.ts

@@ -1,5 +0,0 @@
-import AppContext from '../../../../context';
-import { RepoView, RepoViewDetail, AccountView } from '../../../../lexicon/types/com/atproto/admin/defs';
-export declare const getPdsAccountInfo: (ctx: AppContext, did: string) => Promise<AccountView | null>;
-export declare const addAccountInfoToRepoViewDetail: (repoView: RepoViewDetail, accountInfo: AccountView | null, includeEmail?: boolean) => RepoViewDetail;
-export declare const addAccountInfoToRepoView: (repoView: RepoView, accountInfo: AccountView | null, includeEmail?: boolean) => RepoView;

package/dist/api/com/atproto/moderation/createReport.d.ts

@@ -1,3 +0,0 @@
-import { Server } from '../../../../lexicon';
-import AppContext from '../../../../context';
-export default function (server: Server, ctx: AppContext): void;

package/dist/api/com/atproto/moderation/util.d.ts

@@ -1,4 +0,0 @@
-import { InputSchema as ReportInput } from '../../../../lexicon/types/com/atproto/moderation/createReport';
-export declare const getReasonType: (reasonType: ReportInput['reasonType']) => string | boolean;
-export declare const getEventType: (type: string) => "com.atproto.admin.defs#modEventTakedown" | "com.atproto.admin.defs#modEventAcknowledge" | "com.atproto.admin.defs#modEventEscalate" | "com.atproto.admin.defs#modEventComment" | "com.atproto.admin.defs#modEventLabel" | "com.atproto.admin.defs#modEventReport" | "com.atproto.admin.defs#modEventMute" | "com.atproto.admin.defs#modEventReverseTakedown" | "com.atproto.admin.defs#modEventEmail";
-export declare const getReviewState: (reviewState?: string) => "com.atproto.admin.defs#reviewOpen" | "com.atproto.admin.defs#reviewEscalated" | "com.atproto.admin.defs#reviewClosed" | undefined;

package/dist/api/com/atproto/temp/fetchLabels.d.ts

@@ -1,3 +0,0 @@
-import { Server } from '../../../../lexicon';
-import AppContext from '../../../../context';
-export default function (server: Server, ctx: AppContext): void;

package/dist/api/util.d.ts

@@ -1,2 +0,0 @@
-import express from 'express';
-export declare const setRepoRev: (res: express.Response, rev: string | null) => void;

package/dist/auth-verifier.d.ts

@@ -1,47 +0,0 @@
-import { IdResolver } from '@atproto/identity';
-import express from 'express';
-type ReqCtx = {
-    req: express.Request;
-};
-type AdminOutput = {
-    credentials: {
-        type: 'admin';
-        aud: string;
-        iss: string;
-        isModerator: boolean;
-        isTriage: true;
-    };
-};
-type StandardOutput = {
-    credentials: {
-        type: 'standard';
-        aud: string;
-        iss: string;
-        isModerator: boolean;
-        isTriage: boolean;
-    };
-};
-type NullOutput = {
-    credentials: {
-        type: 'null';
-        iss: null;
-    };
-};
-export type AuthVerifierOpts = {
-    serviceDid: string;
-    moderators: string[];
-    triage: string[];
-};
-export declare class AuthVerifier {
-    idResolver: IdResolver;
-    serviceDid: string;
-    moderators: string[];
-    triage: string[];
-    constructor(idResolver: IdResolver, opts: AuthVerifierOpts);
-    admin: (reqCtx: ReqCtx) => Promise<AdminOutput>;
-    standard: (reqCtx: ReqCtx) => Promise<StandardOutput>;
-    standardOptional: (reqCtx: ReqCtx) => Promise<StandardOutput | NullOutput>;
-    nullCreds(): NullOutput;
-}
-export declare const getJwtStrFromReq: (req: express.Request) => string | null;
-export {};

package/dist/config.d.ts

@@ -1,42 +0,0 @@
-export interface ServerConfigValues {
-    version: string;
-    debugMode?: boolean;
-    port?: number;
-    publicUrl?: string;
-    serverDid: string;
-    appviewUrl: string;
-    appviewDid?: string;
-    pdsUrl?: string;
-    pdsDid?: string;
-    dbPostgresUrl: string;
-    dbPostgresSchema?: string;
-    didPlcUrl: string;
-    labelerDid: string;
-    adminPassword: string;
-    moderatorPassword?: string;
-    triagePassword?: string;
-}
-export declare class ServerConfig {
-    private cfg;
-    private assignedPort?;
-    constructor(cfg: ServerConfigValues);
-    static readEnv(overrides?: Partial<ServerConfigValues>): ServerConfig;
-    assignPort(port: number): void;
-    get version(): string;
-    get debugMode(): boolean;
-    get port(): number | undefined;
-    get localUrl(): string;
-    get publicUrl(): string | undefined;
-    get serverDid(): string;
-    get appviewUrl(): string;
-    get appviewDid(): string | undefined;
-    get pdsUrl(): string | undefined;
-    get pdsDid(): string | undefined;
-    get dbPostgresUrl(): string;
-    get dbPostgresSchema(): string | undefined;
-    get didPlcUrl(): string;
-    get labelerDid(): string;
-    get adminPassword(): string;
-    get moderatorPassword(): string | undefined;
-    get triagePassword(): string | undefined;
-}

package/dist/daemon/config.d.ts

@@ -1,23 +0,0 @@
-export interface DaemonConfigValues {
-    version: string;
-    dbPostgresUrl: string;
-    dbPostgresSchema?: string;
-    serverDid: string;
-    appviewUrl: string;
-    appviewDid?: string;
-    pdsUrl?: string;
-    pdsDid?: string;
-}
-export declare class DaemonConfig {
-    private cfg;
-    constructor(cfg: DaemonConfigValues);
-    static readEnv(overrides?: Partial<DaemonConfigValues>): DaemonConfig;
-    get version(): string;
-    get dbPostgresUrl(): string;
-    get dbPostgresSchema(): string | undefined;
-    get serverDid(): string;
-    get appviewUrl(): string;
-    get appviewDid(): string | undefined;
-    get pdsUrl(): string | undefined;
-    get pdsDid(): string | undefined;
-}

package/dist/lexicon/types/app/bsky/moderation/defs.d.ts

@@ -1,49 +0,0 @@
-import { ValidationResult } from '@atproto/lexicon';
-import * as AppBskyActorDefs from '../actor/defs';
-import * as AppBskyRichtextFacet from '../richtext/facet';
-import * as ComAtprotoLabelDefs from '../../../com/atproto/label/defs';
-import * as ComAtprotoModerationDefs from '../../../com/atproto/moderation/defs';
-export interface ModServiceView {
-    uri: string;
-    cid: string;
-    creator: AppBskyActorDefs.ProfileView;
-    description?: string;
-    descriptionFacets?: AppBskyRichtextFacet.Main[];
-    likeCount?: number;
-    viewer?: ModServiceViewerState;
-    indexedAt: string;
-    labels?: ComAtprotoLabelDefs.Label[];
-    [k: string]: unknown;
-}
-export declare function isModServiceView(v: unknown): v is ModServiceView;
-export declare function validateModServiceView(v: unknown): ValidationResult;
-export interface ModServiceViewDetailed {
-    uri: string;
-    cid: string;
-    creator: AppBskyActorDefs.ProfileView;
-    description?: string;
-    descriptionFacets?: AppBskyRichtextFacet.Main[];
-    policies: ModServicePolicies;
-    likeCount?: number;
-    viewer?: ModServiceViewerState;
-    indexedAt: string;
-    labels?: ComAtprotoLabelDefs.Label[];
-    [k: string]: unknown;
-}
-export declare function isModServiceViewDetailed(v: unknown): v is ModServiceViewDetailed;
-export declare function validateModServiceViewDetailed(v: unknown): ValidationResult;
-export interface ModServiceViewerState {
-    like?: string;
-    [k: string]: unknown;
-}
-export declare function isModServiceViewerState(v: unknown): v is ModServiceViewerState;
-export declare function validateModServiceViewerState(v: unknown): ValidationResult;
-export interface ModServicePolicies {
-    description?: string;
-    descriptionFacets?: AppBskyRichtextFacet.Main[];
-    reportReasons: ComAtprotoModerationDefs.ReasonType[];
-    labelValues: ComAtprotoLabelDefs.LabelValue[];
-    [k: string]: unknown;
-}
-export declare function isModServicePolicies(v: unknown): v is ModServicePolicies;
-export declare function validateModServicePolicies(v: unknown): ValidationResult;

package/dist/lexicon/types/app/bsky/moderation/service.d.ts

@@ -1,17 +0,0 @@
-import { ValidationResult } from '@atproto/lexicon';
-import * as AppBskyRichtextFacet from '../richtext/facet';
-import * as AppBskyModerationDefs from './defs';
-import * as ComAtprotoLabelDefs from '../../../com/atproto/label/defs';
-export interface Record {
-    description?: string;
-    descriptionFacets?: AppBskyRichtextFacet.Main[];
-    policies: AppBskyModerationDefs.ModServicePolicies;
-    labels?: ComAtprotoLabelDefs.SelfLabels | {
-        $type: string;
-        [k: string]: unknown;
-    };
-    createdAt: string;
-    [k: string]: unknown;
-}
-export declare function isRecord(v: unknown): v is Record;
-export declare function validateRecord(v: unknown): ValidationResult;

package/dist/sequencer/index.d.ts

@@ -1,2 +0,0 @@
-export * from './sequencer';
-export * from './outbox';

package/dist/sequencer/outbox.d.ts

@@ -1,16 +0,0 @@
-import { AsyncBuffer } from '@atproto/common';
-import { Sequencer, LabelsEvt } from './sequencer';
-export type OutboxOpts = {
-    maxBufferSize: number;
-};
-export declare class Outbox {
-    sequencer: Sequencer;
-    private caughtUp;
-    lastSeen: number;
-    cutoverBuffer: LabelsEvt[];
-    outBuffer: AsyncBuffer<LabelsEvt>;
-    constructor(sequencer: Sequencer, opts?: Partial<OutboxOpts>);
-    events(backfillCursor?: number, signal?: AbortSignal): AsyncGenerator<LabelsEvt>;
-    getBackfill(backfillCursor: number): AsyncGenerator<LabelsEvt, void, unknown>;
-}
-export default Outbox;

package/dist/sequencer/sequencer.d.ts

@@ -1,35 +0,0 @@
-/// <reference types="node" />
-import TypedEmitter from 'typed-emitter';
-import Database from '../db';
-import { Labels as LabelsEvt } from '../lexicon/types/com/atproto/label/subscribeLabels';
-import { Label as LabelTable } from '../db/schema/label';
-import { Selectable } from 'kysely';
-import { ModerationService } from '../mod-service';
-export type { Labels as LabelsEvt } from '../lexicon/types/com/atproto/label/subscribeLabels';
-type LabelRow = Selectable<LabelTable>;
-declare const Sequencer_base: new () => SequencerEmitter;
-export declare class Sequencer extends Sequencer_base {
-    modService: ModerationService;
-    lastSeen: number;
-    destroyed: boolean;
-    pollPromise: Promise<void>;
-    pollTimer: NodeJS.Timer | undefined;
-    triesWithNoResults: number;
-    db: Database;
-    constructor(modService: ModerationService, lastSeen?: number);
-    start(): Promise<void>;
-    destroy(): Promise<void>;
-    curr(): Promise<number | null>;
-    next(cursor: number): Promise<LabelRow | null>;
-    requestLabelRange(opts: {
-        earliestId?: number;
-        limit?: number;
-    }): Promise<LabelsEvt[]>;
-    private poll;
-}
-type SequencerEvents = {
-    events: (evts: LabelsEvt[]) => void;
-    close: () => void;
-};
-export type SequencerEmitter = TypedEmitter<SequencerEvents>;
-export default Sequencer;

package/dist/services/index.d.ts

@@ -1,7 +0,0 @@
-import AtpAgent from '@atproto/api';
-import { ModerationService } from './moderation';
-import { FromDb } from './types';
-export declare function createServices(appviewAgent: AtpAgent): Services;
-export declare type Services = {
-    moderation: FromDb<ModerationService>;
-};