@deenruv/admin-ui-plugin 1.0.0

package/lib/index.d.ts

@@ -0,0 +1 @@
+export * from "./src/plugin";

package/lib/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./src/plugin"), exports);
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+CAA6B"}

package/lib/src/api/metrics.resolver.d.ts

@@ -0,0 +1,8 @@
+import { RequestContext } from "@deenruv/core";
+import { MetricsService } from "../service/metrics.service";
+import { MetricSummary, MetricSummaryInput } from "../types";
+export declare class MetricsResolver {
+    private service;
+    constructor(service: MetricsService);
+    metricSummary(ctx: RequestContext, input: MetricSummaryInput): Promise<MetricSummary[]>;
+}

package/lib/src/api/metrics.resolver.js

@@ -0,0 +1,41 @@
+"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 __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MetricsResolver = void 0;
+const graphql_1 = require("@nestjs/graphql");
+const core_1 = require("@deenruv/core");
+const metrics_service_1 = require("../service/metrics.service");
+let MetricsResolver = class MetricsResolver {
+    constructor(service) {
+        this.service = service;
+    }
+    async metricSummary(ctx, input) {
+        return this.service.getMetrics(ctx, input);
+    }
+};
+exports.MetricsResolver = MetricsResolver;
+__decorate([
+    (0, graphql_1.Query)(),
+    (0, core_1.Allow)(core_1.Permission.ReadOrder),
+    __param(0, (0, core_1.Ctx)()),
+    __param(1, (0, graphql_1.Args)("input")),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [core_1.RequestContext, Object]),
+    __metadata("design:returntype", Promise)
+], MetricsResolver.prototype, "metricSummary", null);
+exports.MetricsResolver = MetricsResolver = __decorate([
+    (0, graphql_1.Resolver)(),
+    __metadata("design:paramtypes", [metrics_service_1.MetricsService])
+], MetricsResolver);
+//# sourceMappingURL=metrics.resolver.js.map

package/lib/src/api/metrics.resolver.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"metrics.resolver.js","sourceRoot":"","sources":["../../../src/api/metrics.resolver.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,6CAAwD;AACxD,wCAAuE;AAEvE,gEAA4D;AAIrD,IAAM,eAAe,GAArB,MAAM,eAAe;IAC1B,YAAoB,OAAuB;QAAvB,YAAO,GAAP,OAAO,CAAgB;IAAG,CAAC;IAIzC,AAAN,KAAK,CAAC,aAAa,CACV,GAAmB,EACX,KAAyB;QAExC,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IAC7C,CAAC;CACF,CAAA;AAXY,0CAAe;AAKpB;IAFL,IAAA,eAAK,GAAE;IACP,IAAA,YAAK,EAAC,iBAAU,CAAC,SAAS,CAAC;IAEzB,WAAA,IAAA,UAAG,GAAE,CAAA;IACL,WAAA,IAAA,cAAI,EAAC,OAAO,CAAC,CAAA;;qCADF,qBAAc;;oDAI3B;0BAVU,eAAe;IAD3B,IAAA,kBAAQ,GAAE;qCAEoB,gCAAc;GADhC,eAAe,CAW3B"}

package/lib/src/config/metrics-strategies.d.ts

