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

package/dist/es5/translator/translator.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/es5/translator/types.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var platform_1 = require("../core/platform");
+var SERVICE_NAME = 'translate';
+platform_1.PlatformServiceName.Translate = SERVICE_NAME;

package/dist/es5/userdata/decorator.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SelectUserData = void 0;
+var core_1 = require("../core");
+var factory_1 = require("../core/decorators/factory");
+function SelectUserData(options) {
+    if (options === void 0) { options = {}; }
+    var config = {
+        name: core_1.PlatformServiceName.UserData,
+    };
+    return (0, factory_1.createStateDecorator)(options, config);
+}
+exports.SelectUserData = SelectUserData;

package/dist/es5/userdata/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./repository"), exports);
+tslib_1.__exportStar(require("./types"), exports);
+tslib_1.__exportStar(require("./decorator"), exports);

package/dist/es5/userdata/repository.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/es5/userdata/types.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var platform_1 = require("../core/platform");
+var SERVICE_NAME = 'state.user-data';
+platform_1.PlatformServiceName.UserData = SERVICE_NAME;

package/dist/eventdispatcher/eventdispatcher.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Service for handling application level events
+ */
+export interface EventDispatcher {
+    /**
+     * Dispatch a new event
+     *
+     * @param {string} eventName name of the event to dispatch
+     * @param {T} data data attached to the event
+     */
+    dispatch<T>(eventName: string, data: T): CustomEvent<T>;
+    /**
+     * Add a new listener for a specific event
+     *
+     * @param {string} eventName name of the event to listen to
+     * @param {Function} listener listener to invoke when the event is dispatched
+     */
+    addListener<T>(eventName: string, listener: (event: CustomEvent<T>) => void): void;
+    /**
+     * Stop listening for a specific event
+     *
+     * @param {string} eventName name of the event to stop listening to
+     * @param {Function} listener listener to remove from the dispatcher
+     */
+    removeListener<T>(eventName: string, listener: (event: CustomEvent<T>) => void): void;
+}

package/dist/eventdispatcher/eventdispatcher.js

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

package/dist/eventdispatcher/index.d.ts

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

package/dist/eventdispatcher/index.js

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

package/dist/eventdispatcher/types.d.ts

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

package/dist/eventdispatcher/types.js

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

package/dist/filter/decorator.d.ts

@@ -0,0 +1,15 @@
+import { StateOptions } from '../core';
+/**
+ * Config for the {@link SelectFilters} state decorator
+ */
+export interface SelectFiltersOptions extends StateOptions {
+    id?: string;
+    limetype?: string;
+}
+/**
+ * Gets a list of filters
+ *
+ * @param {StateOptions} [options] state decorator options
+ * @returns {Function} state decorator
+ */
+export declare function SelectFilters(options?: SelectFiltersOptions): PropertyDecorator;

package/dist/filter/decorator.js

@@ -0,0 +1,14 @@
+import { PlatformServiceName, } from '../core';
+import { createStateDecorator } from '../core/decorators/factory';
+/**
+ * Gets a list of filters
+ *
+ * @param {StateOptions} [options] state decorator options
+ * @returns {Function} state decorator
+ */
+export function SelectFilters(options = {}) {
+    const config = {
+        name: PlatformServiceName.FilterRepository,
+    };
+    return createStateDecorator(options, config);
+}

package/dist/filter/index.d.ts

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

package/dist/filter/index.js

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

package/dist/filter/repository.d.ts

@@ -0,0 +1,18 @@
+import { Filter } from '../query';
+import { StateRepository } from '../core';
+export interface FilterRepository extends StateRepository {
+    /**
+     * Saves the new filter to the database
+     *
+     * @param filter a filter to save
+     * @returns {Promise<void>} a promise that will be resolved when the filter is saved
+     */
+    save(filter: Filter): Promise<void>;
+    /**
+     * Deletes the filter
+     *
+     * @param id a filter id to delete
+     * @returns {Promise<void>} a promise that will be resolved when the filter is deleted
+     */
+    delete?(filter: Filter): Promise<void>;
+}

package/dist/filter/repository.js

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

package/dist/filter/types.d.ts

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

package/dist/filter/types.js

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

package/dist/http/http.d.ts

