@deenruv/reviews-plugin 1.0.0

package/dist/plugin-server/entities/review-translation.entity.js

@@ -0,0 +1,37 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+import { DeenruvEntity, LanguageCode, } from "@deenruv/core";
+import { Column, Entity, Index, ManyToOne } from "typeorm";
+import { ReviewEntity } from "./review.entity.js";
+let ReviewEntityTranslation = class ReviewEntityTranslation extends DeenruvEntity {
+    constructor(input) {
+        super(input);
+    }
+};
+__decorate([
+    Column("varchar"),
+    __metadata("design:type", String)
+], ReviewEntityTranslation.prototype, "languageCode", void 0);
+__decorate([
+    Column("text"),
+    __metadata("design:type", String)
+], ReviewEntityTranslation.prototype, "body", void 0);
+__decorate([
+    Index(),
+    ManyToOne(() => ReviewEntity, (base) => base.translations, {
+        onDelete: "CASCADE",
+    }),
+    __metadata("design:type", Object)
+], ReviewEntityTranslation.prototype, "base", void 0);
+ReviewEntityTranslation = __decorate([
+    Entity(),
+    __metadata("design:paramtypes", [Object])
+], ReviewEntityTranslation);
+export { ReviewEntityTranslation };

package/dist/plugin-server/entities/review.entity.d.ts

@@ -0,0 +1,24 @@
+import { Relation } from "typeorm";
+import type { DeepPartial, LocaleString, Translatable, Translation } from "@deenruv/core";
+import { Customer, DeenruvEntity, Order, Product, ProductVariant, User } from "@deenruv/core";
+import { ReviewState } from "../constants.js";
+import { ReviewEntityTranslation } from "./review-translation.entity.js";
+export declare class ReviewEntity extends DeenruvEntity implements Translatable {
+    constructor(input?: DeepPartial<ReviewEntity>);
+    keepAnonymous: boolean;
+    assetKeys?: string[];
+    state: ReviewState;
+    response?: string;
+    responseCreatedAt?: Date;
+    responseAuthor?: User;
+    product?: Relation<Product>;
+    productVariant?: Relation<ProductVariant>;
+    order?: Relation<Order>;
+    body: LocaleString;
+    translations: Relation<Array<Translation<ReviewEntityTranslation>>>;
+    rating: number;
+    author?: Relation<Customer>;
+    authorName: string;
+    authorEmailAddress: string;
+    authorLocation?: string;
+}

package/dist/plugin-server/entities/review.entity.js

@@ -0,0 +1,89 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+import { Column, Entity, ManyToOne, OneToMany } from "typeorm";
+import { Customer, DeenruvEntity, Order, Product, ProductVariant, User, } from "@deenruv/core";
+import { ReviewState } from "../constants.js";
+import { ReviewEntityTranslation } from "./review-translation.entity.js";
+let ReviewEntity = class ReviewEntity extends DeenruvEntity {
+    constructor(input) {
+        super(input);
+    }
+};
+__decorate([
+    Column({ default: false }),
+    __metadata("design:type", Boolean)
+], ReviewEntity.prototype, "keepAnonymous", void 0);
+__decorate([
+    Column({ nullable: true, type: "simple-json" }),
+    __metadata("design:type", Array)
+], ReviewEntity.prototype, "assetKeys", void 0);
+__decorate([
+    Column({
+        type: "enum",
+        enum: ReviewState,
+        default: ReviewState.PENDING,
+    }),
+    __metadata("design:type", String)
+], ReviewEntity.prototype, "state", void 0);
+__decorate([
+    Column("text", { nullable: true, default: null }),
+    __metadata("design:type", String)
+], ReviewEntity.prototype, "response", void 0);
+__decorate([
+    Column({ nullable: true, default: null }),
+    __metadata("design:type", Date)
+], ReviewEntity.prototype, "responseCreatedAt", void 0);
+__decorate([
+    ManyToOne(() => User, { nullable: true }),
+    __metadata("design:type", User)
+], ReviewEntity.prototype, "responseAuthor", void 0);
+__decorate([
+    ManyToOne(() => Product, { nullable: true }),
+    __metadata("design:type", Object)
+], ReviewEntity.prototype, "product", void 0);
+__decorate([
+    ManyToOne(() => ProductVariant, { nullable: true }),
+    __metadata("design:type", Object)
+], ReviewEntity.prototype, "productVariant", void 0);
+__decorate([
+    ManyToOne(() => Order, { nullable: true }),
+    __metadata("design:type", Object)
+], ReviewEntity.prototype, "order", void 0);
+__decorate([
+    OneToMany(() => ReviewEntityTranslation, (translation) => translation.base, {
+        eager: true,
+    }),
+    __metadata("design:type", Object)
+], ReviewEntity.prototype, "translations", void 0);
+__decorate([
+    Column(),
+    __metadata("design:type", Number)
+], ReviewEntity.prototype, "rating", void 0);
+__decorate([
+    ManyToOne(() => Customer, { nullable: true }),
+    __metadata("design:type", Object)
+], ReviewEntity.prototype, "author", void 0);
+__decorate([
+    Column(),
+    __metadata("design:type", String)
+], ReviewEntity.prototype, "authorName", void 0);
+__decorate([
+    Column(),
+    __metadata("design:type", String)
+], ReviewEntity.prototype, "authorEmailAddress", void 0);
+__decorate([
+    Column({ nullable: true }),
+    __metadata("design:type", String)
+], ReviewEntity.prototype, "authorLocation", void 0);
+ReviewEntity = __decorate([
+    Entity(),
+    __metadata("design:paramtypes", [Object])
+], ReviewEntity);
+export { ReviewEntity };

