@appsemble/utils 0.20.10 → 0.20.11

package/remap.ts

@@ -0,0 +1,391 @@
+import { Remapper, Remappers, UserInfo } from '@appsemble/types';
+import { addMilliseconds, parse, parseISO } from 'date-fns';
+import equal from 'fast-deep-equal';
+import { createEvent, EventAttributes } from 'ics';
+import { IntlMessageFormat } from 'intl-messageformat';
+import parseDuration from 'parse-duration';
+
+import { has } from './has';
+import { getDuration, processLocation } from './ics';
+import { mapValues } from './mapValues';
+import { stripNullValues } from './miscellaneous';
+
+/**
+ * Stub the console types, since we don’t want to use dom or node types here.
+ */
+declare const console: {
+  /**
+   * Log an error message to the console.
+   *
+   * @param args The message to render to the console.
+   */
+  error: (...args: unknown[]) => void;
+};
+
+export interface IntlMessage {
+  id?: string;
+  defaultMessage?: string;
+}
+
+/**
+ * Get a message format instance based on a message id and default message.
+ *
+ * @param msg The message to get the message format instance for.
+ * @returns A message format instance.
+ */
+export type MessageGetter = (msg: IntlMessage) => IntlMessageFormat;
+
+export interface RemapperContext {
+  /**
+   * The id of the app whose context the remapper is run in.
+   */
+  appId: number;
+
+  /**
+   * The current URL.
+   */
+  url: string;
+
+  /**
+   * The base URL of the app.
+   */
+  appUrl: string;
+
+  /**
+   * @see MessageGetter
+   */
+  getMessage: MessageGetter;
+
+  /**
+   * The current locale of the app.
+   */
+  locale: string;
+
+  /**
+   * Custom data that is available in the page.
+   */
+  pageData?: unknown;
+
+  /**
+   * The OpenID compatible userinfo object for the current user.
+   */
+  userInfo: UserInfo;
+
+  /**
+   * A custom context passed to the remap function.
+   */
+  context: Record<string, any>;
+}
+
+interface InternalContext extends RemapperContext {
+  root?: unknown;
+
+  array?: {
+    index: number;
+    length: number;
+  };
+}
+
+type MapperImplementations = {
+  [F in keyof Remappers]: (args: Remappers[F], input: unknown, context: InternalContext) => unknown;
+};
+
+class RemapperError extends TypeError {
+  remapper: Remapper;
+
+  constructor(message: string, remapper: Remapper) {
+    super(message);
+    this.name = 'RemapperError';
+    this.remapper = remapper;
+  }
+}
+
+export function remap(
+  remapper: Remapper,
+  input: unknown,
+  context: InternalContext | RemapperContext,
+): unknown {
+  if (
+    typeof remapper === 'string' ||
+    typeof remapper === 'number' ||
+    typeof remapper === 'boolean' ||
+    remapper == null
+  ) {
+    return remapper;
+  }
+
+  let result = input;
+  const remappers = Array.isArray(remapper) ? remapper : [remapper];
+  for (const mapper of remappers) {
+    const entries = Object.entries(mapper) as [keyof MapperImplementations, unknown][];
+    if (entries.length !== 1) {
+      console.error(mapper);
+      throw new RemapperError(
+        `Remapper has multiple keys: ${Object.keys(mapper)
+          .map((key) => JSON.stringify(key))
+          .join(', ')}`,
+        mapper,
+      );
+    }
+    const [[name, args]] = entries;
+    // eslint-disable-next-line @typescript-eslint/no-use-before-define
+    if (!has(mapperImplementations, name)) {
+      console.error(mapper);
+      throw new RemapperError(`Remapper name does not exist: ${JSON.stringify(name)}`, mapper);
+    }
+    // eslint-disable-next-line @typescript-eslint/no-use-before-define
+    const implementation = mapperImplementations[name];
+    result = implementation(args as any, result, { root: input, ...context });
+  }
+  return result;
+}
+
+/**
+ * Implementations of all remappers.
+ *
+ * All arguments are deferred from remappers.
+ *
+ * @see Remappers
+ */
+const mapperImplementations: MapperImplementations = {
+  app(prop, input, context) {
+    if (prop === 'id') {
+      return context.appId;
+    }
+    if (prop === 'locale') {
+      return context.locale;
+    }
+    if (prop === 'url') {
+      return context.appUrl;
+    }
+    throw new Error(`Unknown app property: ${prop}`);
+  },
+
+  page(prop, input, context) {
+    if (prop === 'data') {
+      return context.pageData;
+    }
+    if (prop === 'url') {
+      return context.url;
+    }
+    throw new Error(`Unknown page property: ${prop}`);
+  },
+
+  context: (prop, input, context) =>
+    String(prop)
+      .split('.')
+      .reduce((acc, p) => acc?.[p] ?? null, context.context),
+
+  equals(mappers, input: any, context) {
+    if (mappers.length <= 1) {
+      return true;
+    }
+
+    const values = mappers.map((mapper) => remap(mapper, input, context));
+    return values.every((value) => equal(values[0], value));
+  },
+
+  gt: ([left, right], input: any, context) =>
+    remap(left, input, context) > remap(right, input, context),
+
+  lt: ([left, right], input: any, context) =>
+    remap(left, input, context) < remap(right, input, context),
+
+  ics(mappers, input, context) {
+    let event;
+    const mappedStart = remap(mappers.start, input, context);
+    const start = mappedStart instanceof Date ? mappedStart : parseISO(mappedStart as string);
+    const sharedAttributes = {
+      start: [
+        start.getUTCFullYear(),
+        start.getUTCMonth() + 1,
+        start.getUTCDate(),
+        start.getUTCHours(),
+        start.getUTCMinutes(),
+      ],
+      startInputType: 'utc',
+      startOutputType: 'utc',
+      title: remap(mappers.title, input, context) as string,
+      description: remap(mappers.description, input, context) as string,
+      url: remap(mappers.url, input, context) as string,
+      location: remap(mappers.location, input, context) as string,
+      geo: processLocation(remap(mappers.coordinates, input, context)),
+      productId: context.appUrl,
+    };
+
+    if ('end' in mappers) {
+      const mappedEnd = remap(mappers.end, input, context);
+      const end = mappedEnd instanceof Date ? mappedEnd : parseISO(mappedEnd as string);
+      event = {
+        ...sharedAttributes,
+        endInputType: 'utc',
+        endOutputType: 'utc',
+        end: [
+          end.getUTCFullYear(),
+          end.getUTCMonth() + 1,
+          end.getUTCDate(),
+          end.getUTCHours(),
+          end.getUTCMinutes(),
+        ],
+      };
+    } else {
+      event = {
+        ...sharedAttributes,
+        duration: getDuration(remap(mappers.duration, input, context) as string),
+      };
+    }
+
+    const { error, value } = createEvent(event as EventAttributes);
+    if (error) {
+      throw error;
+    }
+    return value;
+  },
+
+  if(mappers, input, context) {
+    const condition = remap(mappers.condition, input, context);
+    return remap(condition ? mappers.then : mappers.else, input, context);
+  },
+
+  'object.from': (mappers, input, context) =>
+    mapValues(mappers, (mapper) => remap(mapper, input, context)),
+
+  'object.assign': (mappers, input: any, context) => ({
+    ...input,
+    ...mapValues(mappers, (mapper) => remap(mapper, input, context)),
+  }),
+
+  'object.omit'(keys, input: Record<string, any>) {
+    const result = { ...input };
+    for (const key of keys) {
+      if (Array.isArray(key)) {
+        key.reduce((acc, k, index) => {
+          if (index === key.length - 1) {
+            delete acc[k];
+          } else {
+            return acc?.[k];
+          }
+          return acc;
+        }, result);
+      } else {
+        delete result[key];
+      }
+    }
+    return result;
+  },
+
+  'array.map': (mapper, input: any[], context) =>
+    input?.map((item, index) =>
+      remap(mapper, item, {
+        ...context,
+        array: { index, length: input.length },
+      }),
+    ) ?? [],
+
+  'array.unique'(mapper, input, context) {
+    if (!Array.isArray(input)) {
+      return input;
+    }
+
+    const remapped = input.map((value, index) =>
+      mapper == null
+        ? value
+        : remap(mapper, value, { ...context, array: { index, length: input.length } }),
+    );
+    return input.filter((value, index) => {
+      for (let i = 0; i < index; i += 1) {
+        if (equal(remapped[index], remapped[i])) {
+          return false;
+        }
+      }
+
+      return true;
+    });
+  },
+
+  array: (prop, input, context) => context.array?.[prop],
+
+  static: (input) => input,
+
+  prop: (prop, obj: Record<string, unknown>) => [].concat(prop).reduce((acc, p) => acc?.[p], obj),
+
+  'date.parse': (format, input: string) =>
+    format ? parse(input, format, new Date()) : parseISO(input),
+
+  'date.now': () => new Date(),
+
+  'date.add'(time, input: any) {
+    const expireDuration = parseDuration(time);
+
+    if (!expireDuration || !input || (!Number.isFinite(input) && !(input instanceof Date))) {
+      return input;
+    }
+
+    return addMilliseconds(input, expireDuration);
+  },
+
+  'null.strip': (args, input) => stripNullValues(input, args || {}),
+
+  'random.choice': (args, input: any[]) =>
+    Array.isArray(input) ? input[Math.floor(Math.random() * input.length)] : input,
+
+  'random.integer'(args) {
+    const min = Math.min(...args);
+    const max = Math.max(...args);
+    return Math.floor(Math.random() * (max - min) + min);
+  },
+
+  'random.float'(args) {
+    const min = Math.min(...args);
+    const max = Math.max(...args);
+    return Math.random() * (max - min) + min;
+  },
+
+  'random.string'(args) {
+    const result: string[] = [];
+    const characters = [...new Set(args.choice.split(''))];
+    for (let i = 0; i <= args.length; i += 1) {
+      result.push(characters[Math.floor(Math.random() * characters.length)]);
+    }
+    return result.join('');
+  },
+
+  root: (args, input, context) => context.root,
+
+  'string.case'(stringCase, input) {
+    if (stringCase === 'lower') {
+      return String(input).toLowerCase();
+    }
+    if (stringCase === 'upper') {
+      return String(input).toUpperCase();
+    }
+    return input;
+  },
+
+  'string.format'({ messageId, template, values }, input, context) {
+    try {
+      const message = context.getMessage({ id: messageId, defaultMessage: template });
+      return message.format(
+        values ? mapValues(values, (val) => remap(val, input, context)) : undefined,
+      );
+    } catch (error: unknown) {
+      if (messageId) {
+        return `{${messageId}}`;
+      }
+
+      return (error as Error).message;
+    }
+  },
+
+  'string.replace'(values, input) {
+    const [[regex, replacer]] = Object.entries(values);
+    return String(input).replace(new RegExp(regex, 'gm'), replacer);
+  },
+
+  translate(messageId, input, context) {
+    const message = context.getMessage({ id: messageId });
+    return message.format() || `{${messageId}}`;
+  },
+
+  user: (property, input, context) => context.userInfo?.[property],
+};

