@xyo-network/react-schema 2.38.11 → 2.38.12

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 (57) hide show
  1. package/dist/cjs/hooks/index.d.ts +2 -0
  2. package/dist/cjs/hooks/index.d.ts.map +1 -0
  3. package/dist/cjs/{diviners → hooks}/index.js +1 -1
  4. package/dist/cjs/hooks/index.js.map +1 -0
  5. package/dist/cjs/hooks/useGetSchema.d.ts +25 -0
  6. package/dist/cjs/hooks/useGetSchema.d.ts.map +1 -0
  7. package/dist/cjs/hooks/useGetSchema.js +53 -0
  8. package/dist/cjs/hooks/useGetSchema.js.map +1 -0
  9. package/dist/cjs/index.d.ts +1 -1
  10. package/dist/cjs/index.d.ts.map +1 -1
  11. package/dist/cjs/index.js +1 -1
  12. package/dist/cjs/index.js.map +1 -1
  13. package/dist/docs.json +321 -566
  14. package/dist/esm/hooks/index.d.ts +2 -0
  15. package/dist/esm/hooks/index.d.ts.map +1 -0
  16. package/dist/esm/hooks/index.js +2 -0
  17. package/dist/esm/hooks/index.js.map +1 -0
  18. package/dist/esm/hooks/useGetSchema.d.ts +25 -0
  19. package/dist/esm/hooks/useGetSchema.d.ts.map +1 -0
  20. package/dist/esm/hooks/useGetSchema.js +49 -0
  21. package/dist/esm/hooks/useGetSchema.js.map +1 -0
  22. package/dist/esm/index.d.ts +1 -1
  23. package/dist/esm/index.d.ts.map +1 -1
  24. package/dist/esm/index.js +1 -1
  25. package/dist/esm/index.js.map +1 -1
  26. package/package.json +5 -6
  27. package/src/hooks/index.ts +1 -0
  28. package/src/hooks/useGetSchema.stories.tsx +76 -0
  29. package/src/hooks/useGetSchema.tsx +55 -0
  30. package/src/index.ts +1 -1
  31. package/dist/cjs/diviners/SchemaListApiDiviner.d.ts +0 -20
  32. package/dist/cjs/diviners/SchemaListApiDiviner.d.ts.map +0 -1
  33. package/dist/cjs/diviners/SchemaListApiDiviner.js +0 -54
  34. package/dist/cjs/diviners/SchemaListApiDiviner.js.map +0 -1
  35. package/dist/cjs/diviners/SchemaListApiDivinerConfig.d.ts +0 -9
  36. package/dist/cjs/diviners/SchemaListApiDivinerConfig.d.ts.map +0 -1
  37. package/dist/cjs/diviners/SchemaListApiDivinerConfig.js +0 -5
  38. package/dist/cjs/diviners/SchemaListApiDivinerConfig.js.map +0 -1
  39. package/dist/cjs/diviners/index.d.ts +0 -2
  40. package/dist/cjs/diviners/index.d.ts.map +0 -1
  41. package/dist/cjs/diviners/index.js.map +0 -1
  42. package/dist/esm/diviners/SchemaListApiDiviner.d.ts +0 -20
  43. package/dist/esm/diviners/SchemaListApiDiviner.d.ts.map +0 -1
  44. package/dist/esm/diviners/SchemaListApiDiviner.js +0 -36
  45. package/dist/esm/diviners/SchemaListApiDiviner.js.map +0 -1
  46. package/dist/esm/diviners/SchemaListApiDivinerConfig.d.ts +0 -9
  47. package/dist/esm/diviners/SchemaListApiDivinerConfig.d.ts.map +0 -1
  48. package/dist/esm/diviners/SchemaListApiDivinerConfig.js +0 -2
  49. package/dist/esm/diviners/SchemaListApiDivinerConfig.js.map +0 -1
  50. package/dist/esm/diviners/index.d.ts +0 -2
  51. package/dist/esm/diviners/index.d.ts.map +0 -1
  52. package/dist/esm/diviners/index.js +0 -2
  53. package/dist/esm/diviners/index.js.map +0 -1
  54. package/src/diviners/SchemaListApiDiviner.spec.ts +0 -23
  55. package/src/diviners/SchemaListApiDiviner.ts +0 -51
  56. package/src/diviners/SchemaListApiDivinerConfig.ts +0 -13
  57. package/src/diviners/index.ts +0 -1
