@igo2/common 16.3.0 → 17.0.0-next.10

package/widget/public_api.d.ts

@@ -0,0 +1,3 @@
+export * from './shared';
+export * from './widget-outlet';
+export * from './widget.module';

package/widget/shared/widget.d.ts

@@ -0,0 +1,4 @@
+import { DynamicComponent } from '@igo2/common/dynamic-component';
+import { WidgetComponent } from './widget.interfaces';
+export declare class Widget extends DynamicComponent<WidgetComponent> {
+}

package/widget/shared/widget.service.d.ts

@@ -0,0 +1,10 @@
+import { DynamicComponentService } from '@igo2/common/dynamic-component';
+import { Widget } from './widget';
+import * as i0 from "@angular/core";
+export declare class WidgetService {
+    private dynamicComponentService;
+    constructor(dynamicComponentService: DynamicComponentService);
+    create(widgetCls: any): Widget;
+    static ɵfac: i0.ɵɵFactoryDeclaration<WidgetService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<WidgetService>;
+}

package/widget/widget-outlet/index.d.ts

@@ -0,0 +1,2 @@
+export * from './widget-outlet.module';
+export * from './widget-outlet.component';

package/widget/widget-outlet/widget-outlet.component.d.ts

@@ -0,0 +1,71 @@
+import { EventEmitter, OnDestroy } from '@angular/core';
+import { DynamicComponent } from '@igo2/common/dynamic-component';
+import { WidgetComponent } from '../shared/widget.interfaces';
+import * as i0 from "@angular/core";
+/**
+ * This component dynamically renders a widget. It also subscribes
+ * to the widget's 'cancel' and 'complete' events and destroys it
+ * when any of those event is emitted.
+ */
+export declare class WidgetOutletComponent implements OnDestroy {
+    /**
+     * Widget subscribers to 'cancel' and 'complete'
+     * @internal
+     */
+    private baseSubscribers;
+    /**
+     * Widget
+     */
+    widget: DynamicComponent<WidgetComponent>;
+    /**
+     * Widget inputs
+     */
+    inputs: {
+        [key: string]: any;
+    };
+    /**
+     * Widget subscribers
+     */
+    subscribers: {
+        [key: string]: (event: any) => void;
+    };
+    /**
+     * Event emitted when the widget emits 'complete'
+     */
+    complete: EventEmitter<any>;
+    /**
+     * Event emitted when the widget emits 'cancel'
+     */
+    cancel: EventEmitter<any>;
+    constructor();
+    /**
+     * Destroy the current widget and all it's inner subscriptions
+     * @internal
+     */
+    ngOnDestroy(): void;
+    /**
+     * Get the effective subscribers. That means a combination of the base
+     * subscribers and any subscriber given as input.
+     * @returns Combined subscribers
+     * @internal
+     */
+    getEffectiveSubscribers(): {
+        [key: string]: (event: any) => void;
+    };
+    /**
+     * When the widget emits 'cancel', propagate that event and destroy
+     * the widget
+     */
+    private onCancel;
+    /**
+     * When the widget emits 'complete', propagate that event and destroy
+     * the widget
+     */
+    private onComplete;
+    /**
+     * Destroy the current widget
+     */
+    private destroyWidget;
+    static ɵfac: i0.ɵɵFactoryDeclaration<WidgetOutletComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<WidgetOutletComponent, "igo-widget-outlet", never, { "widget": { "alias": "widget"; "required": false; }; "inputs": { "alias": "inputs"; "required": false; }; "subscribers": { "alias": "subscribers"; "required": false; }; }, { "complete": "complete"; "cancel": "cancel"; }, never, never, true, never>;
+}

package/widget/widget-outlet/widget-outlet.module.d.ts

