sanity-plugin-dashboard-widget-document-list 0.0.13 → 3.0.0-studio-v3.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.
@@ -0,0 +1,217 @@
1
+ import {jsx as $9Ue0q$jsx, jsxs as $9Ue0q$jsxs} from "react/jsx-runtime";
2
+ import {useState as $9Ue0q$useState, useMemo as $9Ue0q$useMemo, useEffect as $9Ue0q$useEffect} from "react";
3
+ import {IntentButton as $9Ue0q$IntentButton, SanityPreview as $9Ue0q$SanityPreview} from "sanity/_unstable";
4
+ import {useClient as $9Ue0q$useClient, useSchema as $9Ue0q$useSchema, getPublishedId as $9Ue0q$getPublishedId} from "sanity";
5
+ import {intersection as $9Ue0q$intersection} from "lodash";
6
+ import {Card as $9Ue0q$Card, Flex as $9Ue0q$Flex, Spinner as $9Ue0q$Spinner, Stack as $9Ue0q$Stack} from "@sanity/ui";
7
+ import {DashboardWidgetContainer as $9Ue0q$DashboardWidgetContainer} from "@sanity/dashboard";
8
+ import {of as $9Ue0q$of} from "rxjs";
9
+ import {switchMap as $9Ue0q$switchMap, tap as $9Ue0q$tap, delay as $9Ue0q$delay, mergeMap as $9Ue0q$mergeMap} from "rxjs/operators";
10
+ import $9Ue0q$lodashuniqBy from "lodash/uniqBy";
11
+
12
+
13
+
14
+
15
+
16
+
17
+
18
+
19
+
20
+
21
+ const $31d241600102c2cb$var$draftId = (nonDraftDoc)=>`drafts.${nonDraftDoc._id}`;
22
+ function $31d241600102c2cb$var$prepareDocumentList(incoming, client) {
23
+ if (!incoming) return Promise.resolve([]);
24
+ const documents = Array.isArray(incoming) ? incoming : [
25
+ incoming
26
+ ];
27
+ const ids = documents.filter((doc)=>!doc._id.startsWith("drafts.")).map($31d241600102c2cb$var$draftId);
28
+ return client.fetch("*[_id in $ids]", {
29
+ ids: ids
30
+ }).then((drafts)=>{
31
+ const outgoing = documents.map((doc)=>{
32
+ const foundDraft = drafts.find((draft)=>draft._id === $31d241600102c2cb$var$draftId(doc));
33
+ return foundDraft || doc;
34
+ });
35
+ return (0, $9Ue0q$lodashuniqBy)(outgoing, "_id");
36
+ }).catch((error)=>{
37
+ throw new Error(`Problems fetching docs ${ids}. Error: ${error.message}`);
38
+ });
39
+ }
40
+ function $31d241600102c2cb$export$161e8c29756c0df4(query, params, client) {
41
+ return client.listen(query, params, {
42
+ events: [
43
+ "welcome",
44
+ "mutation"
45
+ ],
46
+ includeResult: false,
47
+ visibility: "query"
48
+ }).pipe((0, $9Ue0q$switchMap)((event)=>{
49
+ return (0, $9Ue0q$of)(1).pipe(event.type === "welcome" ? (0, $9Ue0q$tap)() : (0, $9Ue0q$delay)(1000), (0, $9Ue0q$mergeMap)(()=>client.fetch(query, params).then((incoming)=>{
50
+ return $31d241600102c2cb$var$prepareDocumentList(incoming, client);
51
+ }).catch((error)=>{
52
+ if (error.message.startsWith("Problems fetching docs")) throw error;
53
+ throw new Error(`Query failed ${query} and ${JSON.stringify(params)}. Error: ${error.message}`);
54
+ })));
55
+ }));
56
+ }
57
+
58
+
59
+
60
+
61
+ const $df774c2b801774e3$var$defaultProps = {
62
+ title: "Last created",
63
+ order: "_createdAt desc",
64
+ limit: 10,
65
+ queryParams: {},
66
+ showCreateButton: true,
67
+ apiVersion: "v1"
68
+ };
69
+ function $df774c2b801774e3$export$65a803c9e13a7e5b(props) {
70
+ const { query: query , limit: limit , apiVersion: apiVersion , queryParams: queryParams , types: types , order: order , title: title , showCreateButton: showCreateButton , createButtonText: createButtonText , } = {
71
+ ...$df774c2b801774e3$var$defaultProps,
72
+ ...props
73
+ };
74
+ const [documents, setDocuments] = (0, $9Ue0q$useState)();
75
+ const [loading, setLoading] = (0, $9Ue0q$useState)(true);
76
+ const [error, setError] = (0, $9Ue0q$useState)();
77
+ const client = (0, $9Ue0q$useClient)();
78
+ const schema = (0, $9Ue0q$useSchema)();
79
+ const versionedClient = (0, $9Ue0q$useMemo)(()=>client.withConfig({
80
+ apiVersion: apiVersion
81
+ }), [
82
+ client,
83
+ apiVersion
84
+ ]);
85
+ const { assembledQuery: assembledQuery , params: params } = (0, $9Ue0q$useMemo)(()=>{
86
+ if (query) return {
87
+ assembledQuery: query,
88
+ params: queryParams
89
+ };
90
+ const documentTypes = schema.getTypeNames().filter((typeName)=>{
91
+ const schemaType = schema.get(typeName);
92
+ return schemaType.type && schemaType.type.name === "document";
93
+ });
94
+ return {
95
+ assembledQuery: `*[_type in $types] | order(${order}) [0...${limit * 2}]`,
96
+ params: {
97
+ types: types ? (0, $9Ue0q$intersection)(types, documentTypes) : documentTypes
98
+ }
99
+ };
100
+ }, [
101
+ schema,
102
+ query,
103
+ queryParams,
104
+ order,
105
+ limit,
106
+ types
107
+ ]);
108
+ (0, $9Ue0q$useEffect)(()=>{
109
+ if (!assembledQuery) return;
110
+ const subscription = (0, $31d241600102c2cb$export$161e8c29756c0df4)(assembledQuery, params, versionedClient).subscribe({
111
+ next: (d)=>{
112
+ setDocuments(d.slice(0, limit));
113
+ setLoading(false);
114
+ },
115
+ error: (e)=>{
116
+ setError(e);
117
+ setLoading(false);
118
+ }
119
+ });
120
+ // eslint-disable-next-line consistent-return
121
+ return ()=>{
122
+ subscription.unsubscribe();
123
+ };
124
+ }, [
125
+ limit,
126
+ versionedClient,
127
+ assembledQuery,
128
+ params
129
+ ]);
130
+ return /*#__PURE__*/ (0, $9Ue0q$jsx)((0, $9Ue0q$DashboardWidgetContainer), {
131
+ header: title,
132
+ footer: types && types.length === 1 && showCreateButton && /*#__PURE__*/ (0, $9Ue0q$jsx)((0, $9Ue0q$IntentButton), {
133
+ mode: "bleed",
134
+ style: {
135
+ width: "100%"
136
+ },
137
+ paddingX: 2,
138
+ paddingY: 4,
139
+ tone: "primary",
140
+ type: "button",
141
+ intent: "create",
142
+ params: {
143
+ type: types[0]
144
+ },
145
+ text: createButtonText || `Create new ${types[0]}`
146
+ }),
147
+ children: /*#__PURE__*/ (0, $9Ue0q$jsxs)((0, $9Ue0q$Card), {
148
+ children: [
149
+ error && /*#__PURE__*/ (0, $9Ue0q$jsx)("div", {
150
+ children: error.message
151
+ }),
152
+ !error && loading && /*#__PURE__*/ (0, $9Ue0q$jsx)((0, $9Ue0q$Card), {
153
+ padding: 4,
154
+ children: /*#__PURE__*/ (0, $9Ue0q$jsx)((0, $9Ue0q$Flex), {
155
+ justify: "center",
156
+ children: /*#__PURE__*/ (0, $9Ue0q$jsx)((0, $9Ue0q$Spinner), {
157
+ muted: true
158
+ })
159
+ })
160
+ }),
161
+ !error && !documents && !loading && /*#__PURE__*/ (0, $9Ue0q$jsx)("div", {
162
+ children: "Could not locate any documents :/"
163
+ }),
164
+ /*#__PURE__*/ (0, $9Ue0q$jsx)((0, $9Ue0q$Stack), {
165
+ space: 2,
166
+ children: documents && documents.map((doc)=>/*#__PURE__*/ (0, $9Ue0q$jsx)($df774c2b801774e3$var$MenuEntry, {
167
+ doc: doc
168
+ }, doc._id))
169
+ })
170
+ ]
171
+ })
172
+ });
173
+ }
174
+ function $df774c2b801774e3$var$MenuEntry({ doc: doc }) {
175
+ const schema = (0, $9Ue0q$useSchema)();
176
+ const type = schema.get(doc._type);
177
+ return /*#__PURE__*/ (0, $9Ue0q$jsx)((0, $9Ue0q$Card), {
178
+ flex: 1,
179
+ children: /*#__PURE__*/ (0, $9Ue0q$jsx)((0, $9Ue0q$IntentButton), {
180
+ intent: "edit",
181
+ mode: "bleed",
182
+ padding: 1,
183
+ radius: 0,
184
+ params: {
185
+ type: doc._type,
186
+ id: (0, $9Ue0q$getPublishedId)(doc._id)
187
+ },
188
+ style: {
189
+ width: "100%"
190
+ },
191
+ children: /*#__PURE__*/ (0, $9Ue0q$jsx)((0, $9Ue0q$SanityPreview), {
192
+ layout: "default",
193
+ type: type,
194
+ value: doc
195
+ }, doc._id)
196
+ })
197
+ });
198
+ }
199
+ var $df774c2b801774e3$export$2e2bcd8739ae039 = $df774c2b801774e3$export$65a803c9e13a7e5b;
200
+
201
+
202
+
203
+ function $090815f5086f7f29$export$398a1547d616c51(config) {
204
+ return {
205
+ name: "document-list-widget",
206
+ component: function component() {
207
+ return /*#__PURE__*/ (0, $9Ue0q$jsx)((0, $df774c2b801774e3$export$2e2bcd8739ae039), {
208
+ ...config
209
+ });
210
+ },
211
+ layout: config.layout
212
+ };
213
+ }
214
+
215
+
216
+ export {$090815f5086f7f29$export$398a1547d616c51 as documentListWidget};
217
+ //# sourceMappingURL=index.modern.js.map
@@ -0,0 +1 @@
1
+ {"mappings":";;;;;;;;;;;AAAA;ACAA;;;;;ACAA;;;AAMA,MAAM,6BAAO,GAAG,CAAC,WAA2B,GAAK,CAAC,OAAO,EAAE,WAAW,CAAC,GAAG,CAAC,CAAC;AAE5E,SAAS,yCAAmB,CAC1B,QAA2C,EAC3C,MAAoB,EACO;IAC3B,IAAI,CAAC,QAAQ,EACX,OAAO,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;IAE5B,MAAM,SAAS,GAAG,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,QAAQ,GAAG;QAAC,QAAQ;KAAC;IAEjE,MAAM,GAAG,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,GAAG,GAAK,CAAC,GAAG,CAAC,GAAG,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,6BAAO,CAAC;IAElF,OAAO,MAAM,CACV,KAAK,CAAC,gBAAgB,EAAE;aAAC,GAAG;KAAC,CAAC,CAC9B,IAAI,CAAC,CAAC,MAAM,GAAK;QAChB,MAAM,QAAQ,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,GAAG,GAAK;YACtC,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,GAAK,KAAK,CAAC,GAAG,KAAK,6BAAO,CAAC,GAAG,CAAC,CAAC;YACrE,OAAO,UAAU,IAAI,GAAG,CAAA;SACzB,CAAC;QACF,OAAO,CAAA,GAAA,mBAAM,CAAA,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAA;KAC/B,CAAC,CACD,KAAK,CAAC,CAAC,KAAK,GAAK;QAChB,MAAM,IAAI,KAAK,CAAC,CAAC,uBAAuB,EAAE,GAAG,CAAC,SAAS,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAA;KAC1E,CAAC,CAAA;CACL;AAEM,SAAS,yCAAe,CAC7B,KAAa,EACb,MAA2B,EAC3B,MAAoB,EACU;IAC9B,OAAO,MAAM,CACV,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE;QACrB,MAAM,EAAE;YAAC,SAAS;YAAE,UAAU;SAAC;QAC/B,aAAa,EAAE,KAAK;QACpB,UAAU,EAAE,OAAO;KACpB,CAAC,CACD,IAAI,CACH,CAAA,GAAA,gBAAS,CAAA,CAAC,CAAC,KAAK,GAAK;QACnB,OAAO,CAAA,GAAA,SAAY,CAAA,CAAC,CAAC,CAAC,CAAC,IAAI,CACzB,KAAK,CAAC,IAAI,KAAK,SAAS,GAAG,CAAA,GAAA,UAAG,CAAA,EAAE,GAAG,CAAA,GAAA,YAAK,CAAA,CAAC,IAAI,CAAC,EAC9C,CAAA,GAAA,eAAQ,CAAA,CAAC,IACP,MAAM,CACH,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CACpB,IAAI,CAAC,CAAC,QAAQ,GAAK;gBAClB,OAAO,yCAAmB,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;aAC7C,CAAC,CACD,KAAK,CAAC,CAAC,KAAK,GAAK;gBAChB,IAAI,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,wBAAwB,CAAC,EACpD,MAAM,KAAK,CAAA;gBAEb,MAAM,IAAI,KAAK,CACb,CAAC,aAAa,EAAE,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,SAAS,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAC/E,CAAA;aACF,CAAC,CACL,CACF,CAAA;KACF,CAAC,CACH,CAAA;CACJ;;;;;AD7CD,MAAM,kCAAY,GAAG;IACnB,KAAK,EAAE,cAAc;IACrB,KAAK,EAAE,iBAAiB;IACxB,KAAK,EAAE,EAAE;IACT,WAAW,EAAE,EAAE;IACf,gBAAgB,EAAE,IAAI;IACtB,UAAU,EAAE,IAAI;CACjB;AAEM,SAAS,yCAAY,CAAC,KAAyB,EAAE;IACtD,MAAM,SACJ,KAAK,CAAA,SACL,KAAK,CAAA,cACL,UAAU,CAAA,eACV,WAAW,CAAA,SACX,KAAK,CAAA,SACL,KAAK,CAAA,SACL,KAAK,CAAA,oBACL,gBAAgB,CAAA,oBAChB,gBAAgB,CAAA,IACjB,GAAG;QACF,GAAG,kCAAY;QACf,GAAG,KAAK;KACT;IAED,MAAM,CAAC,SAAS,EAAE,YAAY,CAAC,GAAG,CAAA,GAAA,eAAQ,CAAA,EAAgC;IAC1E,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,CAAA,GAAA,eAAQ,CAAA,CAAU,IAAI,CAAC;IACrD,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,CAAA,GAAA,eAAQ,CAAA,EAAqB;IAEvD,MAAM,MAAM,GAAG,CAAA,GAAA,gBAAS,CAAA,EAAE;IAC1B,MAAM,MAAM,GAAG,CAAA,GAAA,gBAAS,CAAA,EAAE;IAC1B,MAAM,eAAe,GAAG,CAAA,GAAA,cAAO,CAAA,CAAC,IAAM,MAAM,CAAC,UAAU,CAAC;wBAAC,UAAU;SAAC,CAAC,EAAE;QAAC,MAAM;QAAE,UAAU;KAAC,CAAC;IAE5F,MAAM,kBAAC,cAAc,CAAA,UAAE,MAAM,CAAA,EAAC,GAAG,CAAA,GAAA,cAAO,CAAA,CAAC,IAAM;QAC7C,IAAI,KAAK,EACP,OAAO;YAAC,cAAc,EAAE,KAAK;YAAE,MAAM,EAAE,WAAW;SAAC,CAAA;QAGrD,MAAM,aAAa,GAAG,MAAM,CAAC,YAAY,EAAE,CAAC,MAAM,CAAC,CAAC,QAAQ,GAAK;YAC/D,MAAM,UAAU,GAAG,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;YACvC,OAAO,UAAU,CAAC,IAAI,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,KAAK,UAAU,CAAA;SAC9D,CAAC;QAEF,OAAO;YACL,cAAc,EAAE,CAAC,2BAA2B,EAAE,KAAK,CAAC,OAAO,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC;YACzE,MAAM,EAAE;gBAAC,KAAK,EAAE,KAAK,GAAG,CAAA,GAAA,mBAAY,CAAA,CAAC,KAAK,EAAE,aAAa,CAAC,GAAG,aAAa;aAAC;SAC5E,CAAA;KACF,EAAE;QAAC,MAAM;QAAE,KAAK;QAAE,WAAW;QAAE,KAAK;QAAE,KAAK;QAAE,KAAK;KAAC,CAAC;IAErD,CAAA,GAAA,gBAAS,CAAA,CAAC,IAAM;QACd,IAAI,CAAC,cAAc,EACjB,OAAM;QAGR,MAAM,YAAY,GAAG,CAAA,GAAA,yCAAe,CAAA,CAAC,cAAc,EAAE,MAAM,EAAE,eAAe,CAAC,CAAC,SAAS,CAAC;YACtF,IAAI,EAAE,CAAC,CAAC,GAAK;gBACX,YAAY,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;gBAC/B,UAAU,CAAC,KAAK,CAAC;aAClB;YACD,KAAK,EAAE,CAAC,CAAC,GAAK;gBACZ,QAAQ,CAAC,CAAC,CAAC;gBACX,UAAU,CAAC,KAAK,CAAC;aAClB;SACF,CAAC;QACF,6CAA6C;QAC7C,OAAO,IAAM;YACX,YAAY,CAAC,WAAW,EAAE;SAC3B,CAAA;KACF,EAAE;QAAC,KAAK;QAAE,eAAe;QAAE,cAAc;QAAE,MAAM;KAAC,CAAC;IAEpD,qBACE,gBAAC,CAAA,GAAA,+BAAwB,CAAA;QACvB,MAAM,EAAE,KAAK;QACb,MAAM,EACJ,KAAK,IACL,KAAK,CAAC,MAAM,KAAK,CAAC,IAClB,gBAAgB,kBACd,gBAAC,CAAA,GAAA,mBAAY,CAAA;YACX,IAAI,EAAC,OAAO;YACZ,KAAK,EAAE;gBAAC,KAAK,EAAE,MAAM;aAAC;YACtB,QAAQ,EAAE,CAAC;YACX,QAAQ,EAAE,CAAC;YACX,IAAI,EAAC,SAAS;YACd,IAAI,EAAC,QAAQ;YACb,MAAM,EAAC,QAAQ;YACf,MAAM,EAAE;gBAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;aAAC;YACxB,IAAI,EAAE,gBAAgB,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;UAClD,AACH;kBAGH,cAAA,iBAAC,CAAA,GAAA,WAAI,CAAA;;gBACF,KAAK,kBAAI,gBAAC,KAAG;8BAAE,KAAK,CAAC,OAAO;kBAAO;gBACnC,CAAC,KAAK,IAAI,OAAO,kBAChB,gBAAC,CAAA,GAAA,WAAI,CAAA;oBAAC,OAAO,EAAE,CAAC;8BACd,cAAA,gBAAC,CAAA,GAAA,WAAI,CAAA;wBAAC,OAAO,EAAC,QAAQ;kCACpB,cAAA,gBAAC,CAAA,GAAA,cAAO,CAAA;4BAAC,KAAK;0BAAG;sBACZ;kBACF,AACR;gBACA,CAAC,KAAK,IAAI,CAAC,SAAS,IAAI,CAAC,OAAO,kBAAI,gBAAC,KAAG;8BAAC,mCAAiC;kBAAM;8BACjF,gBAAC,CAAA,GAAA,YAAK,CAAA;oBAAC,KAAK,EAAE,CAAC;8BACZ,SAAS,IAAI,SAAS,CAAC,GAAG,CAAC,CAAC,GAAG,iBAAK,gBAAC,+BAAS;4BAAe,GAAG,EAAE,GAAG;2BAAjB,GAAG,CAAC,GAAG,CAAc,CAAC;kBACrE;;UACH;MACkB,CAC5B;CACF;AAED,SAAS,+BAAS,CAAC,OAAC,GAAG,CAAA,EAAwB,EAAE;IAC/C,MAAM,MAAM,GAAG,CAAA,GAAA,gBAAS,CAAA,EAAE;IAC1B,MAAM,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC;IAClC,qBACE,gBAAC,CAAA,GAAA,WAAI,CAAA;QAAC,IAAI,EAAE,CAAC;kBACX,cAAA,gBAAC,CAAA,GAAA,mBAAY,CAAA;YACX,MAAM,EAAC,MAAM;YACb,IAAI,EAAC,OAAO;YACZ,OAAO,EAAE,CAAC;YACV,MAAM,EAAE,CAAC;YACT,MAAM,EAAE;gBACN,IAAI,EAAE,GAAG,CAAC,KAAK;gBACf,EAAE,EAAE,CAAA,GAAA,qBAAc,CAAA,CAAC,GAAG,CAAC,GAAG,CAAC;aAC5B;YACD,KAAK,EAAE;gBAAC,KAAK,EAAE,MAAM;aAAC;sBAEtB,cAAA,gBAAC,CAAA,GAAA,oBAAa,CAAA;gBAAC,MAAM,EAAC,SAAS;gBAAC,IAAI,EAAE,IAAI;gBAAE,KAAK,EAAE,GAAG;eAAO,GAAG,CAAC,GAAG,CAAI;UAC3D;MACV,CACR;CACF;IAED,wCAA2B,GAAZ,yCAAY;;;;ADhJpB,SAAS,wCAAkB,CAAC,MAAgC,EAAmB;IACpF,OAAO;QACL,IAAI,EAAE,sBAAsB;QAC5B,SAAS,EAAE,SAAS,SAAS,GAAG;YAC9B,qBAAO,gBAAC,CAAA,GAAA,wCAAY,CAAA;gBAAE,GAAG,MAAM;cAAI,CAAA;SACpC;QACD,MAAM,EAAE,MAAM,CAAC,MAAM;KACtB,CAAA;CACF","sources":["src/index.tsx","src/DocumentList.tsx","src/sanityConnector.ts"],"sourcesContent":["import DocumentList, {DocumentListConfig} from './DocumentList'\nimport React from 'react'\nimport {LayoutConfig, DashboardWidget} from '@sanity/dashboard'\n\nexport interface DocumentListWidgetConfig extends DocumentListConfig {\n layout?: LayoutConfig\n}\n\nexport function documentListWidget(config: DocumentListWidgetConfig): DashboardWidget {\n return {\n name: 'document-list-widget',\n component: function component() {\n return <DocumentList {...config} />\n },\n layout: config.layout,\n }\n}\n","import React, {useEffect, useMemo, useState} from 'react'\nimport {IntentButton, SanityPreview} from 'sanity/_unstable'\nimport {getPublishedId, useClient, useSchema} from 'sanity'\nimport {intersection} from 'lodash'\nimport {getSubscription} from './sanityConnector'\nimport {SanityDocument} from '@sanity/types'\nimport {Card, Flex, Spinner, Stack} from '@sanity/ui'\nimport {DashboardWidgetContainer} from '@sanity/dashboard'\n\nexport interface DocumentListConfig {\n title?: string\n types?: string[]\n query?: string\n queryParams?: Record<string, any>\n order?: string\n limit?: number\n showCreateButton?: boolean\n createButtonText?: string\n apiVersion?: string\n}\n\nconst defaultProps = {\n title: 'Last created',\n order: '_createdAt desc',\n limit: 10,\n queryParams: {},\n showCreateButton: true,\n apiVersion: 'v1',\n}\n\nexport function DocumentList(props: DocumentListConfig) {\n const {\n query,\n limit,\n apiVersion,\n queryParams,\n types,\n order,\n title,\n showCreateButton,\n createButtonText,\n } = {\n ...defaultProps,\n ...props,\n }\n\n const [documents, setDocuments] = useState<SanityDocument[] | undefined>()\n const [loading, setLoading] = useState<boolean>(true)\n const [error, setError] = useState<Error | undefined>()\n\n const client = useClient()\n const schema = useSchema()\n const versionedClient = useMemo(() => client.withConfig({apiVersion}), [client, apiVersion])\n\n const {assembledQuery, params} = useMemo(() => {\n if (query) {\n return {assembledQuery: query, params: queryParams}\n }\n\n const documentTypes = schema.getTypeNames().filter((typeName) => {\n const schemaType = schema.get(typeName)\n return schemaType.type && schemaType.type.name === 'document'\n })\n\n return {\n assembledQuery: `*[_type in $types] | order(${order}) [0...${limit * 2}]`,\n params: {types: types ? intersection(types, documentTypes) : documentTypes},\n }\n }, [schema, query, queryParams, order, limit, types])\n\n useEffect(() => {\n if (!assembledQuery) {\n return\n }\n\n const subscription = getSubscription(assembledQuery, params, versionedClient).subscribe({\n next: (d) => {\n setDocuments(d.slice(0, limit))\n setLoading(false)\n },\n error: (e) => {\n setError(e)\n setLoading(false)\n },\n })\n // eslint-disable-next-line consistent-return\n return () => {\n subscription.unsubscribe()\n }\n }, [limit, versionedClient, assembledQuery, params])\n\n return (\n <DashboardWidgetContainer\n header={title}\n footer={\n types &&\n types.length === 1 &&\n showCreateButton && (\n <IntentButton\n mode=\"bleed\"\n style={{width: '100%'}}\n paddingX={2}\n paddingY={4}\n tone=\"primary\"\n type=\"button\"\n intent=\"create\"\n params={{type: types[0]}}\n text={createButtonText || `Create new ${types[0]}`}\n />\n )\n }\n >\n <Card>\n {error && <div>{error.message}</div>}\n {!error && loading && (\n <Card padding={4}>\n <Flex justify=\"center\">\n <Spinner muted />\n </Flex>\n </Card>\n )}\n {!error && !documents && !loading && <div>Could not locate any documents :/</div>}\n <Stack space={2}>\n {documents && documents.map((doc) => <MenuEntry key={doc._id} doc={doc} />)}\n </Stack>\n </Card>\n </DashboardWidgetContainer>\n )\n}\n\nfunction MenuEntry({doc}: {doc: SanityDocument}) {\n const schema = useSchema()\n const type = schema.get(doc._type)\n return (\n <Card flex={1}>\n <IntentButton\n intent=\"edit\"\n mode=\"bleed\"\n padding={1}\n radius={0}\n params={{\n type: doc._type,\n id: getPublishedId(doc._id),\n }}\n style={{width: '100%'}}\n >\n <SanityPreview layout=\"default\" type={type} value={doc} key={doc._id} />\n </IntentButton>\n </Card>\n )\n}\n\nexport default DocumentList\n","import {Observable, of as observableOf} from 'rxjs'\nimport {delay, mergeMap, switchMap, tap} from 'rxjs/operators'\nimport uniqBy from 'lodash/uniqBy'\nimport {SanityClient} from '@sanity/client'\nimport {SanityDocument} from '@sanity/types'\n\nconst draftId = (nonDraftDoc: SanityDocument) => `drafts.${nonDraftDoc._id}`\n\nfunction prepareDocumentList(\n incoming: SanityDocument | SanityDocument[],\n client: SanityClient\n): Promise<SanityDocument[]> {\n if (!incoming) {\n return Promise.resolve([])\n }\n const documents = Array.isArray(incoming) ? incoming : [incoming]\n\n const ids = documents.filter((doc) => !doc._id.startsWith('drafts.')).map(draftId)\n\n return client\n .fetch('*[_id in $ids]', {ids})\n .then((drafts) => {\n const outgoing = documents.map((doc) => {\n const foundDraft = drafts.find((draft) => draft._id === draftId(doc))\n return foundDraft || doc\n })\n return uniqBy(outgoing, '_id')\n })\n .catch((error) => {\n throw new Error(`Problems fetching docs ${ids}. Error: ${error.message}`)\n })\n}\n\nexport function getSubscription(\n query: string,\n params: Record<string, any>,\n client: SanityClient\n): Observable<SanityDocument[]> {\n return client\n .listen(query, params, {\n events: ['welcome', 'mutation'],\n includeResult: false,\n visibility: 'query',\n })\n .pipe(\n switchMap((event) => {\n return observableOf(1).pipe(\n event.type === 'welcome' ? tap() : delay(1000),\n mergeMap(() =>\n client\n .fetch(query, params)\n .then((incoming) => {\n return prepareDocumentList(incoming, client)\n })\n .catch((error) => {\n if (error.message.startsWith('Problems fetching docs')) {\n throw error\n }\n throw new Error(\n `Query failed ${query} and ${JSON.stringify(params)}. Error: ${error.message}`\n )\n })\n )\n )\n })\n )\n}\n"],"names":[],"version":3,"file":"index.modern.js.map"}
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "public": true,
3
3
  "name": "sanity-plugin-dashboard-widget-document-list",
