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

package/dist/core/decorators/index.js

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

package/dist/core/index.d.ts

@@ -0,0 +1,6 @@
+export * from './context';
+export * from './platform';
+export * from './lime-web-component';
+export * from './plugin-loader';
+export * from './state';
+export * from './decorators';

package/dist/core/index.js

@@ -0,0 +1,6 @@
+export * from './context';
+export * from './platform';
+export * from './lime-web-component';
+export * from './plugin-loader';
+export * from './state';
+export * from './decorators';

package/dist/core/lime-web-component.d.ts

@@ -0,0 +1,15 @@
+import { LimeWebComponentContext } from './context';
+import { LimeWebComponentPlatform } from './platform';
+/**
+ * Interface that Lime Web Components must implement
+ */
+export interface LimeWebComponent {
+    /**
+     * Reference to the platform
+     */
+    platform: LimeWebComponentPlatform;
+    /**
+     * The context this component belongs to
+     */
+    context: LimeWebComponentContext;
+}

package/dist/core/lime-web-component.js

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

package/dist/core/platform.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Service container for the Lime CRM platform
+ */
+export interface LimeWebComponentPlatform {
+    type: 'LimeCRMWebClient' | 'LimeCRMDesktopClient';
+    /**
+     * Get a service
+     *
+     * @param name the name of the service
+     */
+    get(name: string): any;
+    /**
+     * Check if a service is currently registered on the platform
+     *
+     * @param name the name of the service
+     */
+    has(name: string): boolean;
+    /**
+     * Register a service on the platform
+     *
+     * Core platform service names are defined by the enum `PlatformServiceName`. Third parties that wants to register
+     * a service should add a prefix to the service name, e.g. the plugin name.
+     *
+     * @param name the name of the service
+     * @param service the service
+     */
+    register(name: string, service: any): void;
+}
+/**
+ * Core platform service names
+ */
+export declare const PlatformServiceName: PlatformServiceName;
+export interface PlatformServiceName {
+    /**
+     * @deprecated use the new {@link PlatformServiceName.Navigator} instead
+     */
+    Route: 'route';
+}

package/dist/core/platform.js

@@ -0,0 +1,6 @@
+/**
+ * Core platform service names
+ */
+export const PlatformServiceName = {
+    Route: 'route',
+};

package/dist/core/plugin-loader.d.ts

@@ -0,0 +1,28 @@
+import { LimeWebComponent } from './lime-web-component';
+/**
+ * Interface for the loader component that is loaded when the app starts
+ */
+export interface LimePluginLoader extends LimeWebComponent {
+    /**
+     * This method will be invoked every time the component is inserted into
+     * the DOM. For a plugin loader component, it should happen only once. The
+     * method must be present on the component for technical reasons.
+     */
+    connectedCallback(): void | Promise<any>;
+    /**
+     * Do any initializations required for the plugin in this method
+     */
+    componentWillLoad(): void | Promise<any>;
+    /**
+     * This method will never be called since the component will never
+     * be updated. It must still be present on the component though.
+     */
+    componentWillUpdate(): void | Promise<any>;
+    /**
+     * This method will be invoked every time the component is removed from
+     * the DOM. For a plugin loader component, it should never happen since
+     * the component will live during the whole lifespan of the application.
+     * The method must be present on the component for technical reasons.
+     */
+    disconnectedCallback(): void | Promise<any>;
+}

package/dist/core/plugin-loader.js

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

package/dist/core/state.d.ts

