@nocode-factory/sanity-kit 2.54.0 → 2.56.0
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/README.md +23 -5
- package/dist/index.d.ts +48 -4
- package/dist/index.js +287 -69
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
- package/src/hooks/useCollection.ts +19 -3
- package/src/lib/collectionQuery.ts +10 -2
- package/src/structure/collections.tsx +35 -5
- package/src/tools/collections/CollectionTable.tsx +257 -78
- package/src/tools/collections/CollectionToolbar.tsx +53 -4
- package/src/version.ts +1 -1
package/README.md
CHANGED
|
@@ -49,12 +49,16 @@ Zéro ✖ = projet complet. Sortie 1 sinon (utilisable en CI).
|
|
|
49
49
|
|
|
50
50
|
Cliquer une collection dans l'onglet **Structure** ouvre une **table** plutôt que
|
|
51
51
|
la liste native : une colonne par champ du CMS (texte, nombre, booléen, date et
|
|
52
|
-
**références** résolues en titre), ajout/masquage des colonnes,
|
|
53
|
-
**
|
|
54
|
-
|
|
55
|
-
|
|
52
|
+
**références** résolues en titre), ajout/masquage des colonnes, colonnes
|
|
53
|
+
**redimensionnables** (poignée) et **déplaçables** (glisser l'en-tête), **tri** et
|
|
54
|
+
**filtre** par colonne, recherche globale, **export CSV** de la vue courante et un
|
|
55
|
+
bouton **« + »** de création. Un **switch Liste / Table** en haut bascule entre la
|
|
56
|
+
vue dense et une liste compacte (titre + sous-titre, façon liste native). Lecture
|
|
57
|
+
seule sur les lignes : cliquer une ligne ouvre le document **en volet enfant** (à
|
|
58
|
+
droite ; les volets précédents se réduisent sans se fermer). Les colonnes sont
|
|
59
|
+
tirées du schéma — rien à déclarer.
|
|
56
60
|
|
|
57
|
-
|
|
61
|
+
Trois façons de la brancher dans le résolveur de structure :
|
|
58
62
|
|
|
59
63
|
```ts
|
|
60
64
|
import {ncfCollections, ncfCollectionTable} from '@nocode-factory/sanity-kit'
|
|
@@ -68,6 +72,20 @@ structure: (S, context) =>
|
|
|
68
72
|
|
|
69
73
|
// 2. Au cas par cas : la table comme vue d'une entrée de collection existante.
|
|
70
74
|
S.listItem().title('Articles').child(ncfCollectionTable(S, ncfOptions, 'article'))
|
|
75
|
+
|
|
76
|
+
// 3. Au NIVEAU FEUILLE : la table remplace la `documentList` la plus granulaire
|
|
77
|
+
// (une langue, une catégorie…) sans mélanger le reste. `filter`/`params` la
|
|
78
|
+
// restreignent, `newTemplate` garde la création pré-taguée, `id` reste unique
|
|
79
|
+
// quand un même type a plusieurs tables.
|
|
80
|
+
S.listItem().title('Français').child(
|
|
81
|
+
ncfCollectionTable(S, ncfOptions, 'newsArticle', {
|
|
82
|
+
id: 'ncf-col-newsArticle-fr',
|
|
83
|
+
title: 'News (Français)',
|
|
84
|
+
filter: 'language == $lang',
|
|
85
|
+
params: {lang: 'fr'},
|
|
86
|
+
newTemplate: 'newsArticle-fr',
|
|
87
|
+
}),
|
|
88
|
+
)
|
|
71
89
|
```
|
|
72
90
|
|
|
73
91
|
Sélection des types : par défaut tous les types de documents hors pages,
|
package/dist/index.d.ts
CHANGED
|
@@ -1427,7 +1427,7 @@ export declare function ActorName(props: {
|
|
|
1427
1427
|
* quelle version. Recopiée de `package.json` par `npm version` (scripts/sync-version.mjs) ; un test
|
|
1428
1428
|
* le vérifie.
|
|
1429
1429
|
*/
|
|
1430
|
-
export declare const KIT_VERSION = "2.
|
|
1430
|
+
export declare const KIT_VERSION = "2.56.0";
|
|
1431
1431
|
/**
|
|
1432
1432
|
* Données de la page proposées comme colonnes.
|
|
1433
1433
|
*
|
|
@@ -1901,9 +1901,29 @@ export declare function humanizeBlockName(type: string, namespace: string): stri
|
|
|
1901
1901
|
* ```ts
|
|
1902
1902
|
* S.listItem().title('Articles').child(ncfCollectionTable(S, ncfOptions, 'article'))
|
|
1903
1903
|
* ```
|
|
1904
|
+
*
|
|
1905
|
+
* `filter`/`params` posent la table au **niveau feuille** (une langue, une
|
|
1906
|
+
* catégorie…) sans mélanger le reste ; `newTemplate` garde la création
|
|
1907
|
+
* pré-taguée de ce niveau ; `id` sert quand un même type a plusieurs tables
|
|
1908
|
+
* (ex. une par langue), pour des identifiants de structure uniques.
|
|
1909
|
+
*
|
|
1910
|
+
* ```ts
|
|
1911
|
+
* S.documentList() // ancien niveau feuille…
|
|
1912
|
+
* ncfCollectionTable(S, ncfOptions, 'newsArticle', {
|
|
1913
|
+
* id: `ncf-col-newsArticle-${lang}`,
|
|
1914
|
+
* title: `News (${lang})`,
|
|
1915
|
+
* filter: 'language == $lang',
|
|
1916
|
+
* params: {lang},
|
|
1917
|
+
* newTemplate: `newsArticle-${lang}`,
|
|
1918
|
+
* })
|
|
1919
|
+
* ```
|
|
1904
1920
|
*/
|
|
1905
1921
|
export declare function ncfCollectionTable(S: StructureBuilder, options: NcfKitConfig, type: string, opts?: {
|
|
1906
1922
|
title?: string;
|
|
1923
|
+
id?: string;
|
|
1924
|
+
filter?: string;
|
|
1925
|
+
params?: Record<string, unknown>;
|
|
1926
|
+
newTemplate?: string;
|
|
1907
1927
|
}): import("sanity/structure").ComponentBuilder;
|
|
1908
1928
|
/**
|
|
1909
1929
|
* Entrées « collection » pour la structure du Studio, une par type découvert,
|
|
@@ -1917,8 +1937,16 @@ export declare function ncfCollectionTable(S: StructureBuilder, options: NcfKitC
|
|
|
1917
1937
|
export declare function ncfCollections(S: StructureBuilder, context: StructureResolverContext, options: NcfKitConfig): ListItemBuilder[];
|
|
1918
1938
|
interface CollectionTableProps {
|
|
1919
1939
|
type: string;
|
|
1940
|
+
/** Prédicat GROQ supplémentaire (ex. `language == $lang`) — niveau feuille. */
|
|
1941
|
+
filter?: string;
|
|
1942
|
+
/** Valeurs des paramètres du `filter` (ex. `{lang: 'fr'}`). */
|
|
1943
|
+
params?: Record<string, unknown>;
|
|
1944
|
+
/** Template de création à appliquer au « + » (ex. `article-fr`) : garde la
|
|
1945
|
+
* création pré-taguée (langue, catégorie…) du niveau feuille. Sans lui, le
|
|
1946
|
+
* « + » crée un document nu du type. */
|
|
1947
|
+
newTemplate?: string;
|
|
1920
1948
|
}
|
|
1921
|
-
export declare function CollectionTable({ type }: CollectionTableProps): import("react").JSX.Element;
|
|
1949
|
+
export declare function CollectionTable({ type, filter, params, newTemplate }: CollectionTableProps): import("react").JSX.Element;
|
|
1922
1950
|
/**
|
|
1923
1951
|
* Colonnes de la vue table d'une collection.
|
|
1924
1952
|
*
|
|
@@ -1985,12 +2013,22 @@ interface CollectionState {
|
|
|
1985
2013
|
error: Error | null;
|
|
1986
2014
|
refresh: () => void;
|
|
1987
2015
|
}
|
|
2016
|
+
interface UseCollectionOptions {
|
|
2017
|
+
/** Prédicat GROQ supplémentaire (ex. `language == $lang`) — niveau feuille. */
|
|
2018
|
+
filter?: string;
|
|
2019
|
+
/** Valeurs des paramètres du `filter` (ex. `{lang: 'fr'}`). */
|
|
2020
|
+
params?: Record<string, unknown>;
|
|
2021
|
+
}
|
|
1988
2022
|
/**
|
|
1989
2023
|
* Données d'une collection pour la vue table : colonnes tirées du schéma,
|
|
1990
2024
|
* lignes en direct. Seules les colonnes visibles sont projetées (comme
|
|
1991
2025
|
* `usePages`), pour ne pas tirer tout le schéma sur chaque document.
|
|
2026
|
+
*
|
|
2027
|
+
* `filter`/`params` restreignent la table au niveau feuille (une langue, une
|
|
2028
|
+
* catégorie…). `useQueryData` stabilise lui-même les paramètres, donc l'objet
|
|
2029
|
+
* peut être reconstruit à chaque rendu sans relancer la requête en boucle.
|
|
1992
2030
|
*/
|
|
1993
|
-
export declare function useCollection(type: string, visibleKeys: readonly string[]): CollectionState;
|
|
2031
|
+
export declare function useCollection(type: string, visibleKeys: readonly string[], options?: UseCollectionOptions): CollectionState;
|
|
1994
2032
|
/**
|
|
1995
2033
|
* Découverte des types « collection » à montrer en table. Pur : prend la liste
|
|
1996
2034
|
* des types du schéma (nom + nature JSON) et rend les types de documents
|
|
@@ -2025,11 +2063,17 @@ export declare function discoverCollectionTypes(types: readonly SchemaTypeInfo[]
|
|
|
2025
2063
|
*
|
|
2026
2064
|
* Le type passe en paramètre (`$type`), jamais interpolé dans la requête.
|
|
2027
2065
|
*
|
|
2066
|
+
* `filter` est un prédicat GROQ supplémentaire écrit par l'intégrateur (dans le
|
|
2067
|
+
* résolveur de structure), par exemple `language == $lang` : il restreint la
|
|
2068
|
+
* table au niveau feuille (une langue, une catégorie, une page…). Il est
|
|
2069
|
+
* parenthésé puis combiné en `&&`, et ses valeurs passent par `params`, jamais
|
|
2070
|
+
* interpolées. Même niveau de confiance que `S.documentList().filter(...)`.
|
|
2071
|
+
*
|
|
2028
2072
|
* On ne filtre pas les brouillons : le client (perspective `raw`) renvoie
|
|
2029
2073
|
* `drafts.x` ET `x`, que `buildCollectionRows` fusionne par id de base — sans
|
|
2030
2074
|
* quoi un item jamais publié n'apparaîtrait pas.
|
|
2031
2075
|
*/
|
|
2032
|
-
export declare function buildCollectionQuery(columns: readonly CollectionColumn[]): string;
|
|
2076
|
+
export declare function buildCollectionQuery(columns: readonly CollectionColumn[], filter?: string): string;
|
|
2033
2077
|
type SortDirection$1 = 'asc' | 'desc';
|
|
2034
2078
|
interface CollectionSort {
|
|
2035
2079
|
/** Clé de colonne, ou `null` pour l'ordre d'arrivée. */
|