@xyo-network/react-payload-plugin 6.0.0 → 6.1.0

package/dist/browser/index.d.ts

@@ -0,0 +1,87 @@
+import { AvatarProps, CardProps, CardActionAreaProps, CardContentProps, CardHeaderProps, MenuItemProps, MenuListProps, TableCellProps } from '@mui/material';
+import React, { ComponentType } from 'react';
+import { FlexBoxProps } from '@xylabs/react-flexbox';
+import { Payload } from '@xyo-network/payload-model';
+import { ListMode } from '@xyo-network/react-shared';
+
+interface PayloadRenderProps<T extends Payload = Payload> {
+    payload?: T;
+}
+interface PayloadDetailsRenderProps extends PayloadRenderProps {
+    active?: boolean;
+}
+interface PayloadDetailsListRenderProps extends PayloadDetailsRenderProps {
+    listMode?: ListMode;
+    visibleRows?: number;
+}
+interface PayloadEditorRenderProps extends PayloadDetailsRenderProps {
+    onChange?: (payload: Payload) => boolean;
+}
+interface PayloadRenderPluginBase {
+    canRender: (payload?: Payload) => boolean;
+    name: string;
+}
+interface PayloadRenderPluginCardComponents {
+    actionArea: ComponentType<PayloadRenderProps & CardActionAreaProps>;
+    content: ComponentType<PayloadRenderProps & CardContentProps>;
+    header: ComponentType<PayloadRenderProps & CardHeaderProps>;
+}
+interface PayloadRenderPluginAvatarComponents {
+    image: ComponentType<PayloadRenderProps & AvatarProps>;
+}
+interface PayloadRenderPluginTableComponents {
+    cell: ComponentType<PayloadRenderProps & TableCellProps>;
+}
+interface PayloadRenderPluginMenuComponents {
+    item: ComponentType<PayloadRenderProps & MenuItemProps>;
+    list: ComponentType<PayloadRenderProps & MenuListProps>;
+}
+interface PayloadRenderPluginBoxComponents {
+    /** @deprecated - use detailsBox  */
+    details?: ComponentType<PayloadDetailsRenderProps & FlexBoxProps>;
+    detailsBox: ComponentType<PayloadDetailsRenderProps & FlexBoxProps>;
+    detailsCard?: ComponentType<PayloadDetailsRenderProps & CardProps>;
+    editor: ComponentType<PayloadEditorRenderProps & FlexBoxProps>;
+    listModes?: ListMode[];
+}
+interface PayloadRenderPluginComponents {
+    avatar: PayloadRenderPluginAvatarComponents;
+    box: PayloadRenderPluginBoxComponents;
+    card: PayloadRenderPluginCardComponents;
+    table: PayloadRenderPluginTableComponents;
+}
+interface PayloadRenderPluginComponentsConfig {
+    avatar?: Partial<PayloadRenderPluginAvatarComponents>;
+    box?: Partial<PayloadRenderPluginBoxComponents>;
+    card?: Partial<PayloadRenderPluginCardComponents>;
+    menu?: Partial<PayloadRenderPluginMenuComponents>;
+    table?: Partial<PayloadRenderPluginTableComponents>;
+}
+interface PayloadRenderPlugin extends PayloadRenderPluginBase {
+    components: PayloadRenderPluginComponents;
+}
+interface PayloadRenderPluginConfig extends PayloadRenderPluginBase {
+    components?: PayloadRenderPluginComponentsConfig;
+}
+
+declare const PayloadAvatar: React.FC<PayloadRenderProps & AvatarProps>;
+
+declare const PayloadCardActionArea: React.FC<PayloadRenderProps & CardActionAreaProps>;
+
+declare const PayloadCardContent: React.FC<PayloadRenderProps & CardContentProps>;
+
+declare const PayloadCardHeader: React.FC<PayloadRenderProps & CardHeaderProps>;
+
+declare const PayloadDetailsBox: React.FC<PayloadRenderProps & FlexBoxProps>;
+//# sourceMappingURL=PayloadDetailsBox.d.ts.map
+
+declare const PayloadEditorBox: React.FC<PayloadEditorRenderProps & FlexBoxProps>;
+
+declare const PayloadTableCell: React.FC<PayloadRenderProps & TableCellProps>;
+
+declare const createPayloadRenderPlugin: (plugin: PayloadRenderPluginConfig) => PayloadRenderPlugin;
+
+declare const DefaultPayloadRenderPlugin: PayloadRenderPlugin;
+
+export { DefaultPayloadRenderPlugin, PayloadAvatar, PayloadCardActionArea, PayloadCardContent, PayloadCardHeader, PayloadDetailsBox, PayloadEditorBox, PayloadTableCell, createPayloadRenderPlugin };
+export type { PayloadDetailsListRenderProps, PayloadDetailsRenderProps, PayloadEditorRenderProps, PayloadRenderPlugin, PayloadRenderPluginAvatarComponents, PayloadRenderPluginBase, PayloadRenderPluginBoxComponents, PayloadRenderPluginCardComponents, PayloadRenderPluginComponents, PayloadRenderPluginComponentsConfig, PayloadRenderPluginConfig, PayloadRenderPluginMenuComponents, PayloadRenderPluginTableComponents, PayloadRenderProps };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/react-payload-plugin",
-  "version": "6.0.0",
+  "version": "6.1.0",
   "description": "Common React library for all XYO projects that use React",
   "keywords": [
     "xyo",
@@ -28,22 +28,22 @@
   "exports": {
     ".": {
       "browser": {
-        "types": "./dist/types/index.d.ts",
+        "types": "./dist/browser/index.d.ts",
         "default": "./dist/browser/index.mjs"
       },
-      "types": "./dist/types/index.d.ts",
+      "types": "./dist/browser/index.d.ts",
       "default": "./dist/browser/index.mjs"
     },
     "./package.json": "./package.json"
   },
   "module": "dist/browser/index.mjs",
-  "types": "dist/types/index.d.ts",
+  "types": "dist/browser/index.d.ts",
   "dependencies": {
-    "@xylabs/react-flexbox": "^6.3.7",
-    "@xylabs/react-identicon": "^6.3.7",
-    "@xyo-network/payload-model": "^4.0.1",
-    "@xyo-network/react-payload-details": "^6.0.0",
-    "@xyo-network/react-shared": "^6.0.0"
+    "@xylabs/react-flexbox": "^6.3.10",
+    "@xylabs/react-identicon": "^6.3.10",
+    "@xyo-network/payload-model": "^4.1.1",
+    "@xyo-network/react-payload-details": "^6.1.0",
+    "@xyo-network/react-shared": "^6.1.0"
   },
   "devDependencies": {
     "@emotion/react": "^11.14.0",
@@ -51,7 +51,7 @@
     "@mui/icons-material": "^7.2.0",
     "@mui/material": "^7.2.0",
     "@types/react": "^19.1.8",
-    "@xylabs/ts-scripts-yarn3": "^6.5.12",
+    "@xylabs/ts-scripts-yarn3": "next",
     "react": "^19.1.0",
     "react-dom": "^19.1.0",
     "typescript": "^5.8.3"

package/dist/types/index.d.ts

@@ -1,5 +0,0 @@
-export * from './components/index.ts';
-export * from './createPayloadRenderPlugin.ts';
-export * from './DefaultPayloadRenderPlugin.ts';
-export * from './PayloadRenderPlugin.ts';
-//# sourceMappingURL=index.d.ts.map