package/dist/plugin-server/events.d.ts

@@ -0,0 +1,10 @@
+import { RequestContext, DeenruvEvent } from "@deenruv/core";
+import { ReviewEntity } from "./entities/review.entity.js";
+export default class ReviewChangeStateEvent extends DeenruvEvent {
+    ctx: RequestContext;
+    review: ReviewEntity;
+    fromState: string;
+    toState: string;
+    message?: string | undefined;
+    constructor(ctx: RequestContext, review: ReviewEntity, fromState: string, toState: string, message?: string | undefined);
+}

package/dist/plugin-server/events.js

@@ -0,0 +1,11 @@
+import { DeenruvEvent } from "@deenruv/core";
+export default class ReviewChangeStateEvent extends DeenruvEvent {
+    constructor(ctx, review, fromState, toState, message) {
+        super();
+        this.ctx = ctx;
+        this.review = review;
+        this.fromState = fromState;
+        this.toState = toState;
+        this.message = message;
+    }
+}

package/dist/plugin-server/extensions/admin-api.extension.d.ts

@@ -0,0 +1,2 @@
+import { DocumentNode } from "graphql";
+export declare const AdminAPIExtension: DocumentNode;

package/dist/plugin-server/extensions/admin-api.extension.js

@@ -0,0 +1,70 @@
+import { gql } from "graphql-tag";
+import { SharedAPIExtension } from "./shared.extension.js";
+export const AdminAPIExtension = gql `
+  ${SharedAPIExtension}
+
+  type ReviewsConfig {
+    reviewsLanguages: [LanguageCode!]!
+    canTranslate: Boolean!
+  }
+
+  input TranslateReviewsInput {
+    id: ID!
+    languages: [LanguageCode!]!
+  }
+
+  type GeneratedReviewTranslation {
+    languageCode: LanguageCode!
+    body: String!
+  }
+
+  type ReviewInfoForProduct {
+    averageRating: Float!
+    totalReviews: Int!
+    totalRatings: Int!
+  }
+
+  extend type Query {
+    translateReviews(
+      input: TranslateReviewsInput!
+    ): [GeneratedReviewTranslation!]!
+    getReviewsConfig: ReviewsConfig!
+    listReviews(
+      options: ReviewListOptions!
+      productId: ID
+      orderId: ID
+    ): ReviewList!
+    getReview(id: ID!): Review
+    getReviewInfoForProduct(productId: ID!): ReviewInfoForProduct
+    getReviewForOrder(orderId: ID!): Review
+  }
+
+  input ChangeReviewStateInput {
+    id: ID!
+    state: ReviewState!
+    message: String
+  }
+
+  input ReviewEntityTranslation {
+    languageCode: LanguageCode!
+    body: String!
+  }
+
+  input UpdateTranslationsReviewInput {
+    id: ID!
+    translations: [ReviewEntityTranslation!]!
+  }
+
+  type ChangeReviewStateResult {
+    id: ID!
+    success: Boolean!
+  }
+
+  extend type Mutation {
+    changeReviewState(input: ChangeReviewStateInput!): ChangeReviewStateResult!
+    changeReviewsState(
+      input: [ChangeReviewStateInput!]!
+    ): [ChangeReviewStateResult!]!
+    updateTranslationsReview(input: UpdateTranslationsReviewInput!): Review!
+  }
+`;

