@leandrosk/dashboard 3.5.5 → 3.5.6

package/dist/plugin/api/api-extensions.d.ts

@@ -0,0 +1 @@
+export declare const adminApiExtensions: import("graphql").DocumentNode;

package/dist/plugin/api/api-extensions.js

@@ -0,0 +1,35 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.adminApiExtensions = void 0;
+const graphql_tag_1 = __importDefault(require("graphql-tag"));
+exports.adminApiExtensions = (0, graphql_tag_1.default) `
+    type DashboardMetricSummary {
+        type: DashboardMetricType!
+        title: String!
+        entries: [DashboardMetricSummaryEntry!]!
+    }
+    enum DashboardMetricType {
+        OrderCount
+        OrderTotal
+        AverageOrderValue
+    }
+    type DashboardMetricSummaryEntry {
+        label: String!
+        value: Float!
+    }
+    input DashboardMetricSummaryInput {
+        types: [DashboardMetricType!]!
+        refresh: Boolean
+        startDate: DateTime!
+        endDate: DateTime!
+    }
+    extend type Query {
+        """
+        Get metrics for the given date range and metric types.
+        """
+        dashboardMetricSummary(input: DashboardMetricSummaryInput): [DashboardMetricSummary!]!
+    }
+`;

package/dist/plugin/api/metrics.resolver.d.ts

@@ -0,0 +1,8 @@
+import { RequestContext } from '@vendure/core';
+import { MetricsService } from '../service/metrics.service.js';
+import { DashboardMetricSummary, DashboardMetricSummaryInput } from '../types.js';
+export declare class MetricsResolver {
+    private service;
+    constructor(service: MetricsService);
+    dashboardMetricSummary(ctx: RequestContext, input: DashboardMetricSummaryInput): Promise<DashboardMetricSummary[]>;
+}

package/dist/plugin/api/metrics.resolver.js

@@ -0,0 +1,40 @@
+"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("@vendure/core");
+const metrics_service_js_1 = require("../service/metrics.service.js");
+let MetricsResolver = class MetricsResolver {
+    constructor(service) {
+        this.service = service;
+    }
+    async dashboardMetricSummary(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, "dashboardMetricSummary", null);
+exports.MetricsResolver = MetricsResolver = __decorate([
+    (0, graphql_1.Resolver)(),
+    __metadata("design:paramtypes", [metrics_service_js_1.MetricsService])
+], MetricsResolver);

package/dist/plugin/config/metrics-strategies.d.ts

@@ -0,0 +1,39 @@
+import { RequestContext } from '@vendure/core';
+import { MetricData } from '../service/metrics.service.js';
+import { DashboardMetricSummaryEntry, DashboardMetricType } from '../types.js';
+/**
+ * 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: DashboardMetricType;
+    getTitle(ctx: RequestContext): string;
+    calculateEntry(ctx: RequestContext, data: MetricData): DashboardMetricSummaryEntry;
+}
+export declare function getMonthName(monthNr: number): string;
+/**
+ * Calculates the average order value per month/week
+ */
+export declare class AverageOrderValueMetric implements MetricCalculation {
+    readonly type = DashboardMetricType.AverageOrderValue;
+    getTitle(ctx: RequestContext): string;
+    calculateEntry(ctx: RequestContext, data: MetricData): DashboardMetricSummaryEntry;
+}
+/**
+ * Calculates number of orders
+ */
+export declare class OrderCountMetric implements MetricCalculation {
+    readonly type = DashboardMetricType.OrderCount;
+    getTitle(ctx: RequestContext): string;
+    calculateEntry(ctx: RequestContext, data: MetricData): DashboardMetricSummaryEntry;
+}
+/**
+ * Calculates order total
+ */
+export declare class OrderTotalMetric implements MetricCalculation {
+    readonly type = DashboardMetricType.OrderTotal;
+    getTitle(ctx: RequestContext): string;
+    calculateEntry(ctx: RequestContext, data: MetricData): DashboardMetricSummaryEntry;
+}

package/dist/plugin/config/metrics-strategies.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OrderTotalMetric = exports.OrderCountMetric = exports.AverageOrderValueMetric = void 0;
+exports.getMonthName = getMonthName;
+const types_js_1 = require("../types.js");
+function getMonthName(monthNr) {
+    const monthNames = ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'];
+    return monthNames[monthNr];
+}
+/**
+ * Calculates the average order value per month/week
+ */
+class AverageOrderValueMetric {
+    constructor() {
+        this.type = types_js_1.DashboardMetricType.AverageOrderValue;
+    }
+    getTitle(ctx) {
+        return 'average-order-value';
+    }
+    calculateEntry(ctx, 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, 0);
+        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_js_1.DashboardMetricType.OrderCount;
+    }
+    getTitle(ctx) {
+        return 'order-count';
+    }
+    calculateEntry(ctx, data) {
+        const label = data.date.toISOString();
+        return {
+            label,
+            value: data.orders.length,
+        };
+    }
+}
+exports.OrderCountMetric = OrderCountMetric;
+/**
+ * Calculates order total
+ */
+class OrderTotalMetric {
+    constructor() {
+        this.type = types_js_1.DashboardMetricType.OrderTotal;
+    }
+    getTitle(ctx) {
+        return 'order-totals';
+    }
+    calculateEntry(ctx, data) {
+        const label = data.date.toISOString();
+        return {
+            label,
+            value: data.orders.map(o => o.totalWithTax).reduce((_total, current) => _total + current, 0),
+        };
+    }
+}
+exports.OrderTotalMetric = OrderTotalMetric;

package/dist/plugin/constants.d.ts

