@genesislcap/foundation-workspace 14.406.0-workspaces.7

package/dist/foundation-workspace.d.ts

@@ -0,0 +1,343 @@
+import { Auth } from '@genesislcap/foundation-comms';
+import type { ColumnApi } from '@ag-grid-community/core';
+import { Connect } from '@genesislcap/foundation-comms';
+import type { Container } from '@microsoft/fast-foundation';
+import { FoundationElement } from '@microsoft/fast-foundation';
+import type { GridApi } from '@ag-grid-community/core';
+import { InterfaceSymbol } from '@microsoft/fast-foundation';
+import { KVStorage } from '@genesislcap/foundation-comms';
+import { Modal } from '@genesislcap/foundation-ui';
+
+/**
+ * @alpha
+ */
+export declare class DefaultFilterRegistry implements FilterRegistry {
+    private filters;
+    registerFilter(filterKey: string, getFilterValue: () => SavedFilterValue | null, setFilterValue: (value: string) => void): void;
+    unregisterFilter(filterKey: string): void;
+    getAllFiltersValues(): SavedFilterValue[];
+    applyFiltersValues(filtersValues: SavedFilterValue[]): void;
+}
+
+/**
+ * @alpha
+ */
+export declare class DefaultGridRegistry implements GridRegistry {
+    private grids;
+    private cachedSettings;
+    registerGrid(gridKey: string, gridApi: unknown, columnApi: unknown): void;
+    getGrid(gridKey: string): unknown;
+    unregisterGrid(gridKey: string): void;
+    getAllGridsSettings(): SavedGridSettings[];
+    applyGridSettings(gridSetting: SavedGridSettings, options?: {
+        applyColumns?: boolean;
+        applyFilters?: boolean;
+    }): Promise<boolean>;
+    applyAllGridsSettings(gridsSettings: SavedGridSettings[], maxRetries?: number, delayMs?: number): Promise<void>;
+    private getGridSettings;
+}
+
+/**
+ * Default layout registry implementation.
+ * @alpha
+ */
+export declare class DefaultLayoutRegistry implements LayoutRegistry {
+    private layouts;
+    registerLayout(layoutKey: string, layout: any): void;
+    unregisterLayout(layoutKey: string): void;
+    getLayoutsConfigs(): SavedLayout[];
+    applySavedLayouts(savedLayouts: SavedLayout[]): Promise<void>;
+}
+
+/**
+ * Default workspace persistence implementation backed by KVStorage.
+ *
+ * @alpha
+ */
+export declare class DefaultWorkspaceState implements WorkspaceState {
+    kvStorage: KVStorage;
+    auth: Auth;
+    private readonly STORAGE_PREFIX;
+    private readonly WORKSPACES_LIST_KEY;
+    private currentWorkspace;
+    constructor(kvStorage: KVStorage, auth: Auth);
+    private getCurrentUsername;
+    private getWorkspaceStorageKey;
+    private getWorkspacesListKey;
+    saveWorkspace(workspaceName: string, layouts: SavedLayout[], grids: SavedGridSettings[], filters: SavedFilterValue[], description?: string): Promise<void>;
+    loadWorkspace(workspaceName: string): Promise<SavedWorkspace | null>;
+    private getWorkspace;
+    getCurrentWorkspace(): SavedWorkspace | null;
+    setCurrentWorkspace(workspace: SavedWorkspace | null): void;
+    getSavedWorkspaces(): Promise<SavedWorkspace[]>;
+    deleteWorkspace(workspaceName: string): Promise<void>;
+    private updateWorkspacesList;
+    private removeFromWorkspacesList;
+}
+
+/**
+ * @alpha
+ */
+export declare interface FilterRegistration {
+    filterKey: string;
+    getFilterValue: () => SavedFilterValue | null;
+    setFilterValue: (value: string) => void;
+}
+
+/**
+ * @alpha
+ */
+export declare interface FilterRegistry {
+    registerFilter(filterKey: string, getFilterValue: () => SavedFilterValue | null, setFilterValue: (value: string) => void): void;
+    getAllFiltersValues(): SavedFilterValue[];
+    unregisterFilter(filterKey: string): void;
+    applyFiltersValues(savedFilters: SavedFilterValue[]): void;
+}
+
+/**
+ * DI token for filter registry.
+ * @alpha
+ */
+export declare const FilterRegistry: InterfaceSymbol<FilterRegistry>;
+
+/**
+ * Registers an AG Grid instance so workspace state can apply/load it.
+ * @alpha
+ */
+export declare class GridRegister extends HTMLElement {
+    gridKey: string;
+    gridRegistry: GridRegistry;
+    workspaceState: WorkspaceState;
+    private gridElement;
+    private gridApi;
+    private columnApi;
+    private workspaceSettingsApplied;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    private findAndRegisterGrid;
+    private readonly handleGridReady;
+    private attachToGridApis;
+    private detachFromGridApis;
+    private loadWorkspaceSettings;
+    private loadWorkspaceColumnState;
+}
+
+/**
+ * @alpha
+ */
+export declare interface GridRegistration {
+    gridKey: string;
+    gridApi: GridApi;
+    columnApi: ColumnApi;
+}
+
+/**
+ * @alpha
+ */
+export declare interface GridRegistry {
+    registerGrid(gridKey: string, gridApi: unknown, columnApi: unknown): void;
+    getGrid(gridKey: string): unknown;
+    unregisterGrid(gridKey: string): void;
+    getAllGridsSettings(): SavedGridSettings[];
+    applyGridSettings(gridSetting: SavedGridSettings, options?: {
+        applyColumns?: boolean;
+        applyFilters?: boolean;
+    }): Promise<boolean>;
+    applyAllGridsSettings(gridsSettings: SavedGridSettings[]): Promise<void>;
+}
+
+/**
+ * DI token for grid registry.
+ * @alpha
+ */
+export declare const GridRegistry: InterfaceSymbol<GridRegistry>;
+
+/**
+ * @alpha
+ */
+export declare interface LayoutRegistry {
+    registerLayout(layoutKey: string, layout: unknown): void;
+    unregisterLayout(layoutKey: string): void;
+    getLayoutsConfigs(): SavedLayout[];
+    applySavedLayouts(savedLayouts: SavedLayout[]): Promise<void>;
+}
+
+/**
+ * DI token for layout registry.
+ * @alpha
+ */
+export declare const LayoutRegistry: InterfaceSymbol<LayoutRegistry>;
+
+/**
+ * Registers a layout instance so workspace state can apply/load it.
+ * @alpha
+ */
+export declare class LayoutWrapper extends HTMLElement {
+    layoutKey: string;
+    layoutRegistry: LayoutRegistry;
+    private layoutElement;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    private findAndRegisterLayout;
+}
+
+/**
+ * Workspace load mode.
+ * @alpha
+ */
+export declare type LoadMode = 'MY' | 'SHARED';
+
+/**
+ * @alpha
+ */
+export declare interface SavedFilterValue {
+    filterKey: string;
+    value: string;
+}
+
+/**
+ * Workspace persistence types.
+ * Layout and column state use generic shapes so consumers can use foundation-layout and ag-grid types.
+ * @alpha
+ */
+export declare interface SavedGridSettings {
+    gridKey: string;
+    columnState: any[];
+    savedAt: string;
+}
+
+/**
+ * @alpha
+ */
+export declare interface SavedLayout {
+    layoutKey: string;
+    layout: unknown;
+}
+
+/**
+ * @alpha
+ */
+export declare interface SavedWorkspace {
+    name: string;
+    username: string;
+    description?: string;
+    layouts: SavedLayout[];
+    grids: SavedGridSettings[];
+    filters: SavedFilterValue[];
+    savedAt: string;
+}
+
+/**
+ * @alpha
+ */
+export declare interface SharedWorkspace {
+    id: string;
+    name: string;
+    userName: string;
+    description?: string;
+    createdOn?: string | number;
+    modifiedOn?: string | number;
+    data: string;
+}
+
+/**
+ * Registration object for workspace-related components.
+ *
+ * Mirrors the shape of `rapidGridComponents` so it can be passed into
+ * `provideDesignSystem().register(...)` without additional glue code.
+ *
+ * @alpha
+ */
+export declare const workspaceComponents: {
+    workspaceManager: () => {
+        register(_container?: Container, ..._rest: any[]): void;
+    };
+    layoutWrapper: () => {
+        register(_container?: Container, ..._rest: any[]): void;
+    };
+    gridRegister: () => {
+        register(_container?: Container, ..._rest: any[]): void;
+    };
+    register(container?: Container, ...rest: any[]): void;
+};
+
+/**
+ * Workspace persistence UI (save/load + share/delete shared workspaces).
+ * @alpha
+ */
+export declare class WorkspaceManager extends FoundationElement {
+    workspaceName: string;
+    workspaceDescription: string;
+    savedWorkspaces: SavedWorkspace[];
+    sharedWorkspaces: SharedWorkspace[];
+    isLoading: boolean;
+    applyingWorkspace: boolean;
+    loadMode: LoadMode;
+    saveModal: Modal;
+    loadModal: Modal;
+    saveMode: 'create' | 'overwrite' | 'shared';
+    selectedWorkspaceToOverwrite: string;
+    workspaceToShare: string;
+    dialogBoundary: HTMLElement;
+    sharedWorkspaceDialogBoundary: HTMLElement;
+    layoutRegistry: LayoutRegistry;
+    gridRegistry: GridRegistry;
+    filterRegistry: FilterRegistry;
+    workspaceState: WorkspaceState;
+    connect: Connect;
+    auth: Auth;
+    canShareWorkspace: boolean;
+    private sanitizeDescription;
+    updateWorkspaceDescription(raw: string): void;
+    private setDescriptionFromSelectedWorkspace;
+    connectedCallback(): Promise<void>;
+    refreshSavedWorkspaces(): Promise<void>;
+    refreshSharedWorkspaces(): Promise<void>;
+    private notifyError;
+    saveWorkspace(): Promise<void>;
+    private applyWorkspace;
+    loadWorkspace(workspaceName: string): Promise<void>;
+    private requestSharedWorkspace;
+    loadSharedWorkspace(shared: {
+        id: string;
+        name: string;
+        userName: string;
+        createdOn?: string | number;
+        modifiedOn?: string | number;
+        data: string;
+    }): Promise<void>;
+    deleteWorkspace(workspaceName: string): Promise<void>;
+    private showDeleteConfirmation;
+    confirmDeleteWorkspace(workspaceName: string): void;
+    modifySharedWorkspace(sharedWorkspace: SharedWorkspace): Promise<void>;
+    deleteSharedWorkspace(sharedWorkspace: SharedWorkspace): Promise<void>;
+    confirmDeleteSharedWorkspace(sharedWorkspace: SharedWorkspace): void;
+    shareExistingWorkspace(workspaceName: string): Promise<void>;
+    openSaveDialog(): Promise<void>;
+    isWorkspaceExisting(workspaceName: string): boolean;
+    saveModeChanged(oldValue: string, newValue: string): void;
+    selectedWorkspaceToOverwriteChanged(oldValue: string, newValue: string): void;
+    openLoadDialog(): void;
+    closeSaveDialog(): void;
+    closeLoadDialog(): void;
+}
+
+/**
+ * @alpha
+ */
+export declare interface WorkspaceState {
+    saveWorkspace(workspaceName: string, layouts: SavedLayout[], grids: SavedGridSettings[], filters: SavedFilterValue[], description?: string): Promise<void>;
+    loadWorkspace(workspaceName: string): Promise<SavedWorkspace | null>;
+    getSavedWorkspaces(): Promise<SavedWorkspace[]>;
+    deleteWorkspace(workspaceName: string): Promise<void>;
+    getCurrentWorkspace(): SavedWorkspace | null;
+    setCurrentWorkspace(workspace: SavedWorkspace | null): void;
+}
+
+/**
+ * DI token for workspace state.
+ * @alpha
+ */
+export declare const WorkspaceState: InterfaceSymbol<WorkspaceState>;
+
+export { }

