@xyo-network/react-archivist 2.26.56 → 2.26.59
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.
- package/dist/cjs/contexts/Provider.d.ts +10 -13
- package/dist/cjs/contexts/Provider.d.ts.map +1 -1
- package/dist/cjs/contexts/Provider.js +2 -2
- package/dist/cjs/contexts/Provider.js.map +1 -1
- package/dist/cjs/contexts/use.d.ts +4 -0
- package/dist/cjs/contexts/use.d.ts.map +1 -1
- package/dist/cjs/contexts/use.js +48 -3
- package/dist/cjs/contexts/use.js.map +1 -1
- package/dist/docs.json +472 -327
- package/dist/esm/contexts/Provider.d.ts +10 -13
- package/dist/esm/contexts/Provider.d.ts.map +1 -1
- package/dist/esm/contexts/Provider.js +2 -2
- package/dist/esm/contexts/Provider.js.map +1 -1
- package/dist/esm/contexts/use.d.ts +4 -0
- package/dist/esm/contexts/use.d.ts.map +1 -1
- package/dist/esm/contexts/use.js +42 -0
- package/dist/esm/contexts/use.js.map +1 -1
- package/package.json +6 -6
- package/src/contexts/Provider.tsx +11 -18
- package/src/contexts/use.ts +48 -0
|
@@ -1,20 +1,17 @@
|
|
|
1
1
|
/// <reference types="react" />
|
|
2
|
-
import { WithChildren } from '@xylabs/react-shared';
|
|
3
2
|
import { XyoRemoteArchivistConfig } from '@xyo-network/api';
|
|
4
3
|
import { XyoArchivist, XyoArchivistConfig } from '@xyo-network/archivist';
|
|
5
|
-
|
|
6
|
-
|
|
4
|
+
import { ContextExProviderProps } from '@xyo-network/react-shared';
|
|
5
|
+
export declare type ArchivistProviderProps = ContextExProviderProps<{
|
|
7
6
|
archivist?: XyoArchivist;
|
|
8
|
-
}
|
|
9
|
-
export declare const ArchivistProvider: React.FC<
|
|
10
|
-
export
|
|
11
|
-
required?: boolean;
|
|
7
|
+
}>;
|
|
8
|
+
export declare const ArchivistProvider: React.FC<ArchivistProviderProps>;
|
|
9
|
+
export declare type MemoryArchivistProviderProps = ContextExProviderProps<{
|
|
12
10
|
config?: XyoArchivistConfig;
|
|
13
|
-
}
|
|
14
|
-
export declare const MemoryArchivistProvider: React.FC<
|
|
15
|
-
export
|
|
16
|
-
required?: boolean;
|
|
11
|
+
}>;
|
|
12
|
+
export declare const MemoryArchivistProvider: React.FC<MemoryArchivistProviderProps>;
|
|
13
|
+
export declare type ApiArchivistProviderProps = ContextExProviderProps<{
|
|
17
14
|
config?: XyoRemoteArchivistConfig;
|
|
18
|
-
}
|
|
19
|
-
export declare const RemoteArchivistProvider: React.FC<
|
|
15
|
+
}>;
|
|
16
|
+
export declare const RemoteArchivistProvider: React.FC<ApiArchivistProviderProps>;
|
|
20
17
|
//# sourceMappingURL=Provider.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Provider.d.ts","sourceRoot":"","sources":["../../../src/contexts/Provider.tsx"],"names":[],"mappings":";AAAA,OAAO,
|
|
1
|
+
{"version":3,"file":"Provider.d.ts","sourceRoot":"","sources":["../../../src/contexts/Provider.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAsB,wBAAwB,EAAE,MAAM,kBAAkB,CAAA;AAC/E,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAsB,MAAM,wBAAwB,CAAA;AAC7F,OAAO,EAAE,sBAAsB,EAAE,MAAM,2BAA2B,CAAA;AAMlE,oBAAY,sBAAsB,GAAG,sBAAsB,CAAC;IAC1D,SAAS,CAAC,EAAE,YAAY,CAAA;CACzB,CAAC,CAAA;AAEF,eAAO,MAAM,iBAAiB,EAAE,KAAK,CAAC,EAAE,CAAC,sBAAsB,CAc9D,CAAA;AAED,oBAAY,4BAA4B,GAAG,sBAAsB,CAAC;IAChE,MAAM,CAAC,EAAE,kBAAkB,CAAA;CAC5B,CAAC,CAAA;AAEF,eAAO,MAAM,uBAAuB,EAAE,KAAK,CAAC,EAAE,CAAC,4BAA4B,CAI1E,CAAA;AAED,oBAAY,yBAAyB,GAAG,sBAAsB,CAAC;IAC7D,MAAM,CAAC,EAAE,wBAAwB,CAAA;CAClC,CAAC,CAAA;AAEF,eAAO,MAAM,uBAAuB,EAAE,KAAK,CAAC,EAAE,CAAC,yBAAyB,CAIvE,CAAA"}
|
|
@@ -19,10 +19,10 @@ const ArchivistProvider = ({ archivist: archivistProp, required = false, childre
|
|
|
19
19
|
exports.ArchivistProvider = ArchivistProvider;
|
|
20
20
|
const MemoryArchivistProvider = (_a) => {
|
|
21
21
|
var _b;
|
|
22
|
-
var { config = {}
|
|
22
|
+
var { config = {} } = _a, props = tslib_1.__rest(_a, ["config"]);
|
|
23
23
|
const { archivist } = (0, use_1.useArchivist)();
|
|
24
24
|
config.parent = (_b = config.parent) !== null && _b !== void 0 ? _b : archivist;
|
|
25
|
-
return (
|
|
25
|
+
return (0, jsx_runtime_1.jsx)(exports.ArchivistProvider, Object.assign({ archivist: new archivist_1.XyoMemoryArchivist(config) }, props));
|
|
26
26
|
};
|
|
27
27
|
exports.MemoryArchivistProvider = MemoryArchivistProvider;
|
|
28
28
|
const RemoteArchivistProvider = (_a) => {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Provider.js","sourceRoot":"","sources":["../../../src/contexts/Provider.tsx"],"names":[],"mappings":";;;;;
|
|
1
|
+
{"version":3,"file":"Provider.js","sourceRoot":"","sources":["../../../src/contexts/Provider.tsx"],"names":[],"mappings":";;;;;AAAA,0CAA+E;AAC/E,sDAA6F;AAE7F,iCAAgC;AAEhC,uCAA4C;AAC5C,+BAAoC;AAM7B,MAAM,iBAAiB,GAAqC,CAAC,EAAE,SAAS,EAAE,aAAa,EAAE,QAAQ,GAAG,KAAK,EAAE,QAAQ,EAAE,EAAE,EAAE;IAC9H,MAAM,CAAC,SAAS,EAAE,YAAY,CAAC,GAAG,IAAA,gBAAQ,EAA2B,aAAa,CAAC,CAAA;IAEnF,OAAO,CACL,uBAAC,0BAAgB,CAAC,QAAQ,kBACxB,KAAK,EAAE;YACL,SAAS;YACT,QAAQ,EAAE,IAAI;YACd,YAAY;SACb,gBAEA,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,IACxB,CAC7B,CAAA;AACH,CAAC,CAAA;AAdY,QAAA,iBAAiB,qBAc7B;AAMM,MAAM,uBAAuB,GAA2C,CAAC,EAAyB,EAAE,EAAE;;QAA7B,EAAE,MAAM,GAAG,EAAE,OAAY,EAAP,KAAK,sBAAvB,UAAyB,CAAF;IACrG,MAAM,EAAE,SAAS,EAAE,GAAG,IAAA,kBAAY,GAAE,CAAA;IACpC,MAAM,CAAC,MAAM,GAAG,MAAA,MAAM,CAAC,MAAM,mCAAI,SAAS,CAAA;IAC1C,OAAO,uBAAC,yBAAiB,kBAAC,SAAS,EAAE,IAAI,8BAAkB,CAAC,MAAM,CAAC,IAAM,KAAK,EAAI,CAAA;AACpF,CAAC,CAAA;AAJY,QAAA,uBAAuB,2BAInC;AAMM,MAAM,uBAAuB,GAAwC,CAAC,EAAyB,EAAE,EAAE;;QAA7B,EAAE,MAAM,GAAG,EAAE,OAAY,EAAP,KAAK,sBAAvB,UAAyB,CAAF;IAClG,MAAM,EAAE,SAAS,EAAE,GAAG,IAAA,kBAAY,GAAE,CAAA;IACpC,MAAM,CAAC,MAAM,GAAG,MAAA,MAAM,CAAC,MAAM,mCAAI,SAAS,CAAA;IAC1C,OAAO,uBAAC,yBAAiB,kBAAC,SAAS,EAAE,IAAI,wBAAkB,CAAC,MAAM,CAAC,IAAM,KAAK,EAAI,CAAA;AACpF,CAAC,CAAA;AAJY,QAAA,uBAAuB,2BAInC"}
|
|
@@ -1,2 +1,6 @@
|
|
|
1
|
+
import { XyoPayloadFindQuery } from '@xyo-network/archivist';
|
|
2
|
+
import { XyoPayload } from '@xyo-network/payload';
|
|
1
3
|
export declare const useArchivist: (required?: boolean) => Omit<import("./State").ArchivistState & import("@xyo-network/react-shared").ContextExState, "provided">;
|
|
4
|
+
export declare const useArchivistGet: (ids?: string[], required?: boolean) => [(XyoPayload | null)[]?, Error?];
|
|
5
|
+
export declare const useArchivistFind: <TQuery extends XyoPayloadFindQuery>(query?: TQuery | undefined, required?: boolean) => [(XyoPayload | null)[]?, Error?];
|
|
2
6
|
//# sourceMappingURL=use.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"use.d.ts","sourceRoot":"","sources":["../../../src/contexts/use.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"use.d.ts","sourceRoot":"","sources":["../../../src/contexts/use.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAA;AAC5D,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AAMjD,eAAO,MAAM,YAAY,iIAExB,CAAA;AAED,eAAO,MAAM,eAAe,SAAU,MAAM,EAAE,yBAAqB,CAAC,CAAC,UAAU,GAAG,IAAI,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,CAoBjG,CAAA;AAED,eAAO,MAAM,gBAAgB,0FAA2E,CAAC,CAAC,UAAU,GAAG,IAAI,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,CAoBtI,CAAA"}
|
package/dist/cjs/contexts/use.js
CHANGED
|
@@ -1,10 +1,55 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.useArchivist = void 0;
|
|
4
|
-
const
|
|
3
|
+
exports.useArchivistFind = exports.useArchivistGet = exports.useArchivist = void 0;
|
|
4
|
+
const tslib_1 = require("tslib");
|
|
5
|
+
const react_shared_1 = require("@xylabs/react-shared");
|
|
6
|
+
const react_shared_2 = require("@xyo-network/react-shared");
|
|
7
|
+
const react_1 = require("react");
|
|
5
8
|
const Context_1 = require("./Context");
|
|
6
9
|
const useArchivist = (required = false) => {
|
|
7
|
-
return (0,
|
|
10
|
+
return (0, react_shared_2.useContextEx)(Context_1.ArchivistContext, 'Archivist', required);
|
|
8
11
|
};
|
|
9
12
|
exports.useArchivist = useArchivist;
|
|
13
|
+
const useArchivistGet = (ids, required = false) => {
|
|
14
|
+
const { archivist } = (0, exports.useArchivist)(required);
|
|
15
|
+
const [payloads, setPayloads] = (0, react_1.useState)();
|
|
16
|
+
const [error, setError] = (0, react_1.useState)();
|
|
17
|
+
(0, react_shared_1.useAsyncEffect)(
|
|
18
|
+
// eslint-disable-next-line react-hooks/exhaustive-deps
|
|
19
|
+
(mounted) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
|
|
20
|
+
try {
|
|
21
|
+
const result = archivist ? yield archivist.get(ids !== null && ids !== void 0 ? ids : []) : undefined;
|
|
22
|
+
if (mounted()) {
|
|
23
|
+
setError(undefined);
|
|
24
|
+
setPayloads(result);
|
|
25
|
+
}
|
|
26
|
+
}
|
|
27
|
+
catch (ex) {
|
|
28
|
+
setError(ex);
|
|
29
|
+
}
|
|
30
|
+
}), [archivist, ids]);
|
|
31
|
+
return [payloads, error];
|
|
32
|
+
};
|
|
33
|
+
exports.useArchivistGet = useArchivistGet;
|
|
34
|
+
const useArchivistFind = (query, required = false) => {
|
|
35
|
+
const { archivist } = (0, exports.useArchivist)(required);
|
|
36
|
+
const [payloads, setPayloads] = (0, react_1.useState)();
|
|
37
|
+
const [error, setError] = (0, react_1.useState)();
|
|
38
|
+
(0, react_shared_1.useAsyncEffect)(
|
|
39
|
+
// eslint-disable-next-line react-hooks/exhaustive-deps
|
|
40
|
+
(mounted) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
|
|
41
|
+
try {
|
|
42
|
+
const result = archivist && query ? yield archivist.find(query) : undefined;
|
|
43
|
+
if (mounted()) {
|
|
44
|
+
setError(undefined);
|
|
45
|
+
setPayloads(result);
|
|
46
|
+
}
|
|
47
|
+
}
|
|
48
|
+
catch (ex) {
|
|
49
|
+
setError(ex);
|
|
50
|
+
}
|
|
51
|
+
}), [archivist, query]);
|
|
52
|
+
return [payloads, error];
|
|
53
|
+
};
|
|
54
|
+
exports.useArchivistFind = useArchivistFind;
|
|
10
55
|
//# sourceMappingURL=use.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"use.js","sourceRoot":"","sources":["../../../src/contexts/use.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"use.js","sourceRoot":"","sources":["../../../src/contexts/use.ts"],"names":[],"mappings":";;;;AAAA,uDAAqD;AAGrD,4DAAwD;AACxD,iCAAgC;AAEhC,uCAA4C;AAErC,MAAM,YAAY,GAAG,CAAC,QAAQ,GAAG,KAAK,EAAE,EAAE;IAC/C,OAAO,IAAA,2BAAY,EAAC,0BAAgB,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAA;AAC9D,CAAC,CAAA;AAFY,QAAA,YAAY,gBAExB;AAEM,MAAM,eAAe,GAAG,CAAC,GAAc,EAAE,QAAQ,GAAG,KAAK,EAAoC,EAAE;IACpG,MAAM,EAAE,SAAS,EAAE,GAAG,IAAA,oBAAY,EAAC,QAAQ,CAAC,CAAA;IAC5C,MAAM,CAAC,QAAQ,EAAE,WAAW,CAAC,GAAG,IAAA,gBAAQ,GAAyB,CAAA;IACjE,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,IAAA,gBAAQ,GAAS,CAAA;IAC3C,IAAA,6BAAc;IACZ,uDAAuD;IACvD,CAAO,OAAO,EAAE,EAAE;QAChB,IAAI;YACF,MAAM,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC,MAAM,SAAS,CAAC,GAAG,CAAC,GAAG,aAAH,GAAG,cAAH,GAAG,GAAI,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;YACrE,IAAI,OAAO,EAAE,EAAE;gBACb,QAAQ,CAAC,SAAS,CAAC,CAAA;gBACnB,WAAW,CAAC,MAAM,CAAC,CAAA;aACpB;SACF;QAAC,OAAO,EAAE,EAAE;YACX,QAAQ,CAAC,EAAW,CAAC,CAAA;SACtB;IACH,CAAC,CAAA,EACD,CAAC,SAAS,EAAE,GAAG,CAAC,CACjB,CAAA;IACD,OAAO,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAA;AAC1B,CAAC,CAAA;AApBY,QAAA,eAAe,mBAoB3B;AAEM,MAAM,gBAAgB,GAAG,CAAqC,KAAc,EAAE,QAAQ,GAAG,KAAK,EAAoC,EAAE;IACzI,MAAM,EAAE,SAAS,EAAE,GAAG,IAAA,oBAAY,EAAC,QAAQ,CAAC,CAAA;IAC5C,MAAM,CAAC,QAAQ,EAAE,WAAW,CAAC,GAAG,IAAA,gBAAQ,GAAyB,CAAA;IACjE,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,IAAA,gBAAQ,GAAS,CAAA;IAC3C,IAAA,6BAAc;IACZ,uDAAuD;IACvD,CAAO,OAAO,EAAE,EAAE;QAChB,IAAI;YACF,MAAM,MAAM,GAAG,SAAS,IAAI,KAAK,CAAC,CAAC,CAAC,MAAM,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;YAC3E,IAAI,OAAO,EAAE,EAAE;gBACb,QAAQ,CAAC,SAAS,CAAC,CAAA;gBACnB,WAAW,CAAC,MAAM,CAAC,CAAA;aACpB;SACF;QAAC,OAAO,EAAE,EAAE;YACX,QAAQ,CAAC,EAAW,CAAC,CAAA;SACtB;IACH,CAAC,CAAA,EACD,CAAC,SAAS,EAAE,KAAK,CAAC,CACnB,CAAA;IACD,OAAO,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAA;AAC1B,CAAC,CAAA;AApBY,QAAA,gBAAgB,oBAoB5B"}
|