package/string.d.ts

@@ -0,0 +1,23 @@
+/**
+ * A minimalistic implementation to convert camelcase strings to hyphenated ones.
+ *
+ * @param string The camelcase input.
+ * @returns The input, but hyphenated.
+ */
+export declare function camelToHyphen(string: string): string;
+/**
+ * Convert a string to upper case.
+ *
+ * @param input The string to convert to upper case.
+ * @returns The input, but upper case.
+ */
+export declare function toUpperCase(input: string): string;
+/**
+ * Escape a JSON reference.
+ *
+ * See https://tools.ietf.org/html/rfc6901#section-3
+ *
+ * @param ref The JSON pointer segment to escape.
+ * @returns The escaped JSON pointer segment.
+ */
+export declare function decodeJSONRef(ref: string): string;

package/string.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.decodeJSONRef = exports.toUpperCase = exports.camelToHyphen = void 0;
+/**
+ * A minimalistic implementation to convert camelcase strings to hyphenated ones.
+ *
+ * @param string The camelcase input.
+ * @returns The input, but hyphenated.
+ */
+function camelToHyphen(string) {
+    return string.replace(/[A-Z]/g, (match) => `-${match.toLowerCase()}`);
+}
+exports.camelToHyphen = camelToHyphen;
+/**
+ * Convert a string to upper case.
+ *
+ * @param input The string to convert to upper case.
+ * @returns The input, but upper case.
+ */
+function toUpperCase(input) {
+    return input.toUpperCase();
+}
+exports.toUpperCase = toUpperCase;
+/**
+ * Escape a JSON reference.
+ *
+ * See https://tools.ietf.org/html/rfc6901#section-3
+ *
+ * @param ref The JSON pointer segment to escape.
+ * @returns The escaped JSON pointer segment.
+ */
+function decodeJSONRef(ref) {
+    return decodeURIComponent(ref).replace(/~1/g, '/').replace(/~0/g, '~');
+}
+exports.decodeJSONRef = decodeJSONRef;
+//# sourceMappingURL=string.js.map