@@ -0,0 +1,39 @@
+import { RequestContext } from "@deenruv/core";
+import { MetricData } from "../service/metrics.service";
+import { MetricInterval, MetricSummaryEntry, MetricType } from "../types";
+/**
+ * Calculate your metric data based on the given input.
+ * Be careful with heavy queries and calculations,
+ * as this function is executed everytime a user views its dashboard
+ *
+ */
+export interface MetricCalculation {
+    type: MetricType;
+    getTitle(ctx: RequestContext): string;
+    calculateEntry(ctx: RequestContext, interval: MetricInterval, data: MetricData): MetricSummaryEntry;
+}
+export declare function getMonthName(monthNr: number): string;
+/**
+ * Calculates the average order value per month/week
+ */
+export declare class AverageOrderValueMetric implements MetricCalculation {
+    readonly type = MetricType.AverageOrderValue;
+    getTitle(ctx: RequestContext): string;
+    calculateEntry(ctx: RequestContext, interval: MetricInterval, data: MetricData): MetricSummaryEntry;
+}
+/**
+ * Calculates number of orders
+ */
+export declare class OrderCountMetric implements MetricCalculation {
+    readonly type = MetricType.OrderCount;
+    getTitle(ctx: RequestContext): string;
+    calculateEntry(ctx: RequestContext, interval: MetricInterval, data: MetricData): MetricSummaryEntry;
+}
+/**
+ * Calculates order total
+ */
+export declare class OrderTotalMetric implements MetricCalculation {
+    readonly type = MetricType.OrderTotal;
+    getTitle(ctx: RequestContext): string;
+    calculateEntry(ctx: RequestContext, interval: MetricInterval, data: MetricData): MetricSummaryEntry;
+}

package/lib/src/config/metrics-strategies.js

@@ -0,0 +1,92 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OrderTotalMetric = exports.OrderCountMetric = exports.AverageOrderValueMetric = exports.getMonthName = void 0;
+const types_1 = require("../types");
+function getMonthName(monthNr) {
+    const monthNames = [
+        "Jan",
+        "Feb",
+        "Mar",
+        "Apr",
+        "May",
+        "Jun",
+        "Jul",
+        "Aug",
+        "Sep",
+        "Oct",
+        "Nov",
+        "Dec",
+    ];
+    return monthNames[monthNr];
+}
+exports.getMonthName = getMonthName;
+/**
+ * Calculates the average order value per month/week
+ */
+class AverageOrderValueMetric {
+    constructor() {
+        this.type = types_1.MetricType.AverageOrderValue;
+    }
+    getTitle(ctx) {
+        return "average-order-value";
+    }
+    calculateEntry(ctx, interval, data) {
+        const label = data.date.toISOString();
+        if (!data.orders.length) {
+            return {
+                label,
+                value: 0,
+            };
+        }
+        const total = data.orders
+            .map((o) => o.totalWithTax)
+            .reduce((_total, current) => _total + current);
+        const average = Math.round(total / data.orders.length);
+        return {
+            label,
+            value: average,
+        };
+    }
+}
+exports.AverageOrderValueMetric = AverageOrderValueMetric;
+/**
+ * Calculates number of orders
+ */
+class OrderCountMetric {
+    constructor() {
+        this.type = types_1.MetricType.OrderCount;
+    }
+    getTitle(ctx) {
+        return "order-count";
+    }
+    calculateEntry(ctx, interval, data) {
+        const label = data.date.toISOString();
+        return {
+            label,
+            value: data.orders.length,
+        };
+    }
+}
+exports.OrderCountMetric = OrderCountMetric;
+/**
+ * Calculates order total
+ */
+class OrderTotalMetric {
+    constructor() {
+        this.type = types_1.MetricType.OrderTotal;
+    }
+    getTitle(ctx) {
+        return "order-totals";
+    }
+    calculateEntry(ctx, interval, data) {
+        const label = data.date.toISOString();
+        return {
+            label,
+            value: data.orders
+                .map((o) => o.totalWithTax)
+                .reduce((_total, current) => _total + current, 0),
+        };
+    }
+}
+exports.OrderTotalMetric = OrderTotalMetric;
+//# sourceMappingURL=metrics-strategies.js.map