@@ -0,0 +1,72 @@
+/**
+ * HTTP service for sending requests to a given URL
+ *
+ * By default, the service will work with the JSON data format. If anything but JSON is returned from the endpoint,
+ * the `responseType` property in the `options` parameter needs to be set.
+ */
+export interface HttpClient {
+    /**
+     * Sends a get request.
+     *
+     * @param {string} url - Url to resource (for instance my_addon/endpoint).
+     * @param {object} options - The HTTP options to send with the request.
+     * @returns {Promise}
+     */
+    get(url: string, options?: HttpOptions): Promise<any>;
+    /**
+     * Sends a post request.
+     *
+     * @param {string} url - Url to resource (for instance my_addon/endpoint).
+     * @param {object} data - Payload to send to the server.
+     * @param {object} options - The HTTP options to send with the request.
+     * @returns {Promise}
+     */
+    post(url: string, data?: {}, options?: HttpOptions): Promise<any>;
+    /**
+     * Sends a patch request.
+     *
+     * @param {string} url - Url to resource (for instance my_addon/endpoint).
+     * @param {object} data - Payload to send to the server.
+     * @param {object} options - The HTTP options to send with the request.
+     * @returns {Promise}
+     */
+    patch(url: string, data?: {}, options?: HttpOptions): Promise<any>;
+    /**
+     * Sends a put request.
+     *
+     * @param {string} url - Url to resource (for instance my_addon/endpoint).
+     * @param {object} data - Payload to send to the server.
+     * @param {object} options - The HTTP options to send with the request.
+     * @returns {Promise}
+     */
+    put(url: string, data?: {}, options?: HttpOptions): Promise<any>;
+    /**
+     * Sends a delete request.
+     *
+     * @param {string} url - Url to resource (for instance my_addon/endpoint).
+     * @param {object} options - The HTTP options to send with the request.
+     * @returns {Promise}
+     */
+    delete(url: string, options?: HttpOptions): Promise<any>;
+}
+export interface HttpOptions {
+    /**
+     * Query parameters to include in the request
+     */
+    params?: HttpParams;
+    /**
+     * Additional HTTP-headers to send in the request
+     */
+    headers?: HttpHeaders;
+    /**
+     * Type of the response that is returned. Defaults to `json`
+     */
+    responseType?: HttpResponseType;
+}
+export interface HttpParams {
+    [param: string]: string | string[];
+}
+export interface HttpHeaders {
+    [header: string]: string | string[];
+}
+export declare type HttpResponseType = 'text' | 'json' | 'arraybuffer' | 'blob';

package/dist/http/http.js

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

package/dist/http/index.d.ts

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

package/dist/http/index.js

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

package/dist/http/types.d.ts

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

package/dist/http/types.js

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

package/dist/index.d.ts

@@ -0,0 +1,19 @@
+export * from './core';
+export * from './limetype';
+export * from './limeobject';
+export * from './query';
+export * from './http';
+export * from './commandbus';
+export * from './eventdispatcher';
+export * from './translator';
+export * from './dialog';
+export * from './keybindings';
+export * from './navigator';
+export * from './notifications';
+export * from './routeregistry';
+export * from './task';
+export * from './config';
+export * from './device';
+export * from './filter';
+export * from './userdata';
+export * from './application';

package/dist/index.js

@@ -0,0 +1,19 @@
+export * from './core';
+export * from './limetype';
+export * from './limeobject';
+export * from './query';
+export * from './http';
+export * from './commandbus';
+export * from './eventdispatcher';
+export * from './translator';
+export * from './dialog';
+export * from './keybindings';
+export * from './navigator';
+export * from './notifications';
+export * from './routeregistry';
+export * from './task';
+export * from './config';
+export * from './device';
+export * from './filter';
+export * from './userdata';
+export * from './application';

package/dist/keybindings/index.d.ts

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

package/dist/keybindings/index.js

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

package/dist/keybindings/registry.d.ts

