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

package/dist/task/repository.js

@@ -0,0 +1,49 @@
+// eslint-disable-next-line no-shadow
+export var TaskState;
+(function (TaskState) {
+    /**
+     * Task state is unknown
+     */
+    TaskState["Pending"] = "PENDING";
+    /**
+     * Task was started by a worker
+     */
+    TaskState["Started"] = "STARTED";
+    /**
+     * Task is waiting for retry
+     */
+    TaskState["Retry"] = "RETRY";
+    /**
+     * Task succeeded
+     */
+    TaskState["Success"] = "SUCCESS";
+    /**
+     * Task failed
+     */
+    TaskState["Failure"] = "FAILURE";
+})(TaskState || (TaskState = {}));
+/**
+ * Events dispatched by the task service
+ */
+// eslint-disable-next-line no-shadow
+export var TaskEventType;
+(function (TaskEventType) {
+    /**
+     * Dispatched when a task has been created.
+     *
+     * @detail { task }
+     */
+    TaskEventType["Created"] = "task.created";
+    /**
+     * Dispatched when the task has successfully been completed
+     *
+     * @detail { task }
+     */
+    TaskEventType["Success"] = "task.success";
+    /**
+     * Dispatched if an error occured while running the task
+     *
+     * @detail { task | error? }
+     */
+    TaskEventType["Failed"] = "task.failed";
+})(TaskEventType || (TaskEventType = {}));

package/dist/task/types.d.ts

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

package/dist/task/types.js

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

package/dist/testing/component-testing.d.ts

@@ -0,0 +1,53 @@
+import { SpecPage } from '@stencil/core/testing';
+export interface ComponentProps {
+    [name: string]: any;
+}
+export interface ComponentListeners {
+    [name: string]: (event: CustomEvent<any>) => void;
+}
+export interface ComponentConfig {
+    /**
+     * Tag name of the component
+     */
+    tag: string;
+    /**
+     * The props to give the component when it is created
+     */
+    props?: ComponentProps;
+    /**
+     * The initial state to give the component when it is created
+     */
+    state?: object;
+    /**
+     * Any listeners to attach to the component
+     */
+    listeners?: ComponentListeners;
+    /**
+     * A list of elements to append to the created component before it's inserted into the DOM
+     */
+    children?: HTMLElement[];
+}
+/**
+ * Create a new component
+ *
+ * @param {*} component the component class
+ * @param {SpecPage} page the page to create the component on
+ * @param {ComponentConfig} config component configuration
+ * @returns {HTMLElement} the component
+ */
+export declare function createComponent(component: any, page: SpecPage, config: ComponentConfig): HTMLElement;
+/**
+ * Destroy a component that was created by the `createComponent` function
+ *
+ * @param {HTMLElement} component the component to destroy
+ * @returns {void}
+ */
+export declare function destroyComponent(component: HTMLElement): void;
+/**
+ * Set a state variable on the component
+ *
+ * @param {HTMLElement} component the component
+ * @param {object} state the state variables to set along with their values
+ * @returns {void}
+ */
+export declare function setState(component: HTMLElement, state: object): void;

package/dist/testing/component-testing.js

