sanity-plugin-documents-pane 1.1.0 → 1.1.1

package/.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx --no -- commitlint --edit ""

package/.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx lint-staged

package/.releaserc.json

@@ -0,0 +1,7 @@
+{
+  "extends": "@sanity/semantic-release-preset",
+  "branches": [
+    "main",
+    { "name": "studio-v2", "channel": "studio-v2", "range": "1.1.x" }
+  ]
+}

package/CHANGELOG.md

@@ -0,0 +1,12 @@
+<!-- markdownlint-disable --><!-- textlint-disable -->
+
+# 📓 Changelog
+
+All notable changes to this project will be documented in this file. See
+[Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## [1.1.1](https://github.com/sanity-io/sanity-plugin-documents-pane/compare/v1.1.0...v1.1.1) (2022-11-22)
+
+### Bug Fixes
+
+- **ci:** publish using semantic-release ([7624fac](https://github.com/sanity-io/sanity-plugin-documents-pane/commit/7624fac74aea307f7999071f5228af5df8447885))

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Simeon Griggs
+Copyright (c) 2022 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,13 +1,23 @@
 # sanity-plugin-documents-pane
 
+> This is a **Sanity Studio v2** plugin.
+> For the v3 version, please refer to the [v3-branch](https://github.com/sanity-io/sanity-plugin-documents-pane).
+
 Displays the results of a GROQ query in a View Pane. With the ability to use field values in the current document as query parameters.
 
 ![Incoming References](https://user-images.githubusercontent.com/9684022/121202594-52bc6180-c86d-11eb-897d-f418047b3d22.png)
 
 ## Installation
 
+```sh
+yarn add sanity-plugin-documents-pane@studio-v2
 ```
-sanity install documents-pane
+
+Next, add `"documents-pane"` to `sanity.json` plugins array:
+```json
+"plugins": [
+  "documents-pane"
+]
 ```
 
 This plugin is designed to be used as a [Component inside of a View](https://www.sanity.io/docs/structure-builder-reference#c0c8284844b7).
@@ -32,16 +42,17 @@ S.view
 The `.options()` configuration works as follows:
 
 - `query` (string, required) A string defining the entire GROQ query that will select documents to list.
-- `params` (object or function, optional) 
+- `params` (object or function, optional)
   - Object: a [dot-notated string](https://www.npmjs.com/package/dlv) from the document object to a field, to use as variables in the query.
   - Function: a function that receives the various displayed, draft, and published versions of the document, and returns an object of query parameters. Return null if the parameters cannot be resolved.
 - `useDraft` (bool, optional, default: `false`) When populating the `params` values, it will use the `published` version of the document by default. Not permitted if using a function for `params` as the function will determine which version of the document to use.
 - `debug` (bool, optional, default: `false`) In case of an error or the query returning no documents, setting to `true` will display the query and params that were used.
 - `initialValueTemplates` (function, optional) A function that receives the various displayed, draft, and published versions of the document, and returns a list of initial value templates. These will be used to define buttons at the top of the list so users can create new related documents.
 
-
 ## Resolving query parameters with a function and providing initial value templates
+
 Providing a function for `params` allows us to modify values from the current document, for example to list references to a draft document. Providing a function for the `initialValueTemplates` option allows us to determine which buttons to show and what parameters will be used for the new document.
+
 ```js
 const options = {
   query: `*[_type=="post" && author._ref == $id]`,
@@ -49,14 +60,14 @@ const options = {
     // references will never point to a draft ID, so extract the regular ID
     const id = document.displayed._id?.replace('drafts.', '')
 
-    // we don't have to worry about undefined parameters, 
+    // we don't have to worry about undefined parameters,
     // as the plugin will handle them and show an appropriate message
     return {id}
   },
   initialValueTemplates: ({document}) => {
     const templates = []
 
-    // references must point to a non-draft ID, so if using the ID in the template, 
+    // references must point to a non-draft ID, so if using the ID in the template,
     // be sure it doesn't start with `drafts.`
     const id = document?.displayed?._id.replace('drafts.', '')
     const name = document?.displayed?.name || 'author'
@@ -90,5 +101,5 @@ This plugin is based on [Incoming References](https://github.com/sanity-io/sanit
 
 ## License
 
-MIT © Simeon Griggs
-See LICENSE
+MIT © Sanity.io
+See [LICENSE](license)

package/commitlint.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ['@commitlint/config-conventional'],
+}

package/lib/NewDocument.js

@@ -32,6 +32,10 @@ function NewDocument(props) {
     justify: "flex-end",
     gap: 1
   }, initialValueTemplates.map(template => {
+    if (!template.template) {
+      return null;
+    }
+
     return /*#__PURE__*/_react.default.createElement(ReferenceChildLink, {
       documentId: (0, _uuid.uuid)(),
       documentType: template.schemaType,
@@ -40,10 +44,7 @@ function NewDocument(props) {
         params: template.parameters
       },
       parentRefPath: [],
-      key: "".concat(template.schemaType, "-").concat(template.template),
-      style: {
-        textDecoration: 'none'
-      }
+      key: "".concat(template.schemaType, "-").concat(template.template)
     }, /*#__PURE__*/_react.default.createElement(_ui.Button, {
       icon: /*#__PURE__*/_react.default.createElement(_icons.ComposeIcon, null),
       text: template.title,

package/lib/NewDocument.js.map

@@ -1 +1 @@
-{"version":3,"file":"NewDocument.js","names":["NewDocument","props","initialValueTemplates","usePaneRouter","ReferenceChildLink","length","map","template","uuid","schemaType","id","params","parameters","textDecoration","title"],"sources":["../src/NewDocument.tsx"],"sourcesContent":["import {Button, Card, Flex} from '@sanity/ui'\nimport React from 'react'\nimport {DocumentsPaneInitialValueTemplate} from './types'\nimport {ComposeIcon} from '@sanity/icons'\nimport {usePaneRouter} from '@sanity/desk-tool'\nimport {uuid} from \"@sanity/uuid\"\n\ninterface NewDocumentProps {\n  initialValueTemplates: DocumentsPaneInitialValueTemplate[]\n}\n\nexport default function NewDocument(props: NewDocumentProps) {\n  const {initialValueTemplates = []} = props\n  const {ReferenceChildLink} = usePaneRouter()\n\n  if (!initialValueTemplates.length) return null\n\n  return (\n    <Card borderBottom={true} padding={2}>\n      <Flex justify=\"flex-end\" gap={1}>\n        {initialValueTemplates.map((template) => {\n          return (\n            <ReferenceChildLink\n              documentId={uuid()}\n              documentType={template.schemaType}\n              template={{id: template.template, params: template.parameters}}\n              parentRefPath={[]}\n              key={`${template.schemaType}-${template.template}`}\n              style={{textDecoration: 'none'}}\n            >\n              <Button icon={<ComposeIcon />} text={template.title} mode=\"bleed\" as=\"span\" />\n            </ReferenceChildLink>\n          )\n        })}\n      </Flex>\n    </Card>\n  )\n}\n"],"mappings":";;;;;;;AAAA;;AACA;;AAEA;;AACA;;AACA;;;;AAMe,SAASA,WAAT,CAAqBC,KAArB,EAA8C;EAC3D,4BAAqCA,KAArC,CAAOC,qBAAP;EAAA,IAAOA,qBAAP,sCAA+B,EAA/B;;EACA,qBAA6B,IAAAC,uBAAA,GAA7B;EAAA,IAAOC,kBAAP,kBAAOA,kBAAP;;EAEA,IAAI,CAACF,qBAAqB,CAACG,MAA3B,EAAmC,OAAO,IAAP;EAEnC,oBACE,6BAAC,QAAD;IAAM,YAAY,EAAE,IAApB;IAA0B,OAAO,EAAE;EAAnC,gBACE,6BAAC,QAAD;IAAM,OAAO,EAAC,UAAd;IAAyB,GAAG,EAAE;EAA9B,GACGH,qBAAqB,CAACI,GAAtB,CAA2BC,QAAD,IAAc;IACvC,oBACE,6BAAC,kBAAD;MACE,UAAU,EAAE,IAAAC,UAAA,GADd;MAEE,YAAY,EAAED,QAAQ,CAACE,UAFzB;MAGE,QAAQ,EAAE;QAACC,EAAE,EAAEH,QAAQ,CAACA,QAAd;QAAwBI,MAAM,EAAEJ,QAAQ,CAACK;MAAzC,CAHZ;MAIE,aAAa,EAAE,EAJjB;MAKE,GAAG,YAAKL,QAAQ,CAACE,UAAd,cAA4BF,QAAQ,CAACA,QAArC,CALL;MAME,KAAK,EAAE;QAACM,cAAc,EAAE;MAAjB;IANT,gBAQE,6BAAC,UAAD;MAAQ,IAAI,eAAE,6BAAC,kBAAD,OAAd;MAA+B,IAAI,EAAEN,QAAQ,CAACO,KAA9C;MAAqD,IAAI,EAAC,OAA1D;MAAkE,EAAE,EAAC;IAArE,EARF,CADF;EAYD,CAbA,CADH,CADF,CADF;AAoBD"}
+{"version":3,"file":"NewDocument.js","names":["NewDocument","props","initialValueTemplates","usePaneRouter","ReferenceChildLink","length","map","template","uuid","schemaType","id","params","parameters","title"],"sources":["../src/NewDocument.tsx"],"sourcesContent":["import {Button, Card, Flex} from '@sanity/ui'\nimport React from 'react'\nimport {DocumentsPaneInitialValueTemplate} from './types'\nimport {ComposeIcon} from '@sanity/icons'\nimport {usePaneRouter} from '@sanity/desk-tool'\nimport {uuid} from '@sanity/uuid'\n\ninterface NewDocumentProps {\n  initialValueTemplates: DocumentsPaneInitialValueTemplate[]\n}\n\nexport default function NewDocument(props: NewDocumentProps) {\n  const {initialValueTemplates = []} = props\n  const {ReferenceChildLink} = usePaneRouter()\n\n  if (!initialValueTemplates.length) return null\n\n  return (\n    <Card borderBottom={true} padding={2}>\n      <Flex justify=\"flex-end\" gap={1}>\n        {initialValueTemplates.map((template) => {\n          if (!template.template) {\n            return null\n          }\n          return (\n            <ReferenceChildLink\n              documentId={uuid()}\n              documentType={template.schemaType}\n              template={{id: template.template, params: template.parameters}}\n              parentRefPath={[]}\n              key={`${template.schemaType}-${template.template}`}\n            >\n              <Button icon={<ComposeIcon />} text={template.title} mode=\"bleed\" as=\"span\" />\n            </ReferenceChildLink>\n          )\n        })}\n      </Flex>\n    </Card>\n  )\n}\n"],"mappings":";;;;;;;AAAA;;AACA;;AAEA;;AACA;;AACA;;;;AAMe,SAASA,WAAT,CAAqBC,KAArB,EAA8C;EAC3D,4BAAqCA,KAArC,CAAOC,qBAAP;EAAA,IAAOA,qBAAP,sCAA+B,EAA/B;;EACA,qBAA6B,IAAAC,uBAAA,GAA7B;EAAA,IAAOC,kBAAP,kBAAOA,kBAAP;;EAEA,IAAI,CAACF,qBAAqB,CAACG,MAA3B,EAAmC,OAAO,IAAP;EAEnC,oBACE,6BAAC,QAAD;IAAM,YAAY,EAAE,IAApB;IAA0B,OAAO,EAAE;EAAnC,gBACE,6BAAC,QAAD;IAAM,OAAO,EAAC,UAAd;IAAyB,GAAG,EAAE;EAA9B,GACGH,qBAAqB,CAACI,GAAtB,CAA2BC,QAAD,IAAc;IACvC,IAAI,CAACA,QAAQ,CAACA,QAAd,EAAwB;MACtB,OAAO,IAAP;IACD;;IACD,oBACE,6BAAC,kBAAD;MACE,UAAU,EAAE,IAAAC,UAAA,GADd;MAEE,YAAY,EAAED,QAAQ,CAACE,UAFzB;MAGE,QAAQ,EAAE;QAACC,EAAE,EAAEH,QAAQ,CAACA,QAAd;QAAwBI,MAAM,EAAEJ,QAAQ,CAACK;MAAzC,CAHZ;MAIE,aAAa,EAAE,EAJjB;MAKE,GAAG,YAAKL,QAAQ,CAACE,UAAd,cAA4BF,QAAQ,CAACA,QAArC;IALL,gBAOE,6BAAC,UAAD;MAAQ,IAAI,eAAE,6BAAC,kBAAD,OAAd;MAA+B,IAAI,EAAEA,QAAQ,CAACM,KAA9C;MAAqD,IAAI,EAAC,OAA1D;MAAkE,EAAE,EAAC;IAArE,EAPF,CADF;EAWD,CAfA,CADH,CADF,CADF;AAsBD"}

package/lib/hooks/useListeningQuery.js.map

@@ -1 +1 @@
-{"version":3,"file":"useListeningQuery.js","names":["DEFAULT_PARAMS","DEFAULT_OPTIONS","apiVersion","useListeningQuery","query","params","options","useState","loading","setLoading","error","setError","data","setData","subscription","useRef","useEffect","current","documentStore","listenQuery","pipe","distinctUntilChanged","isEqual","catchError","err","console","subscribe","documents","unsubscribe","undefined"],"sources":["../../src/hooks/useListeningQuery.ts"],"sourcesContent":["import React, {useEffect, useState, useRef} from 'react'\nimport documentStore from 'part:@sanity/base/datastore/document'\nimport {catchError, distinctUntilChanged} from 'rxjs/operators'\nimport isEqual from 'react-fast-compare'\n\ntype Params = Record<string, string | number | boolean | string[]>\n\ninterface ListenQueryOptions {\n  tag?: string\n  apiVersion?: string\n}\n\ntype ReturnShape = {\n  loading: boolean\n  error: boolean\n  data: any\n}\n\ntype Observable = {\n  unsubscribe: () => void\n}\n\nconst DEFAULT_PARAMS = {}\nconst DEFAULT_OPTIONS = {apiVersion: `v2022-05-09`}\n\nexport default function useListeningQuery(\n  query: string,\n  params: Params = DEFAULT_PARAMS,\n  options: ListenQueryOptions = DEFAULT_OPTIONS\n): ReturnShape {\n  const [loading, setLoading] = useState(true)\n  const [error, setError] = useState(false)\n  const [data, setData] = useState(null)\n  const subscription = useRef<null | Observable>(null)\n\n  useEffect(() => {\n    if (query) {\n      subscription.current = documentStore\n        .listenQuery(query, params, options)\n        .pipe(\n          distinctUntilChanged(isEqual),\n          catchError((err) => {\n            console.error(err)\n            setError(err)\n            setLoading(false)\n            setData(null)\n\n            return err\n          })\n        )\n        .subscribe((documents) => {\n          setData((current) => (isEqual(current, documents) ? current : documents))\n          setLoading(false)\n          setError(false)\n        })\n    }\n\n    return () => {\n      return subscription.current ? subscription.current.unsubscribe() : undefined\n    }\n  }, [query, params, options])\n\n  return {loading, error, data}\n}\n"],"mappings":";;;;;;;AAAA;;AACA;;AACA;;AACA;;;;;;;;;;;;;;;;AAmBA,IAAMA,cAAc,GAAG,EAAvB;AACA,IAAMC,eAAe,GAAG;EAACC,UAAU;AAAX,CAAxB;;AAEe,SAASC,iBAAT,CACbC,KADa,EAIA;EAAA,IAFbC,MAEa,uEAFIL,cAEJ;EAAA,IADbM,OACa,uEADiBL,eACjB;;EACb,gBAA8B,IAAAM,eAAA,EAAS,IAAT,CAA9B;EAAA;EAAA,IAAOC,OAAP;EAAA,IAAgBC,UAAhB;;EACA,iBAA0B,IAAAF,eAAA,EAAS,KAAT,CAA1B;EAAA;EAAA,IAAOG,KAAP;EAAA,IAAcC,QAAd;;EACA,iBAAwB,IAAAJ,eAAA,EAAS,IAAT,CAAxB;EAAA;EAAA,IAAOK,IAAP;EAAA,IAAaC,OAAb;;EACA,IAAMC,YAAY,GAAG,IAAAC,aAAA,EAA0B,IAA1B,CAArB;EAEA,IAAAC,gBAAA,EAAU,MAAM;IACd,IAAIZ,KAAJ,EAAW;MACTU,YAAY,CAACG,OAAb,GAAuBC,iBAAA,CACpBC,WADoB,CACRf,KADQ,EACDC,MADC,EACOC,OADP,EAEpBc,IAFoB,CAGnB,IAAAC,+BAAA,EAAqBC,yBAArB,CAHmB,EAInB,IAAAC,qBAAA,EAAYC,GAAD,IAAS;QAClBC,OAAO,CAACf,KAAR,CAAcc,GAAd;QACAb,QAAQ,CAACa,GAAD,CAAR;QACAf,UAAU,CAAC,KAAD,CAAV;QACAI,OAAO,CAAC,IAAD,CAAP;QAEA,OAAOW,GAAP;MACD,CAPD,CAJmB,EAapBE,SAboB,CAaTC,SAAD,IAAe;QACxBd,OAAO,CAAEI,OAAD,IAAc,IAAAK,yBAAA,EAAQL,OAAR,EAAiBU,SAAjB,IAA8BV,OAA9B,GAAwCU,SAAvD,CAAP;QACAlB,UAAU,CAAC,KAAD,CAAV;QACAE,QAAQ,CAAC,KAAD,CAAR;MACD,CAjBoB,CAAvB;IAkBD;;IAED,OAAO,MAAM;MACX,OAAOG,YAAY,CAACG,OAAb,GAAuBH,YAAY,CAACG,OAAb,CAAqBW,WAArB,EAAvB,GAA4DC,SAAnE;IACD,CAFD;EAGD,CAzBD,EAyBG,CAACzB,KAAD,EAAQC,MAAR,EAAgBC,OAAhB,CAzBH;EA2BA,OAAO;IAACE,OAAD;IAAUE,KAAV;IAAiBE;EAAjB,CAAP;AACD"}
+{"version":3,"file":"useListeningQuery.js","names":["DEFAULT_PARAMS","DEFAULT_OPTIONS","apiVersion","useListeningQuery","query","params","options","useState","loading","setLoading","error","setError","data","setData","subscription","useRef","useEffect","current","documentStore","listenQuery","pipe","distinctUntilChanged","isEqual","catchError","err","console","subscribe","documents","unsubscribe","undefined"],"sources":["../../src/hooks/useListeningQuery.ts"],"sourcesContent":["import type {SanityDocument} from '@sanity/types'\nimport {useEffect, useState, useRef} from 'react'\nimport documentStore from 'part:@sanity/base/datastore/document'\nimport {catchError, distinctUntilChanged} from 'rxjs/operators'\nimport isEqual from 'react-fast-compare'\n\ntype Params = Record<string, string | number | boolean | string[]>\n\ninterface ListenQueryOptions {\n  tag?: string\n  apiVersion?: string\n}\n\ntype ReturnShape = {\n  loading: boolean\n  error: boolean\n  data: SanityDocument[] | null\n}\n\ntype Observable = {\n  unsubscribe: () => void\n}\n\nconst DEFAULT_PARAMS = {}\nconst DEFAULT_OPTIONS = {apiVersion: `v2022-05-09`}\n\nexport default function useListeningQuery(\n  query: string,\n  params: Params = DEFAULT_PARAMS,\n  options: ListenQueryOptions = DEFAULT_OPTIONS\n): ReturnShape {\n  const [loading, setLoading] = useState(true)\n  const [error, setError] = useState(false)\n  const [data, setData] = useState<SanityDocument[] | null>(null)\n  const subscription = useRef<null | Observable>(null)\n\n  useEffect(() => {\n    if (query) {\n      subscription.current = documentStore\n        .listenQuery(query, params, options)\n        .pipe(\n          distinctUntilChanged(isEqual),\n          catchError((err) => {\n            console.error(err)\n            setError(err)\n            setLoading(false)\n            setData(null)\n\n            return err\n          })\n        )\n        .subscribe((documents: SanityDocument[]) => {\n          setData((current) => (isEqual(current, documents) ? current : documents))\n          setLoading(false)\n          setError(false)\n        })\n    }\n\n    return () => {\n      return subscription.current ? subscription.current.unsubscribe() : undefined\n    }\n  }, [query, params, options])\n\n  return {loading, error, data}\n}\n"],"mappings":";;;;;;;AACA;;AACA;;AACA;;AACA;;;;;;;;;;;;;;;;AAmBA,IAAMA,cAAc,GAAG,EAAvB;AACA,IAAMC,eAAe,GAAG;EAACC,UAAU;AAAX,CAAxB;;AAEe,SAASC,iBAAT,CACbC,KADa,EAIA;EAAA,IAFbC,MAEa,uEAFIL,cAEJ;EAAA,IADbM,OACa,uEADiBL,eACjB;;EACb,gBAA8B,IAAAM,eAAA,EAAS,IAAT,CAA9B;EAAA;EAAA,IAAOC,OAAP;EAAA,IAAgBC,UAAhB;;EACA,iBAA0B,IAAAF,eAAA,EAAS,KAAT,CAA1B;EAAA;EAAA,IAAOG,KAAP;EAAA,IAAcC,QAAd;;EACA,iBAAwB,IAAAJ,eAAA,EAAkC,IAAlC,CAAxB;EAAA;EAAA,IAAOK,IAAP;EAAA,IAAaC,OAAb;;EACA,IAAMC,YAAY,GAAG,IAAAC,aAAA,EAA0B,IAA1B,CAArB;EAEA,IAAAC,gBAAA,EAAU,MAAM;IACd,IAAIZ,KAAJ,EAAW;MACTU,YAAY,CAACG,OAAb,GAAuBC,iBAAA,CACpBC,WADoB,CACRf,KADQ,EACDC,MADC,EACOC,OADP,EAEpBc,IAFoB,CAGnB,IAAAC,+BAAA,EAAqBC,yBAArB,CAHmB,EAInB,IAAAC,qBAAA,EAAYC,GAAD,IAAS;QAClBC,OAAO,CAACf,KAAR,CAAcc,GAAd;QACAb,QAAQ,CAACa,GAAD,CAAR;QACAf,UAAU,CAAC,KAAD,CAAV;QACAI,OAAO,CAAC,IAAD,CAAP;QAEA,OAAOW,GAAP;MACD,CAPD,CAJmB,EAapBE,SAboB,CAaTC,SAAD,IAAiC;QAC1Cd,OAAO,CAAEI,OAAD,IAAc,IAAAK,yBAAA,EAAQL,OAAR,EAAiBU,SAAjB,IAA8BV,OAA9B,GAAwCU,SAAvD,CAAP;QACAlB,UAAU,CAAC,KAAD,CAAV;QACAE,QAAQ,CAAC,KAAD,CAAR;MACD,CAjBoB,CAAvB;IAkBD;;IAED,OAAO,MAAM;MACX,OAAOG,YAAY,CAACG,OAAb,GAAuBH,YAAY,CAACG,OAAb,CAAqBW,WAArB,EAAvB,GAA4DC,SAAnE;IACD,CAFD;EAGD,CAzBD,EAyBG,CAACzB,KAAD,EAAQC,MAAR,EAAgBC,OAAhB,CAzBH;EA2BA,OAAO;IAACE,OAAD;IAAUE,KAAV;IAAiBE;EAAjB,CAAP;AACD"}

package/lib/parts.d.js

@@ -0,0 +1,2 @@
+"use strict";
+//# sourceMappingURL=parts.d.js.map

package/lib/parts.d.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parts.d.js","names":[],"sources":["../src/parts.d.ts"],"sourcesContent":["// Tells Typescript to skip typechecking imported parts\ndeclare module \"part:@sanity/*\";\n"],"mappings":""}

package/lib/resolveParams.js.map

@@ -1 +1 @@
-{"version":3,"file":"resolveParams.js","names":["defaultResolver","options","params","document","useDraft","doc","displayed","published","Object","keys","reduce","acc","key","delve","resolveParams","resolvedParams","values","includes","undefined"],"sources":["../src/resolveParams.ts"],"sourcesContent":["import {DocumentsPaneQueryParams, DocumentVersionsCollection} from './types'\nimport delve from 'dlv'\n\ninterface ResolveParamsOptions {\n  params?: DocumentsPaneQueryParams\n  document: DocumentVersionsCollection\n  useDraft: boolean\n}\n\ntype ResolveParamsReturn = undefined | {[key: string]: string}\n\nfunction defaultResolver(options: ResolveParamsOptions): {[key: string]: string | undefined} {\n  const {params, document, useDraft} = options\n\n  // params is optional\n  if (!params) return {}\n\n  // legacy useDraft behaviour\n  const doc = useDraft ? document.displayed : document.published\n\n  return Object.keys(params).reduce((acc, key) => ({...acc, [key]: delve(doc, params[key])}), {})\n}\n\nexport default function resolveParams(options: ResolveParamsOptions): ResolveParamsReturn {\n  const {params, document} = options\n\n  const resolvedParams = typeof params == 'function' ? params({document}) : defaultResolver(options)\n\n  // if any of the parameters are undefined, the query will error\n  // so return undefined so the UI can show a more appropriate message\n  if (Object.values(resolvedParams).includes(undefined)) return undefined\n\n  // Typescript can't tell that we've guarded against any value being undefined,\n  // so forcing the type\n  return resolvedParams as {[key: string]: string}\n}\n"],"mappings":";;;;;;;AACA;;;;;;;;;;AAUA,SAASA,eAAT,CAAyBC,OAAzB,EAA6F;EAC3F,IAAOC,MAAP,GAAqCD,OAArC,CAAOC,MAAP;EAAA,IAAeC,QAAf,GAAqCF,OAArC,CAAeE,QAAf;EAAA,IAAyBC,QAAzB,GAAqCH,OAArC,CAAyBG,QAAzB,CAD2F,CAG3F;;EACA,IAAI,CAACF,MAAL,EAAa,OAAO,EAAP,CAJ8E,CAM3F;;EACA,IAAMG,GAAG,GAAGD,QAAQ,GAAGD,QAAQ,CAACG,SAAZ,GAAwBH,QAAQ,CAACI,SAArD;EAEA,OAAOC,MAAM,CAACC,IAAP,CAAYP,MAAZ,EAAoBQ,MAApB,CAA2B,CAACC,GAAD,EAAMC,GAAN,qCAAmBD,GAAnB;IAAwB,CAACC,GAAD,GAAO,IAAAC,YAAA,EAAMR,GAAN,EAAWH,MAAM,CAACU,GAAD,CAAjB;EAA/B,EAA3B,EAAqF,EAArF,CAAP;AACD;;AAEc,SAASE,aAAT,CAAuBb,OAAvB,EAA2E;EACxF,IAAOC,MAAP,GAA2BD,OAA3B,CAAOC,MAAP;EAAA,IAAeC,QAAf,GAA2BF,OAA3B,CAAeE,QAAf;EAEA,IAAMY,cAAc,GAAG,OAAOb,MAAP,IAAiB,UAAjB,GAA8BA,MAAM,CAAC;IAACC;EAAD,CAAD,CAApC,GAAmDH,eAAe,CAACC,OAAD,CAAzF,CAHwF,CAKxF;EACA;;EACA,IAAIO,MAAM,CAACQ,MAAP,CAAcD,cAAd,EAA8BE,QAA9B,CAAuCC,SAAvC,CAAJ,EAAuD,OAAOA,SAAP,CAPiC,CASxF;EACA;;EACA,OAAOH,cAAP;AACD"}
+{"version":3,"file":"resolveParams.js","names":["defaultResolver","options","params","document","useDraft","doc","displayed","published","Object","keys","reduce","acc","key","delve","resolveParams","resolvedParams","values","includes","undefined"],"sources":["../src/resolveParams.ts"],"sourcesContent":["import {DocumentsPaneQueryParams, DocumentVersionsCollection} from './types'\nimport delve from 'dlv'\n\ninterface ResolveParamsOptions {\n  params?: DocumentsPaneQueryParams\n  document: DocumentVersionsCollection\n  useDraft: boolean\n}\n\ntype ResolveParamsReturn = undefined | {[key: string]: string}\n\nfunction defaultResolver(options: ResolveParamsOptions): {\n  [key: string]: string | undefined\n} {\n  const {params, document, useDraft} = options\n\n  // params is optional\n  if (!params) return {}\n\n  // legacy useDraft behaviour\n  const doc = useDraft ? document.displayed : document.published\n\n  return Object.keys(params).reduce(\n    (acc, key) => ({\n      ...acc,\n      [key]: delve(doc, params[key as keyof DocumentsPaneQueryParams]),\n    }),\n    {}\n  )\n}\n\nexport default function resolveParams(options: ResolveParamsOptions): ResolveParamsReturn {\n  const {params, document} = options\n\n  const resolvedParams = typeof params == 'function' ? params({document}) : defaultResolver(options)\n\n  // if any of the parameters are undefined, the query will error\n  // so return undefined so the UI can show a more appropriate message\n  if (Object.values(resolvedParams).includes(undefined)) return undefined\n\n  // Typescript can't tell that we've guarded against any value being undefined,\n  // so forcing the type\n  return resolvedParams as {[key: string]: string}\n}\n"],"mappings":";;;;;;;AACA;;;;;;;;;;AAUA,SAASA,eAAT,CAAyBC,OAAzB,EAEE;EACA,IAAOC,MAAP,GAAqCD,OAArC,CAAOC,MAAP;EAAA,IAAeC,QAAf,GAAqCF,OAArC,CAAeE,QAAf;EAAA,IAAyBC,QAAzB,GAAqCH,OAArC,CAAyBG,QAAzB,CADA,CAGA;;EACA,IAAI,CAACF,MAAL,EAAa,OAAO,EAAP,CAJb,CAMA;;EACA,IAAMG,GAAG,GAAGD,QAAQ,GAAGD,QAAQ,CAACG,SAAZ,GAAwBH,QAAQ,CAACI,SAArD;EAEA,OAAOC,MAAM,CAACC,IAAP,CAAYP,MAAZ,EAAoBQ,MAApB,CACL,CAACC,GAAD,EAAMC,GAAN,qCACKD,GADL;IAEE,CAACC,GAAD,GAAO,IAAAC,YAAA,EAAMR,GAAN,EAAWH,MAAM,CAACU,GAAD,CAAjB;EAFT,EADK,EAKL,EALK,CAAP;AAOD;;AAEc,SAASE,aAAT,CAAuBb,OAAvB,EAA2E;EACxF,IAAOC,MAAP,GAA2BD,OAA3B,CAAOC,MAAP;EAAA,IAAeC,QAAf,GAA2BF,OAA3B,CAAeE,QAAf;EAEA,IAAMY,cAAc,GAAG,OAAOb,MAAP,IAAiB,UAAjB,GAA8BA,MAAM,CAAC;IAACC;EAAD,CAAD,CAApC,GAAmDH,eAAe,CAACC,OAAD,CAAzF,CAHwF,CAKxF;EACA;;EACA,IAAIO,MAAM,CAACQ,MAAP,CAAcD,cAAd,EAA8BE,QAA9B,CAAuCC,SAAvC,CAAJ,EAAuD,OAAOA,SAAP,CAPiC,CASxF;EACA;;EACA,OAAOH,cAAP;AACD"}

package/lint-staged.config.js

@@ -0,0 +1,4 @@
+module.exports = {
+  '**/*.{js,jsx}': ['eslint'],
+  '**/*.{ts,tsx}': ['eslint', () => 'tsc --noEmit'],
+}

package/package.json

@@ -1,17 +1,15 @@
 {
   "name": "sanity-plugin-documents-pane",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "Displays the results of a GROQ query in a View Pane",
   "main": "lib/index.js",
   "scripts": {
     "build": "sanipack build",
     "verify": "sanipack verify",
     "watch": "sanipack build --watch",
-    "_postinstall": "husky install",
-    "prepublishOnly": "pinst --disable && sanipack build && sanipack verify",
-    "postpublish": "pinst --enable",
     "lint": "eslint .",
-    "lint:fix": "eslint . --fix"
+    "prepublishOnly": "npm run compile && npm run build",
+    "compile": "tsc --noEmit"
   },
   "husky": {
     "hooks": {
@@ -38,20 +36,34 @@
   "peerDependencies": {
     "@sanity/base": "^2.30.1",
     "@sanity/desk-tool": "^2.30.1",
-    "@sanity/uuid": "^3.0.1",
     "@sanity/util": "^2.29.5",
+    "@sanity/uuid": "^3.0.1",
     "react": "^16.0.0 || ^17.0.0"
   },
   "devDependencies": {
-    "@sanity/eslint-config-studio": "^2.0.0",
-    "eslint": "8.19.0",
+    "@commitlint/cli": "^17.1.2",
+    "@commitlint/config-conventional": "^17.1.0",
+    "@sanity/base": "^2.30.1",
+    "@sanity/desk-tool": "^2.30.1",
+    "@sanity/semantic-release-preset": "^2.0.1",
+    "@sanity/types": "^2.34.0",
+    "@sanity/util": "^2.29.5",
+    "@sanity/uuid": "^3.0.1",
+    "@types/dlv": "^1.1.2",
+    "@types/react": "^17.0.0",
+    "@types/react-dom": "^17.0.0",
+    "@typescript-eslint/eslint-plugin": "^5.38.1",
+    "@typescript-eslint/parser": "^5.38.1",
+    "eslint": "^8.24.0",
     "eslint-config-prettier": "^8.5.0",
-    "eslint-config-sanity": "6.0.0",
+    "eslint-config-sanity": "^6.0.0",
     "eslint-plugin-prettier": "^4.2.1",
-    "eslint-plugin-react": "^7.30.1",
     "husky": "^8.0.1",
+    "lint-staged": "^13.0.3",
     "pinst": "^3.0.0",
     "prettier": "^2.7.1",
+    "react": "^17.0.0",
+    "react-dom": "^17.0.2",
     "sanipack": "^2.1.0",
     "typescript": "^4.7.4"
   },

package/renovate.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "github>sanity-io/renovate-presets//ecosystem/auto",
+    "github>sanity-io/renovate-presets//ecosystem/studio-v3"
+  ]
+}

package/src/NewDocument.tsx

@@ -3,7 +3,7 @@ import React from 'react'
 import {DocumentsPaneInitialValueTemplate} from './types'
 import {ComposeIcon} from '@sanity/icons'
 import {usePaneRouter} from '@sanity/desk-tool'
-import {uuid} from "@sanity/uuid"
+import {uuid} from '@sanity/uuid'
 
 interface NewDocumentProps {
   initialValueTemplates: DocumentsPaneInitialValueTemplate[]
@@ -19,6 +19,9 @@ export default function NewDocument(props: NewDocumentProps) {
     <Card borderBottom={true} padding={2}>
       <Flex justify="flex-end" gap={1}>
         {initialValueTemplates.map((template) => {
+          if (!template.template) {
+            return null
+          }
           return (
             <ReferenceChildLink
               documentId={uuid()}
@@ -26,7 +29,6 @@ export default function NewDocument(props: NewDocumentProps) {
               template={{id: template.template, params: template.parameters}}
               parentRefPath={[]}
               key={`${template.schemaType}-${template.template}`}
-              style={{textDecoration: 'none'}}
             >
               <Button icon={<ComposeIcon />} text={template.title} mode="bleed" as="span" />
             </ReferenceChildLink>

package/src/hooks/useListeningQuery.ts

@@ -1,4 +1,5 @@
-import React, {useEffect, useState, useRef} from 'react'
+import type {SanityDocument} from '@sanity/types'
+import {useEffect, useState, useRef} from 'react'
 import documentStore from 'part:@sanity/base/datastore/document'
 import {catchError, distinctUntilChanged} from 'rxjs/operators'
 import isEqual from 'react-fast-compare'
@@ -13,7 +14,7 @@ interface ListenQueryOptions {
 type ReturnShape = {
   loading: boolean
   error: boolean
-  data: any
+  data: SanityDocument[] | null
 }
 
 type Observable = {
@@ -30,7 +31,7 @@ export default function useListeningQuery(
 ): ReturnShape {
   const [loading, setLoading] = useState(true)
   const [error, setError] = useState(false)
-  const [data, setData] = useState(null)
+  const [data, setData] = useState<SanityDocument[] | null>(null)
   const subscription = useRef<null | Observable>(null)
 
   useEffect(() => {
@@ -48,7 +49,7 @@ export default function useListeningQuery(
             return err
           })
         )
-        .subscribe((documents) => {
+        .subscribe((documents: SanityDocument[]) => {
           setData((current) => (isEqual(current, documents) ? current : documents))
           setLoading(false)
           setError(false)

package/src/parts.d.ts

@@ -0,0 +1,2 @@
+// Tells Typescript to skip typechecking imported parts
+declare module "part:@sanity/*";

package/src/resolveParams.ts

@@ -9,7 +9,9 @@ interface ResolveParamsOptions {
 
 type ResolveParamsReturn = undefined | {[key: string]: string}
 
-function defaultResolver(options: ResolveParamsOptions): {[key: string]: string | undefined} {
+function defaultResolver(options: ResolveParamsOptions): {
+  [key: string]: string | undefined
+} {
   const {params, document, useDraft} = options
 
   // params is optional
@@ -18,7 +20,13 @@ function defaultResolver(options: ResolveParamsOptions): {[key: string]: string
   // legacy useDraft behaviour
   const doc = useDraft ? document.displayed : document.published
 
-  return Object.keys(params).reduce((acc, key) => ({...acc, [key]: delve(doc, params[key])}), {})
+  return Object.keys(params).reduce(
+    (acc, key) => ({
+      ...acc,
+      [key]: delve(doc, params[key as keyof DocumentsPaneQueryParams]),
+    }),
+    {}
+  )
 }
 
 export default function resolveParams(options: ResolveParamsOptions): ResolveParamsReturn {

package/tsconfig.json

@@ -0,0 +1,21 @@
+{
+  "compilerOptions": {
+    "jsx": "react",
+    "moduleResolution": "node",
+    "target": "es5",
+    "esModuleInterop": true,
+    "module": "es2015",
+    "lib": ["es2015", "es2016", "es2017", "dom"],
+    "strict": true,
+    "skipLibCheck": true,
+    "sourceMap": true,
+    "declaration": true,
+    "allowSyntheticDefaultImports": true,
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+    "outDir": "lib",
+    "typeRoots": ["node_modules/@types"],
+    "baseUrl": "."
+  },
+  "include": ["src/**/*"]
+}