@xyo-network/react-api 2.32.0-rc.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (69) hide show
  1. package/LICENSE +165 -0
  2. package/README.md +70 -0
  3. package/dist/cjs/components/ApiErrorAlert.d.ts +9 -0
  4. package/dist/cjs/components/ApiErrorAlert.d.ts.map +1 -0
  5. package/dist/cjs/components/ApiErrorAlert.js +13 -0
  6. package/dist/cjs/components/ApiErrorAlert.js.map +1 -0
  7. package/dist/cjs/components/JsonRouteWrapper/JsonApiButton.d.ts +4 -0
  8. package/dist/cjs/components/JsonRouteWrapper/JsonApiButton.d.ts.map +1 -0
  9. package/dist/cjs/components/JsonRouteWrapper/JsonApiButton.js +15 -0
  10. package/dist/cjs/components/JsonRouteWrapper/JsonApiButton.js.map +1 -0
  11. package/dist/cjs/components/JsonRouteWrapper/JsonRouteWrapper.d.ts +11 -0
  12. package/dist/cjs/components/JsonRouteWrapper/JsonRouteWrapper.d.ts.map +1 -0
  13. package/dist/cjs/components/JsonRouteWrapper/JsonRouteWrapper.js +47 -0
  14. package/dist/cjs/components/JsonRouteWrapper/JsonRouteWrapper.js.map +1 -0
  15. package/dist/cjs/components/JsonRouteWrapper/index.d.ts +3 -0
  16. package/dist/cjs/components/JsonRouteWrapper/index.d.ts.map +1 -0
  17. package/dist/cjs/components/JsonRouteWrapper/index.js +6 -0
  18. package/dist/cjs/components/JsonRouteWrapper/index.js.map +1 -0
  19. package/dist/cjs/components/ResultLoader.d.ts +9 -0
  20. package/dist/cjs/components/ResultLoader.d.ts.map +1 -0
  21. package/dist/cjs/components/ResultLoader.js +24 -0
  22. package/dist/cjs/components/ResultLoader.js.map +1 -0
  23. package/dist/cjs/components/index.d.ts +4 -0
  24. package/dist/cjs/components/index.d.ts.map +1 -0
  25. package/dist/cjs/components/index.js +7 -0
  26. package/dist/cjs/components/index.js.map +1 -0
  27. package/dist/cjs/index.d.ts +2 -0
  28. package/dist/cjs/index.d.ts.map +1 -0
  29. package/dist/cjs/index.js +5 -0
  30. package/dist/cjs/index.js.map +1 -0
  31. package/dist/docs.json +19042 -0
  32. package/dist/esm/components/ApiErrorAlert.d.ts +9 -0
  33. package/dist/esm/components/ApiErrorAlert.d.ts.map +1 -0
  34. package/dist/esm/components/ApiErrorAlert.js +7 -0
  35. package/dist/esm/components/ApiErrorAlert.js.map +1 -0
  36. package/dist/esm/components/JsonRouteWrapper/JsonApiButton.d.ts +4 -0
  37. package/dist/esm/components/JsonRouteWrapper/JsonApiButton.d.ts.map +1 -0
  38. package/dist/esm/components/JsonRouteWrapper/JsonApiButton.js +11 -0
  39. package/dist/esm/components/JsonRouteWrapper/JsonApiButton.js.map +1 -0
  40. package/dist/esm/components/JsonRouteWrapper/JsonRouteWrapper.d.ts +11 -0
  41. package/dist/esm/components/JsonRouteWrapper/JsonRouteWrapper.d.ts.map +1 -0
  42. package/dist/esm/components/JsonRouteWrapper/JsonRouteWrapper.js +41 -0
  43. package/dist/esm/components/JsonRouteWrapper/JsonRouteWrapper.js.map +1 -0
  44. package/dist/esm/components/JsonRouteWrapper/index.d.ts +3 -0
  45. package/dist/esm/components/JsonRouteWrapper/index.d.ts.map +1 -0
  46. package/dist/esm/components/JsonRouteWrapper/index.js +3 -0
  47. package/dist/esm/components/JsonRouteWrapper/index.js.map +1 -0
  48. package/dist/esm/components/ResultLoader.d.ts +9 -0
  49. package/dist/esm/components/ResultLoader.d.ts.map +1 -0
  50. package/dist/esm/components/ResultLoader.js +20 -0
  51. package/dist/esm/components/ResultLoader.js.map +1 -0
  52. package/dist/esm/components/index.d.ts +4 -0
  53. package/dist/esm/components/index.d.ts.map +1 -0
  54. package/dist/esm/components/index.js +4 -0
  55. package/dist/esm/components/index.js.map +1 -0
  56. package/dist/esm/index.d.ts +2 -0
  57. package/dist/esm/index.d.ts.map +1 -0
  58. package/dist/esm/index.js +2 -0
  59. package/dist/esm/index.js.map +1 -0
  60. package/package.json +75 -0
  61. package/src/components/ApiErrorAlert.tsx +21 -0
  62. package/src/components/JsonRouteWrapper/JsonApiButton.tsx +19 -0
  63. package/src/components/JsonRouteWrapper/JsonRouteWrapper.stories.tsx +68 -0
  64. package/src/components/JsonRouteWrapper/JsonRouteWrapper.tsx +85 -0
  65. package/src/components/JsonRouteWrapper/index.ts +2 -0
  66. package/src/components/ResultLoader.stories.tsx +37 -0
  67. package/src/components/ResultLoader.tsx +26 -0
  68. package/src/components/index.ts +3 -0
  69. package/src/index.ts +1 -0
