@haus-storefront-react/vendure-plugin-configs 0.0.1

package/index.d.ts

@@ -0,0 +1 @@
+export * from './lib/plugin-config';

package/index.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./index-CzxpJe9c.js");exports.VendurePluginConfig=e.VendurePluginConfig;

package/index.mjs

@@ -0,0 +1,4 @@
+import { V as o } from "./index-RBMJ45wv.mjs";
+export {
+  o as VendurePluginConfig
+};

package/lib/configs/vendure-badge-plugin.augmentation.d.ts

@@ -0,0 +1,15 @@
+import { BadgeFeatures } from './vendure-badge-plugin.types';
+declare module '@haus-storefront-react/shared-types' {
+    interface Product {
+        badges?: Maybe<Array<Badge>>;
+    }
+    interface SearchResult {
+        badges?: Maybe<Array<Badge>>;
+    }
+    interface ProductVariant {
+        badges?: Maybe<Array<Badge>>;
+    }
+    interface PluginFeatureMappings {
+        showBadges: BadgeFeatures['showBadges'];
+    }
+}

package/lib/configs/vendure-badge-plugin.d.ts

@@ -0,0 +1,14 @@
+import { Asset, Collection } from '@haus-storefront-react/shared-types';
+import { VendurePluginConfig } from '../plugin-config';
+import { BadgeFeatures, BadgePluginRequests, BadgePluginSettings } from './vendure-badge-plugin.types';
+export declare const VendureBadgePlugin: VendurePluginConfig<BadgeFeatures, BadgePluginRequests, BadgePluginSettings, import('@haus-storefront-react/shared-types').IGraphQLSDK>;
+export type Badge = {
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    collection: Collection;
+    collectionId: string;
+    position: string;
+    asset: Asset;
+    assetId: string;
+};

package/lib/configs/vendure-badge-plugin.types.d.ts

@@ -0,0 +1,24 @@
+import { Badge, ErrorResult, Maybe, PaginatedList, Product, ProductVariant, SearchResult } from '@haus-storefront-react/shared-types';
+export interface BadgePluginRequests {
+    [key: string]: (...args: unknown[]) => unknown;
+    getBadges: () => Promise<PaginatedList<Badge> | ErrorResult>;
+}
+export interface BadgeFeatures {
+    showBadges: (props: {
+        product?: Product | SearchResult;
+        variant?: ProductVariant;
+        parentComponent?: keyof BadgePluginSettings['availablePositions'];
+        badges: Maybe<Badge[]>;
+    }) => {
+        badges: Badge[];
+        availablePositions?: string[];
+    };
+}
+export type BadgePluginSettings = {
+    defaultPositions: string[];
+    availablePositions: {
+        productListItem?: string[];
+        productDetail?: string[];
+        imageCarousel?: string[];
+    };
+};

package/lib/configs/vendure-campaign-plugin.augmentation.d.ts

@@ -0,0 +1,13 @@
+import { CampaignFeatures } from './vendure-campaign-plugin.types';
+declare module '@haus-storefront-react/shared-types' {
+    interface Product {
+        ordinaryPrice?: Price;
+    }
+    interface SearchResult {
+        ordinaryPrice?: Price;
+    }
+    interface PluginFeatureMappings {
+        showCampaignPrices: CampaignFeatures['showCampaignPrices'];
+        ordinaryPrice: CampaignFeatures['ordinaryPrice'];
+    }
+}

package/lib/configs/vendure-campaign-plugin.d.ts

@@ -0,0 +1,5 @@
+import { VendurePluginConfig } from '../plugin-config';
+import { CampaignFeatures } from './vendure-campaign-plugin.types';
+export declare const VendureCampaignPlugin: VendurePluginConfig<CampaignFeatures, Record<string, (...args: any[]) => any>, {
+    [x: string]: any;
+}, import('@haus-storefront-react/shared-types').IGraphQLSDK>;

package/lib/configs/vendure-campaign-plugin.types.d.ts

