@appsemble/utils 0.25.2 → 0.26.0

package/examples.js

@@ -0,0 +1,668 @@
+import { IntlMessageFormat } from 'intl-messageformat';
+import { stringify } from 'yaml';
+export const examples = {
+    None: {
+        input: null,
+        remapper: '',
+        result: '',
+    },
+    'app.id': {
+        input: null,
+        remapper: {
+            app: 'id',
+        },
+        result: 0,
+    },
+    'app.locale': {
+        input: null,
+        remapper: {
+            app: 'locale',
+        },
+        result: 'en',
+    },
+    'app.url': {
+        input: null,
+        remapper: {
+            app: 'url',
+        },
+        result: 'https://example-app.example-organization.example.com',
+    },
+    appMember: {
+        input: null,
+        remapper: {},
+        result: {},
+        skip: true,
+    },
+    array: {
+        input: ['a', 'b', 'c'],
+        remapper: {
+            'array.map': {
+                'object.from': {
+                    index: {
+                        array: 'index',
+                    },
+                    length: {
+                        array: 'length',
+                    },
+                },
+            },
+        },
+        result: [
+            {
+                index: 0,
+                length: 3,
+            },
+            {
+                index: 1,
+                length: 3,
+            },
+            {
+                index: 2,
+                length: 3,
+            },
+        ],
+    },
+    'array.append': {
+        input: [
+            {
+                name: 'Peter',
+                occupation: 'Delivery driver',
+            },
+            {
+                name: 'Otto',
+                occupation: 'Scientist',
+            },
+            {
+                name: 'Harry',
+                occupation: 'CEO',
+            },
+        ],
+        remapper: {
+            'array.append': [
+                {
+                    'object.from': {
+                        name: 'James',
+                        occupation: 'News reporter',
+                    },
+                },
+            ],
+        },
+        result: [
+            {
+                name: 'Peter',
+                occupation: 'Delivery driver',
+            },
+            {
+                name: 'Otto',
+                occupation: 'Scientist',
+            },
+            {
+                name: 'Harry',
+                occupation: 'CEO',
+            },
+            {
+                name: 'James',
+                occupation: 'News reporter',
+            },
+        ],
+    },
+    'array.find': {
+        input: [
+            {
+                name: 'Craig',
+            },
+            {
+                name: 'Joey',
+            },
+            {
+                name: 'Stuart',
+            },
+        ],
+        remapper: {
+            'array.find': {
+                equals: [
+                    {
+                        prop: 'name',
+                    },
+                    'Craig',
+                ],
+            },
+        },
+        result: {
+            name: 'Craig',
+        },
+    },
+    'array.from': {
+        input: null,
+        remapper: {
+            'array.from': ['Peter', 'Otto', 'Harry'],
+        },
+        result: ['Peter', 'Otto', 'Harry'],
+    },
+    'array.map': {
+        input: [
+            {
+                name: 'Peter',
+                occupation: 'Delivery driver',
+            },
+            {
+                name: 'Otto',
+                occupation: 'Scientist',
+            },
+            {
+                name: 'Harry',
+                occupation: 'CEO',
+            },
+        ],
+        remapper: {
+            'array.map': {
+                'object.omit': ['name'],
+            },
+        },
+        result: [
+            {
+                occupation: 'Delivery driver',
+            },
+            {
+                occupation: 'Scientist',
+            },
+            {
+                occupation: 'CEO',
+            },
+        ],
+    },
+    'array.map.1': {
+        input: [
+            {
+                name: 'Peter',
+                occupation: 'Delivery driver',
+            },
+            {
+                name: 'Otto',
+                occupation: 'Scientist',
+            },
+            {
+                name: 'Harry',
+                occupation: 'CEO',
+            },
+        ],
+        remapper: [
+            {
+                'array.map': {
+                    if: {
+                        condition: {
+                            equals: [
+                                {
+                                    prop: 'occupation',
+                                },
+                                'Scientist',
+                            ],
+                        },
+                        else: null,
+                        then: {
+                            'object.from': {
+                                name: {
+                                    prop: 'name',
+                                },
+                                occupation: {
+                                    prop: 'occupation',
+                                },
+                            },
+                        },
+                    },
+                },
+            },
+            {
+                'null.strip': null,
+            },
+        ],
+        result: [
+            {
+                name: 'Otto',
+                occupation: 'Scientist',
+            },
+        ],
+    },
+    'array.omit': {
+        input: [
+            {
+                name: 'Peter',
+                occupation: 'Delivery driver',
+            },
+            {
+                name: 'Otto',
+                occupation: 'Scientist',
+            },
+            {
+                name: 'Harry',
+                occupation: 'CEO',
+            },
+            {
+                name: 'James',
+                occupation: 'News reporter',
+            },
+        ],
+        remapper: {
+            'array.omit': [3],
+        },
+        result: [
+            {
+                name: 'Peter',
+                occupation: 'Delivery driver',
+            },
+            {
+                name: 'Otto',
+                occupation: 'Scientist',
+            },
+            {
+                name: 'Harry',
+                occupation: 'CEO',
+            },
+        ],
+    },
+    'array.unique': {
+        input: [1, 1, 2, 3],
+        remapper: {
+            'array.unique': null,
+        },
+        result: [1, 2, 3],
+    },
+    'assign.history': {
+        input: null,
+        remapper: {},
+        result: {},
+        skip: true,
+    },
+    context: {
+        input: null,
+        remapper: {},
+        result: {},
+        skip: true,
+    },
+    'date.add': {
+        input: '2023-06-30T14:50:19.601Z',
+        remapper: [
+            {
+                'date.now': null,
+            },
+            {
+                'date.add': '1w',
+            },
+            {
+                'date.format': null,
+            },
+        ],
+        result: '2023-07-07T14:50:19.601Z',
+        skip: true,
+    },
+    'date.format': {
+        input: '2023-07-03',
+        remapper: {
+            'date.format': null,
+        },
+        result: '2023-07-02T22:00:00.000Z',
+        skip: true,
+    },
+    'date.now': {
+        input: null,
+        remapper: {
+            'date.now': null,
+        },
+        result: 'Mon Jul 03 2023 11:47:18 GMT+0200 (Midden-Europese zomertijd)',
+        skip: true,
+    },
+    'date.parse': {
+        input: '02/11/2014',
+        remapper: {
+            'date.parse': 'MM/dd/yyyy',
+        },
+        result: 'Tue Feb 11 2014 00:00:00',
+        skip: true,
+    },
+    equals: {
+        input: { inputValue: 'example', expectedValue: 'example' },
+        remapper: {
+            equals: [{ prop: 'inputValue' }, { prop: 'expectedValue' }],
+        },
+        result: true,
+    },
+    'from.history': {
+        input: null,
+        remapper: {},
+        result: {},
+        skip: true,
+    },
+    gt: {
+        input: { stock: 100 },
+        remapper: { gt: [{ prop: 'stock' }, 5] },
+        result: true,
+    },
+    history: {
+        input: null,
+        remapper: {},
+        result: {},
+        skip: true,
+    },
+    ics: {
+        input: null,
+        remapper: {},
+        result: {},
+        skip: true,
+    },
+    'if.then': {
+        input: { guess: 4 },
+        remapper: {
+            if: {
+                condition: {
+                    equals: [
+                        {
+                            prop: 'guess',
+                        },
+                        4,
+                    ],
+                },
+                then: {
+                    static: 'You guessed right!',
+                },
+                else: {
+                    static: 'You guessed wrong!',
+                },
+            },
+        },
+        result: 'You guessed right!',
+    },
+    'if.else': {
+        input: { guess: 5 },
+        remapper: {
+            if: {
+                condition: {
+                    equals: [
+                        {
+                            prop: 'guess',
+                        },
+                        4,
+                    ],
+                },
+                then: {
+                    static: 'You guessed right!',
+                },
+                else: {
+                    static: 'You guessed wrong!',
+                },
+            },
+        },
+        result: 'You guessed wrong!',
+    },
+    log: {
+        input: null,
+        remapper: {},
+        result: {},
+        skip: true,
+    },
+    lt: {
+        input: { stock: 4 },
+        remapper: { lt: [{ prop: 'stock' }, 5] },
+        result: true,
+    },
+    match: {
+        input: { Gem: 'Ruby' },
+        remapper: {
+            match: [
+                {
+                    case: {
+                        equals: [
+                            {
+                                prop: 'Gem',
+                            },
+                            'Diamond',
+                        ],
+                    },
+                    value: 100,
+                },
+                {
+                    case: {
+                        equals: [
+                            {
+                                prop: 'Gem',
+                            },
+                            'Ruby',
+                        ],
+                    },
+                    value: 75,
+                },
+                {
+                    case: {
+                        equals: [
+                            {
+                                prop: 'Gem',
+                            },
+                            'Gold',
+                        ],
+                    },
+                    value: 50,
+                },
+                {
+                    case: {
+                        equals: [
+                            {
+                                prop: 'Gem',
+                            },
+                            'Sapphire',
+                        ],
+                    },
+                    value: 25,
+                    result: {},
+                },
+            ],
+        },
+        result: 75,
+    },
+    not: {
+        input: { number: 3 },
+        remapper: { not: [{ prop: 'number' }, 4] },
+        result: true,
+    },
+    'null.strip': {
+        input: null,
+        remapper: {},
+        result: {},
+        skip: true,
+    },
+    'object.assign': {
+        input: {
+            title: 'Weekly fishing 21',
+        },
+        remapper: {
+            'object.assign': {
+                author: 'John Doe',
+            },
+        },
+        result: {
+            author: 'John Doe',
+            title: 'Weekly fishing 21',
+        },
+    },
+    'object.from': {
+        input: null,
+        remapper: {
+            'object.from': {
+                email: 'example@hotmail.com',
+                username: 'Chris Taub',
+            },
+        },
+        result: {
+            email: 'example@hotmail.com',
+            username: 'Chris Taub',
+        },
+    },
+    'object.omit': {
+        input: {
+            author: 'John Doe',
+            content: {
+                interview: '...',
+                introduction: 'This is the introduction for the new weekly fishing issue',
+                paragraph1: '...',
+            },
+            title: 'Weekly fishing 21',
+        },
+        remapper: {
+            'object.omit': ['author', ['content', 'interview']],
+        },
+        result: {
+            content: {
+                introduction: 'This is the introduction for the new weekly fishing issue',
+                paragraph1: '...',
+            },
+            title: 'Weekly fishing 21',
+        },
+    },
+    'omit.history': {
+        input: null,
+        remapper: {},
+        result: {},
+        skip: true,
+    },
+    page: {
+        input: null,
+        remapper: {},
+        result: {},
+        skip: true,
+    },
+    prop: {
+        input: {
+            age: 52,
+            name: 'John',
+        },
+        remapper: {
+            prop: 'name',
+        },
+        result: 'John',
+    },
+    'random.choice': {
+        input: null,
+        remapper: {},
+        result: {},
+        skip: true,
+    },
+    'random.float': {
+        input: null,
+        remapper: {},
+        result: {},
+        skip: true,
+    },
+    'random.integer': {
+        input: null,
+        remapper: {},
+        result: {},
+        skip: true,
+    },
+    'random.string': {
+        input: null,
+        remapper: {},
+        result: {},
+        skip: true,
+    },
+    root: {
+        input: 'input',
+        remapper: { root: null },
+        result: 'input',
+    },
+    static: {
+        input: null,
+        remapper: {
+            static: 'Hello!',
+        },
+        result: 'Hello!',
+    },
+    step: {
+        input: null,
+        remapper: {},
+        result: {},
+        skip: true,
+    },
+    'string.case': {
+        input: 'Patrick',
+        remapper: {
+            'string.case': 'upper',
+        },
+        result: 'PATRICK',
+    },
+    'string.format': {
+        input: {
+            lotteryPrize: '5000',
+        },
+        remapper: {
+            'string.format': {
+                template: 'You have won €{lotteryAmount} in the lottery!!',
+                values: {
+                    lotteryAmount: {
+                        prop: 'lotteryPrize',
+                    },
+                },
+            },
+        },
+        result: 'You have won €5000 in the lottery!!',
+    },
+    'string.replace': {
+        input: 'Eindhoven is the best city in the Netherlands',
+        remapper: {
+            'string.replace': {
+                '(best*)\\w+': 'cleanest',
+            },
+        },
+        result: 'Eindhoven is the cleanest city in the Netherlands',
+    },
+    translate: {
+        input: null,
+        remapper: {},
+        result: {},
+        skip: true,
+    },
+    user: {
+        input: null,
+        remapper: {},
+        result: {},
+        skip: true,
+    },
+};
+/**
+ * @param remapper The remapper example to use.
+ * @param options The options specifying how to display the example.
+ * @returns Example based on the input options.
+ */
+export function schemaExample(remapper, options) {
+    const { exclude = [], input = 'inline', result } = options !== null && options !== void 0 ? options : {};
+    let example = '';
+    if (!exclude.includes('input')) {
+        const spacing = input === 'pretty' && 2;
+        example += `Input:\n\n\`\`\`json\n${JSON.stringify(examples[remapper].input, null, spacing)}\n\`\`\`\n`;
+    }
+    if (!exclude.includes('remapper')) {
+        example += `\`\`\`yaml\n${stringify(examples[remapper].remapper)}\n\`\`\`\n`;
+    }
+    if (!exclude.includes('result')) {
+        const spacing = result === 'pretty' && 2;
+        example += `Result:\n\n\`\`\`json\n${JSON.stringify(examples[remapper].result, null, spacing)}\n\`\`\`\n`;
+    }
+    return example;
+}
+export function createExampleContext(url, lang, userInfo, history) {
+    return {
+        getMessage: ({ defaultMessage }) => new IntlMessageFormat(defaultMessage, lang, undefined),
+        url: String(url),
+        appUrl: `${url.protocol}//example-app.example-organization.${url.host}`,
+        userInfo: userInfo !== null && userInfo !== void 0 ? userInfo : {
+            sub: 'default-example-sub',
+            name: 'default-example-name',
+            email: 'default@example.com',
+            email_verified: false,
+        },
+        context: {},
+        history: history !== null && history !== void 0 ? history : ['Default example value'],
+        appId: 0,
+        locale: 'en',
+        pageData: { default: 'Page data' },
+        appMember: userInfo === null || userInfo === void 0 ? void 0 : userInfo.appMember,
+    };
+}
+//# sourceMappingURL=examples.js.map