package/lib/src/config/metrics-strategies.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"metrics-strategies.js","sourceRoot":"","sources":["../../../src/config/metrics-strategies.ts"],"names":[],"mappings":";;;AAGA,oCAA0E;AAoB1E,SAAgB,YAAY,CAAC,OAAe;IAC1C,MAAM,UAAU,GAAG;QACjB,KAAK;QACL,KAAK;QACL,KAAK;QACL,KAAK;QACL,KAAK;QACL,KAAK;QACL,KAAK;QACL,KAAK;QACL,KAAK;QACL,KAAK;QACL,KAAK;QACL,KAAK;KACN,CAAC;IACF,OAAO,UAAU,CAAC,OAAO,CAAC,CAAC;AAC7B,CAAC;AAhBD,oCAgBC;AAED;;GAEG;AACH,MAAa,uBAAuB;IAApC;QACW,SAAI,GAAG,kBAAU,CAAC,iBAAiB,CAAC;IA2B/C,CAAC;IAzBC,QAAQ,CAAC,GAAmB;QAC1B,OAAO,qBAAqB,CAAC;IAC/B,CAAC;IAED,cAAc,CACZ,GAAmB,EACnB,QAAwB,EACxB,IAAgB;QAEhB,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;QACtC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;YACxB,OAAO;gBACL,KAAK;gBACL,KAAK,EAAE,CAAC;aACT,CAAC;QACJ,CAAC;QACD,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM;aACtB,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC;aAC1B,MAAM,CAAC,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,CAAC,MAAM,GAAG,OAAO,CAAC,CAAC;QACjD,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACvD,OAAO;YACL,KAAK;YACL,KAAK,EAAE,OAAO;SACf,CAAC;IACJ,CAAC;CACF;AA5BD,0DA4BC;AAED;;GAEG;AACH,MAAa,gBAAgB;IAA7B;QACW,SAAI,GAAG,kBAAU,CAAC,UAAU,CAAC;IAiBxC,CAAC;IAfC,QAAQ,CAAC,GAAmB;QAC1B,OAAO,aAAa,CAAC;IACvB,CAAC;IAED,cAAc,CACZ,GAAmB,EACnB,QAAwB,EACxB,IAAgB;QAEhB,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;QACtC,OAAO;YACL,KAAK;YACL,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM;SAC1B,CAAC;IACJ,CAAC;CACF;AAlBD,4CAkBC;AACD;;GAEG;AACH,MAAa,gBAAgB;IAA7B;QACW,SAAI,GAAG,kBAAU,CAAC,UAAU,CAAC;IAmBxC,CAAC;IAjBC,QAAQ,CAAC,GAAmB;QAC1B,OAAO,cAAc,CAAC;IACxB,CAAC;IAED,cAAc,CACZ,GAAmB,EACnB,QAAwB,EACxB,IAAgB;QAEhB,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;QACtC,OAAO;YACL,KAAK;YACL,KAAK,EAAE,IAAI,CAAC,MAAM;iBACf,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC;iBAC1B,MAAM,CAAC,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,CAAC,MAAM,GAAG,OAAO,EAAE,CAAC,CAAC;SACpD,CAAC;IACJ,CAAC;CACF;AApBD,4CAoBC"}

package/lib/src/constants.d.ts

@@ -0,0 +1,7 @@
+import { LanguageCode } from "@deenruv/core";
+export declare const DEFAULT_APP_PATH: string;
+export declare const loggerCtx = "AdminUiPlugin";
+export declare const defaultLanguage = LanguageCode.en;
+export declare const defaultLocale: undefined;
+export declare const defaultAvailableLanguages: LanguageCode[];
+export declare const defaultAvailableLocales: string[];

package/lib/src/constants.js

