@limetech/lime-web-components 4.48.2 → 4.49.1-alpha.4

package/dist/testing/limetypes/todo.js

@@ -0,0 +1,426 @@
+import { getBackreference, getLimetype, getProperty } from '.';
+export const todo = {
+    name: 'todo',
+    localname: {
+        singular: 'To-do',
+        plural: "To-do's",
+    },
+    sort_order: 6,
+    label: 'todo',
+    getProperty: (property) => getProperty('todo', property),
+    properties: {
+        subject: {
+            name: 'subject',
+            required: false,
+            label: 'description',
+            fieldorder: 1,
+            defaultvalue: '',
+            localname: 'Subject',
+            type: 'string',
+            has_sql: false,
+            length: 128,
+            options: [
+                {
+                    key: 'followupquote',
+                    text: 'Follow up quote',
+                    inactive: false,
+                },
+                {
+                    key: 'customervisit',
+                    text: 'Customer visit',
+                    inactive: false,
+                },
+                {
+                    key: 'call',
+                    text: 'Call',
+                    inactive: false,
+                },
+                {
+                    key: 'salescall',
+                    text: 'Sales call',
+                    inactive: false,
+                },
+            ],
+            acl: {
+                read: true,
+                update: true,
+                create: true,
+                delete: true,
+            },
+            ui: {},
+        },
+        starttime: {
+            name: 'starttime',
+            required: true,
+            label: 'startdate',
+            fieldorder: 4,
+            defaultvalue: '2020-04-07T12:13:49.985289+02:00',
+            localname: 'Start time',
+            type: 'time',
+            has_sql: false,
+            acl: {
+                read: true,
+                update: true,
+                create: true,
+                delete: true,
+            },
+            ui: {},
+        },
+        endtime: {
+            name: 'endtime',
+            required: false,
+            label: 'duedate',
+            fieldorder: 5,
+            defaultvalue: null,
+            localname: 'End time',
+            type: 'time',
+            has_sql: false,
+            acl: {
+                read: true,
+                update: true,
+                create: true,
+                delete: true,
+            },
+            ui: {},
+        },
+        done: {
+            name: 'done',
+            required: false,
+            label: 'completed',
+            fieldorder: 6,
+            defaultvalue: false,
+            localname: 'Done',
+            type: 'yesno',
+            has_sql: false,
+            acl: {
+                read: true,
+                update: true,
+                create: true,
+                delete: true,
+            },
+            ui: {},
+        },
+        note: {
+            name: 'note',
+            required: false,
+            label: 'notes',
+            fieldorder: 8,
+            defaultvalue: '',
+            localname: 'Notes',
+            type: 'text',
+            has_sql: false,
+            length: 1024,
+            acl: {
+                read: true,
+                update: true,
+                create: true,
+                delete: true,
+            },
+            ui: {},
+        },
+        coworker: {
+            name: 'coworker',
+            required: false,
+            label: 'responsiblecoworker',
+            fieldorder: 3,
+            defaultvalue: null,
+            localname: 'Coworker',
+            type: 'belongsto',
+            has_sql: false,
+            relation: {
+                getBackreference: () => getBackreference('coworker', 'todo'),
+                getLimetype: () => getLimetype('coworker'),
+            },
+            acl: {
+                read: true,
+                update: true,
+                create: true,
+                delete: true,
+            },
+            ui: {},
+        },
+        company: {
+            name: 'company',
+            required: false,
+            label: 'none',
+            fieldorder: 9,
+            defaultvalue: null,
+            localname: 'Company',
+            type: 'belongsto',
+            has_sql: false,
+            relation: {
+                getBackreference: () => getBackreference('company', 'todo'),
+                getLimetype: () => getLimetype('company'),
+            },
+            acl: {
+                read: true,
+                update: true,
+                create: true,
+                delete: true,
+            },
+            ui: {},
+        },
+        campaign: {
+            name: 'campaign',
+            required: false,
+            label: 'none',
+            fieldorder: 12,
+            defaultvalue: null,
+            localname: 'Marketing activity',
+            type: 'belongsto',
+            has_sql: false,
+            relation: {
+                getBackreference: () => getBackreference('campaign', 'todo'),
+                getLimetype: () => getLimetype('campaign'),
+            },
+            acl: {
+                read: true,
+                update: true,
+                create: true,
+                delete: true,
+            },
+            ui: {},
+        },
+        helpdesk: {
+            name: 'helpdesk',
+            required: false,
+            label: 'none',
+            fieldorder: 11,
+            defaultvalue: null,
+            localname: 'Helpdesk',
+            type: 'belongsto',
+            has_sql: false,
+            relation: {
+                getBackreference: () => getBackreference('helpdesk', 'todo'),
+                getLimetype: () => getLimetype('helpdesk'),
+            },
+            acl: {
+                read: true,
+                update: true,
+                create: true,
+                delete: true,
+            },
+            ui: {},
+        },
+        person: {
+            name: 'person',
+            required: false,
+            label: 'name',
+            fieldorder: 2,
+            defaultvalue: null,
+            localname: 'Person',
+            type: 'belongsto',
+            has_sql: false,
+            relation: {
+                getBackreference: () => getBackreference('person', 'todo'),
+                getLimetype: () => getLimetype('person'),
+            },
+            acl: {
+                read: true,
+                update: true,
+                create: true,
+                delete: true,
+            },
+            ui: {},
+        },
+        deal: {
+            name: 'deal',
+            required: false,
+            label: 'none',
+            fieldorder: 10,
+            defaultvalue: null,
+            localname: 'Deal',
+            type: 'belongsto',
+            has_sql: false,
+            relation: {
+                getBackreference: () => getBackreference('deal', 'todo'),
+                getLimetype: () => getLimetype('deal'),
+            },
+            acl: {
+                read: true,
+                update: true,
+                create: true,
+                delete: true,
+            },
+            ui: {},
+        },
+        history: {
+            name: 'history',
+            required: false,
+            label: 'none',
+            fieldorder: 14,
+            defaultvalue: '',
+            localname: 'Company history',
+            type: 'hasandbelongstomany',
+            has_sql: true,
+            relation: {
+                getBackreference: () => getBackreference('history', 'todo'),
+                getLimetype: () => getLimetype('history'),
+            },
+            acl: {
+                read: true,
+                update: true,
+                create: true,
+                delete: true,
+            },
+            ui: {},
+        },
+        todostatus: {
+            name: 'todostatus',
+            required: false,
+            label: 'none',
+            fieldorder: 7,
+            defaultvalue: {
+                key: 'empty',
+                text: '',
+                inactive: false,
+            },
+            localname: 'To-do status',
+            type: 'option',
+            has_sql: true,
+            options: [
+                {
+                    key: 'empty',
+                    text: '',
+                    inactive: false,
+                },
+                {
+                    key: 'delayed',
+                    text: 'Delayed',
+                    inactive: false,
+                },
+                {
+                    key: 'done',
+                    text: 'Done',
+                    inactive: false,
+                },
+                {
+                    key: 'future',
+                    text: 'Future',
+                    inactive: false,
+                },
+                {
+                    key: 'active',
+                    text: 'Just do it!',
+                    inactive: false,
+                },
+            ],
+            acl: {
+                read: true,
+                update: true,
+                create: true,
+                delete: true,
+            },
+            ui: {},
+        },
+        deal2: {
+            name: 'deal2',
+            required: false,
+            label: 'none',
+            fieldorder: 15,
+            defaultvalue: '',
+            localname: 'Deals (HIDDEN)',
+            type: 'hasmany',
+            has_sql: true,
+            relation: {
+                getBackreference: () => getBackreference('deal', 'todo2'),
+                getLimetype: () => getLimetype('deal'),
+            },
+            acl: {
+                read: true,
+                update: true,
+                create: true,
+                delete: true,
+            },
+            ui: {},
+        },
+        successplan: {
+            name: 'successplan',
+            required: false,
+            label: 'none',
+            fieldorder: 13,
+            defaultvalue: null,
+            localname: 'Success plan',
+            type: 'belongsto',
+            has_sql: false,
+            relation: {
+                getBackreference: () => getBackreference('successplan', 'todo'),
+                getLimetype: () => getLimetype('successplan'),
+            },
+            acl: {
+                read: true,
+                update: true,
+                create: true,
+                delete: true,
+            },
+            ui: {},
+        },
+        id: {
+            acl: {},
+            defaultvalue: null,
+            fieldorder: 1,
+            label: 'id',
+            localname: 'Record ID (System)',
+            name: 'id',
+            required: false,
+            type: 'system',
+            ui: {},
+        },
+        createduser: {
+            acl: {},
+            defaultvalue: null,
+            fieldorder: 1,
+            label: 'createduser',
+            localname: 'Created by (System)',
+            name: 'createduser',
+            required: false,
+            type: 'system',
+            ui: {},
+        },
+        createdtime: {
+            acl: {},
+            defaultvalue: null,
+            fieldorder: 1,
+            label: 'createdtime',
+            localname: 'Created (System)',
+            name: 'createdtime',
+            required: false,
+            type: 'system',
+            ui: {},
+        },
+        timestamp: {
+            acl: {},
+            defaultvalue: null,
+            fieldorder: 1,
+            label: 'timestamp',
+            localname: 'Last updated (System)',
+            name: 'timestamp',
+            required: false,
+            type: 'system',
+            ui: {},
+        },
+        updateduser: {
+            acl: {},
+            defaultvalue: null,
+            fieldorder: 1,
+            label: 'updateduser',
+            localname: 'Last updated by (System)',
+            name: 'updateduser',
+            required: false,
+            type: 'system',
+            ui: {},
+        },
+    },
+    acl: {
+        read: true,
+        update: true,
+        create: true,
+        delete: true,
+    },
+    ui: {
+        icon: 'todo_list',
+        color: 'lime-turquoise',
+        create: false,
+        descriptive: ['subject'],
+    },
+};