@@ -0,0 +1,10 @@
+import * as i0 from "@angular/core";
+import * as i1 from "./widget-outlet.component";
+/**
+ * @deprecated import the WidgetOutletComponent directly
+ */
+export declare class IgoWidgetOutletModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<IgoWidgetOutletModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<IgoWidgetOutletModule, never, [typeof i1.WidgetOutletComponent], [typeof i1.WidgetOutletComponent]>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<IgoWidgetOutletModule>;
+}

package/widget/widget.module.d.ts

@@ -0,0 +1,10 @@
+import * as i0 from "@angular/core";
+import * as i1 from "./widget-outlet/widget-outlet.module";
+/**
+ * @deprecated import the WidgetOutletComponent directly
+ */
+export declare class IgoWidgetModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<IgoWidgetModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<IgoWidgetModule, never, [typeof i1.IgoWidgetOutletModule], [typeof i1.IgoWidgetOutletModule]>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<IgoWidgetModule>;
+}

package/workspace/index.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Generated bundle index. Do not edit.
+ */
+/// <amd-module name="@igo2/common/workspace" />
+export * from './public_api';

package/workspace/public_api.d.ts

@@ -0,0 +1,4 @@
+export * from './shared';
+export * from './workspace.module';
+export * from './workspace-selector';
+export * from './workspace-widget-outlet';

package/workspace/shared/store.d.ts

@@ -0,0 +1,20 @@
+import { EntityStore } from '@igo2/common/entity';
+import { BehaviorSubject } from 'rxjs';
+import { Workspace } from './workspace';
+/**
+ * The class is a specialized version of an EntityStore that stores
+ * workspaces.
+ */
+export declare class WorkspaceStore extends EntityStore<Workspace> {
+    activeWorkspace$: BehaviorSubject<Workspace>;
+    /**
+     * Activate the an workspace workspace and deactivate the one currently active
+     * @param workspace Workspace
+     */
+    activateWorkspace(workspace: Workspace): void;
+    /**
+     * Deactivate the current workspace
+     * @param workspace Workspace
+     */
+    deactivateWorkspace(): void;
+}

package/workspace/shared/workspace.d.ts

@@ -0,0 +1,108 @@
+import { ActionStore } from '@igo2/common/action';
+import { EntityStore } from '@igo2/common/entity';
+import { Widget } from '@igo2/common/widget';
+import { BehaviorSubject } from 'rxjs';
+import { WorkspaceOptions } from './workspace.interfaces';
+/**
+ * This class is responsible of managing the relations between
+ * entities and the actions that consume them. It also defines an
+ * entity table template that may be used by an entity table component.
+ */
+export declare class Workspace<E extends object = object> {
+    protected options: WorkspaceOptions;
+    /**
+     * Observable of the selected widget
+     */
+    readonly widget$: BehaviorSubject<Widget>;
+    /**
+     * Observable of the selected widget's inputs
+     */
+    readonly widgetInputs$: BehaviorSubject<{
+        [key: string]: any;
+    }>;
+    /**
+     * Observable of the selected widget's subscribers
+     */
+    readonly widgetSubscribers$: BehaviorSubject<{
+        [key: string]: (event: any) => void;
+    }>;
+    /**
+     * Subscription to the selected entity
+     */
+    private entities$$;
+    /**
+     * State change that trigger an update of the actions availability
+     */
+    private change;
+    /**
+     * Subscription to state changes
+     */
+    private change$;
+    /**
+     * Workspace id
+     */
+    get id(): string;
+    /**
+     * Workspace title
+     */
+    get title(): string;
+    /**
+     * Workspace title
+     */
+    get meta(): {
+        [key: string]: any;
+    };
+    /**
+     * Entities store
+     */
+    get entityStore(): EntityStore<E>;
+    /**
+     * Actions store (some actions activate a widget)
+     */
+    get actionStore(): ActionStore;
+    /**
+     * Selected widget
+     */
+    get widget(): Widget;
+    /**
+     * Whether a widget is selected
+     */
+    get hasWidget(): boolean;
+    constructor(options: WorkspaceOptions);
+    /**
+     * Whether this strategy is active
+     * @internal
+     */
+    get active(): boolean;
+    readonly active$: BehaviorSubject<boolean>;
+    /**
+     * Activate the workspace. By doing that, the workspace will observe
+     * the selected entity (from the store) and update the actions availability.
+     * For example, some actions require an entity to be selected.
+     */
+    activate(): void;
+    /**
+     * Deactivate the workspace. Unsubcribe to the selected entity.
+     */
+    deactivate(): void;
+    /**
+     * Activate a widget. In itself, activating a widget doesn't render it but,
+     * if an WorkspaceWidgetOutlet component is bound to this workspace, the widget will
+     * show up.
+     * @param widget Widget
+     * @param inputs Inputs the widget will receive
+     */
+    activateWidget(widget: Widget, inputs?: {
+        [key: string]: any;
+    }, subscribers?: {
+        [key: string]: (event: any) => void;
+    }): void;
+    /**
+     * Deactivate a widget.
+     */
+    deactivateWidget(): void;
+    /**
+     * When the state changes, update the actions availability.
+     */
+    private onStateChange;
+}

