@lilaquadrat/interfaces 1.14.1 → 1.16.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.16.0](https://github.com/lilaquadrat/interfaces/compare/v1.15.0...v1.16.0) (2025-01-05)
+
+
+### Features
+
+* **paymentprovider:** added paymentProviders interfaced and updated mongodb ([0437ae9](https://github.com/lilaquadrat/interfaces/commit/0437ae97d4a0c737564219868d495e23fbfe5d1b))
+
+## [1.15.0](https://github.com/lilaquadrat/interfaces/compare/v1.14.1...v1.15.0) (2025-01-03)
+
+
+### Features
+
+* **customerminimal & payment:** added customerMinimal and payment ([2d34012](https://github.com/lilaquadrat/interfaces/commit/2d340121c04579d593729239d4708e0e5e2cf717))
+
 ### [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)

package/lib/cjs/CustomerMinimal.d.ts

@@ -0,0 +1,7 @@
+import { ObjectId } from "mongodb";
+export interface CustomerMinimal {
+    name: string;
+    email: string;
+    id: string;
+    _id: ObjectId;
+}

package/lib/cjs/ListParticipantWithUser.d.ts

@@ -1,10 +1,9 @@
-import { ObjectId } from "mongodb";
 import { ListParticipants } from "./ListParticipants";
-export type ListParticipantWithUser = ListParticipants & {
-    user: {
-        name: string;
-        email: string;
-        id: string;
-        _id: ObjectId;
-    };
+import { Payment } from "./Payment";
+import { BasicData } from "./BasicData";
+import { CustomerMinimal } from "./CustomerMinimal";
+export type ListParticipantWithCustomerAndPayment = BasicData<ListParticipants> & {
+    user: CustomerMinimal;
+} & {
+    payment?: Pick<BasicData<Payment>, '_id' | 'state' | 'items' | 'provider' | 'currency' | 'amount'>;
 };

package/lib/cjs/ListParticipants.d.ts

@@ -1,6 +1,5 @@
 import { ObjectId } from "mongodb";
 import { AgreementResponse } from "./AgreementResponse";
-import { ListItem } from "./ListItem";
 export interface ListParticipants {
     _id?: ObjectId;
     list: ObjectId;
@@ -56,9 +55,8 @@ export interface ListParticipants {
     */
     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;
+    payment?: ObjectId;
 }

package/lib/cjs/Payment.d.ts

@@ -0,0 +1,15 @@
+import { ObjectId } from "mongodb";
+import { ListItem } from "./ListItem";
+export interface Payment {
+    company: string;
+    project: string;
+    test?: boolean;
+    body?: Record<string, any>;
+    provider: string;
+    state: 'waiting' | 'failed' | 'paid';
+    amount: number;
+    currency: string;
+    customer: ObjectId;
+    webhook?: ObjectId;
+    items?: ListItem[];
+}

package/lib/cjs/PaymentProvider.d.ts

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

package/lib/cjs/PaymentProviderShopify .d.ts

@@ -0,0 +1,5 @@
+import { PaymentProvider } from "./PaymentProvider";
+export interface PaymentProviderShopify extends PaymentProvider {
+    type: 'shopify';
+    validationKey: string;
+}

package/lib/cjs/PaymentWithCustomer.d.ts

@@ -0,0 +1,16 @@
+import { ObjectId } from "mongodb";
+import { ListItem } from "./ListItem";
+import { CustomerMinimal } from "./CustomerMinimal";
+export interface PaymentWithCustomer {
+    company: string;
+    project: string;
+    test?: boolean;
+    body?: Record<string, any>;
+    provider: string;
+    state: 'waiting' | 'failed' | 'paid';
+    amount: number;
+    currency: string;
+    customer: CustomerMinimal;
+    webhook?: ObjectId;
+    items?: ListItem[];
+}

package/lib/cjs/Project.d.ts

@@ -1,4 +1,5 @@
 import Auth0ProjectSettings from "./Auth0ProjectSettings";
+import ShopifyProjectSettings from "./ShopifyProjectSettings";
 export interface Project {
     name: string;
     description?: string;
@@ -7,4 +8,5 @@ export interface Project {
     tags?: string[];
     apps?: string[];
     auth0?: Auth0ProjectSettings;
+    shopify?: ShopifyProjectSettings;
 }

package/lib/cjs/ShopifyProjectSettings.d.ts

@@ -0,0 +1,3 @@
+export default interface ShopifyProjectSettings {
+    key?: string;
+}

package/lib/cjs/WebhookCall.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Represents a webhook call with details about the company, project, and other relevant information.
+ */
+export interface WebhookCall {
+    /**
+     * The name of the company associated with the webhook call.
+     */
+    company: string;
+    /**
+     * The name of the project associated with the webhook call.
+     */
+    project: string;
+    /**
+     * Indicates whether the webhook call is a test.
+     */
+    test?: boolean;
+    /**
+     * The body of the webhook call, containing the payload data.
+     */
+    body: Record<string, any>;
+    /**
+     * The type of the webhook call.
+     */
+    type: string;
+    /**
+     * The provider of the webhook service.
+     */
+    provider: string;
+}

package/lib/cjs/index.d.ts

@@ -36,6 +36,7 @@ export * from './CreateResult';
 export * from './CustomerAccounts';
 export * from './CustomerBase';
 export * from './CustomerCompany';
+export * from './CustomerMinimal';
 export * from './CustomerPerson';
 export * from './CustomerPersonWithAddress';
 export * from './CustomerPersonWithEmail';
@@ -98,6 +99,10 @@ export * from './MulterFile';
 export * from './ObjectIdString';
 export * from './Options';
 export * from './Partner';
+export * from './Payment';
+export * from './PaymentProvider';
+export * from './PaymentProviderShopify ';
+export * from './PaymentWithCustomer';
 export * from './Permissions';
 export * from './PermissionsWithScope';
 export * from './Price';
@@ -120,6 +125,7 @@ export * from './Secret';
 export * from './Settings';
 export * from './ShareClient';
 export * from './ShareClientOptions';
+export * from './ShopifyProjectSettings';
 export * from './SkipLimitSort';
 export * from './StudioIframeMessage';
 export * from './SystemDomain';
@@ -131,4 +137,5 @@ export * from './UserApp';
 export * from './UserAppOptionsRequired';
 export * from './UserAppWithOptions';
 export * from './VersionInfo';
+export * from './WebhookCall';
 export * from './WildcardCertificates';

package/lib/esm/CustomerMinimal.d.ts

@@ -0,0 +1,7 @@
+import { ObjectId } from "mongodb";
+export interface CustomerMinimal {
+    name: string;
+    email: string;
+    id: string;
+    _id: ObjectId;
+}

package/lib/esm/CustomerMinimal.js

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

package/lib/esm/CustomerMinimal.js.map

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

package/lib/esm/ListParticipantWithUser.d.ts

@@ -1,10 +1,9 @@
-import { ObjectId } from "mongodb";
 import { ListParticipants } from "./ListParticipants";
-export type ListParticipantWithUser = ListParticipants & {
-    user: {
-        name: string;
-        email: string;
-        id: string;
-        _id: ObjectId;
-    };
+import { Payment } from "./Payment";
+import { BasicData } from "./BasicData";
+import { CustomerMinimal } from "./CustomerMinimal";
+export type ListParticipantWithCustomerAndPayment = BasicData<ListParticipants> & {
+    user: CustomerMinimal;
+} & {
+    payment?: Pick<BasicData<Payment>, '_id' | 'state' | 'items' | 'provider' | 'currency' | 'amount'>;
 };

package/lib/esm/ListParticipants.d.ts

@@ -1,6 +1,5 @@
 import { ObjectId } from "mongodb";
 import { AgreementResponse } from "./AgreementResponse";
-import { ListItem } from "./ListItem";
 export interface ListParticipants {
     _id?: ObjectId;
     list: ObjectId;
@@ -56,9 +55,8 @@ export interface ListParticipants {
     */
     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;
+    payment?: ObjectId;
 }

package/lib/esm/Payment.d.ts

@@ -0,0 +1,15 @@
+import { ObjectId } from "mongodb";
+import { ListItem } from "./ListItem";
+export interface Payment {
+    company: string;
+    project: string;
+    test?: boolean;
+    body?: Record<string, any>;
+    provider: string;
+    state: 'waiting' | 'failed' | 'paid';
+    amount: number;
+    currency: string;
+    customer: ObjectId;
+    webhook?: ObjectId;
+    items?: ListItem[];
+}

package/lib/esm/Payment.js

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

package/lib/esm/Payment.js.map

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

package/lib/esm/PaymentProvider.d.ts

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

package/lib/esm/PaymentProvider.js

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

package/lib/esm/PaymentProvider.js.map

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

package/lib/esm/PaymentProviderShopify .d.ts

@@ -0,0 +1,5 @@
+import { PaymentProvider } from "./PaymentProvider";
+export interface PaymentProviderShopify extends PaymentProvider {
+    type: 'shopify';
+    validationKey: string;
+}

package/lib/esm/PaymentProviderShopify .js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=PaymentProviderShopify%20.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/PaymentWithCustomer.d.ts

@@ -0,0 +1,16 @@
+import { ObjectId } from "mongodb";
+import { ListItem } from "./ListItem";
+import { CustomerMinimal } from "./CustomerMinimal";
+export interface PaymentWithCustomer {
+    company: string;
+    project: string;
+    test?: boolean;
+    body?: Record<string, any>;
+    provider: string;
+    state: 'waiting' | 'failed' | 'paid';
+    amount: number;
+    currency: string;
+    customer: CustomerMinimal;
+    webhook?: ObjectId;
+    items?: ListItem[];
+}

package/lib/esm/PaymentWithCustomer.js

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

package/lib/esm/PaymentWithCustomer.js.map

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

package/lib/esm/Project.d.ts

@@ -1,4 +1,5 @@
 import Auth0ProjectSettings from "./Auth0ProjectSettings";
+import ShopifyProjectSettings from "./ShopifyProjectSettings";
 export interface Project {
     name: string;
     description?: string;
@@ -7,4 +8,5 @@ export interface Project {
     tags?: string[];
     apps?: string[];
     auth0?: Auth0ProjectSettings;
+    shopify?: ShopifyProjectSettings;
 }

package/lib/esm/ShopifyProjectSettings.d.ts

@@ -0,0 +1,3 @@
+export default interface ShopifyProjectSettings {
+    key?: string;
+}

package/lib/esm/ShopifyProjectSettings.js

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

package/lib/esm/ShopifyProjectSettings.js.map

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

package/lib/esm/WebhookCall.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Represents a webhook call with details about the company, project, and other relevant information.
+ */
+export interface WebhookCall {
+    /**
+     * The name of the company associated with the webhook call.
+     */
+    company: string;
+    /**
+     * The name of the project associated with the webhook call.
+     */
+    project: string;
+    /**
+     * Indicates whether the webhook call is a test.
+     */
+    test?: boolean;
+    /**
+     * The body of the webhook call, containing the payload data.
+     */
+    body: Record<string, any>;
+    /**
+     * The type of the webhook call.
+     */
+    type: string;
+    /**
+     * The provider of the webhook service.
+     */
+    provider: string;
+}

package/lib/esm/WebhookCall.js

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

package/lib/esm/WebhookCall.js.map

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

package/lib/esm/index.d.ts

@@ -36,6 +36,7 @@ export * from './CreateResult';
 export * from './CustomerAccounts';
 export * from './CustomerBase';
 export * from './CustomerCompany';
+export * from './CustomerMinimal';
 export * from './CustomerPerson';
 export * from './CustomerPersonWithAddress';
 export * from './CustomerPersonWithEmail';
@@ -98,6 +99,10 @@ export * from './MulterFile';
 export * from './ObjectIdString';
 export * from './Options';
 export * from './Partner';
+export * from './Payment';
+export * from './PaymentProvider';
+export * from './PaymentProviderShopify ';
+export * from './PaymentWithCustomer';
 export * from './Permissions';
 export * from './PermissionsWithScope';
 export * from './Price';
@@ -120,6 +125,7 @@ export * from './Secret';
 export * from './Settings';
 export * from './ShareClient';
 export * from './ShareClientOptions';
+export * from './ShopifyProjectSettings';
 export * from './SkipLimitSort';
 export * from './StudioIframeMessage';
 export * from './SystemDomain';
@@ -131,4 +137,5 @@ export * from './UserApp';
 export * from './UserAppOptionsRequired';
 export * from './UserAppWithOptions';
 export * from './VersionInfo';
+export * from './WebhookCall';
 export * from './WildcardCertificates';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lilaquadrat/interfaces",
-  "version": "1.14.1",
+  "version": "1.16.0",
   "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.9.2",
+    "mongodb": "^6.12.0",
     "standard-version": "^9.5.0"
   },
   "config": {

package/src/CustomerMinimal.ts

@@ -0,0 +1,8 @@
+import { ObjectId } from "mongodb";
+
+export interface CustomerMinimal {
+    name: string,
+    email: string,
+    id: string,
+    _id: ObjectId
+}

package/src/ListParticipantWithUser.ts

@@ -1,12 +1,14 @@
-import { ObjectId } from "mongodb";
 import { ListParticipants } from "./ListParticipants";
+import { Payment } from "./Payment";
+import { BasicData } from "./BasicData";
+import { CustomerMinimal } from "./CustomerMinimal";
 
-export type ListParticipantWithUser = ListParticipants
-& {
-  user: {
-    name: string,
-    email: string,
-    id: string,
-    _id: ObjectId
-  }
-};
+export type ListParticipantWithCustomerAndPayment = BasicData<ListParticipants>
+  & 
+  {
+    user: CustomerMinimal
+  } 
+  & 
+  {
+    payment?: Pick<BasicData<Payment>, '_id' | 'state' | 'items' | 'provider' | 'currency' | 'amount'>;
+  }

package/src/ListParticipants.ts

@@ -1,6 +1,5 @@
 import { ObjectId } from "mongodb"
 import {AgreementResponse} from "./AgreementResponse"
-import { ListItem } from "./ListItem"
 
 export interface ListParticipants {
   _id?: ObjectId
@@ -64,10 +63,9 @@ export interface ListParticipants {
   */
   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
+  payment?: ObjectId
 
 }

package/src/Payment.ts

@@ -0,0 +1,16 @@
+import { ObjectId } from "mongodb"
+import { ListItem } from "./ListItem"
+
+export interface Payment {
+    company: string
+    project: string
+    test?: boolean
+    body?: Record<string, any>
+    provider: string
+    state: 'waiting' | 'failed' | 'paid'
+    amount: number
+    currency: string
+    customer: ObjectId
+    webhook?: ObjectId
+    items?: ListItem[]
+}

package/src/PaymentProvider.ts

@@ -0,0 +1,10 @@
+
+export interface PaymentProvider {
+
+  type: 'shopify'
+
+  active: boolean
+
+  label: string
+
+}

package/src/PaymentProviderShopify .ts

@@ -0,0 +1,9 @@
+import { PaymentProvider } from "./PaymentProvider";
+
+export interface PaymentProviderShopify extends PaymentProvider {
+
+  type: 'shopify'
+
+  validationKey: string
+
+}

package/src/PaymentWithCustomer.ts

@@ -0,0 +1,17 @@
+import { ObjectId } from "mongodb"
+import { ListItem } from "./ListItem"
+import { CustomerMinimal } from "./CustomerMinimal"
+
+export interface PaymentWithCustomer {
+    company: string
+    project: string
+    test?: boolean
+    body?: Record<string, any>
+    provider: string
+    state: 'waiting' | 'failed' | 'paid'
+    amount: number
+    currency: string
+    customer: CustomerMinimal
+    webhook?: ObjectId
+    items?: ListItem[]
+}

package/src/Project.ts

@@ -1,4 +1,5 @@
 import Auth0ProjectSettings from "./Auth0ProjectSettings"
+import ShopifyProjectSettings from "./ShopifyProjectSettings"
 
 export interface Project {
 
@@ -10,5 +11,6 @@ export interface Project {
   apps?: string[]
 
   auth0?: Auth0ProjectSettings
+  shopify?: ShopifyProjectSettings
 
 }

package/src/ShopifyProjectSettings.ts

@@ -0,0 +1,5 @@
+export default interface ShopifyProjectSettings {
+
+    key?: string
+
+}

package/src/WebhookCall.ts

@@ -0,0 +1,34 @@
+/**
+ * Represents a webhook call with details about the company, project, and other relevant information.
+ */
+export interface WebhookCall {
+    /**
+     * The name of the company associated with the webhook call.
+     */
+    company: string
+
+    /**
+     * The name of the project associated with the webhook call.
+     */
+    project: string
+
+    /**
+     * Indicates whether the webhook call is a test.
+     */
+    test?: boolean
+
+    /**
+     * The body of the webhook call, containing the payload data.
+     */
+    body: Record<string, any>;
+
+    /**
+     * The type of the webhook call.
+     */
+    type: string
+
+    /**
+     * The provider of the webhook service.
+     */
+    provider: string
+}