@serve.zone/interfaces 1.0.10 → 1.0.13

package/dist_ts/00_commitinfo_data.js

@@ -3,7 +3,7 @@
  */
 export const commitinfo = {
     name: '@serve.zone/interfaces',
-    version: '1.0.10',
+    version: '1.0.13',
     description: 'interfaces for working with containers'
 };
 //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiMDBfY29tbWl0aW5mb19kYXRhLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvMDBfY29tbWl0aW5mb19kYXRhLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBOztHQUVHO0FBQ0gsTUFBTSxDQUFDLE1BQU0sVUFBVSxHQUFHO0lBQ3hCLElBQUksRUFBRSx3QkFBd0I7SUFDOUIsT0FBTyxFQUFFLFFBQVE7SUFDakIsV0FBVyxFQUFFLHdDQUF3QztDQUN0RCxDQUFBIn0=

package/dist_ts/config/cluster.d.ts

@@ -1,5 +1,7 @@
 import { type IDockerRegistryInfo, type IServiceRessources } from './docker.js';
+import type { IServerConfig } from './server.js';
 export interface IClusterConfig {
+    id: string;
     name: string;
     zone: 'servezone' | 'gitzone' | 'shipzone' | 'umbrellazone' | 'trafficzone' | 'proxyzone';
     type: 'cluster';
@@ -8,6 +10,7 @@ export interface IClusterConfig {
     jumpCodeUsedAt: number;
     manager_domain: string;
     manager_ip: string;
+    servers: IServerConfig[];
     containers: IClusterConfigContainer[];
     acmeInfo: {
         serverAddress: string;

package/dist_ts/data/cluster.d.ts

@@ -1,4 +1,50 @@
+import { type IDockerRegistryInfo, type IServiceRessources } from '../data/docker.js';
+import type { IServerConfig } from './server.js';
 export interface IClusterIdentifier {
     clusterName: string;
     secretKey: string;
 }
+export interface IClusterConfig {
+    id: string;
+    data: {
+        name: string;
+        secretKey: string;
+        jumpCode: string;
+        jumpCodeUsedAt: number;
+        /**
+         * how can the cluster reach cloudly
+         */
+        cloudlyUrl: string;
+        /**
+         * what servers are expected to be part of the cluster
+         */
+        servers: IServerConfig[];
+        /**
+         * the containers running
+         */
+        containers: IClusterConfigContainer[];
+        /**
+         *
+         */
+        acmeInfo: {
+            serverAddress: string;
+            serverSecret: string;
+        };
+        registryInfo: IDockerRegistryInfo;
+    };
+}
+export interface IClusterConfigContainer {
+    name: string;
+    image: string;
+    ports: {
+        web: number;
+        custom?: {
+            [domain: string]: string;
+        };
+    };
+    resources?: IServiceRessources;
+    domains: string[];
+    secrets: {
+        [key: string]: string;
+    };
+}

package/dist_ts/data/cluster.js

@@ -1,2 +1,2 @@
-export {};
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2x1c3Rlci5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3RzL2RhdGEvY2x1c3Rlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIn0=
+import {} from '../data/docker.js';
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2x1c3Rlci5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3RzL2RhdGEvY2x1c3Rlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQXFELE1BQU0sbUJBQW1CLENBQUMifQ==

package/dist_ts/data/config.d.ts

@@ -1,3 +1 @@
-export * from '../config/cluster.js';
-export * from '../config/server.js';
 export type TConfigType = 'server' | 'cluster' | 'coreflow' | 'service';

package/dist_ts/data/config.js

@@ -1,6 +1,2 @@
-/* ==========
-This file exports all config interfaces for easier access under module.config.[anyconfig]
-// ========== */
-export * from '../config/cluster.js';
-export * from '../config/server.js';
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uZmlnLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vdHMvZGF0YS9jb25maWcudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUE7O2dCQUVnQjtBQUVoQixjQUFjLHNCQUFzQixDQUFDO0FBQ3JDLGNBQWMscUJBQXFCLENBQUMifQ==
+export {};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uZmlnLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vdHMvZGF0YS9jb25maWcudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiJ9

package/dist_ts/data/docker.d.ts

@@ -0,0 +1,10 @@
+import * as plugins from '../plugins.js';
+export interface IDockerRegistryInfo {
+    serveraddress: string;
+    username: string;
+    password: string;
+}
+export interface IServiceRessources {
+    memorySizeMB?: number;
+    volumeMounts?: plugins.tsclass.container.IVolumeMount[];
+}

package/dist_ts/data/docker.js

@@ -0,0 +1,2 @@
+import * as plugins from '../plugins.js';
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZG9ja2VyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vdHMvZGF0YS9kb2NrZXIudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxLQUFLLE9BQU8sTUFBTSxlQUFlLENBQUMifQ==

package/dist_ts/data/index.d.ts

@@ -1,8 +1,10 @@
 export * from './cluster.js';
 export * from './config.js';
+export * from './docker.js';
 export * from './env.js';
 export * from './event.js';
 export * from './secret.js';
+export * from './server.js';
 export * from './status.js';
 export * from './traffic.js';
 export * from './version.js';

package/dist_ts/data/index.js

@@ -1,9 +1,11 @@
 export * from './cluster.js';
 export * from './config.js';
+export * from './docker.js';
 export * from './env.js';
 export * from './event.js';
 export * from './secret.js';
+export * from './server.js';
 export * from './status.js';
 export * from './traffic.js';
 export * from './version.js';
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi90cy9kYXRhL2luZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLGNBQWMsY0FBYyxDQUFDO0FBQzdCLGNBQWMsYUFBYSxDQUFDO0FBQzVCLGNBQWMsVUFBVSxDQUFDO0FBQ3pCLGNBQWMsWUFBWSxDQUFDO0FBQzNCLGNBQWMsYUFBYSxDQUFBO0FBQzNCLGNBQWMsYUFBYSxDQUFDO0FBQzVCLGNBQWMsY0FBYyxDQUFDO0FBQzdCLGNBQWMsY0FBYyxDQUFDIn0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi90cy9kYXRhL2luZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLGNBQWMsY0FBYyxDQUFDO0FBQzdCLGNBQWMsYUFBYSxDQUFDO0FBQzVCLGNBQWMsYUFBYSxDQUFDO0FBQzVCLGNBQWMsVUFBVSxDQUFDO0FBQ3pCLGNBQWMsWUFBWSxDQUFDO0FBQzNCLGNBQWMsYUFBYSxDQUFBO0FBQzNCLGNBQWMsYUFBYSxDQUFDO0FBQzVCLGNBQWMsYUFBYSxDQUFDO0FBQzVCLGNBQWMsY0FBYyxDQUFDO0FBQzdCLGNBQWMsY0FBYyxDQUFDIn0=

package/dist_ts/data/server.d.ts

@@ -1,3 +1,4 @@
+import { type IDockerRegistryInfo } from './docker.js';
 export interface IServerMetrics {
     serverId: string;
     cpuUsageInPercent: number;
@@ -11,3 +12,20 @@ export interface IServerMetrics {
         memoryUsageInMB: number;
     }>;
 }
+export interface IServerConfig {
+    type: 'server';
+    /**
+     * a list of debian packages to be installed
+     */
+    requiredDebianPackages: string[];
+    /**
+     * a list of SSH keys to deploy
+     */
+    sshKeys: IServezoneSshKey[];
+    dockerRegistryInfo: IDockerRegistryInfo;
+}
+export interface IServezoneSshKey {
+    keyName: string;
+    public: string;
+    private?: string;
+}

package/dist_ts/data/server.js

@@ -1,2 +1,2 @@
-export {};
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2VydmVyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vdHMvZGF0YS9zZXJ2ZXIudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiJ9
+import {} from './docker.js';
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2VydmVyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vdHMvZGF0YS9zZXJ2ZXIudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUE0QixNQUFNLGFBQWEsQ0FBQyJ9

package/dist_ts/requests/cluster.d.ts

@@ -0,0 +1,20 @@
+import type { IClusterConfig } from '../data/cluster.js';
+import * as plugins from '../plugins.js';
+export interface IRequest_CreateCluster extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IRequest_CreateCluster> {
+    method: 'createCluster';
+    request: {
+        clusterName: string;
+    };
+    response: {
+        clusterConfig: IClusterConfig;
+    };
+}
+export interface IRequest_UpdateCluster extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IRequest_UpdateCluster> {
+    method: 'updateCluster';
+    request: {
+        clusterConfig: IClusterConfig;
+    };
+    response: {
+        clusterConfig: IClusterConfig;
+    };
+}

package/dist_ts/requests/cluster.js

@@ -0,0 +1,2 @@
+import * as plugins from '../plugins.js';
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2x1c3Rlci5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3RzL3JlcXVlc3RzL2NsdXN0ZXIudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQ0EsT0FBTyxLQUFLLE9BQU8sTUFBTSxlQUFlLENBQUMifQ==

package/dist_ts/requests/config.d.ts

@@ -1,13 +1,13 @@
 import * as plugins from '../plugins.js';
 import * as clusterInterfaces from '../data/cluster.js';
-import * as configInterfaces from '../data/config.js';
+import * as serverInterfaces from '../data/server.js';
 export interface IRequest_Any_Cloudly_GetServerConfig extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IRequest_Any_Cloudly_GetServerConfig> {
     method: 'getServerConfig';
     request: {
         clusterIdentifier: clusterInterfaces.IClusterIdentifier;
     };
     response: {
-        configData: configInterfaces.IServerConfig;
+        configData: serverInterfaces.IServerConfig;
     };
 }
 export interface IRequest_Any_Cloudly_GetClusterConfig extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IRequest_Any_Cloudly_GetClusterConfig> {
@@ -16,21 +16,21 @@ export interface IRequest_Any_Cloudly_GetClusterConfig extends plugins.typedrequ
         clusterIdentifier: clusterInterfaces.IClusterIdentifier;
     };
     response: {
-        configData: configInterfaces.IClusterConfig;
+        configData: clusterInterfaces.IClusterConfig;
     };
 }
 export interface IRequest_Cloudly_Coreflow_PushClusterConfig extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IRequest_Cloudly_Coreflow_PushClusterConfig> {
     method: 'pushClusterConfig';
     request: {
-        configData: configInterfaces.IClusterConfig;
+        configData: clusterInterfaces.IClusterConfig;
     };
     response: {};
 }
 export interface IRequest_Cloudly_Coreflow_PushContainerUpdate extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IRequest_Cloudly_Coreflow_PushContainerUpdate> {
     method: 'pushContainerUpdate';
     request: {
-        configData: configInterfaces.IClusterConfig;
-        specificContainerConfigToUpdate: configInterfaces.IClusterConfigContainer;
+        configData: clusterInterfaces.IClusterConfig;
+        specificContainerConfigToUpdate: clusterInterfaces.IClusterConfigContainer;
     };
     response: {};
 }

package/dist_ts/requests/config.js

@@ -1,4 +1,4 @@
 import * as plugins from '../plugins.js';
 import * as clusterInterfaces from '../data/cluster.js';
-import * as configInterfaces from '../data/config.js';
+import * as serverInterfaces from '../data/server.js';
 //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uZmlnLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vdHMvcmVxdWVzdHMvY29uZmlnLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sS0FBSyxPQUFPLE1BQU0sZUFBZSxDQUFDO0FBQ3pDLE9BQU8sS0FBSyxpQkFBaUIsTUFBTSxvQkFBb0IsQ0FBQztBQUN4RCxPQUFPLEtBQUssZ0JBQWdCLE1BQU0sbUJBQW1CLENBQUMifQ==

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serve.zone/interfaces",
-  "version": "1.0.10",
+  "version": "1.0.13",
   "private": false,
   "description": "interfaces for working with containers",
   "main": "dist_ts/index.js",

package/ts/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@serve.zone/interfaces',
-  version: '1.0.10',
+  version: '1.0.13',
   description: 'interfaces for working with containers'
 }

package/ts/data/cluster.ts

@@ -1,4 +1,52 @@
+import { type IDockerRegistryInfo, type IServiceRessources } from '../data/docker.js';
+import type { IServerConfig } from './server.js';
+
 export interface IClusterIdentifier {
   clusterName: string;
   secretKey: string;
 }
+
+export interface IClusterConfig {
+  id: string;
+  data: {
+    name: string;
+    secretKey: string;
+    jumpCode: string;
+    jumpCodeUsedAt: number;
+    /**
+     * how can the cluster reach cloudly
+     */
+    cloudlyUrl: string;
+
+    /**
+     * what servers are expected to be part of the cluster
+     */
+    servers: IServerConfig[];
+
+    /**
+     * the containers running
+     */
+    containers: IClusterConfigContainer[];
+
+    /**
+     * 
+     */
+    acmeInfo: {
+      serverAddress: string;
+      serverSecret: string;
+    };
+    registryInfo: IDockerRegistryInfo;
+  };
+}
+
+export interface IClusterConfigContainer {
+  name: string;
+  image: string;
+  ports: {
+    web: number;
+    custom?: { [domain: string]: string };
+  };
+  resources?: IServiceRessources;
+  domains: string[];
+  secrets: { [key: string]: string };
+}

package/ts/data/config.ts

@@ -1,7 +1 @@
-/* ==========
-This file exports all config interfaces for easier access under module.config.[anyconfig]
-// ========== */
-
-export * from '../config/cluster.js';
-export * from '../config/server.js';
 export type TConfigType = 'server' | 'cluster' | 'coreflow' | 'service';

package/ts/data/index.ts

@@ -1,8 +1,10 @@
 export * from './cluster.js';
 export * from './config.js';
+export * from './docker.js';
 export * from './env.js';
 export * from './event.js';
 export * from './secret.js'
+export * from './server.js';
 export * from './status.js';
 export * from './traffic.js';
 export * from './version.js';

package/ts/data/server.ts

@@ -1,3 +1,5 @@
+import { type IDockerRegistryInfo } from './docker.js';
+
 export interface IServerMetrics {
   serverId: string;
   cpuUsageInPercent: number;
@@ -10,4 +12,26 @@ export interface IServerMetrics {
     cpuUsageInPercent: number;
     memoryUsageInMB: number;
   }>;
-}
+}
+
+export interface IServerConfig {
+  type: 'server';
+
+  /**
+   * a list of debian packages to be installed
+   */
+  requiredDebianPackages: string[];
+
+  /**
+   * a list of SSH keys to deploy
+   */
+  sshKeys: IServezoneSshKey[];
+
+  dockerRegistryInfo: IDockerRegistryInfo;
+}
+
+export interface IServezoneSshKey {
+  keyName: string;
+  public: string;
+  private?: string;
+}

