@plentymarkets/shop-core 1.17.1 → 1.18.1

package/README.md

@@ -1,12 +1,8 @@
 # Shop Core
 
-- [✨  Release Notes](/CHANGELOG.md)
+Core nuxt module for PlentyONE shops enabling essential functionalities and integrations.
 
-## Features
-
-- EventBus to emit and listen to PlentyONE Shop events
-- Register cookies
-- React to cookie consent changes
+- [📚  Documentation](https://pwa-docs.plentyone.com/guide/modules/shop-core/)
 
 ## Quick Setup
 
@@ -18,12 +14,18 @@ npx nuxi module add @plentymarkets/shop-core
 
 ## Contribution
 
+To use the playground for developement and testing, follow these steps:
+- Rename `.env.example` to `.env` and set your API security token:
+```API_SECURITY_TOKEN="your-token-here"```
+- Adjust `playground/nuxt.config.ts` if needed.
+
+
 ```bash
 # Install dependencies
 npm install
 
-# Generate type stubs
-npm run dev:prepare
+# Build the module and prepare
+npm run go
 
 # Develop with the playground
 npm run dev
@@ -32,11 +34,18 @@ npm run dev
 npm run dev:build
 
 # Run ESLint
-npm run lint
+npm run lint:fix
 
-# Run Vitest
+# Run Prettier
+npm run format:fix
+
+# Run Vitest unit tests
 npm run test
 npm run test:watch
+
+# Run playwright E2E tests
+npm run test:e2e
+npm run test:e2e:dev
 ```
 
 <!-- Badges -->

package/dist/module.d.mts

@@ -1,19 +1,7 @@
 import * as _nuxt_schema from '@nuxt/schema';
+import { ModuleOptions } from '../dist/runtime/types/module.js';
 export { Cookie, CookieGroup, CookieGroupFromNuxtConfig, Events, JsonCookie, LocalizationMessage, Notification, PaymentButtonComponent, PaymentButtonComponentProps } from '../dist/runtime/types/index.js';
 
-interface ModuleOptions {
-    apiUrl: string;
-    apiEndpoint: string;
-    configId: number;
-    logger?: {
-        sdkPlugin?: {
-            enabled: boolean;
-            verbose: boolean;
-            serverOnly: boolean;
-        };
-    };
-}
 declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, ModuleOptions, false>;
 
 export { _default as default };
-export type { ModuleOptions };

package/dist/module.json

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

package/dist/module.mjs

@@ -80,6 +80,11 @@ const module$1 = defineNuxtModule({
       as: "useSdk",
       from: resolver.resolve("./runtime/composables/useSdk")
     });
+    addImports({
+      name: "useCsrfToken",
+      as: "useCsrfToken",
+      from: resolver.resolve("./runtime/composables/useCsrfToken")
+    });
     addImports({
       name: "useNotification",
       as: "useNotification",

package/dist/runtime/composables/localization/useEditorLocalizationLocales.d.ts

@@ -7,7 +7,6 @@ export declare const allLanguages: {
     es: string;
     tr: string;
     nl: string;
-    pl: string;
     pt: string;
     nn: string;
     ro: string;
@@ -15,6 +14,7 @@ export declare const allLanguages: {
     se: string;
     cz: string;
     ru: string;
+    pl: string;
     sk: string;
     cn: string;
     vn: string;
@@ -29,7 +29,6 @@ export declare const useEditorLocalizationLocales: () => {
         es: string;
         tr: string;
         nl: string;
-        pl: string;
         pt: string;
         nn: string;
         ro: string;
@@ -37,6 +36,7 @@ export declare const useEditorLocalizationLocales: () => {
         se: string;
         cz: string;
         ru: string;
+        pl: string;
         sk: string;
         cn: string;
         vn: string;

package/dist/runtime/composables/localization/useEditorLocalizationLocales.js

@@ -9,7 +9,6 @@ export const allLanguages = {
   es: "Spanish",
   tr: "Turkish",
   nl: "Dutch",
-  pl: "Polish",
   pt: "Portuguese",
   nn: "Norwegian",
   ro: "Romanian",
@@ -17,9 +16,10 @@ export const allLanguages = {
   se: "Swedish",
   cz: "Czech",
   ru: "Russian",
-  sk: "Slovak",
-  cn: "Chinese",
-  vn: "Vietnamese"
+  pl: "Polish (No Item Search)",
+  sk: "Slovak (No Item Search)",
+  cn: "Chinese (No Item Search)",
+  vn: "Vietnamese (No Item Search)"
   /*
   fi: 'Finnish',
   ga: 'Irish',

package/dist/runtime/composables/useNotification.js

@@ -1,5 +1,6 @@
 import { useState } from "nuxt/app";
-import { toRefs, onUnmounted, getCurrentInstance } from "vue";
+import { toRefs } from "vue";
+import { tryOnScopeDispose } from "@vueuse/core";
 const maxVisibleNotifications = 5;
 export const useNotification = (defaultDismissTimeout = 5e3) => {
   const state = useState(`useNotification`, () => ({
@@ -39,11 +40,9 @@ export const useNotification = (defaultDismissTimeout = 5e3) => {
     clearTimeouts();
     state.value.data = [];
   };
-  if (getCurrentInstance()) {
-    onUnmounted(() => {
-      clearTimeouts();
-    });
-  }
+  tryOnScopeDispose(() => {
+    clearTimeouts();
+  });
   return {
     send,
     clear,

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

@@ -3,3 +3,4 @@ export * from './events.js';
 export * from './render.js';
 export * from './notification.js';
 export * from './localization.js';
+export * from './module.js';

package/dist/runtime/types/index.js

@@ -3,3 +3,4 @@ export * from "./events.js";
 export * from "./render.js";
 export * from "./notification.js";
 export * from "./localization.js";
+export * from "./module.js";

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

@@ -0,0 +1,12 @@
+export interface ModuleOptions {
+    apiUrl: string;
+    apiEndpoint: string;
+    configId: number;
+    logger?: {
+        sdkPlugin?: {
+            enabled: boolean;
+            verbose: boolean;
+            serverOnly: boolean;
+        };
+    };
+}

package/dist/runtime/utils/sdk/sdk.client.js

@@ -1,5 +1,6 @@
 import axios from "axios";
 import { ApiError } from "@plentymarkets/shop-api";
+import { isServer } from "../runtime.js";
 export const handleHttpError = (error) => {
   const axiosError = error;
   const data = axiosError?.response?.data?.data || axiosError?.response?.data;
@@ -20,7 +21,7 @@ export const httpClient = async (url, params, config) => {
     if (response.headers["x-csrf-token"] && response.data) {
       response.data.csrfToken = response.headers["x-csrf-token"];
     }
-    if (import.meta.server && response.headers["set-cookie"] && response.data && typeof response.data === "object" && response.data !== null) {
+    if (isServer() && response.headers["set-cookie"] && response.data && typeof response.data === "object" && response.data !== null) {
       response.data.setCookie = response.headers["set-cookie"];
     }
     return response.data;

package/dist/types.d.mts

@@ -1,5 +1,9 @@
+import type { NuxtModule } from '@nuxt/schema'
+
+import type { default as Module } from './module.mjs'
+
+export type ModuleOptions = typeof Module extends NuxtModule<infer O> ? Partial<O> : Record<string, any>
+
 export { type Cookie, type CookieGroup, type CookieGroupFromNuxtConfig, type Events, type JsonCookie, type LocalizationMessage, type Notification, type PaymentButtonComponent, type PaymentButtonComponentProps } from '../dist/runtime/types/index.js'
 
 export { default } from './module.mjs'
-
-export { type ModuleOptions } from './module.mjs'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plentymarkets/shop-core",
-  "version": "1.17.1",
+  "version": "1.18.1",
   "description": "Core module for PlentyONE Shop",
   "repository": {
     "type": "git",
@@ -31,7 +31,9 @@
   "scripts": {
     "go": "npm run dev:prepare && npm run prepack",
     "prepack": "nuxt-module-build build",
-    "dev": "nuxi dev playground",
+    "dev": "concurrently -k -s first --names \"middleware,nuxt\" \"npm run middleware\" \"nuxi dev playground\"",
+    "start": "npm run dev:build && concurrently -k -s first --names \"middleware,nuxt\" \"npm run middleware\" \"nuxi start playground\"",
+    "middleware": "tsx playground/middleware-server.ts",
     "dev:build": "nuxi build playground",
     "dev:prepare": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxi prepare playground",
     "release": "npm run lint && npm run test && npm run prepack && changelogen --release && npm publish && git push --follow-tags",
@@ -42,7 +44,9 @@
     "test": "vitest run",
     "test:coverage": "vitest run --coverage",
     "test:watch": "vitest watch",
-    "test:types": "vue-tsc --noEmit"
+    "test:types": "vue-tsc --noEmit",
+    "test:e2e": "concurrently -k -s first --names \"server,playwright\" \"npm run start\" \"npx wait-on http-get://localhost:3000 && playwright test\"",
+    "test:e2e:dev": "concurrently -k -s first --names \"server,playwright\" \"npm run start\" \"npx wait-on http-get://localhost:3000 && playwright test --ui\""
   },
   "dependencies": {
     "@plentymarkets/shop-api": "^0.152.2",
@@ -56,6 +60,7 @@
     "prettier": "^3.6.2"
   },
   "devDependencies": {
+    "@testing-library/vue": "^8.1.0",
     "@nuxt/devtools": "^3.1.0",
     "@nuxt/eslint-config": "^0.7.6",
     "@nuxt/kit": "^4.1.3",
@@ -63,23 +68,30 @@
     "@nuxt/schema": "^4.1.3",
     "@nuxt/test-utils": "^3.19.0",
     "@nuxtjs/i18n": "9.5.4",
+    "@playwright/test": "^1.57.0",
     "@types/node": "latest",
     "@typescript-eslint/parser": "^8.47.0",
     "@vitest/coverage-v8": "^3.2.4",
+    "@vue-storefront/middleware": "5.4.1",
     "@vue/test-utils": "^2.4.6",
-    "changelogen": "^0.5.7",
+    "@vueuse/core": "^14.1.0",
+    "changelogen": "^0.6.2",
+    "concurrently": "^9.2.1",
+    "dotenv": "16.6.1",
     "eslint": "^9.24.0",
     "eslint-config-prettier": "^9.1.0",
-    "eslint-plugin-ceviz": "^0.0.4",
+    "eslint-plugin-ceviz": "^0.0.6",
     "eslint-plugin-vuejs-accessibility": "^2.4.1",
     "happy-dom": "^20.0.2",
-    "nuxi": "3.17.2",
+    "nuxi": "3.32.0",
     "nuxt": "^4.1.3",
     "prettier": "^3.6.2",
+    "tsx": "^4.21.0",
     "typescript": "~5.9.2",
     "typescript-eslint": "^8.47.0",
     "vitest": "^3.2.4",
     "vue-eslint-parser": "^10.2.0",
-    "vue-tsc": "^2.2.8"
+    "vue-tsc": "^2.2.8",
+    "wait-on": "^9.0.3"
   }
 }