@powerhousedao/common 1.1.0

package/dist/editors/generic-drive-explorer/components/folder-view.d.ts

@@ -0,0 +1,16 @@
+import { BaseProps } from '../../utils';
+import { UiDriveNode, UiFolderNode, UiNode } from '@powerhousedao/design-system';
+interface IFolderViewProps extends BaseProps {
+    node: UiDriveNode | UiFolderNode;
+    isDropTarget: boolean;
+    onSelectNode: (uiNode: UiNode) => void;
+    onRenameNode: (name: string, uiNode: UiNode) => void;
+    onDuplicateNode: (uiNode: UiNode) => void;
+    onDeleteNode: (uiNode: UiNode) => void;
+    onAddFile: (file: File, parentNode: UiNode | null) => Promise<void>;
+    onCopyNode: (uiNode: UiNode, targetNode: UiNode) => Promise<void>;
+    onMoveNode: (uiNode: UiNode, targetNode: UiNode) => Promise<void>;
+    isAllowedToCreateDocuments: boolean;
+}
+export declare function FolderView(props: IFolderViewProps): import("react/jsx-runtime").JSX.Element;
+export default FolderView;

package/dist/editors/generic-drive-explorer/components/layout.d.ts

@@ -0,0 +1,11 @@
+import { BaseProps } from '../../utils';
+export declare function DriveLayout({ children, className, ...props }: BaseProps): import("react/jsx-runtime").JSX.Element;
+export declare namespace DriveLayout {
+    var Container: ({ children, className, containerProps, ...props }: BaseProps) => import("react/jsx-runtime").JSX.Element;
+    var Header: ({ children, className, containerProps, ...props }: BaseProps) => import("react/jsx-runtime").JSX.Element;
+    var Content: ({ children, className, containerProps, ...props }: BaseProps) => import("react/jsx-runtime").JSX.Element;
+    var ContentSection: ({ title, children, className, containerProps, ...props }: BaseProps & {
+        title?: string;
+    }) => import("react/jsx-runtime").JSX.Element;
+    var Footer: ({ children, className, containerProps, ...props }: BaseProps) => import("react/jsx-runtime").JSX.Element;
+}

package/dist/editors/generic-drive-explorer/components/search-bar.d.ts

@@ -0,0 +1 @@
+export declare const SearchBar: () => import("react/jsx-runtime").JSX.Element;

package/dist/editors/generic-drive-explorer/editor.d.ts

@@ -0,0 +1,4 @@
+import { EditorProps } from 'document-model/document';
+import { DocumentDriveAction, DocumentDriveLocalState, DocumentDriveState } from 'document-models/document-drive';
+export type IProps = EditorProps<DocumentDriveState, DocumentDriveAction, DocumentDriveLocalState>;
+export default function Editor(props: IProps): import("react/jsx-runtime").JSX.Element;

package/dist/editors/generic-drive-explorer/index.d.ts

@@ -0,0 +1,4 @@
+import { ExtendedEditor, EditorContextProps } from 'document-model-libs';
+import { DocumentDriveState, DocumentDriveAction, DocumentDriveLocalState } from '../../document-models/document-drive';
+export declare const module: ExtendedEditor<DocumentDriveState, DocumentDriveAction, DocumentDriveLocalState, EditorContextProps>;
+export default module;

package/dist/editors/generic-drive-explorer.d.ts

@@ -0,0 +1,6 @@
+export * from './generic-drive-explorer/index'
+export {}
+import _default from './generic-drive-explorer/index'
+export default _default
+export * from './generic-drive-explorer/index'
+export {}

package/dist/editors/hooks/index.d.ts

@@ -0,0 +1,3 @@
+export * from './useDriveActions';
+export * from './useDriveActionsWithUiNodes';
+export * from './useDriveContext';

package/dist/editors/hooks/useDriveActions.d.ts

