sanity-plugin-dashboard-widget-document-list 1.0.0 → 2.0.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Sanity.io
+Copyright (c) 2024 Sanity.io
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,6 +1,6 @@
 # sanity-plugin-dashboard-widget-document-list
 
->This is a **Sanity Studio v3** plugin.
+> This is a **Sanity Studio v3** plugin.
 > For the v2 version, please refer to the [v2-branch](https://github.com/sanity-io/dashboard-widget-document-list/tree/studio-v2).
 
 ## What is it?
@@ -26,86 +26,88 @@ Ensure that you have followed install and usage instructions for @sanity/dashboa
 Add dashboard-widget-document-list as a widget to @sanity/dashboard plugin in sanity.config.ts (or .js):
 
 ```js
-import { dashboardTool } from "@sanity/dashboard";
-import { documentListWidget } from "sanity-plugin-dashboard-widget-document-list";
+import {dashboardTool} from '@sanity/dashboard'
+import {documentListWidget} from 'sanity-plugin-dashboard-widget-document-list'
 
 export default defineConfig({
   // ...
   plugins: [
-     dashboardTool({
-             widgets: [
-                 documentListWidget(),
-             ],
-         }
-     ),
-  ] 
+    dashboardTool({
+      widgets: [documentListWidget()],
+    }),
+  ],
 })
 ```
 
-*Note*: If a document in the result (as returned by the backend) has a draft, that draft is rendered instead of the published document.
+_Note_: If a document in the result (as returned by the backend) has a draft, that draft is rendered instead of the published document.
 
 ## Options
 
 There are some options available, as specified by [DocumentListConfig](src/DocumentList.tsx):
 
 ### `title` (string)
+
 Widget title
 
 ```js
 documentListWidget({
-    title: 'Some documents'
+  title: 'Some documents',
 })
 ```
 
 ### `order` (string)
+
 Field and direction to order by when docs are rendered
 
 ```js
 documentListWidget({
-    title: 'Last edited',
-    order: '_updatedAt desc'
+  title: 'Last edited',
+  order: '_updatedAt desc',
 })
 ```
 
 ### `limit` (number)
+
 Number of docs rendered
 
 ```js
 documentListWidget({
-    title: 'Last edited',
-    order: '_updatedAt desc',
-    limit: 3
+  title: 'Last edited',
+  order: '_updatedAt desc',
+  limit: 3,
 })
 ```
 
 ### `types` (array)
+
 Array of strings signifying which document (schema) types are fetched
 
 ```js
 documentListWidget({
-    title: 'Last edited',
-    order: '_updatedAt desc',
-    types: ['book', 'author']
+  title: 'Last edited',
+  order: '_updatedAt desc',
+  types: ['book', 'author'],
 })
 ```
 
 ### `query` (string) and `params` (object)
+
 Customized GROQ query with params for maximum control. If you use the query option, the `types`, `order`, and `limit` options will cease to function. You're on your own.
 
 ```js
 documentListWidget({
-    title: 'Published books by title',
-    query: '*[_type == "book" && published == true] | order(title asc) [0...10]'
+  title: 'Published books by title',
+  query: '*[_type == "book" && published == true] | order(title asc) [0...10]',
 })
 ```
 
 ```js
 documentListWidget({
-    title: 'My favorite documents',
-    query: '*[_id in $ids]',
-    params: {
-      ids: ['ab2', 'c5z', '654']
-    }
+  title: 'My favorite documents',
+  query: '*[_id in $ids]',
+  params: {
+    ids: ['ab2', 'c5z', '654'],
+  },
 })
 ```
 
@@ -115,9 +117,9 @@ You can override the button default button text (`Create new ${types[0]}`) by se
 
 ```js
 documentListWidget({
-    title: 'Blog posts',
-    query: '*[_type == "post"]',
-    createButtonText: 'Create new blog post'
+  title: 'Blog posts',
+  query: '*[_type == "post"]',
+  createButtonText: 'Create new blog post',
 })
 ```
 
@@ -127,16 +129,17 @@ You can disable the create button altogether by passing a `showCreateButton` boo
 
 ```js
 documentListWidget({
-    showCreateButton: false
+  showCreateButton: false,
 })
 ```
 
 ### Widget size
 
 You can change the width of the plugin using `layout.width`:
+
 ```js
 documentListWidget({
-    layout: { width: "small" } 
+  layout: {width: 'small'},
 })
 ```
 

package/dist/index.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0});var e=require("react/jsx-runtime"),t=require("@sanity/dashboard"),r=require("@sanity/ui"),s=require("lodash/intersection.js"),i=require("react"),n=require("sanity"),a=require("lodash/uniqBy"),o=require("rxjs"),u=require("rxjs/operators");function d(e){return e&&"object"==typeof e&&"default"in e?e:{default:e}}var c=d(s),l=d(a);const m=e=>`drafts.${e._id}`;function p(e,t,r){return r.listen(e,t,{events:["welcome","mutation"],includeResult:!1,visibility:"query"}).pipe(u.switchMap((s=>o.of(1).pipe("welcome"===s.type?u.tap():u.delay(1e3),u.mergeMap((()=>r.fetch(e,t).then((e=>function(e,t){if(!e)return Promise.resolve([]);const r=Array.isArray(e)?e:[e],s=r.filter((e=>!e._id.startsWith("drafts."))).map(m);return t.fetch("*[_id in $ids]",{ids:s}).then((e=>{const t=r.map((t=>e.find((e=>e._id===m(t)))||t));return l.default(t,"_id")})).catch((e=>{throw new Error(`Problems fetching docs ${s}. Error: ${e.message}`)}))}(e,r))).catch((r=>{throw r.message.startsWith("Problems fetching docs")?r:new Error(`Query failed ${e} and ${JSON.stringify(t)}. Error: ${r.message}`)}))))))))}const y={title:"Last created",order:"_createdAt desc",limit:10,queryParams:{},showCreateButton:!0,apiVersion:"v1"};function h(s){const{query:a,limit:o,apiVersion:u,queryParams:d,types:l,order:m,title:h,showCreateButton:x,createButtonText:j}={...y,...s},[g,b]=i.useState(),[q,v]=i.useState(!0),[w,_]=i.useState(),$=n.useClient({apiVersion:u}),C=n.useSchema(),{assembledQuery:P,params:S}=i.useMemo((()=>{if(a)return{assembledQuery:a,params:d};const e=C.getTypeNames().filter((e=>{var t;const r=C.get(e);return"document"===(null==(t=null==r?void 0:r.type)?void 0:t.name)}));return{assembledQuery:`*[_type in $types] | order(${m}) [0...${2*o}]`,params:{types:l?c.default(l,e):e}}}),[C,a,d,m,o,l]);return i.useEffect((()=>{if(!P)return;const e=p(P,S,$).subscribe({next:e=>{b(e.slice(0,o)),v(!1)},error:e=>{_(e),v(!1)}});return()=>{e.unsubscribe()}}),[o,$,P,S]),e.jsx(t.DashboardWidgetContainer,{header:h,footer:l&&1===l.length&&x&&e.jsx(n.IntentButton,{mode:"bleed",style:{width:"100%"},paddingY:4,tone:"primary",type:"button",intent:"create",params:{type:l[0]},text:j||`Create new ${l[0]}`}),children:e.jsxs(r.Card,{children:[w&&e.jsx("div",{children:w.message}),!w&&q&&e.jsx(r.Card,{padding:4,children:e.jsx(r.Flex,{justify:"center",children:e.jsx(r.Spinner,{muted:!0})})}),!w&&!g&&!q&&e.jsx("div",{children:"Could not locate any documents :/"}),e.jsx(r.Stack,{space:2,children:g&&g.map((t=>e.jsx(f,{doc:t},t._id)))})]})})}function f({doc:t}){const s=n.useSchema().get(t._type);return e.jsx(r.Card,{flex:1,children:e.jsx(n.IntentButton,{intent:"edit",mode:"bleed",tooltipProps:{},params:{type:t._type,id:n.getPublishedId(t._id)},style:{width:"100%"},children:s?e.jsx(n.Preview,{layout:"default",schemaType:s,value:t},t._id):"Schema-type missing"})})}exports.documentListWidget=function(t){return{name:"document-list-widget",component:function(){return e.jsx(h,{...t})},layout:t.layout}};//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sources":["../src/sanityConnector.ts","../src/DocumentList.tsx","../src/plugin.tsx"],"sourcesContent":["import type {SanityClient} from '@sanity/client'\nimport uniqBy from 'lodash/uniqBy'\nimport {type Observable, of as observableOf} from 'rxjs'\nimport {delay, mergeMap, switchMap, tap} from 'rxjs/operators'\nimport type {SanityDocument} from 'sanity'\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<SanityDocument[]>('*[_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  // eslint-disable-next-line @typescript-eslint/no-explicit-any\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","import {DashboardWidgetContainer} from '@sanity/dashboard'\nimport {Card, Flex, Spinner, Stack} from '@sanity/ui'\nimport {intersection} from 'lodash'\nimport {type ReactNode, useEffect, useMemo, useState} from 'react'\nimport {\n  getPublishedId,\n  IntentButton,\n  Preview,\n  type SanityDocument,\n  useClient,\n  useSchema,\n} from 'sanity'\n\nimport {getSubscription} from './sanityConnector'\n\nexport interface DocumentListConfig {\n  title?: string\n  types?: string[]\n  query?: string\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\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): ReactNode {\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 versionedClient = useClient({apiVersion})\n  const schema = useSchema()\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?.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        tooltipProps={{}}\n        // padding={1}\n        // radius={0}\n        params={{\n          type: doc._type,\n          id: getPublishedId(doc._id),\n        }}\n        style={{width: '100%'}}\n      >\n        {type ? (\n          <Preview layout=\"default\" schemaType={type} value={doc} key={doc._id} />\n        ) : (\n          'Schema-type missing'\n        )}\n      </IntentButton>\n    </Card>\n  )\n}\n\nexport default DocumentList\n","import type {DashboardWidget, LayoutConfig} from '@sanity/dashboard'\n\nimport DocumentList, {type DocumentListConfig} from './DocumentList'\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"],"names":["Object","defineProperty","exports","value","jsxRuntime","require","dashboard","ui","intersection","react","sanity","uniqBy","rxjs","operators","_interopDefaultCompat","e","default","intersection__default","uniqBy__default","draftId","nonDraftDoc","_id","getSubscription","query","params","client","listen","events","includeResult","visibility","pipe","switchMap","event","observableOf","type","tap","delay","mergeMap","fetch","then","incoming","Promise","resolve","documents","Array","isArray","ids","filter","doc","startsWith","map","drafts","outgoing","find","draft","catch","error","Error","message","prepareDocumentList","JSON","stringify","defaultProps","title","order","limit","queryParams","showCreateButton","apiVersion","DocumentList","props","types","createButtonText","setDocuments","useState","loading","setLoading","setError","versionedClient","useClient","schema","useSchema","assembledQuery","useMemo","documentTypes","getTypeNames","typeName","_a","schemaType","get","name","useEffect","subscription","subscribe","next","d","slice","unsubscribe","jsx","DashboardWidgetContainer","header","footer","length","IntentButton","mode","style","width","paddingY","tone","intent","text","children","Card","padding","Flex","justify","Spinner","muted","Stack","space","MenuEntry","_type","flex","tooltipProps","id","getPublishedId","Preview","layout","documentListWidget","config","component"],"mappings":"aAMAA,OAAAC,eAAAC,QAAA,aAAA,CAAAC,OAAA,IAAA,IAAAC,EAAAC,QAAA,qBAAAC,EAAAD,QAAA,qBAAAE,EAAAF,QAAA,cAAAG,EAAAH,QAAA,0BAAAI,EAAAJ,QAAA,SAAAK,EAAAL,QAAA,UAAAM,EAAAN,QAAA,iBAAAO,EAAAP,QAAA,QAAAQ,EAAAR,QAAA,kBAAA,SAAAS,EAAAC,GAAA,OAAAA,GAAA,iBAAAA,GAAA,YAAAA,EAAAA,EAAA,CAAAC,QAAAD,EAAA,CAAA,IAAAE,EAAAH,EAAAN,GAAAU,IAAAP,GAAA,MAAMQ,EAAWC,GAAgC,UAAUA,EAAYC,MA2BvD,SAAAC,EACdC,EAEAC,EACAC,GAEO,OAAAA,EACJC,OAAOH,EAAOC,EAAQ,CACrBG,OAAQ,CAAC,UAAW,YACpBC,eAAe,EACfC,WAAY,UAEbC,KACCC,EAAAA,WAAWC,GACFC,KAAa,GAAGH,KACN,YAAfE,EAAME,KAAqBC,EAAIA,MAAIC,EAAAA,MAAM,KACzCC,EAAAA,UAAS,IACPZ,EACGa,MAAMf,EAAOC,GACbe,MAAMC,GA5CrB,SACEA,EACAf,GAEA,IAAKe,EACI,OAAAC,QAAQC,QAAQ,IAEnB,MAAAC,EAAYC,MAAMC,QAAQL,GAAYA,EAAW,CAACA,GAElDM,EAAMH,EAAUI,QAAQC,IAASA,EAAI3B,IAAI4B,WAAW,aAAYC,IAAI/B,GAEnE,OAAAM,EACJa,MAAwB,iBAAkB,CAACQ,QAC3CP,MAAMY,IACL,MAAMC,EAAWT,EAAUO,KAAKF,GACXG,EAAOE,MAAMC,GAAUA,EAAMjC,MAAQF,EAAQ6B,MAC3CA,IAEhBrC,OAAAA,EAAAK,QAAOoC,EAAU,MAAK,IAE9BG,OAAOC,IACN,MAAM,IAAIC,MAAM,0BAA0BX,aAAeU,EAAME,UAAS,GAE9E,CAsBuBC,CAAoBnB,EAAUf,KAEtC8B,OAAOC,IACN,MAAIA,EAAME,QAAQT,WAAW,0BACrBO,EAEF,IAAIC,MACR,gBAAgBlC,SAAaqC,KAAKC,UAAUrC,cAAmBgC,EAAME,UAAO,SAO9F,CCvCA,MAAMI,EAAe,CACnBC,MAAO,eACPC,MAAO,kBACPC,MAAO,GACPC,YAAa,CAAC,EACdC,kBAAkB,EAClBC,WAAY,MAGP,SAASC,EAAaC,GACrB,MAAA/C,MACJA,EAAA0C,MACAA,EAAAG,WACAA,EAAAF,YACAA,EAAAK,MACAA,EAAAP,MACAA,EAAAD,MACAA,EAAAI,iBACAA,EAAAK,iBACAA,GACE,IACCV,KACAQ,IAGE3B,EAAW8B,GAAgBC,EAAAA,YAC3BC,EAASC,GAAcF,EAAAA,UAAkB,IACzClB,EAAOqB,GAAYH,EAAAA,WAEpBI,EAAkBC,YAAU,CAACX,eAC7BY,EAASC,EAAAA,aAETC,eAACA,EAAA1D,OAAgBA,GAAU2D,WAAQ,KACnC,GAAA5D,EACF,MAAO,CAAC2D,eAAgB3D,EAAOC,OAAQ0C,GAGzC,MAAMkB,EAAgBJ,EAAOK,eAAetC,QAAQuC,IAjExD,IAAAC,EAkEY,MAAAC,EAAaR,EAAOS,IAAIH,GACvB,MAA2B,cAA3B,OAAAC,EAAA,MAAAC,OAAA,EAAAA,EAAYtD,WAAZ,EAAAqD,EAAkBG,KAAS,IAG7B,MAAA,CACLR,eAAgB,8BAA8BlB,WAAuB,EAARC,KAC7DzC,OAAQ,CAAC+C,MAAOA,EAAQ/D,UAAa+D,EAAOa,GAAiBA,GAAa,GAE3E,CAACJ,EAAQzD,EAAO2C,EAAaF,EAAOC,EAAOM,IAE9CoB,OAAAA,EAAAA,WAAU,KACR,IAAKT,EACH,OAGF,MAAMU,EAAetE,EAAgB4D,EAAgB1D,EAAQsD,GAAiBe,UAAU,CACtFC,KAAOC,IACLtB,EAAasB,EAAEC,MAAM,EAAG/B,IACxBW,GAAW,EAAK,EAElBpB,MAAQzC,IACG8D,EAAA9D,GACT6D,GAAW,EAAK,IAIpB,MAAO,KACLgB,EAAaK,aAAY,CAAA,GAE1B,CAAChC,EAAOa,EAAiBI,EAAgB1D,IAG1CpB,EAAA8F,IAACC,EAAAA,yBAAA,CACCC,OAAQrC,EACRsC,OACE9B,GACiB,IAAjBA,EAAM+B,QACNnC,GACE/D,EAAA8F,IAACK,EAAAA,aAAA,CACCC,KAAK,QACLC,MAAO,CAACC,MAAO,QAEfC,SAAU,EACVC,KAAK,UACL1E,KAAK,SACL2E,OAAO,SACPrF,OAAQ,CAACU,KAAMqC,EAAM,IACrBuC,KAAMtC,GAAoB,cAAcD,EAAM,OAKpDwC,gBAACC,OACE,CAAAD,SAAA,CAASvD,KAAA0C,IAAC,MAAK,CAAAa,SAAAvD,EAAME,WACpBF,GAASmB,GACRuB,EAAAA,IAAAc,EAAAA,KAAA,CAAKC,QAAS,EACbF,SAAAb,EAAAA,IAACgB,EAAKA,KAAA,CAAAC,QAAQ,SACZJ,SAACb,EAAAA,IAAAkB,EAAAA,QAAA,CAAQC,OAAK,SAIlB7D,IAAUb,IAAcgC,GAAWvE,EAAA8F,IAAC,OAAIa,SAAiC,sCAC1Eb,EAAAA,IAAAoB,EAAAA,MAAA,CAAMC,MAAO,EACXR,YAAapE,EAAUO,KAAKF,SAASwE,EAAwB,CAAAxE,OAATA,EAAI3B,aAKnE,CAEA,SAASmG,GAAUxE,IAACA,IAElB,MAAMd,EADS+C,EAAAA,YACKQ,IAAIzC,EAAIyE,OAE1BvB,OAAAA,EAAAA,IAACc,EAAAA,KAAK,CAAAU,KAAM,EACVX,SAAA3G,EAAA8F,IAACK,EAAAA,aAAA,CACCM,OAAO,OACPL,KAAK,QACLmB,aAAc,CAAC,EAGfnG,OAAQ,CACNU,KAAMc,EAAIyE,MACVG,GAAIC,EAAAA,eAAe7E,EAAI3B,MAEzBoF,MAAO,CAACC,MAAO,QAEdK,SAAA7E,EACEgE,EAAAA,IAAA4B,EAAAA,QAAA,CAAQC,OAAO,UAAUvC,WAAYtD,EAAM/B,MAAO6C,GAAUA,EAAI3B,KAEjE,yBAKV,CCjJAnB,QAAA8H,mBARO,SAA4BC,GAC1B,MAAA,CACLvC,KAAM,uBACNwC,UAAW,WACF,SAAAhC,IAAC7B,EAAc,IAAG4D,GAC3B,EACAF,OAAQE,EAAOF,OAEnB"}

