@appsemble/cli 0.24.13 → 0.25.0

package/README.md

@@ -1,9 +1,9 @@
-# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.24.13/config/assets/logo.svg) Appsemble CLI
+# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.25.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.24.13/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.24.13)
+[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.25.0/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.25.0)
 [![Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://prettier.io)
 
 ## Table of Contents
@@ -180,7 +180,7 @@ appsemble app import <path-of-zip-file> --organization <organizationId>
 ```
 
 For a more in depth explanation of how to build apps, use our
-[app building guide](https://appsemble.app/docs/guide).
+[app building guide](https://appsemble.app/docs/03-guide).
 
 ### Blocks
 
@@ -229,7 +229,7 @@ npm install webpack@webpack-4 @appsemble/webpack-config
 ```
 
 For a more in-depth explanation of how to build apps, use our
-[block development guide](https://appsemble.app/docs/development/developing-blocks).
+[block development guide](https://appsemble.app/docs/02-development/developing-blocks).
 
 ### Teams
 
@@ -304,5 +304,5 @@ appsemble run-cronjobs --interval 30
 
 ## License
 
-[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.24.13/LICENSE.md) ©
+[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.25.0/LICENSE.md) ©
 [Appsemble](https://appsemble.com)

package/commands/app/create.d.ts

@@ -8,6 +8,10 @@ interface AppArgs {
     template?: string;
     languages?: string[];
     description?: string;
+    resource?: string;
+    security?: boolean;
+    cronJobs?: boolean;
+    teams?: boolean;
 }
 export declare function builder(yargs: Argv): Promise<Argv<any>>;
 export declare function handler(args: AppArgs): Promise<void>;

package/commands/app/create.js

@@ -1,9 +1,10 @@
-import { cp, readdir } from 'node:fs/promises';
+import { cp, readdir, readFile, writeFile } from 'node:fs/promises';
 import { join } from 'node:path';
 import { logger, readData, writeData } from '@appsemble/node-utils';
 import inquirer from 'inquirer';
-import { parse, stringify } from 'yaml';
-const templatesDir = new URL('../../templates/apps/', import.meta.url);
+import { format } from 'prettier';
+import { parse, parseDocument, stringify } from 'yaml';
+const templatesDir = new URL('../../templates/apps/', import.meta.url).pathname;
 export const command = 'create';
 export const description = 'Scaffold a new app with a basic app-definition and styling.';
 export async function builder(yargs) {
@@ -29,6 +30,16 @@ export async function builder(yargs) {
         .option('languages', {
         describe: 'Languages in which the app will be translated.',
         choices: languageChoices,
+    })
+        .option('resource', {
+        describe: 'Name of a demo resource to be added to the app definition.',
+    })
+        .option('security', {
+        describe: 'Whether to append a default security definition to app',
+        type: 'boolean',
+    })
+        .option('cron-jobs', {
+        describe: 'Whether to append default cron-jobs to the app definition',
     });
 }
 function validateAppName(input) {
@@ -67,6 +78,29 @@ export async function handler(args) {
             choices: languageChoices,
             message: 'Please select the languages for your app.',
         },
+        !args.resource && {
+            name: 'resource',
+            message: 'Please enter the name of sample resource to be added to the app definition.(leave empty for none)',
+        },
+        !args.security && {
+            name: 'security',
+            message: 'Would you like to add a security definition to the app.',
+            type: 'confirm',
+            default: false,
+        },
+        {
+            name: 'teams',
+            message: 'Will you be using teams in your app.',
+            type: 'confirm',
+            default: false,
+            when: (appOptions) => appOptions.security,
+        },
+        !args.cronJobs && {
+            name: 'cron-jobs',
+            message: 'Would you like to add a cron-job to the definition of the app.',
+            type: 'confirm',
+            default: false,
+        },
         !args.path && {
             name: 'path',
             message: 'Please enter the path for where you want the app folder to go (default "apps").',
@@ -78,21 +112,74 @@ export async function handler(args) {
     const appDescription = answers.description || args.description || '';
     const template = answers.template || args.template;
     const languages = answers.languages || args.languages;
+    const resource = answers.resource || args.resource;
+    const security = answers.security || args.security;
+    const cronJobs = answers['cron-jobs'] || args.cronJobs;
+    const { teams } = answers;
     const outputDirectory = join(path, name);
-    const inputDirectory = new URL(`${template}/`, templatesDir);
-    const appsembleRcPath = new URL('.appsemblerc.yaml', inputDirectory);
+    const inputDirectory = join(`${templatesDir}/`, template);
+    const appsembleRcPath = join(inputDirectory, '.appsemblerc.yaml');
     const [appsembleRc] = await readData(appsembleRcPath);
     const outputAppsembleRcObject = { ...appsembleRc };
     for (const key of Object.keys(appsembleRc.context)) {
         outputAppsembleRcObject.context[key].organization = organization;
     }
     const outputAppsembleRc = parse(stringify(outputAppsembleRcObject));
-    const appDefinitionPath = new URL('app-definition.yaml', inputDirectory);
-    const [appDefinition] = await readData(appDefinitionPath);
-    const outputAppDefinitionObject = { ...appDefinition };
-    outputAppDefinitionObject.name = name;
-    outputAppDefinitionObject.description = appDescription;
-    const outputAppDefinition = parse(stringify(outputAppDefinitionObject));
+    const appDefinitionPath = join(inputDirectory, 'app-definition.yaml');
+    const yaml = await readFile(appDefinitionPath, 'utf8');
+    const appDefinition = parseDocument(yaml);
+    appDefinition.set('name', name);
+    appDefinition.set('description', appDescription);
+    if (resource) {
+        appDefinition.set('resources', {
+            [resource]: {
+                roles: ['$public'],
+                schema: {
+                    type: 'object',
+                    additionalProperties: false,
+                },
+            },
+        });
+    }
+    if (security) {
+        appDefinition.set('security', {
+            default: {
+                role: 'User',
+                policy: 'everyone',
+            },
+            roles: {
+                User: {
+                    description: 'A sample user to be included in the app definition',
+                },
+            },
+            teams: teams
+                ? {
+                    join: 'invite',
+                    invite: ['$team:member'],
+                }
+                : undefined,
+        });
+        appDefinition.set('roles', ['User']);
+    }
+    if (cronJobs) {
+        appDefinition.set('cron', {
+            dailyLogs: {
+                action: {
+                    type: 'noop',
+                },
+                schedule: '0 12 * * *',
+            },
+        });
+    }
+    const outputAppDefinition = await format(String(appDefinition), {
+        tabWidth: 2,
+        useTabs: false,
+        endOfLine: 'lf',
+        singleQuote: true,
+        proseWrap: 'preserve',
+        printWidth: 100,
+        parser: 'yaml',
+    });
     await cp(inputDirectory, outputDirectory, {
         errorOnExist: true,
         filter: (src) => !src.endsWith('.appsemblerc.yaml') || !src.endsWith('app-definition.yaml'),
@@ -103,9 +190,7 @@ export async function handler(args) {
         await writeData(join(outputDirectory, 'i18n', `${language}.json`), {});
     }
     await writeData(join(outputDirectory, '.appsemblerc.yaml'), outputAppsembleRc);
-    await writeData(join(outputDirectory, 'app-definition.yaml'), outputAppDefinition, {
-        sort: false,
-    });
+    await writeFile(join(outputDirectory, 'app-definition.yaml'), outputAppDefinition);
     logger.info(`Successfully created ${name} at ${outputDirectory}`);
 }
 //# sourceMappingURL=create.js.map

package/commands/app/publish.d.ts

@@ -13,6 +13,7 @@ interface PublishAppArguments extends BaseArguments {
     organization: string;
     template: boolean;
     demoMode: boolean;
+    seed: boolean;
     dryRun: boolean;
     resources: boolean;
     assets: boolean;

package/commands/app/publish.js

@@ -40,6 +40,10 @@ export function builder(yargs) {
         .option('demo-mode', {
         describe: 'Whether the app should be used in demo mode.',
         type: 'boolean',
+    })
+        .option('seed', {
+        describe: 'Whether to enable seeding for an app or not.',
+        implies: ['demo-mode'],
     })
         .option('dry-run', {
         describe: 'Whether the API should be called to run without actually creating the app.',

package/commands/app/update.d.ts

@@ -13,6 +13,7 @@ interface UpdateAppArguments extends BaseArguments {
     id: number;
     template: boolean;
     demoMode: boolean;
+    seed: boolean;
     force: boolean;
     visibility: AppVisibility;
     sentryDsn: string;

package/commands/app/update.js

@@ -43,6 +43,10 @@ export function builder(yargs) {
         .option('demo-mode', {
         describe: 'Whether the app should be used in demo mode.',
         type: 'boolean',
+    })
+        .option('seed', {
+        describe: 'Whether to enable seeding for an app or not.',
+        implies: ['demo-mode'],
     })
         .option('force', {
         describe: 'Whether the lock property should be ignored.',

package/lib/app.d.ts

@@ -36,6 +36,10 @@ interface PublishAppParams {
      * Whether the App should be used in demo mode.
      */
     demoMode: boolean;
+    /**
+     * Whether the App should seed resources and assets in demo mode.
+     */
+    seed: boolean;
     /**
      * The icon to upload.
      */
@@ -115,6 +119,10 @@ interface UpdateAppParams {
      * Whether the App should be used in demo mode.
      */
     demoMode: boolean;
+    /**
+     * Whether the App should seed resources and assets in demo mode.
+     */
+    seed: boolean;
     /**
      * Whether the locked property should be ignored.
      */

package/lib/app.js

@@ -331,7 +331,7 @@ This block version is not used in the app`);
  * @param argv The command line options used for updating the app.
  */
 export async function updateApp({ clientCredentials, context, force, path, ...options }) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v;
     const file = await stat(path);
     const formData = new FormData();
     let appsembleContext;
@@ -346,13 +346,16 @@ export async function updateApp({ clientCredentials, context, force, path, ...op
     const id = (_b = appsembleContext.id) !== null && _b !== void 0 ? _b : options.id;
     const template = (_d = (_c = appsembleContext.template) !== null && _c !== void 0 ? _c : options.template) !== null && _d !== void 0 ? _d : false;
     const demoMode = (_f = (_e = appsembleContext.demoMode) !== null && _e !== void 0 ? _e : options.demoMode) !== null && _f !== void 0 ? _f : false;
-    const visibility = (_g = appsembleContext.visibility) !== null && _g !== void 0 ? _g : options.visibility;
-    const iconBackground = (_h = appsembleContext.iconBackground) !== null && _h !== void 0 ? _h : options.iconBackground;
-    const icon = (_j = options.icon) !== null && _j !== void 0 ? _j : appsembleContext.icon;
-    const maskableIcon = (_k = options.maskableIcon) !== null && _k !== void 0 ? _k : appsembleContext.maskableIcon;
-    const sentryDsn = (_l = appsembleContext.sentryDsn) !== null && _l !== void 0 ? _l : options.sentryDsn;
-    const sentryEnvironment = (_m = appsembleContext.sentryEnvironment) !== null && _m !== void 0 ? _m : options.sentryEnvironment;
-    const googleAnalyticsId = (_o = appsembleContext.googleAnalyticsId) !== null && _o !== void 0 ? _o : options.googleAnalyticsId;
+    // TODO: seed depends on demoMode, this is caused by bad database normalization.
+    // Consider using a property called `type` on the App model instead.
+    const seed = (_j = (_h = (_g = appsembleContext.seed) !== null && _g !== void 0 ? _g : options.seed) !== null && _h !== void 0 ? _h : options.demoMode) !== null && _j !== void 0 ? _j : false;
+    const visibility = (_k = appsembleContext.visibility) !== null && _k !== void 0 ? _k : options.visibility;
+    const iconBackground = (_l = appsembleContext.iconBackground) !== null && _l !== void 0 ? _l : options.iconBackground;
+    const icon = (_m = options.icon) !== null && _m !== void 0 ? _m : appsembleContext.icon;
+    const maskableIcon = (_o = options.maskableIcon) !== null && _o !== void 0 ? _o : appsembleContext.maskableIcon;
+    const sentryDsn = (_p = appsembleContext.sentryDsn) !== null && _p !== void 0 ? _p : options.sentryDsn;
+    const sentryEnvironment = (_q = appsembleContext.sentryEnvironment) !== null && _q !== void 0 ? _q : options.sentryEnvironment;
+    const googleAnalyticsId = (_r = appsembleContext.googleAnalyticsId) !== null && _r !== void 0 ? _r : options.googleAnalyticsId;
     const { appLock } = appsembleContext;
     logger.info(`App id: ${id}`);
     logger.verbose(`App remote: ${remote}`);
@@ -366,16 +369,17 @@ export async function updateApp({ clientCredentials, context, force, path, ...op
     formData.append('force', String(force));
     formData.append('template', String(template));
     formData.append('demoMode', String(demoMode));
+    formData.append('demoMode', String(seed));
     formData.append('visibility', visibility);
     formData.append('iconBackground', iconBackground);
     if (icon) {
         const realIcon = typeof icon === 'string' ? createReadStream(icon) : icon;
-        logger.info(`Using icon from ${(_p = realIcon.path) !== null && _p !== void 0 ? _p : 'stdin'}`);
+        logger.info(`Using icon from ${(_s = realIcon.path) !== null && _s !== void 0 ? _s : 'stdin'}`);
         formData.append('icon', realIcon);
     }
     if (maskableIcon) {
         const realIcon = typeof maskableIcon === 'string' ? createReadStream(maskableIcon) : maskableIcon;
-        logger.info(`Using maskable icon from ${(_q = realIcon.path) !== null && _q !== void 0 ? _q : 'stdin'}`);
+        logger.info(`Using maskable icon from ${(_t = realIcon.path) !== null && _t !== void 0 ? _t : 'stdin'}`);
         formData.append('maskableIcon', realIcon);
     }
     if (sentryDsn) {
@@ -412,7 +416,7 @@ export async function updateApp({ clientCredentials, context, force, path, ...op
         if (!axios.isAxiosError(error)) {
             throw error;
         }
-        if (((_s = (_r = error.response) === null || _r === void 0 ? void 0 : _r.data) === null || _s === void 0 ? void 0 : _s.message) !== 'App validation failed') {
+        if (((_v = (_u = error.response) === null || _u === void 0 ? void 0 : _u.data) === null || _v === void 0 ? void 0 : _v.message) !== 'App validation failed') {
             throw error;
         }
         logger.error(error.response.data);
@@ -434,7 +438,7 @@ export async function updateApp({ clientCredentials, context, force, path, ...op
  * @param options The options to use for publishing an app.
  */
 export async function publishApp({ assets, assetsClonable, clientCredentials, context, dryRun, modifyContext, path, resources, ...options }) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v;
     const file = await stat(path);
     const formData = new FormData();
     let appsembleContext;
@@ -455,13 +459,16 @@ export async function publishApp({ assets, assetsClonable, clientCredentials, co
     const organizationId = (_b = appsembleContext.organization) !== null && _b !== void 0 ? _b : options.organization;
     const template = (_d = (_c = appsembleContext.template) !== null && _c !== void 0 ? _c : options.template) !== null && _d !== void 0 ? _d : false;
     const demoMode = (_f = (_e = appsembleContext.demoMode) !== null && _e !== void 0 ? _e : options.demoMode) !== null && _f !== void 0 ? _f : false;
-    const visibility = (_g = appsembleContext.visibility) !== null && _g !== void 0 ? _g : options.visibility;
-    const iconBackground = (_h = appsembleContext.iconBackground) !== null && _h !== void 0 ? _h : options.iconBackground;
-    const icon = (_j = options.icon) !== null && _j !== void 0 ? _j : appsembleContext.icon;
-    const maskableIcon = (_k = options.maskableIcon) !== null && _k !== void 0 ? _k : appsembleContext.maskableIcon;
-    const sentryDsn = (_l = appsembleContext.sentryDsn) !== null && _l !== void 0 ? _l : options.sentryDsn;
-    const sentryEnvironment = (_m = appsembleContext.sentryEnvironment) !== null && _m !== void 0 ? _m : options.sentryEnvironment;
-    const googleAnalyticsId = (_o = appsembleContext.googleAnalyticsId) !== null && _o !== void 0 ? _o : options.googleAnalyticsId;
+    // TODO: seed depends on demoMode, this is caused by bad database normalization.
+    // Consider using a property called `type` on the App model instead.
+    const seed = (_j = (_h = (_g = appsembleContext.seed) !== null && _g !== void 0 ? _g : options.seed) !== null && _h !== void 0 ? _h : options.demoMode) !== null && _j !== void 0 ? _j : false;
+    const visibility = (_k = appsembleContext.visibility) !== null && _k !== void 0 ? _k : options.visibility;
+    const iconBackground = (_l = appsembleContext.iconBackground) !== null && _l !== void 0 ? _l : options.iconBackground;
+    const icon = (_m = options.icon) !== null && _m !== void 0 ? _m : appsembleContext.icon;
+    const maskableIcon = (_o = options.maskableIcon) !== null && _o !== void 0 ? _o : appsembleContext.maskableIcon;
+    const sentryDsn = (_p = appsembleContext.sentryDsn) !== null && _p !== void 0 ? _p : options.sentryDsn;
+    const sentryEnvironment = (_q = appsembleContext.sentryEnvironment) !== null && _q !== void 0 ? _q : options.sentryEnvironment;
+    const googleAnalyticsId = (_r = appsembleContext.googleAnalyticsId) !== null && _r !== void 0 ? _r : options.googleAnalyticsId;
     const appLock = appsembleContext.appLock || 'unlocked';
     logger.verbose(`App remote: ${remote}`);
     logger.verbose(`App organization: ${organizationId}`);
@@ -474,17 +481,18 @@ export async function publishApp({ assets, assetsClonable, clientCredentials, co
     formData.append('OrganizationId', organizationId);
     formData.append('template', String(template));
     formData.append('demoMode', String(demoMode));
+    formData.append('seed', String(seed));
     formData.append('visibility', visibility);
     formData.append('iconBackground', iconBackground);
     formData.append('locked', appLock);
     if (icon) {
         const realIcon = typeof icon === 'string' ? createReadStream(icon) : icon;
-        logger.info(`Using icon from ${(_p = realIcon.path) !== null && _p !== void 0 ? _p : 'stdin'}`);
+        logger.info(`Using icon from ${(_s = realIcon.path) !== null && _s !== void 0 ? _s : 'stdin'}`);
         formData.append('icon', realIcon);
     }
     if (maskableIcon) {
         const realIcon = typeof maskableIcon === 'string' ? createReadStream(maskableIcon) : maskableIcon;
-        logger.info(`Using maskable icon from ${(_q = realIcon.path) !== null && _q !== void 0 ? _q : 'stdin'}`);
+        logger.info(`Using maskable icon from ${(_t = realIcon.path) !== null && _t !== void 0 ? _t : 'stdin'}`);
         formData.append('maskableIcon', realIcon);
     }
     if (sentryDsn) {
@@ -514,7 +522,7 @@ export async function publishApp({ assets, assetsClonable, clientCredentials, co
         if (!axios.isAxiosError(error)) {
             throw error;
         }
-        if (((_s = (_r = error.response) === null || _r === void 0 ? void 0 : _r.data) === null || _s === void 0 ? void 0 : _s.message) !== 'App validation failed') {
+        if (((_v = (_u = error.response) === null || _u === void 0 ? void 0 : _u.data) === null || _v === void 0 ? void 0 : _v.message) !== 'App validation failed') {
             throw error;
         }
         throw new AppsembleError(printAxiosError(filename, yaml, error.response.data.data.errors));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appsemble/cli",
-  "version": "0.24.13",
+  "version": "0.25.0",
   "description": "The CLI for developing with Appsemble apps and blocks",
   "keywords": [
     "app",
@@ -42,9 +42,9 @@
     "test": "vitest"
   },
   "dependencies": {
-    "@appsemble/node-utils": "0.24.13",
-    "@appsemble/types": "0.24.13",
-    "@appsemble/utils": "0.24.13",
+    "@appsemble/node-utils": "0.25.0",
+    "@appsemble/types": "0.25.0",
+    "@appsemble/utils": "0.25.0",
     "@fortawesome/fontawesome-common-types": "^6.0.0",
     "@koa/cors": "^4.0.0",
     "@odata/parser": "^0.2.0",
@@ -76,6 +76,7 @@
     "postcss-import": "^15.0.0",
     "postcss-load-config": "^4.0.0",
     "postcss-url": "^10.0.0",
+    "prettier": "^3.0.0",
     "raw-body": "^2.0.0",
     "read-package-up": "^11.0.0",
     "sharp": "^0.32.0",
@@ -86,7 +87,7 @@
     "yargs": "^17.0.0"
   },
   "devDependencies": {
-    "@appsemble/types": "0.24.13",
+    "@appsemble/types": "0.25.0",
     "@types/concat-stream": "^2.0.0",
     "@types/inquirer": "^9.0.0",
     "@types/normalize-path": "^3.0.0",

package/templates/apps/empty/app-definition.yaml

@@ -6,7 +6,7 @@ pages:
   - name: Example Page A
     blocks:
       - type: action-button
-        version: 0.24.13
+        version: 0.25.0
         parameters:
           icon: arrow-right
         actions:
@@ -17,7 +17,7 @@ pages:
   - name: Example Page B
     blocks:
       - type: action-button
-        version: 0.24.13
+        version: 0.25.0
         parameters:
           icon: arrow-left
         actions:

package/templates/blocks/mini-jsx/package.json

@@ -2,7 +2,7 @@
   "private": true,
   "type": "module",
   "dependencies": {
-    "@appsemble/sdk": "0.24.13",
+    "@appsemble/sdk": "0.25.0",
     "mini-jsx": "^4.0.0"
   }
 }

package/templates/blocks/preact/package.json

@@ -2,8 +2,8 @@
   "private": true,
   "type": "module",
   "dependencies": {
-    "@appsemble/preact": "0.24.13",
-    "@appsemble/sdk": "0.24.13",
+    "@appsemble/preact": "0.25.0",
+    "@appsemble/sdk": "0.25.0",
     "preact": "^10.0.0"
   }
 }

package/templates/blocks/vanilla/package.json

@@ -2,6 +2,6 @@
   "private": true,
   "type": "module",
   "dependencies": {
-    "@appsemble/sdk": "0.24.13"
+    "@appsemble/sdk": "0.25.0"
   }
 }