package/dist/tsconfig.tsbuildinfo

@@ -0,0 +1 @@
+{"root":["../src/index.ts","../src/workspace-components.ts","../src/workspace/filter-registry.ts","../src/workspace/grid-registry.ts","../src/workspace/index.ts","../src/workspace/layout-registry.ts","../src/workspace/workspace-state.ts","../src/workspace/workspace-state.types.ts","../src/workspace/workspace.types.ts","../src/workspace/grid-register/grid-register.template.ts","../src/workspace/grid-register/grid-register.ts","../src/workspace/grid-register/index.ts","../src/workspace/layout-wrapper/index.ts","../src/workspace/layout-wrapper/layout-wrapper.template.ts","../src/workspace/layout-wrapper/layout-wrapper.ts","../src/workspace-manager/index.ts","../src/workspace-manager/workspace-manager.styles.ts","../src/workspace-manager/workspace-manager.template.ts","../src/workspace-manager/workspace-manager.ts"],"version":"5.9.2"}

package/docs/.gitkeep

@@ -0,0 +1 @@
+

package/docs/api/foundation-workspace.defaultfilterregistry.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-workspace](./foundation-workspace.md) &gt; [DefaultFilterRegistry](./foundation-workspace.defaultfilterregistry.md)
+
+## DefaultFilterRegistry class
+
+> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+
+**Signature:**
+
+```typescript
+export declare class DefaultFilterRegistry implements FilterRegistry 
+```
+**Implements:** [FilterRegistry](./foundation-workspace.filterregistry.md)
+