package/dist/plugin-server/extensions/shared.extension.d.ts

@@ -0,0 +1,2 @@
+import { DocumentNode } from "graphql";
+export declare const SharedAPIExtension: DocumentNode;

package/dist/plugin-server/extensions/shared.extension.js

@@ -0,0 +1,87 @@
+import { gql } from "graphql-tag";
+export const SharedAPIExtension = gql `
+  enum ReviewState {
+    PENDING
+    ACCEPTED
+    DECLINED
+  }
+
+  type ReviewTranslation {
+    id: ID!
+    createdAt: DateTime!
+    updatedAt: DateTime!
+    languageCode: String!
+    body: String
+  }
+
+  type ReviewAsset {
+    key: String!
+    url: String!
+  }
+
+  type Review implements Node {
+    id: ID!
+    createdAt: DateTime!
+    updatedAt: DateTime!
+    assets: [ReviewAsset!]!
+    state: ReviewState!
+    response: String
+    responseCreatedAt: DateTime
+    rating: Float!
+    authorName: String!
+    authorLocation: String
+    authorEmailAddress: String!
+    body: String
+    translations: [ReviewTranslation!]!
+    product: Product
+    productVariant: ProductVariant
+    order: Order
+    author: Customer
+    keepAnonymous: Boolean!
+  }
+
+  type ReviewList implements PaginatedList {
+    items: [Review!]!
+    totalItems: Int!
+  }
+
+  input ReviewFilterParameter {
+    id: IDOperators
+    createdAt: DateOperators
+    updatedAt: DateOperators
+    state: StringOperators
+    response: StringOperators
+    responseCreatedAt: DateOperators
+    rating: NumberOperators
+    authorName: StringOperators
+    authorLocation: StringOperators
+    authorEmailAddress: StringOperators
+    body: StringOperators
+    productId: IDOperators
+    orderId: IDOperators
+    customerId: IDOperators
+    _and: [ReviewFilterParameter!]
+    _or: [ReviewFilterParameter!]
+  }
+
+  input ReviewSortParameter {
+    id: SortOrder
+    createdAt: SortOrder
+    updatedAt: SortOrder
+    response: SortOrder
+    responseCreatedAt: SortOrder
+    rating: SortOrder
+    authorName: SortOrder
+    authorLocation: SortOrder
+    authorEmailAddress: SortOrder
+    body: SortOrder
+  }
+
+  input ReviewListOptions {
+    skip: Int
+    take: Int
+    sort: ReviewSortParameter
+    filter: ReviewFilterParameter
+    filterOperator: LogicalOperator
+  }
+`;

package/dist/plugin-server/extensions/shop-api.extension.d.ts

@@ -0,0 +1,2 @@
+import { DocumentNode } from "graphql";
+export declare const ShopAPIExtension: DocumentNode;

package/dist/plugin-server/extensions/shop-api.extension.js

@@ -0,0 +1,60 @@
+import { gql } from "graphql-tag";
+import { SharedAPIExtension } from "./shared.extension.js";
+export const ShopAPIExtension = gql `
+  ${SharedAPIExtension}
+
+  input CreateReviewInput {
+    rating: Float!
+    body: String!
+    authorName: String
+    authorLocation: String
+    authorEmailAddress: String
+    uploadedAssets: [String!]
+    orderId: ID
+    productVariantId: ID
+    keepAnonymous: Boolean
+  }
+
+  input ReviewsStorageOptions {
+    filename: String!
+  }
+
+  type ReviewsStorage {
+    url: String!
+    key: String!
+  }
+
+  extend type Mutation {
+    createReview(input: CreateReviewInput!): Review!
+  }
+
+  type AverageRating {
+    total: Int!
+    count: Int!
+  }
+
+  type AverageRatings {
+    shopAverageRating: AverageRating!
+    productsAverageRating: AverageRating!
+  }
+
+  extend type Query {
+    getAverageRatings: AverageRatings!
+    getReviewsStorage(input: [ReviewsStorageOptions!]!): [ReviewsStorage!]!
+  }
+
+  extend type Product {
+    averageRating: Float!
+    reviews(options: ReviewListOptions): ReviewList!
+  }
+
+  extend type Order {
+    reviewed: Boolean!
+    review: Review
+  }
+
+  extend type Customer {
+    reviews(options: ReviewListOptions): ReviewList!
+    shopReviewCreated: Boolean!
+  }
+`;

