@lilaquadrat/interfaces 1.19.0 → 1.21.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.21.0](https://github.com/lilaquadrat/interfaces/compare/v1.20.0...v1.21.0) (2025-03-21)
+
+
+### Features
+
+* **structures:** added structures types ([1523e11](https://github.com/lilaquadrat/interfaces/commit/1523e11894954e99096528a122b8550aa57ae80f))
+
+## [1.20.0](https://github.com/lilaquadrat/interfaces/compare/v1.19.0...v1.20.0) (2025-03-10)
+
+
+### Features
+
+* **list & emailscontent:** refactored emailsContent ([6a96a3f](https://github.com/lilaquadrat/interfaces/commit/6a96a3f8d180c0d09731c208a1fffb72655dcb50))
+
 ## [1.19.0](https://github.com/lilaquadrat/interfaces/compare/v1.18.1...v1.19.0) (2025-02-07)
 
 

package/lib/cjs/CategoryStructure.d.ts

@@ -0,0 +1,10 @@
+import { BasicData } from "./BasicData";
+import { Structure } from "./Structure";
+export interface CategoryStructure {
+    title?: string;
+    description?: string;
+    structures: BasicData<Structure & {
+        required?: boolean;
+    }>[];
+    required?: string[];
+}

package/lib/cjs/CategoryStructureWithRequired.d.ts

@@ -0,0 +1,4 @@
+import { CategoryStructure } from "./CategoryStructure";
+export type CategoryStructureWithRequired = CategoryStructure & {
+    required?: boolean;
+};

package/lib/cjs/EmailsContent.d.ts

@@ -1,5 +1,7 @@
+import { ListParticipants } from "./ListParticipants";
+import { ObjectIdString } from "./ObjectIdString";
 export interface EmailsContent {
-    waiting: string;
-    active: string;
-    post: string;
+    contentId: ObjectIdString;
+    audience: 'public' | 'members';
+    affectedState: ListParticipants['state'];
 }

package/lib/cjs/GenericData.d.ts

@@ -3,10 +3,11 @@ import { Content } from "./Content";
 import { Customers } from "./Customers";
 import { List } from "./List";
 import { Media } from "./Media";
-type CompatibleGenericDataType = 'editor' | 'lists' | 'customers' | 'media';
+import { Structure } from "./Structure";
+type CompatibleGenericDataType = 'editor' | 'lists' | 'customers' | 'media' | 'structures';
 type GenericData = {
     [key in CompatibleGenericDataType]: string[];
 } & {
-    data: BasicData<Content | List | Customers | Media>[];
+    data: BasicData<Content | List | Customers | Media | Structure>[];
 };
 export { GenericData, CompatibleGenericDataType };

package/lib/cjs/GenericDataWithContent.d.ts

@@ -4,7 +4,8 @@ import { Customers } from "./Customers";
 import { CompatibleGenericDataType } from "./GenericData";
 import { List } from "./List";
 import { Media } from "./Media";
+import { Structure } from "./Structure";
 type GenericDataWithContent = {
-    [key in CompatibleGenericDataType]: Record<string, BasicData<Content | List | Customers | Media>>;
+    [key in CompatibleGenericDataType]: Record<string, BasicData<Content | List | Customers | Media | Structure>>;
 };
 export { GenericDataWithContent };

package/lib/cjs/List.d.ts

@@ -26,5 +26,5 @@ export interface List {
     agreements: Agreement[];
     categories?: ListCategory[];
     content?: ListContent;
-    emails: EmailsContent;
+    emails?: EmailsContent[];
 }

package/lib/cjs/Structure.d.ts

@@ -0,0 +1,38 @@
+export interface Structure {
+    /**
+     * Unique identifier for the structure
+     */
+    id: string;
+    /**
+     * The question text
+     */
+    question: string;
+    /**
+     * Type of the structure
+     */
+    type: 'string' | 'text' | 'number' | 'select' | 'boolean';
+    model: 'listsParticipants' | 'customers';
+    /**
+     * Maximum value for number type or maximum length for text type
+     */
+    max?: number;
+    /**
+     * Minimum value for number type or minimum length for text type
+     */
+    min?: number;
+    multiple?: boolean;
+    /**
+     * Available options for select and multiselect types
+     */
+    options?: {
+        value: string;
+        text: string;
+        description?: string;
+    }[];
+    /**
+     * Company identifier
+     */
+    company: string;
+    project: string;
+    description?: string;
+}

package/lib/cjs/index.d.ts

@@ -18,6 +18,8 @@ export * from './BaseFilterOptions';
 export * from './BasicData';
 export * from './BasicDataDatabase';
 export * from './CallResponse';
+export * from './CategoryStructure';
+export * from './CategoryStructureWithRequired';
 export * from './Certificate';
 export * from './CertificateAction';
 export * from './CertificateActionResult';
@@ -133,6 +135,7 @@ export * from './ShareClient';
 export * from './ShareClientOptions';
 export * from './ShopifyProjectSettings';
 export * from './SkipLimitSort';
+export * from './Structure';
 export * from './StudioIframeMessage';
 export * from './SystemDomain';
 export * from './Tracker';

package/lib/esm/CategoryStructure.d.ts

@@ -0,0 +1,10 @@
+import { BasicData } from "./BasicData";
+import { Structure } from "./Structure";
+export interface CategoryStructure {
+    title?: string;
+    description?: string;
+    structures: BasicData<Structure & {
+        required?: boolean;
+    }>[];
+    required?: string[];
+}

package/lib/esm/CategoryStructure.js

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

package/lib/esm/CategoryStructure.js.map

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

package/lib/esm/CategoryStructureWithRequired.d.ts

@@ -0,0 +1,4 @@
+import { CategoryStructure } from "./CategoryStructure";
+export type CategoryStructureWithRequired = CategoryStructure & {
+    required?: boolean;
+};

package/lib/esm/CategoryStructureWithRequired.js

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

package/lib/esm/CategoryStructureWithRequired.js.map

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

package/lib/esm/EmailsContent.d.ts

@@ -1,5 +1,7 @@
+import { ListParticipants } from "./ListParticipants";
+import { ObjectIdString } from "./ObjectIdString";
 export interface EmailsContent {
-    waiting: string;
-    active: string;
-    post: string;
+    contentId: ObjectIdString;
+    audience: 'public' | 'members';
+    affectedState: ListParticipants['state'];
 }

package/lib/esm/GenericData.d.ts

@@ -3,10 +3,11 @@ import { Content } from "./Content";
 import { Customers } from "./Customers";
 import { List } from "./List";
 import { Media } from "./Media";
-type CompatibleGenericDataType = 'editor' | 'lists' | 'customers' | 'media';
+import { Structure } from "./Structure";
+type CompatibleGenericDataType = 'editor' | 'lists' | 'customers' | 'media' | 'structures';
 type GenericData = {
     [key in CompatibleGenericDataType]: string[];
 } & {
-    data: BasicData<Content | List | Customers | Media>[];
+    data: BasicData<Content | List | Customers | Media | Structure>[];
 };
 export { GenericData, CompatibleGenericDataType };

package/lib/esm/GenericDataWithContent.d.ts

@@ -4,7 +4,8 @@ import { Customers } from "./Customers";
 import { CompatibleGenericDataType } from "./GenericData";
 import { List } from "./List";
 import { Media } from "./Media";
+import { Structure } from "./Structure";
 type GenericDataWithContent = {
-    [key in CompatibleGenericDataType]: Record<string, BasicData<Content | List | Customers | Media>>;
+    [key in CompatibleGenericDataType]: Record<string, BasicData<Content | List | Customers | Media | Structure>>;
 };
 export { GenericDataWithContent };

package/lib/esm/List.d.ts

@@ -26,5 +26,5 @@ export interface List {
     agreements: Agreement[];
     categories?: ListCategory[];
     content?: ListContent;
-    emails: EmailsContent;
+    emails?: EmailsContent[];
 }

package/lib/esm/Structure.d.ts

@@ -0,0 +1,38 @@
+export interface Structure {
+    /**
+     * Unique identifier for the structure
+     */
+    id: string;
+    /**
+     * The question text
+     */
+    question: string;
+    /**
+     * Type of the structure
+     */
+    type: 'string' | 'text' | 'number' | 'select' | 'boolean';
+    model: 'listsParticipants' | 'customers';
+    /**
+     * Maximum value for number type or maximum length for text type
+     */
+    max?: number;
+    /**
+     * Minimum value for number type or minimum length for text type
+     */
+    min?: number;
+    multiple?: boolean;
+    /**
+     * Available options for select and multiselect types
+     */
+    options?: {
+        value: string;
+        text: string;
+        description?: string;
+    }[];
+    /**
+     * Company identifier
+     */
+    company: string;
+    project: string;
+    description?: string;
+}

package/lib/esm/Structure.js

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

package/lib/esm/Structure.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Structure.js","sourceRoot":"","sources":["../../src/Structure.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 './CategoryStructure';
+export * from './CategoryStructureWithRequired';
 export * from './Certificate';
 export * from './CertificateAction';
 export * from './CertificateActionResult';
@@ -133,6 +135,7 @@ export * from './ShareClient';
 export * from './ShareClientOptions';
 export * from './ShopifyProjectSettings';
 export * from './SkipLimitSort';
+export * from './Structure';
 export * from './StudioIframeMessage';
 export * from './SystemDomain';
 export * from './Tracker';

package/package.json

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

package/src/CategoryStructure.ts

@@ -0,0 +1,9 @@
+import { BasicData } from "./BasicData"
+import { Structure } from "./Structure"
+
+export interface CategoryStructure {
+    title?: string
+    description?: string
+    structures: BasicData<Structure & {required?: boolean}>[]
+    required?: string[]
+}

package/src/CategoryStructureWithRequired.ts

@@ -0,0 +1,3 @@
+import { CategoryStructure } from "./CategoryStructure"
+
+export type CategoryStructureWithRequired = CategoryStructure & {required?: boolean};

package/src/EmailsContent.ts

@@ -1,11 +1,11 @@
+import { ListParticipants } from "./ListParticipants"
+import { ObjectIdString } from "./ObjectIdString"
+
 export interface EmailsContent {
 
-    // the user is reserved but not confirmed
-    waiting: string
+    contentId: ObjectIdString
 
-    // the user is confirmed
-    active: string
+    audience: 'public' | 'members'
 
-    // the usage/event is fulfilled
-    post: string
+    affectedState: ListParticipants['state']
 }

package/src/GenericData.ts

@@ -3,13 +3,14 @@ import { Content } from "./Content"
 import { Customers } from "./Customers";
 import { List } from "./List";
 import { Media } from "./Media";
+import { Structure } from "./Structure";
 
-type CompatibleGenericDataType = 'editor' | 'lists' | 'customers' | 'media';
+type CompatibleGenericDataType = 'editor' | 'lists' | 'customers' | 'media' | 'structures';
 
 type GenericData = {
     [key in CompatibleGenericDataType]: string[]
 } & {
-    data: BasicData<Content | List | Customers | Media>[];
+    data: BasicData<Content | List | Customers | Media | Structure>[];
 }
 
 

package/src/GenericDataWithContent.ts

@@ -4,9 +4,10 @@ import { Customers } from "./Customers";
 import { CompatibleGenericDataType } from "./GenericData";
 import { List } from "./List";
 import { Media } from "./Media";
+import { Structure } from "./Structure";
 
 type GenericDataWithContent = {
-    [key in CompatibleGenericDataType]: Record<string, BasicData<Content | List | Customers | Media>>
+    [key in CompatibleGenericDataType]: Record<string, BasicData<Content | List | Customers | Media | Structure>>
 }
 
 export { GenericDataWithContent };

package/src/List.ts

@@ -37,5 +37,5 @@ export interface List {
 
     content?: ListContent
 
-    emails: EmailsContent
+    emails?: EmailsContent[]
   }

package/src/Structure.ts

@@ -0,0 +1,44 @@
+export interface Structure {
+  /**
+   * Unique identifier for the structure
+   */
+  id: string
+
+  /**
+   * The question text
+   */
+  question: string
+
+  /**
+   * Type of the structure
+   */
+  type: 'string' | 'text' | 'number' | 'select' | 'boolean'
+  model: 'listsParticipants' | 'customers'
+
+  /**
+   * Maximum value for number type or maximum length for text type
+   */
+  max?: number
+
+  /**
+   * Minimum value for number type or minimum length for text type
+   */
+  min?: number
+  multiple?: boolean
+
+  /**
+   * Available options for select and multiselect types
+   */
+  options?: {
+    value: string
+    text: string
+    description?: string
+  }[]
+  /**
+   * Company identifier
+   */
+  company: string
+  project: string
+
+  description?: string
+}