@etohq/review 0.0.0-stage → 2.1.0

package/dist/services/review-module-service.d.ts

@@ -0,0 +1,269 @@
+import { Context, DAL, ModulesSdkTypes } from "@etohq/framework/types";
+import { ModulesSdkUtils } from "@etohq/framework/utils";
+import type { EditReviewDTO, FlagReviewDTO, IReviewModuleService, ListPublicReviewsDTO, ModerateReviewDTO, PublicReviewDTO, RespondToReviewDTO, ReviewDTO, ReviewFlagDTO, ReviewRef, ReviewRevisionDTO, ReviewSubjectQuery, ReviewSummaryDTO, SubmitReviewDTO, SubmitReviewResult, WithdrawReviewDTO } from "@etohq/types/review";
+import { Review, ReviewFlag, ReviewRevision, ReviewSummary } from "../models";
+type InjectedDependencies = {
+    baseRepository: DAL.RepositoryService;
+    reviewService: ModulesSdkTypes.IEtoInternalService<typeof Review>;
+    reviewRevisionService: ModulesSdkTypes.IEtoInternalService<typeof ReviewRevision>;
+    reviewFlagService: ModulesSdkTypes.IEtoInternalService<typeof ReviewFlag>;
+    reviewSummaryService: ModulesSdkTypes.IEtoInternalService<typeof ReviewSummary>;
+};
+type Pending = {
+    name: string;
+    data: Record<string, unknown>;
+};
+declare const ReviewModuleService_base: ModulesSdkUtils.EtoServiceReturnType<{
+    Review: {
+        dto: ReviewDTO;
+    };
+    ReviewRevision: {
+        dto: ReviewRevisionDTO;
+    };
+    ReviewFlag: {
+        dto: ReviewFlagDTO;
+    };
+    ReviewSummary: {
+        dto: ReviewSummaryDTO;
+    };
+}>;
+/**
+ * The review engine.
+ *
+ * Every invariant in DESIGN.md is enforced here or by an index. Eligibility —
+ * whether the reviewer really took part — is the consumer's, attested on the
+ * input (`verified`, `eligible_until`) and composed by the consumer's flow ahead
+ * of the canonical workflows.
+ */
+export default class ReviewModuleService extends ReviewModuleService_base implements IReviewModuleService {
+    protected baseRepository_: DAL.RepositoryService;
+    protected reviewService_: ModulesSdkTypes.IEtoInternalService<typeof Review>;
+    protected reviewRevisionService_: ModulesSdkTypes.IEtoInternalService<typeof ReviewRevision>;
+    protected reviewFlagService_: ModulesSdkTypes.IEtoInternalService<typeof ReviewFlag>;
+    protected reviewSummaryService_: ModulesSdkTypes.IEtoInternalService<typeof ReviewSummary>;
+    constructor(dependencies: InjectedDependencies);
+    submitReview(data: SubmitReviewDTO, sharedContext?: Context): Promise<SubmitReviewResult>;
+    protected submitReview_(data: SubmitReviewDTO, sharedContext?: Context): Promise<{
+        review: any;
+        replayed: boolean;
+        revealed_ids: string[];
+        events: Pending[];
+    }>;
+    editReview(data: EditReviewDTO, sharedContext?: Context): Promise<ReviewDTO>;
+    protected editReview_(data: EditReviewDTO, sharedContext?: Context): Promise<{
+        review: {
+            id: string;
+            space_id: string;
+            subject_type: string;
+            subject_id: string;
+            subject_owner_id: string | null;
+            reviewer_type: string;
+            reviewer_id: string;
+            reviewer_display: string | null;
+            anonymous: boolean;
+            context_type: string;
+            context_id: string;
+            scope: string | null;
+            rating: number;
+            dimensions: Record<string, unknown> | null;
+            tags: Record<string, unknown> | null;
+            title: string | null;
+            body: string | null;
+            media: Record<string, unknown> | null;
+            locale: string | null;
+            verified: boolean;
+            status: "pending" | "published" | "hidden" | "withdrawn";
+            revealed_at: Date | null;
+            reveal_after: Date | null;
+            eligible_until: Date | null;
+            occurred_at: Date;
+            edited_at: Date | null;
+            response_body: string | null;
+            responder_id: string | null;
+            responded_at: Date | null;
+            moderated_by: string | null;
+            moderated_at: Date | null;
+            moderation_reason: string | null;
+            open_flag_count: number;
+            idempotency_key: string | null;
+            metadata: Record<string, unknown> | null;
+            created_at: Date;
+            updated_at: Date;
+            deleted_at: Date | null;
+        };
+        events: Pending[];
+    }>;
+    withdrawReview(data: WithdrawReviewDTO, sharedContext?: Context): Promise<ReviewDTO>;
+    protected withdrawReview_(data: WithdrawReviewDTO, sharedContext?: Context): Promise<{
+        review: {
+            id: string;
+            space_id: string;
+            subject_type: string;
+            subject_id: string;
+            subject_owner_id: string | null;
+            reviewer_type: string;
+            reviewer_id: string;
+            reviewer_display: string | null;
+            anonymous: boolean;
+            context_type: string;
+            context_id: string;
+            scope: string | null;
+            rating: number;
+            dimensions: Record<string, unknown> | null;
+            tags: Record<string, unknown> | null;
+            title: string | null;
+            body: string | null;
+            media: Record<string, unknown> | null;
+            locale: string | null;
+            verified: boolean;
+            status: "pending" | "published" | "hidden" | "withdrawn";
+            revealed_at: Date | null;
+            reveal_after: Date | null;
+            eligible_until: Date | null;
+            occurred_at: Date;
+            edited_at: Date | null;
+            response_body: string | null;
+            responder_id: string | null;
+            responded_at: Date | null;
+            moderated_by: string | null;
+            moderated_at: Date | null;
+            moderation_reason: string | null;
+            open_flag_count: number;
+            idempotency_key: string | null;
+            metadata: Record<string, unknown> | null;
+            created_at: Date;
+            updated_at: Date;
+            deleted_at: Date | null;
+        };
+        events: Pending[];
+    }>;
+    respondToReview(data: RespondToReviewDTO, sharedContext?: Context): Promise<ReviewDTO>;
+    protected respondToReview_(data: RespondToReviewDTO, sharedContext?: Context): Promise<{
+        id: string;
+        space_id: string;
+        subject_type: string;
+        subject_id: string;
+        subject_owner_id: string | null;
+        reviewer_type: string;
+        reviewer_id: string;
+        reviewer_display: string | null;
+        anonymous: boolean;
+        context_type: string;
+        context_id: string;
+        scope: string | null;
+        rating: number;
+        dimensions: Record<string, unknown> | null;
+        tags: Record<string, unknown> | null;
+        title: string | null;
+        body: string | null;
+        media: Record<string, unknown> | null;
+        locale: string | null;
+        verified: boolean;
+        status: "pending" | "published" | "hidden" | "withdrawn";
+        revealed_at: Date | null;
+        reveal_after: Date | null;
+        eligible_until: Date | null;
+        occurred_at: Date;
+        edited_at: Date | null;
+        response_body: string | null;
+        responder_id: string | null;
+        responded_at: Date | null;
+        moderated_by: string | null;
+        moderated_at: Date | null;
+        moderation_reason: string | null;
+        open_flag_count: number;
+        idempotency_key: string | null;
+        metadata: Record<string, unknown> | null;
+        created_at: Date;
+        updated_at: Date;
+        deleted_at: Date | null;
+    }>;
+    moderateReview(data: ModerateReviewDTO, sharedContext?: Context): Promise<ReviewDTO>;
+    protected moderateReview_(data: ModerateReviewDTO, sharedContext?: Context): Promise<{
+        review: {
+            id: string;
+            space_id: string;
+            subject_type: string;
+            subject_id: string;
+            subject_owner_id: string | null;
+            reviewer_type: string;
+            reviewer_id: string;
+            reviewer_display: string | null;
+            anonymous: boolean;
+            context_type: string;
+            context_id: string;
+            scope: string | null;
+            rating: number;
+            dimensions: Record<string, unknown> | null;
+            tags: Record<string, unknown> | null;
+            title: string | null;
+            body: string | null;
+            media: Record<string, unknown> | null;
+            locale: string | null;
+            verified: boolean;
+            status: "pending" | "published" | "hidden" | "withdrawn";
+            revealed_at: Date | null;
+            reveal_after: Date | null;
+            eligible_until: Date | null;
+            occurred_at: Date;
+            edited_at: Date | null;
+            response_body: string | null;
+            responder_id: string | null;
+            responded_at: Date | null;
+            moderated_by: string | null;
+            moderated_at: Date | null;
+            moderation_reason: string | null;
+            open_flag_count: number;
+            idempotency_key: string | null;
+            metadata: Record<string, unknown> | null;
+            created_at: Date;
+            updated_at: Date;
+            deleted_at: Date | null;
+        };
+        events: Pending[];
+    }>;
+    flagReview(data: FlagReviewDTO, sharedContext?: Context): Promise<ReviewFlagDTO>;
+    protected flagReview_(data: FlagReviewDTO, sharedContext?: Context): Promise<any>;
+    revealDueReviews(data?: {
+        now?: Date | string;
+    }, sharedContext?: Context): Promise<{
+        revealed_ids: string[];
+    }>;
+    protected revealDueReviews_(data: {
+        now?: Date | string;
+    }, sharedContext?: Context): Promise<{
+        revealed_ids: string[];
+        events: Pending[];
+    }>;
+    anonymizeReviewer(data: {
+        reviewer: ReviewRef;
+    }, sharedContext?: Context): Promise<{
+        anonymized: number;
+    }>;
+    protected anonymizeReviewer_(data: {
+        reviewer: ReviewRef;
+    }, sharedContext?: Context): Promise<{
+        anonymized: number;
+    }>;
+    getReviewSummary(query: ReviewSubjectQuery, sharedContext?: Context): Promise<ReviewSummaryDTO>;
+    getReviewSummaries(query: {
+        space_id: string;
+        subject_type: string;
+        subject_ids: string[];
+        scope?: string | null;
+    }, sharedContext?: Context): Promise<ReviewSummaryDTO[]>;
+    listPublicReviews(query: ListPublicReviewsDTO, sharedContext?: Context): Promise<{
+        reviews: PublicReviewDTO[];
+        count: number;
+    }>;
+    private ownReview_;
+    /**
+     * Recompute summaries from the rows, in SQL, under a per-subject advisory
+     * lock held to the end of the transaction. Two reviews of one subject at once
+     * serialise here, so the second recompute sees the first's row.
+     */
+    private recomputeSummaries_;
+    private emit_;
+}
+export {};
+//# sourceMappingURL=review-module-service.d.ts.map