package/dist/plugin-server/index.d.ts

@@ -0,0 +1,15 @@
+import type { ReviewsPluginOptions } from "./types.js";
+import { OnApplicationBootstrap } from "@nestjs/common";
+import { ModuleRef } from "@nestjs/core";
+declare class ReviewsPlugin implements OnApplicationBootstrap {
+    private moduleRef;
+    static options: ReviewsPluginOptions;
+    constructor(moduleRef: ModuleRef);
+    static init(options: ReviewsPluginOptions): typeof ReviewsPlugin;
+    onApplicationBootstrap(): Promise<void>;
+    onApplicationShutdown(): Promise<void>;
+    private initTranslationStrategy;
+    private destroyTranslationStrategy;
+}
+export { TranslateReviewStrategy } from "./types.js";
+export { ReviewsPlugin };

package/dist/plugin-server/index.js

@@ -0,0 +1,86 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+import { PluginCommonModule, DeenruvPlugin, Injector } from "@deenruv/core";
+import { AdminAPIExtension } from "./extensions/admin-api.extension.js";
+import { ShopAPIExtension } from "./extensions/shop-api.extension.js";
+import { REVIEWS_PLUGIN_OPTIONS } from "./constants.js";
+import { ReviewEntity } from "./entities/review.entity.js";
+import { ReviewsShopAPIResolver } from "./api/shop-api.resolver.js";
+import { ReviewsAdminAPIResolver } from "./api/admin-api.resolver.js";
+import { ReviewEntityTranslation } from "./entities/review-translation.entity.js";
+import { ReviewsService } from "./services/reviews.service.js";
+import { ReviewStateMachine } from "./state/reviews.state.js";
+import { ModuleRef } from "@nestjs/core";
+import { ReviewAssetResolver } from "./api/review-asset.resolver.js";
+import { ReviewProductResolver } from "./api/review-product.resolver.js";
+import { ReviewOrderResolver } from "./api/review-order.resolver.js";
+import { ReviewCustomerResolver } from "./api/review-customer.resolver.js";
+let ReviewsPlugin = class ReviewsPlugin {
+    constructor(moduleRef) {
+        this.moduleRef = moduleRef;
+    }
+    static init(options) {
+        this.options = options;
+        return this;
+    }
+    async onApplicationBootstrap() {
+        await this.initTranslationStrategy();
+    }
+    async onApplicationShutdown() {
+        await this.destroyTranslationStrategy();
+    }
+    async initTranslationStrategy() {
+        const injector = new Injector(this.moduleRef);
+        const service = injector.get(ReviewsService);
+        if (service.translateStrategy &&
+            typeof service.translateStrategy.init === "function") {
+            await service.translateStrategy.init(injector);
+        }
+    }
+    async destroyTranslationStrategy() {
+        const injector = new Injector(this.moduleRef);
+        const service = injector.get(ReviewsService);
+        if (service.translateStrategy &&
+            typeof service.translateStrategy.destroy === "function") {
+            await service.translateStrategy.destroy();
+        }
+    }
+};
+ReviewsPlugin = __decorate([
+    DeenruvPlugin({
+        compatibility: "0.0.1",
+        imports: [PluginCommonModule],
+        entities: [ReviewEntity, ReviewEntityTranslation],
+        adminApiExtensions: {
+            schema: AdminAPIExtension,
+            resolvers: [ReviewsAdminAPIResolver, ReviewAssetResolver],
+        },
+        shopApiExtensions: {
+            schema: ShopAPIExtension,
+            resolvers: [
+                ReviewsShopAPIResolver,
+                ReviewAssetResolver,
+                ReviewProductResolver,
+                ReviewOrderResolver,
+                ReviewCustomerResolver,
+            ],
+        },
+        providers: [
+            {
+                provide: REVIEWS_PLUGIN_OPTIONS,
+                useFactory: () => ReviewsPlugin.options,
+            },
+            ReviewsService,
+            ReviewStateMachine,
+        ],
+    }),
+    __metadata("design:paramtypes", [ModuleRef])
+], ReviewsPlugin);
+export { ReviewsPlugin };

