@plentymarkets/shop-core 1.3.1 → 1.3.2

package/dist/module.d.mts

@@ -1,5 +1,5 @@
 import * as _nuxt_schema from '@nuxt/schema';
-export { Cookie, CookieGroup, CookieGroupFromNuxtConfig } from '../dist/runtime/types/index.js';
+export { Cookie, CookieGroup, CookieGroupFromNuxtConfig, Events, JsonCookie, Notification, PaymentButtonComponent, PaymentButtonComponentProps } from '../dist/runtime/types/index.js';
 
 interface ModuleOptions {
     apiUrl: string;

package/dist/module.d.ts

@@ -1,5 +1,5 @@
 import * as _nuxt_schema from '@nuxt/schema';
-export { Cookie, CookieGroup, CookieGroupFromNuxtConfig } from '../dist/runtime/types/index.js';
+export { Cookie, CookieGroup, CookieGroupFromNuxtConfig, Events, JsonCookie, Notification, PaymentButtonComponent, PaymentButtonComponentProps } from '../dist/runtime/types/index.js';
 
 interface ModuleOptions {
     apiUrl: string;

package/dist/module.json

@@ -1,7 +1,7 @@
 {
   "name": "shop-core",
   "configKey": "shopCore",
-  "version": "1.3.1",
+  "version": "1.3.2",
   "builder": {
     "@nuxt/module-builder": "0.8.4",
     "unbuild": "2.0.0"

package/dist/module.mjs

@@ -15,6 +15,16 @@ const module = defineNuxtModule({
       as: "useSdk",
       from: resolver.resolve("./runtime/composables/useSdk")
     });
+    addImports({
+      name: "useNotification",
+      as: "useNotification",
+      from: resolver.resolve("./runtime/composables/useNotification")
+    });
+    addImports({
+      name: "useHandleError",
+      as: "useHandleError",
+      from: resolver.resolve("./runtime/composables/useHandleError")
+    });
     addImports({
       name: "usePlentyEvent",
       as: "usePlentyEvent",
@@ -35,6 +45,11 @@ const module = defineNuxtModule({
       as: "useRegisterCookie",
       from: resolver.resolve("./runtime/composables/useRegisterCookie")
     });
+    addImports({
+      name: "useDynamicPaymentButtons",
+      as: "useDynamicPaymentButtons",
+      from: resolver.resolve("./runtime/composables/useDynamicPaymentButtons")
+    });
   }
 });
 

package/dist/runtime/composables/__tests__/useCookieBar.spec.js

@@ -1,5 +1,5 @@
 import { useRuntimeConfig } from "nuxt/app";
-import { describe, it, expect } from "vitest";
+import { describe, it, expect, vi, beforeEach } from "vitest";
 import { mockNuxtImport } from "@nuxt/test-utils/runtime";
 import { useCookieBar } from "../useCookieBar.js";
 import { useCookieConsent } from "../useCookieConsent.js";
@@ -88,6 +88,10 @@ describe("useCookieBar", () => {
     document.cookie = "testCookie=testValue";
     const cookie = {
       name: "testCookie",
+      Lifespan: "Session",
+      Provider: "testProvider",
+      Status: "testStatus",
+      PrivacyPolicy: "https://example.com/privacy",
       cookieNames: ["testCookie"]
     };
     const { removeCookies } = useCookieBar();

package/dist/runtime/composables/__tests__/useRegisterCookie.spec.js

@@ -1,5 +1,5 @@
 import { useRuntimeConfig } from "nuxt/app";
-import { describe, it, vi } from "vitest";
+import { describe, it, vi, expect } from "vitest";
 import { useRegisterCookie } from "../useRegisterCookie.js";
 vi.mock("nuxt/app", () => ({
   useRuntimeConfig: vi.fn()
@@ -103,7 +103,8 @@ describe("useRegisterCookie", () => {
         cookieGroups: {
           groups: [
             {
-              name: "marketing"
+              name: "marketing",
+              cookies: []
             }
           ]
         }

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

@@ -1,3 +1,4 @@
+import type { Ref } from 'vue';
 import type { Cookie, CookieGroupFromNuxtConfig } from '../types/index.js';
 /**
  * @description Composable for managing cookie consent bar.
@@ -15,8 +16,8 @@ export declare const useCookieBar: () => {
     setAllCookiesState: (accepted: boolean) => void;
     removeCookies: (cookie: Cookie) => void;
     accept: (name: string) => void;
-    data: import("vue").Ref<CookieGroupFromNuxtConfig, CookieGroupFromNuxtConfig>;
-    visible: import("vue").Ref<boolean, boolean>;
-    loading: import("vue").Ref<boolean, boolean>;
+    data: Ref<CookieGroupFromNuxtConfig, CookieGroupFromNuxtConfig>;
+    visible: Ref<boolean, boolean>;
+    loading: Ref<boolean, boolean>;
 };
 export declare const fetchScripts: (scripts: string[]) => void;

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

@@ -0,0 +1,5 @@
+import type { PaymentButtonComponent } from '../types/index.js';
+export declare const useDynamicPaymentButtons: () => {
+    components: import("vue").Ref<PaymentButtonComponent[], PaymentButtonComponent[]>;
+    addComponent: (component: PaymentButtonComponent) => void;
+};

package/dist/runtime/composables/useDynamicPaymentButtons.js

@@ -0,0 +1,17 @@
+import { useState } from "nuxt/app";
+import { toRefs } from "vue";
+export const useDynamicPaymentButtons = () => {
+  const state = useState("useDynamicPaymentButtons", () => ({
+    components: []
+  }));
+  const addComponent = (component) => {
+    if (state.value.components.some((stateComponent) => stateComponent.componentName === component.componentName)) {
+      return;
+    }
+    state.value.components.push(component);
+  };
+  return {
+    addComponent,
+    ...toRefs(state.value)
+  };
+};

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

@@ -0,0 +1,13 @@
+import type { UseHandleError } from '../types/index.js';
+/**
+ * @description Composable for handling errors.
+ * @param error
+ * @example
+ * ``` ts
+ * const { data, error } = useHandleError({
+ *   statusCode: ''
+ *   message: ''
+ * });
+ * ```
+ */
+export declare const useHandleError: UseHandleError;

package/dist/runtime/composables/useHandleError.js

@@ -0,0 +1,27 @@
+import { useNuxtApp } from "nuxt/app";
+import { ApiError } from "@plentymarkets/shop-api";
+import { useNotification } from "../composables/useNotification.js";
+export const useHandleError = (error) => {
+  if (error && import.meta.client) {
+    const $i18n = useNuxtApp().$i18n;
+    const { send } = useNotification();
+    const type = "negative";
+    const persist = true;
+    if (error instanceof ApiError) {
+      const translationKey = `storefrontError.${error.key}`;
+      const message = error.key && $i18n.te(translationKey) ? $i18n.t(translationKey) : error.message + " _ " + translationKey;
+      send({
+        type,
+        message,
+        persist
+      });
+    } else {
+      const message = $i18n.t("storefrontError.unknownError");
+      send({
+        type,
+        message,
+        persist
+      });
+    }
+  }
+};

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

@@ -0,0 +1,10 @@
+import type { UseNotificationReturn } from '../types/index.js';
+/**
+ * @description Composable to display ui notifications
+ * @return UseNotificationReturn
+ * @example
+ * ``` ts
+ * const { data, send } = useNotification();
+ * ```
+ */
+export declare const useNotification: UseNotificationReturn;

package/dist/runtime/composables/useNotification.js

@@ -0,0 +1,34 @@
+import { useState } from "nuxt/app";
+import { toRefs } from "vue";
+const maxVisibleNotifications = 5;
+const dismissTimeout = 5e3;
+export const useNotification = () => {
+  const state = useState(`useNotification`, () => ({
+    data: []
+  }));
+  const send = (notification) => {
+    const id = Symbol();
+    const dismiss = () => {
+      const index = state.value.data.findIndex((notification2) => notification2.id === id);
+      if (index !== -1) state.value.data.splice(index, 1);
+    };
+    const dismissibleNotification = {
+      ...notification,
+      id,
+      dismiss
+    };
+    state.value.data.push(dismissibleNotification);
+    if (state.value.data.length > maxVisibleNotifications) state.value.data.shift();
+    if (!notification.persist && notification.type !== "negative") {
+      setTimeout(dismiss, notification.dismissTimeout || dismissTimeout);
+    }
+  };
+  const clear = () => {
+    state.value.data = [];
+  };
+  return {
+    send,
+    clear,
+    ...toRefs(state.value)
+  };
+};

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

@@ -27,4 +27,5 @@ export type Events = {
     'backend:CheckoutChanged': CheckoutChanged;
     'backend:AfterAccountAuthentication': AfterAccountAuthentication;
     'backend:FrontendUpdateCustomerSettings': FrontendUpdateCustomerSettings;
+    'module:clearCart': null;
 };

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

@@ -1,2 +1,4 @@
 export * from './cookies.js';
 export * from './events.js';
+export * from './render.js';
+export * from './notification.js';

package/dist/runtime/types/index.js

@@ -1,2 +1,4 @@
 export * from "./cookies.js";
 export * from "./events.js";
+export * from "./render.js";
+export * from "./notification.js";

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

@@ -0,0 +1,35 @@
+import type { ApiError } from '@plentymarkets/shop-api';
+import type { NuxtError } from 'nuxt/app';
+import type { Ref } from 'vue';
+export type ErrorParams = {
+    /** The error message. */
+    message: string;
+    /** The HTTP status code associated with this error. */
+    statusCode?: number;
+    /** An optional cause for the error, providing more context or the underlying error that led to this error. */
+    cause?: unknown;
+};
+export type UseHandleError = (error: ApiError | NuxtError<unknown> | null) => void;
+export interface Notification {
+    message: string | string[];
+    action?: {
+        text: string;
+        onClick: (...arguments_: Array<unknown>) => void;
+    };
+    type: 'neutral' | 'positive' | 'secondary' | 'warning' | 'negative';
+    persist?: boolean;
+    id?: symbol;
+    dismiss?: () => void;
+    dismissTimeout?: number;
+}
+export type SendNotification = (notification: Notification) => void;
+export type ClearNotification = () => void;
+export interface UseNotificationState {
+    data: Notification[];
+}
+export interface UseNotification {
+    data: Readonly<Ref<UseNotificationState['data']>>;
+    send: SendNotification;
+    clear: ClearNotification;
+}
+export type UseNotificationReturn = () => UseNotification;

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

@@ -0,0 +1,10 @@
+export type PaymentButtonComponent = {
+    componentName: string;
+    key?: string;
+    paymentKey?: string;
+    excludeKeys?: string[];
+    excludePaymentKeys?: string[];
+};
+export type PaymentButtonComponentProps = {
+    disabled: boolean;
+};

package/dist/types.d.mts

@@ -1 +1 @@
-export { type Cookie, type CookieGroup, type CookieGroupFromNuxtConfig } from './module.js'
+export { type Cookie, type CookieGroup, type CookieGroupFromNuxtConfig, type Events, type JsonCookie, type Notification, type PaymentButtonComponent, type PaymentButtonComponentProps } from './module.js'

package/dist/types.d.ts

@@ -1 +1 @@
-export { type Cookie, type CookieGroup, type CookieGroupFromNuxtConfig } from './module'
+export { type Cookie, type CookieGroup, type CookieGroupFromNuxtConfig, type Events, type JsonCookie, type Notification, type PaymentButtonComponent, type PaymentButtonComponentProps } from './module'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plentymarkets/shop-core",
-  "version": "1.3.1",
+  "version": "1.3.2",
   "description": "Core module for PlentyONE Shop",
   "repository": {
     "type": "git",
@@ -26,6 +26,7 @@
     "dist"
   ],
   "scripts": {
+    "go": "bun dev:prepare && bun prepack",
     "prepack": "nuxt-module-build build",
     "dev": "nuxi dev playground",
     "dev:build": "nuxi build playground",

package/dist/runtime/composables/__tests__/usePlentyEvent.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/runtime/composables/__tests__/usePlentyEvent.spec.js

@@ -1,44 +0,0 @@
-import { describe, expect, it, beforeEach, vi } from "vitest";
-import { usePlentyEvent } from "../usePlentyEvent.js";
-describe("usePlentyEvent", () => {
-  beforeEach(() => {
-    usePlentyEvent().all.clear();
-  });
-  it("should register event listener", () => {
-    const { on, all } = usePlentyEvent();
-    on("userLogin", () => {
-    });
-    expect(all.get("userLogin")).toHaveLength(1);
-  });
-  it("should register multiple event listeners", () => {
-    const { on, all } = usePlentyEvent();
-    on("userLogin", () => {
-    });
-    on("userLogin", () => {
-    });
-    expect(all.get("userLogin")).toHaveLength(2);
-  });
-  it("should emit and listen to event", () => {
-    const { on, emit } = usePlentyEvent();
-    const mock = vi.fn();
-    on("userLogin", mock);
-    emit("userLogin", { id: 1, firstName: "John Doe" });
-    expect(mock).toHaveBeenCalled();
-  });
-  it("should clear all event listeners", () => {
-    const { on, all } = usePlentyEvent();
-    on("userLogin", () => {
-    });
-    on("userLogout", () => {
-    });
-    all.clear();
-    expect(all.size).toBe(0);
-  });
-  it("should turn off event listener", () => {
-    const { on, off, all } = usePlentyEvent();
-    const mock = vi.fn();
-    on("userLogin", mock);
-    off("userLogin", mock);
-    expect(all.get("userLogin")).toHaveLength(0);
-  });
-});