@@ -0,0 +1,80 @@
+import { Document, EditorDispatch } from 'document-model/document';
+import { DocumentDriveAction, DocumentDriveDocument, Node } from 'document-models/document-drive';
+import { IDriveContext } from './useDriveContext';
+/**
+ * Actions for managing a document drive
+ */
+export interface IDriveActions {
+    /** The drive context provided by the host application */
+    context: IDriveContext;
+    /** Selects a node in the drive */
+    selectNode: (node: Node) => void;
+    /**
+     * Creates a new folder in the drive
+     * @param name - Name of the folder
+     * @param parentFolder - Optional ID of parent folder
+     * @param id - Optional custom ID for the folder
+     */
+    addFolder: (name: string, parentFolder?: string | null, id?: string) => Promise<void>;
+    /**
+     * Adds a file to the drive
+     * @param file - File to be added
+     * @param parentFolder - Optional ID of parent folder (defaults to selected folder)
+     * @param name - Optional custom name for the file
+     */
+    addFile: (file: File, parentFolder?: string, name?: string) => Promise<void>;
+    /**
+     * Creates a new document in the drive
+     * @param name - Name of the document
+     * @param documentType - Type of document to create
+     * @param document - Optional document content
+     * @param parentFolder - Optional ID of parent folder
+     * @param id - Optional custom ID for the document
+     */
+    addDocument: (name: string, documentType: string, document?: Document, parentFolder?: string, id?: string) => Promise<void>;
+    /**
+     * Deletes a node from the drive
+     * @param id - ID of the node to delete
+     */
+    deleteNode: (id: string) => Promise<void>;
+    /**
+     * Renames a node in the drive
+     * @param id - ID of the node to rename
+     * @param name - New name for the node
+     */
+    renameNode: (id: string, name: string) => Promise<void>;
+    /**
+     * Moves a node to a new parent folder
+     * @param sourceId - ID of the node to move
+     * @param targetId - ID of the target parent folder
+     */
+    moveNode: (sourceId: string, targetId: string) => Promise<void>;
+    /**
+     * Copies a node to a new location
+     * @param sourceId - ID of the node to copy
+     * @param targetFolderId - Optional ID of the target folder
+     */
+    copyNode: (sourceId: string, targetFolderId: string | undefined) => Promise<void>;
+    /**
+     * Creates a copy of a node in the same folder
+     * @param sourceId - ID of the node to duplicate
+     */
+    duplicateNode: (sourceId: string) => Promise<void>;
+}
+/**
+ * Hook that provides actions for managing a document drive
+ *
+ * @param document - The document drive document
+ * @param dispatch - Function to dispatch drive actions
+ * @param context - The drive context containing UI-related functions
+ * @returns Object containing drive management actions
+ *
+ * @example
+ * const {
+ *   addFolder,
+ *   addFile,
+ *   deleteNode,
+ *   moveNode
+ * } = useDriveActions(document, dispatch, driveContext);
+ */
+export declare function useDriveActions(document: DocumentDriveDocument, dispatch: EditorDispatch<DocumentDriveAction>, context: IDriveContext): IDriveActions;

package/dist/editors/hooks/useDriveActionsWithUiNodes.d.ts

@@ -0,0 +1,16 @@
+import { UiNode } from '@powerhousedao/design-system';
+import { EditorDispatch } from 'document-model/document';
+import { DocumentDriveAction, DocumentDriveDocument, Node } from 'document-models/document-drive';
+import { IDriveContext } from './useDriveContext';
+export declare function useDriveActionsWithUiNodes(document: DocumentDriveDocument, dispatch: EditorDispatch<DocumentDriveAction>): {
+    addFile: (file: File, parentNode: UiNode | null) => Promise<void>;
+    addFolder: (name: string, parentFolder?: string | undefined) => Promise<void>;
+    renameNode: (name: string, node: UiNode) => Promise<void>;
+    deleteNode: (node: UiNode) => Promise<void>;
+    moveNode: (src: UiNode, target: UiNode) => Promise<void>;
+    copyNode: (src: UiNode, target: UiNode) => Promise<void>;
+    duplicateNode: (node: UiNode) => Promise<void>;
+    context: IDriveContext;
+    selectNode: (node: Node) => void;
+    addDocument: (name: string, documentType: string, document?: import('document-model/document').Document, parentFolder?: string, id?: string) => Promise<void>;
+};

package/dist/editors/hooks/useDriveContext.d.ts