package/workspace/shared/workspace.interfaces.d.ts

@@ -0,0 +1,11 @@
+import { ActionStore } from '@igo2/common/action';
+import { EntityStore } from '@igo2/common/entity';
+export interface WorkspaceOptions {
+    id: string;
+    title: string;
+    entityStore?: EntityStore<object>;
+    actionStore?: ActionStore;
+    meta?: {
+        [key: string]: any;
+    };
+}

package/workspace/workspace-selector/index.d.ts

@@ -0,0 +1,2 @@
+export * from './workspace-selector.module';
+export * from './workspace-selector.component';

package/workspace/workspace-selector/workspace-selector.component.d.ts

@@ -0,0 +1,38 @@
+import { EventEmitter } from '@angular/core';
+import { EntitySelectorChange } from '@igo2/common/entity';
+import { WorkspaceStore } from '../shared/store';
+import { Workspace } from '../shared/workspace';
+import * as i0 from "@angular/core";
+/**
+ * Drop list that activates the selected workspace emit an event.
+ */
+export declare class WorkspaceSelectorComponent {
+    /**
+     * Store that holds the available workspaces.
+     */
+    store: WorkspaceStore;
+    /**
+     * Wheither the selector must be disabled or not.
+     */
+    disabled: boolean;
+    /**
+     * Event emitted when an workspace is selected or unselected
+     */
+    selectedChange: EventEmitter<{
+        selected: boolean;
+        value: Workspace;
+    }>;
+    /**
+     * @internal
+     */
+    getWorkspaceTitle(workspace: Workspace): string;
+    /**
+     * When an workspace is manually selected, select it into the
+     * store and emit an event.
+     * @internal
+     * @param event The selection change event
+     */
+    onSelectedChange(event: EntitySelectorChange<Workspace>): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<WorkspaceSelectorComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<WorkspaceSelectorComponent, "igo-workspace-selector", never, { "store": { "alias": "store"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; }, { "selectedChange": "selectedChange"; }, never, never, true, never>;
+}

package/workspace/workspace-selector/workspace-selector.module.d.ts

@@ -0,0 +1,10 @@
+import * as i0 from "@angular/core";
+import * as i1 from "./workspace-selector.component";
+/**
+ * @deprecated import the WorkspaceSelectorComponent directly
+ */
+export declare class IgoWorkspaceSelectorModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<IgoWorkspaceSelectorModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<IgoWorkspaceSelectorModule, never, [typeof i1.WorkspaceSelectorComponent], [typeof i1.WorkspaceSelectorComponent]>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<IgoWorkspaceSelectorModule>;
+}

package/workspace/workspace-widget-outlet/index.d.ts

@@ -0,0 +1,2 @@
+export * from './workspace-widget-outlet.module';
+export * from './workspace-widget-outlet.component';

