@serve.zone/interfaces 1.0.5 → 1.0.8

package/dist_ts/00_commitinfo_data.js

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

package/dist_ts/data/env.d.ts

@@ -0,0 +1,7 @@
+export interface IEnvBundle {
+    environment: string;
+    timeSensitive: boolean;
+    configKeyValueObject: {
+        [key: string]: string;
+    };
+}

package/dist_ts/data/env.js

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

package/dist_ts/data/index.d.ts

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

package/dist_ts/data/index.js

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

package/dist_ts/data/secret.d.ts

@@ -0,0 +1,70 @@
+export interface ISecretGroup {
+    /**
+     * the insatnce id. This should be a random id, except for default
+     */
+    id: string;
+    data: {
+        /**
+         * 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;
+                }[];
+            };
+        };
+    };
+}
+export interface ISecretBundle {
+    id: string;
+    data: {
+        purpose: 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/dist_ts/data/secret.js

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

package/dist_ts/requests/secret.d.ts

@@ -0,0 +1,68 @@
+import * as plugins from '../plugins.js';
+import * as data from '../data/index.js';
+export interface IReq_GetEnvBundle extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_GetEnvBundle> {
+    method: 'getEnvBundle';
+    request: {
+        authorization: string;
+        /**
+         * specify this if you want to get a warning, if the envBundle is for an unexpected environment
+         */
+        environment?: string;
+    };
+    response: {
+        envBundle: data.IEnvBundle;
+    };
+}
+export interface IReq_Admin_LoginWithUsernameAndPassword extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_Admin_LoginWithUsernameAndPassword> {
+    method: 'adminLoginWithUsernameAndPassword';
+    request: {
+        username: string;
+        password: string;
+    };
+    response: {
+        jwt: string;
+    };
+}
+export interface IReq_Admin_GetConfigBundlesAndSecretGroups extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_Admin_GetConfigBundlesAndSecretGroups> {
+    method: 'adminGetConfigBundlesAndSecretGroups';
+    request: {
+        jwt: string;
+    };
+    response: {
+        secretBundles: data.ISecretBundle[];
+        secretGroups: data.ISecretGroup[];
+    };
+}
+export interface IReq_Admin_CreateConfigBundlesAndSecretGroups extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_Admin_CreateConfigBundlesAndSecretGroups> {
+    method: 'adminCreateConfigBundlesAndSecretGroups';
+    request: {
+        jwt: string;
+        secretBundles: data.ISecretBundle[];
+        secretGroups: data.ISecretGroup[];
+    };
+    response: {
+        ok: boolean;
+    };
+}
+export interface IReq_Admin_UpdateConfigBundlesAndSecretGroups extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_Admin_UpdateConfigBundlesAndSecretGroups> {
+    method: 'adminUpdateConfigBundlesAndSecretGroups';
+    request: {
+        jwt: string;
+        configBundles: data.ISecretBundle[];
+        secretGroups: data.ISecretGroup[];
+    };
+    response: {
+        ok: boolean;
+    };
+}
+export interface IReq_Admin_DeleteConfigBundlesAndSecretGroups extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_Admin_DeleteConfigBundlesAndSecretGroups> {
+    method: 'adminDeleteConfigBundlesAndSecretGroups';
+    request: {
+        jwt: string;
+        secretBundleIds: string[];
+        secretGroupIds: string[];
+    };
+    response: {
+        ok: boolean;
+    };
+}

package/dist_ts/requests/secret.js

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

package/package.json

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

package/ts/data/env.ts

@@ -0,0 +1,6 @@
+
+export interface IEnvBundle {
+  environment: string;
+  timeSensitive: boolean;
+  configKeyValueObject: {[key: string]: string};
+}

package/ts/data/index.ts

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

package/ts/data/secret.ts

@@ -0,0 +1,78 @@
+export interface ISecretGroup {
+  /**
+   * the insatnce id. This should be a random id, except for default
+   */
+  id: string;
+
+  data: {
+    /**
+     * 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;
+        }[];
+      };
+    };
+  };
+}
+
+export interface ISecretBundle {
+  id: string;
+  data: {
+    purpose: 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/requests/secret.ts

@@ -0,0 +1,93 @@
+import * as plugins from '../plugins.js';
+import * as data from '../data/index.js';
+
+export interface IReq_GetEnvBundle extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_GetEnvBundle
+> {
+  method: 'getEnvBundle';
+  request: {
+    authorization: string;
+    /**
+     * specify this if you want to get a warning, if the envBundle is for an unexpected environment
+     */
+    environment?: string;
+  };
+  response: {
+    envBundle: data.IEnvBundle;
+  };
+}
+
+export interface IReq_Admin_LoginWithUsernameAndPassword extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Admin_LoginWithUsernameAndPassword
+> {
+  method: 'adminLoginWithUsernameAndPassword';
+  request: {
+    username: string;
+    password: string;
+  };
+  response: {
+    jwt: string;
+  }
+}
+
+export interface IReq_Admin_GetConfigBundlesAndSecretGroups extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Admin_GetConfigBundlesAndSecretGroups
+> {
+  method: 'adminGetConfigBundlesAndSecretGroups';
+  request: {
+    jwt: string;
+  };
+  response: {
+    secretBundles: data.ISecretBundle[];
+    secretGroups: data.ISecretGroup[];
+  };
+
+}
+
+export interface IReq_Admin_CreateConfigBundlesAndSecretGroups extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Admin_CreateConfigBundlesAndSecretGroups
+> {
+  method: 'adminCreateConfigBundlesAndSecretGroups';
+  request: {
+    jwt: string;
+    secretBundles: data.ISecretBundle[];
+    secretGroups: data.ISecretGroup[];
+  };
+  response: {
+    ok: boolean;
+  };
+}
+
+export interface IReq_Admin_UpdateConfigBundlesAndSecretGroups extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Admin_UpdateConfigBundlesAndSecretGroups
+> {
+  method: 'adminUpdateConfigBundlesAndSecretGroups';
+  request: {
+    jwt: string;
+    configBundles: data.ISecretBundle[];
+    secretGroups: data.ISecretGroup[];
+  };
+  response: {
+    ok: boolean;
+  };
+}
+
+export interface IReq_Admin_DeleteConfigBundlesAndSecretGroups extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Admin_DeleteConfigBundlesAndSecretGroups
+> {
+  method: 'adminDeleteConfigBundlesAndSecretGroups';
+  request: {
+    jwt: string;
+    secretBundleIds: string[];
+    secretGroupIds: string[];
+  };
+  response: {
+    ok: boolean;
+  };
+}