@@ -0,0 +1,162 @@
+import { getElement } from '@stencil/core';
+import { defaultContext, createPlatform } from './platform';
+const componentConfigs = new WeakMap();
+const componentInstances = new WeakMap();
+const originalHooks = new WeakMap();
+const destroyFunctions = new WeakMap();
+/**
+ * Create a new component
+ *
+ * @param {*} component the component class
+ * @param {SpecPage} page the page to create the component on
+ * @param {ComponentConfig} config component configuration
+ * @returns {HTMLElement} the component
+ */
+export function createComponent(component, page, config) {
+    componentConfigs.set(component.prototype, config);
+    extendLifecycleHook(component.prototype, 'componentWillLoad', initComponent);
+    const element = page.doc.createElement(config.tag);
+    const props = config.props || {};
+    const listeners = config.listeners || {};
+    const children = config.children || [];
+    setDefault(props);
+    addProps(props, element);
+    addListeners(listeners, element);
+    addChildren(element, children);
+    destroyFunctions.set(element, () => {
+        removeListeners(listeners, element);
+    });
+    page.body.appendChild(element);
+    return element;
+}
+/**
+ * Destroy a component that was created by the `createComponent` function
+ *
+ * @param {HTMLElement} component the component to destroy
+ * @returns {void}
+ */
+export function destroyComponent(component) {
+    if (!component) {
+        return;
+    }
+    const destroyFunction = destroyFunctions.get(component);
+    if (!destroyFunction) {
+        return;
+    }
+    destroyFunction();
+}
+/**
+ * Set a state variable on the component
+ *
+ * @param {HTMLElement} component the component
+ * @param {object} state the state variables to set along with their values
+ * @returns {void}
+ */
+export function setState(component, state) {
+    const instance = componentInstances.get(component);
+    Object.assign(instance, state);
+}
+/**
+ * Init a component that is under test
+ *
+ * This is called just before the `componentWillLoad` lifecycle hook
+ * of the component and is a good place to save the component instance
+ * and set the initial state
+ *
+ * @returns {void}
+ */
+function initComponent() {
+    const element = getElement(this);
+    componentInstances.set(element, this);
+    const config = componentConfigs.get(this.constructor.prototype);
+    if (config === null || config === void 0 ? void 0 : config.state) {
+        setState(element, config.state);
+    }
+}
+/**
+ * Extend a lifecycle hook on a component
+ *
+ * @param {*} component the prototype of the component
+ * @param {string} name the name of the hook
+ * @param {Function} hook the function to run before the original hook
+ * @returns {void}
+ */
+function extendLifecycleHook(component, name, hook) {
+    if (!originalHooks.has(component)) {
+        originalHooks.set(component, {});
+    }
+    const hooks = originalHooks.get(component);
+    if (!hooks[name]) {
+        hooks[name] = component[name];
+    }
+    component[name] = function (...args) {
+        hook.apply(this, args);
+        if (hooks[name]) {
+            return hooks[name].apply(this, args);
+        }
+    };
+}
+/**
+ * Sets a default props on the component
+ *
+ * Will set a default platform and context if not already set
+ *
+ * @param {ComponentProps} props the component props
+ * @returns {void}
+ */
+function setDefault(props) {
+    if (!('platform' in props)) {
+        props.platform = createPlatform();
+    }
+    if (!('context' in props)) {
+        props.context = defaultContext;
+    }
+}
+/**
+ * Add properties to a web component
+ *
+ * @param {ComponentProps} props the properties to set
+ * @param {HTMLElement} component the web component
+ * @returns {void}
+ */
+function addProps(props, component) {
+    Object.entries(props).forEach(([key, value]) => {
+        component[key] = value;
+    });
+}
+/**
+ * Add event listeners to a web component
+ *
+ * @param {ComponentListeners} listeners the events to listen to
+ * @param {HTMLElement} component the web component
+ * @returns {void}
+ */
+function addListeners(listeners, component) {
+    Object.entries(listeners).forEach(([key, value]) => {
+        component.addEventListener(key, value);
+    });
+}
+/**
+ * Remove event listeners from a web component
+ *
+ * @param {ComponentListeners} listeners the events to listen to
+ * @param {HTMLElement} component the web component
+ * @returns {void}
+ */
+function removeListeners(listeners, component) {
+    Object.entries(listeners).forEach(([key, value]) => {
+        component.removeEventListener(key, value);
+    });
+}
+/**
+ * Appends children to an html element
+ *
+ * @param {HTMLElement} parent the parent element
+ * @param {HTMLElement[]} children the child elements to add
+ * @returns {void}
+ */
+function addChildren(parent, children = []) {
+    [].slice.call(children).forEach((child) => {
+        parent.appendChild(child);
+    });
+}

package/dist/testing/index.d.ts

@@ -0,0 +1,4 @@
+export * from './component-testing';
+export * from './platform';
+export { limetypes } from './limetypes';
+export { limeobjects } from './limeobjects';

package/dist/testing/index.js

@@ -0,0 +1,4 @@
+export * from './component-testing';
+export * from './platform';
+export { limetypes } from './limetypes';
+export { limeobjects } from './limeobjects';

package/dist/testing/limeobjects/company.d.ts

@@ -0,0 +1,55 @@
+export declare const company: ({
+    getLimetype: () => import("../..").LimeType;
+    getValue: (property: string) => any;
+    name: string;
+    phone: string;
+    www: string;
+    postaladdress1: string;
+    visitingaddress1: string;
+    registrationno: string;
+    postalzipcode: string;
+    postalcity: string;
+    visitingzipcode: string;
+    visitingcity: string;
+    postaladdress2: string;
+    visitingaddress2: string;
+    country: string;
+    inactive: boolean;
+    buyingstatus: string;
+    fullpostaladdress: string;
+    fullvisitingaddress: string;
+    id: number;
+    createdtime: string;
+    timestamp: string;
+    descriptive: string;
+    coworker: number;
+    createduser?: undefined;
+    updateduser?: undefined;
+} | {
+    getLimetype: () => import("../..").LimeType;
+    getValue: (property: string) => any;
+    name: string;
+    phone: string;
+    www: string;
+    postaladdress1: string;
+    visitingaddress1: string;
+    registrationno: string;
+    coworker: any;
+    postalzipcode: string;
+    postalcity: string;
+    visitingzipcode: string;
+    visitingcity: string;
+    postaladdress2: string;
+    visitingaddress2: string;
+    country: string;
+    inactive: boolean;
+    buyingstatus: string;
+    fullpostaladdress: string;
+    fullvisitingaddress: string;
+    id: number;
+    createduser: number;
+    createdtime: string;
+    updateduser: number;
+    timestamp: string;
+    descriptive: string;
+})[];