@@ -0,0 +1,286 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultAvailableLocales = exports.defaultAvailableLanguages = exports.defaultLocale = exports.defaultLanguage = exports.loggerCtx = exports.DEFAULT_APP_PATH = void 0;
+const core_1 = require("@deenruv/core");
+const path_1 = __importDefault(require("path"));
+exports.DEFAULT_APP_PATH = path_1.default.join(__dirname, "../admin-ui");
+exports.loggerCtx = "AdminUiPlugin";
+exports.defaultLanguage = core_1.LanguageCode.en;
+exports.defaultLocale = undefined;
+exports.defaultAvailableLanguages = [
+    core_1.LanguageCode.he,
+    core_1.LanguageCode.ar,
+    core_1.LanguageCode.de,
+    core_1.LanguageCode.en,
+    core_1.LanguageCode.es,
+    core_1.LanguageCode.pl,
+    core_1.LanguageCode.zh_Hans,
+    core_1.LanguageCode.zh_Hant,
+    core_1.LanguageCode.pt_BR,
+    core_1.LanguageCode.pt_PT,
+    core_1.LanguageCode.cs,
+    core_1.LanguageCode.fr,
+    core_1.LanguageCode.ru,
+    core_1.LanguageCode.uk,
+    core_1.LanguageCode.it,
+    core_1.LanguageCode.fa,
+    core_1.LanguageCode.ne,
+    core_1.LanguageCode.hr,
+    core_1.LanguageCode.sv,
+    core_1.LanguageCode.nb,
+];
+exports.defaultAvailableLocales = [
+    "AF",
+    "AL",
+    "DZ",
+    "AS",
+    "AD",
+    "AO",
+    "AI",
+    "AQ",
+    "AG",
+    "AR",
+    "AM",
+    "AW",
+    "AU",
+    "AT",
+    "AZ",
+    "BS",
+    "BH",
+    "BD",
+    "BB",
+    "BY",
+    "BE",
+    "BZ",
+    "BJ",
+    "BM",
+    "BT",
+    "BO",
+    "BQ",
+    "BA",
+    "BW",
+    "BV",
+    "BR",
+    "IO",
+    "BN",
+    "BG",
+    "BF",
+    "BI",
+    "CV",
+    "KH",
+    "CM",
+    "CA",
+    "KY",
+    "CF",
+    "TD",
+    "CL",
+    "CN",
+    "CX",
+    "CC",
+    "CO",
+    "KM",
+    "CD",
+    "CG",
+    "CK",
+    "CR",
+    "HR",
+    "CU",
+    "CW",
+    "CY",
+    "CZ",
+    "CI",
+    "DK",
+    "DJ",
+    "DM",
+    "DO",
+    "EC",
+    "EG",
+    "SV",
+    "GQ",
+    "ER",
+    "EE",
+    "SZ",
+    "ET",
+    "FK",
+    "FO",
+    "FJ",
+    "FI",
+    "FR",
+    "GF",
+    "PF",
+    "TF",
+    "GA",
+    "GM",
+    "GE",
+    "DE",
+    "GH",
+    "GI",
+    "GR",
+    "GL",
+    "GD",
+    "GP",
+    "GU",
+    "GT",
+    "GG",
+    "GN",
+    "GW",
+    "GY",
+    "HT",
+    "HM",
+    "VA",
+    "HN",
+    "HK",
+    "HU",
+    "IS",
+    "IN",
+    "ID",
+    "IR",
+    "IQ",
+    "IE",
+    "IM",
+    "IL",
+    "IT",
+    "JM",
+    "JP",
+    "JE",
+    "JO",
+    "KZ",
+    "KE",
+    "KI",
+    "KP",
+    "KR",
+    "KW",
+    "KG",
+    "LA",
+    "LV",
+    "LB",
+    "LS",
+    "LR",
+    "LY",
+    "LI",
+    "LT",
+    "LU",
+    "MO",
+    "MG",
+    "MW",
+    "MY",
+    "MV",
+    "ML",
+    "MT",
+    "MH",
+    "MQ",
+    "MR",
+    "MU",
+    "YT",
+    "MX",
+    "FM",
+    "MD",
+    "MC",
+    "MN",
+    "ME",
+    "MS",
+    "MA",
+    "MZ",
+    "MM",
+    "NA",
+    "NR",
+    "NP",
+    "NL",
+    "NC",
+    "NZ",
+    "NI",
+    "NE",
+    "NG",
+    "NU",
+    "NF",
+    "MK",
+    "MP",
+    "NO",
+    "OM",
+    "PK",
+    "PW",
+    "PS",
+    "PA",
+    "PG",
+    "PY",
+    "PE",
+    "PH",
+    "PN",
+    "PL",
+    "PT",
+    "PR",
+    "QA",
+    "RO",
+    "RU",
+    "RW",
+    "RE",
+    "BL",
+    "SH",
+    "KN",
+    "LC",
+    "MF",
+    "PM",
+    "VC",
+    "WS",
+    "SM",
+    "ST",
+    "SA",
+    "SN",
+    "RS",
+    "SC",
+    "SL",
+    "SG",
+    "SX",
+    "SK",
+    "SI",
+    "SB",
+    "SO",
+    "ZA",
+    "GS",
+    "SS",
+    "ES",
+    "LK",
+    "SD",
+    "SR",
+    "SJ",
+    "SE",
+    "CH",
+    "SY",
+    "TW",
+    "TJ",
+    "TZ",
+    "TH",
+    "TL",
+    "TG",
+    "TK",
+    "TO",
+    "TT",
+    "TN",
+    "TR",
+    "TM",
+    "TC",
+    "TV",
+    "UG",
+    "UA",
+    "AE",
+    "GB",
+    "UM",
+    "US",
+    "UY",
+    "UZ",
+    "VU",
+    "VE",
+    "VN",
+    "VG",
+    "VI",
+    "WF",
+    "EH",
+    "YE",
+    "ZM",
+    "ZW",
+    "AX",
+];
+//# sourceMappingURL=constants.js.map

