@genesislcap/foundation-workspace 14.406.0-workspaces.7

package/temp/api-report.md.api.md

@@ -0,0 +1,372 @@
+## API Report File for "@genesislcap/foundation-workspace"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+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 (undocumented)
+export class DefaultFilterRegistry implements FilterRegistry {
+    // (undocumented)
+    applyFiltersValues(filtersValues: SavedFilterValue[]): void;
+    // (undocumented)
+    getAllFiltersValues(): SavedFilterValue[];
+    // (undocumented)
+    registerFilter(filterKey: string, getFilterValue: () => SavedFilterValue | null, setFilterValue: (value: string) => void): void;
+    // (undocumented)
+    unregisterFilter(filterKey: string): void;
+}
+
+// @alpha (undocumented)
+export class DefaultGridRegistry implements GridRegistry {
+    // (undocumented)
+    applyAllGridsSettings(gridsSettings: SavedGridSettings[], maxRetries?: number, delayMs?: number): Promise<void>;
+    // (undocumented)
+    applyGridSettings(gridSetting: SavedGridSettings, options?: {
+        applyColumns?: boolean;
+        applyFilters?: boolean;
+    }): Promise<boolean>;
+    // (undocumented)
+    getAllGridsSettings(): SavedGridSettings[];
+    // (undocumented)
+    getGrid(gridKey: string): unknown;
+    // (undocumented)
+    registerGrid(gridKey: string, gridApi: unknown, columnApi: unknown): void;
+    // (undocumented)
+    unregisterGrid(gridKey: string): void;
+}
+
+// @alpha
+export class DefaultLayoutRegistry implements LayoutRegistry {
+    // (undocumented)
+    applySavedLayouts(savedLayouts: SavedLayout[]): Promise<void>;
+    // (undocumented)
+    getLayoutsConfigs(): SavedLayout[];
+    // (undocumented)
+    registerLayout(layoutKey: string, layout: any): void;
+    // (undocumented)
+    unregisterLayout(layoutKey: string): void;
+}
+
+// @alpha
+export class DefaultWorkspaceState implements WorkspaceState {
+    constructor(kvStorage: KVStorage, auth: Auth);
+    // (undocumented)
+    auth: Auth;
+    // (undocumented)
+    deleteWorkspace(workspaceName: string): Promise<void>;
+    // (undocumented)
+    getCurrentWorkspace(): SavedWorkspace | null;
+    // (undocumented)
+    getSavedWorkspaces(): Promise<SavedWorkspace[]>;
+    // (undocumented)
+    kvStorage: KVStorage;
+    // (undocumented)
+    loadWorkspace(workspaceName: string): Promise<SavedWorkspace | null>;
+    // (undocumented)
+    saveWorkspace(workspaceName: string, layouts: SavedLayout[], grids: SavedGridSettings[], filters: SavedFilterValue[], description?: string): Promise<void>;
+    // (undocumented)
+    setCurrentWorkspace(workspace: SavedWorkspace | null): void;
+}
+
+// @alpha (undocumented)
+export interface FilterRegistration {
+    // (undocumented)
+    filterKey: string;
+    // (undocumented)
+    getFilterValue: () => SavedFilterValue | null;
+    // (undocumented)
+    setFilterValue: (value: string) => void;
+}
+
+// @alpha (undocumented)
+export interface FilterRegistry {
+    // (undocumented)
+    applyFiltersValues(savedFilters: SavedFilterValue[]): void;
+    // (undocumented)
+    getAllFiltersValues(): SavedFilterValue[];
+    // (undocumented)
+    registerFilter(filterKey: string, getFilterValue: () => SavedFilterValue | null, setFilterValue: (value: string) => void): void;
+    // (undocumented)
+    unregisterFilter(filterKey: string): void;
+}
+
+// @alpha
+export const FilterRegistry: InterfaceSymbol<FilterRegistry>;
+
+// @alpha
+export class GridRegister extends HTMLElement {
+    // (undocumented)
+    connectedCallback(): void;
+    // (undocumented)
+    disconnectedCallback(): void;
+    // (undocumented)
+    gridKey: string;
+    // (undocumented)
+    gridRegistry: GridRegistry;
+    // (undocumented)
+    workspaceState: WorkspaceState;
+}
+
+// @alpha (undocumented)
+export interface GridRegistration {
+    // (undocumented)
+    columnApi: ColumnApi;
+    // (undocumented)
+    gridApi: GridApi;
+    // (undocumented)
+    gridKey: string;
+}
+
+// @alpha (undocumented)
+export interface GridRegistry {
+    // (undocumented)
+    applyAllGridsSettings(gridsSettings: SavedGridSettings[]): Promise<void>;
+    // (undocumented)
+    applyGridSettings(gridSetting: SavedGridSettings, options?: {
+        applyColumns?: boolean;
+        applyFilters?: boolean;
+    }): Promise<boolean>;
+    // (undocumented)
+    getAllGridsSettings(): SavedGridSettings[];
+    // (undocumented)
+    getGrid(gridKey: string): unknown;
+    // (undocumented)
+    registerGrid(gridKey: string, gridApi: unknown, columnApi: unknown): void;
+    // (undocumented)
+    unregisterGrid(gridKey: string): void;
+}
+
+// @alpha
+export const GridRegistry: InterfaceSymbol<GridRegistry>;
+
+// @alpha (undocumented)
+export interface LayoutRegistry {
+    // (undocumented)
+    applySavedLayouts(savedLayouts: SavedLayout[]): Promise<void>;
+    // (undocumented)
+    getLayoutsConfigs(): SavedLayout[];
+    // (undocumented)
+    registerLayout(layoutKey: string, layout: unknown): void;
+    // (undocumented)
+    unregisterLayout(layoutKey: string): void;
+}
+
+// @alpha
+export const LayoutRegistry: InterfaceSymbol<LayoutRegistry>;
+
+// @alpha
+export class LayoutWrapper extends HTMLElement {
+    // (undocumented)
+    connectedCallback(): void;
+    // (undocumented)
+    disconnectedCallback(): void;
+    // (undocumented)
+    layoutKey: string;
+    // (undocumented)
+    layoutRegistry: LayoutRegistry;
+}
+
+// @alpha
+export type LoadMode = 'MY' | 'SHARED';
+
+// @alpha (undocumented)
+export interface SavedFilterValue {
+    // (undocumented)
+    filterKey: string;
+    // (undocumented)
+    value: string;
+}
+
+// @alpha
+export interface SavedGridSettings {
+    // (undocumented)
+    columnState: any[];
+    // (undocumented)
+    gridKey: string;
+    // (undocumented)
+    savedAt: string;
+}
+
+// @alpha (undocumented)
+export interface SavedLayout {
+    // (undocumented)
+    layout: unknown;
+    // (undocumented)
+    layoutKey: string;
+}
+
+// @alpha (undocumented)
+export interface SavedWorkspace {
+    // (undocumented)
+    description?: string;
+    // (undocumented)
+    filters: SavedFilterValue[];
+    // (undocumented)
+    grids: SavedGridSettings[];
+    // (undocumented)
+    layouts: SavedLayout[];
+    // (undocumented)
+    name: string;
+    // (undocumented)
+    savedAt: string;
+    // (undocumented)
+    username: string;
+}
+
+// @alpha (undocumented)
+export interface SharedWorkspace {
+    // (undocumented)
+    createdOn?: string | number;
+    // (undocumented)
+    data: string;
+    // (undocumented)
+    description?: string;
+    // (undocumented)
+    id: string;
+    // (undocumented)
+    modifiedOn?: string | number;
+    // (undocumented)
+    name: string;
+    // (undocumented)
+    userName: string;
+}
+
+// @alpha
+export 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;
+};
+
+// @alpha
+export class WorkspaceManager extends FoundationElement {
+    // (undocumented)
+    applyingWorkspace: boolean;
+    // (undocumented)
+    auth: Auth;
+    // (undocumented)
+    canShareWorkspace: boolean;
+    // (undocumented)
+    closeLoadDialog(): void;
+    // (undocumented)
+    closeSaveDialog(): void;
+    // (undocumented)
+    confirmDeleteSharedWorkspace(sharedWorkspace: SharedWorkspace): void;
+    // (undocumented)
+    confirmDeleteWorkspace(workspaceName: string): void;
+    // (undocumented)
+    connect: Connect;
+    // (undocumented)
+    connectedCallback(): Promise<void>;
+    // (undocumented)
+    deleteSharedWorkspace(sharedWorkspace: SharedWorkspace): Promise<void>;
+    // (undocumented)
+    deleteWorkspace(workspaceName: string): Promise<void>;
+    // (undocumented)
+    dialogBoundary: HTMLElement;
+    // (undocumented)
+    filterRegistry: FilterRegistry;
+    // (undocumented)
+    gridRegistry: GridRegistry;
+    // (undocumented)
+    isLoading: boolean;
+    // (undocumented)
+    isWorkspaceExisting(workspaceName: string): boolean;
+    // (undocumented)
+    layoutRegistry: LayoutRegistry;
+    // (undocumented)
+    loadModal: Modal;
+    // (undocumented)
+    loadMode: LoadMode;
+    // (undocumented)
+    loadSharedWorkspace(shared: {
+        id: string;
+        name: string;
+        userName: string;
+        createdOn?: string | number;
+        modifiedOn?: string | number;
+        data: string;
+    }): Promise<void>;
+    // (undocumented)
+    loadWorkspace(workspaceName: string): Promise<void>;
+    // (undocumented)
+    modifySharedWorkspace(sharedWorkspace: SharedWorkspace): Promise<void>;
+    // (undocumented)
+    openLoadDialog(): void;
+    // (undocumented)
+    openSaveDialog(): Promise<void>;
+    // (undocumented)
+    refreshSavedWorkspaces(): Promise<void>;
+    // (undocumented)
+    refreshSharedWorkspaces(): Promise<void>;
+    // (undocumented)
+    savedWorkspaces: SavedWorkspace[];
+    // (undocumented)
+    saveModal: Modal;
+    // (undocumented)
+    saveMode: 'create' | 'overwrite' | 'shared';
+    // (undocumented)
+    saveModeChanged(oldValue: string, newValue: string): void;
+    // (undocumented)
+    saveWorkspace(): Promise<void>;
+    // (undocumented)
+    selectedWorkspaceToOverwrite: string;
+    // (undocumented)
+    selectedWorkspaceToOverwriteChanged(oldValue: string, newValue: string): void;
+    // (undocumented)
+    sharedWorkspaceDialogBoundary: HTMLElement;
+    // (undocumented)
+    sharedWorkspaces: SharedWorkspace[];
+    // (undocumented)
+    shareExistingWorkspace(workspaceName: string): Promise<void>;
+    // (undocumented)
+    updateWorkspaceDescription(raw: string): void;
+    // (undocumented)
+    workspaceDescription: string;
+    // (undocumented)
+    workspaceName: string;
+    // (undocumented)
+    workspaceState: WorkspaceState;
+    // (undocumented)
+    workspaceToShare: string;
+}
+
+// @alpha (undocumented)
+export interface WorkspaceState {
+    // (undocumented)
+    deleteWorkspace(workspaceName: string): Promise<void>;
+    // (undocumented)
+    getCurrentWorkspace(): SavedWorkspace | null;
+    // (undocumented)
+    getSavedWorkspaces(): Promise<SavedWorkspace[]>;
+    // (undocumented)
+    loadWorkspace(workspaceName: string): Promise<SavedWorkspace | null>;
+    // (undocumented)
+    saveWorkspace(workspaceName: string, layouts: SavedLayout[], grids: SavedGridSettings[], filters: SavedFilterValue[], description?: string): Promise<void>;
+    // (undocumented)
+    setCurrentWorkspace(workspace: SavedWorkspace | null): void;
+}
+
+// @alpha
+export const WorkspaceState: InterfaceSymbol<WorkspaceState>;
+
+// (No @packageDocumentation comment for this package)
+
+```

package/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "extends": "../../../tsconfig.json",
+  "compilerOptions": {
+    "declarationDir": "./dist/dts",
+    "outDir": "./dist/esm",
+    "rootDir": "./src"
+  },
+  "include": ["src/**/*"],
+  "exclude": ["src/**/*.test.ts", "src/__test__"]
+}
+