@appsemble/types 0.29.4 → 0.29.5

package/README.md

@@ -1,9 +1,9 @@
-# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.29.4/config/assets/logo.svg) Appsemble Types
+# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.29.5/config/assets/logo.svg) Appsemble Types
 
 > Reusable TypeScript types
 
 [![npm](https://img.shields.io/npm/v/@appsemble/types)](https://www.npmjs.com/package/@appsemble/types)
-[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.29.4/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.29.4)
+[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.29.5/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.29.5)
 [![Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://prettier.io)
 
 ## Table of Contents
@@ -26,5 +26,5 @@ not guaranteed.
 
 ## License
 
-[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.29.4/LICENSE.md) ©
+[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.29.5/LICENSE.md) ©
 [Appsemble](https://appsemble.com)

package/index.d.ts

@@ -599,6 +599,7 @@ export interface Remappers {
      */
     translate: string;
     user: keyof UserInfo;
+    container: string;
 }
 export type ObjectRemapper = RequireExactlyOne<Remappers>;
 export type ArrayRemapper = (ArrayRemapper | ObjectRemapper)[];
@@ -1573,6 +1574,15 @@ export interface AppDefinition {
      * Cron jobs associated with the app.
      */
     cron?: Record<string, CronDefinition>;
+    /**
+     * Companion containers of the app.
+     */
+    containers?: CompanionContainerDefinition[];
+    /**
+     * Default registry to use when creating app companion containers.
+     * Used to avoid writing the registry name in front of every image.
+     */
+    registry?: string;
 }
 /**
  * The definition of a cron job for an app.
@@ -2188,3 +2198,49 @@ export interface BlockManifest extends ProjectManifest {
      */
     layout?: 'float' | 'grow' | 'hidden' | 'static' | null;
 }
+export interface CompanionContainerDefinition {
+    /**
+     * Alias of the container in the app.
+     */
+    name: string;
+    /**
+     * Image to use for the container.
+     */
+    image: string;
+    /**
+     * Port exposed by the provided image.
+     *
+     * E.g., if the Dockerfile of the image contains `EXPOSE 3000`
+     * then `port` should be 3000 as well.
+     */
+    port: number;
+    /**
+     * Limits the resources used and required by companion containers
+     *
+     */
+    resources?: ContainerResources;
+    /**
+     * Environment within the container
+     */
+    env?: ContainerEnvVar[];
+    /**
+     * Additional properties e.g., labels, annotations
+     *
+     */
+    metadata?: Record<string, any>;
+}
+export interface ContainerResources {
+    /**
+     * Maximum amount of resources allowed
+     */
+    limits: ContainerResourceProps;
+}
+export interface ContainerResourceProps {
+    cpu: string;
+    memory: string;
+}
+export interface ContainerEnvVar {
+    name: string;
+    value: string;
+    useValueFromSecret?: boolean;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appsemble/types",
-  "version": "0.29.4",
+  "version": "0.29.5",
   "description": "TypeScript definitions reused within Appsemble internally",
   "keywords": [
     "app",