package/dist/testing/platform/index.d.ts

@@ -0,0 +1,8 @@
+import { LimeWebComponentContext, LimeWebComponentPlatform } from '../..';
+/**
+ * Create a new platform suitable for testing
+ *
+ * @returns {LimeWebComponentPlatform} a new testing platform
+ */
+export declare function createPlatform(): LimeWebComponentPlatform;
+export declare const defaultContext: LimeWebComponentContext;

package/dist/testing/platform/index.js

@@ -0,0 +1,61 @@
+/**
+ * A platform suitable for testing
+ */
+class TestingPlatform {
+    constructor() {
+        this.services = {};
+    }
+    get(name) {
+        if (!(name in this.services)) {
+            this.register(name, createDefaultService());
+        }
+        return this.services[name];
+    }
+    has(name) {
+        return true;
+    }
+    register(name, service) {
+        this.services[name] = createServiceProxy(service);
+    }
+}
+/**
+ * Create a new platform suitable for testing
+ *
+ * @returns {LimeWebComponentPlatform} a new testing platform
+ */
+export function createPlatform() {
+    return new TestingPlatform();
+}
+export const defaultContext = {
+    limetype: null,
+    id: null,
+};
+/**
+ * Create a proxy for a service
+ *
+ * Each method that is not implemented in the service will default to return
+ * the arguments it was called with
+ *
+ * @param {any} service the service to proxy
+ * @returns {Proxy} a proxy for the service
+ */
+function createServiceProxy(service) {
+    const handler = {
+        get: (target, prop, receiver) => {
+            let value = Reflect.get(target, prop, receiver);
+            if (value) {
+                if (typeof value === 'function') {
+                    value = value.bind(target);
+                }
+                return value;
+            }
+            return (...args) => {
+                return args;
+            };
+        },
+    };
+    return new Proxy(service, handler);
+}
+function createDefaultService() {
+    return {};
+}