@@ -0,0 +1,8 @@
+import { RwPermissionDefinition } from '@vendure/core';
+export declare const DEFAULT_APP_PATH: string;
+export declare const loggerCtx = "DashboardPlugin";
+export declare const defaultLanguage = "en";
+export declare const defaultLocale: undefined;
+export declare const defaultAvailableLanguages: string[];
+export declare const defaultAvailableLocales: string[];
+export declare const manageDashboardGlobalViews: RwPermissionDefinition;

package/dist/plugin/constants.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.manageDashboardGlobalViews = exports.defaultAvailableLocales = exports.defaultAvailableLanguages = exports.defaultLocale = exports.defaultLanguage = exports.loggerCtx = exports.DEFAULT_APP_PATH = void 0;
+const core_1 = require("@vendure/core");
+const path_1 = require("path");
+exports.DEFAULT_APP_PATH = (0, path_1.join)(__dirname, 'dist');
+exports.loggerCtx = 'DashboardPlugin';
+exports.defaultLanguage = 'en';
+exports.defaultLocale = undefined;
+exports.defaultAvailableLanguages = [
+    'en',
+    'de',
+    'es',
+    'cs',
+    'zh_Hans',
+    'pt_BR',
+    'pt_PT',
+    'zh_Hant',
+    'bg',
+    'nl',
+];
+exports.defaultAvailableLocales = [
+    'en-US',
+    'de-DE',
+    'es-ES',
+    'zh-CN',
+    'zh-TW',
+    'pt-BR',
+    'pt-PT',
+    'bg_BG',
+    'nl-NL',
+];
+exports.manageDashboardGlobalViews = new core_1.RwPermissionDefinition('DashboardGlobalViews');

package/dist/plugin/dashboard.plugin.d.ts

@@ -0,0 +1,115 @@
+import { MiddlewareConsumer, NestModule } from '@nestjs/common';
+import { Type } from '@vendure/common/lib/shared-types';
+import { ProcessContext } from '@vendure/core';
+/**
+ * @description
+ * Configuration options for the {@link DashboardPlugin}.
+ *
+ * @docsCategory core plugins/DashboardPlugin
+ */
+export interface DashboardPluginOptions {
+    /**
+     * @description
+     * The route to the Dashboard UI.
+     *
+     * @default 'dashboard'
+     */
+    route: string;
+    /**
+     * @description
+     * The path to the dashboard UI app dist directory.
+     */
+    appDir: string;
+    /**
+     * @description
+     * The port on which to check for a running Vite dev server.
+     * If a Vite dev server is detected on this port, requests will be proxied to it
+     * instead of serving static files from appDir.
+     *
+     * @default 5173
+     */
+    viteDevServerPort?: number;
+}
+/**
+ * @description
+ * This plugin serves the static files of the Vendure Dashboard and provides the
+ * GraphQL extensions needed for the order metrics on the dashboard index page.
+ *
+ * ## Installation
+ *
+ * `npm install \@vendure/dashboard`
+ *
+ * ## Usage
+ *
+ * First you need to set up compilation of the Dashboard, using the Vite configuration
+ * described in the [Dashboard Getting Started Guide](/extending-the-dashboard/getting-started/)
+ *
+ * ## Development vs Production
+ *
+ * When developing, you can run `npx vite` (or `npm run dev`) to start the Vite development server.
+ * The plugin will automatically detect if Vite is running on the default port (5173) and proxy
+ * requests to it instead of serving static files. This enables hot module replacement and faster
+ * development iterations.
+ *
+ * For production, run `npx vite build` to build the dashboard app. The built app files will be
+ * output to the location specified by `build.outDir` in your Vite config file. This should then
+ * be passed to the `appDir` init option, as in the example below:
+ *
+ * @example
+ * ```ts
+ * import { DashboardPlugin } from '\@vendure/dashboard/plugin';
+ *
+ * const config: VendureConfig = {
+ *   // Add an instance of the plugin to the plugins array
+ *   plugins: [
+ *     DashboardPlugin.init({
+ *       route: 'dashboard',
+ *       appDir: './dist/dashboard',
+ *       // Optional: customize Vite dev server port (defaults to 5173)
+ *       viteDevServerPort: 3000,
+ *     }),
+ *   ],
+ * };
+ * ```
+ *
+ * ## Metrics
+ *
+ * This plugin defines a `metricSummary` query which is used by the Dashboard UI to
+ * display the order metrics on the dashboard.
+ *
+ * If you are building a stand-alone version of the Dashboard UI app, and therefore
+ * don't need this plugin to serve the Dashboard UI, you can still use the
+ * `metricSummary` query by adding the `DashboardPlugin` to the `plugins` array,
+ * but without calling the `init()` method:
+ *
+ * @example
+ * ```ts
+ * import { DashboardPlugin } from '\@vendure/dashboard-plugin';
+ *
+ * const config: VendureConfig = {
+ *   plugins: [
+ *     DashboardPlugin, // <-- no call to .init()
+ *   ],
+ *   // ...
+ * };
+ * ```
+ *
+ * @docsCategory core plugins/DashboardPlugin
+ */
+export declare class DashboardPlugin implements NestModule {
+    private readonly processContext;
+    private static options;
+    private readonly rateLimitRequests;
+    constructor(processContext: ProcessContext);
+    /**
+     * @description
+     * Set the plugin options
+     */
+    static init(options: DashboardPluginOptions): Type<DashboardPlugin>;
+    configure(consumer: MiddlewareConsumer): void;
+    private createStaticServer;
+    private checkViteDevServer;
+    private checkBuiltFiles;
+    private createDefaultPage;
+    private createDynamicHandler;
+}