@nocode-factory/sanity-kit 2.67.0 → 2.68.0-rc.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.
- package/CHANGELOG.md +25 -0
- package/dist/index.d.ts +1 -1
- package/dist/index.js +97 -25
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
- package/src/hooks/sharedListener.ts +101 -0
- package/src/hooks/useAssets.ts +1 -1
- package/src/hooks/useCollection.ts +1 -0
- package/src/hooks/useComponentDefaults.ts +1 -1
- package/src/hooks/useComponentNames.ts +1 -1
- package/src/hooks/usePageContents.ts +1 -0
- package/src/hooks/usePages.ts +1 -0
- package/src/hooks/useQueryData.ts +58 -21
- package/src/hooks/useRedirectMap.ts +1 -1
- package/src/hooks/useTranslationTodo.ts +1 -1
- package/src/hooks/useTranslationTodos.ts +1 -0
- package/src/version.ts +1 -1
package/package.json
CHANGED
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
import type {SanityClient} from 'sanity'
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* UNE écoute Sanity partagée par filtre (types écoutés + publié seulement ou non), quel
|
|
5
|
+
* que soit le nombre de vues qui la demandent (onglet Pages, tableaux, médias...). Avant,
|
|
6
|
+
* chaque vue ouvrait sa propre connexion, souvent sur les mêmes types.
|
|
7
|
+
*
|
|
8
|
+
* - Sanity n'envoie qu'un signal « ça a changé » (`includeResult: false`), jamais le
|
|
9
|
+
* document entier : à chaque frappe, le document partait vers chaque vue ouverte.
|
|
10
|
+
* - Connexion tombée : nouvelle tentative (5 s, puis jusqu'à 60 s), et chaque vue est
|
|
11
|
+
* prévenue au retour (des changements ont pu être manqués). Avant, une écoute tombée
|
|
12
|
+
* arrêtait la mise à jour sans rien dire.
|
|
13
|
+
* - Plus aucune vue abonnée : la connexion est fermée.
|
|
14
|
+
*/
|
|
15
|
+
|
|
16
|
+
type Listener = () => void
|
|
17
|
+
type Entry = {
|
|
18
|
+
listeners: Set<Listener>
|
|
19
|
+
stop: () => void
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
const entries = new Map<string, Entry>()
|
|
23
|
+
|
|
24
|
+
const RETRY_MIN_MS = 5_000
|
|
25
|
+
const RETRY_MAX_MS = 60_000
|
|
26
|
+
|
|
27
|
+
export function listenFilter(types: readonly string[], publishedOnly: boolean): string {
|
|
28
|
+
return publishedOnly ? '*[_type in $types && !(_id in path("drafts.**")) && !(_id in path("versions.**"))]' : '*[_type in $types]'
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
export function subscribeShared(
|
|
32
|
+
client: SanityClient,
|
|
33
|
+
types: readonly string[],
|
|
34
|
+
publishedOnly: boolean,
|
|
35
|
+
listener: Listener,
|
|
36
|
+
tag: string,
|
|
37
|
+
): () => void {
|
|
38
|
+
const {projectId, dataset} = client.config()
|
|
39
|
+
const sorted = [...types].sort()
|
|
40
|
+
const key = `${projectId}:${dataset}:${publishedOnly ? 'published' : 'all'}:${sorted.join(',')}`
|
|
41
|
+
let entry = entries.get(key)
|
|
42
|
+
if (!entry) {
|
|
43
|
+
const listeners = new Set<Listener>()
|
|
44
|
+
const notify = () => listeners.forEach((l) => l())
|
|
45
|
+
let retry = RETRY_MIN_MS
|
|
46
|
+
let retryTimer: ReturnType<typeof setTimeout> | undefined
|
|
47
|
+
let stopped = false
|
|
48
|
+
let unsubscribe = () => {}
|
|
49
|
+
const open = (reconnect: boolean) => {
|
|
50
|
+
const subscription = client
|
|
51
|
+
.listen(listenFilter(sorted, publishedOnly), {types: sorted}, {
|
|
52
|
+
visibility: 'query',
|
|
53
|
+
events: ['welcome', 'mutation'],
|
|
54
|
+
includeResult: false,
|
|
55
|
+
includePreviousRevision: false,
|
|
56
|
+
tag,
|
|
57
|
+
})
|
|
58
|
+
.subscribe({
|
|
59
|
+
next: (event) => {
|
|
60
|
+
if (event.type === 'welcome') {
|
|
61
|
+
retry = RETRY_MIN_MS
|
|
62
|
+
// Reconnecté : des changements ont pu passer pendant la coupure.
|
|
63
|
+
if (reconnect) notify()
|
|
64
|
+
return
|
|
65
|
+
}
|
|
66
|
+
notify()
|
|
67
|
+
},
|
|
68
|
+
error: () => {
|
|
69
|
+
if (stopped) return
|
|
70
|
+
retryTimer = setTimeout(() => open(true), retry)
|
|
71
|
+
retry = Math.min(retry * 2, RETRY_MAX_MS)
|
|
72
|
+
},
|
|
73
|
+
})
|
|
74
|
+
unsubscribe = () => subscription.unsubscribe()
|
|
75
|
+
}
|
|
76
|
+
open(false)
|
|
77
|
+
entry = {
|
|
78
|
+
listeners,
|
|
79
|
+
stop: () => {
|
|
80
|
+
stopped = true
|
|
81
|
+
if (retryTimer) clearTimeout(retryTimer)
|
|
82
|
+
unsubscribe()
|
|
83
|
+
},
|
|
84
|
+
}
|
|
85
|
+
entries.set(key, entry)
|
|
86
|
+
}
|
|
87
|
+
entry.listeners.add(listener)
|
|
88
|
+
const current = entry
|
|
89
|
+
return () => {
|
|
90
|
+
current.listeners.delete(listener)
|
|
91
|
+
if (current.listeners.size === 0) {
|
|
92
|
+
current.stop()
|
|
93
|
+
entries.delete(key)
|
|
94
|
+
}
|
|
95
|
+
}
|
|
96
|
+
}
|
|
97
|
+
|
|
98
|
+
/** Nombre d'écoutes ouvertes (tests). */
|
|
99
|
+
export function sharedListenerCount(): number {
|
|
100
|
+
return entries.size
|
|
101
|
+
}
|
package/src/hooks/useAssets.ts
CHANGED
|
@@ -37,7 +37,7 @@ function entryFor(client: SanityClient, type: string, languageField: string, lan
|
|
|
37
37
|
})
|
|
38
38
|
.catch(() => {})
|
|
39
39
|
void load()
|
|
40
|
-
const sub = client.listen(`*[${filter}]`, params, {visibility: 'query', includeResult: false}).subscribe({next: () => void load()})
|
|
40
|
+
const sub = client.listen(`*[${filter}]`, params, {visibility: 'query', includeResult: false, tag: 'ncf-kit.component-defaults'}).subscribe({next: () => void load()})
|
|
41
41
|
e.stop = () => sub.unsubscribe()
|
|
42
42
|
}
|
|
43
43
|
return [key, e]
|
|
@@ -27,7 +27,7 @@ export function useComponentNames(): Map<string, string> {
|
|
|
27
27
|
.catch(() => {})
|
|
28
28
|
void load()
|
|
29
29
|
const subscription = client
|
|
30
|
-
.listen(`*[_id == $id]`, {id: COMPONENT_META_ID}, {visibility: 'query', events: ['mutation']})
|
|
30
|
+
.listen(`*[_id == $id]`, {id: COMPONENT_META_ID}, {visibility: 'query', events: ['mutation'], includeResult: false, tag: 'ncf-kit.component-names'})
|
|
31
31
|
.subscribe({next: () => void load(), error: () => {}})
|
|
32
32
|
return () => {
|
|
33
33
|
cancelled = true
|
package/src/hooks/usePages.ts
CHANGED
|
@@ -35,6 +35,7 @@ export function usePages(documentColumns: readonly ResolvedDocumentColumn[] = []
|
|
|
35
35
|
|
|
36
36
|
const {data, loading, error, refresh} = useQueryData<PageDoc[]>(query, params, {
|
|
37
37
|
listenTypes: config.pageTypeNames,
|
|
38
|
+
tag: 'pages',
|
|
38
39
|
})
|
|
39
40
|
|
|
40
41
|
// Redirections du Studio : l'adresse affichée est l'URL finale.
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import {useCallback, useEffect, useMemo, useRef, useState} from 'react'
|
|
2
|
+
import {subscribeShared} from './sharedListener'
|
|
2
3
|
import {useKitClient} from './useKitClient'
|
|
3
4
|
|
|
4
5
|
export interface QueryState<T> {
|
|
@@ -13,12 +14,33 @@ export interface UseQueryDataOptions {
|
|
|
13
14
|
listenTypes?: readonly string[]
|
|
14
15
|
/** `false` pour différer la requête (onglet pas encore ouvert). */
|
|
15
16
|
enabled?: boolean
|
|
17
|
+
/**
|
|
18
|
+
* La liste n'affiche que du publié : les brouillons en cours de frappe ne la font pas
|
|
19
|
+
* recharger.
|
|
20
|
+
*/
|
|
21
|
+
publishedOnly?: boolean
|
|
22
|
+
/**
|
|
23
|
+
* Étiquette des requêtes (`ncf-kit.<tag>` dans les journaux de requêtes de Sanity,
|
|
24
|
+
* sanity.io/manage > Usage) : pour savoir qui consomme quoi.
|
|
25
|
+
*/
|
|
26
|
+
tag?: string
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
/** Au plus un rechargement par intervalle pendant une saisie. */
|
|
30
|
+
const REFRESH_EVERY_MS = 3_000
|
|
31
|
+
/** Petite attente : une publication émet plusieurs événements d'affilée. */
|
|
32
|
+
const FIRST_DELAY_MS = 600
|
|
33
|
+
|
|
34
|
+
/** Étiquette acceptée par Sanity : lettres, chiffres, . _ - (75 caractères au plus). */
|
|
35
|
+
export function kitTag(tag: string | undefined): string {
|
|
36
|
+
const clean = (tag ?? 'query').replace(/[^a-zA-Z0-9._-]/g, '-').slice(0, 66)
|
|
37
|
+
return `ncf-kit.${clean}`
|
|
16
38
|
}
|
|
17
39
|
|
|
18
40
|
/**
|
|
19
41
|
* Exécute une requête GROQ et la rejoue quand le contenu change.
|
|
20
42
|
*
|
|
21
|
-
* Le rafraîchissement passe par un
|
|
43
|
+
* Le rafraîchissement passe par un signal d'écoute puis une nouvelle requête, plutôt
|
|
22
44
|
* que par l'application des mutations reçues : c'est plus lent mais toujours
|
|
23
45
|
* cohérent, y compris quand une publication modifie plusieurs documents.
|
|
24
46
|
*/
|
|
@@ -28,7 +50,8 @@ export function useQueryData<T>(
|
|
|
28
50
|
options: UseQueryDataOptions = {},
|
|
29
51
|
): QueryState<T> {
|
|
30
52
|
const client = useKitClient()
|
|
31
|
-
const {listenTypes, enabled = true} = options
|
|
53
|
+
const {listenTypes, enabled = true, publishedOnly = false} = options
|
|
54
|
+
const tag = kitTag(options.tag)
|
|
32
55
|
|
|
33
56
|
const [data, setData] = useState<T | null>(null)
|
|
34
57
|
const [loading, setLoading] = useState(enabled)
|
|
@@ -49,7 +72,7 @@ export function useQueryData<T>(
|
|
|
49
72
|
setLoading(true)
|
|
50
73
|
|
|
51
74
|
client
|
|
52
|
-
.fetch<T>(query, stableParams)
|
|
75
|
+
.fetch<T>(query, stableParams, {tag})
|
|
53
76
|
.then((result) => {
|
|
54
77
|
if (cancelled) return
|
|
55
78
|
setData(result)
|
|
@@ -68,7 +91,10 @@ export function useQueryData<T>(
|
|
|
68
91
|
}
|
|
69
92
|
}, [client, query, stableParams, enabled, tick])
|
|
70
93
|
|
|
71
|
-
/* --- Rafraîchissement sur
|
|
94
|
+
/* --- Rafraîchissement sur changement --- */
|
|
95
|
+
// Une écoute partagée par types (sharedListener.ts), signal seulement. Rechargement au
|
|
96
|
+
// plus toutes les 3 s pendant une saisie (la liste avance, sans relancer la requête à
|
|
97
|
+
// chaque frappe) ; onglet caché : rien, rechargement au retour sur l'onglet.
|
|
72
98
|
const refreshRef = useRef(refresh)
|
|
73
99
|
refreshRef.current = refresh
|
|
74
100
|
const typesKey = (listenTypes ?? []).join(',')
|
|
@@ -76,28 +102,39 @@ export function useQueryData<T>(
|
|
|
76
102
|
useEffect(() => {
|
|
77
103
|
if (!enabled || !typesKey) return undefined
|
|
78
104
|
|
|
79
|
-
const types = typesKey.split(',')
|
|
80
|
-
// Fenêtre courte : une publication émet plusieurs événements d'affilée,
|
|
81
|
-
// on ne veut pas relancer la requête à chacun.
|
|
82
105
|
let timer: ReturnType<typeof setTimeout> | undefined
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
106
|
+
let lastRefresh = Date.now()
|
|
107
|
+
let staleWhileHidden = false
|
|
108
|
+
const run = () => {
|
|
109
|
+
timer = undefined
|
|
110
|
+
if (typeof document !== 'undefined' && document.hidden) {
|
|
111
|
+
staleWhileHidden = true
|
|
112
|
+
return
|
|
113
|
+
}
|
|
114
|
+
lastRefresh = Date.now()
|
|
115
|
+
refreshRef.current()
|
|
116
|
+
}
|
|
117
|
+
const onChange = () => {
|
|
118
|
+
if (timer) return
|
|
119
|
+
const wait = Math.max(FIRST_DELAY_MS, REFRESH_EVERY_MS - (Date.now() - lastRefresh))
|
|
120
|
+
timer = setTimeout(run, wait)
|
|
121
|
+
}
|
|
122
|
+
const onVisible = () => {
|
|
123
|
+
if (!document.hidden && staleWhileHidden) {
|
|
124
|
+
staleWhileHidden = false
|
|
125
|
+
lastRefresh = Date.now()
|
|
126
|
+
refreshRef.current()
|
|
127
|
+
}
|
|
128
|
+
}
|
|
129
|
+
const unsubscribe = subscribeShared(client, typesKey.split(','), publishedOnly, onChange, tag)
|
|
130
|
+
document.addEventListener('visibilitychange', onVisible)
|
|
95
131
|
|
|
96
132
|
return () => {
|
|
97
133
|
if (timer) clearTimeout(timer)
|
|
98
|
-
|
|
134
|
+
unsubscribe()
|
|
135
|
+
document.removeEventListener('visibilitychange', onVisible)
|
|
99
136
|
}
|
|
100
|
-
}, [client, typesKey, enabled])
|
|
137
|
+
}, [client, typesKey, enabled, publishedOnly, tag])
|
|
101
138
|
|
|
102
139
|
return {data, loading, error, refresh}
|
|
103
140
|
}
|
|
@@ -8,6 +8,6 @@ const QUERY = `*[_type == $type && defined(from) && defined(to) && !(_id in path
|
|
|
8
8
|
export function useRedirectMap(redirectType: string): RedirectMap {
|
|
9
9
|
const params = useMemo(() => ({type: redirectType}), [redirectType])
|
|
10
10
|
const listenTypes = useMemo(() => [redirectType], [redirectType])
|
|
11
|
-
const {data} = useQueryData<{from?: string; to?: string}[]>(QUERY, params, {listenTypes})
|
|
11
|
+
const {data} = useQueryData<{from?: string; to?: string}[]>(QUERY, params, {listenTypes, publishedOnly: true, tag: 'redirect-map'})
|
|
12
12
|
return useMemo(() => redirectMapOf(data ?? []), [data])
|
|
13
13
|
}
|
|
@@ -39,7 +39,7 @@ function entryFor(client: SanityClient, documentId: string): Entry {
|
|
|
39
39
|
})
|
|
40
40
|
.catch(() => {})
|
|
41
41
|
void load()
|
|
42
|
-
const sub = client.listen(`*[_id == $id]`, {id}, {visibility: 'query', includeResult: false}).subscribe({next: () => void load()})
|
|
42
|
+
const sub = client.listen(`*[_id == $id]`, {id}, {visibility: 'query', includeResult: false, tag: 'ncf-kit.translation-todo'}).subscribe({next: () => void load()})
|
|
43
43
|
e.stop = () => sub.unsubscribe()
|
|
44
44
|
}
|
|
45
45
|
return e
|
|
@@ -14,6 +14,7 @@ export function useTranslationTodos(): ReadonlyMap<string, number> {
|
|
|
14
14
|
const params = useMemo(() => ({type: TRANSLATION_TODO_TYPE}), [])
|
|
15
15
|
const {data} = useQueryData<{documentId: string; count: number}[]>(QUERY, params, {
|
|
16
16
|
listenTypes: [TRANSLATION_TODO_TYPE],
|
|
17
|
+
tag: 'translation-todos',
|
|
17
18
|
enabled: Boolean(config.i18n),
|
|
18
19
|
})
|
|
19
20
|
return useMemo(() => new Map((data ?? []).map((t) => [t.documentId, t.count])), [data])
|
package/src/version.ts
CHANGED