@appsemble/utils 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 Utilities
+# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.29.5/config/assets/logo.svg) Appsemble Utilities
 
 > Internal utility functions used across multiple Appsemble projects.
 
 [![npm](https://img.shields.io/npm/v/@appsemble/utils)](https://www.npmjs.com/package/@appsemble/utils)
-[![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/api/components/schemas/AppDefinition.js

@@ -114,6 +114,18 @@ The most basic resource has a \`schema\` property and defines the minimal securi
             description: 'Helper property that can be used to store YAML anchors.',
             items: {},
         },
+        containers: {
+            type: 'array',
+            minItems: 1,
+            additionalProperties: false,
+            description: 'Definition of the companion containers to be created.',
+            items: { $ref: '#/components/schemas/ContainerDefinition' },
+        },
+        registry: {
+            type: 'string',
+            default: null,
+            description: 'The default registry used to pull images for companion containers.',
+        },
     },
 };
 //# sourceMappingURL=AppDefinition.js.map

package/api/components/schemas/ContainerDefinition.d.ts

@@ -0,0 +1,2 @@
+import { type OpenAPIV3 } from 'openapi-types';
+export declare const ContainerDefinition: OpenAPIV3.NonArraySchemaObject;

package/api/components/schemas/ContainerDefinition.js

@@ -0,0 +1,52 @@
+export const ContainerDefinition = {
+    type: 'object',
+    additionalProperties: false,
+    description: 'An object describing a companion container',
+    required: ['name', 'image', 'port'],
+    properties: {
+        name: {
+            type: 'string',
+            description: 'Alias used to reference the container',
+        },
+        image: {
+            type: 'string',
+            description: 'Name of the image used for the container',
+        },
+        port: {
+            type: 'number',
+            description: 'Port used by the image provided',
+        },
+        resources: {
+            type: 'object',
+            additionalProperties: true,
+            description: 'Maximum amount of resources the container can use. Deafult: 1 CPU and 512Mi memory',
+        },
+        env: {
+            type: 'array',
+            description: 'Environment variables that will be used within the container',
+            items: {
+                type: 'object',
+                additionalProperties: false,
+                description: 'Each item is an environment variable. `useValueFromSecret` property determines whether the value is taken literally or from and existing secret',
+                required: ['name', 'value'],
+                properties: {
+                    name: { type: 'string', description: 'Name of the environment variable' },
+                    useValueFromSecret: {
+                        type: 'boolean',
+                        description: 'If set to true, will retrieve the value from the Kubernetes secret, the value property will refer to the secret key. If false, will take the value literally',
+                    },
+                    value: {
+                        type: 'string',
+                        description: "The value of the environment variable. If `useValueFromSecret` is true, this property will refer to the Kubernetes secret's key",
+                    },
+                },
+            },
+        },
+        metadata: {
+            type: 'object',
+            additionalProperties: true,
+            description: 'Metadata including labels and annotations to be added to the container',
+        },
+    },
+};
+//# sourceMappingURL=ContainerDefinition.js.map

package/api/components/schemas/index.d.ts

@@ -19,6 +19,7 @@ export * from './BlockDefinition.js';
 export * from './BlockVersion.js';
 export * from './ConditionActionDefinition.js';
 export * from './CronDefinition.js';
+export * from './ContainerDefinition.js';
 export * from './CustomFontDefinition.js';
 export * from './DialogActionDefinition.js';
 export * from './DialogErrorActionDefinition.js';

package/api/components/schemas/index.js

@@ -19,6 +19,7 @@ export * from './BlockDefinition.js';
 export * from './BlockVersion.js';
 export * from './ConditionActionDefinition.js';
 export * from './CronDefinition.js';
+export * from './ContainerDefinition.js';
 export * from './CustomFontDefinition.js';
 export * from './DialogActionDefinition.js';
 export * from './DialogErrorActionDefinition.js';

package/api/paths/action.js

@@ -15,6 +15,27 @@ function proxy(method, body) {
             description: 'The data that was passed to the action',
             required: true,
             content: {
+                'multipart/form-data': {
+                    schema: {
+                        type: 'object',
+                        description: 'A `multipart/form-data` representation of a resource.',
+                        additionalProperties: true,
+                        properties: {
+                            resource: {
+                                type: 'array',
+                                items: { $ref: '#/components/schemas/Resource' },
+                            },
+                            assets: {
+                                type: 'array',
+                                description: 'A list of assets that should be linked to the resource.',
+                                items: {
+                                    type: 'string',
+                                    format: 'binary',
+                                },
+                            },
+                        },
+                    },
+                },
                 '*/*': {},
             },
         };

package/api/paths/apps.js

@@ -279,6 +279,10 @@ export const paths = {
                                     type: 'boolean',
                                     description: 'Whether TLS is being used.',
                                 },
+                                containers: {
+                                    type: 'array',
+                                    items: { $ref: '#/components/schemas/ContainerDefinition' },
+                                },
                             },
                         },
                         encoding: {

package/examples.js

@@ -655,6 +655,12 @@ export const examples = {
         result: {},
         skip: true,
     },
+    container: {
+        input: null,
+        remapper: {},
+        result: {},
+        skip: true,
+    },
 };
 /**
  * @param remapper The remapper example to use.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appsemble/utils",
-  "version": "0.29.4",
+  "version": "0.29.5",
   "description": "Utility functions used in Appsemble internally",
   "keywords": [
     "app",
@@ -37,7 +37,7 @@
     "test": "vitest"
   },
   "dependencies": {
-    "@appsemble/types": "0.29.4",
+    "@appsemble/types": "0.29.5",
     "axios": "^1.0.0",
     "cron-parser": "^4.0.0",
     "date-fns": "^2.0.0",

package/reference-schemas/remappers/data.js

@@ -349,6 +349,7 @@ Provides some fields of the appMember object.
 - \`primary_email\`: User’s **primary** email address.
 - \`name\`: The user’s name.
 - \`role\`: User's role in the context of the app.
+
 Example:
 
 \`\`\`json
@@ -359,6 +360,24 @@ Example:
   "role": "Medewerker",
   "userId": "5c6270e2-ad31-414f-bcab-6752a2c4dcfd"
 }
+\`\`\`
+    `,
+    },
+    container: {
+        type: 'string',
+        description: `
+> **Note:** For this remapper to work, the application needs to define a companion container. 
+
+This remapper provides a short way to access a companion container for the purpose of making http requests.
+When using the 'request' action, the url can be provided by using the 'container' remapper, and providing a string. 
+The string should contain the name of the companion container, followed by the API endpoint path. 
+
+Example:
+\`\`\`yaml
+    type: request
+    url: { container: my-container/api/endpoint }
+    proxy: true
+    method: get
 \`\`\`
     `,
     },

package/remap.js

@@ -415,5 +415,15 @@ const mapperImplementations = {
     },
     user: (property, input, context) => { var _a; return (_a = context.userInfo) === null || _a === void 0 ? void 0 : _a[property]; },
     appMember: (property, input, context) => { var _a, _b; return (_b = (_a = context.userInfo) === null || _a === void 0 ? void 0 : _a.appMember) === null || _b === void 0 ? void 0 : _b[property]; },
+    container(property, input, context) {
+        const namespace = 'companion-containers';
+        const appName = context.appUrl.split('.')[0].replace(/^https?:\/\//, '');
+        const endpoint = property.split('/').slice(1).join('/');
+        const containerName = `${property.split('/')[0]}-${appName}-${context.appId}`
+            .replaceAll(' ', '-')
+            .toLowerCase();
+        const url = `http://${containerName}.${namespace}.svc.cluster.local/${endpoint}`;
+        return url;
+    },
 };
 //# sourceMappingURL=remap.js.map