@deenruv/core 1.0.0

package/dist/service/services/session.service.d.ts

@@ -0,0 +1,105 @@
+import { ID } from "@deenruv/common/lib/shared-types";
+import { EntitySubscriberInterface, InsertEvent, RemoveEvent, UpdateEvent } from "typeorm";
+import { RequestContext } from "../../api/common/request-context";
+import { ConfigService } from "../../config/config.service";
+import { CachedSession } from "../../config/session-cache/session-cache-strategy";
+import { TransactionalConnection } from "../../connection/transactional-connection";
+import { Channel } from "../../entity/channel/channel.entity";
+import { Order } from "../../entity/order/order.entity";
+import { AnonymousSession } from "../../entity/session/anonymous-session.entity";
+import { AuthenticatedSession } from "../../entity/session/authenticated-session.entity";
+import { User } from "../../entity/user/user.entity";
+import { OrderService } from "./order.service";
+/**
+ * @description
+ * Contains methods relating to {@link Session} entities.
+ *
+ * @docsCategory services
+ */
+export declare class SessionService implements EntitySubscriberInterface {
+    private connection;
+    private configService;
+    private orderService;
+    private sessionCacheStrategy;
+    private readonly sessionDurationInMs;
+    private readonly sessionCacheTimeoutMs;
+    constructor(connection: TransactionalConnection, configService: ConfigService, orderService: OrderService);
+    /** @internal */
+    afterInsert(event: InsertEvent<any>): Promise<any>;
+    /** @internal */
+    afterRemove(event: RemoveEvent<any>): Promise<any>;
+    /** @internal */
+    afterUpdate(event: UpdateEvent<any>): Promise<any>;
+    private clearSessionCacheOnDataChange;
+    /**
+     * @description
+     * Creates a new {@link AuthenticatedSession}. To be used after successful authentication.
+     */
+    createNewAuthenticatedSession(ctx: RequestContext, user: User, authenticationStrategyName: string): Promise<AuthenticatedSession>;
+    /**
+     * @description
+     * Create an {@link AnonymousSession} and caches it using the configured {@link SessionCacheStrategy},
+     * and returns the cached session object.
+     */
+    createAnonymousSession(): Promise<CachedSession>;
+    /**
+     * @description
+     * Returns the cached session object matching the given session token.
+     */
+    getSessionFromToken(sessionToken: string): Promise<CachedSession | undefined>;
+    /**
+     * @description
+     * Serializes a {@link Session} instance into a simplified plain object suitable for caching.
+     */
+    serializeSession(session: AuthenticatedSession | AnonymousSession): CachedSession;
+    /**
+     * If the session cache is taking longer than say 50ms then something is wrong - it is supposed to
+     * be very fast after all! So we will return undefined and let the request continue without a cached session.
+     */
+    private withTimeout;
+    /**
+     * Looks for a valid session with the given token and returns one if found.
+     */
+    private findSessionByToken;
+    /**
+     * @description
+     * Sets the `activeOrder` on the given cached session object and updates the cache.
+     */
+    setActiveOrder(ctx: RequestContext, serializedSession: CachedSession, order: Order): Promise<CachedSession>;
+    /**
+     * @description
+     * Clears the `activeOrder` on the given cached session object and updates the cache.
+     */
+    unsetActiveOrder(ctx: RequestContext, serializedSession: CachedSession): Promise<CachedSession>;
+    /**
+     * @description
+     * Sets the `activeChannel` on the given cached session object and updates the cache.
+     */
+    setActiveChannel(serializedSession: CachedSession, channel: Channel): Promise<CachedSession>;
+    /**
+     * @description
+     * Deletes all existing sessions for the given user.
+     */
+    deleteSessionsByUser(ctx: RequestContext, user: User): Promise<void>;
+    /**
+     * @description
+     * Deletes all existing sessions with the given activeOrder.
+     */
+    deleteSessionsByActiveOrderId(ctx: RequestContext, activeOrderId: ID): Promise<void>;
+    /**
+     * If we are over half way to the current session's expiry date, then we update it.
+     *
+     * This ensures that the session will not expire when in active use, but prevents us from
+     * needing to run an update query on *every* request.
+     */
+    private updateSessionExpiry;
+    /**
+     * Returns a future expiry date according timeToExpireInMs in the future.
+     */
+    private getExpiryDate;
+    /**
+     * Generates a random session token.
+     */
+    private generateSessionToken;
+    private isAuthenticatedSession;
+}