@@ -0,0 +1,79 @@
+/**
+ * Service for binding keyboard shortcuts to execute commands
+ *
+ * A keybinding is a sequence or key combination on a computer keyboard which
+ * invokes commands. This service supports key bindings as a way of responding
+ * to individual keys typed by a user. The key combination can be pressing a single
+ * key or a sequence of keys one after the other.
+ *
+ * The service works together with the `CommandBus` to execute the commands and
+ * a command needs to already be registered on the command bus in order to be
+ * bound as a keyboard shortcut.
+ *
+ * The following example registers the command `MyCommand` to be handled by
+ * `MyHandler` and creates a keybinding for it. The `bind` method takes the key
+ * combination and command object as input.
+ *
+ * Later, if the keybinding no longer is needed it can be removed with the
+ * `unbind` method.
+ *
+ * @example
+ * // The command bus needs to have a handler registered for the command
+ * // before it can be bound to a key sequence
+ * const handler = new MyHandler();
+ * commandBus.register(MyCommand, handler);
+ *
+ * // Bind 'ctrl+s' to trigger the command
+ * const command = new MyCommand();
+ * keybindingRegistry.bind('ctrl+s', command);
+ *
+ * // Remove the binding when we no longer need it to trigger the command
+ * keybindingRegistry.unbind('ctrl+s')
+ * @note This service is work in progress
+ * @private
+ */
+export interface KeybindingRegistry {
+    /**
+     * Bind a command to a specific key combination to add it to the registry
+     *
+     * @param {string} keys the string representation of keys
+     * @param {Object} command the command to trigger when keys are pressed
+     * @throws Will throw an error if the command is invalid or not registered
+     */
+    bind: (keys: string, command: object) => void;
+    /**
+     * Unbind a keybinding to remove it from the registry
+     *
+     * @param {string} keys the string representation of the key combination
+     * @param {Object} command the command connected to the key combination
+     */
+    unbind: (keys: string, command: object) => void;
+    /**
+     * Get a list of the key bindings that are currently in the registry
+     *
+     * @returns {Keybinding[]} the list of command and its specific key combination
+     */
+    getKeybindings: () => Keybinding[];
+    /**
+     * Checks if a key combination or a specific keybinding is already bound
+     *
+     * @param {string} keys the string representation of a key combination
+     * @param {Object} command the command connected to the key combination
+     * @returns {boolean} true if key combination already exists, else false
+     */
+    isBound: (keys: string, command?: object) => boolean;
+}
+/**
+ * A key combination and its corresponding command that will be triggered when
+ * the key combination is pressed
+ */
+export interface Keybinding {
+    /**
+     * The string representation of key combination
+     */
+    keys: string;
+    /**
+     * The command to trigger when the key combination is pressed
+     */
+    command: object;
+}

package/dist/keybindings/registry.js

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

package/dist/keybindings/types.d.ts

@@ -0,0 +1,17 @@
+import { KeybindingRegistry as Service } from './registry';
+declare const SERVICE_NAME = "keybindingRegistry";
+declare module '../core/platform' {
+    interface PlatformServiceName {
+        /**
+         * @see {@link Service KeybindingRegistry}
+         *
+         * @note Work in progress, do not use!
+         * @private
+         */
+        KeybindingRegistry: typeof SERVICE_NAME;
+    }
+    interface LimeWebComponentPlatform {
+        get(name: PlatformServiceName['KeybindingRegistry']): Service;
+    }
+}
+export {};

package/dist/keybindings/types.js

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

package/dist/limeobject/commands/bulk-create-dialog.d.ts

@@ -0,0 +1,49 @@
+import { Expression } from '../../query';
+import { LimeType } from '../../limetype';
+/**
+ * Open a dialog for bulk creating limeobjects
+ *
+ *
+ * ### Flow example
+ * Let's have a look at the general flow by going through the concrete example of adding several persons to a marketing activity:
+ * - Go to the table view of persons.
+ * - Filter everyone who should be included in the marketing activity.
+ * - Select 'Bulk create objects' form the action menu.
+ * - Select marketing activity as type of content.
+ * - Fill out the rest of the form and click 'create'.
+ * - A toast message appears and gives you 5 seconds to undo the action before it creates the corresponding task.
+ * - Another toast message will inform you after the task is completed.
+ * - If the task ended successful you can go to the participant table view and check the result.
+ *
+ * ### Configuration
+ * In order to activate the feature go to a table configuration in lime-admin to the limetype you want to bulk create from
+ * and add the following configuration:
+ *
+ * ```json
+ * "actions": [
+ * {
+ *      "id": "limeobject.bulk-create-dialog",
+ *      "params": {
+ *        "relations": [<LIST OF CREATABLE, RELATED FIELDS (AS STRINGS)>]
+ *      }
+ *    }
+ * ],
+ * ```
+ *
+ * @id `limeobject.bulk-create-dialog`
+ */
+export declare class BulkCreateDialogCommand {
+    /**
+     * The limetype of the objects to create new objects from
+     */
+    limetype: LimeType;
+    /**
+     * A query describing what limeobjects to create new limeobjects from. Each object from the result will result in a
+     * new related limeobject to be created
+     */
+    filter: Expression;
+    /**
+     * A list of relation names that are possible to create from the limetype
+     */
+    relations: string[];
+}

package/dist/limeobject/commands/bulk-create-dialog.js

