@lilaquadrat/interfaces 1.26.1 → 1.27.0

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 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.27.0](https://github.com/lilaquadrat/interfaces/compare/v1.26.1...v1.27.0) (2025-04-26)
+
+
+### Features
+
+* **modules:** added interfaces for all compatible modules ([2e1d6a3](https://github.com/lilaquadrat/interfaces/commit/2e1d6a3e80c163d4c39d4e873507430f264f487c))
+
 ### [1.26.1](https://github.com/lilaquadrat/interfaces/compare/v1.26.0...v1.26.1) (2025-04-16)
 
 

package/lib/cjs/Accordion.d.ts

@@ -0,0 +1,7 @@
+import { AccordionElement } from "./AccordtionElement";
+export interface Accordion {
+    openOnStart?: string;
+    multiOpen?: boolean;
+    disableControls?: boolean;
+    elements?: AccordionElement[];
+}

package/lib/cjs/AccordtionElement.d.ts

@@ -0,0 +1,8 @@
+import { ListLink } from "./ListLink";
+import { ListString } from "./ListString";
+import { Textblock } from "./Textblock";
+export interface AccordionElement {
+    textblock?: Textblock;
+    list?: ListString;
+    links?: ListLink;
+}

package/lib/cjs/Auth0ProjectSettings.d.ts

@@ -1,3 +1,3 @@
-export default interface Auth0ProjectSettings {
+export interface Auth0ProjectSettings {
     domain?: string;
 }

package/lib/cjs/BlogIntroModule.d.ts

@@ -0,0 +1,12 @@
+import { Link } from "./Link";
+import { Module } from "./Module";
+import { Picture } from "./Picture";
+import { Textblock } from "./Textblock";
+export interface BlogIntroModule extends Module {
+    type: "blog-intro-module";
+    author?: string;
+    date?: string;
+    textblock?: Textblock;
+    picture?: Picture;
+    link?: Link;
+}

package/lib/cjs/CallToActionModule.d.ts

@@ -0,0 +1,12 @@
+import { Link } from "./Link";
+import { ListLink } from "./ListLink";
+import { ListString } from "./ListString";
+import { Module } from "./Module";
+import { Textblock } from "./Textblock";
+export interface CallToActionModule extends Module {
+    type: "callToAction-module";
+    textblock?: Textblock;
+    list?: ListString;
+    links?: ListLink;
+    link?: Link;
+}

package/lib/cjs/CompareElement.d.ts

@@ -0,0 +1,5 @@
+export interface CompareElement {
+    elements?: string[];
+    headline?: string;
+    description?: string;
+}

package/lib/cjs/CompareModule.d.ts

@@ -0,0 +1,10 @@
+import { CompareElement } from "./CompareElement";
+import { CompareStructureElement } from "./CompareStructureElement";
+import { Module } from "./Module";
+import { Textblock } from "./Textblock";
+export interface CompareModule extends Module {
+    type: "compare-module";
+    textblock?: Textblock;
+    elements?: CompareElement[];
+    structure?: CompareStructureElement[];
+}

package/lib/cjs/CompareStructureElement.d.ts

@@ -0,0 +1,5 @@
+export interface CompareStructureElement {
+    headline?: string;
+    description?: string;
+    list?: string[];
+}

package/lib/cjs/CompatibleModule.d.ts

@@ -0,0 +1,33 @@
+import { BlogIntroModule } from "./BlogIntroModule";
+import { CallToActionModule } from "./CallToActionModule";
+import { CompareModule } from "./CompareModule";
+import { ContactModule } from "./ContactModule";
+import { CookiesModule } from "./CookiesModule";
+import { EmotionModule } from "./EmotionModule";
+import { EventModule } from "./EventModule";
+import { EventsListModule } from "./EventsListModule";
+import { FactsModule } from "./FactsModule";
+import { FaqModule } from "./FaqModule";
+import { FooterModule } from "./FooterModule";
+import { GalleryModule } from "./GalleryModule";
+import { IndexModule } from "./IndexModule";
+import { LocationModule } from "./LocationModule";
+import { MenuModule } from "./MenuModule";
+import { NavigationModule } from "./NavigationModule";
+import { PartialModule } from "./PartialModule";
+import { PictureAndTextModule } from "./PictureAndTextModule";
+import { PicturegroupModule } from "./PicturegroupModule";
+import { PictureModule } from "./PictureModule";
+import { PlaceholderModule } from "./PlaeceholderModule";
+import { PricesModule } from "./PricesModule";
+import { QuellcodeModule } from "./QuellcodeModule";
+import { QuoteModule } from "./QuoteModule";
+import { ShoppingCartModule } from "./ShoppingCartModule";
+import { StoryModule } from "./StoryModule";
+import { TextModule } from "./TextModule";
+import { TrainingModule } from "./TrainingMdule";
+import { VideoModule } from "./VideoModule";
+/**
+ * Union type that combines all module interfaces for compatibility
+ */
+export type CompatibleModule = BlogIntroModule | CallToActionModule | CompareModule | ContactModule | CookiesModule | EmotionModule | EventModule | EventsListModule | FactsModule | FaqModule | FooterModule | GalleryModule | IndexModule | LocationModule | MenuModule | NavigationModule | PartialModule | PictureAndTextModule | PictureModule | PicturegroupModule | PlaceholderModule | PricesModule | QuellcodeModule | QuoteModule | ShoppingCartModule | StoryModule | TextModule | TrainingModule | VideoModule;

package/lib/cjs/ContactCategoryElement.d.ts

@@ -0,0 +1,7 @@
+import { GenericData } from "./GenericData";
+export interface ContactCategoryElement {
+    genericData?: GenericData;
+    title?: string;
+    description?: string;
+    required?: string[];
+}

package/lib/cjs/ContactModule.d.ts

@@ -0,0 +1,15 @@
+import { GenericData } from "./GenericData";
+import { Module } from "./Module";
+import { Textblock } from "./Textblock";
+export interface ContactModule extends Module {
+    type: "contact-module";
+    genericData?: GenericData;
+    textblock?: Textblock;
+    categoryTextblock?: Textblock;
+    categories?: {
+        type: 'array';
+        contains: {
+            model: 'contact-category-element';
+        };
+    };
+}

package/lib/cjs/Content.d.ts

@@ -1,14 +1,21 @@
 import { ChildData } from "./ChildData";
+import { CompatibleModule } from "./CompatibleModule";
 import { GenericData } from "./GenericData";
-import { ModuleGeneric } from "./ModuleGeneric";
 import { ObjectIdString } from "./ObjectIdString";
 export interface Content {
     id: string;
     company: string;
     project: string;
-    modules: ModuleGeneric[];
+    modules: CompatibleModule[];
     tags?: string[];
+    /**
+     * a description of the content which will be used as context for AI text generation
+     */
     description?: string;
+    /**
+     * a internal note for better understanding and identification of the content
+     */
+    note?: string;
     partial?: boolean;
     layout?: boolean;
     state: 'draft' | 'publish';

package/lib/cjs/CookiesModule.d.ts

@@ -0,0 +1,10 @@
+import { ListLink } from "./ListLink";
+import { ListString } from "./ListString";
+import { Module } from "./Module";
+import { Textblock } from "./Textblock";
+export interface CookiesModule extends Module {
+    type: "cookies-module";
+    textblock?: Textblock;
+    list?: ListString;
+    links?: ListLink;
+}

package/lib/cjs/EditorSettings.d.ts

@@ -0,0 +1,3 @@
+export interface EditorSettings {
+    modes?: string[];
+}

package/lib/cjs/EmotionModule.d.ts

@@ -0,0 +1,14 @@
+import { Link } from "./Link";
+import { Module } from "./Module";
+import { Picture } from "./Picture";
+import { Textblock } from "./Textblock";
+import { Video } from "./Video";
+export interface EmotionModule extends Module {
+    type: "emotion-module";
+    fontVariant?: string[];
+    background?: Picture;
+    video?: Video;
+    textblock?: Textblock;
+    picture?: Picture;
+    links?: Link[];
+}

package/lib/cjs/EventModule.d.ts

@@ -0,0 +1,21 @@
+import { GenericData } from "./GenericData";
+import { Link } from "./Link";
+import { ListLink } from "./ListLink";
+import { ListString } from "./ListString";
+import { Media } from "./Media";
+import { Module } from "./Module";
+import { Textblock } from "./Textblock";
+export interface EventModule extends Module {
+    type: "event-module";
+    textblock?: Textblock;
+    artist?: string;
+    name?: string;
+    location?: string;
+    list?: ListString;
+    links?: ListLink;
+    callToAction?: Link;
+    genericData?: GenericData;
+    start?: Date;
+    end?: Date;
+    media?: Media;
+}

package/lib/cjs/EventsListModule.d.ts

@@ -0,0 +1,8 @@
+import { EventsListElement } from "./events-list-element";
+import { Module } from "./Module";
+import { Textblock } from "./Textblock";
+export interface EventsListModule extends Module {
+    type: "events-list-module";
+    textblock?: Textblock;
+    elements?: EventsListElement[];
+}

package/lib/cjs/FactsElement.d.ts

@@ -0,0 +1,6 @@
+import { Picture } from "./Picture";
+import { Textblock } from "./Textblock";
+export interface FactsElement {
+    picture?: Picture;
+    textblock?: Textblock;
+}

package/lib/cjs/FactsModule.d.ts

@@ -0,0 +1,8 @@
+import { FactsElement } from "./FactsElement";
+import { Module } from "./Module";
+import { Textblock } from "./Textblock";
+export interface FactsModule extends Module {
+    type: "facts-module";
+    textblock?: Textblock;
+    elements?: FactsElement[];
+}

package/lib/cjs/FaqModule.d.ts

@@ -0,0 +1,8 @@
+import { Accordion } from "./Accordion";
+import { Module } from "./Module";
+import { Textblock } from "./Textblock";
+export interface FaqModule extends Module {
+    type: "faq-module";
+    textblock?: Textblock;
+    accordion?: Accordion;
+}

package/lib/cjs/FooterContact.d.ts

@@ -0,0 +1,5 @@
+import { Link } from "./Link";
+export interface FooterContact {
+    title?: string;
+    link?: Link;
+}

package/lib/cjs/FooterModule.d.ts

@@ -0,0 +1,19 @@
+import { Module } from "./Module";
+import { FooterContact } from "./FooterContact";
+import { FooterSitemap } from "./FooterSitemap";
+import { FooterSocial } from "./FooterSocial";
+import { ListLink } from "./ListLink";
+import { ListString } from "./ListString";
+import { Picture } from "./Picture";
+import { Textblock } from "./Textblock";
+export interface FooterModule extends Module {
+    type: "footer-module";
+    legal?: string;
+    contact?: FooterContact;
+    social?: FooterSocial;
+    sitemap?: FooterSitemap[];
+    list?: ListString;
+    links?: ListLink;
+    textblock?: Textblock;
+    picture?: Picture;
+}

package/lib/cjs/FooterSitemap.d.ts

@@ -0,0 +1,5 @@
+import { Link } from "./Link";
+export interface FooterSitemap {
+    title?: string;
+    elements?: Link[];
+}

package/lib/cjs/FooterSocial.d.ts

@@ -0,0 +1,7 @@
+import { Link } from "./Link";
+import { PicturegroupElement } from "./PicturegroupElement";
+export interface FooterSocial {
+    title?: string;
+    link?: Link;
+    elements?: PicturegroupElement[];
+}

package/lib/cjs/GalleryElement.d.ts

@@ -0,0 +1,6 @@
+import { Picture } from "./Picture";
+import { Textblock } from "./Textblock";
+export interface GalleryElement {
+    picture?: Picture;
+    textblock?: Textblock;
+}

package/lib/cjs/GalleryModule.d.ts

@@ -0,0 +1,8 @@
+import { GalleryElement } from "./GalleryElement";
+import { Module } from "./Module";
+import { Textblock } from "./Textblock";
+export interface GalleryModule extends Module {
+    type: "gallery-module";
+    description?: Textblock;
+    elements?: GalleryElement[];
+}

package/lib/cjs/GenericDataSingle.d.ts

@@ -0,0 +1,8 @@
+import { Content } from "./Content";
+export interface GenericDataSingle {
+    editor?: string;
+    lists?: string;
+    customers?: string;
+    media?: string;
+    data?: Record<string, Content>;
+}

package/lib/cjs/IndexModule.d.ts

@@ -0,0 +1,6 @@
+import { ListLink } from "./ListLink";
+import { Module } from "./Module";
+export interface IndexModule extends Module {
+    type: "index-module";
+    links?: ListLink;
+}

package/lib/cjs/Link.d.ts

@@ -0,0 +1,9 @@
+export interface Link {
+    text?: string;
+    link?: string;
+    event?: string;
+    icon?: string;
+    attributes?: string[];
+    variant?: string[];
+    additionalData?: string;
+}

package/lib/cjs/LinkGroupElement.d.ts

@@ -0,0 +1,12 @@
+import { Link } from "./Link";
+export interface LinkGroupElement {
+    text?: string;
+    event?: string;
+    link?: string;
+    icon?: string;
+    classes?: string[];
+    attributes?: string[];
+    variant?: string[];
+    external?: boolean;
+    links?: Link[];
+}

package/lib/cjs/ListCategory.d.ts

@@ -1,5 +1,5 @@
 import { ObjectId } from "mongodb";
-import Price from "./Price";
+import { Price } from "./Price";
 export interface ListCategory {
     _id: ObjectId;
     id: string;

package/lib/cjs/ListLink.d.ts

@@ -0,0 +1,5 @@
+import { Link } from "./Link";
+export interface ListLink {
+    title?: string;
+    value?: Link[];
+}

package/lib/cjs/ListString.d.ts

@@ -0,0 +1,4 @@
+export interface ListString {
+    title?: string;
+    value?: string[];
+}

package/lib/cjs/LocationModule.d.ts

@@ -0,0 +1,11 @@
+import { ListLink } from "./ListLink";
+import { ListString } from "./ListString";
+import { Module } from "./Module";
+import { Textblock } from "./Textblock";
+export interface LocationModule extends Module {
+    type: 'location-module';
+    textblock?: Textblock;
+    map?: string;
+    list?: ListString;
+    links?: ListLink;
+}

package/lib/cjs/MediaApp.d.ts

@@ -0,0 +1,12 @@
+import { PictureSource } from "./PictureSource";
+import { SelectedFile } from "./SelectedFile";
+export interface MediaApp {
+    src?: string;
+    alt?: string;
+    type?: string;
+    copyright?: string;
+    poster?: string;
+    file?: SelectedFile;
+    attributes?: string[];
+    source?: PictureSource[];
+}

package/lib/cjs/MenuCategoryElement.d.ts

@@ -0,0 +1,6 @@
+import { MenuItemElement } from "./MenuItemElement";
+import { Textblock } from "./Textblock";
+export interface MenuCategoryElement {
+    textblock?: Textblock;
+    items?: MenuItemElement[];
+}

package/lib/cjs/MenuItemElement.d.ts

@@ -0,0 +1,9 @@
+import { Picture } from "./Picture";
+export interface MenuItemElement {
+    title?: string;
+    description?: string;
+    price?: string;
+    properties?: string[];
+    allergens?: string[];
+    picture?: Picture;
+}

package/lib/cjs/MenuModule.d.ts

@@ -0,0 +1,10 @@
+import { MenuCategoryElement } from "./MenuCategoryElement";
+import { Module } from "./Module";
+import { Textblock } from "./Textblock";
+export interface MenuModule extends Module {
+    type: "menu-module";
+    name?: string;
+    textblock?: Textblock;
+    intro?: Textblock;
+    categories?: MenuCategoryElement[];
+}

package/lib/cjs/Module.d.ts

@@ -0,0 +1,15 @@
+import { EditorSettings } from "./EditorSettings";
+import { ModuleIndex } from "./ModuleIndex";
+import { ModulePdf } from "./ModulePdf";
+export interface Module {
+    type: string;
+    id?: string;
+    uuid?: string;
+    position?: string;
+    layout?: string;
+    changed?: boolean;
+    variant: string[];
+    index?: ModuleIndex;
+    pdf?: ModulePdf;
+    editor?: EditorSettings;
+}

package/lib/cjs/ModuleIndex.d.ts

@@ -0,0 +1,4 @@
+export interface ModuleIndex {
+    anchor?: string;
+    title?: string;
+}

package/lib/cjs/ModulePdf.d.ts

@@ -0,0 +1,4 @@
+export interface ModulePdf {
+    newSiteAfter?: boolean;
+    newSiteBefore?: boolean;
+}

package/lib/cjs/NavigationModule.d.ts

@@ -0,0 +1,9 @@
+import { LinkGroupElement } from "./LinkGroupElement";
+import { Module } from "./Module";
+import { Picture } from "./Picture";
+export interface NavigationModule extends Module {
+    type: "navigation-module";
+    name?: string;
+    picture?: Picture;
+    elements?: LinkGroupElement[];
+}

package/lib/cjs/PartialModule.d.ts

@@ -0,0 +1,8 @@
+import { Module } from "./Module";
+export interface PartialModule extends Module {
+    type: "partial-module";
+    company?: string;
+    project?: string;
+    partialId?: string;
+    modules?: string[];
+}

package/lib/cjs/Picture.d.ts

@@ -0,0 +1,9 @@
+import { PictureSource } from "./PictureSource";
+import { SelectedFile } from "./SelectedFile";
+export interface Picture {
+    src?: string;
+    alt?: string;
+    copyright?: string;
+    file?: SelectedFile;
+    source?: PictureSource[];
+}

package/lib/cjs/PictureAndTextModule.d.ts

@@ -0,0 +1,13 @@
+import { ListLink } from "./ListLink";
+import { ListString } from "./ListString";
+import { Module } from "./Module";
+import { Picture } from "./Picture";
+import { Textblock } from "./Textblock";
+export interface PictureAndTextModule extends Module {
+    type: "pictureandtext-module";
+    picture?: Picture;
+    textblock?: Textblock;
+    title?: Textblock;
+    list?: ListString;
+    links?: ListLink;
+}

package/lib/cjs/PictureModule.d.ts

@@ -0,0 +1,8 @@
+import { Module } from "./Module";
+import { Picture } from "./Picture";
+import { Textblock } from "./Textblock";
+export interface PictureModule extends Module {
+    type: "picture-module";
+    picture?: Picture;
+    textblock?: Textblock;
+}

package/lib/cjs/PictureSource.d.ts

@@ -0,0 +1,6 @@
+import { SelectedFile } from "./SelectedFile";
+export interface PictureSource {
+    media?: string;
+    src?: string;
+    file?: SelectedFile;
+}

package/lib/cjs/PicturegroupElement.d.ts

@@ -0,0 +1,12 @@
+import { Link } from "./Link";
+import { ListLink } from "./ListLink";
+import { ListString } from "./ListString";
+import { Picture } from "./Picture";
+import { Textblock } from "./Textblock";
+export interface PicturegroupElement {
+    picture?: Picture;
+    link?: Link;
+    textblock?: Textblock;
+    list?: ListString;
+    links?: ListLink;
+}

package/lib/cjs/PicturegroupModule.d.ts

@@ -0,0 +1,11 @@
+import { ListString } from "./ListString";
+import { Module } from "./Module";
+import { PicturegroupElement } from "./PicturegroupElement";
+import { Textblock } from "./Textblock";
+export interface PicturegroupModule extends Module {
+    type: "picturegroup-module";
+    elements?: PicturegroupElement[];
+    title?: Textblock;
+    list?: ListString;
+    textblock?: Textblock;
+}

package/lib/cjs/PlaeceholderModule.d.ts

@@ -0,0 +1,6 @@
+import { Module } from "./Module";
+export interface PlaceholderModule extends Module {
+    type: "placeholder-module";
+    hint?: string;
+    additionalData?: string;
+}

package/lib/cjs/Price.d.ts

@@ -1,5 +1,5 @@
-export default interface Price {
-    amount: number;
-    currency: string;
-    tax: number;
+export interface Price {
+    amount?: number;
+    currency?: string;
+    tax?: number;
 }

package/lib/cjs/PricesElement.d.ts

@@ -0,0 +1,11 @@
+import { Link } from "./Link";
+import { Textblock } from "./Textblock";
+export interface PricesElement {
+    price?: string;
+    interval?: string;
+    facts?: string[];
+    variant?: string[];
+    textblock?: Textblock;
+    callToAction?: Link;
+    more?: Link;
+}

package/lib/cjs/PricesModule.d.ts

@@ -0,0 +1,8 @@
+import { Module } from "./Module";
+import { PricesElement } from "./PricesElement";
+import { Textblock } from "./Textblock";
+export interface PricesModule extends Module {
+    type: "prices-module";
+    textblock?: Textblock;
+    elements?: PricesElement[];
+}

package/lib/cjs/Project.d.ts

@@ -1,5 +1,5 @@
-import Auth0ProjectSettings from "./Auth0ProjectSettings";
-import ShopifyProjectSettings from "./ShopifyProjectSettings";
+import { Auth0ProjectSettings } from "./Auth0ProjectSettings";
+import { ShopifyProjectSettings } from "./ShopifyProjectSettings";
 export interface Project {
     name: string;
     description?: string;

package/lib/cjs/QuellcodeModule.d.ts

@@ -0,0 +1,9 @@
+import { Module } from "./Module";
+export interface QuellcodeModule extends Module {
+    type: "quellcode-module";
+    headline?: string;
+    subline?: string;
+    intro?: string;
+    code?: string;
+    text?: string[];
+}

package/lib/cjs/QuoteModule.d.ts

@@ -0,0 +1,8 @@
+import { Link } from "./Link";
+import { Module } from "./Module";
+export interface QuoteModule extends Module {
+    type: "quote-module";
+    citation?: string;
+    quote?: string;
+    link?: Link;
+}