@@ -0,0 +1,39 @@
+import { Subscribable } from 'rxjs';
+import { LimeWebComponentContext } from './context';
+/**
+ * Base service for letting a Lime web component subscribe to state changes
+ */
+export interface StateRepository {
+    /**
+     * Subscribe to state changes
+     *
+     * @param {Function} callback function to call when subscription updates
+     * @param {StateOptions} [options] options for the state selector
+     * @returns {Function} unsubscribe callback
+     */
+    subscribe(callback: () => void, options?: StateOptions): () => void;
+}
+/**
+ * Options for the state selector
+ */
+export interface StateOptions {
+    /**
+     * List of functions that will be used to map the state.
+     * The functions will be bound to the web component instance
+     */
+    map?: Array<(state: any) => any>;
+    /**
+     * List of functions that will be used to filter any changes to the state.
+     * The functions will be bound to the web component instance
+     */
+    filter?: Array<(state: any) => boolean>;
+}
+export interface ContextAwareStateOptions extends StateOptions {
+    /**
+     * An observable that emits a new value when the context of the component
+     * is changed. If set, the corresponding state service will emit a new value
+     * when the context has changed as well. Only applies to states that are
+     * aware of the context, e.g. `CurrentLimetype` and `CurrentLimeobject`
+     */
+    context?: Subscribable<LimeWebComponentContext> | null;
+}

package/dist/core/state.js

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

package/dist/device/decorator.d.ts

@@ -0,0 +1,16 @@
+import { StateOptions } from '../core';
+/**
+ * DeviceType
+ *
+ * @type {string}
+ */
+export declare type DeviceType = 'desktop' | 'tablet' | 'phone';
+/**
+ * Get the current device type
+ *
+ * The device will only indicate roughly how big the viewport is, not what actual device is being used
+ *
+ * @param {StateOptions} [options] state decorator options
+ * @returns {Function} state decorator
+ */
+export declare function SelectDevice(options?: StateOptions): PropertyDecorator;

package/dist/device/decorator.js

@@ -0,0 +1,16 @@
+import { PlatformServiceName, } from '../core';
+import { createStateDecorator } from '../core/decorators/factory';
+/**
+ * Get the current device type
+ *
+ * The device will only indicate roughly how big the viewport is, not what actual device is being used
+ *
+ * @param {StateOptions} [options] state decorator options
+ * @returns {Function} state decorator
+ */
+export function SelectDevice(options = {}) {
+    const config = {
+        name: PlatformServiceName.Device,
+    };
+    return createStateDecorator(options, config);
+}

package/dist/device/device.d.ts

@@ -0,0 +1,21 @@
+import { StateRepository } from '../core';
+export interface Device extends StateRepository {
+    /**
+     * Check if the device type is 'desktop'
+     *
+     * @returns {boolean} true/false
+     */
+    isDesktopSize(): boolean;
+    /**
+     * Check if the device type is 'tablet'
+     *
+     * @returns {boolean} true/false
+     */
+    isTabletSize(): boolean;
+    /**
+     * Check if the device type is 'phone'
+     *
+     * @returns {boolean} true/false
+     */
+    isPhoneSize(): boolean;
+}

package/dist/device/device.js

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

package/dist/device/index.d.ts

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

package/dist/device/index.js

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

package/dist/device/types.d.ts

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

package/dist/device/types.js

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

package/dist/dialog/dialog.d.ts

@@ -0,0 +1,41 @@
+/**
+ * Service for creating and displaying dialogs containing a web component
+ *
+ * @emits dialog.destroyed - When the dialog is beeing externally destroyed,
+ * e.g. by closing a popup window (depending on platform), a
+ * {@link DialogDestroyedEvent} will be emitted using
+ * {@link EventDispatcher}
+ */
+export interface DialogRenderer {
+    /**
+     * Create a new dialog and render its contents. Depending on what kind of
+     * platform the service is used on, the dialog might be rendered in the
+     * current {@link Document} or opened in a new popup window.
+     *
+     * @param name the name of the web component representing the dialog
+     * @param properties any properties to send to the dialog
+     * @param listeners any event listeners to register on the dialog
+     * @returns id representing the dialog
+     */
+    create(name: string, properties?: DialogProperties, listeners?: DialogListeners): number;
+    /**
+     * Update an existing dialog with new properties
+     *
+     * @param id the dialog identifier
+     * @param properties any properties to send to the dialog
+     */
+    update?(id: number, properties?: DialogProperties): void;
+    /**
+     * Destroy a dialog
+     *
+     * @param id id representing the dialog
+     */
+    destroy(id: number): void;
+}
+export declare type DialogProperties = Record<string, any>;
+export declare type DialogListeners = Record<string, (event?: CustomEvent<any>) => void>;
+/**
+ * @event dialog.destroyed - Emitted when a dialog is externally destroyed, e.g.
+ * by closing a popup window
+ */
+export declare type DialogDestroyedEvent = CustomEvent<number>;

