@xyo-network/react-archivist 2.43.3 → 2.44.1

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 (85) hide show
  1. package/dist/cjs/components/Details.js +2 -2
  2. package/dist/cjs/components/Details.js.map +1 -1
  3. package/dist/cjs/contexts/Provider/CookieArchivistProvider.js +4 -1
  4. package/dist/cjs/contexts/Provider/CookieArchivistProvider.js.map +1 -1
  5. package/dist/cjs/contexts/Provider/MemoryArchivistProvider.js +5 -1
  6. package/dist/cjs/contexts/Provider/MemoryArchivistProvider.js.map +1 -1
  7. package/dist/cjs/contexts/Provider/Provider.js +2 -0
  8. package/dist/cjs/contexts/Provider/Provider.js.map +1 -1
  9. package/dist/cjs/contexts/Provider/StorageArchivistProvider.js +7 -3
  10. package/dist/cjs/contexts/Provider/StorageArchivistProvider.js.map +1 -1
  11. package/dist/cjs/contexts/use/use.js +4 -4
  12. package/dist/cjs/contexts/use/use.js.map +1 -1
  13. package/dist/cjs/contexts/use/useArchivistAll.js +2 -2
  14. package/dist/cjs/contexts/use/useArchivistAll.js.map +1 -1
  15. package/dist/cjs/contexts/use/useArchivistClear.js +2 -2
  16. package/dist/cjs/contexts/use/useArchivistClear.js.map +1 -1
  17. package/dist/cjs/contexts/use/useArchivistFind.js +2 -2
  18. package/dist/cjs/contexts/use/useArchivistFind.js.map +1 -1
  19. package/dist/cjs/contexts/use/useArchivistGet.js +2 -2
  20. package/dist/cjs/contexts/use/useArchivistGet.js.map +1 -1
  21. package/dist/cjs/contexts/use/useArchivistInsert.js +2 -2
  22. package/dist/cjs/contexts/use/useArchivistInsert.js.map +1 -1
  23. package/dist/cjs/contexts/use/useArchivistStates.js +2 -2
  24. package/dist/cjs/contexts/use/useArchivistStates.js.map +1 -1
  25. package/dist/docs.json +224 -202
  26. package/dist/esm/components/Details.js +2 -2
  27. package/dist/esm/components/Details.js.map +1 -1
  28. package/dist/esm/contexts/Provider/CookieArchivistProvider.js +4 -1
  29. package/dist/esm/contexts/Provider/CookieArchivistProvider.js.map +1 -1
  30. package/dist/esm/contexts/Provider/MemoryArchivistProvider.js +5 -1
  31. package/dist/esm/contexts/Provider/MemoryArchivistProvider.js.map +1 -1
  32. package/dist/esm/contexts/Provider/Provider.js +2 -0
  33. package/dist/esm/contexts/Provider/Provider.js.map +1 -1
  34. package/dist/esm/contexts/Provider/StorageArchivistProvider.js +7 -3
  35. package/dist/esm/contexts/Provider/StorageArchivistProvider.js.map +1 -1
  36. package/dist/esm/contexts/use/use.js +4 -4
  37. package/dist/esm/contexts/use/use.js.map +1 -1
  38. package/dist/esm/contexts/use/useArchivistAll.js +2 -2
  39. package/dist/esm/contexts/use/useArchivistAll.js.map +1 -1
  40. package/dist/esm/contexts/use/useArchivistClear.js +2 -2
  41. package/dist/esm/contexts/use/useArchivistClear.js.map +1 -1
  42. package/dist/esm/contexts/use/useArchivistFind.js +2 -2
  43. package/dist/esm/contexts/use/useArchivistFind.js.map +1 -1
  44. package/dist/esm/contexts/use/useArchivistGet.js +2 -2
  45. package/dist/esm/contexts/use/useArchivistGet.js.map +1 -1
  46. package/dist/esm/contexts/use/useArchivistInsert.js +2 -2
  47. package/dist/esm/contexts/use/useArchivistInsert.js.map +1 -1
  48. package/dist/esm/contexts/use/useArchivistStates.js +2 -2
  49. package/dist/esm/contexts/use/useArchivistStates.js.map +1 -1
  50. package/dist/types/components/Details.d.ts +1 -2
  51. package/dist/types/components/Details.d.ts.map +1 -1
  52. package/dist/types/contexts/Provider/CookieArchivistProvider.d.ts +1 -0
  53. package/dist/types/contexts/Provider/CookieArchivistProvider.d.ts.map +1 -1
  54. package/dist/types/contexts/Provider/MemoryArchivistProvider.d.ts +2 -0
  55. package/dist/types/contexts/Provider/MemoryArchivistProvider.d.ts.map +1 -1
  56. package/dist/types/contexts/Provider/Provider.d.ts +2 -0
  57. package/dist/types/contexts/Provider/Provider.d.ts.map +1 -1
  58. package/dist/types/contexts/Provider/StorageArchivistProvider.d.ts +2 -0
  59. package/dist/types/contexts/Provider/StorageArchivistProvider.d.ts.map +1 -1
  60. package/dist/types/contexts/use/use.d.ts +2 -1
  61. package/dist/types/contexts/use/use.d.ts.map +1 -1
  62. package/dist/types/contexts/use/useArchivistAll.d.ts +1 -1
  63. package/dist/types/contexts/use/useArchivistClear.d.ts +1 -1
  64. package/dist/types/contexts/use/useArchivistFind.d.ts +1 -1
  65. package/dist/types/contexts/use/useArchivistFind.d.ts.map +1 -1
  66. package/dist/types/contexts/use/useArchivistGet.d.ts +1 -1
  67. package/dist/types/contexts/use/useArchivistGet.d.ts.map +1 -1
  68. package/dist/types/contexts/use/useArchivistInsert.d.ts +1 -1
  69. package/dist/types/contexts/use/useArchivistStates.d.ts +1 -1
  70. package/dist/types/contexts/use/useArchivistStates.d.ts.map +1 -1
  71. package/package.json +10 -8
  72. package/src/components/Details.stories.tsx +4 -4
  73. package/src/components/Details.tsx +4 -4
  74. package/src/contexts/Provider/CookieArchivistProvider.tsx +4 -1
  75. package/src/contexts/Provider/MemoryArchivistProvider.tsx +6 -1
  76. package/src/contexts/Provider/Provider.tsx +3 -0
  77. package/src/contexts/Provider/StorageArchivistProvider.stories.tsx +3 -1
  78. package/src/contexts/Provider/StorageArchivistProvider.tsx +8 -4
  79. package/src/contexts/use/use.tsx +4 -5
  80. package/src/contexts/use/useArchivistAll.tsx +2 -2
  81. package/src/contexts/use/useArchivistClear.tsx +2 -2
  82. package/src/contexts/use/useArchivistFind.tsx +2 -2
  83. package/src/contexts/use/useArchivistGet.tsx +2 -2
  84. package/src/contexts/use/useArchivistInsert.tsx +2 -2
  85. package/src/contexts/use/useArchivistStates.tsx +2 -2
