@appsemble/cli 0.27.11 → 0.28.0

package/README.md

@@ -1,9 +1,9 @@
-# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.27.11/config/assets/logo.svg) Appsemble CLI
+# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.28.0/config/assets/logo.svg) Appsemble CLI
 
 > Manage apps and blocks from the command line.
 
 [![npm](https://img.shields.io/npm/v/@appsemble/cli)](https://www.npmjs.com/package/@appsemble/cli)
-[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.27.11/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.27.11)
+[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.28.0/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.28.0)
 [![Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://prettier.io)
 
 ## Table of Contents
@@ -323,5 +323,5 @@ appsemble run-cronjobs --interval 30
 
 ## License
 
-[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.27.11/LICENSE.md) ©
+[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.28.0/LICENSE.md) ©
 [Appsemble](https://appsemble.com)

package/commands/app/delete.js

@@ -1,5 +1,4 @@
-import { authenticate, logger } from '@appsemble/node-utils';
-import axios from 'axios';
+import { deleteApp } from '../../lib/app.js';
 export const command = 'delete';
 export const description = 'Delete an app using the app id.';
 export function builder(yargs) {
@@ -9,13 +8,6 @@ export function builder(yargs) {
     });
 }
 export async function handler({ clientCredentials, id, remote, }) {
-    await authenticate(remote, 'apps:delete', clientCredentials);
-    const response = await axios.get(`/api/apps/${id}`);
-    const { name } = response.data;
-    logger.warn(`Deleting app: ${name}`);
-    axios.delete(`/api/apps/${id}`, {
-        baseURL: remote,
-    });
-    logger.info(`Successfully deleted ${name} app.`);
+    await deleteApp({ id, remote, clientCredentials });
 }
 //# sourceMappingURL=delete.js.map

package/commands/app/export.js

@@ -1,5 +1,5 @@
 import { join } from 'node:path';
-import { authenticate, logger } from '@appsemble/node-utils';
+import { logger } from '@appsemble/node-utils';
 import { exportAppAsZip } from '../../lib/app.js';
 export const command = 'export';
 export const description = `Export an app as a zip file using app id.
@@ -24,9 +24,8 @@ export function builder(yargs) {
 export async function handler(args) {
     const { assets = false, clientCredentials, id: appId, path: outputDirectory, remote, resources = false, } = args;
     const defaultOutputDirectory = join(process.cwd(), 'apps');
-    await authenticate(remote, 'apps:export', clientCredentials);
     logger.info(`Exporting app with id: ${appId}`);
-    await exportAppAsZip(appId, assets, resources, outputDirectory || defaultOutputDirectory, remote);
+    await exportAppAsZip(clientCredentials, appId, assets, resources, outputDirectory || defaultOutputDirectory, remote);
     logger.info('Export completed successfully');
 }
 //# sourceMappingURL=export.js.map

package/commands/block/delete.js

@@ -1,4 +1,4 @@
-import { authenticate, logger } from '@appsemble/node-utils';
+import { logger } from '@appsemble/node-utils';
 import { deleteBlock } from '../../lib/block.js';
 export const command = 'delete <block>';
 export const description = 'Delete a specific block version. Using this outside local development is discouraged.';
@@ -13,9 +13,8 @@ export function builder(yargs) {
     });
 }
 export async function handler({ block, clientCredentials, organization, remote, }) {
-    await authenticate(remote, 'blocks:delete', clientCredentials);
     const [blockName, blockVersion] = block.split(':');
     logger.info(`Deleting Block ${block}`);
-    await deleteBlock({ organization, blockName, blockVersion, remote });
+    await deleteBlock({ organization, blockName, blockVersion, remote, clientCredentials });
 }
 //# sourceMappingURL=delete.js.map

package/commands/serve.js

@@ -9,7 +9,7 @@ import axios from 'axios';
 import csvToJson from 'csvtojson';
 import FormData from 'form-data';
 import globalCacheDir from 'global-cache-dir';
-import { traverseAppDirectory } from '../lib/app.js';
+import { parseValues, traverseAppDirectory } from '../lib/app.js';
 import { buildBlock } from '../lib/block.js';
 import { getProjectBuildConfig, getProjectWebpackConfig } from '../lib/config.js';
 import { createApiServer, createStaticServer } from '../lib/createServers.js';
@@ -207,6 +207,24 @@ export async function handler(argv) {
         const { name } = parse(stat.name);
         await Resource.bulkCreate(resources, name, true);
     }, { allowMissing: true });
+    const appVariables = [];
+    const configPath = join(appPath, 'config');
+    if (existsSync(configPath)) {
+        const variablesPath = join(configPath, 'variables.json');
+        if (existsSync(variablesPath)) {
+            const [readAppVariables] = (await readData(variablesPath));
+            if (readAppVariables.length) {
+                for (const appVariable of readAppVariables) {
+                    const { name, value } = appVariable;
+                    const [parsedValues, missingValues] = parseValues('variable', name, [{ value }]);
+                    if (missingValues) {
+                        continue;
+                    }
+                    appVariables.push({ name, ...parsedValues });
+                }
+            }
+        }
+    }
     const stubbedApp = {
         ...appsembleApp,
         id: appId,
@@ -221,6 +239,7 @@ export async function handler(argv) {
             appsembleApp: stubbedApp,
             appBlocks,
             appMessages,
+            appVariables,
             ...(appSecurity
                 ? {
                     appMembers,

package/commands/team/create.js

@@ -1,4 +1,3 @@
-import { authenticate } from '@appsemble/node-utils';
 import { resolveAppIdAndRemote } from '../../lib/app.js';
 import { createTeam } from '../../lib/team.js';
 export const command = 'create <name>';
@@ -28,12 +27,12 @@ export function builder(yargs) {
 }
 export async function handler({ annotation, app, appId, clientCredentials, context, name, remote, }) {
     const [resolvedAppId, resolvedRemote] = await resolveAppIdAndRemote(app, context, remote, appId);
-    await authenticate(resolvedRemote, 'teams:write', clientCredentials);
     await createTeam({
         name,
         appId: resolvedAppId,
         annotations: annotation,
         remote: resolvedRemote,
+        clientCredentials,
     });
 }
 //# sourceMappingURL=create.js.map

package/commands/team/delete.js

@@ -1,4 +1,3 @@
-import { authenticate } from '@appsemble/node-utils';
 import { resolveAppIdAndRemote } from '../../lib/app.js';
 import { deleteTeam } from '../../lib/team.js';
 export const command = 'delete';
@@ -24,11 +23,11 @@ export function builder(yargs) {
 }
 export async function handler({ app, appId, clientCredentials, context, id, remote, }) {
     const [resolvedAppId, resolvedRemote] = await resolveAppIdAndRemote(app, context, remote, appId);
-    await authenticate(resolvedRemote, 'teams:write', clientCredentials);
     await deleteTeam({
         id,
         appId: resolvedAppId,
         remote: resolvedRemote,
+        clientCredentials,
     });
 }
 //# sourceMappingURL=delete.js.map

package/lib/app.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="node" resolution-mode="require"/>
 /// <reference types="node" resolution-mode="require"/>
 import { type ReadStream } from 'node:fs';
-import { type App, type AppLock, type AppsembleContext, type AppsembleRC, type AppVisibility } from '@appsemble/types';
+import { type App, type AppLock, type AppsembleContext, type AppsembleRC, type AppVisibility, type ValueFromDefinition, type ValueFromProcess } from '@appsemble/types';
 import FormData from 'form-data';
 /**
  * Traverses an app directory and appends the files it finds to the given FormData object.
@@ -15,13 +15,14 @@ export declare function traverseAppDirectory(path: string, context: string, form
 /**
  * Export an app as a zip file.
  *
+ * @param clientCredentials The OAuth2 client credentials to use
  * @param appId Id of the app to be exported.
  * @param assets Boolean representing whether to include assets in the exported zip file.
  * @param resources Boolean representing whether to include resources in the zip file.
  * @param path Path of the folder where you want to put your downloaded file.
  * @param remote The remote to fetch the app from.
  */
-export declare function exportAppAsZip(appId: number, assets: boolean, resources: boolean, path: string, remote: string): Promise<void>;
+export declare function exportAppAsZip(clientCredentials: string, appId: number, assets: boolean, resources: boolean, path: string, remote: string): Promise<void>;
 /**
  * Upload messages for an app.
  *
@@ -31,8 +32,16 @@ export declare function exportAppAsZip(appId: number, assets: boolean, resources
  * @param force Whether or not to force the update for locked apps.
  */
 export declare function uploadMessages(path: string, appId: number, remote: string, force: boolean): Promise<void>;
+interface DeleteAppArgs {
+    remote: string;
+    id: number;
+    clientCredentials: string;
+}
+export declare function deleteApp({ clientCredentials, id, remote }: DeleteAppArgs): Promise<void>;
 export declare function publishSeedResources(path: string, app: App, remote: string): Promise<void>;
 export declare function publishSeedAssets(path: string, app: App, remote: string, assetsClonable: boolean): Promise<void>;
+export declare function parseValues(type: string, name: string, valuesToParse: Record<string, ValueFromDefinition>[]): [Record<string, ValueFromProcess>, boolean];
+export declare function publishAppConfig(path: string, app: App, remote: string): Promise<void>;
 /**
  * @param path The path to the app directory.
  * @param languages A list of languages for which translations should be added in addition to the

package/lib/app.js

@@ -152,6 +152,13 @@ export async function traverseAppDirectory(path, context, formData) {
         : maskableIconPath;
     return [discoveredContext, rc, yaml, gatheredData];
 }
+function extractFilenameFromContentDisposition(contentDisposition) {
+    const match = contentDisposition.match(/filename="(.+?)"/);
+    if (match && match.length > 1) {
+        return match[1];
+    }
+    return null;
+}
 async function retrieveContext(path, context) {
     let rc;
     let discoveredContext;
@@ -190,20 +197,20 @@ async function retrieveContext(path, context) {
 /**
  * Export an app as a zip file.
  *
+ * @param clientCredentials The OAuth2 client credentials to use
  * @param appId Id of the app to be exported.
  * @param assets Boolean representing whether to include assets in the exported zip file.
  * @param resources Boolean representing whether to include resources in the zip file.
  * @param path Path of the folder where you want to put your downloaded file.
  * @param remote The remote to fetch the app from.
  */
-export async function exportAppAsZip(appId, assets, resources, path, remote) {
-    const app = await axios.get(`/api/apps/${appId}`);
-    const { name } = app.data.definition;
+export async function exportAppAsZip(clientCredentials, appId, assets, resources, path, remote) {
+    await authenticate(remote, 'apps:export', clientCredentials);
     const response = await axios.get(`/api/apps/${appId}/export?resources=${resources}&assets=${assets}`, {
         baseURL: remote,
         responseType: 'stream',
     });
-    const zipFileName = join(path, `${name}_${appId}.zip`);
+    const zipFileName = join(path, String(extractFilenameFromContentDisposition(response.headers['content-disposition'])));
     const writeStream = createWriteStream(zipFileName);
     response.data.pipe(writeStream);
     logger.info(`Successfully downloaded file: ${zipFileName}`);
@@ -236,6 +243,16 @@ export async function uploadMessages(path, appId, remote, force) {
         logger.info(`Successfully uploaded messages for language “${language.language}” 🎉`);
     }
 }
+export async function deleteApp({ clientCredentials, id, remote }) {
+    await authenticate(remote, 'apps:delete', clientCredentials);
+    const response = await axios.get(`/api/apps/${id}`);
+    const { name } = response.data;
+    logger.warn(`Deleting app: ${name}`);
+    await axios.delete(`/api/apps/${id}`, {
+        baseURL: remote,
+    });
+    logger.info(`Successfully deleted app with id ${id}`);
+}
 export async function publishSeedResources(path, app, remote) {
     var _a, _b;
     const resourcesPath = join(path, 'resources');
@@ -318,6 +335,182 @@ export async function publishSeedAssets(path, app, remote, assetsClonable) {
         logger.warn(`Missing assets directory in ${path}. Skipping...`);
     }
 }
+function parseValueFromDefinition(value) {
+    let parsed = value;
+    if (typeof parsed === 'string' && parsed.includes('{{') && parsed.includes('}}')) {
+        parsed = parsed.replaceAll(/{{\s*([^\s{}]+)\s*}}/g, (match, variable) => process.env[variable.trim()] || match);
+    }
+    return parsed;
+}
+export function parseValues(type, name, valuesToParse) {
+    const parsedValues = {};
+    let missingValues = false;
+    for (const valueToParse of valuesToParse) {
+        const [key, value] = Object.entries(valueToParse)[0];
+        parsedValues[key] = parseValueFromDefinition(value);
+        if (!parsedValues[key]) {
+            logger.error(`Missing ${key} value for ${type} ${name}`);
+            missingValues = true;
+        }
+    }
+    return [parsedValues, missingValues];
+}
+export async function publishAppConfig(path, app, remote) {
+    const configPath = join(path, 'config');
+    logger.info(`Publishing app config from ${configPath}`);
+    if (existsSync(configPath)) {
+        try {
+            logger.info(`Deleting existing variables from app ${app.id}`);
+            await axios.delete(`/api/apps/${app.id}/variables`, { baseURL: remote });
+            const appVariablesPath = join(configPath, 'variables.json');
+            if (existsSync(appVariablesPath)) {
+                const [appVariables] = (await readData(appVariablesPath));
+                if (appVariables.length) {
+                    logger.info(`Publishing ${appVariables.length} app variable(s)`);
+                    for (const appVariable of appVariables) {
+                        const { name, value } = appVariable;
+                        const [parsedValues, missingValues] = parseValues('variable', name, [{ value }]);
+                        if (missingValues) {
+                            continue;
+                        }
+                        await axios.post(`/api/apps/${app.id}/variables`, { name, ...parsedValues }, { baseURL: remote });
+                    }
+                }
+            }
+        }
+        catch (error) {
+            logger.error('Something went wrong when creating app variables:');
+            logger.error(error);
+        }
+        try {
+            logger.info(`Deleting existing service secrets from app ${app.id}`);
+            await axios.delete(`/api/apps/${app.id}/secrets/service`, { baseURL: remote });
+            const serviceSecretsPath = join(configPath, 'secrets', 'service.json');
+            if (existsSync(serviceSecretsPath)) {
+                const [serviceSecrets] = (await readData(serviceSecretsPath));
+                if (serviceSecrets.length) {
+                    logger.info(`Publishing ${serviceSecrets.length} app service secret(s)`);
+                    for (const serviceSecret of serviceSecrets) {
+                        const { identifier, name, secret, urlPatterns, ...rest } = serviceSecret;
+                        const [parsedValues, missingValues] = parseValues('service secret', name, [
+                            { secret },
+                            { identifier },
+                            { urlPatterns },
+                        ]);
+                        if (missingValues) {
+                            continue;
+                        }
+                        await axios.post(`/api/apps/${app.id}/secrets/service`, { name, ...parsedValues, ...rest }, { baseURL: remote });
+                    }
+                }
+            }
+        }
+        catch (error) {
+            logger.error('Something went wrong when creating app service secrets:');
+            logger.error(error);
+        }
+        try {
+            logger.info(`Deleting existing saml secrets from app ${app.id}`);
+            await axios.delete(`/api/apps/${app.id}/secrets/saml`, { baseURL: remote });
+            const samlSecretsPath = join(configPath, 'secrets', 'saml.json');
+            if (existsSync(samlSecretsPath)) {
+                const [samlSecrets] = (await readData(samlSecretsPath));
+                if (samlSecrets.length) {
+                    logger.info(`Publishing ${samlSecrets.length} app saml secret(s)`);
+                    for (const samlSecret of samlSecrets) {
+                        const { entityId, idpCertificate, name, ssoUrl, ...rest } = samlSecret;
+                        const [parsedValues, missingValues] = parseValues('saml secret', name, [
+                            { entityId },
+                            { idpCertificate },
+                            { ssoUrl },
+                        ]);
+                        if (missingValues) {
+                            continue;
+                        }
+                        await axios.post(`/api/apps/${app.id}/secrets/saml`, { name, ...parsedValues, ...rest }, { baseURL: remote });
+                    }
+                }
+            }
+        }
+        catch (error) {
+            logger.error('Something went wrong when creating app saml secrets:');
+            logger.error(error);
+        }
+        try {
+            logger.info(`Deleting existing oauth2 secrets from app ${app.id}`);
+            await axios.delete(`/api/apps/${app.id}/secrets/oauth2`, { baseURL: remote });
+            const oauth2SecretsPath = join(configPath, 'secrets', 'oauth2.json');
+            if (existsSync(oauth2SecretsPath)) {
+                const [oauth2Secrets] = (await readData(oauth2SecretsPath));
+                if (oauth2Secrets.length) {
+                    logger.info(`Publishing ${oauth2Secrets.length} app oauth2 secrets`);
+                    for (const oauth2Secret of oauth2Secrets) {
+                        const { authorizationUrl, clientId, clientSecret, name, tokenUrl, userInfoUrl, ...rest } = oauth2Secret;
+                        const [parsedValues, missingValues] = parseValues('oauth2 secret', name, [
+                            { authorizationUrl },
+                            { tokenUrl },
+                            { userInfoUrl },
+                            { clientId },
+                            { clientSecret },
+                        ]);
+                        if (missingValues) {
+                            continue;
+                        }
+                        await axios.post(`/api/apps/${app.id}/secrets/oauth2`, { name, ...parsedValues, ...rest }, { baseURL: remote });
+                    }
+                }
+            }
+        }
+        catch (error) {
+            logger.error('Something went wrong when creating app oauth2 secrets:');
+            logger.error(error);
+        }
+        try {
+            const sslSecretPath = join(configPath, 'secrets', 'ssl.json');
+            if (existsSync(sslSecretPath)) {
+                const [sslSecret] = (await readData(sslSecretPath));
+                if (sslSecret) {
+                    logger.info('Publishing app ssl secret');
+                    const { certificate, key } = sslSecret;
+                    const [parsedValues, missingValues] = parseValues('ssl secret', '', [
+                        { certificate },
+                        { key },
+                    ]);
+                    if (missingValues) {
+                        return;
+                    }
+                    await axios.put(`/api/apps/${app.id}/secrets/ssl`, { ...parsedValues }, { baseURL: remote });
+                }
+            }
+        }
+        catch (error) {
+            logger.error('Something went wrong when creating app ssl secret:');
+            logger.error(error);
+        }
+        try {
+            const scimSecretPath = join(configPath, 'secrets', 'scim.json');
+            if (existsSync(scimSecretPath)) {
+                const [scimSecret] = (await readData(scimSecretPath));
+                if (scimSecret) {
+                    logger.info('Publishing app scim secret');
+                    const { enabled, token } = scimSecret;
+                    const [parsedValues, missingValues] = parseValues('scim secret', '', [{ token }]);
+                    if (missingValues) {
+                        return;
+                    }
+                    await axios.patch(`/api/apps/${app.id}/secrets/scim`, { enabled, ...parsedValues }, { baseURL: remote });
+                }
+            }
+        }
+        catch (error) {
+            logger.error('Something went wrong when creating app scim secret:');
+            logger.error(error);
+        }
+    }
+    else {
+        logger.warn(`Missing config directory in ${path}. Skipping...`);
+    }
+}
 /**
  * @param path The path to the app directory.
  * @param languages A list of languages for which translations should be added in addition to the
@@ -616,6 +809,7 @@ export async function publishApp({ clientCredentials, context, dryRun, modifyCon
         // After uploading the app, upload block styles, messages if they are available
         await traverseBlockThemes(appVariantPath, data.id, remote, false);
         await uploadMessages(appVariantPath, data.id, remote, false);
+        await publishAppConfig(appVariantPath, data, remote);
         // After uploading the app, publish seed resources and assets if they are available
         if (assets) {
             await publishSeedAssets(appVariantPath, data, remote, assetsClonable);
@@ -776,6 +970,7 @@ export async function updateApp({ clientCredentials, context, force, path, ...op
         // After uploading the app, upload block styles and messages if they are available
         await traverseBlockThemes(appVariantPath, data.id, remote, force);
         await uploadMessages(appVariantPath, data.id, remote, force);
+        await publishAppConfig(appVariantPath, data, remote);
         // After updating the app, publish seed resources and assets if they are available
         if (assets && (data.locked !== 'fullLock' || force)) {
             await publishSeedAssets(appVariantPath, data, remote, assetsClonable);