package/dist/index.d.cts

@@ -0,0 +1,22 @@
+import type {DashboardWidget} from '@sanity/dashboard'
+import type {LayoutConfig} from '@sanity/dashboard'
+
+declare interface DocumentListConfig {
+  title?: string
+  types?: string[]
+  query?: string
+  queryParams?: Record<string, any>
+  order?: string
+  limit?: number
+  showCreateButton?: boolean
+  createButtonText?: string
+  apiVersion?: string
+}
+
+export declare function documentListWidget(config: DocumentListWidgetConfig): DashboardWidget
+
+export declare interface DocumentListWidgetConfig extends DocumentListConfig {
+  layout?: LayoutConfig
+}
+
+export {}

package/{lib/src → dist}/index.d.ts

@@ -1,7 +1,5 @@
-/// <reference types="react" />
-
-import {DashboardWidget} from '@sanity/dashboard'
-import {LayoutConfig} from '@sanity/dashboard'
+import type {DashboardWidget} from '@sanity/dashboard'
+import type {LayoutConfig} from '@sanity/dashboard'
 
 declare interface DocumentListConfig {
   title?: string

package/dist/index.js

@@ -0,0 +1 @@
+import{jsx as e,jsxs as t}from"react/jsx-runtime";import{DashboardWidgetContainer as r}from"@sanity/dashboard";import{Card as i,Flex as n,Spinner as o,Stack as s}from"@sanity/ui";import a from"lodash/intersection.js";import{useState as d,useMemo as c,useEffect as m}from"react";import{useClient as u,useSchema as l,IntentButton as p,getPublishedId as y,Preview as f}from"sanity";import h from"lodash/uniqBy";import{of as g}from"rxjs";import{switchMap as b,tap as w,delay as _,mergeMap as $}from"rxjs/operators";const v=e=>`drafts.${e._id}`;function x(e,t,r){return r.listen(e,t,{events:["welcome","mutation"],includeResult:!1,visibility:"query"}).pipe(b((i=>g(1).pipe("welcome"===i.type?w():_(1e3),$((()=>r.fetch(e,t).then((e=>function(e,t){if(!e)return Promise.resolve([]);const r=Array.isArray(e)?e:[e],i=r.filter((e=>!e._id.startsWith("drafts."))).map(v);return t.fetch("*[_id in $ids]",{ids:i}).then((e=>{const t=r.map((t=>e.find((e=>e._id===v(t)))||t));return h(t,"_id")})).catch((e=>{throw new Error(`Problems fetching docs ${i}. Error: ${e.message}`)}))}(e,r))).catch((r=>{throw r.message.startsWith("Problems fetching docs")?r:new Error(`Query failed ${e} and ${JSON.stringify(t)}. Error: ${r.message}`)}))))))))}const P={title:"Last created",order:"_createdAt desc",limit:10,queryParams:{},showCreateButton:!0,apiVersion:"v1"};function j(y){const{query:f,limit:h,apiVersion:g,queryParams:b,types:w,order:_,title:$,showCreateButton:v,createButtonText:j}={...P,...y},[B,C]=d(),[E,Q]=d(!0),[A,T]=d(),V=u({apiVersion:g}),N=l(),{assembledQuery:S,params:W}=c((()=>{if(f)return{assembledQuery:f,params:b};const e=N.getTypeNames().filter((e=>{var t;const r=N.get(e);return"document"===(null==(t=null==r?void 0:r.type)?void 0:t.name)}));return{assembledQuery:`*[_type in $types] | order(${_}) [0...${2*h}]`,params:{types:w?a(w,e):e}}}),[N,f,b,_,h,w]);return m((()=>{if(!S)return;const e=x(S,W,V).subscribe({next:e=>{C(e.slice(0,h)),Q(!1)},error:e=>{T(e),Q(!1)}});return()=>{e.unsubscribe()}}),[h,V,S,W]),e(r,{header:$,footer:w&&1===w.length&&v&&e(p,{mode:"bleed",style:{width:"100%"},paddingY:4,tone:"primary",type:"button",intent:"create",params:{type:w[0]},text:j||`Create new ${w[0]}`}),children:t(i,{children:[A&&e("div",{children:A.message}),!A&&E&&e(i,{padding:4,children:e(n,{justify:"center",children:e(o,{muted:!0})})}),!A&&!B&&!E&&e("div",{children:"Could not locate any documents :/"}),e(s,{space:2,children:B&&B.map((t=>e(q,{doc:t},t._id)))})]})})}function q({doc:t}){const r=l().get(t._type);return e(i,{flex:1,children:e(p,{intent:"edit",mode:"bleed",tooltipProps:{},params:{type:t._type,id:y(t._id)},style:{width:"100%"},children:r?e(f,{layout:"default",schemaType:r,value:t},t._id):"Schema-type missing"})})}function B(t){return{name:"document-list-widget",component:function(){return e(j,{...t})},layout:t.layout}}export{B as documentListWidget};//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../src/sanityConnector.ts","../src/DocumentList.tsx","../src/plugin.tsx"],"sourcesContent":["import type {SanityClient} from '@sanity/client'\nimport uniqBy from 'lodash/uniqBy'\nimport {type Observable, of as observableOf} from 'rxjs'\nimport {delay, mergeMap, switchMap, tap} from 'rxjs/operators'\nimport type {SanityDocument} from 'sanity'\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<SanityDocument[]>('*[_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  // eslint-disable-next-line @typescript-eslint/no-explicit-any\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","import {DashboardWidgetContainer} from '@sanity/dashboard'\nimport {Card, Flex, Spinner, Stack} from '@sanity/ui'\nimport {intersection} from 'lodash'\nimport {type ReactNode, useEffect, useMemo, useState} from 'react'\nimport {\n  getPublishedId,\n  IntentButton,\n  Preview,\n  type SanityDocument,\n  useClient,\n  useSchema,\n} from 'sanity'\n\nimport {getSubscription} from './sanityConnector'\n\nexport interface DocumentListConfig {\n  title?: string\n  types?: string[]\n  query?: string\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\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): ReactNode {\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 versionedClient = useClient({apiVersion})\n  const schema = useSchema()\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?.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        tooltipProps={{}}\n        // padding={1}\n        // radius={0}\n        params={{\n          type: doc._type,\n          id: getPublishedId(doc._id),\n        }}\n        style={{width: '100%'}}\n      >\n        {type ? (\n          <Preview layout=\"default\" schemaType={type} value={doc} key={doc._id} />\n        ) : (\n          'Schema-type missing'\n        )}\n      </IntentButton>\n    </Card>\n  )\n}\n\nexport default DocumentList\n","import type {DashboardWidget, LayoutConfig} from '@sanity/dashboard'\n\nimport DocumentList, {type DocumentListConfig} from './DocumentList'\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"],"names":["jsx","jsxs","DashboardWidgetContainer","Card","Flex","Spinner","Stack","intersection","useState","useMemo","useEffect","useClient","useSchema","IntentButton","getPublishedId","Preview","uniqBy","of","switchMap","tap","delay","mergeMap","draftId","nonDraftDoc","_id","getSubscription","query","params","client","listen","events","includeResult","visibility","pipe","event","observableOf","type","fetch","then","incoming","Promise","resolve","documents","Array","isArray","ids","filter","doc","startsWith","map","drafts","outgoing","find","draft","catch","error","Error","message","prepareDocumentList","JSON","stringify","defaultProps","title","order","limit","queryParams","showCreateButton","apiVersion","DocumentList","props","types","createButtonText","setDocuments","loading","setLoading","setError","versionedClient","schema","assembledQuery","documentTypes","getTypeNames","typeName","_a","schemaType","get","name","subscription","subscribe","next","d","slice","e","unsubscribe","header","footer","length","mode","style","width","paddingY","tone","intent","text","children","padding","justify","muted","space","MenuEntry","_type","flex","tooltipProps","id","layout","value","documentListWidget","config","component"],"mappings":"cAMAA,UAAAC,MAAA,uDAAAC,MAAA,mCAAAC,UAAAC,aAAAC,WAAAC,MAAA,oBAAAC,MAAA,4CAAAC,aAAAC,eAAAC,MAAA,4BAAAC,eAAAC,kBAAAC,oBAAAC,aAAAC,MAAA,gBAAAC,MAAA,6BAAAC,MAAA,2BAAAC,SAAAC,WAAAC,cAAAC,MAAA,iBAAA,MAAMC,EAAWC,GAAgC,UAAUA,EAAYC,MA2BvD,SAAAC,EACdC,EAEAC,EACAC,GAEO,OAAAA,EACJC,OAAOH,EAAOC,EAAQ,CACrBG,OAAQ,CAAC,UAAW,YACpBC,eAAe,EACfC,WAAY,UAEbC,KACCf,GAAWgB,GACFC,EAAa,GAAGF,KACN,YAAfC,EAAME,KAAqBjB,IAAQC,EAAM,KACzCC,GAAS,IACPO,EACGS,MAAMX,EAAOC,GACbW,MAAMC,GA5CrB,SACEA,EACAX,GAEA,IAAKW,EACI,OAAAC,QAAQC,QAAQ,IAEnB,MAAAC,EAAYC,MAAMC,QAAQL,GAAYA,EAAW,CAACA,GAElDM,EAAMH,EAAUI,QAAQC,IAASA,EAAIvB,IAAIwB,WAAW,aAAYC,IAAI3B,GAEnE,OAAAM,EACJS,MAAwB,iBAAkB,CAACQ,QAC3CP,MAAMY,IACL,MAAMC,EAAWT,EAAUO,KAAKF,GACXG,EAAOE,MAAMC,GAAUA,EAAM7B,MAAQF,EAAQyB,MAC3CA,IAEhB,OAAA/B,EAAOmC,EAAU,MAAK,IAE9BG,OAAOC,IACN,MAAM,IAAIC,MAAM,0BAA0BX,aAAeU,EAAME,UAAS,GAE9E,CAsBuBC,CAAoBnB,EAAUX,KAEtC0B,OAAOC,IACN,MAAIA,EAAME,QAAQT,WAAW,0BACrBO,EAEF,IAAIC,MACR,gBAAgB9B,SAAaiC,KAAKC,UAAUjC,cAAmB4B,EAAME,UAAO,SAO9F,CCvCA,MAAMI,EAAe,CACnBC,MAAO,eACPC,MAAO,kBACPC,MAAO,GACPC,YAAa,CAAC,EACdC,kBAAkB,EAClBC,WAAY,MAGP,SAASC,EAAaC,GACrB,MAAA3C,MACJA,EAAAsC,MACAA,EAAAG,WACAA,EAAAF,YACAA,EAAAK,MACAA,EAAAP,MACAA,EAAAD,MACAA,EAAAI,iBACAA,EAAAK,iBACAA,GACE,IACCV,KACAQ,IAGE3B,EAAW8B,GAAgBhE,KAC3BiE,EAASC,GAAclE,GAAkB,IACzC+C,EAAOoB,GAAYnE,IAEpBoE,EAAkBjE,EAAU,CAACwD,eAC7BU,EAASjE,KAETkE,eAACA,EAAAnD,OAAgBA,GAAUlB,GAAQ,KACnC,GAAAiB,EACF,MAAO,CAACoD,eAAgBpD,EAAOC,OAAQsC,GAGzC,MAAMc,EAAgBF,EAAOG,eAAelC,QAAQmC,IAjExD,IAAAC,EAkEY,MAAAC,EAAaN,EAAOO,IAAIH,GACvB,MAA2B,cAA3B,OAAAC,EAAA,MAAAC,OAAA,EAAAA,EAAY/C,WAAZ,EAAA8C,EAAkBG,KAAS,IAG7B,MAAA,CACLP,eAAgB,8BAA8Bf,WAAuB,EAARC,KAC7DrC,OAAQ,CAAC2C,MAAOA,EAAQ/D,EAAa+D,EAAOS,GAAiBA,GAAa,GAE3E,CAACF,EAAQnD,EAAOuC,EAAaF,EAAOC,EAAOM,IAE9C,OAAA5D,GAAU,KACR,IAAKoE,EACH,OAGF,MAAMQ,EAAe7D,EAAgBqD,EAAgBnD,EAAQiD,GAAiBW,UAAU,CACtFC,KAAOC,IACLjB,EAAaiB,EAAEC,MAAM,EAAG1B,IACxBU,GAAW,EAAK,EAElBnB,MAAQoC,IACGhB,EAAAgB,GACTjB,GAAW,EAAK,IAIpB,MAAO,KACLY,EAAaM,aAAY,CAAA,GAE1B,CAAC5B,EAAOY,EAAiBE,EAAgBnD,IAG1C3B,EAACE,EAAA,CACC2F,OAAQ/B,EACRgC,OACExB,GACiB,IAAjBA,EAAMyB,QACN7B,GACElE,EAACa,EAAA,CACCmF,KAAK,QACLC,MAAO,CAACC,MAAO,QAEfC,SAAU,EACVC,KAAK,UACLhE,KAAK,SACLiE,OAAO,SACP1E,OAAQ,CAACS,KAAMkC,EAAM,IACrBgC,KAAM/B,GAAoB,cAAcD,EAAM,OAKpDiC,WAACpG,EACE,CAAAoG,SAAA,CAAShD,GAACvD,EAAA,MAAK,CAAAuG,SAAAhD,EAAME,WACpBF,GAASkB,GACRzE,EAAAG,EAAA,CAAKqG,QAAS,EACbD,SAAAvG,EAACI,EAAK,CAAAqG,QAAQ,SACZF,SAACvG,EAAAK,EAAA,CAAQqG,OAAK,SAIlBnD,IAAUb,IAAc+B,GAAWzE,EAAC,OAAIuG,SAAiC,sCAC1EvG,EAAAM,EAAA,CAAMqG,MAAO,EACXJ,YAAa7D,EAAUO,KAAKF,GAAS/C,EAAA4G,EAAwB,CAAA7D,OAATA,EAAIvB,aAKnE,CAEA,SAASoF,GAAU7D,IAACA,IAElB,MAAMX,EADSxB,IACKwE,IAAIrC,EAAI8D,OAE1B,OAAC7G,EAAAG,EAAK,CAAA2G,KAAM,EACVP,SAAAvG,EAACa,EAAA,CACCwF,OAAO,OACPL,KAAK,QACLe,aAAc,CAAC,EAGfpF,OAAQ,CACNS,KAAMW,EAAI8D,MACVG,GAAIlG,EAAeiC,EAAIvB,MAEzByE,MAAO,CAACC,MAAO,QAEdK,SAAAnE,EACEpC,EAAAe,EAAA,CAAQkG,OAAO,UAAU9B,WAAY/C,EAAM8E,MAAOnE,GAAUA,EAAIvB,KAEjE,yBAKV,CCzJO,SAAS2F,EAAmBC,GAC1B,MAAA,CACL/B,KAAM,uBACNgC,UAAW,WACF,OAACrH,EAAAoE,EAAc,IAAGgD,GAC3B,EACAH,OAAQG,EAAOH,OAEnB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sanity-plugin-dashboard-widget-document-list",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "description": "> **NOTE**",
   "keywords": [
     "sanity",
@@ -22,74 +22,76 @@
   "author": "Sanity.io <hello@sanity.io>",
   "exports": {
     ".": {
-      "types": "./lib/src/index.d.ts",
       "source": "./src/index.ts",
-      "import": "./lib/index.esm.js",
-      "require": "./lib/index.js",
-      "default": "./lib/index.esm.js"
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs",
+      "default": "./dist/index.js"
     },
     "./package.json": "./package.json"
   },
-  "main": "./lib/index.js",
-  "module": "./lib/index.esm.js",
-  "source": "./src/index.ts",
-  "types": "./lib/src/index.d.ts",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "files": [
     "src",
-    "lib",
+    "dist",
     "v2-incompatible.js",
     "sanity.json"
   ],
   "scripts": {
-    "prebuild": "npm run clean && plugin-kit verify-package --silent && pkg-utils",
-    "build": "pkg-utils build --strict",
-    "clean": "rimraf lib",
+    "build": "plugin-kit verify-package --silent && pkg-utils build --strict --check --clean",
     "compile": "tsc --noEmit",
     "link-watch": "plugin-kit link-watch",
     "lint": "eslint .",
-    "prepare": "husky install",
+    "prepare": "husky",
     "prepublishOnly": "npm run build",
-    "watch": "pkg-utils watch"
+    "watch": "pkg-utils watch --strict"
   },
   "dependencies": {
     "@sanity/incompatible-plugin": "^1.0.4",
-    "@sanity/ui": "1.0.0-beta.32",
-    "lodash": "^4.17.15",
-    "rxjs": "^6.0.0"
+    "@sanity/ui": "^2.8.8",
+    "lodash": "^4.17.21",
+    "rxjs": "^7.8.1"
   },
   "devDependencies": {
-    "@commitlint/cli": "^17.2.0",
-    "@commitlint/config-conventional": "^17.2.0",
-    "@sanity/dashboard": "^3.0.0-v3-studio.8",
-    "@sanity/pkg-utils": "^1.17.2",
-    "@sanity/plugin-kit": "^2.1.5",
-    "@sanity/semantic-release-preset": "^2.0.2",
+    "@commitlint/cli": "^19.3.0",
+    "@commitlint/config-conventional": "^19.2.2",
+    "@sanity/dashboard": "^4.0.0",
+    "@sanity/pkg-utils": "^6.10.7",
+    "@sanity/plugin-kit": "^4.0.17",
+    "@sanity/semantic-release-preset": "^5.0.0",
     "@types/react": "^18",
-    "@typescript-eslint/eslint-plugin": "^5.42.0",
-    "@typescript-eslint/parser": "^5.42.0",
-    "eslint": "^8.26.0",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-config-sanity": "^6.0.0",
-    "eslint-plugin-prettier": "^4.2.1",
-    "eslint-plugin-react": "^7.31.10",
-    "eslint-plugin-react-hooks": "^4.6.0",
-    "husky": "^8.0.1",
-    "lint-staged": "^13.0.3",
-    "prettier": "^2.7.1",
-    "prettier-plugin-packagejson": "^2.3.0",
+    "@typescript-eslint/eslint-plugin": "^7.17.0",
+    "@typescript-eslint/parser": "^7.17.0",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-config-sanity": "^7.1.2",
+    "eslint-plugin-prettier": "^5.2.1",
+    "eslint-plugin-react": "^7.35.0",
+    "eslint-plugin-react-hooks": "^4.6.2",
+    "husky": "^9.1.3",
+    "lint-staged": "^15.2.7",
+    "prettier": "^3.3.3",
+    "prettier-plugin-packagejson": "^2.5.1",
     "react": "^18",
-    "rimraf": "^3.0.2",
-    "sanity": "3.0.0-rc.2",
-    "typescript": "^4.8.4"
+    "sanity": "^3.52.2",
+    "semantic-release": "^24.0.0",
+    "typescript": "5.5.4"
   },
   "peerDependencies": {
-    "@sanity/dashboard": "^3.0.0-v3-studio.8",
+    "@sanity/dashboard": "^4.0.0",
     "react": "^18",
-    "sanity": "dev-preview || 3.0.0-rc.2"
+    "sanity": "^3.0.0"
   },
   "engines": {
-    "node": ">=14"
+    "node": ">=18"
   },
   "public": true,
-  "sanityExchangeUrl": "https://www.sanity.io/plugins/sanity-plugin-dashboard-widget-document-list"
+  "sanityExchangeUrl": "https://www.sanity.io/plugins/sanity-plugin-dashboard-widget-document-list",
+  "browserslist": "extends @sanity/browserslist-config",
+  "sideEffects": false,
+  "type": "module",
+  "overrides": {
+    "conventional-changelog-conventionalcommits": ">= 8.0.0"
+  }
 }

package/src/DocumentList.tsx

@@ -1,15 +1,23 @@
-import React, {useEffect, useMemo, useState} from 'react'
-import {getPublishedId, useClient, useSchema} from 'sanity'
+import {DashboardWidgetContainer} from '@sanity/dashboard'
+import {Card, Flex, Spinner, Stack} from '@sanity/ui'
 import {intersection} from 'lodash'
+import {type ReactNode, useEffect, useMemo, useState} from 'react'
+import {
+  getPublishedId,
+  IntentButton,
+  Preview,
+  type SanityDocument,
+  useClient,
+  useSchema,
+} from 'sanity'
+
 import {getSubscription} from './sanityConnector'
-import {SanityDocument, IntentButton, SanityPreview} from 'sanity'
-import {Card, Flex, Spinner, Stack} from '@sanity/ui'
-import {DashboardWidgetContainer} from '@sanity/dashboard'
 
 export interface DocumentListConfig {
   title?: string
   types?: string[]
   query?: string
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   queryParams?: Record<string, any>
   order?: string
   limit?: number
@@ -27,7 +35,7 @@ const defaultProps = {
   apiVersion: 'v1',
 }
 
-export function DocumentList(props: DocumentListConfig) {
+export function DocumentList(props: DocumentListConfig): ReactNode {
   const {
     query,
     limit,
@@ -97,7 +105,7 @@ export function DocumentList(props: DocumentListConfig) {
           <IntentButton
             mode="bleed"
             style={{width: '100%'}}
-            paddingX={2}
+            // paddingX={2}
             paddingY={4}
             tone="primary"
             type="button"
@@ -134,8 +142,9 @@ function MenuEntry({doc}: {doc: SanityDocument}) {
       <IntentButton
         intent="edit"
         mode="bleed"
-        padding={1}
-        radius={0}
+        tooltipProps={{}}
+        // padding={1}
+        // radius={0}
         params={{
           type: doc._type,
           id: getPublishedId(doc._id),
@@ -143,7 +152,7 @@ function MenuEntry({doc}: {doc: SanityDocument}) {
         style={{width: '100%'}}
       >
         {type ? (
-          <SanityPreview layout="default" schemaType={type} value={doc} key={doc._id} />
+          <Preview layout="default" schemaType={type} value={doc} key={doc._id} />
         ) : (
           'Schema-type missing'
         )}

package/src/plugin.tsx

@@ -1,6 +1,6 @@
-import DocumentList, {DocumentListConfig} from './DocumentList'
-import React from 'react'
-import {LayoutConfig, DashboardWidget} from '@sanity/dashboard'
+import type {DashboardWidget, LayoutConfig} from '@sanity/dashboard'
+
+import DocumentList, {type DocumentListConfig} from './DocumentList'
 
 export interface DocumentListWidgetConfig extends DocumentListConfig {
   layout?: LayoutConfig

package/src/sanityConnector.ts

@@ -1,14 +1,14 @@
-import {Observable, of as observableOf} from 'rxjs'
-import {delay, mergeMap, switchMap, tap} from 'rxjs/operators'
+import type {SanityClient} from '@sanity/client'
 import uniqBy from 'lodash/uniqBy'
-import {SanityClient} from '@sanity/client'
-import {SanityDocument} from 'sanity'
+import {type Observable, of as observableOf} from 'rxjs'
+import {delay, mergeMap, switchMap, tap} from 'rxjs/operators'
+import type {SanityDocument} from 'sanity'
 
 const draftId = (nonDraftDoc: SanityDocument) => `drafts.${nonDraftDoc._id}`
 
 function prepareDocumentList(
   incoming: SanityDocument | SanityDocument[],
-  client: SanityClient
+  client: SanityClient,
 ): Promise<SanityDocument[]> {
   if (!incoming) {
     return Promise.resolve([])
@@ -33,8 +33,9 @@ function prepareDocumentList(
 
 export function getSubscription(
   query: string,
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   params: Record<string, any>,
-  client: SanityClient
+  client: SanityClient,
 ): Observable<SanityDocument[]> {
   return client
     .listen(query, params, {
@@ -57,11 +58,11 @@ export function getSubscription(
                   throw error
                 }
                 throw new Error(
-                  `Query failed ${query} and ${JSON.stringify(params)}. Error: ${error.message}`
+                  `Query failed ${query} and ${JSON.stringify(params)}. Error: ${error.message}`,
                 )
-              })
-          )
+              }),
+          ),
         )
-      })
+      }),
     )
 }

package/lib/index.esm.js

@@ -1,2 +0,0 @@
-function e(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function t(t){for(var n=1;n<arguments.length;n++){var i=null!=arguments[n]?arguments[n]:{};n%2?e(Object(i),!0).forEach((function(e){r(t,e,i[e])})):Object.getOwnPropertyDescriptors?Object.defineProperties(t,Object.getOwnPropertyDescriptors(i)):e(Object(i)).forEach((function(e){Object.defineProperty(t,e,Object.getOwnPropertyDescriptor(i,e))}))}return t}function r(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}import{jsx as n,jsxs as i}from"react/jsx-runtime";import{useState as o,useMemo as c,useEffect as a}from"react";import{useClient as s,useSchema as d,IntentButton as u,getPublishedId as p,SanityPreview as l}from"sanity";import{intersection as m}from"lodash";import{of as y}from"rxjs";import{switchMap as f,tap as h,delay as b,mergeMap as g}from"rxjs/operators";import w from"lodash/uniqBy";import{Card as O,Flex as j,Spinner as v,Stack as P}from"@sanity/ui";import{DashboardWidgetContainer as _}from"@sanity/dashboard";const x=e=>"drafts.".concat(e._id);function E(e,t,r){return r.listen(e,t,{events:["welcome","mutation"],includeResult:!1,visibility:"query"}).pipe(f((n=>y(1).pipe("welcome"===n.type?h():b(1e3),g((()=>r.fetch(e,t).then((e=>function(e,t){if(!e)return Promise.resolve([]);const r=Array.isArray(e)?e:[e],n=r.filter((e=>!e._id.startsWith("drafts."))).map(x);return t.fetch("*[_id in $ids]",{ids:n}).then((e=>{const t=r.map((t=>e.find((e=>e._id===x(t)))||t));return w(t,"_id")})).catch((e=>{throw new Error("Problems fetching docs ".concat(n,". Error: ").concat(e.message))}))}(e,r))).catch((r=>{if(r.message.startsWith("Problems fetching docs"))throw r;throw new Error("Query failed ".concat(e," and ").concat(JSON.stringify(t),". Error: ").concat(r.message))}))))))))}const q={title:"Last created",order:"_createdAt desc",limit:10,queryParams:{},showCreateButton:!0,apiVersion:"v1"};function B(e){const{query:r,limit:p,apiVersion:l,queryParams:y,types:f,order:h,title:b,showCreateButton:g,createButtonText:w}=t(t({},q),e),[x,B]=o(),[D,Q]=o(!0),[S,A]=o(),T=s({apiVersion:l}),V=d(),{assembledQuery:N,params:W}=c((()=>{if(r)return{assembledQuery:r,params:y};const e=V.getTypeNames().filter((e=>{var t;const r=V.get(e);return"document"===(null==(t=null==r?void 0:r.type)?void 0:t.name)}));return{assembledQuery:"*[_type in $types] | order(".concat(h,") [0...").concat(2*p,"]"),params:{types:f?m(f,e):e}}}),[V,r,y,h,p,f]);return a((()=>{if(!N)return;const e=E(N,W,T).subscribe({next:e=>{B(e.slice(0,p)),Q(!1)},error:e=>{A(e),Q(!1)}});return()=>{e.unsubscribe()}}),[p,T,N,W]),n(_,{header:b,footer:f&&1===f.length&&g&&n(u,{mode:"bleed",style:{width:"100%"},paddingX:2,paddingY:4,tone:"primary",type:"button",intent:"create",params:{type:f[0]},text:w||"Create new ".concat(f[0])}),children:i(O,{children:[S&&n("div",{children:S.message}),!S&&D&&n(O,{padding:4,children:n(j,{justify:"center",children:n(v,{muted:!0})})}),!S&&!x&&!D&&n("div",{children:"Could not locate any documents :/"}),n(P,{space:2,children:x&&x.map((e=>n(C,{doc:e},e._id)))})]})})}function C(e){let{doc:t}=e;const r=d().get(t._type);return n(O,{flex:1,children:n(u,{intent:"edit",mode:"bleed",padding:1,radius:0,params:{type:t._type,id:p(t._id)},style:{width:"100%"},children:r?n(l,{layout:"default",schemaType:r,value:t},t._id):"Schema-type missing"})})}function D(e){return{name:"document-list-widget",component:function(){return n(B,t({},e))},layout:e.layout}}export{D as documentListWidget};
-//# sourceMappingURL=index.esm.js.map

package/lib/index.esm.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.esm.js","sources":["../src/sanityConnector.ts","../src/DocumentList.tsx","../src/plugin.tsx"],"sourcesContent":["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'\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<SanityDocument[]>('*[_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","import React, {useEffect, useMemo, useState} from 'react'\nimport {getPublishedId, useClient, useSchema} from 'sanity'\nimport {intersection} from 'lodash'\nimport {getSubscription} from './sanityConnector'\nimport {SanityDocument, IntentButton, SanityPreview} from 'sanity'\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 versionedClient = useClient({apiVersion})\n  const schema = useSchema()\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?.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        {type ? (\n          <SanityPreview layout=\"default\" schemaType={type} value={doc} key={doc._id} />\n        ) : (\n          'Schema-type missing'\n        )}\n      </IntentButton>\n    </Card>\n  )\n}\n\nexport default DocumentList\n","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"],"names":["draftId","nonDraftDoc","_id","getSubscription","query","params","client","listen","events","includeResult","visibility","pipe","switchMap","event","observableOf","type","tap","delay","mergeMap","fetch","then","incoming","Promise","resolve","documents","Array","isArray","ids","filter","doc","startsWith","map","drafts","outgoing","find","draft","uniqBy","catch","error","Error","message","prepareDocumentList","JSON","stringify","defaultProps","title","order","limit","queryParams","showCreateButton","apiVersion","DocumentList","props","types","createButtonText","setDocuments","useState","loading","setLoading","setError","versionedClient","useClient","schema","useSchema","assembledQuery","useMemo","documentTypes","getTypeNames","typeName","_a","schemaType","get","name","concat","intersection","useEffect","subscription","subscribe","next","d","slice","e","unsubscribe","jsx","DashboardWidgetContainer","header","footer","length","IntentButton","mode","style","width","paddingX","paddingY","tone","intent","text","children","jsxs","Card","padding","Flex","justify","Spinner","muted","Stack","space","MenuEntry","_ref","_type","flex","radius","id","getPublishedId","SanityPreview","layout","value","documentListWidget","config","component","_objectSpread"],"mappings":"4rCAMA,MAAMA,EAAWC,oBAA0CA,EAAYC,KA2BvD,SAAAC,EACdC,EACAC,EACAC,GAEO,OAAAA,EACJC,OAAOH,EAAOC,EAAQ,CACrBG,OAAQ,CAAC,UAAW,YACpBC,eAAe,EACfC,WAAY,UAEbC,KACCC,GAAWC,GACFC,EAAa,GAAGH,KACN,YAAfE,EAAME,KAAqBC,IAAQC,EAAM,KACzCC,GAAS,IACPZ,EACGa,MAAMf,EAAOC,GACbe,MAAMC,GA3CrB,SACEA,EACAf,GAEA,IAAKe,EACI,OAAAC,QAAQC,QAAQ,IAEzB,MAAMC,EAAYC,MAAMC,QAAQL,GAAYA,EAAW,CAACA,GAElDM,EAAMH,EAAUI,QAAQC,IAASA,EAAI3B,IAAI4B,WAAW,aAAYC,IAAI/B,GAEnE,OAAAM,EACJa,MAAwB,iBAAkB,CAACQ,QAC3CP,MAAMY,IACL,MAAMC,EAAWT,EAAUO,KAAKF,GACXG,EAAOE,MAAMC,GAAUA,EAAMjC,MAAQF,EAAQ6B,MAC3CA,IAEhB,OAAAO,EAAOH,EAAU,MAAK,IAE9BI,OAAOC,IACN,MAAM,IAAIC,MAAgCZ,0BAAAA,OAAAA,sBAAeW,EAAME,SAAS,GAE9E,CAqBuBC,CAAoBpB,EAAUf,KAEtC+B,OAAOC,IACN,GAAIA,EAAME,QAAQV,WAAW,0BACrB,MAAAQ,EAER,MAAM,IAAIC,MACQnC,gBAAAA,OAAAA,kBAAasC,KAAKC,UAAUtC,uBAAmBiC,EAAME,SACvE,SAMhB,CC9CA,MAAMI,EAAe,CACnBC,MAAO,eACPC,MAAO,kBACPC,MAAO,GACPC,YAAa,CAAC,EACdC,kBAAkB,EAClBC,WAAY,MAGP,SAASC,EAAaC,GACrB,MAAAhD,MACJA,EAAA2C,MACAA,EAAAG,WACAA,EAAAF,YACAA,EAAAK,MACAA,EAAAP,MACAA,EAAAD,MACAA,EAAAI,iBACAA,EAAAK,iBACAA,GAEGV,EAAAA,EAAAA,CAAAA,EAAAA,GACAQ,IAGE5B,EAAW+B,GAAgBC,KAC3BC,EAASC,GAAcF,GAAkB,IACzClB,EAAOqB,GAAYH,IAEpBI,EAAkBC,EAAU,CAACX,eAC7BY,EAASC,KAETC,eAACA,EAAA3D,OAAgBA,GAAU4D,GAAQ,KACvC,GAAI7D,EACF,MAAO,CAAC4D,eAAgB5D,EAAOC,OAAQ2C,GAGzC,MAAMkB,EAAgBJ,EAAOK,eAAevC,QAAQwC,IAzDxD,IAAAC,EA0DY,MAAAC,EAAaR,EAAOS,IAAIH,GACvB,MAA2B,cAA3B,OAAAC,EAAA,MAAAC,OAAA,EAAAA,EAAYvD,WAAZ,EAAAsD,EAAkBG,KAAS,IAG7B,MAAA,CACLR,oDAA8ClB,EAAA,WAAA2B,OAAuB,EAAR1B,EAAQ,KACrE1C,OAAQ,CAACgD,MAAOA,EAAQqB,EAAarB,EAAOa,GAAiBA,GAC/D,GACC,CAACJ,EAAQ1D,EAAO4C,EAAaF,EAAOC,EAAOM,IAuB9C,OArBAsB,GAAU,KACR,IAAKX,EACH,OAGF,MAAMY,EAAezE,EAAgB6D,EAAgB3D,EAAQuD,GAAiBiB,UAAU,CACtFC,KAAOC,IACLxB,EAAawB,EAAEC,MAAM,EAAGjC,IACxBW,GAAW,EAAK,EAElBpB,MAAQ2C,IACNtB,EAASsB,GACTvB,GAAW,EAAK,IAIpB,MAAO,KACLkB,EAAaM,aAAY,CAC3B,GACC,CAACnC,EAAOa,EAAiBI,EAAgB3D,IAGzC8E,EAAAC,EAAA,CACCC,OAAQxC,EACRyC,OACEjC,GACiB,IAAjBA,EAAMkC,QACNtC,GACGkC,EAAAK,EAAA,CACCC,KAAK,QACLC,MAAO,CAACC,MAAO,QACfC,SAAU,EACVC,SAAU,EACVC,KAAK,UACL/E,KAAK,SACLgF,OAAO,SACP1F,OAAQ,CAACU,KAAMsC,EAAM,IACrB2C,KAAM1C,GAAoB,cAAAmB,OAAcpB,EAAM,MAKpD4C,SAACC,EAAAC,EAAA,CACEF,SAAA,CAAA3D,GAAU6C,EAAA,MAAA,CAAKc,SAAM3D,EAAAE,WACpBF,GAASmB,GACR0B,EAAAgB,EAAA,CAAKC,QAAS,EACbH,SAACd,EAAAkB,EAAA,CAAKC,QAAQ,SACZL,SAACd,EAAAoB,EAAA,CAAQC,OAAK,SAIlBlE,IAAUd,IAAciC,GAAY0B,EAAA,MAAA,CAAIc,SAAA,sCACzCd,EAAAsB,EAAA,CAAMC,MAAO,EACXT,SAAazE,GAAAA,EAAUO,KAAKF,GAASsD,EAAAwB,EAAA,CAAwB9E,OAATA,EAAI3B,aAKnE,CAEA,SAASyG,EAAwCC,GAAA,IAA9B/E,IAACA,GAA6B+E,EAC/C,MACM7F,EADSgD,IACKQ,IAAI1C,EAAIgF,OAC5B,OACG1B,EAAAgB,EAAA,CAAKW,KAAM,EACVb,SAACd,EAAAK,EAAA,CACCO,OAAO,OACPN,KAAK,QACLW,QAAS,EACTW,OAAQ,EACR1G,OAAQ,CACNU,KAAMc,EAAIgF,MACVG,GAAIC,EAAepF,EAAI3B,MAEzBwF,MAAO,CAACC,MAAO,QAEdM,WACEd,EAAA+B,EAAA,CAAcC,OAAO,UAAU7C,WAAYvD,EAAMqG,MAAOvF,GAAUA,EAAI3B,KAEvE,yBAKV,CChJO,SAASmH,EAAmBC,GAC1B,MAAA,CACL9C,KAAM,uBACN+C,UAAW,WACT,OAAQpC,EAAAhC,EAAAqE,EAAA,CAAA,EAAiBF,GAC3B,EACAH,OAAQG,EAAOH,OAEnB"}

package/lib/index.js

@@ -1,2 +0,0 @@
-"use strict";function e(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function t(t){for(var n=1;n<arguments.length;n++){var i=null!=arguments[n]?arguments[n]:{};n%2?e(Object(i),!0).forEach((function(e){r(t,e,i[e])})):Object.getOwnPropertyDescriptors?Object.defineProperties(t,Object.getOwnPropertyDescriptors(i)):e(Object(i)).forEach((function(e){Object.defineProperty(t,e,Object.getOwnPropertyDescriptor(i,e))}))}return t}function r(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}Object.defineProperty(exports,"__esModule",{value:!0});var n=require("react/jsx-runtime"),i=require("react"),s=require("sanity"),a=require("lodash"),o=require("rxjs"),c=require("rxjs/operators"),u=require("lodash/uniqBy"),d=require("@sanity/ui"),l=require("@sanity/dashboard");function p(e){return e&&"object"==typeof e&&"default"in e?e:{default:e}}var y=p(u);const f=e=>"drafts.".concat(e._id);function m(e,t,r){return r.listen(e,t,{events:["welcome","mutation"],includeResult:!1,visibility:"query"}).pipe(c.switchMap((n=>o.of(1).pipe("welcome"===n.type?c.tap():c.delay(1e3),c.mergeMap((()=>r.fetch(e,t).then((e=>function(e,t){if(!e)return Promise.resolve([]);const r=Array.isArray(e)?e:[e],n=r.filter((e=>!e._id.startsWith("drafts."))).map(f);return t.fetch("*[_id in $ids]",{ids:n}).then((e=>{const t=r.map((t=>e.find((e=>e._id===f(t)))||t));return y.default(t,"_id")})).catch((e=>{throw new Error("Problems fetching docs ".concat(n,". Error: ").concat(e.message))}))}(e,r))).catch((r=>{if(r.message.startsWith("Problems fetching docs"))throw r;throw new Error("Query failed ".concat(e," and ").concat(JSON.stringify(t),". Error: ").concat(r.message))}))))))))}const h={title:"Last created",order:"_createdAt desc",limit:10,queryParams:{},showCreateButton:!0,apiVersion:"v1"};function b(e){const{query:r,limit:o,apiVersion:c,queryParams:u,types:p,order:y,title:f,showCreateButton:b,createButtonText:g}=t(t({},h),e),[x,w]=i.useState(),[O,v]=i.useState(!0),[P,q]=i.useState(),_=s.useClient({apiVersion:c}),S=s.useSchema(),{assembledQuery:C,params:E}=i.useMemo((()=>{if(r)return{assembledQuery:r,params:u};const e=S.getTypeNames().filter((e=>{var t;const r=S.get(e);return"document"===(null==(t=null==r?void 0:r.type)?void 0:t.name)}));return{assembledQuery:"*[_type in $types] | order(".concat(y,") [0...").concat(2*o,"]"),params:{types:p?a.intersection(p,e):e}}}),[S,r,u,y,o,p]);return i.useEffect((()=>{if(!C)return;const e=m(C,E,_).subscribe({next:e=>{w(e.slice(0,o)),v(!1)},error:e=>{q(e),v(!1)}});return()=>{e.unsubscribe()}}),[o,_,C,E]),n.jsx(l.DashboardWidgetContainer,{header:f,footer:p&&1===p.length&&b&&n.jsx(s.IntentButton,{mode:"bleed",style:{width:"100%"},paddingX:2,paddingY:4,tone:"primary",type:"button",intent:"create",params:{type:p[0]},text:g||"Create new ".concat(p[0])}),children:n.jsxs(d.Card,{children:[P&&n.jsx("div",{children:P.message}),!P&&O&&n.jsx(d.Card,{padding:4,children:n.jsx(d.Flex,{justify:"center",children:n.jsx(d.Spinner,{muted:!0})})}),!P&&!x&&!O&&n.jsx("div",{children:"Could not locate any documents :/"}),n.jsx(d.Stack,{space:2,children:x&&x.map((e=>n.jsx(j,{doc:e},e._id)))})]})})}function j(e){let{doc:t}=e;const r=s.useSchema().get(t._type);return n.jsx(d.Card,{flex:1,children:n.jsx(s.IntentButton,{intent:"edit",mode:"bleed",padding:1,radius:0,params:{type:t._type,id:s.getPublishedId(t._id)},style:{width:"100%"},children:r?n.jsx(s.SanityPreview,{layout:"default",schemaType:r,value:t},t._id):"Schema-type missing"})})}exports.documentListWidget=function(e){return{name:"document-list-widget",component:function(){return n.jsx(b,t({},e))},layout:e.layout}};
-//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sources":["../src/sanityConnector.ts","../src/DocumentList.tsx","../src/plugin.tsx"],"sourcesContent":["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'\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<SanityDocument[]>('*[_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","import React, {useEffect, useMemo, useState} from 'react'\nimport {getPublishedId, useClient, useSchema} from 'sanity'\nimport {intersection} from 'lodash'\nimport {getSubscription} from './sanityConnector'\nimport {SanityDocument, IntentButton, SanityPreview} from 'sanity'\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 versionedClient = useClient({apiVersion})\n  const schema = useSchema()\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?.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        {type ? (\n          <SanityPreview layout=\"default\" schemaType={type} value={doc} key={doc._id} />\n        ) : (\n          'Schema-type missing'\n        )}\n      </IntentButton>\n    </Card>\n  )\n}\n\nexport default DocumentList\n","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"],"names":["draftId","nonDraftDoc","_id","getSubscription","query","params","client","listen","events","includeResult","visibility","pipe","switchMap","event","observableOf","of","type","tap","delay","mergeMap","fetch","then","incoming","Promise","resolve","documents","Array","isArray","ids","filter","doc","startsWith","map","drafts","outgoing","find","draft","uniqBy","catch","error","Error","message","prepareDocumentList","JSON","stringify","defaultProps","title","order","limit","queryParams","showCreateButton","apiVersion","DocumentList","props","types","createButtonText","setDocuments","useState","loading","setLoading","setError","versionedClient","useClient","schema","useSchema","assembledQuery","useMemo","documentTypes","getTypeNames","typeName","_a","schemaType","get","name","concat","intersection","useEffect","subscription","subscribe","next","d","slice","e","unsubscribe","jsx","DashboardWidgetContainer","header","footer","length","IntentButton","mode","style","width","paddingX","paddingY","tone","intent","text","children","jsxs","Card","padding","Flex","justify","Spinner","muted","Stack","space","MenuEntry","_ref","_type","flex","radius","id","getPublishedId","SanityPreview","layout","value","config","component","_objectSpread"],"mappings":"4iCAMA,MAAMA,EAAWC,oBAA0CA,EAAYC,KA2BvD,SAAAC,EACdC,EACAC,EACAC,GAEO,OAAAA,EACJC,OAAOH,EAAOC,EAAQ,CACrBG,OAAQ,CAAC,UAAW,YACpBC,eAAe,EACfC,WAAY,UAEbC,KACCC,EAAAA,WAAWC,GACFC,EAAAC,GAAa,GAAGJ,KACN,YAAfE,EAAMG,KAAqBC,EAAIA,MAAIC,EAAAA,MAAM,KACzCC,EAAAA,UAAS,IACPb,EACGc,MAAMhB,EAAOC,GACbgB,MAAMC,GA3CrB,SACEA,EACAhB,GAEA,IAAKgB,EACI,OAAAC,QAAQC,QAAQ,IAEzB,MAAMC,EAAYC,MAAMC,QAAQL,GAAYA,EAAW,CAACA,GAElDM,EAAMH,EAAUI,QAAQC,IAASA,EAAI5B,IAAI6B,WAAW,aAAYC,IAAIhC,GAEnE,OAAAM,EACJc,MAAwB,iBAAkB,CAACQ,QAC3CP,MAAMY,IACL,MAAMC,EAAWT,EAAUO,KAAKF,GACXG,EAAOE,MAAMC,GAAUA,EAAMlC,MAAQF,EAAQ8B,MAC3CA,IAEhB,OAAAO,EAAA,QAAOH,EAAU,MAAK,IAE9BI,OAAOC,IACN,MAAM,IAAIC,MAAgCZ,0BAAAA,OAAAA,sBAAeW,EAAME,SAAS,GAE9E,CAqBuBC,CAAoBpB,EAAUhB,KAEtCgC,OAAOC,IACN,GAAIA,EAAME,QAAQV,WAAW,0BACrB,MAAAQ,EAER,MAAM,IAAIC,MACQpC,gBAAAA,OAAAA,kBAAauC,KAAKC,UAAUvC,uBAAmBkC,EAAME,SACvE,SAMhB,CC9CA,MAAMI,EAAe,CACnBC,MAAO,eACPC,MAAO,kBACPC,MAAO,GACPC,YAAa,CAAC,EACdC,kBAAkB,EAClBC,WAAY,MAGP,SAASC,EAAaC,GACrB,MAAAjD,MACJA,EAAA4C,MACAA,EAAAG,WACAA,EAAAF,YACAA,EAAAK,MACAA,EAAAP,MACAA,EAAAD,MACAA,EAAAI,iBACAA,EAAAK,iBACAA,GAEGV,EAAAA,EAAAA,CAAAA,EAAAA,GACAQ,IAGE5B,EAAW+B,GAAgBC,EAAuCA,YAClEC,EAASC,GAAcF,YAAkB,IACzClB,EAAOqB,GAAYH,EAA4BA,WAEhDI,EAAkBC,EAAAA,UAAU,CAACX,eAC7BY,EAASC,EAAAA,aAETC,eAACA,EAAA5D,OAAgBA,GAAU6D,WAAQ,KACvC,GAAI9D,EACF,MAAO,CAAC6D,eAAgB7D,EAAOC,OAAQ4C,GAGzC,MAAMkB,EAAgBJ,EAAOK,eAAevC,QAAQwC,IAzDxD,IAAAC,EA0DY,MAAAC,EAAaR,EAAOS,IAAIH,GACvB,MAA2B,cAA3B,OAAAC,EAAA,MAAAC,OAAA,EAAAA,EAAYvD,WAAZ,EAAAsD,EAAkBG,KAAS,IAG7B,MAAA,CACLR,oDAA8ClB,EAAA,WAAA2B,OAAuB,EAAR1B,EAAQ,KACrE3C,OAAQ,CAACiD,MAAOA,EAAQqB,eAAarB,EAAOa,GAAiBA,GAC/D,GACC,CAACJ,EAAQ3D,EAAO6C,EAAaF,EAAOC,EAAOM,IAuB9C,OArBAsB,EAAAA,WAAU,KACR,IAAKX,EACH,OAGF,MAAMY,EAAe1E,EAAgB8D,EAAgB5D,EAAQwD,GAAiBiB,UAAU,CACtFC,KAAOC,IACLxB,EAAawB,EAAEC,MAAM,EAAGjC,IACxBW,GAAW,EAAK,EAElBpB,MAAQ2C,IACNtB,EAASsB,GACTvB,GAAW,EAAK,IAIpB,MAAO,KACLkB,EAAaM,aAAY,CAC3B,GACC,CAACnC,EAAOa,EAAiBI,EAAgB5D,IAGzC+E,EAAAA,IAAAC,EAAAA,yBAAA,CACCC,OAAQxC,EACRyC,OACEjC,GACiB,IAAjBA,EAAMkC,QACNtC,GACGkC,EAAAA,IAAAK,eAAA,CACCC,KAAK,QACLC,MAAO,CAACC,MAAO,QACfC,SAAU,EACVC,SAAU,EACVC,KAAK,UACL/E,KAAK,SACLgF,OAAO,SACP3F,OAAQ,CAACW,KAAMsC,EAAM,IACrB2C,KAAM1C,GAAoB,cAAAmB,OAAcpB,EAAM,MAKpD4C,SAACC,EAAAA,KAAAC,OAAA,CACEF,SAAA,CAAA3D,GAAU6C,EAAAA,IAAA,MAAA,CAAKc,SAAM3D,EAAAE,WACpBF,GAASmB,GACR0B,EAAAA,IAAAgB,OAAA,CAAKC,QAAS,EACbH,SAACd,EAAAA,IAAAkB,OAAA,CAAKC,QAAQ,SACZL,SAACd,EAAAA,IAAAoB,UAAA,CAAQC,OAAK,SAIlBlE,IAAUd,IAAciC,GAAY0B,EAAAA,IAAA,MAAA,CAAIc,SAAA,sCACzCd,EAAAA,IAAAsB,EAAAA,MAAA,CAAMC,MAAO,EACXT,SAAazE,GAAAA,EAAUO,KAAKF,GAASsD,EAAAA,IAAAwB,EAAA,CAAwB9E,OAATA,EAAI5B,aAKnE,CAEA,SAAS0G,EAAwCC,GAAA,IAA9B/E,IAACA,GAA6B+E,EAC/C,MACM7F,EADSgD,EAAAA,YACKQ,IAAI1C,EAAIgF,OAC5B,OACG1B,EAAAA,IAAAgB,EAAAA,KAAA,CAAKW,KAAM,EACVb,SAACd,EAAAA,IAAAK,eAAA,CACCO,OAAO,OACPN,KAAK,QACLW,QAAS,EACTW,OAAQ,EACR3G,OAAQ,CACNW,KAAMc,EAAIgF,MACVG,GAAIC,EAAAA,eAAepF,EAAI5B,MAEzByF,MAAO,CAACC,MAAO,QAEdM,WACEd,EAAAA,IAAA+B,gBAAA,CAAcC,OAAO,UAAU7C,WAAYvD,EAAMqG,MAAOvF,GAAUA,EAAI5B,KAEvE,yBAKV,4BChJO,SAA4BoH,GAC1B,MAAA,CACL7C,KAAM,uBACN8C,UAAW,WACT,OAAQnC,EAAAA,IAAAhC,EAAAoE,EAAA,CAAA,EAAiBF,GAC3B,EACAF,OAAQE,EAAOF,OAEnB"}