@buerli.io/react-cad 0.0.23-beta.4 → 0.0.24-beta.1

package/build/components/UI/CAD/{SideBar/Constraints.d.ts → Constraints.d.ts}

@@ -1,6 +1,12 @@
 import React from 'react';
 import 'antd/dist/antd.css';
 import { DrawingID } from '@buerli.io/core';
+/**
+ * Shows list of 3d constraints which are contained by currentProduct.
+ *
+ * @param drawingId - id of a drawing in which currentProduct will be found.
+ * @returns
+ */
 export declare const Constraints: React.FC<{
     drawingId: DrawingID;
 }>;

package/build/components/UI/CAD/Drawing.d.ts

@@ -1,9 +1,16 @@
 import { DrawingID } from '@buerli.io/core';
 import 'antd/dist/antd.css';
 import React from 'react';
+/**
+ * Component which provides convenient UI for working with models which is loaded to existing drawing.
+ * It includes ModelTree, Constraints and Solids components and toolbar for creating new features/3dconstraints
+ * Drawing doesn't contain canvas component, so all graphics should be provided as children.
+ *
+ * @param drawingId - id of an existing drawing.
+ * @param Menu - you can pass custom file menu which will be shown at the left top corner.
+ */
 export declare const Drawing: React.FC<{
     drawingId: DrawingID;
     Menu?: JSX.Element;
-    onFirstRender?: () => void;
     children?: React.ReactNode;
 }>;

package/build/components/UI/CAD/ModelTree/ModelTree.d.ts

@@ -0,0 +1,13 @@
+import { DrawingID } from '@buerli.io/core';
+import React from 'react';
+/**
+ * Component which shows structure of model.
+ * In part mode a list of part features is shown. In assembly mode a tree of assembly nodes is shown.
+ * It checks root and currentProduct to understand which mode is currently enabled. Check useEditMode hook for more details.
+ *
+ * @param drawingId
+ * @returns
+ */
+export declare const ModelTree: React.FC<{
+    drawingId: DrawingID;
+}>;

package/build/components/UI/CAD/{SideBar/AssemblyTree/AssemblyTreeHeader.d.ts → ModelTree/ModelTreeHeader.d.ts}

@@ -1,7 +1,7 @@
 import { DrawingID } from '@buerli.io/core';
 import React from 'react';
 /**
- * The assembly tree header.
+ * The model tree header.
  *
  * Responsibility:
  * - Show name of current node
@@ -10,6 +10,6 @@ import React from 'react';
  *      - Provide convert to template functionality
  *      - Provide import/add functionality
  */