@@ -0,0 +1,9 @@
1
+ /// <reference types="react" />
2
+ import { AlertProps } from '@mui/material';
3
+ import { XyoApiError } from '@xyo-network/api';
4
+ export interface ApiErrorAlertProps extends AlertProps {
5
+ call?: XyoApiError;
6
+ }
7
+ declare const ApiErrorAlert: React.FC<ApiErrorAlertProps>;
8
+ export { ApiErrorAlert };
9
+ //# sourceMappingURL=ApiErrorAlert.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ApiErrorAlert.d.ts","sourceRoot":"","sources":["../../../src/components/ApiErrorAlert.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAS,UAAU,EAA0B,MAAM,eAAe,CAAA;AACzE,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAE9C,MAAM,WAAW,kBAAmB,SAAQ,UAAU;IACpD,IAAI,CAAC,EAAE,WAAW,CAAA;CACnB;AAED,QAAA,MAAM,aAAa,EAAE,KAAK,CAAC,EAAE,CAAC,kBAAkB,CAW/C,CAAA;AAED,OAAO,EAAE,aAAa,EAAE,CAAA"}
@@ -0,0 +1,7 @@
1
+ import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
2
+ import { Alert, AlertTitle, Typography } from '@mui/material';
3
+ const ApiErrorAlert = ({ call, ...props }) => {
4
+ return (_jsxs(Alert, { severity: "error", ...props, children: [_jsx(AlertTitle, { children: "Whoops! Something went wrong" }), _jsx(Typography, { sx: { wordBreak: 'break-all' }, children: call?.config?.url }), _jsx(Typography, { variant: "caption", mr: 0.5, fontWeight: "bold", children: "Error:" }), _jsx(Typography, { variant: "caption", children: call?.message })] }));
5
+ };
6
+ export { ApiErrorAlert };
7
+ //# sourceMappingURL=ApiErrorAlert.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ApiErrorAlert.js","sourceRoot":"","sources":["../../../src/components/ApiErrorAlert.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAE,KAAK,EAAc,UAAU,EAAE,UAAU,EAAE,MAAM,eAAe,CAAA;AAOzE,MAAM,aAAa,GAAiC,CAAC,EAAE,IAAI,EAAE,GAAG,KAAK,EAAE,EAAE,EAAE;IACzE,OAAO,CACL,MAAC,KAAK,IAAC,QAAQ,EAAC,OAAO,KAAK,KAAK,aAC/B,KAAC,UAAU,+CAA0C,EACrD,KAAC,UAAU,IAAC,EAAE,EAAE,EAAE,SAAS,EAAE,WAAW,EAAE,YAAG,IAAI,EAAE,MAAM,EAAE,GAAG,GAAc,EAC5E,KAAC,UAAU,IAAC,OAAO,EAAC,SAAS,EAAC,EAAE,EAAE,GAAG,EAAE,UAAU,EAAC,MAAM,uBAE3C,EACb,KAAC,UAAU,IAAC,OAAO,EAAC,SAAS,YAAE,IAAI,EAAE,OAAO,GAAc,IACpD,CACT,CAAA;AACH,CAAC,CAAA;AAED,OAAO,EAAE,aAAa,EAAE,CAAA"}
@@ -0,0 +1,4 @@
1
+ /// <reference types="react" />
2
+ import { ButtonExProps } from '@xylabs/react-button';
3
+ export declare const JsonApiButton: React.FC<ButtonExProps>;
4
+ //# sourceMappingURL=JsonApiButton.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"JsonApiButton.d.ts","sourceRoot":"","sources":["../../../../src/components/JsonRouteWrapper/JsonApiButton.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAY,aAAa,EAAE,MAAM,sBAAsB,CAAA;AAG9D,eAAO,MAAM,aAAa,EAAE,KAAK,CAAC,EAAE,CAAC,aAAa,CAejD,CAAA"}
@@ -0,0 +1,11 @@
1
+ import { jsx as _jsx } from "react/jsx-runtime";
2
+ import { ButtonEx } from '@xylabs/react-button';
3
+ import { useSearchParams } from 'react-router-dom';
4
+ export const JsonApiButton = (props) => {
5
+ const [searchParams, setSearchParams] = useSearchParams();
6
+ return (_jsx(ButtonEx, { marginX: 2, variant: "outlined", onClick: () => {
7
+ searchParams.set('json', 'true');
8
+ setSearchParams(searchParams);
9
+ }, ...props, children: "JSON" }));
10
+ };
11
+ //# sourceMappingURL=JsonApiButton.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"JsonApiButton.js","sourceRoot":"","sources":["../../../../src/components/JsonRouteWrapper/JsonApiButton.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAE,QAAQ,EAAiB,MAAM,sBAAsB,CAAA;AAC9D,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAA;AAElD,MAAM,CAAC,MAAM,aAAa,GAA4B,CAAC,KAAK,EAAE,EAAE;IAC9D,MAAM,CAAC,YAAY,EAAE,eAAe,CAAC,GAAG,eAAe,EAAE,CAAA;IACzD,OAAO,CACL,KAAC,QAAQ,IACP,OAAO,EAAE,CAAC,EACV,OAAO,EAAC,UAAU,EAClB,OAAO,EAAE,GAAG,EAAE;YACZ,YAAY,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;YAChC,eAAe,CAAC,YAAY,CAAC,CAAA;QAC/B,CAAC,KACG,KAAK,qBAGA,CACZ,CAAA;AACH,CAAC,CAAA"}
@@ -0,0 +1,11 @@
1
+ /// <reference types="react" />
2
+ import { FlexBoxProps } from '@xylabs/react-flexbox';
3
+ import { ReactJsonViewProps } from 'react-json-view';
4
+ export interface JsonFromPromiseProps extends FlexBoxProps {
5
+ callback: () => Promise<object | undefined>;
6
+ noBackButton?: boolean;
7
+ noJsonButton?: boolean;
8
+ jsonViewProps?: ReactJsonViewProps;
9
+ }
10
+ export declare const JsonRouteWrapper: React.FC<JsonFromPromiseProps>;
11
+ //# sourceMappingURL=JsonRouteWrapper.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"JsonRouteWrapper.d.ts","sourceRoot":"","sources":["../../../../src/components/JsonRouteWrapper/JsonRouteWrapper.tsx"],"names":[],"mappings":";AAEA,OAAO,EAAE,YAAY,EAAoB,MAAM,uBAAuB,CAAA;AAItE,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAA;AAOpD,MAAM,WAAW,oBAAqB,SAAQ,YAAY;IACxD,QAAQ,EAAE,MAAM,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAA;IAC3C,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,aAAa,CAAC,EAAE,kBAAkB,CAAA;CACnC;AAED,eAAO,MAAM,gBAAgB,EAAE,KAAK,CAAC,EAAE,CAAC,oBAAoB,CAgE3D,CAAA"}
@@ -0,0 +1,41 @@
1
+ import { jsx as _jsx, Fragment as _Fragment, jsxs as _jsxs } from "react/jsx-runtime";
2
+ import { ButtonEx } from '@xylabs/react-button';
3
+ import { ErrorDialog } from '@xylabs/react-dialogs';
4
+ import { FlexCol, FlexRow } from '@xylabs/react-flexbox';
5
+ import { useAsyncEffect } from '@xylabs/react-shared';
6
+ import { lazy, Suspense, useState } from 'react';
7
+ import { useSearchParams } from 'react-router-dom';
8
+ import { JsonApiButton } from './JsonApiButton';
9
+ const JsonView = lazy(() => import(/* webpackChunkName: "jsonView" */ 'react-json-view'));
10
+ export const JsonRouteWrapper = ({ callback, children, noBackButton = false, noJsonButton = false, jsonViewProps, ...props }) => {
11
+ const [apiResponse, setApiResponse] = useState();
12
+ const [apiError, setApiError] = useState();
13
+ const [searchParams, setSearchParams] = useSearchParams();
14
+ const active = !!searchParams.get('json');
15
+ useAsyncEffect(
16
+ // eslint-disable-next-line react-hooks/exhaustive-deps
17
+ async (mounted) => {
18
+ try {
19
+ const response = await callback();
20
+ if (mounted()) {
21
+ setApiResponse(response);
22
+ }
23
+ }
24
+ catch (ex) {
25
+ if (mounted()) {
26
+ const error = ex;
27
+ if (error.isXyoError) {
28
+ setApiError(error);
29
+ }
30
+ else {
31
+ throw ex;
32
+ }
33
+ }
34
+ }
35
+ }, [callback]);
36
+ return (_jsx(FlexCol, { ...props, children: active ? (_jsxs(_Fragment, { children: [_jsx(Suspense, { fallback: null, children: apiResponse && _jsx(JsonView, { src: apiResponse, collapseStringsAfterLength: 64, ...jsonViewProps }) }), !noBackButton && (_jsx(FlexRow, { marginY: 3, children: _jsx(ButtonEx, { flexDirection: "row", variant: "outlined", onClick: () => {
37
+ searchParams.delete('json');
38
+ setSearchParams(searchParams);
39
+ }, children: "Back" }) })), _jsx(ErrorDialog, { title: "Error Fetching JSON", error: apiError, open: !!apiError, onAction: () => setApiError(undefined) })] })) : (_jsxs(_Fragment, { children: [children, !noJsonButton && _jsx(JsonApiButton, { marginTop: 2 })] })) }));
40
+ };
41
+ //# sourceMappingURL=JsonRouteWrapper.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"JsonRouteWrapper.js","sourceRoot":"","sources":["../../../../src/components/JsonRouteWrapper/JsonRouteWrapper.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAA;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACnD,OAAO,EAAgB,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAA;AACtE,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAErD,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAA;AAEhD,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAA;AAElD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAE/C,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,kCAAkC,CAAC,iBAAiB,CAAC,CAAC,CAAA;AASzF,MAAM,CAAC,MAAM,gBAAgB,GAAmC,CAAC,EAC/D,QAAQ,EACR,QAAQ,EACR,YAAY,GAAG,KAAK,EACpB,YAAY,GAAG,KAAK,EACpB,aAAa,EACb,GAAG,KAAK,EACT,EAAE,EAAE;IACH,MAAM,CAAC,WAAW,EAAE,cAAc,CAAC,GAAG,QAAQ,EAAU,CAAA;IACxD,MAAM,CAAC,QAAQ,EAAE,WAAW,CAAC,GAAG,QAAQ,EAAe,CAAA;IACvD,MAAM,CAAC,YAAY,EAAE,eAAe,CAAC,GAAG,eAAe,EAAE,CAAA;IACzD,MAAM,MAAM,GAAG,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;IAEzC,cAAc;IACZ,uDAAuD;IACvD,KAAK,EAAE,OAAO,EAAE,EAAE;QAChB,IAAI;YACF,MAAM,QAAQ,GAAG,MAAM,QAAQ,EAAE,CAAA;YACjC,IAAI,OAAO,EAAE,EAAE;gBACb,cAAc,CAAC,QAAQ,CAAC,CAAA;aACzB;SACF;QAAC,OAAO,EAAE,EAAE;YACX,IAAI,OAAO,EAAE,EAAE;gBACb,MAAM,KAAK,GAAG,EAAiB,CAAA;gBAC/B,IAAI,KAAK,CAAC,UAAU,EAAE;oBACpB,WAAW,CAAC,KAAK,CAAC,CAAA;iBACnB;qBAAM;oBACL,MAAM,EAAE,CAAA;iBACT;aACF;SACF;IACH,CAAC,EACD,CAAC,QAAQ,CAAC,CACX,CAAA;IAED,OAAO,CACL,KAAC,OAAO,OAAK,KAAK,YACf,MAAM,CAAC,CAAC,CAAC,CACR,8BACE,KAAC,QAAQ,IAAC,QAAQ,EAAE,IAAI,YAAG,WAAW,IAAI,KAAC,QAAQ,IAAC,GAAG,EAAE,WAAW,EAAE,0BAA0B,EAAE,EAAE,KAAM,aAAa,GAAI,GAAY,EACtI,CAAC,YAAY,IAAI,CAChB,KAAC,OAAO,IAAC,OAAO,EAAE,CAAC,YACjB,KAAC,QAAQ,IACP,aAAa,EAAC,KAAK,EACnB,OAAO,EAAC,UAAU,EAClB,OAAO,EAAE,GAAG,EAAE;4BACZ,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;4BAC3B,eAAe,CAAC,YAAY,CAAC,CAAA;wBAC/B,CAAC,qBAGQ,GACH,CACX,EACD,KAAC,WAAW,IAAC,KAAK,EAAC,qBAAqB,EAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,QAAQ,EAAE,QAAQ,EAAE,GAAG,EAAE,CAAC,WAAW,CAAC,SAAS,CAAC,GAAI,IACrH,CACJ,CAAC,CAAC,CAAC,CACF,8BACG,QAAQ,EACR,CAAC,YAAY,IAAI,KAAC,aAAa,IAAC,SAAS,EAAE,CAAC,GAAI,IAChD,CACJ,GACO,CACX,CAAA;AACH,CAAC,CAAA"}
@@ -0,0 +1,3 @@
1
+ export * from './JsonApiButton';
2
+ export * from './JsonRouteWrapper';
3
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/components/JsonRouteWrapper/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAA;AAC/B,cAAc,oBAAoB,CAAA"}
@@ -0,0 +1,3 @@
1
+ export * from './JsonApiButton';
2
+ export * from './JsonRouteWrapper';
3
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/components/JsonRouteWrapper/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAA;AAC/B,cAAc,oBAAoB,CAAA"}
@@ -0,0 +1,9 @@
1
+ import { XyoApiError } from '@xyo-network/api';
2
+ import { PropsWithChildren } from 'react';
3
+ export interface HandleItemDetailLoadingProps<T> {
4
+ apiError: Error | XyoApiError | undefined;
5
+ notFound: boolean;
6
+ searchResult: T | undefined;
7
+ }
8
+ export declare function ResultLoader<T>(props: PropsWithChildren<HandleItemDetailLoadingProps<T>>): JSX.Element;
9
+ //# sourceMappingURL=ResultLoader.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ResultLoader.d.ts","sourceRoot":"","sources":["../../../src/components/ResultLoader.tsx"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAE9C,OAAO,EAAE,iBAAiB,EAAE,MAAM,OAAO,CAAA;AAEzC,MAAM,WAAW,4BAA4B,CAAC,CAAC;IAC7C,QAAQ,EAAE,KAAK,GAAG,WAAW,GAAG,SAAS,CAAA;IACzC,QAAQ,EAAE,OAAO,CAAA;IACjB,YAAY,EAAE,CAAC,GAAG,SAAS,CAAA;CAC5B;AAED,wBAAgB,YAAY,CAAC,CAAC,EAAE,KAAK,EAAE,iBAAiB,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC,eAcxF"}
@@ -0,0 +1,20 @@
1
+ import { jsx as _jsx, Fragment as _Fragment } from "react/jsx-runtime";
2
+ import { FlexGrowRow } from '@xylabs/react-flexbox';
3
+ import { NotFound } from '@xyo-network/react-shared';
4
+ export function ResultLoader(props) {
5
+ const { notFound, apiError, searchResult, children } = props;
6
+ if (notFound) {
7
+ return _jsx(NotFound, {});
8
+ }
9
+ // Defer error handling to the children
10
+ if (apiError) {
11
+ return _jsx(_Fragment, { children: children });
12
+ }
13
+ if (searchResult === undefined) {
14
+ return _jsx(FlexGrowRow, { busy: true, minHeight: "50px" });
15
+ }
16
+ else {
17
+ return _jsx(_Fragment, { children: children });
18
+ }
19
+ }
20
+ //# sourceMappingURL=ResultLoader.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ResultLoader.js","sourceRoot":"","sources":["../../../src/components/ResultLoader.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAEnD,OAAO,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAA;AASpD,MAAM,UAAU,YAAY,CAAI,KAAyD;IACvF,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,YAAY,EAAE,QAAQ,EAAE,GAAG,KAAK,CAAA;IAC5D,IAAI,QAAQ,EAAE;QACZ,OAAO,KAAC,QAAQ,KAAG,CAAA;KACpB;IACD,uCAAuC;IACvC,IAAI,QAAQ,EAAE;QACZ,OAAO,4BAAG,QAAQ,GAAI,CAAA;KACvB;IACD,IAAI,YAAY,KAAK,SAAS,EAAE;QAC9B,OAAO,KAAC,WAAW,IAAC,IAAI,QAAC,SAAS,EAAC,MAAM,GAAG,CAAA;KAC7C;SAAM;QACL,OAAO,4BAAG,QAAQ,GAAI,CAAA;KACvB;AACH,CAAC"}
@@ -0,0 +1,4 @@
1
+ export * from './ApiErrorAlert';
2
+ export * from './JsonRouteWrapper';
3
+ export * from './ResultLoader';
4
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAA;AAC/B,cAAc,oBAAoB,CAAA;AAClC,cAAc,gBAAgB,CAAA"}
@@ -0,0 +1,4 @@
1
+ export * from './ApiErrorAlert';
2
+ export * from './JsonRouteWrapper';
3
+ export * from './ResultLoader';
4
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/components/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAA;AAC/B,cAAc,oBAAoB,CAAA;AAClC,cAAc,gBAAgB,CAAA"}
@@ -0,0 +1,2 @@
1
+ export * from './components';
2
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAA"}
@@ -0,0 +1,2 @@
1
+ export * from './components';
2
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAA"}
package/package.json ADDED
@@ -0,0 +1,75 @@
1
+ {
2
+ "name": "@xyo-network/react-api",
3
+ "author": {
4
+ "email": "support@xyo.network",
5
+ "name": "XYO Development Team",
6
+ "url": "https://xyo.network"
7
+ },
8
+ "bugs": {
9
+ "email": "support@xyo.network",
10
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/issues"
11
+ },
12
+ "dependencies": {
13
+ "@emotion/react": "^11.10.4",
14
+ "@emotion/styled": "^11.10.4",
15
+ "@mui/material": "^5.10.3",
16
+ "@xylabs/react-button": "^2.14.14",
17
+ "@xylabs/react-dialogs": "^2.14.14",
18
+ "@xylabs/react-flexbox": "^2.14.14",
19
+ "@xylabs/react-shared": "^2.14.14",
20
+ "@xyo-network/react-shared": "^2.32.0-rc.7",
21
+ "react": "^18.2.0",
22
+ "react-dom": "^18.2.0",
23
+ "react-json-view": "^1.21.3",
24
+ "react-router-dom": "^6.3.0",
25
+ "tslib": "^2.4.0"
26
+ },
27
+ "description": "Common React library for all XYO projects that use React",
28
+ "devDependencies": {
29
+ "@xyo-network/api": "^2.30.0-rc.3"
30
+ },
31
+ "browser": "dist/esm/index.js",
32
+ "docs": "dist/docs.json",
33
+ "exports": {
34
+ ".": {
35
+ "node": {
36
+ "import": "./dist/esm/index.js",
37
+ "require": "./dist/cjs/index.js"
38
+ },
39
+ "browser": {
40
+ "import": "./dist/esm/index.js",
41
+ "require": "./dist/cjs/index.js"
42
+ },
43
+ "default": "./dist/esm/index.js"
44
+ },
45
+ "./dist/docs.json": {
46
+ "default": "./dist/docs.json"
47
+ },
48
+ "./package.json": "./package.json"
49
+ },
50
+ "main": "dist/cjs/index.js",
51
+ "module": "dist/esm/index.js",
52
+ "homepage": "https://xyo.network",
53
+ "keywords": [
54
+ "xyo",
55
+ "utility",
56
+ "typescript",
57
+ "react"
58
+ ],
59
+ "license": "LGPL-3.0",
60
+ "publishConfig": {
61
+ "access": "public"
62
+ },
63
+ "repository": {
64
+ "type": "git",
65
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js.git"
66
+ },
67
+ "scripts": {
68
+ "lint-pkg": "npmPkgJsonLint .",
69
+ "license": "yarn license-checker --exclude \"MIT, ISC, Apache-2.0, BSD, BSD-2-Clause, CC-BY-4.0, Unlicense, CC-BY-3.0, CC0-1.0\""
70
+ },
71
+ "sideEffects": false,
72
+ "types": "dist/esm/index.d.ts",
73
+ "version": "2.32.0-rc.7",
74
+ "stableVersion": "2.31.3"
75
+ }
@@ -0,0 +1,21 @@
1
+ import { Alert, AlertProps, AlertTitle, Typography } from '@mui/material'
2
+ import { XyoApiError } from '@xyo-network/api'
3
+
4
+ export interface ApiErrorAlertProps extends AlertProps {
5
+ call?: XyoApiError
6
+ }
7
+
8
+ const ApiErrorAlert: React.FC<ApiErrorAlertProps> = ({ call, ...props }) => {
9
+ return (
10
+ <Alert severity="error" {...props}>
11
+ <AlertTitle>Whoops! Something went wrong</AlertTitle>
12
+ <Typography sx={{ wordBreak: 'break-all' }}>{call?.config?.url}</Typography>
13
+ <Typography variant="caption" mr={0.5} fontWeight="bold">
14
+ Error:
15
+ </Typography>
16
+ <Typography variant="caption">{call?.message}</Typography>
17
+ </Alert>
18
+ )
19
+ }
20
+
21
+ export { ApiErrorAlert }
@@ -0,0 +1,19 @@
1
+ import { ButtonEx, ButtonExProps } from '@xylabs/react-button'
2
+ import { useSearchParams } from 'react-router-dom'
3
+
4
+ export const JsonApiButton: React.FC<ButtonExProps> = (props) => {
5
+ const [searchParams, setSearchParams] = useSearchParams()
6
+ return (
7
+ <ButtonEx
8
+ marginX={2}
9
+ variant="outlined"
10
+ onClick={() => {
11
+ searchParams.set('json', 'true')
12
+ setSearchParams(searchParams)
13
+ }}
14
+ {...props}
15
+ >
16
+ JSON
17
+ </ButtonEx>
18
+ )
19
+ }
@@ -0,0 +1,68 @@
1
+ import { ComponentMeta, ComponentStory, DecoratorFn } from '@storybook/react'
2
+ import { ButtonEx } from '@xylabs/react-button'
3
+ import { FlexCol } from '@xylabs/react-flexbox'
4
+ import { XyoArchivistApi } from '@xyo-network/api'
5
+ import { BrowserRouter, useSearchParams } from 'react-router-dom'
6
+
7
+ import { JsonRouteWrapper } from './JsonRouteWrapper'
8
+
9
+ const JsonDecorator: DecoratorFn = (Story) => (
10
+ <BrowserRouter>
11
+ <Story />
12
+ </BrowserRouter>
13
+ )
14
+
15
+ const StorybookEntry = {
16
+ argTypes: {
17
+ apiDomain: 'https://beta.api.archivist.xyo.network',
18
+ },
19
+ component: JsonRouteWrapper,
20
+ decorators: [JsonDecorator],
21
+ parameters: {
22
+ docs: {
23
+ page: null,
24
+ },
25
+ },
26
+ title: 'shared/JsonRouteWrapper',
27
+ } as ComponentMeta<typeof JsonRouteWrapper>
28
+
29
+ const Template: ComponentStory<typeof JsonRouteWrapper> = (props) => {
30
+ const [searchParams, setSearchParams] = useSearchParams()
31
+ const activeJson = searchParams.get('json')
32
+ return (
33
+ <FlexCol>
34
+ <ButtonEx
35
+ marginY={3}
36
+ onClick={() => {
37
+ activeJson === 'true' ? searchParams.delete('json') : searchParams.set('json', 'true')
38
+ setSearchParams(searchParams)
39
+ }}
40
+ variant="outlined"
41
+ >
42
+ Toggle JSON Page
43
+ </ButtonEx>
44
+ <JsonRouteWrapper {...props}></JsonRouteWrapper>
45
+ </FlexCol>
46
+ )
47
+ }
48
+
49
+ const Default = Template.bind({})
50
+ Default.args = {
51
+ callback: () => new XyoArchivistApi({ apiDomain: 'https://beta.api.archivist.xyo.network' }).archive('temp').block.stats.get(),
52
+ }
53
+
54
+ const HideBackButton = Template.bind({})
55
+ HideBackButton.args = {
56
+ callback: () =>
57
+ new XyoArchivistApi({
58
+ apiDomain: 'https://beta.api.archivist.xyo.network',
59
+ })
60
+ .archive('temp')
61
+ .block.stats.get(),
62
+ noBackButton: true,
63
+ }
64
+
65
+ export { Default, HideBackButton }
66
+
67
+ // eslint-disable-next-line import/no-default-export
68
+ export default StorybookEntry
@@ -0,0 +1,85 @@
1
+ import { ButtonEx } from '@xylabs/react-button'
2
+ import { ErrorDialog } from '@xylabs/react-dialogs'
3
+ import { FlexBoxProps, FlexCol, FlexRow } from '@xylabs/react-flexbox'
4
+ import { useAsyncEffect } from '@xylabs/react-shared'
5
+ import { XyoApiError } from '@xyo-network/api'
6
+ import { lazy, Suspense, useState } from 'react'
7
+ import { ReactJsonViewProps } from 'react-json-view'
8
+ import { useSearchParams } from 'react-router-dom'
9
+
10
+ import { JsonApiButton } from './JsonApiButton'
11
+
12
+ const JsonView = lazy(() => import(/* webpackChunkName: "jsonView" */ 'react-json-view'))
13
+
14
+ export interface JsonFromPromiseProps extends FlexBoxProps {
15
+ callback: () => Promise<object | undefined>
16
+ noBackButton?: boolean
17
+ noJsonButton?: boolean
18
+ jsonViewProps?: ReactJsonViewProps
19
+ }
20
+
21
+ export const JsonRouteWrapper: React.FC<JsonFromPromiseProps> = ({
22
+ callback,
23
+ children,
24
+ noBackButton = false,
25
+ noJsonButton = false,
26
+ jsonViewProps,
27
+ ...props
28
+ }) => {
29
+ const [apiResponse, setApiResponse] = useState<object>()
30
+ const [apiError, setApiError] = useState<XyoApiError>()
31
+ const [searchParams, setSearchParams] = useSearchParams()
32
+ const active = !!searchParams.get('json')
33
+
34
+ useAsyncEffect(
35
+ // eslint-disable-next-line react-hooks/exhaustive-deps
36
+ async (mounted) => {
37
+ try {
38
+ const response = await callback()
39
+ if (mounted()) {
40
+ setApiResponse(response)
41
+ }
42
+ } catch (ex) {
43
+ if (mounted()) {
44
+ const error = ex as XyoApiError
45
+ if (error.isXyoError) {
46
+ setApiError(error)
47
+ } else {
48
+ throw ex
49
+ }
50
+ }
51
+ }
52
+ },
53
+ [callback],
54
+ )
55
+
56
+ return (
57
+ <FlexCol {...props}>
58
+ {active ? (
59
+ <>
60
+ <Suspense fallback={null}>{apiResponse && <JsonView src={apiResponse} collapseStringsAfterLength={64} {...jsonViewProps} />}</Suspense>
61
+ {!noBackButton && (
62
+ <FlexRow marginY={3}>
63
+ <ButtonEx
64
+ flexDirection="row"
65
+ variant="outlined"
66
+ onClick={() => {
67
+ searchParams.delete('json')
68
+ setSearchParams(searchParams)
69
+ }}
70
+ >
71
+ Back
72
+ </ButtonEx>
73
+ </FlexRow>
74
+ )}
75
+ <ErrorDialog title="Error Fetching JSON" error={apiError} open={!!apiError} onAction={() => setApiError(undefined)} />
76
+ </>
77
+ ) : (
78
+ <>
79
+ {children}
80
+ {!noJsonButton && <JsonApiButton marginTop={2} />}
81
+ </>
82
+ )}
83
+ </FlexCol>
84
+ )
85
+ }
@@ -0,0 +1,2 @@
1
+ export * from './JsonApiButton'
2
+ export * from './JsonRouteWrapper'
@@ -0,0 +1,37 @@
1
+ /* eslint-disable import/no-internal-modules */
2
+ import { ComponentStory, Meta } from '@storybook/react'
3
+ import { AxiosError } from 'axios'
4
+
5
+ import { ResultLoader } from './ResultLoader'
6
+
7
+ const StorybookEntry: Meta = {
8
+ argTypes: {},
9
+ component: ResultLoader,
10
+ parameters: {
11
+ docs: {
12
+ page: null,
13
+ },
14
+ },
15
+ title: 'webapp/ResultLoader',
16
+ }
17
+
18
+ const Template: ComponentStory<typeof ResultLoader> = (props) => {
19
+ return <ResultLoader {...props} />
20
+ }
21
+
22
+ const Default = Template.bind({})
23
+ Default.args = {}
24
+
25
+ const NotFound = Template.bind({})
26
+ NotFound.args = { notFound: true }
27
+
28
+ const ApiError = Template.bind({})
29
+ ApiError.args = { apiError: new AxiosError(), children: <h1>Shown in case of error</h1> }
30
+
31
+ const SearchResult = Template.bind({})
32
+ SearchResult.args = { children: <h1>Shown when there is a valid result</h1>, searchResult: 'foo' }
33
+
34
+ export { ApiError, Default, NotFound, SearchResult }
35
+
36
+ // eslint-disable-next-line import/no-default-export
37
+ export default StorybookEntry
@@ -0,0 +1,26 @@
1
+ import { FlexGrowRow } from '@xylabs/react-flexbox'
2
+ import { XyoApiError } from '@xyo-network/api'
3
+ import { NotFound } from '@xyo-network/react-shared'
4
+ import { PropsWithChildren } from 'react'
5
+
6
+ export interface HandleItemDetailLoadingProps<T> {
7
+ apiError: Error | XyoApiError | undefined
8
+ notFound: boolean
9
+ searchResult: T | undefined
10
+ }
11
+
12
+ export function ResultLoader<T>(props: PropsWithChildren<HandleItemDetailLoadingProps<T>>) {
13
+ const { notFound, apiError, searchResult, children } = props
14
+ if (notFound) {
15
+ return <NotFound />
16
+ }
17
+ // Defer error handling to the children
18
+ if (apiError) {
19
+ return <>{children}</>
20
+ }
21
+ if (searchResult === undefined) {
22
+ return <FlexGrowRow busy minHeight="50px" />
23
+ } else {
24
+ return <>{children}</>
25
+ }
26
+ }
@@ -0,0 +1,3 @@
1
+ export * from './ApiErrorAlert'
2
+ export * from './JsonRouteWrapper'
3
+ export * from './ResultLoader'
package/src/index.ts ADDED
@@ -0,0 +1 @@
1
+ export * from './components'