package/lib/src/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":";;;;;;AAAA,wCAA6C;AAC7C,gDAAwB;AAEX,QAAA,gBAAgB,GAAG,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;AACvD,QAAA,SAAS,GAAG,eAAe,CAAC;AAC5B,QAAA,eAAe,GAAG,mBAAY,CAAC,EAAE,CAAC;AAClC,QAAA,aAAa,GAAG,SAAS,CAAC;AAE1B,QAAA,yBAAyB,GAAG;IACvC,mBAAY,CAAC,EAAE;IACf,mBAAY,CAAC,EAAE;IACf,mBAAY,CAAC,EAAE;IACf,mBAAY,CAAC,EAAE;IACf,mBAAY,CAAC,EAAE;IACf,mBAAY,CAAC,EAAE;IACf,mBAAY,CAAC,OAAO;IACpB,mBAAY,CAAC,OAAO;IACpB,mBAAY,CAAC,KAAK;IAClB,mBAAY,CAAC,KAAK;IAClB,mBAAY,CAAC,EAAE;IACf,mBAAY,CAAC,EAAE;IACf,mBAAY,CAAC,EAAE;IACf,mBAAY,CAAC,EAAE;IACf,mBAAY,CAAC,EAAE;IACf,mBAAY,CAAC,EAAE;IACf,mBAAY,CAAC,EAAE;IACf,mBAAY,CAAC,EAAE;IACf,mBAAY,CAAC,EAAE;IACf,mBAAY,CAAC,EAAE;CAChB,CAAC;AAEW,QAAA,uBAAuB,GAAG;IACrC,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;CACL,CAAC"}

package/lib/src/plugin.d.ts