package/docs/api/foundation-workspace.defaultgridregistry.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-workspace](./foundation-workspace.md) &gt; [DefaultGridRegistry](./foundation-workspace.defaultgridregistry.md)
+
+## DefaultGridRegistry class
+
+> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+
+**Signature:**
+
+```typescript
+export declare class DefaultGridRegistry implements GridRegistry 
+```
+**Implements:** [GridRegistry](./foundation-workspace.gridregistry.md)
+

package/docs/api/foundation-workspace.defaultlayoutregistry.md

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-workspace](./foundation-workspace.md) &gt; [DefaultLayoutRegistry](./foundation-workspace.defaultlayoutregistry.md)
+
+## DefaultLayoutRegistry class
+
+> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+Default layout registry implementation.
+
+**Signature:**
+
+```typescript
+export declare class DefaultLayoutRegistry implements LayoutRegistry 
+```
+**Implements:** [LayoutRegistry](./foundation-workspace.layoutregistry.md)
+

package/docs/api/foundation-workspace.defaultworkspacestate._constructor_.md

@@ -0,0 +1,65 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-workspace](./foundation-workspace.md) &gt; [DefaultWorkspaceState](./foundation-workspace.defaultworkspacestate.md) &gt; [(constructor)](./foundation-workspace.defaultworkspacestate._constructor_.md)
+
+## DefaultWorkspaceState.(constructor)
+
+> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+Constructs a new instance of the `DefaultWorkspaceState` class
+
+**Signature:**
+
+```typescript
+constructor(kvStorage: KVStorageType, auth: AuthType);
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+kvStorage
+
+
+</td><td>
+
+KVStorageType
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+auth
+
+
+</td><td>
+
+AuthType
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+

package/docs/api/foundation-workspace.defaultworkspacestate.auth.md

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-workspace](./foundation-workspace.md) &gt; [DefaultWorkspaceState](./foundation-workspace.defaultworkspacestate.md) &gt; [auth](./foundation-workspace.defaultworkspacestate.auth.md)
+
+## DefaultWorkspaceState.auth property
+
+> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+**Signature:**
+
+```typescript
+auth: AuthType;
+```

package/docs/api/foundation-workspace.defaultworkspacestate.kvstorage.md

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-workspace](./foundation-workspace.md) &gt; [DefaultWorkspaceState](./foundation-workspace.defaultworkspacestate.md) &gt; [kvStorage](./foundation-workspace.defaultworkspacestate.kvstorage.md)
+
+## DefaultWorkspaceState.kvStorage property
+
+> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+**Signature:**
+
+```typescript
+kvStorage: KVStorageType;
+```

package/docs/api/foundation-workspace.defaultworkspacestate.md

@@ -0,0 +1,115 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-workspace](./foundation-workspace.md) &gt; [DefaultWorkspaceState](./foundation-workspace.defaultworkspacestate.md)
+
+## DefaultWorkspaceState class
+
+> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+Default workspace persistence implementation backed by KVStorage.
+
+**Signature:**
+
+```typescript
+export declare class DefaultWorkspaceState implements WorkspaceState 
+```
+**Implements:** [WorkspaceState](./foundation-workspace.workspacestate.md)
+
+## Constructors
+
+<table><thead><tr><th>
+
+Constructor
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[(constructor)(kvStorage, auth)](./foundation-workspace.defaultworkspacestate._constructor_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(ALPHA)_** Constructs a new instance of the `DefaultWorkspaceState` class
+
+
+</td></tr>
+</tbody></table>
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[auth](./foundation-workspace.defaultworkspacestate.auth.md)
+
+
+</td><td>
+
+
+</td><td>
+
+AuthType
+
+
+</td><td>
+
+**_(ALPHA)_**
+
+
+</td></tr>
+<tr><td>
+
+[kvStorage](./foundation-workspace.defaultworkspacestate.kvstorage.md)
+
+
+</td><td>
+
+
+</td><td>
+
+KVStorageType
+
+
+</td><td>
+
+**_(ALPHA)_**
+
+
+</td></tr>
+</tbody></table>
+

package/docs/api/foundation-workspace.filterregistration.filterkey.md

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-workspace](./foundation-workspace.md) &gt; [FilterRegistration](./foundation-workspace.filterregistration.md) &gt; [filterKey](./foundation-workspace.filterregistration.filterkey.md)
+
+## FilterRegistration.filterKey property
+
+> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+**Signature:**
+
+```typescript
+filterKey: string;
+```

package/docs/api/foundation-workspace.filterregistration.getfiltervalue.md

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-workspace](./foundation-workspace.md) &gt; [FilterRegistration](./foundation-workspace.filterregistration.md) &gt; [getFilterValue](./foundation-workspace.filterregistration.getfiltervalue.md)
+
+## FilterRegistration.getFilterValue property
+
+> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+**Signature:**
+
+```typescript
+getFilterValue: () => SavedFilterValue | null;
+```