package/dist/plugin-server/services/reviews.service.d.ts

@@ -0,0 +1,85 @@
+import { Customer, CustomerService, EntityHydrator, EventBus, ID, ListQueryBuilder, OrderService, Product, ProductVariantService, RelationPaths, RequestContext, TransactionalConnection, TranslatableSaver, TranslatorService } from "@deenruv/core";
+import { ReviewStateMachine } from "../state/reviews.state.js";
+import { ReviewEntity } from "../entities/review.entity.js";
+import { ReviewState } from "../constants.js";
+import { CreateReviewInput, ReviewsPluginOptions } from "../types.js";
+import { ModelTypes } from "../zeus/index.js";
+export declare class ReviewsService {
+    private readonly options;
+    private readonly connection;
+    private readonly reviewStateMachine;
+    private readonly productVariantService;
+    private readonly orderService;
+    private readonly translatableSaver;
+    private readonly translatorService;
+    private readonly customerServicer;
+    private readonly listQueryBuilder;
+    private readonly eventBus;
+    private readonly entityHydrator;
+    private readonly logger;
+    private readonly error;
+    private readonly log;
+    translateStrategy: ReviewsPluginOptions["translateStrategy"];
+    canTranslate: boolean;
+    constructor(options: ReviewsPluginOptions, connection: TransactionalConnection, reviewStateMachine: ReviewStateMachine, productVariantService: ProductVariantService, orderService: OrderService, translatableSaver: TranslatableSaver, translatorService: TranslatorService, customerServicer: CustomerService, listQueryBuilder: ListQueryBuilder, eventBus: EventBus, entityHydrator: EntityHydrator);
+    hasShopReviewCreated(ctx: RequestContext, customer: Customer): Promise<boolean>;
+    getAverageRatings(ctx: RequestContext): Promise<{
+        shopAverageRating: {
+            total: number;
+            count: number;
+        };
+        productsAverageRating: {
+            total: number;
+            count: number;
+        };
+    }>;
+    getOrderReview(ctx: RequestContext, order: {
+        id: ID;
+    }, relations?: RelationPaths<ReviewEntity>): Promise<import("@deenruv/core").Translated<ReviewEntity> | null>;
+    isOrderReviewed(ctx: RequestContext, order: {
+        id: ID;
+    }): Promise<boolean>;
+    getAverageRating(ctx: RequestContext, product: Product): Promise<number>;
+    translateReviews(ctx: RequestContext, input: ModelTypes["TranslateReviewsInput"]): Promise<{
+        languageCode: import("../zeus/index.js").LanguageCode;
+        body: string;
+        summary: string;
+    }[]>;
+    updateTranslationsReview(ctx: RequestContext, input: ModelTypes["UpdateTranslationsReviewInput"]): Promise<ReviewEntity | undefined>;
+    getReviewInfoForProduct(ctx: RequestContext, productId: ID): Promise<{
+        averageRating: number;
+        totalReviews: number;
+        totalRatings: number;
+    }>;
+    getReviewsConfig(ctx: RequestContext): Promise<{
+        canTranslate: boolean;
+        reviewsLanguages: string[];
+    }>;
+    getReview(ctx: RequestContext, id: ID, relations: RelationPaths<ReviewEntity>): Promise<import("@deenruv/core").Translated<ReviewEntity>>;
+    changeReviewState(ctx: RequestContext, input: Array<{
+        id: ID;
+        state: ReviewState;
+        message?: string;
+    }>): Promise<{
+        id: ID;
+        success: boolean;
+    } | {
+        id: ID;
+        success: boolean;
+    }[]>;
+    listReviews(ctx: RequestContext, _options: ModelTypes["ReviewListOptions"], relations?: RelationPaths<ReviewEntity>, showAll?: boolean): Promise<{
+        items: import("@deenruv/core").Translated<ReviewEntity>[];
+        totalItems: number;
+    }>;
+    createReview(ctx: RequestContext, input: CreateReviewInput): Promise<ReviewEntity>;
+    getReviewsStorage(ctx: RequestContext, input: Array<{
+        filename: string;
+    }>): Promise<{
+        key: string;
+        url: string;
+    }[]>;
+    getReviewAssets(ctx: RequestContext, review: ReviewEntity): Promise<{
+        key: string;
+        url: string;
+    }[]>;
+}