@evenicanpm/portal-editor-ui 1.4.1 → 1.5.0

package/{src/editor.tsx → dist/editor.d.ts}

@@ -1,13 +1,11 @@
 import type { PropsWithChildren } from "react";
 import { Editor } from "./features/editor/components/editor";
-
 /**
  * Main Entry point properties into portal package
  *
  *
  */
 type PortalProps = {};
-
 /**
  * The main **e4Portal** entry point.
  * * This is a React Functional Component that provides the core context
@@ -18,17 +16,15 @@ type PortalProps = {};
  * @param props - The properties passed to the Portal component.
  * @returns A React Element rendering the main application structure.
  */
-const Portal = ({ children }: PropsWithChildren<PortalProps>) => {
-	return <>{children}</>;
+declare const Portal: {
+    ({ children }: PropsWithChildren<PortalProps>): import("react").JSX.Element;
+    /**
+     *
+     * # Feature: Editor
+     * This is the editor feature component.
+     * @params props
+     *
+     */
+    Editor: typeof Editor;
 };
-
-/**
- *
- * # Feature: Editor
- * This is the editor feature component.
- * @params props
- *
- */
-Portal.Editor = Editor;
-
 export { Portal, type PortalProps };

package/dist/features/editor/components/column-list/column-card/column-card-options.d.ts

@@ -0,0 +1,9 @@
+export type ColumnCardOptionsValue = {
+    isSortable: boolean;
+    isSearchable: boolean;
+};
+export type ColumnCardOptionsProps = {
+    value: ColumnCardOptionsValue;
+    onChange: (patch: Partial<ColumnCardOptionsValue>) => void;
+};
+export declare function ColumnCardOptions({ value, onChange, }: Readonly<ColumnCardOptionsProps>): import("react").JSX.Element;

package/dist/features/editor/components/column-list/column-card/column-card-title.d.ts

@@ -0,0 +1,4 @@
+export type ColumnCardTitleProps = {
+    value: string;
+};
+export declare function ColumnCardTitle({ value }: Readonly<ColumnCardTitleProps>): import("react").JSX.Element;

package/dist/features/editor/components/column-list/column-card/column-card.d.ts

@@ -0,0 +1,8 @@
+import type { Column } from "@evenicanpm/portal-types-schemas";
+import * as React from "react";
+export type ColumnCardProps = {
+    field: Column;
+    onChange: (id: string, patch: Partial<Column>) => void;
+    onRemove: (id: string) => void;
+};
+export declare function ColumnCard({ field, onChange, onRemove, }: Readonly<ColumnCardProps>): React.JSX.Element;

package/dist/features/editor/components/column-list/column-card/drag-handle.d.ts

@@ -0,0 +1,6 @@
+import type { DraggableAttributes, DraggableSyntheticListeners } from "@dnd-kit/core";
+export type DragHandleProps = {
+    attributes: DraggableAttributes;
+    listeners?: DraggableSyntheticListeners;
+};
+export declare function DragHandle({ attributes, listeners, }: Readonly<DragHandleProps>): import("react").JSX.Element;

package/dist/features/editor/components/column-list/column-card/editable-label.d.ts

@@ -0,0 +1,11 @@
+import * as React from "react";
+export type EditableLabelProps = {
+    value: string;
+    onCommit: (next: string) => void;
+    labelPrefix?: string;
+    inputWidth?: {
+        xs: string | number;
+        sm: string | number;
+    };
+};
+export declare function EditableLabel({ value, onCommit, labelPrefix, inputWidth, }: Readonly<EditableLabelProps>): React.JSX.Element;

package/dist/features/editor/components/column-list/column-list-section.d.ts

@@ -0,0 +1,12 @@
+import type { EditorQueries } from "../editor";
+interface ColumnProps {
+    currentResourceKey: string;
+    editorQueries: EditorQueries;
+}
+/**
+ * The view config column list section that handles
+ * fetching the initial view config data thats stored in the db
+ * and handles loading state skeleton view while data is pending
+ */
+export declare function ColumnListSection({ currentResourceKey, editorQueries, }: Readonly<ColumnProps>): import("react").JSX.Element;
+export {};

package/dist/features/editor/components/column-list/column-list-skeleton.d.ts

@@ -0,0 +1 @@
+export declare function ColumnListSkeleton(): import("react").JSX.Element;

package/dist/features/editor/components/column-list/column-list-state.d.ts

@@ -0,0 +1,33 @@
+import type { Column } from "@evenicanpm/portal-types-schemas";
+/**
+ * Reassigns sequential ColumnOrder values (1..n) to visible fields.
+ */
+export declare function normalizeVisibleOrders(list: Column[]): Column[];
+/**
+ * Returns fields that are currently visible (ColumnOrder not null),
+ * sorted by ColumnOrder.
+ */
+export declare function getVisibleFields(fields: Column[]): Column[];
+/**
+ * Returns fields that are currently removed (ColumnOrder null),
+ * sorted alphabetically by label or data key.
+ */
+export declare function getRemovedFields(fields: Column[]): Column[];
+/**
+ * Applies a partial update to a single field by id.
+ */
+export declare function patchField(fields: Column[], id: string, patch: Partial<Column>): Column[];
+/**
+ * Removes a field from the visible list by setting ColumnOrder to null
+ * and re-normalizes remaining visible fields.
+ */
+export declare function removeField(fields: Column[], id: string): Column[];
+/**
+ * Adds a previously removed field back to the end of the visible list
+ * and re-normalizes ordering.
+ */
+export declare function addFieldToEnd(fields: Column[], id: string): Column[];
+/**
+ * Reorders visible fields after a drag operation and updates ColumnOrder.
+ */
+export declare function reorderVisibleFields(fields: Column[], activeId: string, overId: string, arrayMoveFn: <T>(array: T[], from: number, to: number) => T[]): Column[];

package/dist/features/editor/components/column-list/column-list-title.d.ts

@@ -0,0 +1,5 @@
+interface Props {
+    selectedResourceKey: string;
+}
+export declare function ColumnListTitle({ selectedResourceKey }: Readonly<Props>): import("react").JSX.Element;
+export {};

package/dist/features/editor/components/column-list/column-list.d.ts

@@ -0,0 +1,8 @@
+import type { ViewConfig } from "@evenicanpm/portal-types-schemas";
+import type { EditorQueries } from "../editor";
+export type ColumnListProps = {
+    resourceKey: string;
+    initialState: ViewConfig;
+    editorQueries: EditorQueries;
+};
+export declare function ColumnList({ resourceKey, initialState, editorQueries, }: Readonly<ColumnListProps>): import("react").JSX.Element;

package/dist/features/editor/components/editor-dms-card.d.ts

@@ -0,0 +1,14 @@
+interface Props {
+    /** Currently selected resource */
+    selectedResourceKey: string;
+    /** A pojo with providers -> images */
+    providerImageMap: Record<string, string>;
+    /** A pojo with resources -> providers */
+    resourceProviderMap: Record<string, string>;
+}
+/**
+ * Editor view header contains provider details and other
+ * resource/view config data not related to the column list.
+ */
+export declare function EditorDMSCard({ selectedResourceKey, providerImageMap, resourceProviderMap, }: Readonly<Props>): import("react").JSX.Element;
+export {};

package/dist/features/editor/components/editor-tabs.d.ts

@@ -0,0 +1,13 @@
+interface Props {
+    /** List of resource keys to select from */
+    resourceList: string[];
+    /** Currently selected key */
+    selectedResourceKey: string;
+    /** Action to take when resource changes. */
+    handleChangeResource: (id: string) => void;
+}
+/**
+ * Tab-based selection menu for resource keys on the editor page.
+ */
+declare function EditorResourceTabs({ resourceList, selectedResourceKey, handleChangeResource, }: Readonly<Props>): import("react").JSX.Element;
+export { EditorResourceTabs };

package/dist/features/editor/components/editor.d.ts

@@ -0,0 +1,28 @@
+import type { ViewConfig } from "@evenicanpm/portal-types-schemas";
+import type { QueryKey } from "@tanstack/react-query";
+export type SaveInput = {
+    key: string;
+    viewConfig: ViewConfig;
+};
+export type ViewConfigQuery = (resourceKey: string) => {
+    queryKey: QueryKey;
+    queryFn: () => Promise<ViewConfig>;
+};
+export type SaveViewConfigMutation = (resourceKey: string) => {
+    mutationKey: QueryKey;
+    mutationFn: (input: SaveInput) => Promise<ViewConfig>;
+};
+export type EditorQueries = {
+    viewConfigQuery: ViewConfigQuery;
+    saveViewConfigMutation: SaveViewConfigMutation;
+};
+export interface EditorProps {
+    resourceList: string[];
+    providerMetaData: Record<string, string>;
+    resourceProviderMap: Record<string, string>;
+    editorQueries: EditorQueries;
+}
+/**
+ * Top-Level editor component.
+ */
+export declare function Editor({ resourceList, providerMetaData, resourceProviderMap, editorQueries, }: Readonly<EditorProps>): import("react").JSX.Element;

package/{src/index.ts → dist/index.d.ts}

@@ -1,3 +1,2 @@
 export { Portal, type PortalProps } from "./editor";
-
 export { Editor } from "./features/editor";