@appsemble/utils 0.20.9 → 0.20.12

package/theme.test.js

@@ -0,0 +1,92 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const package_json_1 = require("bulma/package.json");
+const theme_1 = require("./theme");
+describe('mergeThemes', () => {
+    it('should use the base theme as default', () => {
+        const result = (0, theme_1.mergeThemes)({ primaryColor: '#123456', successColor: '#789abc' });
+        expect(result).toStrictEqual({
+            dangerColor: '#ff2800',
+            font: {
+                family: 'Open Sans',
+                source: 'google',
+            },
+            infoColor: '#a7d0ff',
+            linkColor: '#0440ad',
+            primaryColor: '#123456',
+            splashColor: '#ffffff',
+            successColor: '#789abc',
+            themeColor: '#ffffff',
+            tileLayer: 'https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png',
+            warningColor: '#fed719',
+        });
+    });
+    it('should fill in the default font source', () => {
+        const result = (0, theme_1.mergeThemes)({ font: { family: 'Lato' } });
+        expect(result).toStrictEqual({
+            dangerColor: '#ff2800',
+            font: {
+                family: 'Lato',
+                source: 'google',
+            },
+            infoColor: '#a7d0ff',
+            linkColor: '#0440ad',
+            primaryColor: '#5393ff',
+            splashColor: '#ffffff',
+            successColor: '#1fd25b',
+            themeColor: '#ffffff',
+            tileLayer: 'https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png',
+            warningColor: '#fed719',
+        });
+    });
+    it('should combine multiple themes', () => {
+        const result = (0, theme_1.mergeThemes)({ primaryColor: '#123456', successColor: '#789abc' }, { successColor: '#abcdef' });
+        expect(result).toStrictEqual({
+            dangerColor: '#ff2800',
+            font: {
+                family: 'Open Sans',
+                source: 'google',
+            },
+            infoColor: '#a7d0ff',
+            linkColor: '#0440ad',
+            primaryColor: '#123456',
+            splashColor: '#ffffff',
+            successColor: '#abcdef',
+            themeColor: '#ffffff',
+            tileLayer: 'https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png',
+            warningColor: '#fed719',
+        });
+    });
+});
+describe('createThemeURL', () => {
+    it('should create the URL of a theme including correct query parameters and bulma version', () => {
+        const result = (0, theme_1.createThemeURL)({
+            dangerColor: '#ff2800',
+            font: {
+                family: 'Open Sans',
+                source: 'google',
+            },
+            infoColor: '#a7d0ff',
+            linkColor: '#0440ad',
+            primaryColor: '#123456',
+            splashColor: '#ffffff',
+            successColor: '#abcdef',
+            themeColor: '#ffffff',
+            tileLayer: 'https://example.com',
+            warningColor: '#fed719',
+        });
+        expect(result).toBe(`/bulma/${package_json_1.version}/bulma.min.css` +
+            '?dangerColor=%23ff2800' +
+            '&fontFamily=Open+Sans' +
+            '&fontSource=google' +
+            '&infoColor=%23a7d0ff' +
+            '&linkColor=%230440ad' +
+            '&primaryColor=%23123456' +
+            '&splashColor=%23ffffff' +
+            '&successColor=%23abcdef' +
+            '&themeColor=%23ffffff' +
+            '&tileLayer=https%3A%2F%2Fexample.com' +
+            '&warningColor=%23fed719');
+    });
+});
+//# sourceMappingURL=theme.test.js.map