package/string.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"string.js","sourceRoot":"","sources":["string.ts"],"names":[],"mappings":";;;AAAA;;;;;GAKG;AACH,SAAgB,aAAa,CAAC,MAAc;IAC1C,OAAO,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;AACxE,CAAC;AAFD,sCAEC;AAED;;;;;GAKG;AACH,SAAgB,WAAW,CAAC,KAAa;IACvC,OAAO,KAAK,CAAC,WAAW,EAAE,CAAC;AAC7B,CAAC;AAFD,kCAEC;AAED;;;;;;;GAOG;AACH,SAAgB,aAAa,CAAC,GAAW;IACvC,OAAO,kBAAkB,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;AACzE,CAAC;AAFD,sCAEC"}

package/string.test.d.ts

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

package/string.test.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const string_1 = require("./string");
+describe('camelToHyphen', () => {
+    it('should convert camel case to hyphenated', () => {
+        const result = (0, string_1.camelToHyphen)('iAmAString');
+        expect(result).toBe('i-am-a-string');
+    });
+});
+describe('toUpperCase', () => {
+    it('should convert a string to upper case', () => {
+        expect((0, string_1.toUpperCase)('hello')).toBe('HELLO');
+    });
+});
+describe('decodeJSONRef', () => {
+    const tests = [
+        ['foo~1bar', 'foo/bar'],
+        ['foo~0bar', 'foo~bar'],
+        ['foo~0~1bar', 'foo~/bar'],
+        ['foo~1~0bar', 'foo/~bar'],
+        ['Record%3Cstring%2Cnumber%3E', 'Record<string,number>'],
+    ];
+    it.each(tests)('%s → %s', (unescaped, escaped) => {
+        const result = (0, string_1.decodeJSONRef)(unescaped);
+        expect(result).toBe(escaped);
+    });
+});
+//# sourceMappingURL=string.test.js.map