@@ -0,0 +1,19 @@
+import { OrderLine, Price, Product, ProductVariant, SearchResult } from '@haus-storefront-react/shared-types';
+export interface CampaignFeatures {
+    showCampaignPrices: boolean;
+    ordinaryPrice: (props: {
+        product?: Product;
+        searchResult?: SearchResult & {
+            ordinaryPrice?: Price;
+        };
+        variant?: ProductVariant & {
+            ordinaryPrice?: Price;
+        };
+        orderLine?: OrderLine & {
+            productVariant: ProductVariant & {
+                ordinaryPrice?: Price;
+            };
+        };
+        identifier?: string;
+    }) => Price;
+}

package/lib/configs/vendure-packagesize-plugin.augmentation.d.ts

@@ -0,0 +1,14 @@
+import { PackageSizeFeatures } from './vendure-packagesize-plugin.types';
+declare module '@haus-storefront-react/shared-types' {
+    interface Product {
+        packageSize?: number;
+    }
+    interface SearchResult {
+        packageSize?: number;
+    }
+    interface PluginFeatureMappings {
+        changeQuantityByPackageSize: PackageSizeFeatures['changeQuantityByPackageSize'];
+        showPackageSize: PackageSizeFeatures['showPackageSize'];
+        showCostPerPackage: PackageSizeFeatures['showCostPerPackage'];
+    }
+}

package/lib/configs/vendure-packagesize-plugin.d.ts

@@ -0,0 +1,23 @@
+import { VendurePluginConfig } from '../plugin-config';
+import { PackageSizeFeatures } from './vendure-packagesize-plugin.types';
+/**
+ * Instance of `VendurePluginConfig` configured for the `packageSize` plugin.
+ * This setup initializes the plugin with its specific name and an empty array of enabled features,
+ * indicating that no additional features are enabled by default. It also provides an empty object for
+ * query updates, which can be customized as needed.
+ *
+ * Usage:
+ * To enable features, you can modify the `enableFeatures` array during instantiation or use the `init` method
+ * to update it later. For example, to enable the `changeQuantityByPackageSize` feature, you would pass
+ * `['changeQuantityByPackageSize']` as the value for `enableFeatures` in the configuration object.
+ *
+ * @example
+ * const VendurePackageSizePlugin = new VendurePluginConfig<PackageSizeFeatures>({
+ *   name: 'packageSize',
+ *   enableFeatures: ['changeQuantityByPackageSize'], // Enable specific features here
+ *   queryUpdates: {},
+ * });
+ */
+export declare const VendurePackageSizePlugin: VendurePluginConfig<PackageSizeFeatures, Record<string, (...args: any[]) => any>, {
+    [x: string]: any;
+}, import('@haus-storefront-react/shared-types').IGraphQLSDK>;

package/lib/configs/vendure-packagesize-plugin.types.d.ts

@@ -0,0 +1,27 @@
+import { Product, ProductVariant, SearchResult } from '@haus-storefront-react/shared-types';
+/**
+ * Represents the specific features available for the `packageSize` plugin.
+ * These features can be enabled individually to customize the behavior of the plugin.
+ *
+ * @type {('changeQuantityByPackageSize' | 'showPackageSize')}
+ *
+ * - `changeQuantityByPackageSize`: Enables functionality to adjust product quantities based on package size.
+ * - `showPackageSize`: Allows the display of package sizes in product details.
+ */
+export type PackageSizeFeatures = {
+    changeQuantityByPackageSize: (props: {
+        product?: Product | SearchResult;
+        variant?: ProductVariant;
+        identifier: string;
+    }) => boolean;
+    showPackageSize: (props: {
+        product?: Product | SearchResult;
+        variant?: ProductVariant;
+        identifier: string;
+    }) => boolean;
+    showCostPerPackage: (props: {
+        product?: Product | SearchResult;
+        variant?: ProductVariant;
+        identifier: string;
+    }) => boolean;
+};