-export declare const AssemblyTreeHeader: React.FC<{
+export declare const ModelTreeHeader: React.FC<{
     drawingId: DrawingID;
 }>;

package/build/components/UI/CAD/ModelTree/index.d.ts

@@ -0,0 +1 @@
+export { ModelTree } from './ModelTree';

package/build/components/UI/CAD/{SideBar/AssemblyTree → ModelTree}/useMenuItems.d.ts

@@ -1,5 +1,5 @@
 import React from 'react';
 import 'antd/dist/antd.css';
 import { DrawingID, ObjectID } from '@buerli.io/core';
-import { MenuItems } from '../../common/Menu';
+import { MenuItems } from '../common/Menu';
 export declare function useMenuItems(drawingId: DrawingID, objectId: ObjectID, setRename: React.Dispatch<React.SetStateAction<boolean>>): MenuItems;

package/build/components/UI/CAD/Solids/Solids.d.ts

@@ -0,0 +1,11 @@
+import React from 'react';
+import { DrawingID } from '@buerli.io/core';
+/**
+ * Shows list of solids which are contained by currentProduct.
+ *
+ * @param drawingId - id of a drawing in which currentProduct will be found.
+ * @returns
+ */
+export declare const Solids: React.FC<{
+    drawingId: DrawingID;
+}>;

package/build/components/UI/CAD/{SideBar/Solids → Solids}/useMenuItems.d.ts

@@ -1,4 +1,4 @@
 import React from 'react';
 import 'antd/dist/antd.css';
-import { MenuItems } from '../../common/Menu';
+import { MenuItems } from '../common/Menu';
 export declare function useMenuItems(setEditName: React.Dispatch<React.SetStateAction<boolean>>): MenuItems;

package/build/components/UI/CAD/ViewOptionsBar/ViewOptionButtons.d.ts

@@ -1,6 +1,3 @@
 import React from 'react';
 import 'antd/dist/antd.css';
-import { DrawingID } from '@buerli.io/core';
-export declare const ViewOptionButtons: React.FC<{
-    drawingId: DrawingID;
-}>;
+export declare const ViewOptionButtons: React.FC;

package/build/components/UI/CAD/ViewOptionsBar/useOptionCommands.d.ts

@@ -1,11 +1,4 @@
-import { DrawingID } from '@buerli.io/core';
-export declare const useOptionCommands: (drawingId: DrawingID) => ({
-    label: string;
-    icon: JSX.Element;
-    command: () => void;
-    isChecked?: undefined;
-    isDisabled?: undefined;
-} | {
+export declare const useOptionCommands: () => ({
     label: string;
     icon: JSX.Element;
     isChecked: boolean;

package/build/components/UI/CAD/common/Menu.d.ts

@@ -13,6 +13,17 @@ export declare type SubMenuItem = {
     children: Record<string, MenuItem>;
 };
 export declare type MenuItems = Record<string, MenuItem | SubMenuItem>;
+/**
+ * Context menu. By default it's rendered as thee dots "...", when user hovers it the menuitems is shown.
+ * It's possible to show an icon instead of "..." - just render an icon you whant to show as a Menu child.
+ *
+ * If you want to have nested level of menu items you need to fill children prop of a menu item with SubMenuItems (check src/components/UI/CAD/plugin/ProductManagement/useMenuItems.tsx:"export")
+ *
+ * @param items - Object contains items you whant to show in the menu. An item should contain caption and callback, it also migh has optional props: icon and children.
+ * @param children - Any component which will be shown as a button which opens menu, if no children passed three dots "..." are shown.
+ * @param DropDownProps - Since Menu is implemented using DropDown from "antd" you can pass any of DropDown props (except 'overltay') to customize the menu.
+ * @returns
+ */
 export declare const Menu: React.FC<Omit<{
     items: MenuItems;
 } & DropDownProps, 'overlay'>>;

package/build/components/UI/CAD/hooks/index.d.ts

@@ -3,6 +3,7 @@ export { useRoot } from './useRoot';
 export { useCurrentProduct } from './useCurrentProduct';
 export { useCurrentNode } from './useCurrentNode';
 export { useEditMode, EditMode } from './useEditMode';
+export { useMenuItems } from './useMenuItems';
 export { useObjectDetails } from './useObjectDetails';
 export { useOperationSequence } from './useOperationSequence';
 export { useRollbackBar } from './useRollbackBar';

package/build/components/UI/CAD/{SideBar/FeatureList → hooks}/useMenuItems.d.ts

@@ -1,5 +1,5 @@
 import React from 'react';
 import { DrawingID, ObjectID } from '@buerli.io/core';
 import 'antd/dist/antd.css';
-import { MenuItems } from '../../common/Menu';
+import { MenuItems } from '../common/Menu';
 export declare function useMenuItems(drawingId: DrawingID, featureId: ObjectID, isActive: boolean, setEditName: React.Dispatch<React.SetStateAction<boolean>>): MenuItems;

package/build/components/UI/CAD/index.d.ts

@@ -1,8 +1,13 @@
-export { CAD } from './CAD';
+export { Constraints } from './Constraints';
 export { Drawing } from './Drawing';
+export { Messages } from './Messages';
+export { ModelTree } from './ModelTree';
+export { FeaturePlugin, GlobalPlugins } from './PluginsWindows';
 export { SideBar } from './SideBar';
-export { FeatureList } from './SideBar/FeatureList';
-export { AssemblyTree } from './SideBar/AssemblyTree';
+export { Solids } from './Solids';
+export { ToolBar } from './ToolBar';
+export { ViewOptionButtons } from './ViewOptionsBar/ViewOptionButtons';
+export { ViewPlugButtons } from './ViewPlugButtons';
 export { Menu } from './common/Menu';
 export type { MenuItem, MenuItems } from './common/Menu';
 export * from './store/CADStore';

package/build/components/UI/CAD/plugins/ProductManagement/index.d.ts

@@ -1,5 +1,8 @@
 import { PluginDescription } from '@buerli.io/core';
 import { Root } from './Root';
 import { View } from './View';
+/**
+ * ProductManagement plugin is responsible for showing/creation/deletion parts and assemblies
+ */
 declare const description: PluginDescription;
 export { Root, View, description };

package/build/components/UI/CAD/store/CADStore.d.ts

@@ -12,6 +12,9 @@ export declare type CADStateT = {
     api: ReturnType<typeof appApi>;
 };
 declare const CADApi: import("zustand").StoreApi<CADStateT>;
+/**
+ * We need separate store for CAD components. It might contain auxiliary information like stack of current products or camera api.
+ */
 declare const useCADStore: import("zustand").UseStore<CADStateT>;
 declare const getCADState: GetState<CADStateT>;
 export { useCADStore, CADApi, getCADState };

package/build/components/UI/Readfile.d.ts

@@ -1,5 +1,6 @@
-export default function Readfile({ el: El, singleDrawingApp, children, ...props }: {
-    el: any;
+import React from 'react';
+declare type Props = {
     singleDrawingApp?: boolean;
-    children: any;
-}): JSX.Element;
+};
+declare const Readfile: React.ForwardRefExoticComponent<Props & React.RefAttributes<any>>;
+export default Readfile;

package/build/components/UI/editors/useParam.d.ts

@@ -1,4 +1,17 @@
-import { MemberParam } from 'src/types';
+import { MemberParam } from '../../../types';
+/**
+ * Wrapper for a parameter which will be used in an editor.
+ * @param param - an object which should contain next props:
+ * {
+ *   userValue - value shown for the user
+ *   setUserValue - userValue setter
+     defaults - default value
+     isChanged - function shows whether value is changed or not
+ * }
+ * @param getServValue - if value should be converted (e.g. deg -> rad) pass this function, it will be called right before classCAD API call.
+ * @param validation - Custom validation (used in useMateParam, useRefsParam. - these params has an array in userValue, so we need to apply validateF for each element from array).
+ * @returns
+ */
 export declare function useParam<T>(param: Omit<MemberParam<T>, 'serverValue' | 'validator' | 'setValidator'>, getServValue?: (x: T) => T, validation?: {
     validator: () => string[];
     setValidator: (...args: any[]) => void;

package/build/components/utils/CompValidation/validators/{AssemblyTreeValidator.d.ts → ModelTreeValidator.d.ts}

@@ -1,11 +1,11 @@
 import React from 'react';
 import { DrawingID } from '@buerli.io/core';
 /**
- * Validator for AssemblyTree component. Checks drawing existance.
+ * Validator for ModelTree component. Checks drawing existance.
  *
  * @param drawingId
  * @returns
  */
-export declare const AssemblyTreeValidator: React.FC<{
+export declare const ModelTreeValidator: React.FC<{
     drawingId: DrawingID;
 }>;