package/string.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"string.test.js","sourceRoot":"","sources":["string.test.ts"],"names":[],"mappings":";;AAAA,qCAAqE;AAErE,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;IAC7B,EAAE,CAAC,yCAAyC,EAAE,GAAG,EAAE;QACjD,MAAM,MAAM,GAAG,IAAA,sBAAa,EAAC,YAAY,CAAC,CAAC;QAC3C,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;IAC3B,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;QAC/C,MAAM,CAAC,IAAA,oBAAW,EAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC7C,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;IAC7B,MAAM,KAAK,GAAG;QACZ,CAAC,UAAU,EAAE,SAAS,CAAC;QACvB,CAAC,UAAU,EAAE,SAAS,CAAC;QACvB,CAAC,YAAY,EAAE,UAAU,CAAC;QAC1B,CAAC,YAAY,EAAE,UAAU,CAAC;QAC1B,CAAC,6BAA6B,EAAE,uBAAuB,CAAC;KACzD,CAAC;IAEF,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,SAAS,EAAE,CAAC,SAAS,EAAE,OAAO,EAAE,EAAE;QAC/C,MAAM,MAAM,GAAG,IAAA,sBAAa,EAAC,SAAS,CAAC,CAAC;QACxC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC/B,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/string.test.ts

@@ -0,0 +1,29 @@
+import { camelToHyphen, decodeJSONRef, toUpperCase } from './string';
+
+describe('camelToHyphen', () => {
+  it('should convert camel case to hyphenated', () => {
+    const result = camelToHyphen('iAmAString');
+    expect(result).toBe('i-am-a-string');
+  });
+});
+
+describe('toUpperCase', () => {
+  it('should convert a string to upper case', () => {
+    expect(toUpperCase('hello')).toBe('HELLO');
+  });
+});
+
+describe('decodeJSONRef', () => {
+  const tests = [
+    ['foo~1bar', 'foo/bar'],
+    ['foo~0bar', 'foo~bar'],
+    ['foo~0~1bar', 'foo~/bar'],
+    ['foo~1~0bar', 'foo/~bar'],
+    ['Record%3Cstring%2Cnumber%3E', 'Record<string,number>'],
+  ];
+
+  it.each(tests)('%s → %s', (unescaped, escaped) => {
+    const result = decodeJSONRef(unescaped);
+    expect(result).toBe(escaped);
+  });
+});