@@ -0,0 +1,2 @@
1
+ export * from './useGetSchema';
2
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/hooks/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAA"}
@@ -1,5 +1,5 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  const tslib_1 = require("tslib");
4
- tslib_1.__exportStar(require("./SchemaListApiDiviner"), exports);
4
+ tslib_1.__exportStar(require("./useGetSchema"), exports);
5
5
  //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/hooks/index.ts"],"names":[],"mappings":";;;AAAA,yDAA8B"}
@@ -0,0 +1,25 @@
1
+ /**
2
+ * Gets a Huri and schema payload from a schema string
3
+ */
4
+ declare const useGetSchemaPayload: (schema?: string) => {
5
+ notFound: boolean;
6
+ schemaHuri: import("@xyo-network/payload").Huri<import("@xyo-network/payload").SchemaFields & import("@xyo-network/payload").PayloadFields & {
7
+ schema: string;
8
+ }> | undefined;
9
+ schemaPayload: (import("@xyo-network/payload").SchemaFields & import("@xyo-network/payload").PayloadFields & {
10
+ definition: {
11
+ [key: string]: unknown;
12
+ $id?: string | undefined;
13
+ };
14
+ extends?: string | undefined;
15
+ name?: string | undefined;
16
+ schema: "network.xyo.schema";
17
+ }) | null | undefined;
18
+ xyoError: (import("@xyo-network/payload").SchemaFields & import("@xyo-network/payload").PayloadFields & {
19
+ message?: string | undefined;
20
+ schema: "network.xyo.error";
21
+ sources: string[];
22
+ }) | undefined;
23
+ };
24
+ export { useGetSchemaPayload };
25
+ //# sourceMappingURL=useGetSchema.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"useGetSchema.d.ts","sourceRoot":"","sources":["../../../src/hooks/useGetSchema.tsx"],"names":[],"mappings":"AAOA;;GAEG;AACH,QAAA,MAAM,mBAAmB,YAAa,MAAM;;;;;;;;;;;;;;;;;;;CA0C3C,CAAA;AAED,OAAO,EAAE,mBAAmB,EAAE,CAAA"}
@@ -0,0 +1,53 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.useGetSchemaPayload = void 0;
4
+ const tslib_1 = require("tslib");
5
+ const react_shared_1 = require("@xylabs/react-shared");
6
+ const module_1 = require("@xyo-network/module");
7
+ const payload_1 = require("@xyo-network/payload");
8
+ const utils_1 = require("@xyo-network/utils");
9
+ const react_1 = require("react");
10
+ /**
11
+ * Gets a Huri and schema payload from a schema string
12
+ */
13
+ const useGetSchemaPayload = (schema) => {
14
+ const [notFound, setNotFound] = (0, react_1.useState)(false);
15
+ const [xyoError, setXyoError] = (0, react_1.useState)();
16
+ const [schemaCacheEntry, setSchemaCacheEntry] = (0, react_1.useState)();
17
+ const [schemaLocal, setSchemaLocal] = (0, react_1.useState)();
18
+ (0, react_shared_1.useAsyncEffect)(
19
+ // eslint-disable-next-line react-hooks/exhaustive-deps
20
+ (mounted) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
21
+ const firstRequest = !notFound && !schemaCacheEntry && !xyoError;
22
+ const schemaChanged = schema !== schemaLocal;
23
+ if ((schema && firstRequest) || (schema && schemaChanged)) {
24
+ try {
25
+ const schemaCacheEntry = yield utils_1.XyoSchemaCache.instance.get(schema);
26
+ if (mounted()) {
27
+ setSchemaCacheEntry(schemaCacheEntry);
28
+ setNotFound(schemaCacheEntry === null || schemaCacheEntry === undefined);
29
+ }
30
+ }
31
+ catch (e) {
32
+ const error = e;
33
+ console.error(e);
34
+ if (mounted()) {
35
+ setXyoError({ message: error.message, schema: module_1.XyoErrorSchema, sources: [] });
36
+ }
37
+ }
38
+ }
39
+ if (schemaChanged) {
40
+ setSchemaLocal(schema);
41
+ }
42
+ }), [xyoError, notFound, schema, schemaLocal, schemaCacheEntry]);
43
+ return {
44
+ notFound,
45
+ schemaHuri: schemaCacheEntry === null || schemaCacheEntry === void 0 ? void 0 : schemaCacheEntry.huri,
46
+ schemaPayload: schemaCacheEntry
47
+ ? new payload_1.XyoPayloadBuilder(schemaCacheEntry === null || schemaCacheEntry === void 0 ? void 0 : schemaCacheEntry.payload).fields(schemaCacheEntry.payload).build()
48
+ : schemaCacheEntry,
49
+ xyoError,
50
+ };
51
+ };
52
+ exports.useGetSchemaPayload = useGetSchemaPayload;
53
+ //# sourceMappingURL=useGetSchema.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"useGetSchema.js","sourceRoot":"","sources":["../../../src/hooks/useGetSchema.tsx"],"names":[],"mappings":";;;;AAAA,uDAAqD;AACrD,gDAA8D;AAC9D,kDAAwD;AAExD,8CAAwE;AACxE,iCAAgC;AAEhC;;GAEG;AACH,MAAM,mBAAmB,GAAG,CAAC,MAAe,EAAE,EAAE;IAC9C,MAAM,CAAC,QAAQ,EAAE,WAAW,CAAC,GAAG,IAAA,gBAAQ,EAAC,KAAK,CAAC,CAAA;IAC/C,MAAM,CAAC,QAAQ,EAAE,WAAW,CAAC,GAAG,IAAA,gBAAQ,GAAY,CAAA;IACpD,MAAM,CAAC,gBAAgB,EAAE,mBAAmB,CAAC,GAAG,IAAA,gBAAQ,GAA0C,CAAA;IAClG,MAAM,CAAC,WAAW,EAAE,cAAc,CAAC,GAAG,IAAA,gBAAQ,GAAU,CAAA;IAExD,IAAA,6BAAc;IACZ,uDAAuD;IACvD,CAAO,OAAO,EAAE,EAAE;QAChB,MAAM,YAAY,GAAG,CAAC,QAAQ,IAAI,CAAC,gBAAgB,IAAI,CAAC,QAAQ,CAAA;QAChE,MAAM,aAAa,GAAG,MAAM,KAAK,WAAW,CAAA;QAE5C,IAAI,CAAC,MAAM,IAAI,YAAY,CAAC,IAAI,CAAC,MAAM,IAAI,aAAa,CAAC,EAAE;YACzD,IAAI;gBACF,MAAM,gBAAgB,GAAG,MAAM,sBAAc,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;gBAClE,IAAI,OAAO,EAAE,EAAE;oBACb,mBAAmB,CAAC,gBAAgB,CAAC,CAAA;oBACrC,WAAW,CAAC,gBAAgB,KAAK,IAAI,IAAI,gBAAgB,KAAK,SAAS,CAAC,CAAA;iBACzE;aACF;YAAC,OAAO,CAAC,EAAE;gBACV,MAAM,KAAK,GAAG,CAAU,CAAA;gBACxB,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;gBAChB,IAAI,OAAO,EAAE,EAAE;oBACb,WAAW,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,uBAAc,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,CAAA;iBAC7E;aACF;SACF;QACD,IAAI,aAAa,EAAE;YACjB,cAAc,CAAC,MAAM,CAAC,CAAA;SACvB;IACH,CAAC,CAAA,EACD,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,gBAAgB,CAAC,CAC5D,CAAA;IAED,OAAO;QACL,QAAQ;QACR,UAAU,EAAE,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,IAAI;QAClC,aAAa,EAAE,gBAAgB;YAC7B,CAAC,CAAC,IAAI,2BAAiB,CAAmB,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,OAAO,CAAC,CAAC,MAAM,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE;YAC7G,CAAC,CAAC,gBAAgB;QACpB,QAAQ;KACT,CAAA;AACH,CAAC,CAAA;AAEQ,kDAAmB"}
@@ -1,4 +1,4 @@
1
1
  export * from './components';
2
2
  export * from './contexts';
3
- export * from './diviners';
3
+ export * from './hooks';
4
4
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAA;AAC5B,cAAc,YAAY,CAAA;AAC1B,cAAc,YAAY,CAAA"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAA;AAC5B,cAAc,YAAY,CAAA;AAC1B,cAAc,SAAS,CAAA"}
package/dist/cjs/index.js CHANGED
@@ -3,5 +3,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  const tslib_1 = require("tslib");
4
4
  tslib_1.__exportStar(require("./components"), exports);
5
5
  tslib_1.__exportStar(require("./contexts"), exports);
6
- tslib_1.__exportStar(require("./diviners"), exports);
6
+ tslib_1.__exportStar(require("./hooks"), exports);
7
7
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA,uDAA4B;AAC5B,qDAA0B;AAC1B,qDAA0B"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA,uDAA4B;AAC5B,qDAA0B;AAC1B,kDAAuB"}