@lilaquadrat/interfaces 1.3.1 → 1.5.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.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)
+
+
+### Features
+
+* **mepermissions & content:** added target to content and added me permissions ([bb6141f](https://github.com/lilaquadrat/interfaces/commit/bb6141f3425f370a0de0baf669ce1ae97d90a721))
+
 ### [1.3.1](https://github.com/lilaquadrat/interfaces/compare/v1.3.0...v1.3.1) (2024-02-17)
 
 

package/lib/cjs/AppEditorConfiguration.d.ts

@@ -0,0 +1,10 @@
+import { AppEditorTitleDescription } from "./AppEditorTitleDescription";
+export interface AppEditorConfiguration {
+    editorUrl: string;
+    breakpointTablet: string;
+    breakpointDesktop: string;
+    breakpointWide: string;
+    preloadImages: boolean;
+    title: AppEditorTitleDescription;
+    description: AppEditorTitleDescription;
+}

package/lib/cjs/AppEditorTitleDescription.d.ts

@@ -0,0 +1,4 @@
+export interface AppEditorTitleDescription {
+    full: string;
+    short: string;
+}

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/Content.d.ts

@@ -13,6 +13,7 @@ export interface Content {
     layout?: boolean;
     state: 'draft' | 'publish';
     language?: string;
+    target?: 'browser' | 'mail';
     settings: {
         url?: string;
         useLayout?: ObjectId;

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/MePermissions.d.ts

@@ -0,0 +1,8 @@
+import { MePermissionsProject } from "./MePermissionsProject";
+import { ScopeObject } from "./Scope";
+export interface MePermissions {
+    _id: string;
+    name: string;
+    scope: ScopeObject;
+    projects: MePermissionsProject[];
+}

package/lib/cjs/MePermissionsProject.d.ts

@@ -0,0 +1,8 @@
+import { ScopeObject } from "./Scope";
+export interface MePermissionsProject {
+    scope: ScopeObject;
+    company: string;
+    project: string;
+    name: string;
+    id: string;
+}

package/lib/cjs/StudioIframeMessage.d.ts

@@ -1,6 +1,21 @@
-export interface StudioIframeMessage<T> {
+import { AppEditorConfiguration } from "./AppEditorConfiguration";
+import { Content } from "./Content";
+import { EditorActiveModule } from "./EditorActiveModule";
+export interface StudioIframeMessage {
     data: {
-        type: 'studio-content' | 'studio-editor-settings' | 'studio-settings' | 'studio-active' | 'studio-cookie-reset';
-        data: T;
+        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'>;
     };
 }

package/lib/cjs/index.d.ts

@@ -6,7 +6,10 @@ export * from './Agreement';
 export * from './AgreementResponse';
 export * from './ApiResponses';
 export * from './App';
+export * from './AppEditorConfiguration';
+export * from './AppEditorTitleDescription';
 export * from './AppFilter';
+export * from './AppHostingSettings';
 export * from './AppPermissions';
 export * from './Auth0ProjectSettings';
 export * from './AvailableStorageTypes';
@@ -72,6 +75,8 @@ export * from './ListParticipants';
 export * from './ListParticipantsDetails';
 export * from './Location';
 export * from './Me';
+export * from './MePermissions';
+export * from './MePermissionsProject';
 export * from './Media';
 export * from './MediaContentFiles';
 export * from './MediaInfo';

package/lib/esm/AppEditorConfiguration.d.ts

@@ -0,0 +1,10 @@
+import { AppEditorTitleDescription } from "./AppEditorTitleDescription";
+export interface AppEditorConfiguration {
+    editorUrl: string;
+    breakpointTablet: string;
+    breakpointDesktop: string;
+    breakpointWide: string;
+    preloadImages: boolean;
+    title: AppEditorTitleDescription;
+    description: AppEditorTitleDescription;
+}

package/lib/esm/AppEditorConfiguration.js

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

package/lib/esm/AppEditorConfiguration.js.map

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

package/lib/esm/AppEditorTitleDescription.d.ts

@@ -0,0 +1,4 @@
+export interface AppEditorTitleDescription {
+    full: string;
+    short: string;
+}

package/lib/esm/AppEditorTitleDescription.js

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

package/lib/esm/AppEditorTitleDescription.js.map

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

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/Content.d.ts

@@ -13,6 +13,7 @@ export interface Content {
     layout?: boolean;
     state: 'draft' | 'publish';
     language?: string;
+    target?: 'browser' | 'mail';
     settings: {
         url?: string;
         useLayout?: ObjectId;

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/MePermissions.d.ts

@@ -0,0 +1,8 @@
+import { MePermissionsProject } from "./MePermissionsProject";
+import { ScopeObject } from "./Scope";
+export interface MePermissions {
+    _id: string;
+    name: string;
+    scope: ScopeObject;
+    projects: MePermissionsProject[];
+}

package/lib/esm/MePermissions.js

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

package/lib/esm/MePermissions.js.map

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

package/lib/esm/MePermissionsProject.d.ts

@@ -0,0 +1,8 @@
+import { ScopeObject } from "./Scope";
+export interface MePermissionsProject {
+    scope: ScopeObject;
+    company: string;
+    project: string;
+    name: string;
+    id: string;
+}

package/lib/esm/MePermissionsProject.js

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

package/lib/esm/MePermissionsProject.js.map

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

package/lib/esm/StudioIframeMessage.d.ts

@@ -1,6 +1,21 @@
-export interface StudioIframeMessage<T> {
+import { AppEditorConfiguration } from "./AppEditorConfiguration";
+import { Content } from "./Content";
+import { EditorActiveModule } from "./EditorActiveModule";
+export interface StudioIframeMessage {
     data: {
-        type: 'studio-content' | 'studio-editor-settings' | 'studio-settings' | 'studio-active' | 'studio-cookie-reset';
-        data: T;
+        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'>;
     };
 }

package/lib/esm/index.d.ts

@@ -6,7 +6,10 @@ export * from './Agreement';
 export * from './AgreementResponse';
 export * from './ApiResponses';
 export * from './App';
+export * from './AppEditorConfiguration';
+export * from './AppEditorTitleDescription';
 export * from './AppFilter';
+export * from './AppHostingSettings';
 export * from './AppPermissions';
 export * from './Auth0ProjectSettings';
 export * from './AvailableStorageTypes';
@@ -72,6 +75,8 @@ export * from './ListParticipants';
 export * from './ListParticipantsDetails';
 export * from './Location';
 export * from './Me';
+export * from './MePermissions';
+export * from './MePermissionsProject';
 export * from './Media';
 export * from './MediaContentFiles';
 export * from './MediaInfo';

package/package.json

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

package/src/AppEditorConfiguration.ts

@@ -0,0 +1,11 @@
+import { AppEditorTitleDescription } from "./AppEditorTitleDescription"
+
+export interface AppEditorConfiguration {
+    editorUrl: string
+    breakpointTablet: string
+    breakpointDesktop: string
+    breakpointWide: string
+    preloadImages: boolean
+    title: AppEditorTitleDescription
+    description: AppEditorTitleDescription
+}

package/src/AppEditorTitleDescription.ts

@@ -0,0 +1,4 @@
+export interface AppEditorTitleDescription {
+    full: string
+    short: string
+}

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/Content.ts

@@ -14,6 +14,7 @@ export interface Content {
   layout?: boolean
   state: 'draft' | 'publish'
   language?: string
+  target?: 'browser' | 'mail'
   settings: {
     url?: string
     useLayout?: ObjectId

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/MePermissions.ts

@@ -0,0 +1,9 @@
+import { MePermissionsProject } from "./MePermissionsProject"
+import { ScopeObject } from "./Scope"
+
+export interface MePermissions {
+    _id: string
+    name: string
+    scope: ScopeObject
+    projects: MePermissionsProject[]
+}

package/src/MePermissionsProject.ts

@@ -0,0 +1,11 @@
+import { ScopeObject } from "./Scope"
+
+export interface MePermissionsProject {
+
+    scope: ScopeObject
+    company: string
+    project: string
+    name: string
+    id: string
+
+}

package/src/StudioIframeMessage.ts

@@ -1,6 +1,13 @@
-export interface StudioIframeMessage<T> {
-  data: {
-    type: 'studio-content' | 'studio-editor-settings' | 'studio-settings' | 'studio-active' | 'studio-cookie-reset'
-    data: T
-  }
+import { AppEditorConfiguration } from "./AppEditorConfiguration"
+import { Content } from "./Content"
+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'> }
+
 }