package/dist/testing/platform/platform.spec.d.ts

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

package/dist/testing/platform/platform.spec.js

@@ -0,0 +1,41 @@
+import { createPlatform } from '.';
+describe('createPlatform', () => {
+    let platform;
+    beforeEach(() => {
+        platform = createPlatform();
+    });
+    it('creates a platform', () => {
+        expect(platform).toBeTruthy();
+    });
+    describe('when registering a service', () => {
+        class MyService {
+            constructor() {
+                this.myData = 'foo';
+            }
+            getData() {
+                return this.myData;
+            }
+        }
+        beforeEach(() => {
+            platform.register('service', new MyService());
+        });
+        it('the service works as expected', () => {
+            const service = platform.get('service');
+            expect(service.getData()).toEqual('foo');
+        });
+        it('unknown methods returns the arguments', () => {
+            const service = platform.get('service');
+            expect(service.unknownMethod('bar')).toEqual(['bar']);
+        });
+    });
+    describe('when registering a Map', () => {
+        beforeEach(() => {
+            const map = new Map();
+            platform.register('map', map);
+        });
+        it('does not throw errors when using the map methods', () => {
+            const service = platform.get('map');
+            expect(() => service.has('foo')).not.toThrow();
+        });
+    });
+});

package/dist/translator/index.d.ts