package/workspace/workspace-widget-outlet/workspace-widget-outlet.component.d.ts

@@ -0,0 +1,57 @@
+import { EventEmitter } from '@angular/core';
+import { Widget } from '@igo2/common/widget';
+import { BehaviorSubject } from 'rxjs';
+import { Workspace } from '../shared/workspace';
+import * as i0 from "@angular/core";
+/**
+ * This component dynamically render an Workspace's active widget.
+ * It also deactivate that widget whenever the widget's component
+ * emit the 'cancel' or 'complete' event.
+ */
+export declare class WorkspaceWidgetOutletComponent {
+    /**
+     * Workspace
+     */
+    workspace: Workspace;
+    /**
+     * Event emitted when a widget is deactivate which happens
+     * when the widget's component emits the 'cancel' or 'complete' event.
+     */
+    deactivateWidget: EventEmitter<Widget>;
+    /**
+     * Observable of the workspace's active widget
+     * @internal
+     */
+    get widget$(): BehaviorSubject<Widget>;
+    /**
+     * Observable of the workspace's widget inputs
+     * @internal
+     */
+    get widgetInputs$(): BehaviorSubject<{
+        [key: string]: any;
+    }>;
+    /**
+     * Observable of the workspace's widget inputs
+     * @internal
+     */
+    get widgetSubscribers$(): BehaviorSubject<{
+        [key: string]: (event: any) => void;
+    }>;
+    constructor();
+    /**
+     * When a widget's component emit the 'cancel' event,
+     * deactivate that widget and emit the 'deactivateWidget' event.
+     * @param widget Widget
+     * @internal
+     */
+    onWidgetCancel(widget: Widget): void;
+    /**
+     * When a widget's component emit the 'cancel' event,
+     * deactivate that widget and emit the 'deactivateWidget' event.
+     * @param widget Widget
+     * @internal
+     */
+    onWidgetComplete(widget: Widget): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<WorkspaceWidgetOutletComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<WorkspaceWidgetOutletComponent, "igo-workspace-widget-outlet", never, { "workspace": { "alias": "workspace"; "required": false; }; }, { "deactivateWidget": "deactivateWidget"; }, never, never, true, never>;
+}

package/workspace/workspace-widget-outlet/workspace-widget-outlet.module.d.ts

@@ -0,0 +1,10 @@
+import * as i0 from "@angular/core";
+import * as i1 from "./workspace-widget-outlet.component";
+/**
+ * @deprecated import the WorkspaceWidgetOutletComponent directly
+ */
+export declare class IgoWorkspaceWidgetOutletModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<IgoWorkspaceWidgetOutletModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<IgoWorkspaceWidgetOutletModule, never, [typeof i1.WorkspaceWidgetOutletComponent], [typeof i1.WorkspaceWidgetOutletComponent]>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<IgoWorkspaceWidgetOutletModule>;
+}

package/workspace/workspace.module.d.ts

@@ -0,0 +1,14 @@
+import { WorkspaceSelectorComponent } from './workspace-selector';
+import { WorkspaceWidgetOutletComponent } from './workspace-widget-outlet';
+import * as i0 from "@angular/core";
+import * as i1 from "./workspace-selector/workspace-selector.component";
+import * as i2 from "./workspace-widget-outlet/workspace-widget-outlet.component";
+export declare const WORKSPACE_DIRECTIVES: readonly [typeof WorkspaceSelectorComponent, typeof WorkspaceWidgetOutletComponent];
+/**
+ * @deprecated import the components directly or WORKSPACE_DIRECTIVES for every components/directives
+ */
+export declare class IgoWorkspaceModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<IgoWorkspaceModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<IgoWorkspaceModule, never, [typeof i1.WorkspaceSelectorComponent, typeof i2.WorkspaceWidgetOutletComponent], [typeof i1.WorkspaceSelectorComponent, typeof i2.WorkspaceWidgetOutletComponent]>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<IgoWorkspaceModule>;
+}