package/theme.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"theme.test.js","sourceRoot":"","sources":["theme.test.ts"],"names":[],"mappings":";;AAAA,qDAA6C;AAE7C,mCAAsD;AAEtD,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;IAC3B,EAAE,CAAC,sCAAsC,EAAE,GAAG,EAAE;QAC9C,MAAM,MAAM,GAAG,IAAA,mBAAW,EAAC,EAAE,YAAY,EAAE,SAAS,EAAE,YAAY,EAAE,SAAS,EAAE,CAAC,CAAC;QACjF,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC;YAC3B,WAAW,EAAE,SAAS;YACtB,IAAI,EAAE;gBACJ,MAAM,EAAE,WAAW;gBACnB,MAAM,EAAE,QAAQ;aACjB;YACD,SAAS,EAAE,SAAS;YACpB,SAAS,EAAE,SAAS;YACpB,YAAY,EAAE,SAAS;YACvB,WAAW,EAAE,SAAS;YACtB,YAAY,EAAE,SAAS;YACvB,UAAU,EAAE,SAAS;YACrB,SAAS,EAAE,oDAAoD;YAC/D,YAAY,EAAE,SAAS;SACxB,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wCAAwC,EAAE,GAAG,EAAE;QAChD,MAAM,MAAM,GAAG,IAAA,mBAAW,EAAC,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC;QACzD,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC;YAC3B,WAAW,EAAE,SAAS;YACtB,IAAI,EAAE;gBACJ,MAAM,EAAE,MAAM;gBACd,MAAM,EAAE,QAAQ;aACjB;YACD,SAAS,EAAE,SAAS;YACpB,SAAS,EAAE,SAAS;YACpB,YAAY,EAAE,SAAS;YACvB,WAAW,EAAE,SAAS;YACtB,YAAY,EAAE,SAAS;YACvB,UAAU,EAAE,SAAS;YACrB,SAAS,EAAE,oDAAoD;YAC/D,YAAY,EAAE,SAAS;SACxB,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gCAAgC,EAAE,GAAG,EAAE;QACxC,MAAM,MAAM,GAAG,IAAA,mBAAW,EACxB,EAAE,YAAY,EAAE,SAAS,EAAE,YAAY,EAAE,SAAS,EAAE,EACpD,EAAE,YAAY,EAAE,SAAS,EAAE,CAC5B,CAAC;QACF,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC;YAC3B,WAAW,EAAE,SAAS;YACtB,IAAI,EAAE;gBACJ,MAAM,EAAE,WAAW;gBACnB,MAAM,EAAE,QAAQ;aACjB;YACD,SAAS,EAAE,SAAS;YACpB,SAAS,EAAE,SAAS;YACpB,YAAY,EAAE,SAAS;YACvB,WAAW,EAAE,SAAS;YACtB,YAAY,EAAE,SAAS;YACvB,UAAU,EAAE,SAAS;YACrB,SAAS,EAAE,oDAAoD;YAC/D,YAAY,EAAE,SAAS;SACxB,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;IAC9B,EAAE,CAAC,uFAAuF,EAAE,GAAG,EAAE;QAC/F,MAAM,MAAM,GAAG,IAAA,sBAAc,EAAC;YAC5B,WAAW,EAAE,SAAS;YACtB,IAAI,EAAE;gBACJ,MAAM,EAAE,WAAW;gBACnB,MAAM,EAAE,QAAQ;aACjB;YACD,SAAS,EAAE,SAAS;YACpB,SAAS,EAAE,SAAS;YACpB,YAAY,EAAE,SAAS;YACvB,WAAW,EAAE,SAAS;YACtB,YAAY,EAAE,SAAS;YACvB,UAAU,EAAE,SAAS;YACrB,SAAS,EAAE,qBAAqB;YAChC,YAAY,EAAE,SAAS;SACxB,CAAC,CAAC;QACH,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CACjB,UAAU,sBAAO,gBAAgB;YAC/B,wBAAwB;YACxB,uBAAuB;YACvB,oBAAoB;YACpB,sBAAsB;YACtB,sBAAsB;YACtB,yBAAyB;YACzB,wBAAwB;YACxB,yBAAyB;YACzB,uBAAuB;YACvB,sCAAsC;YACtC,yBAAyB,CAC5B,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/theme.test.ts