package/dist/service/services/session.service.js

@@ -0,0 +1,328 @@
+"use strict";
+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);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SessionService = void 0;
+const common_1 = require("@nestjs/common");
+const crypto_1 = __importDefault(require("crypto"));
+const ms_1 = __importDefault(require("ms"));
+const config_service_1 = require("../../config/config.service");
+const transactional_connection_1 = require("../../connection/transactional-connection");
+const channel_entity_1 = require("../../entity/channel/channel.entity");
+const role_entity_1 = require("../../entity/role/role.entity");
+const anonymous_session_entity_1 = require("../../entity/session/anonymous-session.entity");
+const authenticated_session_entity_1 = require("../../entity/session/authenticated-session.entity");
+const session_entity_1 = require("../../entity/session/session.entity");
+const get_user_channels_permissions_1 = require("../helpers/utils/get-user-channels-permissions");
+const order_service_1 = require("./order.service");
+/**
+ * @description
+ * Contains methods relating to {@link Session} entities.
+ *
+ * @docsCategory services
+ */
+let SessionService = class SessionService {
+    constructor(connection, configService, orderService) {
+        this.connection = connection;
+        this.configService = configService;
+        this.orderService = orderService;
+        this.sessionCacheTimeoutMs = 50;
+        this.sessionCacheStrategy =
+            this.configService.authOptions.sessionCacheStrategy;
+        this.sessionDurationInMs = (0, ms_1.default)(this.configService.authOptions.sessionDuration);
+        // This allows us to register this class as a TypeORM Subscriber while also allowing
+        // the injection on dependencies. See https://docs.nestjs.com/techniques/database#subscribers
+        this.connection.rawConnection.subscribers.push(this);
+    }
+    /** @internal */
+    async afterInsert(event) {
+        await this.clearSessionCacheOnDataChange(event);
+    }
+    /** @internal */
+    async afterRemove(event) {
+        await this.clearSessionCacheOnDataChange(event);
+    }
+    /** @internal */
+    async afterUpdate(event) {
+        await this.clearSessionCacheOnDataChange(event);
+    }
+    async clearSessionCacheOnDataChange(event) {
+        if (event.entity) {
+            // If a Channel or Role changes, potentially all the cached permissions in the
+            // session cache will be wrong, so we just clear the entire cache. It should however
+            // be a very rare occurrence in normal operation, once initial setup is complete.
+            if (event.entity instanceof channel_entity_1.Channel || event.entity instanceof role_entity_1.Role) {
+                await this.withTimeout(this.sessionCacheStrategy.clear());
+            }
+        }
+    }
+    /**
+     * @description
+     * Creates a new {@link AuthenticatedSession}. To be used after successful authentication.
+     */
+    async createNewAuthenticatedSession(ctx, user, authenticationStrategyName) {
+        const token = await this.generateSessionToken();
+        const guestOrder = ctx.session && ctx.session.activeOrderId
+            ? await this.orderService.findOne(ctx, ctx.session.activeOrderId)
+            : undefined;
+        const existingOrder = await this.orderService.getActiveOrderForUser(ctx, user.id);
+        const activeOrder = await this.orderService.mergeOrders(ctx, user, guestOrder, existingOrder);
+        const authenticatedSession = await this.connection
+            .getRepository(ctx, authenticated_session_entity_1.AuthenticatedSession)
+            .save(new authenticated_session_entity_1.AuthenticatedSession({
+            token,
+            user,
+            activeOrder,
+            authenticationStrategy: authenticationStrategyName,
+            expires: this.getExpiryDate(this.sessionDurationInMs),
+            invalidated: false,
+        }));
+        await this.withTimeout(this.sessionCacheStrategy.set(this.serializeSession(authenticatedSession)));
+        return authenticatedSession;
+    }
+    /**
+     * @description
+     * Create an {@link AnonymousSession} and caches it using the configured {@link SessionCacheStrategy},
+     * and returns the cached session object.
+     */
+    async createAnonymousSession() {
+        const token = await this.generateSessionToken();
+        const session = new anonymous_session_entity_1.AnonymousSession({
+            token,
+            expires: this.getExpiryDate(this.sessionDurationInMs),
+            invalidated: false,
+        });
+        // save the new session
+        const newSession = await this.connection.rawConnection
+            .getRepository(anonymous_session_entity_1.AnonymousSession)
+            .save(session);
+        const serializedSession = this.serializeSession(newSession);
+        await this.withTimeout(this.sessionCacheStrategy.set(serializedSession));
+        return serializedSession;
+    }
+    /**
+     * @description
+     * Returns the cached session object matching the given session token.
+     */
+    async getSessionFromToken(sessionToken) {
+        let serializedSession = await this.withTimeout(this.sessionCacheStrategy.get(sessionToken));
+        const stale = !!(serializedSession &&
+            serializedSession.cacheExpiry < new Date().getTime() / 1000);
+        const expired = !!(serializedSession && serializedSession.expires < new Date());
+        if (!serializedSession || stale || expired) {
+            const session = await this.findSessionByToken(sessionToken);
+            if (session) {
+                serializedSession = this.serializeSession(session);
+                await this.withTimeout(this.sessionCacheStrategy.set(serializedSession));
+                return serializedSession;
+            }
+            else {
+                return;
+            }
+        }
+        return serializedSession;
+    }
+    /**
+     * @description
+     * Serializes a {@link Session} instance into a simplified plain object suitable for caching.
+     */
+    serializeSession(session) {
+        const expiry = Math.floor(new Date().getTime() / 1000) +
+            this.configService.authOptions.sessionCacheTTL;
+        const serializedSession = {
+            cacheExpiry: expiry,
+            id: session.id,
+            token: session.token,
+            expires: session.expires,
+            activeOrderId: session.activeOrderId,
+            activeChannelId: session.activeChannelId,
+        };
+        if (this.isAuthenticatedSession(session)) {
+            serializedSession.authenticationStrategy = session.authenticationStrategy;
+            const { user } = session;
+            serializedSession.user = {
+                id: user.id,
+                identifier: user.identifier,
+                verified: user.verified,
+                channelPermissions: (0, get_user_channels_permissions_1.getUserChannelsPermissions)(user),
+            };
+        }
+        return serializedSession;
+    }
+    /**
+     * If the session cache is taking longer than say 50ms then something is wrong - it is supposed to
+     * be very fast after all! So we will return undefined and let the request continue without a cached session.
+     */
+    withTimeout(maybeSlow) {
+        return Promise.race([
+            new Promise((resolve) => setTimeout(() => resolve(undefined), this.sessionCacheTimeoutMs)),
+            maybeSlow,
+        ]);
+    }
+    /**
+     * Looks for a valid session with the given token and returns one if found.
+     */
+    async findSessionByToken(token) {
+        const session = await this.connection.rawConnection
+            .getRepository(session_entity_1.Session)
+            .createQueryBuilder("session")
+            .leftJoinAndSelect("session.user", "user")
+            .leftJoinAndSelect("user.roles", "roles")
+            .leftJoinAndSelect("roles.channels", "channels")
+            .where("session.token = :token", { token })
+            .andWhere("session.invalidated = false")
+            .getOne();
+        if (session && session.expires > new Date()) {
+            await this.updateSessionExpiry(session);
+            return session;
+        }
+    }
+    /**
+     * @description
+     * Sets the `activeOrder` on the given cached session object and updates the cache.
+     */
+    async setActiveOrder(ctx, serializedSession, order) {
+        const session = await this.connection.getRepository(ctx, session_entity_1.Session).findOne({
+            where: { id: serializedSession.id },
+            relations: ["user", "user.roles", "user.roles.channels"],
+        });
+        if (session) {
+            session.activeOrder = order;
+            await this.connection
+                .getRepository(ctx, session_entity_1.Session)
+                .save(session, { reload: false });
+            const updatedSerializedSession = this.serializeSession(session);
+            await this.withTimeout(this.sessionCacheStrategy.set(updatedSerializedSession));
+            return updatedSerializedSession;
+        }
+        return serializedSession;
+    }
+    /**
+     * @description
+     * Clears the `activeOrder` on the given cached session object and updates the cache.
+     */
+    async unsetActiveOrder(ctx, serializedSession) {
+        if (serializedSession.activeOrderId) {
+            const session = await this.connection
+                .getRepository(ctx, session_entity_1.Session)
+                .findOne({
+                where: { id: serializedSession.id },
+                relations: ["user", "user.roles", "user.roles.channels"],
+            });
+            if (session) {
+                session.activeOrder = null;
+                await this.connection.getRepository(ctx, session_entity_1.Session).save(session);
+                const updatedSerializedSession = this.serializeSession(session);
+                await this.configService.authOptions.sessionCacheStrategy.set(updatedSerializedSession);
+                return updatedSerializedSession;
+            }
+        }
+        return serializedSession;
+    }
+    /**
+     * @description
+     * Sets the `activeChannel` on the given cached session object and updates the cache.
+     */
+    async setActiveChannel(serializedSession, channel) {
+        const session = await this.connection.rawConnection
+            .getRepository(session_entity_1.Session)
+            .findOne({
+            where: { id: serializedSession.id },
+            relations: ["user", "user.roles", "user.roles.channels"],
+        });
+        if (session) {
+            session.activeChannel = channel;
+            await this.connection.rawConnection
+                .getRepository(session_entity_1.Session)
+                .save(session, { reload: false });
+            const updatedSerializedSession = this.serializeSession(session);
+            await this.withTimeout(this.sessionCacheStrategy.set(updatedSerializedSession));
+            return updatedSerializedSession;
+        }
+        return serializedSession;
+    }
+    /**
+     * @description
+     * Deletes all existing sessions for the given user.
+     */
+    async deleteSessionsByUser(ctx, user) {
+        const userSessions = await this.connection
+            .getRepository(ctx, authenticated_session_entity_1.AuthenticatedSession)
+            .find({ where: { user: { id: user.id } } });
+        await this.connection
+            .getRepository(ctx, authenticated_session_entity_1.AuthenticatedSession)
+            .remove(userSessions);
+        for (const session of userSessions) {
+            await this.withTimeout(this.sessionCacheStrategy.delete(session.token));
+        }
+    }
+    /**
+     * @description
+     * Deletes all existing sessions with the given activeOrder.
+     */
+    async deleteSessionsByActiveOrderId(ctx, activeOrderId) {
+        const sessions = await this.connection
+            .getRepository(ctx, session_entity_1.Session)
+            .find({ where: { activeOrderId } });
+        await this.connection.getRepository(ctx, session_entity_1.Session).remove(sessions);
+        for (const session of sessions) {
+            await this.withTimeout(this.sessionCacheStrategy.delete(session.token));
+        }
+    }
+    /**
+     * If we are over half way to the current session's expiry date, then we update it.
+     *
+     * This ensures that the session will not expire when in active use, but prevents us from
+     * needing to run an update query on *every* request.
+     */
+    async updateSessionExpiry(session) {
+        const now = new Date().getTime();
+        if (session.expires.getTime() - now < this.sessionDurationInMs / 2) {
+            const newExpiryDate = this.getExpiryDate(this.sessionDurationInMs);
+            session.expires = newExpiryDate;
+            await this.connection.rawConnection
+                .getRepository(session_entity_1.Session)
+                .update({ id: session.id }, { expires: newExpiryDate });
+        }
+    }
+    /**
+     * Returns a future expiry date according timeToExpireInMs in the future.
+     */
+    getExpiryDate(timeToExpireInMs) {
+        return new Date(Date.now() + timeToExpireInMs);
+    }
+    /**
+     * Generates a random session token.
+     */
+    generateSessionToken() {
+        return new Promise((resolve, reject) => {
+            crypto_1.default.randomBytes(32, (err, buf) => {
+                if (err) {
+                    reject(err);
+                }
+                resolve(buf.toString("hex"));
+            });
+        });
+    }
+    isAuthenticatedSession(session) {
+        return session.hasOwnProperty("user");
+    }
+};
+exports.SessionService = SessionService;
+exports.SessionService = SessionService = __decorate([
+    (0, common_1.Injectable)(),
+    __metadata("design:paramtypes", [transactional_connection_1.TransactionalConnection,
+        config_service_1.ConfigService,
+        order_service_1.OrderService])
+], SessionService);
+//# sourceMappingURL=session.service.js.map

