@scayle/storefront-product-detail 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 SCAYLE GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,78 @@
+# @scayle/storefront-product-detail
+
+<div align="center">
+  <img src="https://cdn-prod.scayle.com/public/media/general/SCAYLE-Commerce-Engine-header.png" />
+</div>
+
+<div align="center">
+  <h1>@scayle/storefront-product-detail</h1>
+</div>
+
+<div align="center">
+  <h4><a href="https://www.scayle.com/">Website</a></h4>
+</div>
+
+<div align="center">
+  A Nuxt module for product detail integration.
+</div>
+<br/>
+<div align="center">
+  <a href="https://www.npmjs.com/package/@scayle/storefront-product-detail"><img src="https://img.shields.io/npm/v/@scayle/storefront-product-detail/latest.svg?style=flat&colorB=007ec6" /></a>
+  <a href="https://www.npmjs.com/package/@scayle/storefront-product-detail"><img src="https://img.shields.io/npm/dm/@scayle/storefront-product-detail.svg?style=flat&colorB=007ec6" /></a>
+  <a href="https://www.npmjs.com/package/@scayle/storefront-product-detail"><img src="https://img.shields.io/badge/license-MIT-blue.svg" /></a>
+  <a href="https://nuxt.com"><img src="https://img.shields.io/badge/Nuxt-18181B?logo=nuxt.js" /></a>
+</div>
+
+## Installation
+
+```bash
+# Using pnpm
+pnpm add @scayle/storefront-product-detail
+
+# Using yarn
+yarn add @scayle/storefront-product-detail
+
+# Using npm
+npm install @scayle/storefront-product-detail
+```
+
+## Usage
+
+```ts
+export default defineNuxtConfig({
+  modules: ['@scayle/storefront-product-detail'],
+})
+```
+
+## Module Configuration
+
+## License
+
+Licensed under the [MIT License](https://opensource.org/license/mit/)
+
+## What is SCAYLE?
+
+[SCAYLE](https://scayle.com) is a full-featured e-commerce software solution that comes with flexible APIs.
+Within SCAYLE, you can manage all aspects of your shop, such as products, stocks, customers, and transactions.
+
+Learn more about [SCAYLE’s architecture](https://scayle.dev/en/getting-started) and commerce modules in the Docs.
+
+## Other channels
+
+- [LinkedIn](https://www.linkedin.com/company/scaylecommerce/)
+- [Jobs](https://careers.smartrecruiters.com/ABOUTYOUGmbH/scayle)
+
+<!-- Badges -->
+
+[npm-version-src]: https://img.shields.io/npm/v/@scayle/storefront-product-detail/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
+[npm-version-href]: https://npmjs.com/package/@scayle/storefront-product-detail
+[npm-downloads-src]: https://img.shields.io/npm/dm/@scayle/storefront-product-detail.svg?style=flat&colorA=18181B&colorB=28CF8D
+[npm-downloads-href]: https://npmjs.com/package/@scayle/storefront-product-detail
+[license-src]: https://img.shields.io/npm/l/@scayle/storefront-product-detail.svg?style=flat&colorA=18181B&colorB=28CF8D
+[license-href]: https://npmjs.com/package/@scayle/storefront-product-detail
+
+## License
+
+Licensed under the [MIT License](https://opensource.org/license/mit/)
+
+---

package/dist/module.cjs

@@ -0,0 +1,5 @@
+module.exports = function(...args) {
+  return import('./module.mjs').then(m => m.default.call(this, ...args))
+}
+const _meta = module.exports.meta = require('./module.json')
+module.exports.getMeta = () => Promise.resolve(_meta)

package/dist/module.d.mts

@@ -0,0 +1,8 @@
+import * as _nuxt_schema from '@nuxt/schema';
+
+interface ModuleOptions {
+    autoImports?: boolean;
+}
+declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, ModuleOptions, false>;
+
+export { _default as default };

package/dist/module.d.ts

@@ -0,0 +1,8 @@
+import * as _nuxt_schema from '@nuxt/schema';
+
+interface ModuleOptions {
+    autoImports?: boolean;
+}
+declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, ModuleOptions, false>;
+
+export { _default as default };

package/dist/module.json

@@ -0,0 +1,13 @@
+{
+  "name": "@scayle/storefront-product-detail",
+  "configKey": "product-detail",
+  "version": "0.0.1",
+  "compatibility": {
+    "bridge": false,
+    "nuxt": ">=3.13"
+  },
+  "builder": {
+    "@nuxt/module-builder": "0.8.4",
+    "unbuild": "2.0.0"
+  }
+}

package/dist/module.mjs

@@ -0,0 +1,24 @@
+import { defineNuxtModule, createResolver, addImportsDir } from '@nuxt/kit';
+
+const module = defineNuxtModule({
+  meta: {
+    name: "@scayle/storefront-product-detail",
+    configKey: "product-detail",
+    version: "0.0.1",
+    compatibility: {
+      bridge: false,
+      nuxt: ">=3.13"
+    }
+  },
+  defaults: {},
+  setup(options, nuxt) {
+    const { resolve } = createResolver(import.meta.url);
+    nuxt.options.alias["#storefront-product-detail"] = resolve("./runtime");
+    nuxt.options.build.transpile.push("#storefront-product-detail/runtime");
+    if (options.autoImports) {
+      addImportsDir(resolve("./runtime/utils"));
+    }
+  }
+});
+
+export { module as default };

package/dist/runtime/index.d.ts

@@ -0,0 +1 @@
+export * from './utils/product.js';

package/dist/runtime/index.js

@@ -0,0 +1 @@
+export * from "./utils/product.js";

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

@@ -0,0 +1,2 @@
+import { type AdvancedAttribute } from '@scayle/storefront-nuxt';
+export declare const getCombineWithProductIds: (attribute?: AdvancedAttribute) => number[];

package/dist/runtime/utils/product.js

@@ -0,0 +1,9 @@
+import {
+  getFlattenedAdvancedAttribute
+} from "@scayle/storefront-nuxt";
+export const getCombineWithProductIds = (attribute) => {
+  if (!attribute) {
+    return [];
+  }
+  return getFlattenedAdvancedAttribute(attribute.values)?.map((item) => Number.parseInt(item.value))?.filter((value) => !Number.isNaN(value)) || [];
+};

package/dist/runtime/utils/product.test.d.ts

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

package/dist/runtime/utils/product.test.js

@@ -0,0 +1,97 @@
+import { it, describe } from "vitest";
+import { getCombineWithProductIds } from "~/src/runtime/utils/product";
+import { advancedAttributeFactory } from "@scayle/storefront-nuxt";
+describe("getCombineWithProductIds", () => {
+  it("should return productIds from data", ({ expect }) => {
+    const combineWithAttribute = advancedAttributeFactory.build({
+      key: "combineWith",
+      label: "Kombiniere mit",
+      values: [
+        {
+          fieldSet: [
+            [
+              {
+                value: "206131"
+              }
+            ]
+          ],
+          groupSet: []
+        },
+        {
+          fieldSet: [
+            [
+              {
+                value: "206017"
+              }
+            ]
+          ],
+          groupSet: []
+        },
+        {
+          fieldSet: [
+            [
+              {
+                value: "206012"
+              }
+            ]
+          ],
+          groupSet: []
+        }
+      ]
+    });
+    expect(getCombineWithProductIds(combineWithAttribute)).toStrictEqual([
+      206131,
+      206017,
+      206012
+    ]);
+  });
+  it("should return empty array when attribute is not available", ({ expect }) => {
+    expect(getCombineWithProductIds(void 0)).toStrictEqual([]);
+  });
+  it("should return productIds ignore invalid data", ({ expect }) => {
+    const combineWithAttributeWithInvalidData = advancedAttributeFactory.build({
+      key: "combineWith",
+      label: "Kombiniere mit",
+      values: [
+        {
+          fieldSet: [
+            [
+              {
+                value: "206131"
+              }
+            ],
+            [
+              {
+                value: "TEST"
+              }
+            ]
+          ],
+          groupSet: []
+        },
+        {
+          fieldSet: [
+            [
+              {
+                value: "206017"
+              }
+            ]
+          ],
+          groupSet: []
+        },
+        {
+          fieldSet: [
+            [
+              {
+                value: "206012"
+              }
+            ]
+          ],
+          groupSet: []
+        }
+      ]
+    });
+    expect(
+      getCombineWithProductIds(combineWithAttributeWithInvalidData)
+    ).toStrictEqual([206131, 206017, 206012]);
+  });
+});

package/dist/types.d.mts

@@ -0,0 +1,7 @@
+import type { NuxtModule } from '@nuxt/schema'
+
+import type { default as Module } from './module.js'
+
+export type ModuleOptions = typeof Module extends NuxtModule<infer O> ? Partial<O> : Record<string, any>
+
+export { default } from './module.js'

package/dist/types.d.ts

@@ -0,0 +1,7 @@
+import type { NuxtModule } from '@nuxt/schema'
+
+import type { default as Module } from './module'
+
+export type ModuleOptions = typeof Module extends NuxtModule<infer O> ? Partial<O> : Record<string, any>
+
+export { default } from './module'

package/package.json

@@ -0,0 +1,70 @@
+{
+  "name": "@scayle/storefront-product-detail",
+  "version": "0.1.0",
+  "description": "Collection of essential composables and utilities to work with product detail",
+  "author": "SCAYLE Commerce Engine",
+  "license": "MIT",
+  "type": "module",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/types.d.ts",
+      "import": "./dist/module.mjs",
+      "require": "./dist/module.cjs"
+    }
+  },
+  "main": "./dist/module.cjs",
+  "types": "./dist/types.d.ts",
+  "files": [
+    "dist"
+  ],
+  "imports": {
+    "#storefront-product-detail": "./dist/runtime/index.js"
+  },
+  "scripts": {
+    "build": "nuxt-module-build build",
+    "dev": "nuxi dev playground",
+    "dev:build": "nuxi build playground",
+    "prep": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxi prepare playground",
+    "lint": "eslint . --format gitlab",
+    "lint:fix": "eslint . --fix",
+    "format": "dprint check",
+    "format:fix": "dprint fmt",
+    "test": "vitest --run --passWithNoTests",
+    "test:watch": "vitest --passWithNoTests",
+    "test:ci": "vitest --run --passWithNoTests --coverage --reporter=default --reporter=junit --outputFile=./junit.xml",
+    "typecheck": "vue-tsc --noEmit && cd playground && vue-tsc --noEmit",
+    "package:lint": "publint"
+  },
+  "peerDependencies": {
+    "@nuxt/kit": "^3.13.0",
+    "@scayle/storefront-nuxt": "^7.93.0",
+    "@vue/test-utils": "2.4.6",
+    "@vueuse/core": "11.2.0",
+    "vue-router": "4.4.5"
+  },
+  "devDependencies": {
+    "@nuxt/kit": "3.13.2",
+    "@nuxt/module-builder": "0.8.4",
+    "@nuxt/schema": "3.13.2",
+    "@nuxt/test-utils": "3.14.4",
+    "@scayle/eslint-config-storefront": "4.3.2",
+    "@scayle/storefront-nuxt": "7.94.0",
+    "@types/node": "22.9.0",
+    "@vue/test-utils": "2.4.6",
+    "@vueuse/core": "11.2.0",
+    "dprint": "0.47.5",
+    "eslint": "9.14.0",
+    "happy-dom": "15.11.0",
+    "eslint-formatter-gitlab": "5.1.0",
+    "nuxt": "3.13.2",
+    "publint": "0.2.12",
+    "typescript": "5.6.3",
+    "vitest": "2.1.4",
+    "vue-router": "4.4.5",
+    "vue-tsc": "2.1.10"
+  }
+}