@@ -0,0 +1,99 @@
+import { version } from 'bulma/package.json';
+
+import { createThemeURL, mergeThemes } from './theme';
+
+describe('mergeThemes', () => {
+  it('should use the base theme as default', () => {
+    const result = mergeThemes({ primaryColor: '#123456', successColor: '#789abc' });
+    expect(result).toStrictEqual({
+      dangerColor: '#ff2800',
+      font: {
+        family: 'Open Sans',
+        source: 'google',
+      },
+      infoColor: '#a7d0ff',
+      linkColor: '#0440ad',
+      primaryColor: '#123456',
+      splashColor: '#ffffff',
+      successColor: '#789abc',
+      themeColor: '#ffffff',
+      tileLayer: 'https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png',
+      warningColor: '#fed719',
+    });
+  });
+
+  it('should fill in the default font source', () => {
+    const result = mergeThemes({ font: { family: 'Lato' } });
+    expect(result).toStrictEqual({
+      dangerColor: '#ff2800',
+      font: {
+        family: 'Lato',
+        source: 'google',
+      },
+      infoColor: '#a7d0ff',
+      linkColor: '#0440ad',
+      primaryColor: '#5393ff',
+      splashColor: '#ffffff',
+      successColor: '#1fd25b',
+      themeColor: '#ffffff',
+      tileLayer: 'https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png',
+      warningColor: '#fed719',
+    });
+  });
+
+  it('should combine multiple themes', () => {
+    const result = mergeThemes(
+      { primaryColor: '#123456', successColor: '#789abc' },
+      { successColor: '#abcdef' },
+    );
+    expect(result).toStrictEqual({
+      dangerColor: '#ff2800',
+      font: {
+        family: 'Open Sans',
+        source: 'google',
+      },
+      infoColor: '#a7d0ff',
+      linkColor: '#0440ad',
+      primaryColor: '#123456',
+      splashColor: '#ffffff',
+      successColor: '#abcdef',
+      themeColor: '#ffffff',
+      tileLayer: 'https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png',
+      warningColor: '#fed719',
+    });
+  });
+});
+
+describe('createThemeURL', () => {
+  it('should create the URL of a theme including correct query parameters and bulma version', () => {
+    const result = createThemeURL({
+      dangerColor: '#ff2800',
+      font: {
+        family: 'Open Sans',
+        source: 'google',
+      },
+      infoColor: '#a7d0ff',
+      linkColor: '#0440ad',
+      primaryColor: '#123456',
+      splashColor: '#ffffff',
+      successColor: '#abcdef',
+      themeColor: '#ffffff',
+      tileLayer: 'https://example.com',
+      warningColor: '#fed719',
+    });
+    expect(result).toBe(
+      `/bulma/${version}/bulma.min.css` +
+        '?dangerColor=%23ff2800' +
+        '&fontFamily=Open+Sans' +
+        '&fontSource=google' +
+        '&infoColor=%23a7d0ff' +
+        '&linkColor=%230440ad' +
+        '&primaryColor=%23123456' +
+        '&splashColor=%23ffffff' +
+        '&successColor=%23abcdef' +
+        '&themeColor=%23ffffff' +
+        '&tileLayer=https%3A%2F%2Fexample.com' +
+        '&warningColor=%23fed719',
+    );
+  });
+});

package/theme.ts

@@ -0,0 +1,38 @@
+import { Theme } from '@appsemble/types';
+
+import { baseTheme } from './constants';
+
+/**
+ * Declare URLSearchParams in way that’s compatible between `dom` lib and `node` types.
+ */
+declare class URLSearchParams {
+  constructor(params: Record<string, string>);
+
+  sort(): void;
+}
+
+/**
+ * Merge multiple partial themes and the base theme into one resulting theme.
+ *
+ * @param themes The themes to merge. The later a theme is specified, the higher its priority.
+ * @returns A combination of all themes.
+ */
+export function mergeThemes(...themes: Partial<Theme>[]): Theme {
+  const result = Object.assign({}, baseTheme, ...themes) as Theme;
+  result.font.source ||= 'google';
+  return result;
+}
+
+/**
+ * Create a Bulma URL for an Appsemble theme.
+ *
+ * @param theme The theme to create a URL for.
+ * @returns The URL to the Bulma theme.
+ */
+export function createThemeURL(theme: Theme): string {
+  const { font, ...rest } = theme;
+  const params = new URLSearchParams({ ...rest, fontFamily: font.family, fontSource: font.source });
+  // Sort for cacheability.
+  params.sort();
+  return `/bulma/0.9.3/bulma.min.css?${params}`;
+}

package/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "extends": "../../tsconfig",
+  "compilerOptions": {
+    "module": "commonjs",
+    "types": ["jest", "node"]
+  }
+}

package/types.d.ts

@@ -0,0 +1,6 @@
+declare global {
+    namespace Intl {
+        function supportedValuesOf(value: string): string[];
+    }
+}
+export {};

package/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["types.ts"],"names":[],"mappings":""}

package/types.ts

@@ -0,0 +1,8 @@
+declare global {
+  // eslint-disable-next-line @typescript-eslint/no-namespace
+  namespace Intl {
+    function supportedValuesOf(value: string): string[];
+  }
+}
+
+export {};