package/ts/requests/cluster.ts

@@ -0,0 +1,28 @@
+import type { IClusterConfig } from '../data/cluster.js';
+import * as plugins from '../plugins.js';
+
+export interface IRequest_CreateCluster extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IRequest_CreateCluster
+> {
+  method: 'createCluster';
+  request: {
+    clusterName: string;
+  };
+  response: {
+    clusterConfig: IClusterConfig;
+  };
+}
+
+export interface IRequest_UpdateCluster extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IRequest_UpdateCluster
+> {
+  method: 'updateCluster';
+  request: {
+    clusterConfig: IClusterConfig;
+  };
+  response: {
+    clusterConfig: IClusterConfig;
+  };
+}

package/ts/requests/config.ts

@@ -1,6 +1,6 @@
 import * as plugins from '../plugins.js';
 import * as clusterInterfaces from '../data/cluster.js';
-import * as configInterfaces from '../data/config.js';
+import * as serverInterfaces from '../data/server.js';
 
 export interface IRequest_Any_Cloudly_GetServerConfig
 extends plugins.typedrequestInterfaces.implementsTR<
@@ -12,7 +12,7 @@ extends plugins.typedrequestInterfaces.implementsTR<
     clusterIdentifier: clusterInterfaces.IClusterIdentifier;
   };
   response: {
-    configData: configInterfaces.IServerConfig;
+    configData: serverInterfaces.IServerConfig;
   };
 }
 
