@haus-storefront-react/vendure-plugin-configs 0.0.49 → 0.0.52-1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@haus-storefront-react/vendure-plugin-configs",
-  "version": "0.0.49",
+  "version": "0.0.52-1",
   "main": "./index.js",
   "types": "./index.d.ts",
   "exports": {
@@ -41,8 +41,8 @@
     }
   },
   "dependencies": {
-    "@haus-storefront-react/common-utils": "0.0.49",
-    "@haus-storefront-react/core": "0.0.49",
-    "@haus-storefront-react/shared-types": "0.0.49"
+    "@haus-storefront-react/common-utils": "0.0.52-1",
+    "@haus-storefront-react/core": "0.0.52-1",
+    "@haus-storefront-react/shared-types": "0.0.52-1"
   }
 }

package/README.md

@@ -1,176 +0,0 @@
-# Vendure Plugin Configs
-
-This package provides a framework for creating and sharing plugin configurations for Vendure-based storefronts. Plugin configs allow you to extend the Vendure SDK with new features, queries, and type-safe entity augmentations—**only when you import the plugin**.
-
-## What is a Plugin Config?
-
-A plugin config is a TypeScript class that encapsulates:
-
-- Feature functions (e.g. `showBadges`)
-- Query/request extensions
-- Optional type augmentation for Vendure entities (e.g. adding `badges` to `Product`)
-
-## How to Create a Plugin Config
-
-1. **Create a new file** in `libs/plugin-configs/vendure/src/lib/`, e.g. `my-plugin.ts`.
-2. **Export a class or constant** that extends the base `VendurePluginConfig`.
-3. **(Optional) Add type augmentation** for Vendure entities by placing a `declare module` block in the same file.
-
-### Example: Badge Plugin
-
-```ts
-import {
-  Asset,
-  Collection,
-  ErrorResult,
-  Maybe,
-  PaginatedList,
-  Product,
-  ProductVariant,
-  SearchResult,
-} from '@haus-storefront-react/shared-types'
-import VendurePluginConfig from './plugin-config'
-import { filter } from 'lodash'
-
-// Type augmentation: Only active if this plugin is imported!
-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>>
-  }
-}
-
-export interface BadgePluginRequests {
-  getBadges: () => Promise<PaginatedList<Badge> | ErrorResult>
-}
-
-export type BadgeFeatures = {
-  showBadges: (props: {
-    product?: Product | SearchResult
-    variant?: ProductVariant
-    parentComponent?: string
-    badges: Maybe<Badge[]>
-  }) => { badges: Badge[]; availablePositions?: string[] }
-}
-
-export type Badge = {
-  id: string
-  createdAt: string
-  updatedAt: string
-  collection: Collection
-  collectionId: string
-  position: string
-  asset: Asset
-  assetId: string
-}
-
-export const VendureBadgePlugin = new VendurePluginConfig<BadgeFeatures, BadgePluginRequests>({
-  name: 'badges',
-  enableFeatures: {
-    showBadges: ({ badges = [], parentComponent }) => {
-      // ...implementation
-      return { badges: [], availablePositions: [] }
-    },
-  },
-  queryUpdates: {},
-  settings: {},
-})
-```
-
-## How to Use a Plugin Config in Your App
-
-1. **Import the plugin in your app:**
-   ```ts
-   import { VendureBadgePlugin } from '@haus-storefront-react/vendure-plugin-configs'
-   ```
-2. **Add it to your DataProvider/pluginConfigs:**
-   ```tsx
-   <DataProvider
-     provider="vendure"
-     options={{
-       // ...
-       pluginConfigs: [VendureBadgePlugin.init({ enableFeatures: ['showBadges'] })],
-     }}
-   >
-     {/* ... */}
-   </DataProvider>
-   ```
-3. **TypeScript will now know about `product.badges`!**
-
-### Example: Type-Safe Usage in a Component
-
-```tsx
-import { Product } from '@haus-storefront-react/shared-types'
-
-function ProductBadges({ product }: { product: Product }) {
-  if (!product.badges?.length) return null
-  return (
-    <div>
-      {product.badges.map((badge) => (
-        <span key={badge.id}>{badge.position}</span>
-      ))}
-    </div>
-  )
-}
-```
-
-**Note:** The type augmentation is _opt-in_: Only projects that import the plugin will see the new fields on `Product`, `SearchResult`, etc.
-
----
-
-## Creating a Plugin Config in an External App
-
-You can also create your own plugin config in an external app (outside this package). This is useful for app-specific features or experiments. See the example below, inspired by `test-plugin.ts`:
-
-### 1. Create your plugin config (e.g. `test-plugin.ts`):
-
-```ts
-import { VendurePluginConfig, PluginFeatures } from '@haus-storefront-react/vendure-plugin-configs'
-
-// Type augmentation: Adds testFeature to PluginFeatureMappings if this plugin is imported
-
-declare module '@haus-storefront-react/vendure-plugin-configs' {
-  interface PluginFeatureMappings {
-    testFeature: (props: { value: string }) => string
-  }
-}
-
-export const TestPlugin = new VendurePluginConfig<PluginFeatures>({
-  name: 'test',
-  enableFeatures: {
-    testFeature: ({ value }: { value: string }) => `Test feature says: ${value}`,
-  },
-  queryUpdates: {},
-  settings: {},
-})
-```
-
-### 2. Use your plugin config in your app:
-
-```tsx
-import { TestPlugin } from './plugin-configs/test-plugin'
-;<DataProvider
-  provider="vendure"
-  options={{
-    // ...
-    pluginConfigs: [TestPlugin.init({ enableFeatures: ['testFeature'] })],
-  }}
->
-  {/* ... */}
-</DataProvider>
-```
-
-- The `declare module` block ensures TypeScript is aware of your new feature when the plugin is imported.
-- You can add any features, queries, or type augmentations you need for your app.
-
----
-
-## Nx Commands
-
-- **Build:** `nx build plugin-configs/vendure`
-- **Test:** `nx test plugin-configs/vendure`