@@ -4,10 +4,13 @@ import { useEffect, useState } from 'react'
4
4
 
5
5
  import { ArchivistContext } from '../Context'
6
6
 
7
+ /** @deprecated use hooks instead */
7
8
  export type ArchivistProviderProps = ContextExProviderProps<{
8
9
  archivist?: ArchivistModule
9
10
  }>
10
11
 
12
+ /** @deprecated use hooks instead */
13
+ // eslint-disable-next-line deprecation/deprecation
11
14
  export const ArchivistProvider: React.FC<ArchivistProviderProps> = ({ archivist: archivistProp, required = false, children }) => {
12
15
  const [archivist, setArchivist] = useState<ArchivistModule>()
13
16
 
@@ -1,3 +1,5 @@
1
+ /* eslint-disable deprecation/deprecation */
2
+ /* eslint-disable import/no-deprecated */
1
3
  import { ComponentMeta, ComponentStory } from '@storybook/react'
2
4
  import { ButtonEx } from '@xylabs/react-button'
3
5
  import { FlexCol, FlexRow } from '@xylabs/react-flexbox'
@@ -23,7 +25,7 @@ const StorybookEntry = {
23
25
  } as ComponentMeta<typeof StorageArchivistProvider>
24
26
 
25
27
  const RenderTest: React.FC = () => {
26
- const { archivist } = useArchivist()
28
+ const archivist = useArchivist()
27
29
  const [items, setItems] = useState<number>()
28
30
  const [refresh, setRefresh] = useState(0)
29
31
  useAsyncEffect(
@@ -1,21 +1,24 @@
1
+ import { useAsyncEffect } from '@xylabs/react-shared'
1
2
  import { StorageArchivistConfig, XyoStorageArchivist } from '@xyo-network/archivist'
2
3
  import { MemoryNode } from '@xyo-network/node'
3
4
  import { ContextExProviderProps } from '@xyo-network/react-shared'
4
5
  import merge from 'lodash/merge'
6
+ import { useState } from 'react'
5
7
 
6
8
  import { useArchivist } from '../use'
9
+ // eslint-disable-next-line import/no-deprecated
7
10
  import { ArchivistProvider } from './Provider'
8
11
 
12
+ /** @deprecated use hooks instead */
9
13
  export type StorageArchivistProviderProps = ContextExProviderProps<{
10
14
  config: StorageArchivistConfig
11
15
  node?: MemoryNode
12
16
  }>
13
17
 
14
- import { useAsyncEffect } from '@xylabs/react-shared'
15
- import { useState } from 'react'
16
-
18
+ /** @deprecated use hooks instead */
19
+ // eslint-disable-next-line deprecation/deprecation
17
20
  export const StorageArchivistProvider: React.FC<StorageArchivistProviderProps> = ({ config, node, ...props }) => {
18
- const { archivist } = useArchivist()
21
+ const archivist = useArchivist()
19
22
 
20
23
  const [activeArchivist, setActiveArchivist] = useState<XyoStorageArchivist>()
21
24
 
@@ -49,5 +52,6 @@ export const StorageArchivistProvider: React.FC<StorageArchivistProviderProps> =
49
52
  [node, archivist, config],
50
53
  )
51
54
 
55
+ // eslint-disable-next-line deprecation/deprecation
52
56
  return <ArchivistProvider archivist={activeArchivist} {...props} />
53
57
  }
@@ -1,7 +1,6 @@
1
- import { useContextEx } from '@xyo-network/react-shared'
1
+ import { ArchivistGetQuerySchema, ArchivistModule } from '@xyo-network/archivist'
2
+ import { useModule } from '@xyo-network/react-node'
2
3
 
3
- import { ArchivistContext } from '../Context'
4
-
5
- export const useArchivist = (required = false) => {
6
- return useContextEx(ArchivistContext, 'Archivist', required)
4
+ export const useArchivist = (nameOrAddress?: string) => {
5
+ return useModule<ArchivistModule>(nameOrAddress, [[ArchivistGetQuerySchema]])
7
6
  }
@@ -3,8 +3,8 @@ import { ArchivistWrapper } from '@xyo-network/archivist'
3
3
 
4
4
  import { useArchivistStates } from './useArchivistStates'
5
5
 
6
- export const useArchivistAll = (required = false) => {
7
- const { archivist, error, payloads, setPayloads, refresh, setError, refreshCount } = useArchivistStates(required)
6
+ export const useArchivistAll = () => {
7
+ const { archivist, error, payloads, setPayloads, refresh, setError, refreshCount } = useArchivistStates()
8
8
 
9
9
  useAsyncEffect(
10
10
  // eslint-disable-next-line react-hooks/exhaustive-deps
@@ -3,8 +3,8 @@ import { ArchivistWrapper } from '@xyo-network/archivist'
3
3
 
4
4
  import { useArchivistStates } from './useArchivistStates'
5
5
 
6
- export const useArchivistClear = (required = false) => {
7
- const { archivist, error, payloads, setPayloads, refresh, setError, refreshCount } = useArchivistStates(required)
6
+ export const useArchivistClear = () => {
7
+ const { archivist, error, payloads, setPayloads, refresh, setError, refreshCount } = useArchivistStates()
8
8
 
9
9
  useAsyncEffect(
10
10
  // eslint-disable-next-line react-hooks/exhaustive-deps
@@ -5,9 +5,9 @@ import { useDataState } from '@xyo-network/react-shared'
5
5
  import { RefreshCallback } from './lib'
6
6
  import { useArchivistStates } from './useArchivistStates'
7
7
 
8
- export const useArchivistFind = <TFilter extends PayloadFindFilter>(filter: TFilter, required = false): [XyoPayload[]?, Error?, RefreshCallback?] => {
8
+ export const useArchivistFind = <TFilter extends PayloadFindFilter>(filter: TFilter): [XyoPayload[]?, Error?, RefreshCallback?] => {
9
9
  const [savedFilter, setSavedFilter] = useDataState(filter)
10
- const { archivist, error, payloads, setPayloads, refresh, setError, refreshCount } = useArchivistStates(required)
10
+ const { archivist, error, payloads, setPayloads, refresh, setError, refreshCount } = useArchivistStates()
11
11
 
12
12
  setSavedFilter(filter)
13
13
 
@@ -5,11 +5,11 @@ import { useDataState } from '@xyo-network/react-shared'
5
5
  import { RefreshCallback } from './lib'
6
6
  import { useArchivistStates } from './useArchivistStates'
7
7
 
8
- export const useArchivistGet = <T extends XyoPayload = XyoPayload>(ids?: string[], required = false): [T[]?, Error?, RefreshCallback?] => {
8
+ export const useArchivistGet = <T extends XyoPayload = XyoPayload>(ids?: string[]): [T[]?, Error?, RefreshCallback?] => {
9
9
  const [savedIds, setSavedIds] = useDataState(ids)
10
10
  setSavedIds(ids)
11
11
 
12
- const { archivist, error, payloads, refresh, setError, setPayloads, refreshCount } = useArchivistStates<T>(required)
12
+ const { archivist, error, payloads, refresh, setError, setPayloads, refreshCount } = useArchivistStates<T>()
13
13
 
14
14
  useAsyncEffect(
15
15
  // eslint-disable-next-line react-hooks/exhaustive-deps
@@ -3,8 +3,8 @@ import { XyoPayload } from '@xyo-network/payload-model'
3
3
 
4
4
  import { useArchivistStates } from './useArchivistStates'
5
5
 
6
- export const useArchivistInsert = (payloads: XyoPayload[], required = false) => {
7
- const { archivist, error, payloads: resultPayloads, refresh, setError, setPayloads: setResultPayloads, refreshCount } = useArchivistStates(required)
6
+ export const useArchivistInsert = (payloads: XyoPayload[]) => {
7
+ const { archivist, error, payloads: resultPayloads, refresh, setError, setPayloads: setResultPayloads, refreshCount } = useArchivistStates()
8
8
 
9
9
  const insertRefresh = () => {
10
10
  setResultPayloads(undefined)
@@ -4,8 +4,8 @@ import { useEffect, useState } from 'react'
4
4
 
5
5
  import { useArchivist } from './use'
6
6
 
7
- export const useArchivistStates = <T extends XyoPayload = XyoPayload>(required: boolean) => {
8
- const { archivist: archivistFromHook } = useArchivist(required)
7
+ export const useArchivistStates = <T extends XyoPayload = XyoPayload>() => {
8
+ const archivistFromHook = useArchivist()
9
9
  const [payloads, setPayloads] = useState<T[]>()
10
10
  const [error, setError] = useState<Error>()
11
11
  const [refreshCount, setRefreshCount] = useState(1)