amp-workflow-ui 0.1.0

package/README.md

@@ -0,0 +1,63 @@
+# @ampersand/workflow-ui
+
+Reusable Approval Workflow UI components for Ampersand portals.
+
+## Install
+
+```bash
+npm install @ampersand/workflow-ui
+# or
+yarn add @ampersand/workflow-ui
+```
+
+Peer dependencies required in host:
+
+- react, react-dom (18.x)
+- @mui/material, @mui/system
+- @emotion/react, @emotion/styled
+
+## Usage
+
+```tsx
+import { DialogOpener } from '@ampersand/workflow-ui'
+import axios from 'axios'
+
+const api = {
+  get: (p: any) => axios.get(p.url),
+  post: (p: any) => axios.post(p.url, p.data)
+}
+
+<DialogOpener
+  openDialog={open}
+  handleClose={() => setOpen(false)}
+  userInfoData={userInfo}
+  api={api}
+/>
+```
+
+Or render inline:
+
+```tsx
+import { ApprovalWorkflow } from '@ampersand/workflow-ui'
+
+<ApprovalWorkflow userInfo={userInfo} api={api} />
+```
+
+### Optional
+
+- `urlBuilder`: (moduleName, moduleId, context, refId?) => string
+- `loadingComponent`: custom loader
+
+## Build
+
+```bash
+npm run build
+```
+
+## Publish
+
+```bash
+npm publish --access public
+```
+
+

package/dist/index.d.mts

@@ -0,0 +1,41 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import React from 'react';
+
+type ApiClient = {
+    get: (params: {
+        url: string;
+        serviceURL?: string;
+        [key: string]: any;
+    }) => Promise<any>;
+    post: (params: {
+        url: string;
+        data?: any;
+        serviceURL?: string;
+        [key: string]: any;
+    }) => Promise<any>;
+};
+type UrlBuilder = (moduleName: string, moduleId: string | number, context: any, referenceId?: string | number) => string;
+type ApprovalWorkflowProps = {
+    userInfo: any;
+    selectedWorkflowsList?: any[];
+};
+type DialogOpenerProps = {
+    openDialog: boolean;
+    handleClose?: () => void;
+    title?: string;
+    userInfoData: any;
+    selectedWorkflowsList?: any[];
+};
+
+declare function DialogOpener(props: DialogOpenerProps & {
+    api: ApiClient;
+    urlBuilder?: UrlBuilder;
+    loadingComponent?: React.ReactNode;
+}): react_jsx_runtime.JSX.Element;
+declare function ApprovalWorkflow(props: ApprovalWorkflowProps & {
+    api: ApiClient;
+    urlBuilder?: UrlBuilder;
+    loadingComponent?: React.ReactNode;
+}): react_jsx_runtime.JSX.Element;
+
+export { type ApiClient, ApprovalWorkflow, type ApprovalWorkflowProps, DialogOpener, type DialogOpenerProps, type UrlBuilder };

package/dist/index.d.ts

@@ -0,0 +1,41 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import React from 'react';
+
+type ApiClient = {
+    get: (params: {
+        url: string;
+        serviceURL?: string;
+        [key: string]: any;
+    }) => Promise<any>;
+    post: (params: {
+        url: string;
+        data?: any;
+        serviceURL?: string;
+        [key: string]: any;
+    }) => Promise<any>;
+};
+type UrlBuilder = (moduleName: string, moduleId: string | number, context: any, referenceId?: string | number) => string;
+type ApprovalWorkflowProps = {
+    userInfo: any;
+    selectedWorkflowsList?: any[];
+};
+type DialogOpenerProps = {
+    openDialog: boolean;
+    handleClose?: () => void;
+    title?: string;
+    userInfoData: any;
+    selectedWorkflowsList?: any[];
+};
+
+declare function DialogOpener(props: DialogOpenerProps & {
+    api: ApiClient;
+    urlBuilder?: UrlBuilder;
+    loadingComponent?: React.ReactNode;
+}): react_jsx_runtime.JSX.Element;
+declare function ApprovalWorkflow(props: ApprovalWorkflowProps & {
+    api: ApiClient;
+    urlBuilder?: UrlBuilder;
+    loadingComponent?: React.ReactNode;
+}): react_jsx_runtime.JSX.Element;
+
+export { type ApiClient, ApprovalWorkflow, type ApprovalWorkflowProps, DialogOpener, type DialogOpenerProps, type UrlBuilder };