@lilaquadrat/interfaces 1.4.0 → 1.6.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.6.0](https://github.com/lilaquadrat/interfaces/compare/v1.5.0...v1.6.0) (2024-03-11)
+
+
+### Features
+
+* **publish methods:** added support for publish methods ([2487872](https://github.com/lilaquadrat/interfaces/commit/248787278607722f9a7f0dbc35669c8707f5b029))
+
+## [1.5.0](https://github.com/lilaquadrat/interfaces/compare/v1.4.0...v1.5.0) (2024-02-23)
+
+
+### Features
+
+* **hosting:** added new hosting settings interface ([321800a](https://github.com/lilaquadrat/interfaces/commit/321800abc7ecabad1000f69f4e588bce63c79a3b))
+
 ## [1.4.0](https://github.com/lilaquadrat/interfaces/compare/v1.3.1...v1.4.0) (2024-02-21)
 
 

package/lib/cjs/AppHostingSettings.d.ts

@@ -0,0 +1,11 @@
+export interface AppHostingSettings {
+    /**
+     * redirects all configured domains to the main domain
+     */
+    redirectToMainDomain?: boolean;
+    /**
+     * enables a catch all route to index.html if the file does not exist.
+     * e.g. /content1 will end up at index.html if content1.html does not exist.
+     */
+    isApp?: boolean;
+}

package/lib/cjs/DomainConf.d.ts

@@ -8,6 +8,10 @@ export interface DomainConf {
     };
     company: string;
     project: string;
+    isMain?: boolean;
+    /**
+     * defines if the domain is a default domain that is created by the system for preview purposes
+     */
     defaultDomain?: string;
     certificate?: string;
 }

package/lib/cjs/Hosting.d.ts

@@ -1,4 +1,5 @@
-export interface Hosting {
+import { AppHostingSettings } from "./AppHostingSettings";
+export interface Hosting extends AppHostingSettings {
     project: string;
     company: string;
     active?: boolean;

package/lib/cjs/Publish.d.ts

@@ -22,4 +22,5 @@ export interface Publish {
         id: number | string;
         name?: string;
     };
+    recipient?: ObjectId;
 }

package/lib/cjs/PublishMethod.d.ts

@@ -1,11 +1,13 @@
+import { ObjectId } from "mongodb";
 import { Content } from "./Content";
 import { PublishContentGroup } from "./PublishContentGroup";
 export interface PublishMethod {
-    type: 'ftp' | 'webhook' | 'internal' | 'pdf';
+    type: 'ftp' | 'webhook' | 'internal' | 'pdf' | 'email';
     active: boolean;
     label: string;
     availableForApps: string[];
     availableForContentGroups: PublishContentGroup[];
+    contextData: ObjectId[];
     affectedStates?: Content['state'][];
     [key: string]: any;
 }

package/lib/cjs/PublishMethodEmail.d.ts

@@ -0,0 +1,4 @@
+import { PublishMethod } from "./PublishMethod";
+export interface PublishMethodEmail extends PublishMethod {
+    type: 'email';
+}

package/lib/cjs/StudioIframeMessage.d.ts

@@ -5,9 +5,6 @@ export interface StudioIframeMessage {
     data: {
         type: 'studio-cookie-reset';
         data: undefined;
-    } | {
-        type: 'studio-editor-settings';
-        data: AppEditorConfiguration;
     } | {
         type: 'studio-active';
         data: EditorActiveModule;
@@ -15,7 +12,10 @@ export interface StudioIframeMessage {
         type: 'studio-content';
         data: Content['modules'];
     } | {
-        type: 'studio-settings';
+        type: 'studio-editor-settings';
         data: Omit<Content, 'modules' | 'genericData' | 'childData'>;
+    } | {
+        type: 'studio-settings';
+        data: AppEditorConfiguration;
     };
 }

package/lib/cjs/index.d.ts

@@ -9,6 +9,7 @@ export * from './App';
 export * from './AppEditorConfiguration';
 export * from './AppEditorTitleDescription';
 export * from './AppFilter';
+export * from './AppHostingSettings';
 export * from './AppPermissions';
 export * from './Auth0ProjectSettings';
 export * from './AvailableStorageTypes';
@@ -97,6 +98,7 @@ export * from './ProjectDomain';
 export * from './Publish';
 export * from './PublishContentGroup';
 export * from './PublishMethod';
+export * from './PublishMethodEmail';
 export * from './PublishMethodFtp';
 export * from './PublishMethodInternal';
 export * from './PublishMethodPdf';

package/lib/esm/AppHostingSettings.d.ts

@@ -0,0 +1,11 @@
+export interface AppHostingSettings {
+    /**
+     * redirects all configured domains to the main domain
+     */
+    redirectToMainDomain?: boolean;
+    /**
+     * enables a catch all route to index.html if the file does not exist.
+     * e.g. /content1 will end up at index.html if content1.html does not exist.
+     */
+    isApp?: boolean;
+}

package/lib/esm/AppHostingSettings.js

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

package/lib/esm/AppHostingSettings.js.map

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

package/lib/esm/DomainConf.d.ts

@@ -8,6 +8,10 @@ export interface DomainConf {
     };
     company: string;
     project: string;
+    isMain?: boolean;
+    /**
+     * defines if the domain is a default domain that is created by the system for preview purposes
+     */
     defaultDomain?: string;
     certificate?: string;
 }

package/lib/esm/Hosting.d.ts

@@ -1,4 +1,5 @@
-export interface Hosting {
+import { AppHostingSettings } from "./AppHostingSettings";
+export interface Hosting extends AppHostingSettings {
     project: string;
     company: string;
     active?: boolean;

package/lib/esm/Publish.d.ts

@@ -22,4 +22,5 @@ export interface Publish {
         id: number | string;
         name?: string;
     };
+    recipient?: ObjectId;
 }

package/lib/esm/PublishMethod.d.ts

@@ -1,11 +1,13 @@
+import { ObjectId } from "mongodb";
 import { Content } from "./Content";
 import { PublishContentGroup } from "./PublishContentGroup";
 export interface PublishMethod {
-    type: 'ftp' | 'webhook' | 'internal' | 'pdf';
+    type: 'ftp' | 'webhook' | 'internal' | 'pdf' | 'email';
     active: boolean;
     label: string;
     availableForApps: string[];
     availableForContentGroups: PublishContentGroup[];
+    contextData: ObjectId[];
     affectedStates?: Content['state'][];
     [key: string]: any;
 }

package/lib/esm/PublishMethodEmail.d.ts

@@ -0,0 +1,4 @@
+import { PublishMethod } from "./PublishMethod";
+export interface PublishMethodEmail extends PublishMethod {
+    type: 'email';
+}

package/lib/esm/PublishMethodEmail.js

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

package/lib/esm/PublishMethodEmail.js.map

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

package/lib/esm/StudioIframeMessage.d.ts

@@ -5,9 +5,6 @@ export interface StudioIframeMessage {
     data: {
         type: 'studio-cookie-reset';
         data: undefined;
-    } | {
-        type: 'studio-editor-settings';
-        data: AppEditorConfiguration;
     } | {
         type: 'studio-active';
         data: EditorActiveModule;
@@ -15,7 +12,10 @@ export interface StudioIframeMessage {
         type: 'studio-content';
         data: Content['modules'];
     } | {
-        type: 'studio-settings';
+        type: 'studio-editor-settings';
         data: Omit<Content, 'modules' | 'genericData' | 'childData'>;
+    } | {
+        type: 'studio-settings';
+        data: AppEditorConfiguration;
     };
 }

package/lib/esm/index.d.ts

@@ -9,6 +9,7 @@ export * from './App';
 export * from './AppEditorConfiguration';
 export * from './AppEditorTitleDescription';
 export * from './AppFilter';
+export * from './AppHostingSettings';
 export * from './AppPermissions';
 export * from './Auth0ProjectSettings';
 export * from './AvailableStorageTypes';
@@ -97,6 +98,7 @@ export * from './ProjectDomain';
 export * from './Publish';
 export * from './PublishContentGroup';
 export * from './PublishMethod';
+export * from './PublishMethodEmail';
 export * from './PublishMethodFtp';
 export * from './PublishMethodInternal';
 export * from './PublishMethodPdf';

package/package.json

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

package/src/AppHostingSettings.ts

@@ -0,0 +1,11 @@
+export interface AppHostingSettings {
+    /**
+     * redirects all configured domains to the main domain
+     */
+    redirectToMainDomain?: boolean
+    /**
+     * enables a catch all route to index.html if the file does not exist.
+     * e.g. /content1 will end up at index.html if content1.html does not exist.
+     */
+    isApp?: boolean
+}

package/src/DomainConf.ts

@@ -14,6 +14,11 @@ export interface DomainConf {
   company: string
   project: string
 
+  isMain?: boolean
+
+  /**
+   * defines if the domain is a default domain that is created by the system for preview purposes
+   */
   defaultDomain?: string
 
   certificate?: string

package/src/Hosting.ts

@@ -1,4 +1,6 @@
-export interface Hosting {
+import { AppHostingSettings } from "./AppHostingSettings";
+
+export interface Hosting extends AppHostingSettings {
   project: string;
   company: string;
 

package/src/Publish.ts

@@ -40,4 +40,6 @@ export interface Publish {
     modelPublish?: string
   
     publishData?: {id: number | string, name?: string}
+
+    recipient?: ObjectId;
   }

package/src/PublishMethod.ts

@@ -1,9 +1,10 @@
-import {Content} from "./Content"
+import { ObjectId } from "mongodb"
+import { Content } from "./Content"
 import { PublishContentGroup } from "./PublishContentGroup"
 
 export interface PublishMethod {
 
-  type: 'ftp' | 'webhook' | 'internal' | 'pdf'
+  type: 'ftp' | 'webhook' | 'internal' | 'pdf' | 'email'
 
   active: boolean
 
@@ -13,6 +14,8 @@ export interface PublishMethod {
 
   availableForContentGroups: PublishContentGroup[]
 
+  contextData: ObjectId[]
+
   affectedStates?: Content['state'][]
 
   [key: string]: any

package/src/PublishMethodEmail.ts

@@ -0,0 +1,7 @@
+import { PublishMethod } from "./PublishMethod";
+
+export interface PublishMethodEmail extends PublishMethod {
+
+  type: 'email'
+
+}

package/src/StudioIframeMessage.ts

@@ -5,9 +5,9 @@ import { EditorActiveModule } from "./EditorActiveModule"
 export interface StudioIframeMessage {
   data:
   { type: 'studio-cookie-reset', data: undefined }
-  | { type: 'studio-editor-settings', data: AppEditorConfiguration }
   | { type: 'studio-active', data: EditorActiveModule }
   | { type: 'studio-content', data: Content['modules'] }
-  | { type: 'studio-settings', data: Omit<Content, 'modules' | 'genericData' | 'childData'> }
+  | { type: 'studio-editor-settings', data: Omit<Content, 'modules' | 'genericData' | 'childData'> }
+  | { type: 'studio-settings', data: AppEditorConfiguration }
 
 }