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

package/README.md

@@ -13,97 +13,21 @@ npm install @unchainedshop/core-enrollments
 
 ## Usage
 
-```typescript
-import { configureEnrollmentsModule, EnrollmentStatus } from '@unchainedshop/core-enrollments';
+The platform initializes this module as `platform.unchainedAPI.modules.enrollments`.
 
-const enrollmentsModule = await configureEnrollmentsModule({ db });
+```typescript
+import { EnrollmentStatus } from '@unchainedshop/core-enrollments';
 
-// Create an enrollment
-const enrollmentId = await enrollmentsModule.create({
+const { enrollments } = platform.unchainedAPI.modules;
+const activeEnrollments = await enrollments.findEnrollments({
+  status: [EnrollmentStatus.ACTIVE],
   userId: 'user-123',
-  productId: 'plan-product-456',
-  quantity: 1,
-});
-
-// Activate enrollment
-await enrollmentsModule.activate(enrollmentId);
-
-// Find active enrollments
-const enrollments = await enrollmentsModule.findEnrollments({
-  status: EnrollmentStatus.ACTIVE,
 });
 ```
 
-## API Overview
-
-### Module Configuration
-
-| Export | Description |
-|--------|-------------|
-| `configureEnrollmentsModule` | Configure and return the enrollments module |
-
-### Queries
-
-| Method | Description |
-|--------|-------------|
-| `findEnrollment` | Find enrollment by ID |
-| `findEnrollments` | Find enrollments with filtering and pagination |
-| `count` | Count enrollments matching query |
-| `enrollmentExists` | Check if enrollment exists |
-
-### Mutations
-
-| Method | Description |
-|--------|-------------|
-| `create` | Create a new enrollment |
-| `update` | Update enrollment data |
-| `delete` | Delete an enrollment |
-| `activate` | Activate an enrollment |
-| `terminate` | Terminate an enrollment |
-
-### Period Management
-
-| Method | Description |
-|--------|-------------|
-| `addPeriod` | Add a billing period |
-| `findPeriod` | Find a specific period |
-| `isExpired` | Check if enrollment is expired |
-
-### Utilities
-
-| Export | Description |
-|--------|-------------|
-| `addToDate` | Add time interval to date |
-
-### Constants
-
-| Export | Description |
-|--------|-------------|
-| `EnrollmentStatus` | Status values (INITIAL, ACTIVE, PAUSED, TERMINATED) |
-
-### Settings
-
-| Export | Description |
-|--------|-------------|
-| `enrollmentsSettings` | Access enrollment module settings |
-
-### Types
-
-| Export | Description |
-|--------|-------------|
-| `Enrollment` | Enrollment document type |
-| `EnrollmentPeriod` | Period document type |
-| `EnrollmentsModule` | Module interface type |
-
-## Events
+Status filters accept arrays. Enrollment lifecycle operations and recurring order generation are coordinated by `unchainedAPI.services.enrollments` and the registered enrollment and worker plugins. The module stores enrollments and their periods (`addEnrollmentPeriod`).
 
-| Event | Description |
-|-------|-------------|
-| `ENROLLMENT_CREATE` | Enrollment created |
-| `ENROLLMENT_UPDATE` | Enrollment updated |
-| `ENROLLMENT_REMOVE` | Enrollment deleted |
-| `ENROLLMENT_ACTIVATE` | Enrollment activated |
-| `ENROLLMENT_TERMINATE` | Enrollment terminated |
+See the [module guide](https://docs.unchained.shop/platform-configuration/modules/enrollments), [public exports](src/enrollments-index.ts), and [module implementation](src/module/configureEnrollmentsModule.ts).
 
 ## License
 

package/lib/db/EnrollmentsCollection.d.ts

@@ -7,7 +7,7 @@ export interface EnrollmentPeriod {
     isTrial?: boolean;
 }
 export interface EnrollmentPlan {
-    configuration: {
+    configuration?: {
         key: string;
         value: string;
     }[] | null;

package/lib/module/configureEnrollmentsModule.d.ts

@@ -18,6 +18,9 @@ export declare const configureEnrollmentsModule: ({ db, migrationRepository, opt
     } | {
         orderId: string;
     }, options?: mongodb.FindOptions) => Promise<Enrollment | null>;
+    findEnrollmentsByOrderIds: ({ orderIds }: {
+        orderIds: string[];
+    }, options?: mongodb.FindOptions) => Promise<Enrollment[]>;
     findEnrollments: ({ limit, offset, sort, ...query }: EnrollmentQuery & {
         limit?: number;
         offset?: number;

package/lib/module/configureEnrollmentsModule.js

@@ -111,6 +111,11 @@ export const configureEnrollmentsModule = async ({ db, migrationRepository, opti
             }
             return Enrollments.findOne({ 'periods.orderId': params.orderId, deleted: null }, options);
         },
+        findEnrollmentsByOrderIds: async ({ orderIds }, options) => {
+            if (!orderIds?.length)
+                return [];
+            return Enrollments.find({ 'periods.orderId': { $in: orderIds }, deleted: null }, options).toArray();
+        },
         findEnrollments: async ({ limit, offset, sort, ...query }) => {
             const defaultSortOption = [{ key: 'created', value: SortDirection.ASC }];
             const enrollments = Enrollments.find(buildFindSelector(query), {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@unchainedshop/core-enrollments",
   "description": "Subscription and recurring billing module for the Unchained Engine",
-  "version": "5.0.0-alpha.5",
+  "version": "5.0.0-alpha.8",
   "main": "lib/enrollments-index.js",
   "types": "lib/enrollments-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",