@plentymarkets/shop-core 1.23.9 → 1.25.0

package/dist/module.json

@@ -1,7 +1,7 @@
 {
   "name": "@plentymarkets/shop-core",
   "configKey": "shopCore",
-  "version": "1.23.9",
+  "version": "1.25.0",
   "builder": {
     "@nuxt/module-builder": "1.0.2",
     "unbuild": "unknown"

package/dist/module.mjs

@@ -167,7 +167,8 @@ const module$1 = defineNuxtModule({
       apiUrl: _options.apiUrl,
       configId: _options.configId,
       experimental: {
-        enableSSRMetrics: _options.experimental?.enableSSRMetrics ?? false
+        enableSSRMetrics: _options.experimental?.enableSSRMetrics ?? false,
+        enablePlentyLogs: _options.experimental?.enablePlentyLogs ?? true
       },
       middlewareSSRUrl: _options.middlewareSSRUrl,
       logger: {
@@ -244,6 +245,7 @@ export type ShopCoreConfig = ${genInlineTypeImport(projectRootResolver.resolve("
     });
     addPlugin(resolver.resolve("./runtime/plugins/sdk"));
     addPlugin(resolver.resolve("./runtime/plugins/cache-control.server"));
+    addPlugin(resolver.resolve("./runtime/plugins/logs.client"));
     addImports({
       name: "useSdk",
       as: "useSdk",
@@ -309,6 +311,11 @@ export type ShopCoreConfig = ${genInlineTypeImport(projectRootResolver.resolve("
       as: "t",
       from: resolver.resolve("./runtime/composables/useT")
     });
+    addImports({
+      name: "usePlentyLogs",
+      as: "usePlentyLogs",
+      from: resolver.resolve("./runtime/composables/usePlentyLogs")
+    });
     addImports({
       name: "getSSRMetrics",
       as: "getSSRMetrics",

package/dist/runtime/composables/usePlentyLogs.d.ts

@@ -0,0 +1,2 @@
+import type { ShopLogEventInput } from '../types/log-events.js';
+export declare const usePlentyLogs: (event: ShopLogEventInput) => void;

package/dist/runtime/composables/usePlentyLogs.js

@@ -0,0 +1,6 @@
+import { useNuxtApp } from "#app";
+export const usePlentyLogs = (event) => {
+  if (!import.meta.client) return;
+  const { $trackEvent } = useNuxtApp();
+  $trackEvent(event);
+};

package/dist/runtime/plugins/logs.client.d.ts

@@ -0,0 +1,11 @@
+import type { ShopLogEventInput } from '../types/log-events.js';
+declare const _default: import("#app").Plugin<{
+    trackEvent: (_event: ShopLogEventInput) => void;
+    collectEvents: () => Promise<void>;
+    stopCollectInterval: () => void;
+}> & import("#app").ObjectPlugin<{
+    trackEvent: (_event: ShopLogEventInput) => void;
+    collectEvents: () => Promise<void>;
+    stopCollectInterval: () => void;
+}>;
+export default _default;

package/dist/runtime/plugins/logs.client.js

@@ -0,0 +1,30 @@
+import { defineNuxtPlugin, useRuntimeConfig, useState } from "#app";
+import { createLogsTracker } from "../utils/logTracker.js";
+import { useSdk } from "../composables/useSdk.js";
+export default defineNuxtPlugin(() => {
+  const config = useRuntimeConfig();
+  let trackEvent = (_event) => {
+  };
+  let collectEvents = async () => {
+  };
+  let stopCollectInterval = () => {
+  };
+  if (config.public.shopCore.experimental.enablePlentyLogs) {
+    const queue = useState("plenty-log-event-queue", () => []);
+    const sendLogs = async (payload) => {
+      return useSdk().plentysystems.doAddShopLogs(payload);
+    };
+    const tracker = createLogsTracker({ queue, fetcher: sendLogs });
+    trackEvent = tracker.trackEvent;
+    collectEvents = tracker.collectEvents;
+    stopCollectInterval = tracker.stopCollectInterval;
+    tracker.startCollectInterval();
+  }
+  return {
+    provide: {
+      trackEvent,
+      collectEvents,
+      stopCollectInterval
+    }
+  };
+});

package/dist/runtime/types/index.d.ts

@@ -6,3 +6,4 @@ export * from './notification.js';
 export * from './localization.js';
 export * from './module.js';
 export * from './ssr-metrics.js';
+export * from './log-events.js';

package/dist/runtime/types/index.js

@@ -6,3 +6,4 @@ export * from "./notification.js";
 export * from "./localization.js";
 export * from "./module.js";
 export * from "./ssr-metrics.js";
+export * from "./log-events.js";

package/dist/runtime/types/log-events.d.ts

@@ -0,0 +1,5 @@
+import type { ISODateString, ShopLogEvent } from "@plentymarkets/shop-api";
+export declare const toISODateString: (value: Date | string) => ISODateString;
+export type ShopLogEventInput = Omit<ShopLogEvent, 'triggeredAt'> & {
+    triggeredAt?: ISODateString;
+};

package/dist/runtime/types/log-events.js

@@ -0,0 +1,5 @@
+export const toISODateString = (value) => {
+  const d = value instanceof Date ? value : new Date(value);
+  if (Number.isNaN(d.getTime())) throw new Error(`Invalid date: ${String(value)}`);
+  return d.toISOString();
+};

package/dist/runtime/types/module.d.ts

@@ -4,6 +4,7 @@ export interface ModuleOptions {
     configId: number;
     experimental?: {
         enableSSRMetrics?: boolean;
+        enablePlentyLogs?: boolean;
     };
     middlewareSSRUrl?: string;
     logger?: {

package/dist/runtime/utils/logTracker.d.ts

@@ -0,0 +1,17 @@
+import type { ShopLogEvent } from '@plentymarkets/shop-api';
+import type { ShopLogEventInput } from '../types/log-events.js';
+interface QueueRef {
+    value: ShopLogEvent[];
+}
+interface LogsTrackerDeps {
+    queue: QueueRef;
+    fetcher: (payload: ShopLogEvent[]) => Promise<unknown>;
+    intervalMs?: number;
+}
+export declare const createLogsTracker: (deps: LogsTrackerDeps) => {
+    trackEvent: (event: ShopLogEventInput) => void;
+    collectEvents: () => Promise<void>;
+    startCollectInterval: () => void;
+    stopCollectInterval: () => void;
+};
+export {};

package/dist/runtime/utils/logTracker.js

@@ -0,0 +1,28 @@
+export const createLogsTracker = (deps) => {
+  const { queue, fetcher, intervalMs = 1e4 } = deps;
+  let flushInterval = null;
+  const trackEvent = (event) => {
+    queue.value.push({ ...event, triggeredAt: event.triggeredAt ?? (/* @__PURE__ */ new Date()).toISOString() });
+  };
+  const collectEvents = async () => {
+    if (queue.value.length === 0) return;
+    const eventsToSend = [...queue.value];
+    queue.value.length = 0;
+    try {
+      await fetcher(eventsToSend);
+    } catch (error) {
+      console.error("Failed to send events:", error);
+      queue.value.unshift(...eventsToSend);
+    }
+  };
+  const startCollectInterval = () => {
+    flushInterval ??= setInterval(collectEvents, intervalMs);
+  };
+  const stopCollectInterval = () => {
+    if (flushInterval) {
+      clearInterval(flushInterval);
+      flushInterval = null;
+    }
+  };
+  return { trackEvent, collectEvents, startCollectInterval, stopCollectInterval };
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plentymarkets/shop-core",
-  "version": "1.23.9",
+  "version": "1.25.0",
   "description": "Core module for PlentyONE Shop",
   "repository": {
     "type": "git",
@@ -50,7 +50,7 @@
   },
   "dependencies": {
     "@noble/hashes": "^2.0.1",
-    "@plentymarkets/shop-api": "^0.168.0",
+    "@plentymarkets/shop-api": "^0.170.0",
     "@vue-storefront/sdk": "^3.4.1",
     "cookie-es": "^2.0.0",
     "knitwork": "^1.3.0",