@lilaquadrat/interfaces 1.17.0 → 1.18.1

package/CHANGELOG.md

@@ -2,6 +2,25 @@
 
 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.18.1](https://github.com/lilaquadrat/interfaces/compare/v1.18.0...v1.18.1) (2025-02-02)
+
+
+### Bug Fixes
+
+* **hostingcommand:** fixed hosting command for current hosting implementation ([6e5fc95](https://github.com/lilaquadrat/interfaces/commit/6e5fc95d7259060645ccc7252cad57be0d8daef5))
+
+## [1.18.0](https://github.com/lilaquadrat/interfaces/compare/v1.17.0...v1.18.0) (2025-02-02)
+
+
+### Features
+
+* **exportdata, importjob:** added import and export interfaces ([908a741](https://github.com/lilaquadrat/interfaces/commit/908a74116d244253ac19363435cf4aadf452aa13))
+
+
+### Bug Fixes
+
+* **exportdata:** made keys optional ([5abadb6](https://github.com/lilaquadrat/interfaces/commit/5abadb6c3fc369dad454a824aeba64d65cce5b3b))
+
 ## [1.17.0](https://github.com/lilaquadrat/interfaces/compare/v1.16.0...v1.17.0) (2025-01-14)
 
 

package/lib/cjs/Content.d.ts

@@ -1,7 +1,7 @@
-import type { ObjectId } from "mongodb";
 import { ChildData } from "./ChildData";
 import { GenericData } from "./GenericData";
 import { ModuleGeneric } from "./ModuleGeneric";
+import { ObjectIdString } from "./ObjectIdString";
 export interface Content {
     id: string;
     company: string;
@@ -16,7 +16,7 @@ export interface Content {
     target?: 'browser' | 'mail';
     settings: {
         url?: string;
-        useLayout?: ObjectId;
+        useLayout?: ObjectIdString;
         title?: string;
         description?: string;
         noSSR?: boolean;

package/lib/cjs/ExportData.d.ts

@@ -0,0 +1,15 @@
+export interface ExportData {
+    company: string;
+    project: string;
+    created: number;
+    files?: string[];
+    filesize?: number;
+    path?: string;
+    metadata?: {
+        createdAt?: string;
+        company?: string;
+        project?: string;
+        selectedServices?: string[];
+        statistics?: Record<string, number>;
+    };
+}

package/lib/cjs/HostindCommand.d.ts

@@ -1,6 +1,7 @@
-import { CommandNginx } from "./CommandNginx";
+import { Command } from "./Command";
 export interface HostingCommand {
-    command: CommandNginx;
+    target: 'nginx' | 'docker';
+    command: Command<HostingCommand['target']>;
     date: Date;
     state: 'new' | 'inProgress' | 'success' | 'error';
     data: {
@@ -10,6 +11,7 @@ export interface HostingCommand {
     company?: string;
     project?: string;
     after?: {
-        command: CommandNginx;
+        target: 'nginx' | 'docker';
+        command: Command<HostingCommand['target']>;
     };
 }

package/lib/cjs/ImportExportData.d.ts

@@ -0,0 +1,22 @@
+import { BasicData } from "./BasicData";
+import { Content } from "./Content";
+import { Customers } from "./Customers";
+import { Hosting } from "./Hosting";
+import { List } from "./List";
+import { ListParticipants } from "./ListParticipants";
+import { Media } from "./Media";
+import { Payment } from "./Payment";
+import { PaymentProvider } from "./PaymentProvider";
+import { PublishMethod } from "./PublishMethod";
+export interface ImportExportData {
+    editor: BasicData<Content>[];
+    hosting: BasicData<Hosting>[];
+    lists: BasicData<List>[];
+    listParticipants: BasicData<ListParticipants>[];
+    payments: BasicData<Payment>[];
+    paymentsProviders: BasicData<PaymentProvider>[];
+    publishMethod: BasicData<PublishMethod>[];
+    media: BasicData<Media>[];
+    customers: BasicData<Customers>[];
+    permissions: BasicData<Permissions>[];
+}

package/lib/cjs/ImportJob.d.ts

@@ -0,0 +1,23 @@
+export interface ImportJob {
+    /**
+     * List of services to import
+     */
+    services: string[];
+    /**
+     * Current state of the import job
+     */
+    state: 'new' | 'running' | 'done' | 'failed';
+    /**
+     * Path to the import files
+     */
+    path: string;
+    cdn?: string;
+    /**
+     * Target company for the import
+     */
+    targetCompany: string;
+    /**
+     * Target project for the import
+     */
+    targetProject: string;
+}

package/lib/cjs/ProjectWithCompany.d.ts

@@ -0,0 +1,7 @@
+import { Project } from "./Project";
+export interface ProjectWithCompany extends Omit<Project, 'company'> {
+    company: {
+        name: string;
+        id: string;
+    };
+}

package/lib/cjs/PublishMethod.d.ts

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

package/lib/cjs/ShareClient.d.ts

@@ -25,6 +25,8 @@ export interface ShareClientInterface {
     remove(folder: string, file: string): Promise<boolean>;
     update(folder: string, filename: string, data: string | Buffer): Promise<boolean>;
     get(folder: string, filename: string): Promise<Buffer>;
-    list(folder: string, filter: RegExp): Promise<string[]>;
+    list(folder: string, filter: RegExp, options?: {
+        fullPath?: boolean;
+    }): Promise<string[]>;
     copy(files: string[], sourceFolder: string, destinationFolder: string): Promise<boolean>;
 }

package/lib/cjs/index.d.ts

@@ -58,6 +58,7 @@ export * from './EditorBase';
 export * from './EditorLegacy';
 export * from './EmailsContent';
 export * from './ErrorObject';
+export * from './ExportData';
 export * from './GenericData';
 export * from './GenericDataDistributed';
 export * from './GenericDataWithContent';
@@ -72,6 +73,8 @@ export * from './HostingWithSettings';
 export * from './HttpStatusCodes';
 export * from './Id';
 export * from './IdentifiersEntity';
+export * from './ImportExportData';
+export * from './ImportJob';
 export * from './List';
 export * from './ListCategory';
 export * from './ListContent';
@@ -109,6 +112,7 @@ export * from './PermissionsWithScope';
 export * from './Price';
 export * from './Project';
 export * from './ProjectDomain';
+export * from './ProjectWithCompany';
 export * from './Publish';
 export * from './PublishContentGroup';
 export * from './PublishMethod';

package/lib/esm/Content.d.ts

@@ -1,7 +1,7 @@
-import type { ObjectId } from "mongodb";
 import { ChildData } from "./ChildData";
 import { GenericData } from "./GenericData";
 import { ModuleGeneric } from "./ModuleGeneric";
+import { ObjectIdString } from "./ObjectIdString";
 export interface Content {
     id: string;
     company: string;
@@ -16,7 +16,7 @@ export interface Content {
     target?: 'browser' | 'mail';
     settings: {
         url?: string;
-        useLayout?: ObjectId;
+        useLayout?: ObjectIdString;
         title?: string;
         description?: string;
         noSSR?: boolean;

package/lib/esm/ExportData.d.ts

@@ -0,0 +1,15 @@
+export interface ExportData {
+    company: string;
+    project: string;
+    created: number;
+    files?: string[];
+    filesize?: number;
+    path?: string;
+    metadata?: {
+        createdAt?: string;
+        company?: string;
+        project?: string;
+        selectedServices?: string[];
+        statistics?: Record<string, number>;
+    };
+}

package/lib/esm/ExportData.js

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

package/lib/esm/ExportData.js.map

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

package/lib/esm/HostindCommand.d.ts

@@ -1,6 +1,7 @@
-import { CommandNginx } from "./CommandNginx";
+import { Command } from "./Command";
 export interface HostingCommand {
-    command: CommandNginx;
+    target: 'nginx' | 'docker';
+    command: Command<HostingCommand['target']>;
     date: Date;
     state: 'new' | 'inProgress' | 'success' | 'error';
     data: {
@@ -10,6 +11,7 @@ export interface HostingCommand {
     company?: string;
     project?: string;
     after?: {
-        command: CommandNginx;
+        target: 'nginx' | 'docker';
+        command: Command<HostingCommand['target']>;
     };
 }

package/lib/esm/ImportExportData.d.ts

@@ -0,0 +1,22 @@
+import { BasicData } from "./BasicData";
+import { Content } from "./Content";
+import { Customers } from "./Customers";
+import { Hosting } from "./Hosting";
+import { List } from "./List";
+import { ListParticipants } from "./ListParticipants";
+import { Media } from "./Media";
+import { Payment } from "./Payment";
+import { PaymentProvider } from "./PaymentProvider";
+import { PublishMethod } from "./PublishMethod";
+export interface ImportExportData {
+    editor: BasicData<Content>[];
+    hosting: BasicData<Hosting>[];
+    lists: BasicData<List>[];
+    listParticipants: BasicData<ListParticipants>[];
+    payments: BasicData<Payment>[];
+    paymentsProviders: BasicData<PaymentProvider>[];
+    publishMethod: BasicData<PublishMethod>[];
+    media: BasicData<Media>[];
+    customers: BasicData<Customers>[];
+    permissions: BasicData<Permissions>[];
+}

package/lib/esm/ImportExportData.js

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

package/lib/esm/ImportExportData.js.map

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

package/lib/esm/ImportJob.d.ts

@@ -0,0 +1,23 @@
+export interface ImportJob {
+    /**
+     * List of services to import
+     */
+    services: string[];
+    /**
+     * Current state of the import job
+     */
+    state: 'new' | 'running' | 'done' | 'failed';
+    /**
+     * Path to the import files
+     */
+    path: string;
+    cdn?: string;
+    /**
+     * Target company for the import
+     */
+    targetCompany: string;
+    /**
+     * Target project for the import
+     */
+    targetProject: string;
+}

package/lib/esm/ImportJob.js

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

package/lib/esm/ImportJob.js.map

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

package/lib/esm/ProjectWithCompany.d.ts

@@ -0,0 +1,7 @@
+import { Project } from "./Project";
+export interface ProjectWithCompany extends Omit<Project, 'company'> {
+    company: {
+        name: string;
+        id: string;
+    };
+}

package/lib/esm/ProjectWithCompany.js

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

package/lib/esm/ProjectWithCompany.js.map

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

package/lib/esm/PublishMethod.d.ts

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

package/lib/esm/ShareClient.d.ts

@@ -25,6 +25,8 @@ export interface ShareClientInterface {
     remove(folder: string, file: string): Promise<boolean>;
     update(folder: string, filename: string, data: string | Buffer): Promise<boolean>;
     get(folder: string, filename: string): Promise<Buffer>;
-    list(folder: string, filter: RegExp): Promise<string[]>;
+    list(folder: string, filter: RegExp, options?: {
+        fullPath?: boolean;
+    }): Promise<string[]>;
     copy(files: string[], sourceFolder: string, destinationFolder: string): Promise<boolean>;
 }

package/lib/esm/index.d.ts

@@ -58,6 +58,7 @@ export * from './EditorBase';
 export * from './EditorLegacy';
 export * from './EmailsContent';
 export * from './ErrorObject';
+export * from './ExportData';
 export * from './GenericData';
 export * from './GenericDataDistributed';
 export * from './GenericDataWithContent';
@@ -72,6 +73,8 @@ export * from './HostingWithSettings';
 export * from './HttpStatusCodes';
 export * from './Id';
 export * from './IdentifiersEntity';
+export * from './ImportExportData';
+export * from './ImportJob';
 export * from './List';
 export * from './ListCategory';
 export * from './ListContent';
@@ -109,6 +112,7 @@ export * from './PermissionsWithScope';
 export * from './Price';
 export * from './Project';
 export * from './ProjectDomain';
+export * from './ProjectWithCompany';
 export * from './Publish';
 export * from './PublishContentGroup';
 export * from './PublishMethod';

package/package.json

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

package/src/Content.ts

@@ -1,7 +1,7 @@
-import type { ObjectId } from "mongodb"
 import { ChildData } from "./ChildData"
 import { GenericData } from "./GenericData"
 import { ModuleGeneric } from "./ModuleGeneric"
+import { ObjectIdString } from "./ObjectIdString"
 
 export interface Content {
   id: string
@@ -17,7 +17,7 @@ export interface Content {
   target?: 'browser' | 'mail'
   settings: {
     url?: string
-    useLayout?: ObjectId
+    useLayout?: ObjectIdString
     title?: string
     description?: string
     noSSR?: boolean

package/src/ExportData.ts

@@ -0,0 +1,15 @@
+export interface ExportData {
+  company: string;
+  project: string;
+  created: number;
+  files?: string[];
+  filesize?: number;
+  path?: string;
+  metadata?: {
+    createdAt?: string;
+    company?: string;
+    project?: string;
+    selectedServices?: string[];
+    statistics?: Record<string, number>;
+  };
+}

package/src/HostindCommand.ts

@@ -1,14 +1,17 @@
-import { CommandNginx } from "./CommandNginx";
-
+import { Command } from "./Command";
 export interface HostingCommand {
-  command: CommandNginx;
-  date: Date;
-  state: 'new' | 'inProgress' | 'success' | 'error';
-  data: { [key: string]: any };
-  batchId?: string;
-  company?: string;
-  project?: string;
-  after?: {
-    command: CommandNginx;
-  };
-}
+    target: 'nginx' | 'docker';
+    command: Command<HostingCommand['target']>;
+    date: Date;
+    state: 'new' | 'inProgress' | 'success' | 'error';
+    data: {
+        [key: string]: any;
+    };
+    batchId?: string;
+    company?: string;
+    project?: string;
+    after?: {
+        target: 'nginx' | 'docker';
+        command: Command<HostingCommand['target']>;
+    };
+}

package/src/ImportExportData.ts

@@ -0,0 +1,23 @@
+import { BasicData } from "./BasicData";
+import { Content } from "./Content";
+import { Customers } from "./Customers";
+import { Hosting } from "./Hosting";
+import { List } from "./List";
+import { ListParticipants } from "./ListParticipants";
+import { Media } from "./Media";
+import { Payment } from "./Payment";
+import { PaymentProvider } from "./PaymentProvider";
+import { PublishMethod } from "./PublishMethod";
+
+export interface ImportExportData {
+    editor: BasicData<Content>[]
+    hosting: BasicData<Hosting>[]
+    lists: BasicData<List>[]
+    listParticipants: BasicData<ListParticipants>[]
+    payments: BasicData<Payment>[]
+    paymentsProviders: BasicData<PaymentProvider>[]
+    publishMethod: BasicData<PublishMethod>[]
+    media: BasicData<Media>[]
+    customers: BasicData<Customers>[]
+    permissions: BasicData<Permissions>[]
+}

package/src/ImportJob.ts

@@ -0,0 +1,28 @@
+export interface ImportJob {
+  /**
+   * List of services to import
+   */
+  services: string[];
+
+  /**
+   * Current state of the import job
+   */
+  state: 'new' | 'running' | 'done' | 'failed';
+
+  /**
+   * Path to the import files
+   */
+  path: string;
+
+  cdn?: string;
+
+  /**
+   * Target company for the import
+   */
+  targetCompany: string;
+
+  /**
+   * Target project for the import
+   */
+  targetProject: string;
+}

package/src/ProjectWithCompany.ts

@@ -0,0 +1,7 @@
+import { Project } from "./Project"
+
+export interface ProjectWithCompany extends Omit<Project, 'company'> {
+
+  company: {name: string, id: string}
+
+}

package/src/PublishMethod.ts

@@ -1,6 +1,6 @@
-import { ObjectId } from "mongodb"
 import { Content } from "./Content"
 import { PublishContentGroup } from "./PublishContentGroup"
+import { ObjectIdString } from "./ObjectIdString"
 
 export interface PublishMethod {
 
@@ -14,7 +14,7 @@ export interface PublishMethod {
 
   availableForContentGroups: PublishContentGroup[]
 
-  contextData: ObjectId[]
+  contextData: ObjectIdString[]
 
   affectedStates?: Content['state'][]
 

package/src/ShareClient.ts

@@ -29,7 +29,7 @@ export interface ShareClientInterface {
 
   get(folder: string, filename: string): Promise<Buffer>;
 
-  list(folder: string, filter: RegExp): Promise<string[]>;
+  list(folder: string, filter: RegExp, options?: {fullPath?: boolean}): Promise<string[]>;
 
   copy(files: string[], sourceFolder: string, destinationFolder: string): Promise<boolean>;