@appsemble/utils 0.29.4 → 0.29.6

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.6/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.6/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.29.6)
 [![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.6/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/SecurityDefaultDefinition.js

@@ -14,7 +14,7 @@ The following values are allowed:
 - \`organization\`: Every authenticated user gets the default role if they are in the same organization as the app.
 - \`invite\`: The user has to manually get a role assigned.
 
-> **Important**: When [OAuth2](../03-guide/oauth2) or [SAML2.0](../03-guide/saml) is used in the
+> **Important**: When [OAuth2](../02-guides/oauth2) or [SAML2.0](../02-guides/saml) is used in the
 > app, you must set the policy to \`everyone\`. This will specifically allow every configured
 > authentication method on the secrets page to be used as login method. If you do not want other
 > Appsemble user accounts to be able to log in, you must \`disable\` the \`appsemble login\` options

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/api/paths/containerLogs.d.ts

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

package/api/paths/containerLogs.js

@@ -0,0 +1,38 @@
+export const paths = {
+    '/api/containers/{appId}/logs/{container}': {
+        get: {
+            tags: ['container'],
+            description: 'Retrieve the logs related to a companion container',
+            operationId: 'getContainerLogs',
+            parameters: [
+                {
+                    name: 'appId',
+                    schema: { type: 'number' },
+                    description: 'Id of the app which defines the companion container',
+                    in: 'path',
+                },
+                {
+                    name: 'container',
+                    schema: { type: 'string' },
+                    description: 'Name of the companion container to fetch the logs for',
+                    in: 'path',
+                },
+            ],
+            responses: {
+                200: {
+                    description: 'Logs of the container running in a specific app',
+                    content: {
+                        'application/json': {
+                            schema: {
+                                type: 'array',
+                                items: {},
+                            },
+                        },
+                    },
+                },
+            },
+            security: [{ studio: [] }],
+        },
+    },
+};
+//# sourceMappingURL=containerLogs.js.map

package/api/paths/index.js

@@ -13,6 +13,7 @@ import { paths as appSSLSecrets } from './appSSLSecrets.js';
 import { paths as appVariables } from './appVariables.js';
 import { paths as assets } from './assets.js';
 import { paths as blocks } from './blocks.js';
+import { paths as containerLogs } from './containerLogs.js';
 import { paths as emails } from './emails.js';
 import { paths as health } from './health.js';
 import { paths as invite } from './invite.js';
@@ -55,5 +56,6 @@ export const paths = {
     ...appServiceSecrets,
     ...user,
     ...trainings,
+    ...containerLogs,
 };
 //# sourceMappingURL=index.js.map

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.6",
   "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.6",
     "axios": "^1.0.0",
     "cron-parser": "^4.0.0",
     "date-fns": "^2.0.0",

package/reference-schemas/remappers/data.js

@@ -61,7 +61,7 @@ Clicking on the first item would log \`0\`, the second item \`1\` and so on.
     },
     history: {
         type: 'integer',
-        description: `> **Note:** This remapper is explained more in depth in the [History](/docs/remapper/history) page
+        description: `> **Note:** This remapper is explained more in depth in the [History](/docs/04-remappers/05-history) page
 
 Gives the data at the history entry at the specified history index. The history at specified index
 is the data that is passed to that action.
@@ -166,7 +166,7 @@ Example:
 \`\`\`
 
 The page data only works in the context of a flow page. Let’s say you have a
-[“FlowPage”](/docs/reference/app#-flow-page-definition) type with multiple subpages. Whenever you
+[“FlowPage”](/docs/05-reference/app#-flow-page-definition) type with multiple subpages. Whenever you
 navigate to the next page it adds the data from that page to the flow page’s data. The page remapper
 allows you to access this cumulative data.
 
@@ -281,7 +281,7 @@ ${schemaExample('static', { exclude: ['input'] })}
     },
     translate: {
         type: 'string',
-        description: `> **Note:** This is explained much more in depth at [Translating](/docs/03-guide/translating)
+        description: `> **Note:** This is explained much more in depth at [Translating](/docs/02-guides/translating)
 
 This remapper allows you to easily add translations to your app. To make this remapper work, replace
 any static text with \`translate: {name}\`. Then, in your app’s Translations page pick the language
@@ -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/reference-schemas/remappers/unsorted.js

@@ -2,7 +2,7 @@ export const unsortedRemappers = {
     ics: {
         type: 'object',
         description: `Create a calendar event. This event can be downloaded as an \`.ics\` file and
-uploaded to your agenda using the [download](../reference/action#download) action.
+uploaded to your agenda using the [download](../05-reference/action#download) action.
 
 For example, the following input:
 \`\`\`yaml
@@ -160,12 +160,12 @@ The options represent the level of logging that will show in the console.
   - \`appId\`: ID of the application,
   - \`url\`: Absolute URL of the page where the remapper was fired,
   - \`appUrl\`: Base URL of the application,
-  - \`pageData\`: Current page data of a FlowPage (See [page remapper](./data#page)),
-  - \`userInfo\`: User's information if they are logged in (See [user remapper](./data#user)),
+  - \`pageData\`: Current page data of a FlowPage (See [page remapper](./04-data#page)),
+  - \`userInfo\`: User's information if they are logged in (See [user remapper](./04-data#user)),
   - \`context\`: Internal context
-  - \`history\`: Complete list of this remapper’s history (See [history remapper](./history))
+  - \`history\`: Complete list of this remapper’s history (See [history remapper](./05-history))
   - \`locale\`: The user’s locale,
-  - \`stepRef\`: In a loop page, gives the properties from the loop’s current data index (See [step remapper](./data#step))
+  - \`stepRef\`: In a loop page, gives the properties from the loop’s current data index (See [step remapper](./04-data#step))
 
 For example:
 

package/remap.js

@@ -415,5 +415,17 @@ 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) {
+        // This value is replaced when the request is made
+        // By using the value of the release name
+        const namespace = 'companion-containers-appsemble';
+        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