@unchainedshop/core-payment 5.0.0-alpha.5 → 5.0.0-alpha.8

package/README.md

@@ -13,117 +13,23 @@ npm install @unchainedshop/core-payment
 
 ## Usage
 
-```typescript
-import { configurePaymentModule, PaymentProviderType } from '@unchainedshop/core-payment';
-
-const paymentModule = await configurePaymentModule({ db });
+The platform initializes this module as `platform.unchainedAPI.modules.payment`. Register a payment plugin before platform startup; the base preset includes Invoice payment.
 
-// Create a payment provider
-const providerId = await paymentModule.create({
-  type: PaymentProviderType.CARD,
-  adapterKey: 'shop.unchained.payment.stripe',
-});
+```typescript
+import { PaymentProviderType } from '@unchainedshop/core-payment';
 
-// Find providers for a context
-const providers = await paymentModule.findSupported({
-  order: orderObject,
+const { payment } = platform.unchainedAPI.modules;
+const provider = await payment.paymentProviders.create({
+  type: PaymentProviderType.INVOICE,
+  adapterKey: 'shop.unchained.invoice',
+  configuration: [],
 });
+const providers = await payment.paymentProviders.findProviders({});
 ```
 
-## API Overview
-
-### Module Configuration
-
-| Export | Description |
-|--------|-------------|
-| `configurePaymentModule` | Configure and return the payment module |
-
-### Queries
-
-| Method | Description |
-|--------|-------------|
-| `findProvider` | Find provider by ID |
-| `findProviders` | Find providers with filtering |
-| `count` | Count providers |
-| `providerExists` | Check if provider exists |
-| `findSupported` | Find providers supported for context |
-| `findInterface` | Get provider interface definition |
-
-### Mutations
-
-| Method | Description |
-|--------|-------------|
-| `create` | Create a new payment provider |
-| `update` | Update provider configuration |
-| `delete` | Soft delete a provider |
-
-### Credentials
-
-| Method | Description |
-|--------|-------------|
-| `findCredentials` | Find stored credentials for user |
-| `createCredentials` | Store payment credentials |
-| `deleteCredentials` | Remove stored credentials |
-| `markPreferred` | Mark credentials as preferred |
-
-### Constants
-
-| Export | Description |
-|--------|-------------|
-| `PaymentProviderType` | Provider types (CARD, INVOICE, GENERIC) |
-
-### Settings
-
-| Export | Description |
-|--------|-------------|
-| `paymentSettings` | Access payment module settings |
-
-### Types
-
-| Export | Description |
-|--------|-------------|
-| `PaymentProvider` | Provider document type |
-| `PaymentCredentials` | Credentials document type |
-| `PaymentModule` | Module interface type |
-
-## Events
-
-| Event | Description |
-|-------|-------------|
-| `PAYMENT_PROVIDER_CREATE` | Provider created |
-| `PAYMENT_PROVIDER_UPDATE` | Provider updated |
-| `PAYMENT_PROVIDER_REMOVE` | Provider deleted |
-
-## Security (PCI DSS)
-
-This module is designed for **PCI DSS SAQ-A eligibility**:
-
-### Tokenization
-
-- **No card data storage**: Credit card numbers (PAN) and CVV are never stored
-- **Provider tokens only**: Only payment provider-issued tokens are stored
-- **Secure credentials**: Payment credentials contain references, not card data
-
-```typescript
-// PaymentCredentials structure - tokens only, no card data
-type PaymentCredentials = {
-  paymentProviderId: string;
-  userId: string;
-  token?: string;        // Provider-issued token (NOT card number)
-  isPreferred?: boolean;
-  meta: any;             // Provider-specific metadata
-};
-```
-
-### Payment Flow
-
-All payment integrations use tokenization patterns:
-1. Card data collected by payment provider (Stripe, Datatrans, etc.)
-2. Provider returns secure token
-3. Unchained stores only the token reference
-4. Subsequent charges use the token
+Provider records are managed by `paymentProviders`; stored credentials by `paymentCredentials`. Order services and payment adapters coordinate provider selection and charging. Payment integrations should store provider tokens and references rather than card data.
 
-See [SECURITY.md](../../SECURITY.md) for complete PCI DSS compliance documentation.
+See the [module guide](https://docs.unchained.shop/platform-configuration/modules/payment), [payment integration guide](https://docs.unchained.shop/guides/payment-integration), [public exports](src/payment-index.ts), and [module implementation](src/module/configurePaymentModule.ts).
 
 ## License
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@unchainedshop/core-payment",
   "description": "Payment provider management module for the Unchained Engine",
-  "version": "5.0.0-alpha.5",
+  "version": "5.0.0-alpha.8",
   "main": "lib/payment-index.js",
   "types": "lib/payment-index.d.ts",
   "type": "module",
@@ -35,9 +35,9 @@
   },
   "homepage": "https://github.com/unchainedshop/unchained#readme",
   "dependencies": {
-    "@unchainedshop/events": "^5.0.0-alpha.5",
-    "@unchainedshop/mongodb": "^5.0.0-alpha.5",
-    "@unchainedshop/utils": "^5.0.0-alpha.5"
+    "@unchainedshop/events": "^5.0.0-alpha.8",
+    "@unchainedshop/mongodb": "^5.0.0-alpha.8",
+    "@unchainedshop/utils": "^5.0.0-alpha.8"
   },
   "devDependencies": {
     "@types/node": "^26.2.0",