4
- "version": "0.0.13",
4
+ "version": "3.0.0-studio-v3.0",
5
5
  "author": "Sanity.io <hello@sanity.io>",
6
6
  "description": "Example dashboard widget for Sanity Content Studio",
7
7
  "homepage": "https://github.com/sanity-io/dashboard-widget-document-list#readme",
@@ -13,37 +13,68 @@
13
13
  "widget",
14
14
  "documents"
15
15
  ],
16
- "main": "lib/index.js",
17
- "license": "MIT",
18
- "bugs": {
19
- "url": "https://github.com/sanity-io/dashboard-widget-document-list/issues"
16
+ "source": "./src/index.tsx",
17
+ "exports": {
18
+ ".": {
19
+ "require": "./lib/cjs/index.js",
20
+ "default": "./lib/esm/index.js"
21
+ }
20
22
  },
23
+ "main": "./lib/cjs/index.js",
24
+ "module": "./lib/esm/index.js",
25
+ "types": "./lib/types/index.d.ts",
26
+ "files": [
27
+ "src",
28
+ "lib"
29
+ ],
21
30
  "scripts": {
22
- "build": "sanipack build",
23
- "test": "sanipack verify",
24
31
  "clean": "rimraf lib",
25
- "prebuild": "npm run clean",
26
- "prepublishOnly": "npm run build && npm test"
32
+ "prebuild": "npm run clean && tsc --noEmit",
33
+ "build": "parcel build",
34
+ "watch": "parcel watch",
35
+ "prepublishOnly": "npm run build",
36
+ "compile": "tsc --noEmit",
37
+ "lint": "eslint ."
38
+ },
39
+ "sanityPlugin": {},
40
+ "license": "MIT",
41
+ "bugs": {
42
+ "url": "https://github.com/sanity-io/dashboard-widget-document-list/issues"
27
43
  },
28
44
  "repository": {
29
45
  "type": "git",
30
46
  "url": "git+https://github.com/sanity-io/dashboard-widget-document-list.git"
31
47
  },
32
48
  "devDependencies": {
33
- "babel-eslint": "^7.2.3",
34
- "eslint": "^4.3.0",
35
- "eslint-config-sanity": "^2.1.4",
36
- "eslint-plugin-react": "^7.1.0",
37
- "rimraf": "^2.7.1",
38
- "sanipack": "^1.0.8"
49
+ "@commitlint/cli": "^16.2.4",
50
+ "@commitlint/config-conventional": "^16.2.4",
51
+ "@parcel/packager-ts": "^2.6.0",
52
+ "@parcel/transformer-typescript-types": "^2.6.0",
53
+ "@types/react": "^17.0.0 || ^18.0.0",
54
+ "@typescript-eslint/eslint-plugin": "^5.12.0",
55
+ "@typescript-eslint/parser": "^5.12.0",
56
+ "eslint": "^8.7.0",
57
+ "eslint-config-prettier": "^8.3.0",
58
+ "eslint-config-sanity": "^5.1.0",
59
+ "eslint-plugin-prettier": "4.0.0",
60
+ "eslint-plugin-react": "^7.28.0",
61
+ "eslint-plugin-react-hooks": "^4.5.0",
62
+ "husky": "^7.0.0",
63
+ "parcel": "^2.6.0",
64
+ "prettier": "^2.6.2",
65
+ "react": "^17.0.0 || ^18.0.0",
66
+ "rimraf": "^3.0.2",
67
+ "sanity": "2.29.5-purple-unicorn.856",
68
+ "typescript": "^4.7.3"
39
69
  },
40
70
  "peerDependencies": {
41
- "@sanity/base": ">=1",
42
- "react": "^16 || ^17"
71
+ "react": "^17.0.0 || ^18.0.0",
72
+ "sanity": "2.29.5-purple-unicorn.856"
43
73
  },
44
74
  "dependencies": {
75
+ "@sanity/ui": "^0.37.9",
76
+ "@sanity/dashboard": "studio-v3",
45
77
  "lodash": "^4.17.15",
46
- "prop-types": "^15.7.2",
47
78
  "rxjs": "^6.0.0"
48
79
  }
49
80
  }
