@serve.zone/interfaces 1.0.61 → 1.0.64

package/dist_ts/00_commitinfo_data.js

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

package/dist_ts/data/image.d.ts

@@ -4,7 +4,7 @@ export interface IImage {
         name: string;
         description: string;
         versions: Array<{
-            version: string;
+            versionString: string;
             storagePath?: string;
             size: number;
             createdAt: number;

package/dist_ts/data/index.d.ts

@@ -7,7 +7,8 @@ export * from './docker.js';
 export * from './env.js';
 export * from './event.js';
 export * from './image.js';
-export * from './secret.js';
+export * from './secretbundle.js';
+export * from './secretgroup.js';
 export * from './server.js';
 export * from './service.js';
 export * from './status.js';

package/dist_ts/data/index.js

@@ -7,11 +7,12 @@ export * from './docker.js';
 export * from './env.js';
 export * from './event.js';
 export * from './image.js';
-export * from './secret.js';
+export * from './secretbundle.js';
+export * from './secretgroup.js';
 export * from './server.js';
 export * from './service.js';
 export * from './status.js';
 export * from './traffic.js';
 export * from './user.js';
 export * from './version.js';
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi90cy9kYXRhL2luZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLGNBQWMsb0JBQW9CLENBQUM7QUFDbkMsY0FBYyxjQUFjLENBQUM7QUFDN0IsY0FBYyxhQUFhLENBQUM7QUFDNUIsY0FBYyxpQkFBaUIsQ0FBQztBQUNoQyxjQUFjLDBCQUEwQixDQUFDO0FBQ3pDLGNBQWMsYUFBYSxDQUFDO0FBQzVCLGNBQWMsVUFBVSxDQUFDO0FBQ3pCLGNBQWMsWUFBWSxDQUFDO0FBQzNCLGNBQWMsWUFBWSxDQUFDO0FBQzNCLGNBQWMsYUFBYSxDQUFBO0FBQzNCLGNBQWMsYUFBYSxDQUFDO0FBQzVCLGNBQWMsY0FBYyxDQUFDO0FBQzdCLGNBQWMsYUFBYSxDQUFDO0FBQzVCLGNBQWMsY0FBYyxDQUFDO0FBQzdCLGNBQWMsV0FBVyxDQUFDO0FBQzFCLGNBQWMsY0FBYyxDQUFDIn0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi90cy9kYXRhL2luZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLGNBQWMsb0JBQW9CLENBQUM7QUFDbkMsY0FBYyxjQUFjLENBQUM7QUFDN0IsY0FBYyxhQUFhLENBQUM7QUFDNUIsY0FBYyxpQkFBaUIsQ0FBQztBQUNoQyxjQUFjLDBCQUEwQixDQUFDO0FBQ3pDLGNBQWMsYUFBYSxDQUFDO0FBQzVCLGNBQWMsVUFBVSxDQUFDO0FBQ3pCLGNBQWMsWUFBWSxDQUFDO0FBQzNCLGNBQWMsWUFBWSxDQUFDO0FBQzNCLGNBQWMsbUJBQW1CLENBQUM7QUFDbEMsY0FBYyxrQkFBa0IsQ0FBQTtBQUNoQyxjQUFjLGFBQWEsQ0FBQztBQUM1QixjQUFjLGNBQWMsQ0FBQztBQUM3QixjQUFjLGFBQWEsQ0FBQztBQUM1QixjQUFjLGNBQWMsQ0FBQztBQUM3QixjQUFjLFdBQVcsQ0FBQztBQUMxQixjQUFjLGNBQWMsQ0FBQyJ9

package/dist_ts/data/secretbundle.d.ts

@@ -0,0 +1,30 @@
+export interface ISecretBundle {
+    id: string;
+    data: {
+        name: string;
+        description: string;
+        /**
+         * determines if the secret is a service or an external secret
+         * if external secret additional checks are put in place to protect the secret
+         */
+        type: 'service' | 'external';
+        /**
+         * You can add specific secret groups using this
+         */
+        includedSecretGroupIds: string[];
+        /**
+         * You can add specific tags using this
+         */
+        includedTags: {
+            key: string;
+            value: string;
+        }[];
+        /**
+         * authrozations select a specific environment of a config bundle
+         */
+        authorizations: Array<{
+            secretAccessKey: string;
+            environment: string;
+        }>;
+    };
+}

package/dist_ts/data/secretbundle.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2VjcmV0YnVuZGxlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vdHMvZGF0YS9zZWNyZXRidW5kbGUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiJ9

package/dist_ts/data/secretgroup.d.ts

@@ -0,0 +1,48 @@
+export interface ISecretGroup {
+    /**
+     * the insatnce id. This should be a random id, except for default
+     */
+    id: string;
+    data: {
+        name: string;
+        description: string;
+        /**
+         * the key of the secretgroup like CI_RUNNER_TOKEN
+         */
+        key: string;
+        /**
+         * the priority of the secretgroup
+         * will be used to determine which secretgroup will be used
+         * when there are multiple secretgroups with the same key
+         */
+        priority?: number;
+        /**
+         * any tags that can be used to filter the secretgroup
+         * can be used for putting secrets into projects
+         */
+        tags: {
+            key: string;
+            value: string;
+        }[];
+        /**
+         * the values for this secretGroup
+         */
+        environments: {
+            [key: string]: {
+                value: string;
+                /**
+                 * can be used to update the value
+                 */
+                updateToken?: string;
+                /**
+                 * the linux timestamp of the last update
+                 */
+                lastUpdated: number;
+                history: {
+                    timestamp: string;
+                    value: string;
+                }[];
+            };
+        };
+    };
+}

package/dist_ts/data/secretgroup.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2VjcmV0Z3JvdXAuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi90cy9kYXRhL3NlY3JldGdyb3VwLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiIifQ==

package/dist_ts/data/service.d.ts

@@ -1,7 +1,12 @@
 import type { IServiceRessources } from "./docker.js";
 export interface IService {
     name: string;
-    image: string;
+    imageId: string;
+    scaleFactor: number;
+    balancingStrategy: 'round-robin' | 'least-connections';
+    secrets: {
+        [key: string]: string;
+    };
     ports: {
         web: number;
         custom?: {
@@ -10,9 +15,6 @@ export interface IService {
     };
     resources?: IServiceRessources;
     domains: string[];
-    secrets: {
-        [key: string]: string;
-    };
     deploymentIds: string[];
     deploymentDirectiveIds: string[];
 }

package/dist_ts/requests/image.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" resolution-mode="require"/>
 import * as plugins from '../plugins.js';
 import type { IImage } from '../data/index.js';
 export interface IRequest_GetAllImages extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IRequest_GetAllImages> {
@@ -10,6 +9,9 @@ export interface IRequest_GetAllImages extends plugins.typedrequestInterfaces.im
         images: IImage[];
     };
 }
+/**
+ * get all kinds of image metadata
+ */
 export interface IRequest_GetImageMetadata extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IRequest_GetImageMetadata> {
     method: 'getImageMetadata';
     request: {
@@ -35,10 +37,9 @@ export interface IRequest_PushImageVersion extends plugins.typedrequestInterface
     method: 'pushImageVersion';
     request: {
         jwt: string;
-        name: string;
-        version: string;
-        imageStream?: plugins.typedrequestInterfaces.IVirtualStream;
-        chunk: Buffer;
+        imageId: string;
+        versionString: string;
+        imageStream: plugins.typedrequestInterfaces.IVirtualStream;
     };
     response: {};
 }
@@ -46,8 +47,8 @@ export interface IRequest_PullImageVersion extends plugins.typedrequestInterface
     method: 'pullImageVersion';
     request: {
         jwt: string;
-        name: string;
-        version: string;
+        imageId: string;
+        versionString: string;
     };
     response: {
         imageStream: plugins.typedrequestInterfaces.IVirtualStream;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serve.zone/interfaces",
-  "version": "1.0.61",
+  "version": "1.0.64",
   "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.61',
+  version: '1.0.64',
   description: 'interfaces for working with containers'
 }

package/ts/data/image.ts

@@ -6,7 +6,7 @@ export interface IImage {
     name: string;
     description: string;
     versions: Array<{
-      version: string;
+      versionString: string;
       storagePath?: string;
       size: number;
       createdAt: number;

package/ts/data/index.ts

@@ -7,7 +7,8 @@ export * from './docker.js';
 export * from './env.js';
 export * from './event.js';
 export * from './image.js';
-export * from './secret.js'
+export * from './secretbundle.js';
+export * from './secretgroup.js'
 export * from './server.js';
 export * from './service.js';
 export * from './status.js';

package/ts/data/secretbundle.ts

@@ -0,0 +1,34 @@
+export interface ISecretBundle {
+  id: string;
+  data: {
+    name: string;
+    description: string;
+
+    /**
+     * determines if the secret is a service or an external secret
+     * if external secret additional checks are put in place to protect the secret
+     */
+    type: 'service' | 'external';
+
+    /**
+     * You can add specific secret groups using this
+     */
+    includedSecretGroupIds: string[];
+
+    /**
+     * You can add specific tags using this
+     */
+    includedTags: {
+      key: string;
+      value: string;
+    }[];
+
+    /**
+     * authrozations select a specific environment of a config bundle
+     */
+    authorizations: Array<{
+      secretAccessKey: string;
+      environment: string;
+    }>;
+  };
+}

package/ts/data/{secret.ts → secretgroup.ts}

@@ -52,32 +52,3 @@ export interface ISecretGroup {
     };
   };
 }
-
-export interface ISecretBundle {
-  id: string;
-  data: {
-    name: string;
-    description: string;
-
-    /**
-     * You can add specific secret groups using this
-     */
-    includedSecretGroupIds: string[];
-
-    /**
-     * You can add specific tags using this
-     */
-    includedTags: {
-      key: string;
-      value: string;
-    }[];
-
-    /**
-     * authrozations select a specific environment of a config bundle
-     */
-    authorizations: Array<{
-      secretAccessKey: string;
-      environment: string;
-    }>;
-  };
-}

package/ts/data/service.ts

@@ -2,14 +2,16 @@ import type { IServiceRessources } from "./docker.js";
 
 export interface IService {
   name: string;
-  image: string;
+  imageId: string;
+  scaleFactor: number;
+  balancingStrategy: 'round-robin' | 'least-connections';
+  secrets: { [key: string]: string };
   ports: {
     web: number;
     custom?: { [domain: string]: string };
   };
   resources?: IServiceRessources;
   domains: string[];
-  secrets: { [key: string]: string };
   deploymentIds: string[];
   deploymentDirectiveIds: string[];
 }

package/ts/requests/image.ts

@@ -15,6 +15,9 @@ export interface IRequest_GetAllImages extends plugins.typedrequestInterfaces.im
   };
 }
 
+/**
+ * get all kinds of image metadata
+ */
 export interface IRequest_GetImageMetadata extends plugins.typedrequestInterfaces.implementsTR<
   plugins.typedrequestInterfaces.ITypedRequest,
   IRequest_GetImageMetadata
@@ -52,10 +55,9 @@ export interface IRequest_PushImageVersion extends plugins.typedrequestInterface
   method: 'pushImageVersion';
   request: {
     jwt: string;
-    name: string;
-    version: string;
-    imageStream?: plugins.typedrequestInterfaces.IVirtualStream;
-    chunk: Buffer;
+    imageId: string;
+    versionString: string;
+    imageStream: plugins.typedrequestInterfaces.IVirtualStream;
   };
   response: {
   };
@@ -68,8 +70,8 @@ export interface IRequest_PullImageVersion extends plugins.typedrequestInterface
   method: 'pullImageVersion';
   request: {
     jwt: string;
-    name: string;
-    version: string;
+    imageId: string;
+    versionString: string;
   };
   response: {
     imageStream: plugins.typedrequestInterfaces.IVirtualStream;