@@ -26,7 +26,7 @@ extends plugins.typedrequestInterfaces.implementsTR<
     clusterIdentifier: clusterInterfaces.IClusterIdentifier;
   };
   response: {
-    configData: configInterfaces.IClusterConfig;
+    configData: clusterInterfaces.IClusterConfig;
   };
 }
 
@@ -37,7 +37,7 @@ extends plugins.typedrequestInterfaces.implementsTR<
 > {
   method: 'pushClusterConfig';
   request: {
-    configData: configInterfaces.IClusterConfig;
+    configData: clusterInterfaces.IClusterConfig;
   };
   response: {};
 }
@@ -49,8 +49,8 @@ extends plugins.typedrequestInterfaces.implementsTR<
 > {
   method: 'pushContainerUpdate'
   request: {
-    configData: configInterfaces.IClusterConfig;
-    specificContainerConfigToUpdate: configInterfaces.IClusterConfigContainer;
+    configData: clusterInterfaces.IClusterConfig;
+    specificContainerConfigToUpdate: clusterInterfaces.IClusterConfigContainer;
   };
   response: {}
 }

package/ts/config/cluster.ts

@@ -1,30 +0,0 @@
-import { type IDockerRegistryInfo, type IServiceRessources } from './docker.js';
-
-export interface IClusterConfig {
-  name: string;
-  zone: 'servezone' | 'gitzone' | 'shipzone' | 'umbrellazone' | 'trafficzone' | 'proxyzone';
-  type: 'cluster';
-  secretKey: string;
-  jumpCode: string;
-  jumpCodeUsedAt: number;
-  manager_domain: string;
-  manager_ip: string;
-  containers: IClusterConfigContainer[];
-  acmeInfo: {
-    serverAddress: string;
-    serverSecret: string;
-  };
-  registryInfo: IDockerRegistryInfo;
-}
-
-export interface IClusterConfigContainer {
-  name: string;
-  image: string;
-  ports: {
-    web: number;
-    custom?: { [domain: string]: string };
-  };
-  resources?: IServiceRessources;
-  domains: string[];
-  secrets: { [key: string]: string };
-}

package/ts/config/server.ts

@@ -1,23 +0,0 @@
-import { type IDockerRegistryInfo } from './docker.js';
-
-export interface IServerConfig {
-  type: 'server';
-
-  /**
-   * a list of debian packages to be installed
-   */
-  requiredDebianPackages: string[];
-
-  /**
-   * a list of SSH keys to deploy
-   */
-  sshKeys: IServezoneSshKey[];
-
-  dockerRegistryInfo: IDockerRegistryInfo;
-}
-
-export interface IServezoneSshKey {
-  keyName: string;
-  public: string;
-  private?: string;
-}