package/esm2022/lib/action/action.module.mjs

@@ -1,19 +0,0 @@
-import { CommonModule } from '@angular/common';
-import { NgModule } from '@angular/core';
-import { IgoActionbarModule } from './actionbar/actionbar.module';
-import * as i0 from "@angular/core";
-export class IgoActionModule {
-    static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.2.12", ngImport: i0, type: IgoActionModule, deps: [], target: i0.ɵɵFactoryTarget.NgModule });
-    static ɵmod = i0.ɵɵngDeclareNgModule({ minVersion: "14.0.0", version: "16.2.12", ngImport: i0, type: IgoActionModule, imports: [CommonModule, IgoActionbarModule], exports: [IgoActionbarModule] });
-    static ɵinj = i0.ɵɵngDeclareInjector({ minVersion: "12.0.0", version: "16.2.12", ngImport: i0, type: IgoActionModule, imports: [CommonModule, IgoActionbarModule, IgoActionbarModule] });
-}
-i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImport: i0, type: IgoActionModule, decorators: [{
-            type: NgModule,
-            args: [{
-                    imports: [CommonModule, IgoActionbarModule],
-                    exports: [IgoActionbarModule],
-                    declarations: [],
-                    providers: []
-                }]
-        }] });
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYWN0aW9uLm1vZHVsZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uLy4uL3BhY2thZ2VzL2NvbW1vbi9zcmMvbGliL2FjdGlvbi9hY3Rpb24ubW9kdWxlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sRUFBRSxZQUFZLEVBQUUsTUFBTSxpQkFBaUIsQ0FBQztBQUMvQyxPQUFPLEVBQUUsUUFBUSxFQUFFLE1BQU0sZUFBZSxDQUFDO0FBRXpDLE9BQU8sRUFBRSxrQkFBa0IsRUFBRSxNQUFNLDhCQUE4QixDQUFDOztBQVFsRSxNQUFNLE9BQU8sZUFBZTt3R0FBZixlQUFlO3lHQUFmLGVBQWUsWUFMaEIsWUFBWSxFQUFFLGtCQUFrQixhQUNoQyxrQkFBa0I7eUdBSWpCLGVBQWUsWUFMaEIsWUFBWSxFQUFFLGtCQUFrQixFQUNoQyxrQkFBa0I7OzRGQUlqQixlQUFlO2tCQU4zQixRQUFRO21CQUFDO29CQUNSLE9BQU8sRUFBRSxDQUFDLFlBQVksRUFBRSxrQkFBa0IsQ0FBQztvQkFDM0MsT0FBTyxFQUFFLENBQUMsa0JBQWtCLENBQUM7b0JBQzdCLFlBQVksRUFBRSxFQUFFO29CQUNoQixTQUFTLEVBQUUsRUFBRTtpQkFDZCIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IENvbW1vbk1vZHVsZSB9IGZyb20gJ0Bhbmd1bGFyL2NvbW1vbic7XHJcbmltcG9ydCB7IE5nTW9kdWxlIH0gZnJvbSAnQGFuZ3VsYXIvY29yZSc7XHJcblxyXG5pbXBvcnQgeyBJZ29BY3Rpb25iYXJNb2R1bGUgfSBmcm9tICcuL2FjdGlvbmJhci9hY3Rpb25iYXIubW9kdWxlJztcclxuXHJcbkBOZ01vZHVsZSh7XHJcbiAgaW1wb3J0czogW0NvbW1vbk1vZHVsZSwgSWdvQWN0aW9uYmFyTW9kdWxlXSxcclxuICBleHBvcnRzOiBbSWdvQWN0aW9uYmFyTW9kdWxlXSxcclxuICBkZWNsYXJhdGlvbnM6IFtdLFxyXG4gIHByb3ZpZGVyczogW11cclxufSlcclxuZXhwb3J0IGNsYXNzIElnb0FjdGlvbk1vZHVsZSB7fVxyXG4iXX0=