package/dist/dialog/dialog.js

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

package/dist/dialog/index.d.ts

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

package/dist/dialog/index.js

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

package/dist/dialog/types.d.ts

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

package/dist/dialog/types.js

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

package/dist/es5/application/decorators/application.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SelectApplicationName = void 0;
+var tslib_1 = require("tslib");
+var core_1 = require("../../core");
+var factory_1 = require("../../core/decorators/factory");
+function SelectApplicationName(options) {
+    if (options === void 0) { options = {}; }
+    var config = {
+        name: core_1.PlatformServiceName.Application,
+    };
+    options.map = tslib_1.__spreadArray([getApplicationName], (options.map || []), true);
+    return (0, factory_1.createStateDecorator)(options, config);
+}
+exports.SelectApplicationName = SelectApplicationName;
+function getApplicationName(applicationData) {
+    return applicationData.applicationName;
+}

package/dist/es5/application/decorators/index.js

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

package/dist/es5/application/decorators/session.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SelectSession = void 0;
+var tslib_1 = require("tslib");
+var core_1 = require("../../core");
+var factory_1 = require("../../core/decorators/factory");
+function SelectSession(options) {
+    if (options === void 0) { options = {}; }
+    var config = {
+        name: core_1.PlatformServiceName.Application,
+    };
+    options.map = tslib_1.__spreadArray([getSession], (options.map || []), true);
+    return (0, factory_1.createStateDecorator)(options, config);
+}
+exports.SelectSession = SelectSession;
+function getSession(applicationData) {
+    return applicationData.session;
+}

package/dist/es5/application/decorators/user.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SelectCurrentUser = void 0;
+var tslib_1 = require("tslib");
+var core_1 = require("../../core");
+var factory_1 = require("../../core/decorators/factory");
+function SelectCurrentUser(options) {
+    if (options === void 0) { options = {}; }
+    var config = {
+        name: core_1.PlatformServiceName.Application,
+    };
+    options.map = tslib_1.__spreadArray([getCurrentUser], (options.map || []), true);
+    return (0, factory_1.createStateDecorator)(options, config);
+}
+exports.SelectCurrentUser = SelectCurrentUser;
+function getCurrentUser(applicationData) {
+    return applicationData.currentUser;
+}

package/dist/es5/application/index.js

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

package/dist/es5/application/session.js

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

package/dist/es5/application/types.js

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

package/dist/es5/application/user.js

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

package/dist/es5/commandbus/commandbus.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCommandId = exports.Command = exports.CommandEventName = void 0;
+var CommandEventName;
+(function (CommandEventName) {
+    CommandEventName["Received"] = "command.received";
+    CommandEventName["Handled"] = "command.handled";
+    CommandEventName["Failed"] = "command.failed";
+})(CommandEventName = exports.CommandEventName || (exports.CommandEventName = {}));
+function Command(options) {
+    return function (commandClass) {
+        setCommandId(commandClass, options.id);
+    };
+}
+exports.Command = Command;
+function setCommandId(commandClass, id) {
+    commandClass['commandId'] = id;
+}
+function getCommandId(value) {
+    if (typeof value === 'string') {
+        return value;
+    }
+    if (value && value.constructor && value.constructor['commandId']) {
+        return value.constructor['commandId'];
+    }
+    if (value && value['commandId']) {
+        return value['commandId'];
+    }
+    return null;
+}
+exports.getCommandId = getCommandId;

package/dist/es5/commandbus/index.js

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

package/dist/es5/commandbus/types.js

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

package/dist/es5/config/decorator.js

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

package/dist/es5/config/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/config/repository.js

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

package/dist/es5/config/types.js

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

package/dist/es5/core/context.js

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