@serve.zone/interfaces 4.12.1 → 5.0.0

package/dist_ts_interfaces/data/secretbundle.d.ts

@@ -19,21 +19,25 @@ export interface ISecretBundle {
          *   the bundle is a secret bundle that is used by an external service
          */
         type: 'service' | 'npmci' | 'gitzone' | 'external';
+        /**
+         * set this if the secretBundle belongs to a service
+         */
+        serviceId?: string;
         /**
          * You can add specific secret groups using this
          */
         includedSecretGroupIds: string[];
         /**
-         * You can add specific tags using this
+         * access to this secretBundle also grants access to resources with matching tags
          */
         includedTags: {
             key: string;
             value?: string;
         }[];
         /**
-         * add images
+         * access to this secretBundle also grants access to the images
          */
-        includedImages: {
+        imageClaims: {
             imageId: string;
             permissions: ('read' | 'write')[];
         }[];

package/dist_ts_interfaces/data/service.d.ts

@@ -9,7 +9,15 @@ export interface IService {
         environment: {
             [key: string]: string;
         };
+        /**
+         * the main secret bundle id, exclusive to the service
+         */
         secretBundleId: string;
+        /**
+         * those secret bundle ids do not belong to the service itself
+         * and thus live past the service lifecycle
+         */
+        additionalSecretBundleIds?: string[];
         scaleFactor: number;
         balancingStrategy: 'round-robin' | 'least-connections';
         ports: {

package/dist_ts_interfaces/platformservice/mta.d.ts

@@ -1,6 +1,6 @@
 import * as plugins from '../plugins.js';
 export type TTemplates = 'default' | 'linkaction' | 'notification';
-export interface IRequest_SendEmail extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IRequest_SendEmail> {
+export interface IReq_SendEmail extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_SendEmail> {
     method: 'sendEmail';
     request: {
         title: string;
@@ -19,7 +19,7 @@ export interface IRequest_SendEmail extends plugins.typedrequestInterfaces.imple
         responseId: string;
     };
 }
-export interface IRequestRegisterRecipient extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IRequestRegisterRecipient> {
+export interface IReq_RegisterRecipient extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_RegisterRecipient> {
     method: 'registerRecepient';
     request: {
         emailAddress: string;
@@ -28,3 +28,21 @@ export interface IRequestRegisterRecipient extends plugins.typedrequestInterface
         status: 'ok' | 'not ok';
     };
 }
+export interface IReq_CheckEmailStatus extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_CheckEmailStatus> {
+    method: 'checkEmailStatus';
+    request: {
+        emailId: string;
+    };
+    response: {
+        status: 'ok' | 'not ok';
+    };
+}
+export interface IReq_GetEMailStats extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_GetEMailStats> {
+    method: 'getEmailStats';
+    request: {
+        jwt: string;
+    };
+    response: {
+        status: {};
+    };
+}

package/dist_ts_interfaces/requests/service.d.ts

@@ -1,7 +1,6 @@
 import * as plugins from '../plugins.js';
 import type { IService } from '../data/service.js';
 import type { IIdentity } from '../data/user.js';
-import type { IServiceRessources } from '../data/docker.js';
 export interface IRequest_Any_Cloudly_GetServiceById extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IRequest_Any_Cloudly_GetServiceById> {
     method: 'getServiceById';
     request: {
@@ -25,28 +24,7 @@ export interface IRequest_Any_Cloudly_CreateService extends plugins.typedrequest
     method: 'createService';
     request: {
         identity: IIdentity;
-        name: string;
-        description: string;
-        imageId: string;
-        imageVersion: string;
-        environment: {
-            [key: string]: string;
-        };
-        secretBundleId: string;
-        scaleFactor: number;
-        balancingStrategy: 'round-robin' | 'least-connections';
-        ports: {
-            web: number;
-            custom?: {
-                [domain: string]: string;
-            };
-        };
-        resources?: IServiceRessources;
-        domains: {
-            name: string;
-            port?: number;
-            protocol?: 'http' | 'https' | 'ssh';
-        }[];
+        serviceData: IService['data'];
     };
     response: {
         service: IService;
@@ -57,35 +35,14 @@ export interface IRequest_Any_Cloudly_UpdateService extends plugins.typedrequest
     request: {
         identity: IIdentity;
         serviceId: string;
-        name: string;
-        description: string;
-        imageId: string;
-        imageVersion: string;
-        environment: {
-            [key: string]: string;
-        };
-        secretBundleId: string;
-        scaleFactor: number;
-        balancingStrategy: 'round-robin' | 'least-connections';
-        ports: {
-            web: number;
-            custom?: {
-                [domain: string]: string;
-            };
-        };
-        resources?: IServiceRessources;
-        domains: {
-            name: string;
-            port?: number;
-            protocol?: 'http' | 'https' | 'ssh';
-        }[];
+        serviceData: IService['data'];
     };
     response: {
         service: IService;
     };
 }
-export interface IRequest_Any_Cloudly_DeleteService extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IRequest_Any_Cloudly_DeleteService> {
-    method: 'deleteService';
+export interface IRequest_Any_Cloudly_DeleteServiceById extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IRequest_Any_Cloudly_DeleteServiceById> {
+    method: 'deleteServiceById';
     request: {
         identity: IIdentity;
         serviceId: string;
@@ -94,3 +51,16 @@ export interface IRequest_Any_Cloudly_DeleteService extends plugins.typedrequest
         success: boolean;
     };
 }
+export interface IRequest_Any_Cloudly_GetServiceSecretBundlesAsFlatObject extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IRequest_Any_Cloudly_GetServiceSecretBundlesAsFlatObject> {
+    method: 'getServiceSecretBundlesAsFlatObject';
+    request: {
+        identity: IIdentity;
+        serviceId: string;
+        environment: string;
+    };
+    response: {
+        flatKeyValueObject: {
+            [key: string]: string;
+        };
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serve.zone/interfaces",
-  "version": "4.12.1",
+  "version": "5.0.0",
   "type": "module",
   "description": "",
   "exports": {
@@ -11,7 +11,7 @@
   "dependencies": {
     "@api.global/typedrequest-interfaces": "^3.0.19",
     "@push.rocks/smartlog-interfaces": "^3.0.2",
-    "@tsclass/tsclass": "^4.2.0"
+    "@tsclass/tsclass": "^9.0.0"
   },
   "devDependencies": {
     "@git.zone/tsbuild": "2.1.67"

package/ts_interfaces/data/secretbundle.ts

@@ -21,13 +21,19 @@ export interface ISecretBundle {
      */
     type: 'service' | 'npmci' | 'gitzone' | 'external';
 
+
+    /**
+     * set this if the secretBundle belongs to a service
+     */
+    serviceId?: string;
+
     /**
      * You can add specific secret groups using this
      */
     includedSecretGroupIds: string[];
 
     /**
-     * You can add specific tags using this
+     * access to this secretBundle also grants access to resources with matching tags
      */
     includedTags: {
       key: string;
@@ -35,12 +41,12 @@ export interface ISecretBundle {
     }[];
 
     /**
-     * add images
+     * access to this secretBundle also grants access to the images
      */
-    includedImages: {
+    imageClaims: {
       imageId: string;
       permissions: ('read' | 'write')[];
-    }[]; 
+    }[];
 
     /**
      * authrozations select a specific environment of a config bundle

package/ts_interfaces/data/service.ts

@@ -8,7 +8,15 @@ export interface IService {
     imageId: string;
     imageVersion: string;
     environment: { [key: string]: string };
+    /**
+     * the main secret bundle id, exclusive to the service
+     */
     secretBundleId: string;
+    /**
+     * those secret bundle ids do not belong to the service itself
+     * and thus live past the service lifecycle
+     */
+    additionalSecretBundleIds?: string[];
     scaleFactor: number;
     balancingStrategy: 'round-robin' | 'least-connections';
     ports: {

package/ts_interfaces/platformservice/mta.ts

@@ -2,9 +2,9 @@ import * as plugins from '../plugins.js';
 
 export type TTemplates = 'default' | 'linkaction' | 'notification';
 
-export interface IRequest_SendEmail extends plugins.typedrequestInterfaces.implementsTR<
+export interface IReq_SendEmail extends plugins.typedrequestInterfaces.implementsTR<
   plugins.typedrequestInterfaces.ITypedRequest,
-  IRequest_SendEmail
+  IReq_SendEmail
 > {
   method: 'sendEmail';
   request: {
@@ -25,9 +25,9 @@ export interface IRequest_SendEmail extends plugins.typedrequestInterfaces.imple
   };
 }
 
-export interface IRequestRegisterRecipient extends plugins.typedrequestInterfaces.implementsTR<
+export interface IReq_RegisterRecipient extends plugins.typedrequestInterfaces.implementsTR<
   plugins.typedrequestInterfaces.ITypedRequest,
-  IRequestRegisterRecipient
+  IReq_RegisterRecipient
 > {
   method: 'registerRecepient';
   request: {
@@ -37,3 +37,29 @@ export interface IRequestRegisterRecipient extends plugins.typedrequestInterface
     status: 'ok' | 'not ok';
   };
 }
+
+export interface IReq_CheckEmailStatus extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_CheckEmailStatus
+> {
+  method: 'checkEmailStatus';
+  request: {
+    emailId: string;
+  };
+  response: {
+    status: 'ok' | 'not ok';
+  };
+}
+
+export interface IReq_GetEMailStats extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_GetEMailStats
+> {
+  method: 'getEmailStats';
+  request: {
+    jwt: string;
+  };
+  response: {
+    status: {};
+  };
+}

package/ts_interfaces/requests/service.ts

@@ -40,24 +40,7 @@ extends plugins.typedrequestInterfaces.implementsTR<
   method: 'createService';
   request: {
     identity: IIdentity;
-    name: string;
-    description: string;
-    imageId: string;
-    imageVersion: string;
-    environment: { [key: string]: string };
-    secretBundleId: string;
-    scaleFactor: number;
-    balancingStrategy: 'round-robin' | 'least-connections';
-    ports: {
-      web: number;
-      custom?: { [domain: string]: string };
-    };
-    resources?: IServiceRessources;
-    domains: {
-      name: string;
-      port?: number;
-      protocol?: 'http' | 'https' | 'ssh';
-    }[];
+    serviceData: IService['data'];
   };
   response: {
     service: IService;
@@ -73,36 +56,19 @@ extends plugins.typedrequestInterfaces.implementsTR<
   request: {
     identity: IIdentity;
     serviceId: string;
-    name: string;
-    description: string;
-    imageId: string;
-    imageVersion: string;
-    environment: { [key: string]: string };
-    secretBundleId: string;
-    scaleFactor: number;
-    balancingStrategy: 'round-robin' | 'least-connections';
-    ports: {
-      web: number;
-      custom?: { [domain: string]: string };
-    };
-    resources?: IServiceRessources;
-    domains: {
-      name: string;
-      port?: number;
-      protocol?: 'http' | 'https' | 'ssh';
-    }[];
+    serviceData: IService['data'];
   };
   response: {
     service: IService;
   };
 }
 
-export interface IRequest_Any_Cloudly_DeleteService
+export interface IRequest_Any_Cloudly_DeleteServiceById
 extends plugins.typedrequestInterfaces.implementsTR<
   plugins.typedrequestInterfaces.ITypedRequest,
-  IRequest_Any_Cloudly_DeleteService
+  IRequest_Any_Cloudly_DeleteServiceById
 > {
-  method: 'deleteService';
+  method: 'deleteServiceById';
   request: {
     identity: IIdentity;
     serviceId: string;
@@ -111,3 +77,19 @@ extends plugins.typedrequestInterfaces.implementsTR<
     success: boolean;
   };
 }
+
+export interface IRequest_Any_Cloudly_GetServiceSecretBundlesAsFlatObject
+extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IRequest_Any_Cloudly_GetServiceSecretBundlesAsFlatObject
+> {
+  method: 'getServiceSecretBundlesAsFlatObject';
+  request: {
+    identity: IIdentity;
+    serviceId: string;
+    environment: string;
+  };
+  response: {
+    flatKeyValueObject: {[key: string]: string};
+  };
+}