@@ -0,0 +1,153 @@
1
+ import React, {useEffect, useMemo, useState} from 'react'
2
+ import {IntentButton, SanityPreview} from 'sanity/_unstable'
3
+ import {getPublishedId, useClient, useSchema} from 'sanity'
4
+ import {intersection} from 'lodash'
5
+ import {getSubscription} from './sanityConnector'
6
+ import {SanityDocument} from '@sanity/types'
7
+ import {Card, Flex, Spinner, Stack} from '@sanity/ui'
8
+ import {DashboardWidgetContainer} from '@sanity/dashboard'
9
+
10
+ export interface DocumentListConfig {
11
+ title?: string
12
+ types?: string[]
13
+ query?: string
14
+ queryParams?: Record<string, any>
15
+ order?: string
16
+ limit?: number
17
+ showCreateButton?: boolean
18
+ createButtonText?: string
19
+ apiVersion?: string
20
+ }
21
+
22
+ const defaultProps = {
23
+ title: 'Last created',
24
+ order: '_createdAt desc',
25
+ limit: 10,
26
+ queryParams: {},
27
+ showCreateButton: true,
28
+ apiVersion: 'v1',
29
+ }
30
+
31
+ export function DocumentList(props: DocumentListConfig) {
32
+ const {
33
+ query,
34
+ limit,
35
+ apiVersion,
36
+ queryParams,
37
+ types,
38
+ order,
39
+ title,
40
+ showCreateButton,
41
+ createButtonText,
42
+ } = {
43
+ ...defaultProps,
44
+ ...props,
45
+ }
46
+
47
+ const [documents, setDocuments] = useState<SanityDocument[] | undefined>()
48
+ const [loading, setLoading] = useState<boolean>(true)
49
+ const [error, setError] = useState<Error | undefined>()
50
+
51
+ const client = useClient()
52
+ const schema = useSchema()
53
+ const versionedClient = useMemo(() => client.withConfig({apiVersion}), [client, apiVersion])
54
+
55
+ const {assembledQuery, params} = useMemo(() => {
56
+ if (query) {
57
+ return {assembledQuery: query, params: queryParams}
58
+ }
59
+
60
+ const documentTypes = schema.getTypeNames().filter((typeName) => {
61
+ const schemaType = schema.get(typeName)
62
+ return schemaType.type && schemaType.type.name === 'document'
63
+ })
64
+
65
+ return {
66
+ assembledQuery: `*[_type in $types] | order(${order}) [0...${limit * 2}]`,
67
+ params: {types: types ? intersection(types, documentTypes) : documentTypes},
68
+ }
69
+ }, [schema, query, queryParams, order, limit, types])
70
+
71
+ useEffect(() => {
72
+ if (!assembledQuery) {
73
+ return
74
+ }
75
+
76
+ const subscription = getSubscription(assembledQuery, params, versionedClient).subscribe({
77
+ next: (d) => {
78
+ setDocuments(d.slice(0, limit))
79
+ setLoading(false)
80
+ },
81
+ error: (e) => {
82
+ setError(e)
83
+ setLoading(false)
84
+ },
85
+ })
86
+ // eslint-disable-next-line consistent-return
87
+ return () => {
88
+ subscription.unsubscribe()
89
+ }
90
+ }, [limit, versionedClient, assembledQuery, params])
91
+
92
+ return (
93
+ <DashboardWidgetContainer
94
+ header={title}
95
+ footer={
96
+ types &&
97
+ types.length === 1 &&
98
+ showCreateButton && (
99
+ <IntentButton
100
+ mode="bleed"
101
+ style={{width: '100%'}}
102
+ paddingX={2}
103
+ paddingY={4}
104
+ tone="primary"
105
+ type="button"
106
+ intent="create"
107
+ params={{type: types[0]}}
108
+ text={createButtonText || `Create new ${types[0]}`}
109
+ />
110
+ )
111
+ }
112
+ >
113
+ <Card>
114
+ {error && <div>{error.message}</div>}
115
+ {!error && loading && (
116
+ <Card padding={4}>
117
+ <Flex justify="center">
118
+ <Spinner muted />
119
+ </Flex>
120
+ </Card>
121
+ )}
122
+ {!error && !documents && !loading && <div>Could not locate any documents :/</div>}
123
+ <Stack space={2}>
124
+ {documents && documents.map((doc) => <MenuEntry key={doc._id} doc={doc} />)}
125
+ </Stack>
126
+ </Card>
127
+ </DashboardWidgetContainer>
128
+ )
129
+ }
130
+
131
+ function MenuEntry({doc}: {doc: SanityDocument}) {
132
+ const schema = useSchema()
133
+ const type = schema.get(doc._type)
134
+ return (
135
+ <Card flex={1}>
136
+ <IntentButton
137
+ intent="edit"
138
+ mode="bleed"
139
+ padding={1}
140
+ radius={0}
141
+ params={{
142
+ type: doc._type,
143
+ id: getPublishedId(doc._id),
144
+ }}
145
+ style={{width: '100%'}}
146
+ >
147
+ <SanityPreview layout="default" type={type} value={doc} key={doc._id} />
148
+ </IntentButton>
149
+ </Card>
150
+ )
151
+ }
152
+
153
+ export default DocumentList
package/src/index.tsx ADDED
@@ -0,0 +1,17 @@
1
+ import DocumentList, {DocumentListConfig} from './DocumentList'
2
+ import React from 'react'
3
+ import {LayoutConfig, DashboardWidget} from '@sanity/dashboard'
4
+
5
+ export interface DocumentListWidgetConfig extends DocumentListConfig {
6
+ layout?: LayoutConfig
7
+ }
8
+
9
+ export function documentListWidget(config: DocumentListWidgetConfig): DashboardWidget {
10
+ return {
11
+ name: 'document-list-widget',
12
+ component: function component() {
13
+ return <DocumentList {...config} />
14
+ },
15
+ layout: config.layout,
16
+ }
17
+ }
@@ -0,0 +1,67 @@
1
+ import {Observable, of as observableOf} from 'rxjs'
2
+ import {delay, mergeMap, switchMap, tap} from 'rxjs/operators'
3
+ import uniqBy from 'lodash/uniqBy'
4
+ import {SanityClient} from '@sanity/client'
5
+ import {SanityDocument} from '@sanity/types'
6
+
7
+ const draftId = (nonDraftDoc: SanityDocument) => `drafts.${nonDraftDoc._id}`
8
+
9
+ function prepareDocumentList(
10
+ incoming: SanityDocument | SanityDocument[],
11
+ client: SanityClient
12
+ ): Promise<SanityDocument[]> {
13
+ if (!incoming) {
14
+ return Promise.resolve([])
15
+ }
16
+ const documents = Array.isArray(incoming) ? incoming : [incoming]
17
+
18
+ const ids = documents.filter((doc) => !doc._id.startsWith('drafts.')).map(draftId)
19
+
20
+ return client
21
+ .fetch('*[_id in $ids]', {ids})
22
+ .then((drafts) => {
23
+ const outgoing = documents.map((doc) => {
24
+ const foundDraft = drafts.find((draft) => draft._id === draftId(doc))
25
+ return foundDraft || doc
26
+ })
27
+ return uniqBy(outgoing, '_id')
28
+ })
29
+ .catch((error) => {
30
+ throw new Error(`Problems fetching docs ${ids}. Error: ${error.message}`)
31
+ })
32
+ }
33
+
34
+ export function getSubscription(
35
+ query: string,
36
+ params: Record<string, any>,
37
+ client: SanityClient
38
+ ): Observable<SanityDocument[]> {
39
+ return client
40
+ .listen(query, params, {
41
+ events: ['welcome', 'mutation'],
42
+ includeResult: false,
43
+ visibility: 'query',
44
+ })
45
+ .pipe(
46
+ switchMap((event) => {
47
+ return observableOf(1).pipe(
48
+ event.type === 'welcome' ? tap() : delay(1000),
49
+ mergeMap(() =>
50
+ client
51
+ .fetch(query, params)
52
+ .then((incoming) => {
53
+ return prepareDocumentList(incoming, client)
54
+ })
55
+ .catch((error) => {
56
+ if (error.message.startsWith('Problems fetching docs')) {
57
+ throw error
58
+ }
59
+ throw new Error(
60
+ `Query failed ${query} and ${JSON.stringify(params)}. Error: ${error.message}`
61
+ )
62
+ })
63
+ )
64
+ )
65
+ })
66
+ )
67
+ }
@@ -1,34 +0,0 @@
1
- @import 'part:@sanity/base/theme/variables-style';
2
-
3
- .container {
4
- composes: container from "part:@sanity/dashboard/widget-styles";
5
- }
6
-
7
- .header {
8
- composes: header from "part:@sanity/dashboard/widget-styles";
9
- }
10
-
11
- .title {
12
- composes: title from "part:@sanity/dashboard/widget-styles";
13
- }
14
-
15
- .content {
16
- composes: content from 'part:@sanity/dashboard/widget-styles';
17
- border-top: 1px solid var(--hairline-color);
18
- padding: var(--small-padding) 0;
19
- }
20
-
21
- .link {
22
- composes: item from 'part:@sanity/base/theme/layout/selectable-style';
23
- display: block;
24
- color: inherit;
25
- text-decoration: inherit;
26
- outline: none;
27
- padding: var(--small-padding) var(--medium-padding);
28
- height: 100%;
29
- }
30
-
31
- .footer {
32
- composes: footer from 'part:@sanity/dashboard/widget-styles';
33
- border-top: 1px solid var(--hairline-color);
34
- }