package/dist/services/review-module-service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"review-module-service.d.ts","sourceRoot":"","sources":["../../src/services/review-module-service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,GAAG,EAAiB,eAAe,EAAE,MAAM,wBAAwB,CAAA;AACrF,OAAO,EAOL,eAAe,EAEhB,MAAM,wBAAwB,CAAA;AAE/B,OAAO,KAAK,EACV,aAAa,EACb,aAAa,EACb,oBAAoB,EACpB,oBAAoB,EACpB,iBAAiB,EACjB,eAAe,EACf,kBAAkB,EAClB,SAAS,EACT,aAAa,EACb,SAAS,EACT,iBAAiB,EACjB,kBAAkB,EAClB,gBAAgB,EAChB,eAAe,EACf,kBAAkB,EAClB,iBAAiB,EAClB,MAAM,qBAAqB,CAAA;AAS5B,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAE3E,KAAK,oBAAoB,GAAG;IAC1B,cAAc,EAAE,GAAG,CAAC,iBAAiB,CAAA;IACrC,aAAa,EAAE,eAAe,CAAC,mBAAmB,CAAC,OAAO,MAAM,CAAC,CAAA;IACjE,qBAAqB,EAAE,eAAe,CAAC,mBAAmB,CAAC,OAAO,cAAc,CAAC,CAAA;IACjF,iBAAiB,EAAE,eAAe,CAAC,mBAAmB,CAAC,OAAO,UAAU,CAAC,CAAA;IACzE,oBAAoB,EAAE,eAAe,CAAC,mBAAmB,CAAC,OAAO,aAAa,CAAC,CAAA;CAChF,CAAA;AAYD,KAAK,OAAO,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAAE,CAAA;;YAiBlD;QAAE,GAAG,EAAE,SAAS,CAAA;KAAE;oBACV;QAAE,GAAG,EAAE,iBAAiB,CAAA;KAAE;gBAC9B;QAAE,GAAG,EAAE,aAAa,CAAA;KAAE;mBACnB;QAAE,GAAG,EAAE,gBAAgB,CAAA;KAAE;;AAb5C;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,OAAO,mBACnB,SAAQ,wBAMR,YAAW,oBAAoB;IAE/B,SAAS,CAAC,eAAe,EAAE,GAAG,CAAC,iBAAiB,CAAA;IAChD,SAAS,CAAC,cAAc,EAAE,eAAe,CAAC,mBAAmB,CAAC,OAAO,MAAM,CAAC,CAAA;IAC5E,SAAS,CAAC,sBAAsB,EAAE,eAAe,CAAC,mBAAmB,CAAC,OAAO,cAAc,CAAC,CAAA;IAC5F,SAAS,CAAC,kBAAkB,EAAE,eAAe,CAAC,mBAAmB,CAAC,OAAO,UAAU,CAAC,CAAA;IACpF,SAAS,CAAC,qBAAqB,EAAE,eAAe,CAAC,mBAAmB,CAAC,OAAO,aAAa,CAAC,CAAA;gBAE9E,YAAY,EAAE,oBAAoB;IAcxC,YAAY,CAChB,IAAI,EAAE,eAAe,EACP,aAAa,GAAE,OAAY,GACxC,OAAO,CAAC,kBAAkB,CAAC;cAWd,aAAa,CAC3B,IAAI,EAAE,eAAe,EACP,aAAa,GAAE,OAAY;;;;;;IA+JrC,UAAU,CACd,IAAI,EAAE,aAAa,EACL,aAAa,GAAE,OAAY,GACxC,OAAO,CAAC,SAAS,CAAC;cAOL,WAAW,CAAC,IAAI,EAAE,aAAa,EAAgB,aAAa,GAAE,OAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAuDpF,cAAc,CAClB,IAAI,EAAE,iBAAiB,EACT,aAAa,GAAE,OAAY,GACxC,OAAO,CAAC,SAAS,CAAC;cAOL,eAAe,CAAC,IAAI,EAAE,iBAAiB,EAAgB,aAAa,GAAE,OAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;gBAGrD,OAAO,EAAE;;IAiBhD,eAAe,CACnB,IAAI,EAAE,kBAAkB,EACV,aAAa,GAAE,OAAY,GACxC,OAAO,CAAC,SAAS,CAAC;cAOL,gBAAgB,CAAC,IAAI,EAAE,kBAAkB,EAAgB,aAAa,GAAE,OAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAkC9F,cAAc,CAClB,IAAI,EAAE,iBAAiB,EACT,aAAa,GAAE,OAAY,GACxC,OAAO,CAAC,SAAS,CAAC;cAOL,eAAe,CAAC,IAAI,EAAE,iBAAiB,EAAgB,aAAa,GAAE,OAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IA+C5F,UAAU,CACd,IAAI,EAAE,aAAa,EACL,aAAa,GAAE,OAAY,GACxC,OAAO,CAAC,aAAa,CAAC;cAOT,WAAW,CAAC,IAAI,EAAE,aAAa,EAAgB,aAAa,GAAE,OAAY;IAmDpF,gBAAgB,CACpB,IAAI,GAAE;QAAE,GAAG,CAAC,EAAE,IAAI,GAAG,MAAM,CAAA;KAAO,EACpB,aAAa,GAAE,OAAY,GACxC,OAAO,CAAC;QAAE,YAAY,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC;cAOtB,iBAAiB,CAC/B,IAAI,EAAE;QAAE,GAAG,CAAC,EAAE,IAAI,GAAG,MAAM,CAAA;KAAE,EACf,aAAa,GAAE,OAAY;sBASV,MAAM,EAAE;gBAAgB,OAAO,EAAE;;IAc5D,iBAAiB,CACrB,IAAI,EAAE;QAAE,QAAQ,EAAE,SAAS,CAAA;KAAE,EACf,aAAa,GAAE,OAAY,GACxC,OAAO,CAAC;QAAE,UAAU,EAAE,MAAM,CAAA;KAAE,CAAC;cAKlB,kBAAkB,CAChC,IAAI,EAAE;QAAE,QAAQ,EAAE,SAAS,CAAA;KAAE,EACf,aAAa,GAAE,OAAY;;;IA+BrC,gBAAgB,CACpB,KAAK,EAAE,kBAAkB,EACX,aAAa,GAAE,OAAY,GACxC,OAAO,CAAC,gBAAgB,CAAC;IAStB,kBAAkB,CACtB,KAAK,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,YAAY,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,EAAE,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,EACjF,aAAa,GAAE,OAAY,GACxC,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAuBxB,iBAAiB,CACrB,KAAK,EAAE,oBAAoB,EACb,aAAa,GAAE,OAAY,GACxC,OAAO,CAAC;QAAE,OAAO,EAAE,eAAe,EAAE,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;YAsC3C,UAAU;IASxB;;;;OAIG;YACW,mBAAmB;IAiGjC,OAAO,CAAC,KAAK;CAcd"}