package/lib/configs/vendure-product-popularity-plugin.augmentation.d.ts

@@ -0,0 +1,12 @@
+import { ProductPopularityFeatures } from './vendure-product-popularity-plugin.types';
+declare module '@haus-storefront-react/shared-types' {
+    interface Product {
+        popularity?: number;
+    }
+    interface SearchResult {
+        popularity?: number;
+    }
+    interface PluginFeatureMappings {
+        sortByPopularity: ProductPopularityFeatures['sortByPopularity'];
+    }
+}

package/lib/configs/vendure-product-popularity-plugin.d.ts

@@ -0,0 +1,32 @@
+import { VendurePluginConfig } from '../plugin-config';
+import { ProductPopularityFeatures } from './vendure-product-popularity-plugin.types';
+/**
+ * Represents the specific features available for the `productPopularity` plugin.
+ * These features can be enabled individually to customize the behavior of the plugin.
+ *
+ * @type {('sortByPopularity')}
+ *
+ * - `changeQuantityByPackageSize`: Enables functionality to adjust product quantities based on package size.
+ * - `showPackageSize`: Allows the display of package sizes in product details.
+ */
+/**
+ * Instance of `VendurePluginConfig` configured for the `packageSize` plugin.
+ * This setup initializes the plugin with its specific name and an empty array of enabled features,
+ * indicating that no additional features are enabled by default. It also provides an empty object for
+ * query updates, which can be customized as needed.
+ *
+ * Usage:
+ * To enable features, you can modify the `enableFeatures` array during instantiation or use the `init` method
+ * to update it later. For example, to enable the `changeQuantityByPackageSize` feature, you would pass
+ * `['changeQuantityByPackageSize']` as the value for `enableFeatures` in the configuration object.
+ *
+ * @example
+ * const VendurePackageSizePlugin = new VendurePluginConfig<PackageSizeFeatures>({
+ *   name: 'packageSize',
+ *   enableFeatures: ['changeQuantityByPackageSize'], // Enable specific features here
+ *   queryUpdates: {},
+ * });
+ */
+export declare const VendureProductPopularityPlugin: VendurePluginConfig<ProductPopularityFeatures, Record<string, (...args: any[]) => any>, {
+    [x: string]: any;
+}, import('@haus-storefront-react/shared-types').IGraphQLSDK>;

package/lib/configs/vendure-product-popularity-plugin.types.d.ts

@@ -0,0 +1,3 @@
+export type ProductPopularityFeatures = {
+    sortByPopularity: boolean;
+};

package/lib/exports/augmentations.d.ts

@@ -0,0 +1,4 @@
+export * from '../configs/vendure-badge-plugin.augmentation';
+export * from '../configs/vendure-campaign-plugin.augmentation';
+export * from '../configs/vendure-packagesize-plugin.augmentation';
+export * from '../configs/vendure-product-popularity-plugin.augmentation';

package/lib/exports/badge.d.ts

@@ -0,0 +1 @@
+export * from '../configs/vendure-badge-plugin';

package/lib/exports/campaign.d.ts

@@ -0,0 +1 @@
+export * from '../configs/vendure-campaign-plugin';

package/lib/exports/packagesize.d.ts

@@ -0,0 +1 @@
+export * from '../configs/vendure-packagesize-plugin';

package/lib/exports/product-popularity.d.ts

@@ -0,0 +1 @@
+export * from '../configs/vendure-product-popularity-plugin';

package/lib/plugin-config.d.ts