package/validateStyle.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validateStyle.js","sourceRoot":"","sources":["validateStyle.ts"],"names":[],"mappings":";;;;;;AAAA,sDAA8B;AAE9B,MAAa,oBAAqB,SAAQ,KAAK;IAC7C,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,sBAAsB,CAAC;IACrC,CAAC;CACF;AALD,oDAKC;AAED,SAAgB,aAAa,CAAC,GAAY;IACxC,IAAI,CAAC,GAAG,EAAE;QACR,OAAO,IAAI,CAAC;KACb;IACD,IAAI;QACF,OAAO,MAAM,CAAC,iBAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;KACnC;IAAC,OAAO,KAAc,EAAE;QACvB,MAAM,IAAI,oBAAoB,CAAC,KAAe,CAAC,CAAC;KACjD;AACH,CAAC;AATD,sCASC"}

package/validateStyle.test.d.ts

@@ -0,0 +1 @@
+export {};

package/validateStyle.test.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const validateStyle_1 = require("./validateStyle");
+describe('validateStyle', () => {
+    it('should validate correct CSS', () => {
+        const css = 'body { background-color: red; }';
+        const validatedCss = (0, validateStyle_1.validateStyle)(css);
+        expect(validatedCss).toStrictEqual(css);
+    });
+    it('should throw a CssValidationError when validating incorrect CSS', () => {
+        expect(() => (0, validateStyle_1.validateStyle)("this isn't valid")).toThrow(validateStyle_1.StyleValidationError);
+    });
+});
+//# sourceMappingURL=validateStyle.test.js.map

package/validateStyle.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validateStyle.test.js","sourceRoot":"","sources":["validateStyle.test.ts"],"names":[],"mappings":";;AAAA,mDAAsE;AAEtE,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;IAC7B,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;QACrC,MAAM,GAAG,GAAG,iCAAiC,CAAC;QAC9C,MAAM,YAAY,GAAG,IAAA,6BAAa,EAAC,GAAG,CAAC,CAAC;QAExC,MAAM,CAAC,YAAY,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;IAC1C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iEAAiE,EAAE,GAAG,EAAE;QACzE,MAAM,CAAC,GAAG,EAAE,CAAC,IAAA,6BAAa,EAAC,kBAAkB,CAAC,CAAC,CAAC,OAAO,CAAC,oCAAoB,CAAC,CAAC;IAChF,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/validateStyle.test.ts

@@ -0,0 +1,14 @@
+import { StyleValidationError, validateStyle } from './validateStyle';
+
+describe('validateStyle', () => {
+  it('should validate correct CSS', () => {
+    const css = 'body { background-color: red; }';
+    const validatedCss = validateStyle(css);
+
+    expect(validatedCss).toStrictEqual(css);
+  });
+
+  it('should throw a CssValidationError when validating incorrect CSS', () => {
+    expect(() => validateStyle("this isn't valid")).toThrow(StyleValidationError);
+  });
+});

package/validateStyle.ts

@@ -0,0 +1,19 @@
+import postcss from 'postcss';
+
+export class StyleValidationError extends Error {
+  constructor(message: string) {
+    super(message);
+    this.name = 'StyleValidationError';
+  }
+}
+
+export function validateStyle(css: unknown): string {
+  if (!css) {
+    return null;
+  }
+  try {
+    return String(postcss.parse(css));
+  } catch (error: unknown) {
+    throw new StyleValidationError(error as string);
+  }
+}

package/validation.d.ts

@@ -0,0 +1,24 @@
+import { AppDefinition, BlockManifest } from '@appsemble/types';
+import { ValidatorResult } from 'jsonschema';
+import { Promisable } from 'type-fest';
+import { IdentifiableBlock } from './blockUtils';
+/**
+ * Check whether or not the given link represents a link related to the Appsemble core.
+ *
+ * @param link The link to check
+ * @returns Whether or not the given link represents a link related to the Appsemble core.
+ */
+export declare function isAppLink(link: string[] | string): boolean;
+export declare type BlockVersionsGetter = (blockMap: IdentifiableBlock[]) => Promisable<BlockManifest[]>;
+/**
+ * Validate an app definition.
+ *
+ * This check various conditions which can’t be validated using basic JSON schema validation.
+ *
+ * @param definition The app validation to check.
+ * @param getBlockVersions A function for getting block manifests from block versions.
+ * @param validatorResult If specified, error messages will be applied to this existing validator
+ * result.
+ * @returns A validator result which contains all app validation violations.
+ */
+export declare function validateAppDefinition(definition: AppDefinition, getBlockVersions: BlockVersionsGetter, validatorResult?: ValidatorResult): Promise<ValidatorResult>;