@@ -0,0 +1,57 @@
+import { DocumentModel } from 'document-model/document';
+import { Node } from 'document-models/document-drive';
+import { PropsWithChildren } from 'react';
+/**
+ * Interface representing the context values provided by the host application
+ * for managing document drive functionality.
+ */
+export interface IDriveContext {
+    /** Controls the visibility of the search bar in the drive interface */
+    showSearchBar: boolean;
+    /** Indicates whether the current user has permissions to create new documents */
+    isAllowedToCreateDocuments: boolean;
+    /** Array of available document models that can be created */
+    documentModels: DocumentModel[];
+    /** Currently selected node (file/folder) in the drive */
+    selectedNode: Node | null;
+    /**
+     * Callback to update the selected node in the drive
+     * @param node - The node to be selected
+     */
+    selectNode: (node: Node) => void;
+    /**
+     * Adds a new file to the drive
+     * @param file - File to be added (can be a string path or File object)
+     * @param drive - The drive to add the file to
+     * @param name - Optional name for the file
+     * @param parentFolder - Optional parent folder of the file
+     * @returns Promise resolving to the newly created Node
+     */
+    addFile: (file: string | File, drive: string, name?: string, parentFolder?: string) => Promise<Node>;
+    /**
+     * Shows a modal for creating a new document
+     * @param documentModel - Document model of the document to be created
+     * @returns Promise resolving to an object containing the document name
+     */
+    showCreateDocumentModal: (documentModel: DocumentModel) => Promise<{
+        name: string;
+    }>;
+}
+export declare const DriveContextProvider: React.FC<PropsWithChildren<{
+    value: IDriveContext;
+}>>;
+/**
+ * Hook to access the drive context values provided by the host application.
+ * Must be used within a DriveContextProvider component.
+ *
+ * @returns IDriveContext - Object containing drive-related values and functions
+ *
+ * @example
+ * const {
+ *   showSearchBar,
+ *   documentModels,
+ *   selectedNode,
+ *   addFile
+ * } = useDriveContext();
+ */
+export declare function useDriveContext(): IDriveContext;

package/dist/editors/hooks.d.ts

@@ -0,0 +1,2 @@
+export * from './hooks/index'
+export {}

package/dist/editors/index.d.ts

@@ -0,0 +1 @@
+export { module as GenericDriveExplorer } from './generic-drive-explorer';

package/dist/editors/utils/index.d.ts

@@ -0,0 +1,9 @@
+import { ClassValue } from 'clsx';
+export declare function cn(...inputs: ClassValue[]): string;
+export type BaseProps<T extends HTMLElement = HTMLDivElement> = {
+    className?: string;
+    style?: React.CSSProperties;
+    id?: string;
+    children?: React.ReactNode;
+    containerProps?: Omit<React.HTMLAttributes<T>, "className" | "style" | "id">;
+};

package/dist/editors/utils/storybook.d.ts

@@ -0,0 +1,12 @@
+import { Decorator, Meta } from '@storybook/react';
+import { DocumentStory, EditorStoryArgs, EditorStoryComponent, EditorStoryProps } from 'document-model-libs/utils';
+import { ExtendedState, PartialState } from 'document-model/document';
+import { DocumentDriveAction, DocumentDriveLocalState, DocumentDriveState } from 'document-models/document-drive';
+export declare function createDriveStory(Editor: EditorStoryComponent<DocumentDriveState, DocumentDriveAction, DocumentDriveLocalState>, initialState?: ExtendedState<PartialState<DocumentDriveState>, PartialState<DocumentDriveLocalState>>, additionalStoryArgs?: EditorStoryArgs<DocumentDriveState, DocumentDriveAction, DocumentDriveLocalState>, decorators?: Decorator<EditorStoryProps<DocumentDriveState, DocumentDriveAction, DocumentDriveLocalState>>[]): {
+    meta: Meta<typeof Editor>;
+    CreateDocumentStory: DocumentStory<DocumentDriveState, DocumentDriveAction, DocumentDriveLocalState>;
+};
+export declare function createDriveStoryWithUINodes(Editor: EditorStoryComponent<DocumentDriveState, DocumentDriveAction, DocumentDriveLocalState>, initialState?: ExtendedState<PartialState<DocumentDriveState>, PartialState<DocumentDriveLocalState>>, additionalStoryArgs?: EditorStoryArgs<DocumentDriveState, DocumentDriveAction, DocumentDriveLocalState>, decorators?: Decorator<EditorStoryProps<DocumentDriveState, DocumentDriveAction, DocumentDriveLocalState>>[]): {
+    meta: Meta<typeof Editor>;
+    CreateDocumentStory: DocumentStory<DocumentDriveState, DocumentDriveAction, DocumentDriveLocalState>;
+};

package/dist/editors/utils/uiNodes.d.ts

@@ -0,0 +1,6 @@
+import { UiDriveNode, UiNode } from '@powerhousedao/design-system';
+import { DocumentDriveDocument, Node } from 'document-models/document-drive';
+export declare function sortUiNodesByName(a: UiNode, b: UiNode): number;
+export declare function makeNodeSlugFromNodeName(name: string): string;
+export declare function makeUiNode(node: Node | undefined, drive: DocumentDriveDocument, withChildren: boolean): UiNode;
+export declare function makeUiDriveNode(drive: DocumentDriveDocument): UiDriveNode;

package/dist/editors/utils.d.ts

@@ -0,0 +1,2 @@
+export * from './utils/index'
+export {}

package/dist/editors.d.ts

@@ -0,0 +1,2 @@
+export * from './editors/index'
+export {}