@@ -0,0 +1,63 @@
+import { BuilderQueryUpdates, IVendurePluginConfig, PluginFeatures, ProviderDataMap, IGraphQLSDK } from '@haus-storefront-react/shared-types';
+type PluginSettings = Record<string, any>;
+export type VendurePluginConfigInput<Features, R, S> = {
+    name: string;
+    enabled?: boolean;
+    enableFeatures?: Partial<Record<keyof Features, boolean>> | Partial<Features>;
+    queryUpdates: BuilderQueryUpdates;
+    requests?: R;
+    providers?: ProviderDataMap;
+    settings?: S;
+};
+export declare class VendurePluginConfig<Features extends PluginFeatures = PluginFeatures, R extends Record<string, (...args: any[]) => any> = Record<string, (...args: any[]) => any>, S extends PluginSettings = PluginSettings, T extends IGraphQLSDK = IGraphQLSDK> implements IVendurePluginConfig<Features, R, S, T> {
+    sdk: T;
+    name: IVendurePluginConfig<Features, R, S, T>['name'];
+    enabled: boolean;
+    enableFeatures: IVendurePluginConfig<Features, R, S, T>['enableFeatures'] | undefined;
+    queryUpdates: BuilderQueryUpdates;
+    requests: R;
+    providers: IVendurePluginConfig<Features, R, S, T>['providers'];
+    settings: S;
+    constructor(config: VendurePluginConfigInput<Features, R, S>);
+    /**
+     * Initializes the plugin configuration with a specified set of features.
+     * This method allows dynamically setting the features that should be enabled for the plugin.
+     *
+     * For the `packageSize` plugin, the available features to enable are:
+     * - `changeQuantityByPackageSize`: Allows changing the quantity of products based on their package size.
+     * - `showPackageSize`: Enables the display of package sizes in product details.
+     *
+     * @param {Pick<IVendurePluginConfig<Features>, 'enableFeatures'>} config An object specifying the features to enable.
+     * @returns {VendurePluginConfig<Features>} Returns the current instance of `VendurePluginConfig`, enabling method chaining.
+     */
+    init(config: Pick<IVendurePluginConfig<Features, R, S, T>, 'enableFeatures' | 'settings'> & {
+        enableFeatures?: Partial<Record<keyof Features, boolean>> | Partial<Features> | Array<keyof Features>;
+    }): VendurePluginConfig<Features, R, S, T>;
+    setSdk(sdk: T): void;
+    getSdk(): T;
+    getName(): string;
+    isEnabled(): boolean;
+    setEnabled(enabled: boolean): void;
+    setQueryUpdates(queryUpdates: BuilderQueryUpdates): void;
+    getQueryUpdates(): BuilderQueryUpdates;
+    setRequests(requests: R): void;
+    getRequests(): R;
+    setProviders(providers: IVendurePluginConfig<Features, R, S, T>['providers']): void;
+    getProviders(): ProviderDataMap;
+    setSettings(settings: S): void;
+    getSettings(): S;
+    setEnableFeatures(enableFeatures: Partial<Record<keyof Features, boolean>> | Partial<Features>): void;
+    getEnabled(): boolean;
+    getEnabledFeatures(): {};
+}
+/**
+ * Extraherar alla enabled features från en array av pluginConfigs.
+ * Används för att få typ-automatik i SDK/getFeature.
+ */
+export type ExtractEnabledFeatures<T extends readonly any[]> = T[number] extends {
+    getEnabledFeatures: () => infer F;
+} ? keyof F : never;
+export type EnabledFeaturesMap<T extends readonly any[]> = {
+    [K in ExtractEnabledFeatures<T>]: boolean;
+};
+export {};

package/lib/types.d.ts

@@ -0,0 +1,2 @@
+export * from './configs/vendure-badge-plugin.types';
+export * from './configs/vendure-product-popularity-plugin.types';

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@haus-storefront-react/vendure-plugin-configs",
+  "version": "0.0.1",
+  "main": "./index.js",
+  "types": "./index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./index.mjs",
+      "require": "./index.js"
+    },
+    "./augmentations": {
+      "types": "./lib/exports/augmentations.d.ts",
+      "import": "./augmentations.mjs",
+      "require": "./augmentations.js"
+    },
+    "./badge": {
+      "types": "./lib/exports/badge.d.ts",
+      "import": "./badge.mjs",
+      "require": "./badge.js"
+    },
+    "./campaign": {
+      "types": "./lib/exports/campaign.d.ts",
+      "import": "./campaign.mjs",
+      "require": "./campaign.js"
+    },
+    "./packagesize": {
+      "types": "./lib/exports/packagesize.d.ts",
+      "import": "./packagesize.mjs",
+      "require": "./packagesize.js"
+    },
+    "./product-popularity": {
+      "types": "./lib/exports/product-popularity.d.ts",
+      "import": "./product-popularity.mjs",
+      "require": "./product-popularity.js"
+    }
+  },
+  "dependencies": {
+    "@haus-storefront-react/common-utils": "0.0.7-0",
+    "@haus-storefront-react/shared-types": "0.0.7-0"
+  }
+}

