@vuu-ui/vuu-utils 2.0.0 → 2.1.0-alpha.10

package/types/data-editing/EditTracker.d.ts

@@ -0,0 +1,24 @@
+import { DataSource } from "@vuu-ui/vuu-data-types";
+import type { VuuRowDataItemType, VuuTable } from "@vuu-ui/vuu-protocol-types";
+import { EventEmitter } from "../event-emitter";
+export type EditState = "clean" | "dirty";
+type EditTrackerEvents = {
+    editState: (editState: EditState) => void;
+};
+export declare class EditTracker extends EventEmitter<EditTrackerEvents> {
+    #private;
+    get active(): boolean;
+    set active(isActive: boolean);
+    get editCount(): number;
+    set editCount(val: number);
+    set dataSource(ds: DataSource);
+    clear(): void;
+    enterEditMode(): Promise<VuuTable | undefined>;
+    get inEditMode(): boolean;
+    get editState(): EditState;
+    cancelChanges(): Promise<import("@vuu-ui/vuu-protocol-types").RpcResultSuccess | import("@vuu-ui/vuu-protocol-types").RpcResultError | undefined>;
+    saveChanges(): Promise<import("@vuu-ui/vuu-protocol-types").RpcResultSuccess | import("@vuu-ui/vuu-protocol-types").RpcResultError | undefined>;
+    edit(key: string, columnName: string, originalValue: VuuRowDataItemType, newValue: VuuRowDataItemType): void;
+    commit(key: string, columnName: string): Promise<import("@vuu-ui/vuu-protocol-types").RpcResultSuccess | import("@vuu-ui/vuu-protocol-types").RpcResultError | undefined>;
+}
+export {};

package/types/data-editing/useEditableTable.d.ts

@@ -0,0 +1,26 @@
+import { VuuTable } from "@vuu-ui/vuu-protocol-types";
+import { EditTracker } from "./EditTracker";
+import { DataSource } from "@vuu-ui/vuu-data-types";
+export type EditMode = "edit" | "view";
+export interface EditableTableHookProps {
+    /**
+     * columns to be included in subscription. If not provided,
+     * default will be '*'. Ignored if dataSource prop present.
+     */
+    columns?: string[];
+    dataSource?: DataSource;
+    isEditMode: boolean;
+    onCancel: () => void;
+    onSave: () => void;
+    /**
+     * If dataSource nor provided, new DataSource
+     * will be created using table and columns
+     */
+    table: VuuTable;
+}
+export declare const useEditableTable: ({ columns, dataSource: dataSourceProp, isEditMode, onCancel, onSave, table, }: EditableTableHookProps) => {
+    dataSource: DataSource;
+    editTracker: EditTracker;
+    onCancel: () => void;
+    onSave: () => Promise<void>;
+};

package/types/index.d.ts

@@ -12,6 +12,10 @@ export * from "./common-types";
 export * from "./component-registry";
 export * from "./cookie-utils";
 export * from "./css-utils";
+export { EditButtons, type EditButtonProps } from "./data-editing/EditButtons";
+export { DataEditingProvider, useEditTracker, } from "./data-editing/DataEditingProvider";
+export { EditTracker, type EditState } from "./data-editing/EditTracker";
+export { useEditableTable } from "./data-editing/useEditableTable";
 export * from "./data-utils";
 export * from "./datasource/BaseDataSource";
 export * from "./datasource/datasource-action-utils";
@@ -62,7 +66,7 @@ export * from "./url-utils";
 export * from "./useId";
 export * from "./useLayoutEffectSkipFirst";
 export * from "./user-types";
-export { WidthHeight, WidthOnly, useResizeObserver, type measurements, type ResizeHandler, } from "./useResizeObserver";
+export { useResizeObserver, WidthHeight, WidthOnly, type measurements, type ResizeHandler, } from "./useResizeObserver";
 export * from "./useStateRef";
 /** Context declarations hosted in utils to minimize intra package dependencies */
 export { DataContext } from "./context-definitions/DataContext";
@@ -71,3 +75,4 @@ export { DataSourceProvider, useDataSource, } from "./context-definitions/DataSo
 export * from "./context-definitions/WorkspaceContext";
 export { PageVisibilityObserver } from "./PageVisibilityObserver";
 export * from "./ShellContext";
+export { ThemeLoadChecker } from "./theme-utils";

package/types/theme-utils.d.ts

@@ -0,0 +1,14 @@
+import { ReactNode } from "react";
+/**
+ * Checks that a theme is loaded by making sure a known css variable
+ * returns a value. Not normally needed except for cases where a theme
+ * is loaded dynamically on startup and there may be components that
+ * may fail if theme is not in place (eg component that rely on taking dom
+ * measurements).
+ * Used by Showcase.
+ */
+export declare const ThemeLoadChecker: ({ children, cssToken, theme, }: {
+    children: ReactNode;
+    cssToken?: string;
+    theme: string;
+}) => ReactNode;

package/types/url-utils.d.ts

@@ -1,2 +1,3 @@
-export declare const getUrlParameter: (paramName: string, defaultValue?: string) => string | undefined;
+export declare function getUrlParameter(paramName: string): string | undefined;
+export declare function getUrlParameter(paramName: string, defaultValue: string): string;
 export declare const hasUrlParameter: (paramName: string) => boolean;