package/dist/service/services/session.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"session.service.js","sourceRoot":"","sources":["../../../src/service/services/session.service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,2CAA4C;AAE5C,oDAA4B;AAC5B,4CAAoB;AASpB,gEAA4D;AAK5D,wFAAoF;AACpF,wEAA8D;AAE9D,+DAAqD;AACrD,4FAAiF;AACjF,oGAAyF;AACzF,wEAA8D;AAE9D,kGAA4F;AAE5F,mDAA+C;AAE/C;;;;;GAKG;AAEI,IAAM,cAAc,GAApB,MAAM,cAAc;IAKzB,YACU,UAAmC,EACnC,aAA4B,EAC5B,YAA0B;QAF1B,eAAU,GAAV,UAAU,CAAyB;QACnC,kBAAa,GAAb,aAAa,CAAe;QAC5B,iBAAY,GAAZ,YAAY,CAAc;QALnB,0BAAqB,GAAG,EAAE,CAAC;QAO1C,IAAI,CAAC,oBAAoB;YACvB,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,oBAAoB,CAAC;QACtD,IAAI,CAAC,mBAAmB,GAAG,IAAA,YAAE,EAC3B,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,eAAyB,CACzD,CAAC;QACF,oFAAoF;QACpF,6FAA6F;QAC7F,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACvD,CAAC;IAED,gBAAgB;IAChB,KAAK,CAAC,WAAW,CAAC,KAAuB;QACvC,MAAM,IAAI,CAAC,6BAA6B,CAAC,KAAK,CAAC,CAAC;IAClD,CAAC;IAED,gBAAgB;IAChB,KAAK,CAAC,WAAW,CAAC,KAAuB;QACvC,MAAM,IAAI,CAAC,6BAA6B,CAAC,KAAK,CAAC,CAAC;IAClD,CAAC;IAED,gBAAgB;IAChB,KAAK,CAAC,WAAW,CAAC,KAAuB;QACvC,MAAM,IAAI,CAAC,6BAA6B,CAAC,KAAK,CAAC,CAAC;IAClD,CAAC;IAEO,KAAK,CAAC,6BAA6B,CACzC,KAA6D;QAE7D,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;YACjB,8EAA8E;YAC9E,oFAAoF;YACpF,iFAAiF;YACjF,IAAI,KAAK,CAAC,MAAM,YAAY,wBAAO,IAAI,KAAK,CAAC,MAAM,YAAY,kBAAI,EAAE,CAAC;gBACpE,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,oBAAoB,CAAC,KAAK,EAAE,CAAC,CAAC;YAC5D,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,6BAA6B,CACjC,GAAmB,EACnB,IAAU,EACV,0BAAkC;QAElC,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAChD,MAAM,UAAU,GACd,GAAG,CAAC,OAAO,IAAI,GAAG,CAAC,OAAO,CAAC,aAAa;YACtC,CAAC,CAAC,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,OAAO,CAAC,aAAa,CAAC;YACjE,CAAC,CAAC,SAAS,CAAC;QAChB,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,qBAAqB,CACjE,GAAG,EACH,IAAI,CAAC,EAAE,CACR,CAAC;QACF,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,WAAW,CACrD,GAAG,EACH,IAAI,EACJ,UAAU,EACV,aAAa,CACd,CAAC;QACF,MAAM,oBAAoB,GAAG,MAAM,IAAI,CAAC,UAAU;aAC/C,aAAa,CAAC,GAAG,EAAE,mDAAoB,CAAC;aACxC,IAAI,CACH,IAAI,mDAAoB,CAAC;YACvB,KAAK;YACL,IAAI;YACJ,WAAW;YACX,sBAAsB,EAAE,0BAA0B;YAClD,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,mBAAmB,CAAC;YACrD,WAAW,EAAE,KAAK;SACnB,CAAC,CACH,CAAC;QACJ,MAAM,IAAI,CAAC,WAAW,CACpB,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAC3B,IAAI,CAAC,gBAAgB,CAAC,oBAAoB,CAAC,CAC5C,CACF,CAAC;QACF,OAAO,oBAAoB,CAAC;IAC9B,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,sBAAsB;QAC1B,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAChD,MAAM,OAAO,GAAG,IAAI,2CAAgB,CAAC;YACnC,KAAK;YACL,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,mBAAmB,CAAC;YACrD,WAAW,EAAE,KAAK;SACnB,CAAC,CAAC;QACH,uBAAuB;QACvB,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,aAAa;aACnD,aAAa,CAAC,2CAAgB,CAAC;aAC/B,IAAI,CAAC,OAAO,CAAC,CAAC;QACjB,MAAM,iBAAiB,GAAG,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;QAC5D,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC,CAAC;QACzE,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,mBAAmB,CACvB,YAAoB;QAEpB,IAAI,iBAAiB,GAAG,MAAM,IAAI,CAAC,WAAW,CAC5C,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,YAAY,CAAC,CAC5C,CAAC;QACF,MAAM,KAAK,GAAG,CAAC,CAAC,CACd,iBAAiB;YACjB,iBAAiB,CAAC,WAAW,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,IAAI,CAC5D,CAAC;QACF,MAAM,OAAO,GAAG,CAAC,CAAC,CAChB,iBAAiB,IAAI,iBAAiB,CAAC,OAAO,GAAG,IAAI,IAAI,EAAE,CAC5D,CAAC;QACF,IAAI,CAAC,iBAAiB,IAAI,KAAK,IAAI,OAAO,EAAE,CAAC;YAC3C,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,YAAY,CAAC,CAAC;YAC5D,IAAI,OAAO,EAAE,CAAC;gBACZ,iBAAiB,GAAG,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;gBACnD,MAAM,IAAI,CAAC,WAAW,CACpB,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,iBAAiB,CAAC,CACjD,CAAC;gBACF,OAAO,iBAAiB,CAAC;YAC3B,CAAC;iBAAM,CAAC;gBACN,OAAO;YACT,CAAC;QACH,CAAC;QACD,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IAED;;;OAGG;IACH,gBAAgB,CACd,OAAgD;QAEhD,MAAM,MAAM,GACV,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC;YACvC,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,eAAe,CAAC;QACjD,MAAM,iBAAiB,GAAkB;YACvC,WAAW,EAAE,MAAM;YACnB,EAAE,EAAE,OAAO,CAAC,EAAE;YACd,KAAK,EAAE,OAAO,CAAC,KAAK;YACpB,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,aAAa,EAAE,OAAO,CAAC,aAAa;YACpC,eAAe,EAAE,OAAO,CAAC,eAAe;SACzC,CAAC;QACF,IAAI,IAAI,CAAC,sBAAsB,CAAC,OAAO,CAAC,EAAE,CAAC;YACzC,iBAAiB,CAAC,sBAAsB,GAAG,OAAO,CAAC,sBAAsB,CAAC;YAC1E,MAAM,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;YACzB,iBAAiB,CAAC,IAAI,GAAG;gBACvB,EAAE,EAAE,IAAI,CAAC,EAAE;gBACX,UAAU,EAAE,IAAI,CAAC,UAAU;gBAC3B,QAAQ,EAAE,IAAI,CAAC,QAAQ;gBACvB,kBAAkB,EAAE,IAAA,0DAA0B,EAAC,IAAI,CAAC;aACrD,CAAC;QACJ,CAAC;QACD,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IAED;;;OAGG;IACK,WAAW,CAAI,SAAyB;QAC9C,OAAO,OAAO,CAAC,IAAI,CAAC;YAClB,IAAI,OAAO,CAAY,CAAC,OAAO,EAAE,EAAE,CACjC,UAAU,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,IAAI,CAAC,qBAAqB,CAAC,CACjE;YACD,SAAS;SACV,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,kBAAkB,CAC9B,KAAa;QAEb,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,aAAa;aAChD,aAAa,CAAC,wBAAO,CAAC;aACtB,kBAAkB,CAAC,SAAS,CAAC;aAC7B,iBAAiB,CAAC,cAAc,EAAE,MAAM,CAAC;aACzC,iBAAiB,CAAC,YAAY,EAAE,OAAO,CAAC;aACxC,iBAAiB,CAAC,gBAAgB,EAAE,UAAU,CAAC;aAC/C,KAAK,CAAC,wBAAwB,EAAE,EAAE,KAAK,EAAE,CAAC;aAC1C,QAAQ,CAAC,6BAA6B,CAAC;aACvC,MAAM,EAAE,CAAC;QAEZ,IAAI,OAAO,IAAI,OAAO,CAAC,OAAO,GAAG,IAAI,IAAI,EAAE,EAAE,CAAC;YAC5C,MAAM,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;YACxC,OAAO,OAAO,CAAC;QACjB,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,cAAc,CAClB,GAAmB,EACnB,iBAAgC,EAChC,KAAY;QAEZ,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,GAAG,EAAE,wBAAO,CAAC,CAAC,OAAO,CAAC;YACxE,KAAK,EAAE,EAAE,EAAE,EAAE,iBAAiB,CAAC,EAAE,EAAE;YACnC,SAAS,EAAE,CAAC,MAAM,EAAE,YAAY,EAAE,qBAAqB,CAAC;SACzD,CAAC,CAAC;QACH,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,CAAC,WAAW,GAAG,KAAK,CAAC;YAC5B,MAAM,IAAI,CAAC,UAAU;iBAClB,aAAa,CAAC,GAAG,EAAE,wBAAO,CAAC;iBAC3B,IAAI,CAAC,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;YACpC,MAAM,wBAAwB,GAAG,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;YAChE,MAAM,IAAI,CAAC,WAAW,CACpB,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,wBAAwB,CAAC,CACxD,CAAC;YACF,OAAO,wBAAwB,CAAC;QAClC,CAAC;QACD,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,gBAAgB,CACpB,GAAmB,EACnB,iBAAgC;QAEhC,IAAI,iBAAiB,CAAC,aAAa,EAAE,CAAC;YACpC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU;iBAClC,aAAa,CAAC,GAAG,EAAE,wBAAO,CAAC;iBAC3B,OAAO,CAAC;gBACP,KAAK,EAAE,EAAE,EAAE,EAAE,iBAAiB,CAAC,EAAE,EAAE;gBACnC,SAAS,EAAE,CAAC,MAAM,EAAE,YAAY,EAAE,qBAAqB,CAAC;aACzD,CAAC,CAAC;YACL,IAAI,OAAO,EAAE,CAAC;gBACZ,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;gBAC3B,MAAM,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,GAAG,EAAE,wBAAO,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBAChE,MAAM,wBAAwB,GAAG,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;gBAChE,MAAM,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,oBAAoB,CAAC,GAAG,CAC3D,wBAAwB,CACzB,CAAC;gBACF,OAAO,wBAAwB,CAAC;YAClC,CAAC;QACH,CAAC;QACD,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,gBAAgB,CACpB,iBAAgC,EAChC,OAAgB;QAEhB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,aAAa;aAChD,aAAa,CAAC,wBAAO,CAAC;aACtB,OAAO,CAAC;YACP,KAAK,EAAE,EAAE,EAAE,EAAE,iBAAiB,CAAC,EAAE,EAAE;YACnC,SAAS,EAAE,CAAC,MAAM,EAAE,YAAY,EAAE,qBAAqB,CAAC;SACzD,CAAC,CAAC;QACL,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,CAAC,aAAa,GAAG,OAAO,CAAC;YAChC,MAAM,IAAI,CAAC,UAAU,CAAC,aAAa;iBAChC,aAAa,CAAC,wBAAO,CAAC;iBACtB,IAAI,CAAC,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;YACpC,MAAM,wBAAwB,GAAG,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;YAChE,MAAM,IAAI,CAAC,WAAW,CACpB,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,wBAAwB,CAAC,CACxD,CAAC;YACF,OAAO,wBAAwB,CAAC;QAClC,CAAC;QACD,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,oBAAoB,CAAC,GAAmB,EAAE,IAAU;QACxD,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,UAAU;aACvC,aAAa,CAAC,GAAG,EAAE,mDAAoB,CAAC;aACxC,IAAI,CAAC,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;QAC9C,MAAM,IAAI,CAAC,UAAU;aAClB,aAAa,CAAC,GAAG,EAAE,mDAAoB,CAAC;aACxC,MAAM,CAAC,YAAY,CAAC,CAAC;QACxB,KAAK,MAAM,OAAO,IAAI,YAAY,EAAE,CAAC;YACnC,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;QAC1E,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,6BAA6B,CACjC,GAAmB,EACnB,aAAiB;QAEjB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU;aACnC,aAAa,CAAC,GAAG,EAAE,wBAAO,CAAC;aAC3B,IAAI,CAAC,EAAE,KAAK,EAAE,EAAE,aAAa,EAAE,EAAE,CAAC,CAAC;QACtC,MAAM,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,GAAG,EAAE,wBAAO,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACnE,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;YAC/B,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;QAC1E,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACK,KAAK,CAAC,mBAAmB,CAAC,OAAgB;QAChD,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;QACjC,IAAI,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,GAAG,GAAG,IAAI,CAAC,mBAAmB,GAAG,CAAC,EAAE,CAAC;YACnE,MAAM,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;YACnE,OAAO,CAAC,OAAO,GAAG,aAAa,CAAC;YAChC,MAAM,IAAI,CAAC,UAAU,CAAC,aAAa;iBAChC,aAAa,CAAC,wBAAO,CAAC;iBACtB,MAAM,CAAC,EAAE,EAAE,EAAE,OAAO,CAAC,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC,CAAC;QAC5D,CAAC;IACH,CAAC;IAED;;OAEG;IACK,aAAa,CAAC,gBAAwB;QAC5C,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,gBAAgB,CAAC,CAAC;IACjD,CAAC;IAED;;OAEG;IACK,oBAAoB;QAC1B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,gBAAM,CAAC,WAAW,CAAC,EAAE,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;gBAClC,IAAI,GAAG,EAAE,CAAC;oBACR,MAAM,CAAC,GAAG,CAAC,CAAC;gBACd,CAAC;gBACD,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;YAC/B,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,sBAAsB,CAC5B,OAAgB;QAEhB,OAAO,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;IACxC,CAAC;CACF,CAAA;AAlXY,wCAAc;yBAAd,cAAc;IAD1B,IAAA,mBAAU,GAAE;qCAOW,kDAAuB;QACpB,8BAAa;QACd,4BAAY;GARzB,cAAc,CAkX1B"}