package/packagesize.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const a=require("./index-CzxpJe9c.js"),e=new a.VendurePluginConfig({name:"packageSize",enableFeatures:{},queryUpdates:{}});e.setQueryUpdates({activeOrder:{fields:[{lines:[{productVariant:["packageSize"]}]}]},orderByCode:{fields:[{lines:[{productVariant:["packageSize"]}]}]},product:{fields:[{variants:["packageSize"]}]},briefProducts:{fields:[{items:[{variants:["packageSize"]}]}]},adjustOrderLine:{fields:[{fields:[{lines:[{productVariant:["packageSize"]}]}]}]},addItemToOrder:{fields:[{fields:[{lines:[{productVariant:["packageSize"]}]}]}]}});exports.VendurePackageSizePlugin=e;

package/packagesize.mjs

@@ -0,0 +1,61 @@
+import { V as e } from "./index-RBMJ45wv.mjs";
+const a = new e({
+  name: "packageSize",
+  enableFeatures: {},
+  queryUpdates: {}
+});
+a.setQueryUpdates({
+  activeOrder: {
+    fields: [{
+      lines: [{
+        productVariant: ["packageSize"]
+        // TODO: add packageSizeUnit
+      }]
+    }]
+  },
+  orderByCode: {
+    fields: [{
+      lines: [{
+        productVariant: ["packageSize"]
+        // TODO: add packageSizeUnit
+      }]
+    }]
+  },
+  product: {
+    fields: [{
+      variants: ["packageSize"]
+      // TODO: add packageSizeUnit
+    }]
+  },
+  briefProducts: {
+    fields: [{
+      items: [{
+        variants: ["packageSize"]
+        // TODO: add packageSizeUnit
+      }]
+    }]
+  },
+  adjustOrderLine: {
+    fields: [{
+      fields: [{
+        lines: [{
+          productVariant: ["packageSize"]
+          // TODO: add packageSizeUnit
+        }]
+      }]
+    }]
+  },
+  addItemToOrder: {
+    fields: [{
+      fields: [{
+        lines: [{
+          productVariant: ["packageSize"]
+          // TODO: add packageSizeUnit
+        }]
+      }]
+    }]
+  }
+});
+export {
+  a as VendurePackageSizePlugin
+};

package/product-popularity.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const r=require("./index-CzxpJe9c.js"),e=new r.VendurePluginConfig({name:"productPopularity",enableFeatures:{},queryUpdates:{}});e.setQueryUpdates({product:{fields:["popularity"]},search:{fields:[{items:["popularity"]}]},searchField:{fields:[{items:["popularity"]}]}});exports.VendureProductPopularityPlugin=e;

package/product-popularity.mjs

@@ -0,0 +1,24 @@
+import { V as e } from "./index-RBMJ45wv.mjs";
+const r = new e({
+  name: "productPopularity",
+  enableFeatures: {},
+  queryUpdates: {}
+});
+r.setQueryUpdates({
+  product: {
+    fields: ["popularity"]
+  },
+  search: {
+    fields: [{
+      items: ["popularity"]
+    }]
+  },
+  searchField: {
+    fields: [{
+      items: ["popularity"]
+    }]
+  }
+});
+export {
+  r as VendureProductPopularityPlugin
+};