@appsemble/node-utils 0.27.9 → 0.27.10

package/README.md

@@ -1,9 +1,9 @@
-# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.27.9/config/assets/logo.svg) Appsemble Node Utilities
+# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.27.10/config/assets/logo.svg) Appsemble Node Utilities
 
 > NodeJS utilities used by Appsemble internally.
 
 [![npm](https://img.shields.io/npm/v/@appsemble/node-utils)](https://www.npmjs.com/package/@appsemble/node-utils)
-[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.27.9/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.27.9)
+[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.27.10/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.27.10)
 [![Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://prettier.io)
 
 ## Table of Contents
@@ -26,5 +26,5 @@ compatibility is not guaranteed.
 
 ## License
 
-[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.27.9/LICENSE.md) ©
+[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.27.10/LICENSE.md) ©
 [Appsemble](https://appsemble.com)

package/app.d.ts

@@ -1,4 +1,4 @@
-import { type App, type UserInfo } from '@appsemble/types';
+import { type App, type AppsembleMessages, type UserInfo } from '@appsemble/types';
 import { type RemapperContext } from '@appsemble/utils';
 import { type DefaultContext, type DefaultState, type ParameterizedContext } from 'koa';
 import { type Options } from './server/types.js';
@@ -15,4 +15,20 @@ import { type Options } from './server/types.js';
  * @returns A localized remapper context for the app.
  */
 export declare function getRemapperContext(app: App, language: string, userInfo: UserInfo, options: Options, context: ParameterizedContext<DefaultState, DefaultContext, any>): Promise<RemapperContext>;
+/**
+ * Patch an app definition of an app inside the `apps` folder.
+ *
+ * @param appPath The path to the app to patch.
+ * @param patches Patches to apply to the YAML.
+ */
+export declare function patchDefinition(appPath: string, patches: [key: (number | string)[], value: unknown][]): Promise<void>;
+/**
+ * Patch app messages.
+ *
+ * The replacements will be deep merged into the original content.
+ *
+ * @param appPath The name of the app to patch.
+ * @param replacements Replacements for the original messages.
+ */
+export declare function patchMessages(appPath: string, replacements: Record<string, Partial<AppsembleMessages>>): Promise<void>;
 export declare function applyAppVariant(appPath: string, appVariant: string): Promise<void>;

package/app.js

@@ -9,7 +9,7 @@ import { IntlMessageFormat } from 'intl-messageformat';
 import lodash from 'lodash';
 import { format, resolveConfig } from 'prettier';
 import { parseDocument } from 'yaml';
-import { readData, writeData } from './fs.js';
+import { opendirSafe, readData, writeData } from './fs.js';
 import { logger } from './logger.js';
 const getNumberFormat = memoize((locale, opts) => new Intl.NumberFormat(locale, opts));
 const getPluralRules = memoize((locale, opts) => new Intl.PluralRules(locale, opts));
@@ -87,7 +87,7 @@ function replaceStyle(stylesheet, selector, property, value) {
  * @param appPath The path to the app to patch.
  * @param patches Patches to apply to the YAML.
  */
-async function patchDefinition(appPath, patches) {
+export async function patchDefinition(appPath, patches) {
     try {
         const path = join(appPath, 'app-definition.yaml');
         logger.verbose(`Updating ${path}`);
@@ -118,11 +118,15 @@ async function patchDefinition(appPath, patches) {
  * @param appPath The name of the app to patch.
  * @param replacements Replacements for the original messages.
  */
-async function patchMessages(appPath, replacements) {
+export async function patchMessages(appPath, replacements) {
     try {
         const i18nPath = join(appPath, 'i18n');
         for (const [language, replacementMessages] of Object.entries(replacements)) {
             const originalMessagesPath = join(i18nPath, `${language}.json`);
+            if (!existsSync(originalMessagesPath)) {
+                logger.warn(`Missing translation file at ${originalMessagesPath}`);
+                return;
+            }
             logger.verbose(`Updating ${originalMessagesPath}`);
             const [originalMessages] = await readData(originalMessagesPath);
             await (replacementMessages
@@ -201,6 +205,21 @@ async function transferAppVariantFiles(appPath, appVariantDefDir, appVariantDest
         logger.error(error);
     }
 }
+async function transferReadmes(appPath, appVariantDefDir, appVariantDestDir) {
+    try {
+        await opendirSafe(appVariantDefDir, async (filePath, fileStat) => {
+            if (fileStat.isFile()) {
+                const fileBasename = basename(filePath);
+                if (fileBasename.toLowerCase().startsWith('readme')) {
+                    await transferAppVariantFiles(appPath, appVariantDefDir, appVariantDestDir, fileBasename);
+                }
+            }
+        });
+    }
+    catch (error) {
+        logger.error(error);
+    }
+}
 export async function applyAppVariant(appPath, appVariant) {
     try {
         logger.info(`Applying ${appVariant} variant to ${appPath}`);
@@ -214,6 +233,7 @@ export async function applyAppVariant(appPath, appVariant) {
         await transferAppVariantFiles(appPath, appVariantDefDir, appVariantDestDir, 'resources');
         await transferAppVariantFiles(appPath, appVariantDefDir, appVariantDestDir, 'screenshots');
         await transferAppVariantFiles(appPath, appVariantDefDir, appVariantDestDir, 'icon.png');
+        await transferReadmes(appPath, appVariantDefDir, appVariantDestDir);
         const patchesPath = join(appVariantDefDir, 'patches');
         try {
             const definitionPath = join(patchesPath, 'app-definition.json');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appsemble/node-utils",
-  "version": "0.27.9",
+  "version": "0.27.10",
   "description": "NodeJS utilities used by Appsemble internally.",
   "keywords": [
     "app",
@@ -38,8 +38,8 @@
     "test": "vitest"
   },
   "dependencies": {
-    "@appsemble/types": "0.27.9",
-    "@appsemble/utils": "0.27.9",
+    "@appsemble/types": "0.27.10",
+    "@appsemble/utils": "0.27.10",
     "@formatjs/fast-memoize": "^2.0.0",
     "@fortawesome/fontawesome-free": "^6.0.0",
     "@koa/cors": "^4.0.0",

package/server/routes/appRouter/index.js

@@ -11,6 +11,7 @@ import { createCssHandler } from './cssHandler.js';
 import { createIconHandler } from './iconHandler.js';
 import { createIndexHandler } from './indexHandler.js';
 import { createManifestHandler } from './manifestHandler.js';
+import { createReadmeHandler } from './readmeHandler.js';
 import { createRobotsHandler } from './robotsHandler.js';
 import { createScreenshotHandler } from './screenshotHandler.js';
 import { createServiceWorkerHandler } from './serviceWorkerHandler.js';
@@ -39,6 +40,10 @@ export function createAppRouter(options) {
             route: /^\/screenshots\/(?<id>\d+)\.(?<ext>[a-z]+)$/,
             get: createScreenshotHandler(options),
         },
+        {
+            route: /^\/readmes\/(?<id>\d+)\.md$/,
+            get: createReadmeHandler(options),
+        },
         {
             route: new RegExp(`^/api/blocks/${blockName}/versions/(?<version>${partialSemver.source})/(?<filename>.+)$`),
             get: createBlockAssetHandler(options),

package/server/routes/appRouter/readmeHandler.d.ts

@@ -0,0 +1,3 @@
+import { type Options } from '@appsemble/node-utils';
+import { type Middleware } from 'koa';
+export declare function createReadmeHandler({ getApp, getAppReadmes }: Options): Middleware;

package/server/routes/appRouter/readmeHandler.js

@@ -0,0 +1,15 @@
+import { assertKoaError } from '@appsemble/node-utils';
+export function createReadmeHandler({ getApp, getAppReadmes }) {
+    return async (ctx) => {
+        const { id } = ctx.params;
+        const app = await getApp({ context: ctx });
+        assertKoaError(!app, ctx, 404, 'App not found');
+        const appReadmes = await getAppReadmes({ app, context: ctx });
+        const appReadme = appReadmes.find((readme) => readme.id === Number.parseInt(id));
+        assertKoaError(!appReadme, ctx, 404, 'Readme not found');
+        const { file } = appReadme;
+        ctx.type = 'text/markdown';
+        ctx.body = file;
+    };
+}
+//# sourceMappingURL=readmeHandler.js.map

package/server/types.d.ts

@@ -28,6 +28,7 @@ declare module 'koa' {
         appUserInfo: UserInfo;
         appTeams: ExtendedTeam[];
         appAssets: AppAsset[];
+        appReadmes: AppReadme[];
         blockConfigs: ContextBlockConfig[];
         params?: Record<string, string>;
     }
@@ -73,6 +74,7 @@ declare module 'koas-parameters' {
         resourceTypeId: string;
         schemaId: string;
         screenshotId: number;
+        readmeId: number;
         snapshotId: number;
         teamId: string;
         token: string;
@@ -96,6 +98,8 @@ declare module 'koas-parameters' {
         view: string;
         resources: boolean;
         assets: boolean;
+        screenshots: boolean;
+        readmes: boolean;
         roles: string[];
     }
 }
@@ -313,6 +317,10 @@ export interface AppScreenshot {
     height: number;
     width: number;
 }
+export interface AppReadme {
+    id: number;
+    file: Buffer;
+}
 export interface AppBlockStyle {
     style: string;
 }
@@ -344,6 +352,7 @@ export interface Options {
     getAppTeams: (params: GetAppTeamsParams) => Promise<ExtendedTeam[]>;
     getAppStyles: (params: GetAppParams | GetAppSubEntityParams) => Promise<AppStyles>;
     getAppScreenshots: (params: GetAppSubEntityParams) => Promise<AppScreenshot[]>;
+    getAppReadmes: (params: GetAppSubEntityParams) => Promise<AppReadme[]>;
     getAppBlockStyles: (params: GetAppBlockStylesParams) => Promise<AppBlockStyle[]>;
     getAppIcon: (params: GetAppSubEntityParams) => Promise<Buffer>;
     getAppUrl: (params: GetAppSubEntityParams) => Promise<URL>;