package/dist/service/services/shipping-method.service.d.ts

@@ -0,0 +1,54 @@
+import { AssignShippingMethodsToChannelInput, ConfigurableOperationDefinition, CreateShippingMethodInput, DeletionResponse, RemoveShippingMethodsFromChannelInput, UpdateShippingMethodInput } from "@deenruv/common/lib/generated-types";
+import { ID, PaginatedList } from "@deenruv/common/lib/shared-types";
+import { RequestContext } from "../../api/common/request-context";
+import { RelationPaths } from "../../api/decorators/relations.decorator";
+import { ListQueryOptions } from "../../common/types/common-types";
+import { Translated } from "../../common/types/locale-types";
+import { ConfigService } from "../../config/config.service";
+import { TransactionalConnection } from "../../connection/transactional-connection";
+import { ShippingMethod } from "../../entity/shipping-method/shipping-method.entity";
+import { EventBus } from "../../event-bus";
+import { ConfigArgService } from "../helpers/config-arg/config-arg.service";
+import { CustomFieldRelationService } from "../helpers/custom-field-relation/custom-field-relation.service";
+import { ListQueryBuilder } from "../helpers/list-query-builder/list-query-builder";
+import { TranslatableSaver } from "../helpers/translatable-saver/translatable-saver";
+import { TranslatorService } from "../helpers/translator/translator.service";
+import { ChannelService } from "./channel.service";
+import { RoleService } from "./role.service";
+/**
+ * @description
+ * Contains methods relating to {@link ShippingMethod} entities.
+ *
+ * @docsCategory services
+ */
+export declare class ShippingMethodService {
+    private connection;
+    private configService;
+    private roleService;
+    private listQueryBuilder;
+    private channelService;
+    private configArgService;
+    private translatableSaver;
+    private customFieldRelationService;
+    private eventBus;
+    private translator;
+    constructor(connection: TransactionalConnection, configService: ConfigService, roleService: RoleService, listQueryBuilder: ListQueryBuilder, channelService: ChannelService, configArgService: ConfigArgService, translatableSaver: TranslatableSaver, customFieldRelationService: CustomFieldRelationService, eventBus: EventBus, translator: TranslatorService);
+    /** @internal */
+    initShippingMethods(): Promise<void>;
+    findAll(ctx: RequestContext, options?: ListQueryOptions<ShippingMethod>, relations?: RelationPaths<ShippingMethod>): Promise<PaginatedList<Translated<ShippingMethod>>>;
+    findOne(ctx: RequestContext, shippingMethodId: ID, includeDeleted?: boolean, relations?: RelationPaths<ShippingMethod>): Promise<Translated<ShippingMethod> | undefined>;
+    create(ctx: RequestContext, input: CreateShippingMethodInput): Promise<Translated<ShippingMethod>>;
+    update(ctx: RequestContext, input: UpdateShippingMethodInput): Promise<Translated<ShippingMethod>>;
+    softDelete(ctx: RequestContext, id: ID): Promise<DeletionResponse>;
+    assignShippingMethodsToChannel(ctx: RequestContext, input: AssignShippingMethodsToChannelInput): Promise<Array<Translated<ShippingMethod>>>;
+    removeShippingMethodsFromChannel(ctx: RequestContext, input: RemoveShippingMethodsFromChannelInput): Promise<Array<Translated<ShippingMethod>>>;
+    getShippingEligibilityCheckers(ctx: RequestContext): ConfigurableOperationDefinition[];
+    getShippingCalculators(ctx: RequestContext): ConfigurableOperationDefinition[];
+    getFulfillmentHandlers(ctx: RequestContext): ConfigurableOperationDefinition[];
+    getActiveShippingMethods(ctx: RequestContext): Promise<ShippingMethod[]>;
+    /**
+     * Ensures that all ShippingMethods have a valid fulfillmentHandlerCode
+     */
+    private verifyShippingMethods;
+    private ensureValidFulfillmentHandlerCode;
+}