package/index.d.ts

@@ -23,6 +23,7 @@ export * from './string.js';
 export * from './theme.js';
 export * from './langmap.js';
 export * from './i18n.js';
+export * from './examples.js';
 export * from './serverActions.js';
 export * from './validation.js';
 export * from './convertToCsv.js';

package/index.js

@@ -23,6 +23,7 @@ export * from './string.js';
 export * from './theme.js';
 export * from './langmap.js';
 export * from './i18n.js';
+export * from './examples.js';
 export * from './serverActions.js';
 export * from './validation.js';
 export * from './convertToCsv.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appsemble/utils",
-  "version": "0.25.2",
+  "version": "0.26.0",
   "description": "Utility functions used in Appsemble internally",
   "keywords": [
     "app",
@@ -37,7 +37,7 @@
     "test": "vitest"
   },
   "dependencies": {
-    "@appsemble/types": "0.25.2",
+    "@appsemble/types": "0.26.0",
     "axios": "^1.0.0",
     "cron-parser": "^4.0.0",
     "date-fns": "^2.0.0",
@@ -51,6 +51,7 @@
     "openapi-types": "^12.0.0",
     "parse-duration": "^1.0.0",
     "postcss": "^8.0.0",
+    "yaml": "^2.0.0",
     "type-fest": "^4.0.0"
   },
   "devDependencies": {
@@ -59,8 +60,7 @@
     "@types/lcm": "^0.0.2",
     "bulma": "0.9.3",
     "koas-core": "^0.7.0",
-    "vitest": "^1.0.0",
-    "yaml": "^2.0.0"
+    "vitest": "^1.0.0"
   },
   "engines": {
     "node": ">=18"