@@ -0,0 +1,129 @@
+import { MiddlewareConsumer, NestModule } from "@nestjs/common";
+import { AdminUiAppConfig, AdminUiAppDevModeConfig, AdminUiConfig, Type } from "@deenruv/common/lib/shared-types";
+import { ConfigService, ProcessContext } from "@deenruv/core";
+/**
+ * @description
+ * Configuration options for the {@link AdminUiPlugin}.
+ *
+ * @docsCategory core plugins/AdminUiPlugin
+ */
+export interface AdminUiPluginOptions {
+    /**
+     * @description
+     * The route to the Admin UI.
+     *
+     * Note: If you are using the `compileUiExtensions` function to compile a custom version of the Admin UI, then
+     * the route should match the `baseHref` option passed to that function. The default value of `baseHref` is `/admin/`,
+     * so it only needs to be changed if you set this `route` option to something other than `"admin"`.
+     */
+    route: string;
+    /**
+     * @description
+     * The port on which the server will listen. This port will be proxied by the AdminUiPlugin to the same port that
+     * the Deenruv server is running on.
+     */
+    port: number;
+    /**
+     * @description
+     * The hostname of the server serving the static admin ui files.
+     *
+     * @default 'localhost'
+     */
+    hostname?: string;
+    /**
+     * @description
+     * By default, the AdminUiPlugin comes bundles with a pre-built version of the
+     * Admin UI. This option can be used to override this default build with a different
+     * version, e.g. one pre-compiled with one or more ui extensions.
+     */
+    app?: AdminUiAppConfig | AdminUiAppDevModeConfig;
+    /**
+     * @description
+     * Allows the contents of the `deenruv-ui-config.json` file to be set, e.g.
+     * for specifying the Deenruv GraphQL API host, available UI languages, etc.
+     */
+    adminUiConfig?: Partial<AdminUiConfig>;
+}
+/**
+ * @description
+ * This plugin starts a static server for the Admin UI app, and proxies it via the `/admin/` path of the main Deenruv server.
+ *
+ * The Admin UI allows you to administer all aspects of your store, from inventory management to order tracking. It is the tool used by
+ * store administrators on a day-to-day basis for the management of the store.
+ *
+ * ## Installation
+ *
+ * `yarn add \@deenruv/admin-ui-plugin`
+ *
+ * or
+ *
+ * `npm install \@deenruv/admin-ui-plugin`
+ *
+ * @example
+ * ```ts
+ * import { AdminUiPlugin } from '\@deenruv/admin-ui-plugin';
+ *
+ * const config: DeenruvConfig = {
+ *   // Add an instance of the plugin to the plugins array
+ *   plugins: [
+ *     AdminUiPlugin.init({ port: 3002 }),
+ *   ],
+ * };
+ * ```
+ *
+ * ## Metrics
+ *
+ * This plugin also defines a `metricSummary` query which is used by the Admin UI to display the order metrics on the dashboard.
+ *
+ * If you are building a stand-alone version of the Admin UI app, and therefore don't need this plugin to server the Admin UI,
+ * you can still use the `metricSummary` query by adding the `AdminUiPlugin` to the `plugins` array, but without calling the `init()` method:
+ *
+ * @example
+ * ```ts
+ * import { AdminUiPlugin } from '\@deenruv/admin-ui-plugin';
+ *
+ * const config: DeenruvConfig = {
+ *   plugins: [
+ *     AdminUiPlugin, // <-- no call to .init()
+ *   ],
+ *   // ...
+ * };
+ * ```
+ *
+ * @docsCategory core plugins/AdminUiPlugin
+ */
+export declare class AdminUiPlugin implements NestModule {
+    private configService;
+    private processContext;
+    private static options;
+    constructor(configService: ConfigService, processContext: ProcessContext);
+    /**
+     * @description
+     * Set the plugin options
+     */
+    static init(options: AdminUiPluginOptions): Type<AdminUiPlugin>;
+    configure(consumer: MiddlewareConsumer): Promise<void>;
+    private createStaticServer;
+    /**
+     * Takes an optional AdminUiConfig provided in the plugin options, and returns a complete
+     * config object for writing to disk.
+     */
+    private getAdminUiConfig;
+    /**
+     * Overwrites the parts of the admin-ui app's `deenruv-ui-config.json` file relating to connecting to
+     * the server admin API.
+     */
+    private overwriteAdminUiConfig;
+    /**
+     * Overwrites the parts of the admin-ui app's `deenruv-ui-config.json` file relating to connecting to
+     * the server admin API.
+     */
+    private overwriteBaseHref;
+    /**
+     * It might be that the ui-devkit compiler has not yet copied the config
+     * file to the expected location (particularly when running in watch mode),
+     * so polling is used to check multiple times with a delay.
+     */
+    private pollForFile;
+    private static isDevModeApp;
+}