@lilaquadrat/interfaces 1.13.0 → 1.14.1

package/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [1.14.1](https://github.com/lilaquadrat/interfaces/compare/v1.14.0...v1.14.1) (2024-12-28)
+
+## [1.14.0](https://github.com/lilaquadrat/interfaces/compare/v1.13.0...v1.14.0) (2024-12-17)
+
+
+### Features
+
+* **design customs & list:** design Custom Modules, Design Event, extended Lists ([1d079fe](https://github.com/lilaquadrat/interfaces/commit/1d079fec690f7c0fdede51c2b290968c1ecc77ae))
+
 ## [1.13.0](https://github.com/lilaquadrat/interfaces/compare/v1.12.0...v1.13.0) (2024-10-15)
 
 

package/lib/cjs/DesignCustomModule.d.ts

@@ -0,0 +1,10 @@
+export interface DesignCustomModule {
+    hint: string;
+    module: string;
+    name?: string;
+    description?: string;
+    additionalData?: {
+        name?: string;
+        description?: string;
+    };
+}

package/lib/cjs/DesignEvent.d.ts

@@ -0,0 +1,5 @@
+export interface DesignEvent {
+    name: string;
+    description?: string;
+    additionalData?: string;
+}

package/lib/cjs/List.d.ts

@@ -9,10 +9,10 @@ export interface List {
     project: string;
     name: string;
     description?: string;
-    mode: 'contact' | 'content' | 'reservation';
+    mode: 'contact' | 'content' | 'reservation' | 'shopping';
     start?: Date;
     end?: Date;
-    payment: 'optional' | 'required' | 'free';
+    payment?: 'optional' | 'required' | 'free';
     participants?: {
         max?: number;
         confirmed?: number;
@@ -20,10 +20,11 @@ export interface List {
         available?: number;
         unique?: boolean;
         addressRequired?: boolean;
+        totalPaid?: number;
     };
     state: 'open' | 'closed' | 'waiting';
     agreements: Agreement[];
-    categories: ListCategory[];
-    content: ListContent;
+    categories?: ListCategory[];
+    content?: ListContent;
     emails: EmailsContent;
 }

package/lib/cjs/ListContent.d.ts

@@ -4,4 +4,5 @@ export interface ListContent {
     waiting: string;
     active: string;
     post: string;
+    paid: string;
 }

package/lib/cjs/ListItem.d.ts

@@ -0,0 +1,7 @@
+export interface ListItem {
+    id: string;
+    name: string;
+    price?: number;
+    currency?: string;
+    quantity: number;
+}

package/lib/cjs/ListParticipants.d.ts

@@ -1,5 +1,6 @@
 import { ObjectId } from "mongodb";
 import { AgreementResponse } from "./AgreementResponse";
+import { ListItem } from "./ListItem";
 export interface ListParticipants {
     _id?: ObjectId;
     list: ObjectId;
@@ -16,6 +17,48 @@ export interface ListParticipants {
     note?: string;
     category?: string;
     explanation?: string;
-    state: 'unchecked' | 'notuseful' | 'confirmed' | 'enlisted' | 'reserved' | 'waiting' | 'blocked' | 'finalized';
+    /**
+    ```enlisted```
+  
+     customer has joined the list, but the owner did not confirm it
+  
+    ```confirmed```
+    
+    customer has joined the list and the owner did confirm it or the list does not required confirmation
+    
+    ```reserved```
+    
+    It implies that the customer has successfully secured a place on the list and is awaiting further instructions or actions.
+   
+    ```waiting```
+    
+    customer has joined the list and waits on action from the owner
+    
+    ```blocked```
+    
+    customer is not part of the list and cant join it
+    
+    ```finalized```
+    
+    the list entry has fulfilled his purpose and no further action is required
+    
+    ```notuseful```
+    
+    spam check has failed
+    
+    ```unchecked```
+    
+    spam check not concluded
+    
+    ```paid```
+    
+    payment webhook confirmed
+    */
+    state: 'unchecked' | 'paid' | 'notuseful' | 'confirmed' | 'enlisted' | 'reserved' | 'waiting' | 'blocked' | 'finalized';
     agreements: AgreementResponse[];
+    items?: ListItem[];
+    /**
+     * if the participants came from a payment webhook paid will have the amount of the whole payment
+     */
+    paid?: number;
 }

package/lib/cjs/index.d.ts

@@ -45,6 +45,8 @@ export * from './DataObject';
 export * from './DatabaseQuery';
 export * from './DatabaseQueryOptions';
 export * from './DatabaseQuerySites';
+export * from './DesignCustomModule';
+export * from './DesignEvent';
 export * from './DesignModule';
 export * from './Domain';
 export * from './DomainConf';
@@ -72,6 +74,7 @@ export * from './List';
 export * from './ListCategory';
 export * from './ListContent';
 export * from './ListCustomQueries';
+export * from './ListItem';
 export * from './ListOfModels';
 export * from './ListParticipantWithUser';
 export * from './ListParticipants';

package/lib/esm/DesignCustomModule.d.ts

@@ -0,0 +1,10 @@
+export interface DesignCustomModule {
+    hint: string;
+    module: string;
+    name?: string;
+    description?: string;
+    additionalData?: {
+        name?: string;
+        description?: string;
+    };
+}

package/lib/esm/DesignCustomModule.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=DesignCustomModule.js.map

package/lib/esm/DesignCustomModule.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DesignCustomModule.js","sourceRoot":"","sources":["../../src/DesignCustomModule.ts"],"names":[],"mappings":""}

package/lib/esm/DesignEvent.d.ts

@@ -0,0 +1,5 @@
+export interface DesignEvent {
+    name: string;
+    description?: string;
+    additionalData?: string;
+}

package/lib/esm/DesignEvent.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=DesignEvent.js.map

package/lib/esm/DesignEvent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DesignEvent.js","sourceRoot":"","sources":["../../src/DesignEvent.ts"],"names":[],"mappings":""}

package/lib/esm/List.d.ts

@@ -9,10 +9,10 @@ export interface List {
     project: string;
     name: string;
     description?: string;
-    mode: 'contact' | 'content' | 'reservation';
+    mode: 'contact' | 'content' | 'reservation' | 'shopping';
     start?: Date;
     end?: Date;
-    payment: 'optional' | 'required' | 'free';
+    payment?: 'optional' | 'required' | 'free';
     participants?: {
         max?: number;
         confirmed?: number;
@@ -20,10 +20,11 @@ export interface List {
         available?: number;
         unique?: boolean;
         addressRequired?: boolean;
+        totalPaid?: number;
     };
     state: 'open' | 'closed' | 'waiting';
     agreements: Agreement[];
-    categories: ListCategory[];
-    content: ListContent;
+    categories?: ListCategory[];
+    content?: ListContent;
     emails: EmailsContent;
 }

package/lib/esm/ListContent.d.ts

@@ -4,4 +4,5 @@ export interface ListContent {
     waiting: string;
     active: string;
     post: string;
+    paid: string;
 }

package/lib/esm/ListItem.d.ts

@@ -0,0 +1,7 @@
+export interface ListItem {
+    id: string;
+    name: string;
+    price?: number;
+    currency?: string;
+    quantity: number;
+}

package/lib/esm/ListItem.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ListItem.js.map

package/lib/esm/ListItem.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ListItem.js","sourceRoot":"","sources":["../../src/ListItem.ts"],"names":[],"mappings":""}

package/lib/esm/ListParticipants.d.ts

@@ -1,5 +1,6 @@
 import { ObjectId } from "mongodb";
 import { AgreementResponse } from "./AgreementResponse";
+import { ListItem } from "./ListItem";
 export interface ListParticipants {
     _id?: ObjectId;
     list: ObjectId;
@@ -16,6 +17,48 @@ export interface ListParticipants {
     note?: string;
     category?: string;
     explanation?: string;
-    state: 'unchecked' | 'notuseful' | 'confirmed' | 'enlisted' | 'reserved' | 'waiting' | 'blocked' | 'finalized';
+    /**
+    ```enlisted```
+  
+     customer has joined the list, but the owner did not confirm it
+  
+    ```confirmed```
+    
+    customer has joined the list and the owner did confirm it or the list does not required confirmation
+    
+    ```reserved```
+    
+    It implies that the customer has successfully secured a place on the list and is awaiting further instructions or actions.
+   
+    ```waiting```
+    
+    customer has joined the list and waits on action from the owner
+    
+    ```blocked```
+    
+    customer is not part of the list and cant join it
+    
+    ```finalized```
+    
+    the list entry has fulfilled his purpose and no further action is required
+    
+    ```notuseful```
+    
+    spam check has failed
+    
+    ```unchecked```
+    
+    spam check not concluded
+    
+    ```paid```
+    
+    payment webhook confirmed
+    */
+    state: 'unchecked' | 'paid' | 'notuseful' | 'confirmed' | 'enlisted' | 'reserved' | 'waiting' | 'blocked' | 'finalized';
     agreements: AgreementResponse[];
+    items?: ListItem[];
+    /**
+     * if the participants came from a payment webhook paid will have the amount of the whole payment
+     */
+    paid?: number;
 }

package/lib/esm/index.d.ts

@@ -45,6 +45,8 @@ export * from './DataObject';
 export * from './DatabaseQuery';
 export * from './DatabaseQueryOptions';
 export * from './DatabaseQuerySites';
+export * from './DesignCustomModule';
+export * from './DesignEvent';
 export * from './DesignModule';
 export * from './Domain';
 export * from './DomainConf';
@@ -72,6 +74,7 @@ export * from './List';
 export * from './ListCategory';
 export * from './ListContent';
 export * from './ListCustomQueries';
+export * from './ListItem';
 export * from './ListOfModels';
 export * from './ListParticipantWithUser';
 export * from './ListParticipants';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lilaquadrat/interfaces",
-  "version": "1.13.0",
+  "version": "1.14.1",
   "description": "interfaces in context of lilaquadrat STUDIO",
   "author": {
     "email": "m.schuebel@lila2.de",
@@ -31,7 +31,7 @@
     "@types/node": "^20.11.9",
     "ajv": "^8.12.0",
     "cz-conventional-changelog": "^3.3.0",
-    "mongodb": "^5.7.0",
+    "mongodb": "^5.9.2",
     "standard-version": "^9.5.0"
   },
   "config": {

package/src/DesignCustomModule.ts

@@ -0,0 +1,12 @@
+export interface DesignCustomModule {
+
+    hint: string
+    module: string
+    name?: string
+    description?: string
+    additionalData?: {
+        name?: string
+        description?: string
+    }
+
+}

package/src/DesignEvent.ts

@@ -0,0 +1,7 @@
+export interface DesignEvent {
+
+    name: string
+    description?: string
+    additionalData?: string
+
+}

package/src/List.ts

@@ -12,12 +12,12 @@ export interface List {
   
     name: string
     description?: string
-    mode: 'contact' | 'content' | 'reservation'
+    mode: 'contact' | 'content' | 'reservation' | 'shopping'
   
     start?: Date
     end?: Date
   
-    payment: 'optional' | 'required' | 'free'
+    payment?: 'optional' | 'required' | 'free'
   
     participants?: {
       max?: number
@@ -26,15 +26,16 @@ export interface List {
       available?: number
       unique?: boolean
       addressRequired?: boolean
+      totalPaid?: number
     }
   
     state: 'open' | 'closed' | 'waiting'
   
     agreements: Agreement[]
   
-    categories: ListCategory[]
+    categories?: ListCategory[]
 
-    content: ListContent
+    content?: ListContent
 
     emails: EmailsContent
   }

package/src/ListContent.ts

@@ -14,4 +14,7 @@ export interface ListContent {
 
     // the usage/event is fulfilled
     post: string
+
+    // the uses has paid via paymeny provider
+    paid: string
 }

package/src/ListItem.ts

@@ -0,0 +1,9 @@
+export interface ListItem {
+
+    id: string
+    name: string
+    price?: number
+    currency?: string
+    quantity: number
+
+}

package/src/ListParticipants.ts

@@ -1,5 +1,6 @@
 import { ObjectId } from "mongodb"
 import {AgreementResponse} from "./AgreementResponse"
+import { ListItem } from "./ListItem"
 
 export interface ListParticipants {
   _id?: ObjectId
@@ -24,15 +25,49 @@ export interface ListParticipants {
 
   explanation?: string
 
-  /*
-  enlisted = customer has joined the list, but the owner did not confirm it
-  confirmed = customer has joined the list and the owner did confirm it or the list does not required confirmation
-  reserved = It implies that the customer has successfully secured a place on the list and is awaiting further instructions or actions.
-  waiting = customer has joined the list and waits on action from the owner
-  blocked = customer is not part of the list and cant join it
-  finalized = the list entry has fulfilled his purpose and no further action is required
+  /**
+  ```enlisted```
+
+   customer has joined the list, but the owner did not confirm it
+
+  ```confirmed``` 
+  
+  customer has joined the list and the owner did confirm it or the list does not required confirmation
+  
+  ```reserved```
+  
+  It implies that the customer has successfully secured a place on the list and is awaiting further instructions or actions.
+ 
+  ```waiting```
+  
+  customer has joined the list and waits on action from the owner
+  
+  ```blocked```
+  
+  customer is not part of the list and cant join it
+  
+  ```finalized```
+  
+  the list entry has fulfilled his purpose and no further action is required
+  
+  ```notuseful```
+  
+  spam check has failed
+  
+  ```unchecked```
+  
+  spam check not concluded
+  
+  ```paid```
+  
+  payment webhook confirmed
   */
-  state: 'unchecked' | 'notuseful' | 'confirmed' | 'enlisted' | 'reserved' | 'waiting' | 'blocked' | 'finalized'
+  state: 'unchecked' | 'paid' | 'notuseful' | 'confirmed' | 'enlisted' | 'reserved' | 'waiting' | 'blocked' | 'finalized'
   agreements: AgreementResponse[]
+  items?: ListItem[]
+  /**
+   * if the participants came from a payment webhook paid will have the amount of the whole payment
+   */
+  paid?: number
 
 }