@@ -0,0 +1,2 @@
+export * from './translator';
+export * from './types';

package/dist/translator/index.js

@@ -0,0 +1,2 @@
+export * from './translator';
+export * from './types';

package/dist/translator/translator.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Service for translating strings into different languages
+ */
+export interface Translator {
+    /**
+     * Get a translated string by ID
+     *
+     * @param {string} id id of the translation
+     * @param {object} params any parameters that the translation might require
+     * @returns {string} the translation
+     */
+    get(id: string, params?: Record<string, string | number | undefined>): string;
+}

package/dist/translator/translator.js

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

package/dist/translator/types.d.ts

@@ -0,0 +1,14 @@
+import { Translator } from './translator';
+declare const SERVICE_NAME = "translate";
+declare module '../core/platform' {
+    interface PlatformServiceName {
+        /**
+         * @see {@link Translate}
+         */
+        Translate: typeof SERVICE_NAME;
+    }
+    interface LimeWebComponentPlatform {
+        get(name: PlatformServiceName['Translate']): Translator;
+    }
+}
+export {};

package/dist/translator/types.js

@@ -0,0 +1,3 @@
+import { PlatformServiceName } from '../core/platform';
+const SERVICE_NAME = 'translate';
+PlatformServiceName.Translate = SERVICE_NAME;

package/dist/userdata/decorator.d.ts

@@ -0,0 +1,17 @@
+import { StateOptions } from '../core';
+/**
+ * Config for the {@link SelectUserData} state decorator
+ */
+export interface SelectUserDataOptions extends StateOptions {
+    /**
+     * Key specifying the user data
+     */
+    key?: string;
+}
+/**
+ * Gets an object with all user data, optionally filtered by key
+ *
+ * @param {SelectUserDataOptions} options state decorator options
+ * @returns {PropertyDecorator} state decorator
+ */
+export declare function SelectUserData(options?: SelectUserDataOptions): PropertyDecorator;

package/dist/userdata/decorator.js

@@ -0,0 +1,14 @@
+import { PlatformServiceName, } from '../core';
+import { createStateDecorator } from '../core/decorators/factory';
+/**
+ * Gets an object with all user data, optionally filtered by key
+ *
+ * @param {SelectUserDataOptions} options state decorator options
+ * @returns {PropertyDecorator} state decorator
+ */
+export function SelectUserData(options = {}) {
+    const config = {
+        name: PlatformServiceName.UserData,
+    };
+    return createStateDecorator(options, config);
+}

package/dist/userdata/index.d.ts

@@ -0,0 +1,3 @@
+export * from './repository';
+export * from './types';
+export * from './decorator';

package/dist/userdata/index.js

@@ -0,0 +1,3 @@
+export * from './repository';
+export * from './types';
+export * from './decorator';

package/dist/userdata/repository.d.ts

@@ -0,0 +1,29 @@
+import { StateRepository } from '../core';
+/**
+ * Handle fetching and saving user specific data, e.g. settings or other state
+ * data that should persist between sessions
+ *
+ */
+export interface UserDataRepository extends StateRepository {
+    /**
+     * Check if user data exists
+     *
+     * @param key name of the key containing the data
+     * @returns true if user data exists
+     */
+    has(key: string): boolean;
+    /**
+     * Get user data
+     *
+     * @param key name of the key containing the data
+     * @returns the data
+     */
+    get<T = any>(key: string): T;
+    /**
+     * Set user data
+     *
+     * @param key name of the key for the data
+     * @param data the data to save, will delete the data if undefined
+     */
+    set<T = any>(key: string, data?: T): void;
+}

package/dist/userdata/repository.js

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

package/dist/userdata/types.d.ts

@@ -0,0 +1,14 @@
+import { UserDataRepository } from './repository';
+declare const SERVICE_NAME = "state.user-data";
+declare module '../core/platform' {
+    interface PlatformServiceName {
+        /**
+         * @see {@link UserDataRepository}
+         */
+        UserData: typeof SERVICE_NAME;
+    }
+    interface LimeWebComponentPlatform {
+        get(name: PlatformServiceName['UserData']): UserDataRepository;
+    }
+}
+export {};

package/dist/userdata/types.js

@@ -0,0 +1,3 @@
+import { PlatformServiceName } from '../core/platform';
+const SERVICE_NAME = 'state.user-data';
+PlatformServiceName.UserData = SERVICE_NAME;