@@ -0,0 +1,48 @@
+import { __decorate } from "tslib";
+import { Command } from '../../commandbus';
+/**
+ * Open a dialog for bulk creating limeobjects
+ *
+ *
+ * ### Flow example
+ * Let's have a look at the general flow by going through the concrete example of adding several persons to a marketing activity:
+ * - Go to the table view of persons.
+ * - Filter everyone who should be included in the marketing activity.
+ * - Select 'Bulk create objects' form the action menu.
+ * - Select marketing activity as type of content.
+ * - Fill out the rest of the form and click 'create'.
+ * - A toast message appears and gives you 5 seconds to undo the action before it creates the corresponding task.
+ * - Another toast message will inform you after the task is completed.
+ * - If the task ended successful you can go to the participant table view and check the result.
+ *
+ * ### Configuration
+ * In order to activate the feature go to a table configuration in lime-admin to the limetype you want to bulk create from
+ * and add the following configuration:
+ *
+ * ```json
+ * "actions": [
+ * {
+ *      "id": "limeobject.bulk-create-dialog",
+ *      "params": {
+ *        "relations": [<LIST OF CREATABLE, RELATED FIELDS (AS STRINGS)>]
+ *      }
+ *    }
+ * ],
+ * ```
+ *
+ * @id `limeobject.bulk-create-dialog`
+ */
+let BulkCreateDialogCommand = class BulkCreateDialogCommand {
+    constructor() {
+        /**
+         * A list of relation names that are possible to create from the limetype
+         */
+        this.relations = [];
+    }
+};
+BulkCreateDialogCommand = __decorate([
+    Command({
+        id: 'limeobject.bulk-create-dialog',
+    })
+], BulkCreateDialogCommand);
+export { BulkCreateDialogCommand };

package/dist/limeobject/commands/create-dialog.d.ts

@@ -0,0 +1,28 @@
+import { LimeWebComponentContext } from '../../core';
+import { LimeType } from '../../limetype';
+/**
+ * Open a dialog for creating a new limeobject or editing a specific limeobject
+ *
+ * The create dialog is implemented as a command so a plugin can easily replace the original dialog with a custom one.
+ * Check out the "Hello, Event!" tutorial for a detailed description on how to implement your own create dialog.
+ *
+ * This dialog also useful to edit a limeobject that already exists
+ *
+ * @id `limeobject.create-dialog`
+ */
+export declare class CreateLimeobjectDialogCommand {
+    /**
+     * The limetype of the object to create
+     */
+    limetype: LimeType;
+    /**
+     * Default data to populate the form with
+     */
+    limeobject?: any;
+    /**
+     * Specifies if routing to limeobject should be done after confirmation
+     */
+    route?: boolean;
+    title?: string;
+    context?: LimeWebComponentContext;
+}

package/dist/limeobject/commands/create-dialog.js

@@ -0,0 +1,26 @@
+import { __decorate } from "tslib";
+import { Command } from '../../commandbus';
+/**
+ * Open a dialog for creating a new limeobject or editing a specific limeobject
+ *
+ * The create dialog is implemented as a command so a plugin can easily replace the original dialog with a custom one.
+ * Check out the "Hello, Event!" tutorial for a detailed description on how to implement your own create dialog.
+ *
+ * This dialog also useful to edit a limeobject that already exists
+ *
+ * @id `limeobject.create-dialog`
+ */
+let CreateLimeobjectDialogCommand = class CreateLimeobjectDialogCommand {
+    constructor() {
+        /**
+         * Specifies if routing to limeobject should be done after confirmation
+         */
+        this.route = false;
+    }
+};
+CreateLimeobjectDialogCommand = __decorate([
+    Command({
+        id: 'limeobject.create-dialog',
+    })
+], CreateLimeobjectDialogCommand);
+export { CreateLimeobjectDialogCommand };

package/dist/limeobject/commands/delete-object.d.ts

@@ -0,0 +1,10 @@
+import { LimeType } from '../../limetype';
+/**
+ * Deletes the object from the database
+ *
+ * @id `limeobject.delete-object`
+ */
+export declare class DeleteObjectCommand {
+    id: number;
+    limetype: LimeType;
+}

package/dist/limeobject/commands/delete-object.js

@@ -0,0 +1,15 @@
+import { __decorate } from "tslib";
+import { Command } from '../../commandbus';
+/**
+ * Deletes the object from the database
+ *
+ * @id `limeobject.delete-object`
+ */
+let DeleteObjectCommand = class DeleteObjectCommand {
+};
+DeleteObjectCommand = __decorate([
+    Command({
+        id: 'limeobject.delete-object',
+    })
+], DeleteObjectCommand);
+export { DeleteObjectCommand };

package/dist/limeobject/commands/index.d.ts

@@ -0,0 +1,5 @@
+export * from './bulk-create-dialog';
+export * from './create-dialog';
+export * from './delete-object';
+export * from './object-access';
+export * from './save-object';

package/dist/limeobject/commands/index.js

@@ -0,0 +1,5 @@
+export * from './bulk-create-dialog';
+export * from './create-dialog';
+export * from './delete-object';
+export * from './object-access';
+export * from './save-object';