@lilaquadrat/interfaces 1.21.1 → 1.23.0

package/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 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.23.0](https://github.com/lilaquadrat/interfaces/compare/v1.22.0...v1.23.0) (2025-04-01)
+
+
+### Features
+
+* **cart:** add Cart and CartItem interfaces; update ListCategory and ListItem structures ([bb17d2e](https://github.com/lilaquadrat/interfaces/commit/bb17d2e9ffc841ea12faddc87f86b8646cafe07b))
+
+## [1.22.0](https://github.com/lilaquadrat/interfaces/compare/v1.21.1...v1.22.0) (2025-03-27)
+
+
+### Features
+
+* **listsparticipants & customers:** extended for structures ([c222a3f](https://github.com/lilaquadrat/interfaces/commit/c222a3f5ece6e49b054b0c8063821a486dbb55d2))
+
 ### [1.21.1](https://github.com/lilaquadrat/interfaces/compare/v1.21.0...v1.21.1) (2025-03-25)
 
 

package/lib/cjs/Cart.d.ts

@@ -0,0 +1,12 @@
+import { CartItem } from "./CartItem";
+export interface Cart {
+    items?: CartItem[];
+    state: 'open' | 'closed' | 'checkout';
+    company: string;
+    project: string;
+    attributes?: {
+        [key: string]: string;
+    };
+    modified?: Date;
+    checkoutUrl?: string;
+}

package/lib/cjs/CartItem.d.ts

@@ -0,0 +1,5 @@
+import { ListCategory } from "./ListCategory";
+export interface CartItem extends ListCategory {
+    id: string;
+    quantity: number;
+}

package/lib/cjs/CustomerBase.d.ts

@@ -1,4 +1,5 @@
-export interface CustomerBase {
+import { WithStructures } from "./WithStructures";
+export interface CustomerBase extends WithStructures {
     type?: 'person' | 'company';
     id?: string;
     email?: string;

package/lib/cjs/ListCategory.d.ts

@@ -1,8 +1,10 @@
+import { ObjectId } from "mongodb";
 import Price from "./Price";
 export interface ListCategory {
-    id: string;
+    _id: ObjectId;
     name: string;
     description?: string;
+    externalId?: string;
     amount?: number;
     disabled?: boolean;
     price?: Price;

package/lib/cjs/ListItem.d.ts

@@ -1,5 +1,6 @@
 export interface ListItem {
-    id: string;
+    id?: string;
+    _id?: string;
     name: string;
     price?: number;
     currency?: string;

package/lib/cjs/ListParticipants.d.ts

@@ -1,6 +1,7 @@
 import { ObjectId } from "mongodb";
 import { AgreementResponse } from "./AgreementResponse";
-export interface ListParticipants {
+import { WithStructures } from "./WithStructures";
+export interface ListParticipants extends WithStructures {
     _id?: ObjectId;
     list: ObjectId;
     company: string;

package/lib/cjs/Payment.d.ts

@@ -12,4 +12,5 @@ export interface Payment {
     customer: ObjectId;
     webhook?: ObjectId;
     items?: ListItem[];
+    additionalData?: Record<string, string>;
 }

package/lib/cjs/PaymentProvider.d.ts

@@ -1,5 +1,5 @@
 export interface PaymentProvider {
-    type: 'shopify';
+    type: 'shopify' | 'stripe';
     active: boolean;
     label: string;
 }

package/lib/cjs/PaymentProviderStripe.d.ts

@@ -0,0 +1,6 @@
+import { PaymentProvider } from "./PaymentProvider";
+export interface PaymentProviderStripe extends PaymentProvider {
+    type: 'stripe';
+    token: string;
+    validationKey: string;
+}

package/lib/cjs/WithStructures.d.ts

@@ -0,0 +1,21 @@
+import { Structure } from "./Structure";
+/**
+ * Base interface containing only the standard properties
+ */
+interface BaseWithStructures {
+    structures?: Structure[];
+}
+/**
+ * A utility type that can be extended by any interface to support
+ * dynamic properties with keys prefixed with 's-'
+ *
+ * @example
+ * interface MyInterface extends WithStructures {
+ *   name: string;
+ *   // MyInterface now supports s- prefixed dynamic properties
+ * }
+ */
+export type WithStructures = BaseWithStructures & Partial<{
+    [key: `s-${string}`]: string | boolean | number | Array<string>;
+}>;
+export {};

package/lib/cjs/index.d.ts

@@ -18,6 +18,8 @@ export * from './BaseFilterOptions';
 export * from './BasicData';
 export * from './BasicDataDatabase';
 export * from './CallResponse';
+export * from './Cart';
+export * from './CartItem';
 export * from './CategoryStructure';
 export * from './CategoryStructureWithRequired';
 export * from './Certificate';
@@ -108,7 +110,8 @@ export * from './Options';
 export * from './Partner';
 export * from './Payment';
 export * from './PaymentProvider';
-export * from './PaymentProviderShopify ';
+export * from './PaymentProviderShopify';
+export * from './PaymentProviderStripe';
 export * from './PaymentWithCustomer';
 export * from './Permissions';
 export * from './PermissionsWithScope';
@@ -147,4 +150,5 @@ export * from './UserAppOptionsRequired';
 export * from './UserAppWithOptions';
 export * from './VersionInfo';
 export * from './WebhookCall';
-export * from './WildcardCertificates';
+export * from './WildcardCertificates';
+export * from './WithStructures';

package/lib/esm/Cart.d.ts

@@ -0,0 +1,12 @@
+import { CartItem } from "./CartItem";
+export interface Cart {
+    items?: CartItem[];
+    state: 'open' | 'closed' | 'checkout';
+    company: string;
+    project: string;
+    attributes?: {
+        [key: string]: string;
+    };
+    modified?: Date;
+    checkoutUrl?: string;
+}

package/lib/esm/Cart.js

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

package/lib/esm/Cart.js.map

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

package/lib/esm/CartItem.d.ts

@@ -0,0 +1,5 @@
+import { ListCategory } from "./ListCategory";
+export interface CartItem extends ListCategory {
+    id: string;
+    quantity: number;
+}

package/lib/esm/CartItem.js

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

package/lib/esm/CartItem.js.map

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

package/lib/esm/CustomerBase.d.ts

@@ -1,4 +1,5 @@
-export interface CustomerBase {
+import { WithStructures } from "./WithStructures";
+export interface CustomerBase extends WithStructures {
     type?: 'person' | 'company';
     id?: string;
     email?: string;

package/lib/esm/ListCategory.d.ts

@@ -1,8 +1,10 @@
+import { ObjectId } from "mongodb";
 import Price from "./Price";
 export interface ListCategory {
-    id: string;
+    _id: ObjectId;
     name: string;
     description?: string;
+    externalId?: string;
     amount?: number;
     disabled?: boolean;
     price?: Price;

package/lib/esm/ListItem.d.ts

@@ -1,5 +1,6 @@
 export interface ListItem {
-    id: string;
+    id?: string;
+    _id?: string;
     name: string;
     price?: number;
     currency?: string;

package/lib/esm/ListParticipants.d.ts

@@ -1,6 +1,7 @@
 import { ObjectId } from "mongodb";
 import { AgreementResponse } from "./AgreementResponse";
-export interface ListParticipants {
+import { WithStructures } from "./WithStructures";
+export interface ListParticipants extends WithStructures {
     _id?: ObjectId;
     list: ObjectId;
     company: string;

package/lib/esm/Payment.d.ts

@@ -12,4 +12,5 @@ export interface Payment {
     customer: ObjectId;
     webhook?: ObjectId;
     items?: ListItem[];
+    additionalData?: Record<string, string>;
 }

package/lib/esm/PaymentProvider.d.ts

@@ -1,5 +1,5 @@
 export interface PaymentProvider {
-    type: 'shopify';
+    type: 'shopify' | 'stripe';
     active: boolean;
     label: string;
 }

package/lib/esm/PaymentProviderShopify.js

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

package/lib/esm/PaymentProviderShopify.js.map

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

package/lib/esm/PaymentProviderStripe.d.ts

@@ -0,0 +1,6 @@
+import { PaymentProvider } from "./PaymentProvider";
+export interface PaymentProviderStripe extends PaymentProvider {
+    type: 'stripe';
+    token: string;
+    validationKey: string;
+}

package/lib/esm/PaymentProviderStripe.js

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

package/lib/esm/PaymentProviderStripe.js.map

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

package/lib/esm/WithStructures.d.ts

@@ -0,0 +1,21 @@
+import { Structure } from "./Structure";
+/**
+ * Base interface containing only the standard properties
+ */
+interface BaseWithStructures {
+    structures?: Structure[];
+}
+/**
+ * A utility type that can be extended by any interface to support
+ * dynamic properties with keys prefixed with 's-'
+ *
+ * @example
+ * interface MyInterface extends WithStructures {
+ *   name: string;
+ *   // MyInterface now supports s- prefixed dynamic properties
+ * }
+ */
+export type WithStructures = BaseWithStructures & Partial<{
+    [key: `s-${string}`]: string | boolean | number | Array<string>;
+}>;
+export {};

package/lib/esm/WithStructures.js

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

package/lib/esm/WithStructures.js.map

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

package/lib/esm/index.d.ts

@@ -18,6 +18,8 @@ export * from './BaseFilterOptions';
 export * from './BasicData';
 export * from './BasicDataDatabase';
 export * from './CallResponse';
+export * from './Cart';
+export * from './CartItem';
 export * from './CategoryStructure';
 export * from './CategoryStructureWithRequired';
 export * from './Certificate';
@@ -108,7 +110,8 @@ export * from './Options';
 export * from './Partner';
 export * from './Payment';
 export * from './PaymentProvider';
-export * from './PaymentProviderShopify ';
+export * from './PaymentProviderShopify';
+export * from './PaymentProviderStripe';
 export * from './PaymentWithCustomer';
 export * from './Permissions';
 export * from './PermissionsWithScope';
@@ -147,4 +150,5 @@ export * from './UserAppOptionsRequired';
 export * from './UserAppWithOptions';
 export * from './VersionInfo';
 export * from './WebhookCall';
-export * from './WildcardCertificates';
+export * from './WildcardCertificates';
+export * from './WithStructures';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lilaquadrat/interfaces",
-  "version": "1.21.1",
+  "version": "1.23.0",
   "description": "interfaces in context of lilaquadrat STUDIO",
   "author": {
     "email": "m.schuebel@lila2.de",

package/src/Cart.ts

@@ -0,0 +1,20 @@
+import { CartItem } from "./CartItem"
+
+export interface Cart {
+
+    items?: CartItem[]
+
+    state: 'open' | 'closed' | 'checkout'
+
+    company: string
+    project: string
+
+    attributes?: {
+        [key: string]: string
+    }
+
+    modified?: Date
+
+    checkoutUrl?: string
+    
+}

package/src/CartItem.ts

@@ -0,0 +1,8 @@
+import { ListCategory } from "./ListCategory"
+
+export interface CartItem extends ListCategory {
+
+    id: string
+    quantity: number
+
+}

package/src/CustomerBase.ts

@@ -1,4 +1,6 @@
-export interface CustomerBase {
+import { WithStructures } from "./WithStructures"
+
+export interface CustomerBase extends WithStructures {
 
   type?: 'person' | 'company'
 

package/src/ListCategory.ts

@@ -1,10 +1,12 @@
+import { ObjectId } from "mongodb";
 import Price from "./Price";
 
 export interface ListCategory {
 
-  id: string;
+  _id: ObjectId;
   name: string
   description?: string
+  externalId?: string
   amount?: number
   disabled?: boolean
   price?: Price

package/src/ListItem.ts

@@ -1,6 +1,7 @@
 export interface ListItem {
 
-    id: string
+    id?: string
+    _id?: string
     name: string
     price?: number
     currency?: string

package/src/ListParticipants.ts

@@ -1,7 +1,8 @@
 import { ObjectId } from "mongodb"
-import {AgreementResponse} from "./AgreementResponse"
+import { AgreementResponse } from "./AgreementResponse"
+import { WithStructures } from "./WithStructures"
 
-export interface ListParticipants {
+export interface ListParticipants extends WithStructures {
   _id?: ObjectId
 
   list: ObjectId
@@ -67,5 +68,4 @@ export interface ListParticipants {
    * if the participants came from a payment webhook paid will have the amount of the whole payment
    */
   payment?: ObjectId
-
 }

package/src/Payment.ts

@@ -13,4 +13,5 @@ export interface Payment {
     customer: ObjectId
     webhook?: ObjectId
     items?: ListItem[]
+    additionalData?: Record<string, string>
 }

package/src/PaymentProvider.ts

@@ -1,7 +1,7 @@
 
 export interface PaymentProvider {
 
-  type: 'shopify'
+  type: 'shopify' | 'stripe'
 
   active: boolean
 

package/src/PaymentProviderStripe.ts

@@ -0,0 +1,10 @@
+import { PaymentProvider } from "./PaymentProvider";
+
+export interface PaymentProviderStripe extends PaymentProvider {
+
+  type: 'stripe'
+
+  token: string
+  validationKey: string
+
+}

package/src/WithStructures.ts

@@ -0,0 +1,22 @@
+import { Structure } from "./Structure";
+
+/**
+ * Base interface containing only the standard properties
+ */
+interface BaseWithStructures {
+  structures?: Structure[]
+}
+
+/**
+ * A utility type that can be extended by any interface to support
+ * dynamic properties with keys prefixed with 's-'
+ * 
+ * @example
+ * interface MyInterface extends WithStructures {
+ *   name: string;
+ *   // MyInterface now supports s- prefixed dynamic properties
+ * }
+ */
+export type WithStructures = BaseWithStructures & Partial<{
+  [key: `s-${string}`]: string | boolean | number | Array<string>;
+}>

package/lib/esm/PaymentProviderShopify .js

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

package/lib/esm/PaymentProviderShopify .js.map

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