package/string.ts

@@ -0,0 +1,31 @@
+/**
+ * A minimalistic implementation to convert camelcase strings to hyphenated ones.
+ *
+ * @param string The camelcase input.
+ * @returns The input, but hyphenated.
+ */
+export function camelToHyphen(string: string): string {
+  return string.replace(/[A-Z]/g, (match) => `-${match.toLowerCase()}`);
+}
+
+/**
+ * Convert a string to upper case.
+ *
+ * @param input The string to convert to upper case.
+ * @returns The input, but upper case.
+ */
+export function toUpperCase(input: string): string {
+  return input.toUpperCase();
+}
+
+/**
+ * Escape a JSON reference.
+ *
+ * See https://tools.ietf.org/html/rfc6901#section-3
+ *
+ * @param ref The JSON pointer segment to escape.
+ * @returns The escaped JSON pointer segment.
+ */
+export function decodeJSONRef(ref: string): string {
+  return decodeURIComponent(ref).replace(/~1/g, '/').replace(/~0/g, '~');
+}

package/theme.d.ts

@@ -0,0 +1,15 @@
+import { Theme } from '@appsemble/types';
+/**
+ * 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 declare function mergeThemes(...themes: Partial<Theme>[]): Theme;
+/**
+ * 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 declare function createThemeURL(theme: Theme): string;

package/theme.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createThemeURL = exports.mergeThemes = void 0;
+const constants_1 = require("./constants");
+/**
+ * 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.
+ */
+function mergeThemes(...themes) {
+    var _a;
+    const result = Object.assign({}, constants_1.baseTheme, ...themes);
+    (_a = result.font).source || (_a.source = 'google');
+    return result;
+}
+exports.mergeThemes = mergeThemes;
+/**
+ * Create a Bulma URL for an Appsemble theme.
+ *
+ * @param theme The theme to create a URL for.
+ * @returns The URL to the Bulma theme.
+ */
+function createThemeURL(theme) {
+    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}`;
+}
+exports.createThemeURL = createThemeURL;
+//# sourceMappingURL=theme.js.map

package/theme.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"theme.js","sourceRoot":"","sources":["theme.ts"],"names":[],"mappings":";;;AAEA,2CAAwC;AAWxC;;;;;GAKG;AACH,SAAgB,WAAW,CAAC,GAAG,MAAwB;;IACrD,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,qBAAS,EAAE,GAAG,MAAM,CAAU,CAAC;IAChE,MAAA,MAAM,CAAC,IAAI,EAAC,MAAM,QAAN,MAAM,GAAK,QAAQ,EAAC;IAChC,OAAO,MAAM,CAAC;AAChB,CAAC;AAJD,kCAIC;AAED;;;;;GAKG;AACH,SAAgB,cAAc,CAAC,KAAY;IACzC,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,GAAG,KAAK,CAAC;IAChC,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,EAAE,IAAI,CAAC,MAAM,EAAE,UAAU,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IAClG,yBAAyB;IACzB,MAAM,CAAC,IAAI,EAAE,CAAC;IACd,OAAO,8BAA8B,MAAM,EAAE,CAAC;AAChD,CAAC;AAND,wCAMC"}

package/theme.test.d.ts

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