sanity-plugin-documents-pane 1.0.9 → 1.1.0

package/README.md

@@ -12,7 +12,7 @@ sanity install 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).
 
-The example below illustrates using the current Document being used to query for all Documents that reference it.
+The example below illustrates using the current Document being used to query for all published documents that reference it.
 
 ```js
 // ./src/deskStructure.js
@@ -25,18 +25,64 @@ S.view
   .options({
     query: `*[!(_id in path("drafts.**")) && references($id)]`,
     params: {id: `_id`},
-    useDraft: false,
-    debug: true,
   })
   .title('Incoming References')
 ```
 
 The `.options()` configuration works as follows:
 
-- `query` (string, required)
-- `params` (object, optional) A [dot-notated string](https://www.npmjs.com/package/dlv) from the document object to a field, to use as variables in the query.
-- `useDraft` (bool, optional, default: `false`) When populating the `params` values, it will use the `published` version of the document by default.
+- `query` (string, required) A string defining the entire GROQ query that will select documents to list.
+- `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]`,
+  params: ({document}) => {
+    // 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, 
+    // 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, 
+    // be sure it doesn't start with `drafts.`
+    const id = document?.displayed?._id.replace('drafts.', '')
+    const name = document?.displayed?.name || 'author'
+
+    if (id) {
+      templates.push({
+        // the name of the schema type that should be created (required)
+        schemaType: 'post',
+        // the title that should appear on the button - we can customize it (required)
+        title: `New post by ${name}`,
+        // the name of the template that should be used (optional)
+        template: 'postWithAuthor',
+        // values for parameters that can be passed to the template referenced above (optional)
+        parameters: {
+          authorId: id,
+        },
+      })
+
+      // we could push more templates if needed.
+    }
+
+    // must always return a list, even if empty
+    return templates
+  },
+}
+```
 
 ## Thanks!
 

package/lib/Debug.js

@@ -16,7 +16,7 @@ function Debug(_ref) {
       params = _ref.params;
   return /*#__PURE__*/_react.default.createElement(_react.default.Fragment, null, /*#__PURE__*/_react.default.createElement(_ui.Stack, {
     space: 4
-  }, /*#__PURE__*/_react.default.createElement(_ui.Box, null, /*#__PURE__*/_react.default.createElement(_ui.Label, null, "Query")), /*#__PURE__*/_react.default.createElement(_ui.Box, null, /*#__PURE__*/_react.default.createElement(_ui.Code, null, query))), /*#__PURE__*/_react.default.createElement(_ui.Stack, {
+  }, /*#__PURE__*/_react.default.createElement(_ui.Box, null, /*#__PURE__*/_react.default.createElement(_ui.Label, null, "Query")), /*#__PURE__*/_react.default.createElement(_ui.Box, null, /*#__PURE__*/_react.default.createElement(_ui.Code, null, query))), params && /*#__PURE__*/_react.default.createElement(_ui.Stack, {
     space: 4
   }, /*#__PURE__*/_react.default.createElement(_ui.Box, null, /*#__PURE__*/_react.default.createElement(_ui.Label, null, "Params")), /*#__PURE__*/_react.default.createElement(_ui.Box, null, /*#__PURE__*/_react.default.createElement(_ui.Code, null, JSON.stringify(params)))));
 }

package/lib/Debug.js.map

@@ -1 +1 @@
-{"version":3,"file":"Debug.js","names":["Debug","query","params","JSON","stringify"],"sources":["../src/Debug.tsx"],"sourcesContent":["import React from 'react'\nimport {Code, Box, Label, Stack} from '@sanity/ui'\n\nexport default function Debug({query, params}: {query: string; params: {[key: string]: string}}) {\n  return (\n    <>\n      <Stack space={4}>\n        <Box>\n          <Label>Query</Label>\n        </Box>\n        <Box>\n          <Code>{query}</Code>\n        </Box>\n      </Stack>\n      <Stack space={4}>\n        <Box>\n          <Label>Params</Label>\n        </Box>\n        <Box>\n          <Code>{JSON.stringify(params)}</Code>\n        </Box>\n      </Stack>\n    </>\n  )\n}\n"],"mappings":";;;;;;;AAAA;;AACA;;;;AAEe,SAASA,KAAT,OAAkF;EAAA,IAAlEC,KAAkE,QAAlEA,KAAkE;EAAA,IAA3DC,MAA2D,QAA3DA,MAA2D;EAC/F,oBACE,yEACE,6BAAC,SAAD;IAAO,KAAK,EAAE;EAAd,gBACE,6BAAC,OAAD,qBACE,6BAAC,SAAD,gBADF,CADF,eAIE,6BAAC,OAAD,qBACE,6BAAC,QAAD,QAAOD,KAAP,CADF,CAJF,CADF,eASE,6BAAC,SAAD;IAAO,KAAK,EAAE;EAAd,gBACE,6BAAC,OAAD,qBACE,6BAAC,SAAD,iBADF,CADF,eAIE,6BAAC,OAAD,qBACE,6BAAC,QAAD,QAAOE,IAAI,CAACC,SAAL,CAAeF,MAAf,CAAP,CADF,CAJF,CATF,CADF;AAoBD"}
+{"version":3,"file":"Debug.js","names":["Debug","query","params","JSON","stringify"],"sources":["../src/Debug.tsx"],"sourcesContent":["import React from 'react'\nimport {Code, Box, Label, Stack} from '@sanity/ui'\n\nexport default function Debug({query, params}: {query: string; params?: {[key: string]: string}}) {\n  return (\n    <>\n      <Stack space={4}>\n        <Box>\n          <Label>Query</Label>\n        </Box>\n        <Box>\n          <Code>{query}</Code>\n        </Box>\n      </Stack>\n      {params && (\n        <Stack space={4}>\n          <Box>\n            <Label>Params</Label>\n          </Box>\n          <Box>\n            <Code>{JSON.stringify(params)}</Code>\n          </Box>\n        </Stack>\n      )}\n    </>\n  )\n}\n"],"mappings":";;;;;;;AAAA;;AACA;;;;AAEe,SAASA,KAAT,OAAmF;EAAA,IAAnEC,KAAmE,QAAnEA,KAAmE;EAAA,IAA5DC,MAA4D,QAA5DA,MAA4D;EAChG,oBACE,yEACE,6BAAC,SAAD;IAAO,KAAK,EAAE;EAAd,gBACE,6BAAC,OAAD,qBACE,6BAAC,SAAD,gBADF,CADF,eAIE,6BAAC,OAAD,qBACE,6BAAC,QAAD,QAAOD,KAAP,CADF,CAJF,CADF,EASGC,MAAM,iBACL,6BAAC,SAAD;IAAO,KAAK,EAAE;EAAd,gBACE,6BAAC,OAAD,qBACE,6BAAC,SAAD,iBADF,CADF,eAIE,6BAAC,OAAD,qBACE,6BAAC,QAAD,QAAOC,IAAI,CAACC,SAAL,CAAeF,MAAf,CAAP,CADF,CAJF,CAVJ,CADF;AAsBD"}

package/lib/Documents.js

@@ -23,6 +23,8 @@ var _Feedback = _interopRequireDefault(require("./Feedback"));
 
 var _useListeningQuery2 = _interopRequireDefault(require("./hooks/useListeningQuery"));
 
+var _NewDocument = _interopRequireDefault(require("./NewDocument"));
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
@@ -32,7 +34,8 @@ function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj &&
 function Documents(props) {
   var query = props.query,
       params = props.params,
-      debug = props.debug;
+      debug = props.debug,
+      initialValueTemplates = props.initialValueTemplates;
 
   var _usePaneRouter = (0, _deskTool.usePaneRouter)(),
       routerPanesState = _usePaneRouter.routerPanesState,
@@ -81,16 +84,20 @@ function Documents(props) {
   }
 
   if (!(data !== null && data !== void 0 && data.length)) {
-    return /*#__PURE__*/_react.default.createElement(_ui.Stack, {
+    return /*#__PURE__*/_react.default.createElement(_react.default.Fragment, null, /*#__PURE__*/_react.default.createElement(_NewDocument.default, {
+      initialValueTemplates: initialValueTemplates
+    }), /*#__PURE__*/_react.default.createElement(_ui.Stack, {
       padding: 4,
       space: 5
     }, /*#__PURE__*/_react.default.createElement(_Feedback.default, null, "No Documents found"), debug && /*#__PURE__*/_react.default.createElement(_Debug.default, {
       query: query,
       params: params
-    }));
+    })));
   }
 
-  return /*#__PURE__*/_react.default.createElement(_ui.Stack, {
+  return /*#__PURE__*/_react.default.createElement(_react.default.Fragment, null, /*#__PURE__*/_react.default.createElement(_NewDocument.default, {
+    initialValueTemplates: initialValueTemplates
+  }), /*#__PURE__*/_react.default.createElement(_ui.Stack, {
     padding: 2,
     space: 1
   }, data.map(doc => /*#__PURE__*/_react.default.createElement(_ui.Button, {
@@ -101,6 +108,6 @@ function Documents(props) {
   }, /*#__PURE__*/_react.default.createElement(_preview.default, {
     value: doc,
     type: _schema.default.get(doc._type)
-  }))));
+  })))));
 }
 //# sourceMappingURL=Documents.js.map

package/lib/Documents.js.map

@@ -1 +1 @@
-{"version":3,"file":"Documents.js","names":["Documents","props","query","params","debug","usePaneRouter","routerPanesState","groupIndex","handleEditReference","useListeningQuery","loading","error","data","handleClick","useCallback","id","type","childParams","parentRefPath","pathFromString","template","length","map","doc","_id","_type","schema","get"],"sources":["../src/Documents.tsx"],"sourcesContent":["import React, {useCallback} from 'react'\nimport {Box, Button, Stack, Flex, Spinner} from '@sanity/ui'\nimport {fromString as pathFromString} from '@sanity/util/paths'\nimport {usePaneRouter} from '@sanity/desk-tool'\nimport Preview from 'part:@sanity/base/preview'\nimport schema from 'part:@sanity/base/schema'\n\nimport Debug from './Debug'\nimport Feedback from './Feedback'\nimport useListeningQuery from './hooks/useListeningQuery'\n\ntype DocumentsProps = {\n  query: string\n  params: {[key: string]: string}\n  debug: boolean\n}\n\nexport default function Documents(props: DocumentsProps) {\n  const {query, params, debug} = props\n  const {routerPanesState, groupIndex, handleEditReference} = usePaneRouter()\n\n  const {loading, error, data} = useListeningQuery(query, params)\n\n  const handleClick = useCallback(\n    (id, type) => {\n      const childParams = routerPanesState[groupIndex + 1]?.[0].params || {}\n      const {parentRefPath} = childParams\n\n      handleEditReference({\n        id,\n        type,\n        // Uncertain that this works as intended\n        parentRefPath: parentRefPath ? pathFromString(parentRefPath) : [``],\n        // Added this to satisfy TS\n        template: type,\n      })\n    },\n    [routerPanesState, groupIndex, handleEditReference]\n  )\n\n  if (loading) {\n    return (\n      <Box padding={4}>\n        <Flex justify=\"center\" align=\"center\">\n          <Spinner muted />\n        </Flex>\n      </Box>\n    )\n  }\n\n  if (error) {\n    return (\n      <Stack padding={4} space={5}>\n        <Feedback>There was en error performing this query</Feedback>\n        {debug && <Debug query={query} params={params} />}\n      </Stack>\n    )\n  }\n\n  if (!data?.length) {\n    return (\n      <Stack padding={4} space={5}>\n        <Feedback>No Documents found</Feedback>\n        {debug && <Debug query={query} params={params} />}\n      </Stack>\n    )\n  }\n\n  return (\n    <Stack padding={2} space={1}>\n      {data.map((doc) => (\n        <Button\n          key={doc._id}\n          onClick={() => handleClick(doc._id, doc._type)}\n          padding={2}\n          mode=\"bleed\"\n        >\n          <Preview value={doc} type={schema.get(doc._type)} />\n        </Button>\n      ))}\n    </Stack>\n  )\n}\n"],"mappings":";;;;;;;AAAA;;AACA;;AACA;;AACA;;AACA;;AACA;;AAEA;;AACA;;AACA;;;;;;;;AAQe,SAASA,SAAT,CAAmBC,KAAnB,EAA0C;EACvD,IAAOC,KAAP,GAA+BD,KAA/B,CAAOC,KAAP;EAAA,IAAcC,MAAd,GAA+BF,KAA/B,CAAcE,MAAd;EAAA,IAAsBC,KAAtB,GAA+BH,KAA/B,CAAsBG,KAAtB;;EACA,qBAA4D,IAAAC,uBAAA,GAA5D;EAAA,IAAOC,gBAAP,kBAAOA,gBAAP;EAAA,IAAyBC,UAAzB,kBAAyBA,UAAzB;EAAA,IAAqCC,mBAArC,kBAAqCA,mBAArC;;EAEA,yBAA+B,IAAAC,2BAAA,EAAkBP,KAAlB,EAAyBC,MAAzB,CAA/B;EAAA,IAAOO,OAAP,sBAAOA,OAAP;EAAA,IAAgBC,KAAhB,sBAAgBA,KAAhB;EAAA,IAAuBC,IAAvB,sBAAuBA,IAAvB;;EAEA,IAAMC,WAAW,GAAG,IAAAC,kBAAA,EAClB,CAACC,EAAD,EAAKC,IAAL,KAAc;IAAA;;IACZ,IAAMC,WAAW,GAAG,sBAAAX,gBAAgB,CAACC,UAAU,GAAG,CAAd,CAAhB,wEAAmC,CAAnC,EAAsCJ,MAAtC,KAAgD,EAApE;IACA,IAAOe,aAAP,GAAwBD,WAAxB,CAAOC,aAAP;IAEAV,mBAAmB,CAAC;MAClBO,EADkB;MAElBC,IAFkB;MAGlB;MACAE,aAAa,EAAEA,aAAa,GAAG,IAAAC,iBAAA,EAAeD,aAAf,CAAH,GAAmC,IAJ7C;MAKlB;MACAE,QAAQ,EAAEJ;IANQ,CAAD,CAAnB;EAQD,CAbiB,EAclB,CAACV,gBAAD,EAAmBC,UAAnB,EAA+BC,mBAA/B,CAdkB,CAApB;;EAiBA,IAAIE,OAAJ,EAAa;IACX,oBACE,6BAAC,OAAD;MAAK,OAAO,EAAE;IAAd,gBACE,6BAAC,QAAD;MAAM,OAAO,EAAC,QAAd;MAAuB,KAAK,EAAC;IAA7B,gBACE,6BAAC,WAAD;MAAS,KAAK;IAAd,EADF,CADF,CADF;EAOD;;EAED,IAAIC,KAAJ,EAAW;IACT,oBACE,6BAAC,SAAD;MAAO,OAAO,EAAE,CAAhB;MAAmB,KAAK,EAAE;IAA1B,gBACE,6BAAC,iBAAD,mDADF,EAEGP,KAAK,iBAAI,6BAAC,cAAD;MAAO,KAAK,EAAEF,KAAd;MAAqB,MAAM,EAAEC;IAA7B,EAFZ,CADF;EAMD;;EAED,IAAI,EAACS,IAAD,aAACA,IAAD,eAACA,IAAI,CAAES,MAAP,CAAJ,EAAmB;IACjB,oBACE,6BAAC,SAAD;MAAO,OAAO,EAAE,CAAhB;MAAmB,KAAK,EAAE;IAA1B,gBACE,6BAAC,iBAAD,6BADF,EAEGjB,KAAK,iBAAI,6BAAC,cAAD;MAAO,KAAK,EAAEF,KAAd;MAAqB,MAAM,EAAEC;IAA7B,EAFZ,CADF;EAMD;;EAED,oBACE,6BAAC,SAAD;IAAO,OAAO,EAAE,CAAhB;IAAmB,KAAK,EAAE;EAA1B,GACGS,IAAI,CAACU,GAAL,CAAUC,GAAD,iBACR,6BAAC,UAAD;IACE,GAAG,EAAEA,GAAG,CAACC,GADX;IAEE,OAAO,EAAE,MAAMX,WAAW,CAACU,GAAG,CAACC,GAAL,EAAUD,GAAG,CAACE,KAAd,CAF5B;IAGE,OAAO,EAAE,CAHX;IAIE,IAAI,EAAC;EAJP,gBAME,6BAAC,gBAAD;IAAS,KAAK,EAAEF,GAAhB;IAAqB,IAAI,EAAEG,eAAA,CAAOC,GAAP,CAAWJ,GAAG,CAACE,KAAf;EAA3B,EANF,CADD,CADH,CADF;AAcD"}
+{"version":3,"file":"Documents.js","names":["Documents","props","query","params","debug","initialValueTemplates","usePaneRouter","routerPanesState","groupIndex","handleEditReference","useListeningQuery","loading","error","data","handleClick","useCallback","id","type","childParams","parentRefPath","pathFromString","template","length","map","doc","_id","_type","schema","get"],"sources":["../src/Documents.tsx"],"sourcesContent":["import React, {useCallback} from 'react'\nimport {Box, Button, Stack, Flex, Spinner} from '@sanity/ui'\nimport {fromString as pathFromString} from '@sanity/util/paths'\nimport {usePaneRouter} from '@sanity/desk-tool'\nimport Preview from 'part:@sanity/base/preview'\nimport schema from 'part:@sanity/base/schema'\n\nimport Debug from './Debug'\nimport Feedback from './Feedback'\nimport useListeningQuery from './hooks/useListeningQuery'\nimport {DocumentsPaneInitialValueTemplate} from './types'\nimport NewDocument from './NewDocument'\n\ntype DocumentsProps = {\n  query: string\n  params: {[key: string]: string}\n  debug: boolean\n  initialValueTemplates: DocumentsPaneInitialValueTemplate[]\n}\n\nexport default function Documents(props: DocumentsProps) {\n  const {query, params, debug, initialValueTemplates} = props\n  const {routerPanesState, groupIndex, handleEditReference} = usePaneRouter()\n\n  const {loading, error, data} = useListeningQuery(query, params)\n\n  const handleClick = useCallback(\n    (id, type) => {\n      const childParams = routerPanesState[groupIndex + 1]?.[0].params || {}\n      const {parentRefPath} = childParams\n\n      handleEditReference({\n        id,\n        type,\n        // Uncertain that this works as intended\n        parentRefPath: parentRefPath ? pathFromString(parentRefPath) : [``],\n        // Added this to satisfy TS\n        template: type,\n      })\n    },\n    [routerPanesState, groupIndex, handleEditReference]\n  )\n\n  if (loading) {\n    return (\n      <Box padding={4}>\n        <Flex justify=\"center\" align=\"center\">\n          <Spinner muted />\n        </Flex>\n      </Box>\n    )\n  }\n\n  if (error) {\n    return (\n      <Stack padding={4} space={5}>\n        <Feedback>There was en error performing this query</Feedback>\n        {debug && <Debug query={query} params={params} />}\n      </Stack>\n    )\n  }\n\n  if (!data?.length) {\n    return (\n      <>\n        <NewDocument initialValueTemplates={initialValueTemplates} />\n        <Stack padding={4} space={5}>\n          <Feedback>No Documents found</Feedback>\n          {debug && <Debug query={query} params={params} />}\n        </Stack>\n      </>\n    )\n  }\n\n  return (\n    <>\n      <NewDocument initialValueTemplates={initialValueTemplates} />\n      <Stack padding={2} space={1}>\n        {data.map((doc) => (\n          <Button\n            key={doc._id}\n            onClick={() => handleClick(doc._id, doc._type)}\n            padding={2}\n            mode=\"bleed\"\n          >\n            <Preview value={doc} type={schema.get(doc._type)} />\n          </Button>\n        ))}\n      </Stack>\n    </>\n  )\n}\n"],"mappings":";;;;;;;AAAA;;AACA;;AACA;;AACA;;AACA;;AACA;;AAEA;;AACA;;AACA;;AAEA;;;;;;;;AASe,SAASA,SAAT,CAAmBC,KAAnB,EAA0C;EACvD,IAAOC,KAAP,GAAsDD,KAAtD,CAAOC,KAAP;EAAA,IAAcC,MAAd,GAAsDF,KAAtD,CAAcE,MAAd;EAAA,IAAsBC,KAAtB,GAAsDH,KAAtD,CAAsBG,KAAtB;EAAA,IAA6BC,qBAA7B,GAAsDJ,KAAtD,CAA6BI,qBAA7B;;EACA,qBAA4D,IAAAC,uBAAA,GAA5D;EAAA,IAAOC,gBAAP,kBAAOA,gBAAP;EAAA,IAAyBC,UAAzB,kBAAyBA,UAAzB;EAAA,IAAqCC,mBAArC,kBAAqCA,mBAArC;;EAEA,yBAA+B,IAAAC,2BAAA,EAAkBR,KAAlB,EAAyBC,MAAzB,CAA/B;EAAA,IAAOQ,OAAP,sBAAOA,OAAP;EAAA,IAAgBC,KAAhB,sBAAgBA,KAAhB;EAAA,IAAuBC,IAAvB,sBAAuBA,IAAvB;;EAEA,IAAMC,WAAW,GAAG,IAAAC,kBAAA,EAClB,CAACC,EAAD,EAAKC,IAAL,KAAc;IAAA;;IACZ,IAAMC,WAAW,GAAG,sBAAAX,gBAAgB,CAACC,UAAU,GAAG,CAAd,CAAhB,wEAAmC,CAAnC,EAAsCL,MAAtC,KAAgD,EAApE;IACA,IAAOgB,aAAP,GAAwBD,WAAxB,CAAOC,aAAP;IAEAV,mBAAmB,CAAC;MAClBO,EADkB;MAElBC,IAFkB;MAGlB;MACAE,aAAa,EAAEA,aAAa,GAAG,IAAAC,iBAAA,EAAeD,aAAf,CAAH,GAAmC,IAJ7C;MAKlB;MACAE,QAAQ,EAAEJ;IANQ,CAAD,CAAnB;EAQD,CAbiB,EAclB,CAACV,gBAAD,EAAmBC,UAAnB,EAA+BC,mBAA/B,CAdkB,CAApB;;EAiBA,IAAIE,OAAJ,EAAa;IACX,oBACE,6BAAC,OAAD;MAAK,OAAO,EAAE;IAAd,gBACE,6BAAC,QAAD;MAAM,OAAO,EAAC,QAAd;MAAuB,KAAK,EAAC;IAA7B,gBACE,6BAAC,WAAD;MAAS,KAAK;IAAd,EADF,CADF,CADF;EAOD;;EAED,IAAIC,KAAJ,EAAW;IACT,oBACE,6BAAC,SAAD;MAAO,OAAO,EAAE,CAAhB;MAAmB,KAAK,EAAE;IAA1B,gBACE,6BAAC,iBAAD,mDADF,EAEGR,KAAK,iBAAI,6BAAC,cAAD;MAAO,KAAK,EAAEF,KAAd;MAAqB,MAAM,EAAEC;IAA7B,EAFZ,CADF;EAMD;;EAED,IAAI,EAACU,IAAD,aAACA,IAAD,eAACA,IAAI,CAAES,MAAP,CAAJ,EAAmB;IACjB,oBACE,yEACE,6BAAC,oBAAD;MAAa,qBAAqB,EAAEjB;IAApC,EADF,eAEE,6BAAC,SAAD;MAAO,OAAO,EAAE,CAAhB;MAAmB,KAAK,EAAE;IAA1B,gBACE,6BAAC,iBAAD,6BADF,EAEGD,KAAK,iBAAI,6BAAC,cAAD;MAAO,KAAK,EAAEF,KAAd;MAAqB,MAAM,EAAEC;IAA7B,EAFZ,CAFF,CADF;EASD;;EAED,oBACE,yEACE,6BAAC,oBAAD;IAAa,qBAAqB,EAAEE;EAApC,EADF,eAEE,6BAAC,SAAD;IAAO,OAAO,EAAE,CAAhB;IAAmB,KAAK,EAAE;EAA1B,GACGQ,IAAI,CAACU,GAAL,CAAUC,GAAD,iBACR,6BAAC,UAAD;IACE,GAAG,EAAEA,GAAG,CAACC,GADX;IAEE,OAAO,EAAE,MAAMX,WAAW,CAACU,GAAG,CAACC,GAAL,EAAUD,GAAG,CAACE,KAAd,CAF5B;IAGE,OAAO,EAAE,CAHX;IAIE,IAAI,EAAC;EAJP,gBAME,6BAAC,gBAAD;IAAS,KAAK,EAAEF,GAAhB;IAAqB,IAAI,EAAEG,eAAA,CAAOC,GAAP,CAAWJ,GAAG,CAACE,KAAf;EAA3B,EANF,CADD,CADH,CAFF,CADF;AAiBD"}

package/lib/DocumentsPane.js

@@ -7,8 +7,6 @@ exports.default = DocumentsPane;
 
 var _react = _interopRequireDefault(require("react"));
 
-var _dlv = _interopRequireDefault(require("dlv"));
-
 var _ui = require("@sanity/ui");
 
 var _Documents = _interopRequireDefault(require("./Documents"));
@@ -17,44 +15,56 @@ var _Feedback = _interopRequireDefault(require("./Feedback"));
 
 var _Debug = _interopRequireDefault(require("./Debug"));
 
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+var _resolveParams = _interopRequireDefault(require("./resolveParams"));
 
-function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+var _resolveInitialValueTemplates = _interopRequireDefault(require("./resolveInitialValueTemplates"));
 
-function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 function DocumentsPane(props) {
-  var sanityDocument = props.document,
+  var document = props.document,
       options = props.options;
   var query = options.query,
       params = options.params,
-      useDraft = options.useDraft,
-      debug = options.debug;
-  var doc = useDraft ? sanityDocument.displayed : sanityDocument.published;
+      _options$useDraft = options.useDraft,
+      useDraft = _options$useDraft === void 0 ? false : _options$useDraft,
+      _options$debug = options.debug,
+      debug = _options$debug === void 0 ? false : _options$debug,
+      initialValueTemplatesResolver = options.initialValueTemplates;
 
-  var _ref = doc !== null && doc !== void 0 ? doc : {},
-      _rev = _ref._rev;
+  if (useDraft && typeof params === 'function') {
+    return /*#__PURE__*/_react.default.createElement(_ui.Stack, {
+      padding: 4,
+      space: 5
+    }, /*#__PURE__*/_react.default.createElement(_Feedback.default, null, /*#__PURE__*/_react.default.createElement("code", null, "useDraft"), " should not be ", /*#__PURE__*/_react.default.createElement("code", null, "true"), " when supplying a function for", /*#__PURE__*/_react.default.createElement("code", null, "params")), debug && /*#__PURE__*/_react.default.createElement(_Debug.default, {
+      query: query
+    }));
+  }
 
-  var paramValues = Object.keys(params).reduce((acc, key) => _objectSpread(_objectSpread({}, acc), {}, {
-    [key]: (0, _dlv.default)(doc, params[key])
-  }), {});
+  var paramValues = (0, _resolveParams.default)({
+    document,
+    params,
+    useDraft
+  });
+  var initialValueTemplates = (0, _resolveInitialValueTemplates.default)({
+    resolver: initialValueTemplatesResolver,
+    document
+  });
 
-  if (!_rev) {
+  if (!paramValues) {
     return /*#__PURE__*/_react.default.createElement(_ui.Stack, {
       padding: 4,
       space: 5
-    }, /*#__PURE__*/_react.default.createElement(_Feedback.default, null, "Document must be Published to have References"), debug && /*#__PURE__*/_react.default.createElement(_Debug.default, {
-      query: query,
-      params: params
+    }, /*#__PURE__*/_react.default.createElement(_Feedback.default, null, "Parameters for this query could not be resolved. This may mean the document does not yet exist or is incomplete."), debug && /*#__PURE__*/_react.default.createElement(_Debug.default, {
+      query: query
     }));
   }
 
   return /*#__PURE__*/_react.default.createElement(_Documents.default, {
     query: query,
     params: paramValues,
-    debug: debug
+    debug: debug,
+    initialValueTemplates: initialValueTemplates
   });
 }
 //# sourceMappingURL=DocumentsPane.js.map

package/lib/DocumentsPane.js.map

@@ -1 +1 @@
-{"version":3,"file":"DocumentsPane.js","names":["DocumentsPane","props","sanityDocument","document","options","query","params","useDraft","debug","doc","displayed","published","_rev","paramValues","Object","keys","reduce","acc","key","delve"],"sources":["../src/DocumentsPane.tsx"],"sourcesContent":["import React from 'react'\nimport delve from 'dlv'\nimport {Stack} from '@sanity/ui'\nimport {SanityDocument} from '@sanity/client'\n\nimport Documents from './Documents'\nimport Feedback from './Feedback'\nimport Debug from './Debug'\n\ntype DocumentsPaneOptions = {\n  query: string\n  params: {[key: string]: string}\n  debug: boolean\n  useDraft: boolean\n}\n\ntype DocumentsPaneProps = {\n  document: SanityDocument\n  options: DocumentsPaneOptions\n}\n\nexport default function DocumentsPane(props: DocumentsPaneProps) {\n  const {document: sanityDocument, options} = props\n  const {query, params, useDraft, debug} = options\n\n  const doc = useDraft ? sanityDocument.displayed : sanityDocument.published\n  const {_rev} = doc ?? {}\n\n  const paramValues = Object.keys(params).reduce(\n    (acc, key) => ({...acc, [key]: delve(doc, params[key])}),\n    {}\n  )\n\n  if (!_rev) {\n    return (\n      <Stack padding={4} space={5}>\n        <Feedback>Document must be Published to have References</Feedback>\n        {debug && <Debug query={query} params={params} />}\n      </Stack>\n    )\n  }\n\n  return <Documents query={query} params={paramValues} debug={debug} />\n}\n"],"mappings":";;;;;;;AAAA;;AACA;;AACA;;AAGA;;AACA;;AACA;;;;;;;;;;AAce,SAASA,aAAT,CAAuBC,KAAvB,EAAkD;EAC/D,IAAiBC,cAAjB,GAA4CD,KAA5C,CAAOE,QAAP;EAAA,IAAiCC,OAAjC,GAA4CH,KAA5C,CAAiCG,OAAjC;EACA,IAAOC,KAAP,GAAyCD,OAAzC,CAAOC,KAAP;EAAA,IAAcC,MAAd,GAAyCF,OAAzC,CAAcE,MAAd;EAAA,IAAsBC,QAAtB,GAAyCH,OAAzC,CAAsBG,QAAtB;EAAA,IAAgCC,KAAhC,GAAyCJ,OAAzC,CAAgCI,KAAhC;EAEA,IAAMC,GAAG,GAAGF,QAAQ,GAAGL,cAAc,CAACQ,SAAlB,GAA8BR,cAAc,CAACS,SAAjE;;EACA,WAAeF,GAAf,aAAeA,GAAf,cAAeA,GAAf,GAAsB,EAAtB;EAAA,IAAOG,IAAP,QAAOA,IAAP;;EAEA,IAAMC,WAAW,GAAGC,MAAM,CAACC,IAAP,CAAYT,MAAZ,EAAoBU,MAApB,CAClB,CAACC,GAAD,EAAMC,GAAN,qCAAmBD,GAAnB;IAAwB,CAACC,GAAD,GAAO,IAAAC,YAAA,EAAMV,GAAN,EAAWH,MAAM,CAACY,GAAD,CAAjB;EAA/B,EADkB,EAElB,EAFkB,CAApB;;EAKA,IAAI,CAACN,IAAL,EAAW;IACT,oBACE,6BAAC,SAAD;MAAO,OAAO,EAAE,CAAhB;MAAmB,KAAK,EAAE;IAA1B,gBACE,6BAAC,iBAAD,wDADF,EAEGJ,KAAK,iBAAI,6BAAC,cAAD;MAAO,KAAK,EAAEH,KAAd;MAAqB,MAAM,EAAEC;IAA7B,EAFZ,CADF;EAMD;;EAED,oBAAO,6BAAC,kBAAD;IAAW,KAAK,EAAED,KAAlB;IAAyB,MAAM,EAAEQ,WAAjC;IAA8C,KAAK,EAAEL;EAArD,EAAP;AACD"}
+{"version":3,"file":"DocumentsPane.js","names":["DocumentsPane","props","document","options","query","params","useDraft","debug","initialValueTemplatesResolver","initialValueTemplates","paramValues","resolveParams","resolveInitialValueTemplates","resolver"],"sources":["../src/DocumentsPane.tsx"],"sourcesContent":["import React from 'react'\nimport {Stack} from '@sanity/ui'\n\nimport Documents from './Documents'\nimport Feedback from './Feedback'\nimport Debug from './Debug'\nimport {DocumentsPaneProps} from './types'\nimport resolveParams from './resolveParams'\nimport resolveInitialValueTemplates from './resolveInitialValueTemplates'\n\nexport default function DocumentsPane(props: DocumentsPaneProps) {\n  const {document, options} = props\n  const {\n    query,\n    params,\n    useDraft = false,\n    debug = false,\n    initialValueTemplates: initialValueTemplatesResolver,\n  } = options\n\n  if (useDraft && typeof params === 'function') {\n    return (\n      <Stack padding={4} space={5}>\n        <Feedback>\n          <code>useDraft</code> should not be <code>true</code> when supplying a function for\n          <code>params</code>\n        </Feedback>\n        {debug && <Debug query={query} />}\n      </Stack>\n    )\n  }\n\n  const paramValues = resolveParams({document, params, useDraft})\n\n  const initialValueTemplates = resolveInitialValueTemplates({\n    resolver: initialValueTemplatesResolver,\n    document,\n  })\n\n  if (!paramValues) {\n    return (\n      <Stack padding={4} space={5}>\n        <Feedback>\n          Parameters for this query could not be resolved. This may mean the document does not yet\n          exist or is incomplete.\n        </Feedback>\n        {debug && <Debug query={query} />}\n      </Stack>\n    )\n  }\n\n  return (\n    <Documents\n      query={query}\n      params={paramValues}\n      debug={debug}\n      initialValueTemplates={initialValueTemplates}\n    />\n  )\n}\n"],"mappings":";;;;;;;AAAA;;AACA;;AAEA;;AACA;;AACA;;AAEA;;AACA;;;;AAEe,SAASA,aAAT,CAAuBC,KAAvB,EAAkD;EAC/D,IAAOC,QAAP,GAA4BD,KAA5B,CAAOC,QAAP;EAAA,IAAiBC,OAAjB,GAA4BF,KAA5B,CAAiBE,OAAjB;EACA,IACEC,KADF,GAMID,OANJ,CACEC,KADF;EAAA,IAEEC,MAFF,GAMIF,OANJ,CAEEE,MAFF;EAAA,wBAMIF,OANJ,CAGEG,QAHF;EAAA,IAGEA,QAHF,kCAGa,KAHb;EAAA,qBAMIH,OANJ,CAIEI,KAJF;EAAA,IAIEA,KAJF,+BAIU,KAJV;EAAA,IAKyBC,6BALzB,GAMIL,OANJ,CAKEM,qBALF;;EAQA,IAAIH,QAAQ,IAAI,OAAOD,MAAP,KAAkB,UAAlC,EAA8C;IAC5C,oBACE,6BAAC,SAAD;MAAO,OAAO,EAAE,CAAhB;MAAmB,KAAK,EAAE;IAA1B,gBACE,6BAAC,iBAAD,qBACE,sDADF,kCACsC,kDADtC,iDAEE,oDAFF,CADF,EAKGE,KAAK,iBAAI,6BAAC,cAAD;MAAO,KAAK,EAAEH;IAAd,EALZ,CADF;EASD;;EAED,IAAMM,WAAW,GAAG,IAAAC,sBAAA,EAAc;IAACT,QAAD;IAAWG,MAAX;IAAmBC;EAAnB,CAAd,CAApB;EAEA,IAAMG,qBAAqB,GAAG,IAAAG,qCAAA,EAA6B;IACzDC,QAAQ,EAAEL,6BAD+C;IAEzDN;EAFyD,CAA7B,CAA9B;;EAKA,IAAI,CAACQ,WAAL,EAAkB;IAChB,oBACE,6BAAC,SAAD;MAAO,OAAO,EAAE,CAAhB;MAAmB,KAAK,EAAE;IAA1B,gBACE,6BAAC,iBAAD,2HADF,EAKGH,KAAK,iBAAI,6BAAC,cAAD;MAAO,KAAK,EAAEH;IAAd,EALZ,CADF;EASD;;EAED,oBACE,6BAAC,kBAAD;IACE,KAAK,EAAEA,KADT;IAEE,MAAM,EAAEM,WAFV;IAGE,KAAK,EAAEH,KAHT;IAIE,qBAAqB,EAAEE;EAJzB,EADF;AAQD"}

package/lib/NewDocument.js

@@ -0,0 +1,55 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = NewDocument;
+
+var _ui = require("@sanity/ui");
+
+var _react = _interopRequireDefault(require("react"));
+
+var _icons = require("@sanity/icons");
+
+var _deskTool = require("@sanity/desk-tool");
+
+var _uuid = require("@sanity/uuid");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function NewDocument(props) {
+  var _props$initialValueTe = props.initialValueTemplates,
+      initialValueTemplates = _props$initialValueTe === void 0 ? [] : _props$initialValueTe;
+
+  var _usePaneRouter = (0, _deskTool.usePaneRouter)(),
+      ReferenceChildLink = _usePaneRouter.ReferenceChildLink;
+
+  if (!initialValueTemplates.length) return null;
+  return /*#__PURE__*/_react.default.createElement(_ui.Card, {
+    borderBottom: true,
+    padding: 2
+  }, /*#__PURE__*/_react.default.createElement(_ui.Flex, {
+    justify: "flex-end",
+    gap: 1
+  }, initialValueTemplates.map(template => {
+    return /*#__PURE__*/_react.default.createElement(ReferenceChildLink, {
+      documentId: (0, _uuid.uuid)(),
+      documentType: template.schemaType,
+      template: {
+        id: template.template,
+        params: template.parameters
+      },
+      parentRefPath: [],
+      key: "".concat(template.schemaType, "-").concat(template.template),
+      style: {
+        textDecoration: 'none'
+      }
+    }, /*#__PURE__*/_react.default.createElement(_ui.Button, {
+      icon: /*#__PURE__*/_react.default.createElement(_icons.ComposeIcon, null),
+      text: template.title,
+      mode: "bleed",
+      as: "span"
+    }));
+  })));
+}
+//# sourceMappingURL=NewDocument.js.map

package/lib/NewDocument.js.map

@@ -0,0 +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"}

package/lib/resolveInitialValueTemplates.js

@@ -0,0 +1,18 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = resolveInitialValueTemplates;
+
+function resolveInitialValueTemplates(options) {
+  var _ref = options || {},
+      resolver = _ref.resolver,
+      document = _ref.document;
+
+  if (!resolver) return [];
+  return resolver({
+    document
+  });
+}
+//# sourceMappingURL=resolveInitialValueTemplates.js.map

package/lib/resolveInitialValueTemplates.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolveInitialValueTemplates.js","names":["resolveInitialValueTemplates","options","resolver","document"],"sources":["../src/resolveInitialValueTemplates.ts"],"sourcesContent":["import {\n  DocumentsPaneInitialValueTemplate,\n  DocumentsPaneInitialValueTemplateResolver,\n  DocumentVersionsCollection,\n} from './types'\n\ninterface ResolveInitialValueTemplatesOptions {\n  resolver: DocumentsPaneInitialValueTemplateResolver | undefined\n  document: DocumentVersionsCollection\n}\n\nexport default function resolveInitialValueTemplates(\n  options: ResolveInitialValueTemplatesOptions\n): DocumentsPaneInitialValueTemplate[] {\n  const {resolver, document} = options || {}\n\n  if (!resolver) return []\n\n  return resolver({document})\n}\n"],"mappings":";;;;;;;AAWe,SAASA,4BAAT,CACbC,OADa,EAEwB;EACrC,WAA6BA,OAAO,IAAI,EAAxC;EAAA,IAAOC,QAAP,QAAOA,QAAP;EAAA,IAAiBC,QAAjB,QAAiBA,QAAjB;;EAEA,IAAI,CAACD,QAAL,EAAe,OAAO,EAAP;EAEf,OAAOA,QAAQ,CAAC;IAACC;EAAD,CAAD,CAAf;AACD"}

package/lib/resolveParams.js

@@ -0,0 +1,44 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = resolveParams;
+
+var _dlv = _interopRequireDefault(require("dlv"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+function defaultResolver(options) {
+  var params = options.params,
+      document = options.document,
+      useDraft = options.useDraft; // params is optional
+
+  if (!params) return {}; // legacy useDraft behaviour
+
+  var doc = useDraft ? document.displayed : document.published;
+  return Object.keys(params).reduce((acc, key) => _objectSpread(_objectSpread({}, acc), {}, {
+    [key]: (0, _dlv.default)(doc, params[key])
+  }), {});
+}
+
+function resolveParams(options) {
+  var params = options.params,
+      document = options.document;
+  var resolvedParams = typeof params == 'function' ? params({
+    document
+  }) : defaultResolver(options); // if any of the parameters are undefined, the query will error
+  // so return undefined so the UI can show a more appropriate message
+
+  if (Object.values(resolvedParams).includes(undefined)) return undefined; // Typescript can't tell that we've guarded against any value being undefined,
+  // so forcing the type
+
+  return resolvedParams;
+}
+//# sourceMappingURL=resolveParams.js.map

package/lib/resolveParams.js.map

@@ -0,0 +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"}

package/lib/types.js

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

package/lib/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","names":[],"sources":["../src/types.ts"],"sourcesContent":["import {SanityDocument} from '@sanity/client'\n\nexport interface DocumentVersionsCollection {\n  displayed: SanityDocument\n  published: SanityDocument\n  draft: SanityDocument\n  historical: SanityDocument\n}\n\n// eslint-disable-next-line prettier/prettier\nexport type DocumentsPaneQueryParams = (params: {document: DocumentVersionsCollection}) => ({[key: string]: string}) | {[key: string]: string}\n\nexport interface DocumentsPaneInitialValueTemplate {\n  schemaType: string\n  template?: string\n  parameters?: {[key: string]: any}\n  title: string\n}\n\n// eslint-disable-next-line prettier/prettier\nexport type DocumentsPaneInitialValueTemplateResolver = (params: {document: DocumentVersionsCollection}) => DocumentsPaneInitialValueTemplate[]\n\nexport type DocumentsPaneOptions = {\n  query: string\n  params?: DocumentsPaneQueryParams\n  debug?: boolean\n  useDraft?: boolean\n  initialValueTemplates?: DocumentsPaneInitialValueTemplateResolver\n}\n\nexport type DocumentsPaneProps = {\n  document: DocumentVersionsCollection\n  options: DocumentsPaneOptions\n}\n"],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sanity-plugin-documents-pane",
-  "version": "1.0.9",
+  "version": "1.1.0",
   "description": "Displays the results of a GROQ query in a View Pane",
   "main": "lib/index.js",
   "scripts": {
@@ -29,7 +29,8 @@
   "author": "Sanity.io <hello@sanity.io>",
   "license": "MIT",
   "dependencies": {
-    "@sanity/ui": "^0.37.12",
+    "@sanity/icons": "^1.3.4",
+    "@sanity/ui": "^0.38.0",
     "dlv": "^1.1.3",
     "react-fast-compare": "^3.2.0",
     "rxjs": "^6.5.6"
@@ -37,6 +38,7 @@
   "peerDependencies": {
     "@sanity/base": "^2.30.1",
     "@sanity/desk-tool": "^2.30.1",
+    "@sanity/uuid": "^3.0.1",
     "@sanity/util": "^2.29.5",
     "react": "^16.0.0 || ^17.0.0"
   },

package/src/Debug.tsx

@@ -1,7 +1,7 @@
 import React from 'react'
 import {Code, Box, Label, Stack} from '@sanity/ui'
 
-export default function Debug({query, params}: {query: string; params: {[key: string]: string}}) {
+export default function Debug({query, params}: {query: string; params?: {[key: string]: string}}) {
   return (
     <>
       <Stack space={4}>
@@ -12,14 +12,16 @@ export default function Debug({query, params}: {query: string; params: {[key: st
           <Code>{query}</Code>
         </Box>
       </Stack>
-      <Stack space={4}>
-        <Box>
-          <Label>Params</Label>
-        </Box>
-        <Box>
-          <Code>{JSON.stringify(params)}</Code>
-        </Box>
-      </Stack>
+      {params && (
+        <Stack space={4}>
+          <Box>
+            <Label>Params</Label>
+          </Box>
+          <Box>
+            <Code>{JSON.stringify(params)}</Code>
+          </Box>
+        </Stack>
+      )}
     </>
   )
 }

package/src/Documents.tsx

@@ -8,15 +8,18 @@ import schema from 'part:@sanity/base/schema'
 import Debug from './Debug'
 import Feedback from './Feedback'
 import useListeningQuery from './hooks/useListeningQuery'
+import {DocumentsPaneInitialValueTemplate} from './types'
+import NewDocument from './NewDocument'
 
 type DocumentsProps = {
   query: string
   params: {[key: string]: string}
   debug: boolean
+  initialValueTemplates: DocumentsPaneInitialValueTemplate[]
 }
 
 export default function Documents(props: DocumentsProps) {
-  const {query, params, debug} = props
+  const {query, params, debug, initialValueTemplates} = props
   const {routerPanesState, groupIndex, handleEditReference} = usePaneRouter()
 
   const {loading, error, data} = useListeningQuery(query, params)
@@ -59,25 +62,31 @@ export default function Documents(props: DocumentsProps) {
 
   if (!data?.length) {
     return (
-      <Stack padding={4} space={5}>
-        <Feedback>No Documents found</Feedback>
-        {debug && <Debug query={query} params={params} />}
-      </Stack>
+      <>
+        <NewDocument initialValueTemplates={initialValueTemplates} />
+        <Stack padding={4} space={5}>
+          <Feedback>No Documents found</Feedback>
+          {debug && <Debug query={query} params={params} />}
+        </Stack>
+      </>
     )
   }
 
   return (
-    <Stack padding={2} space={1}>
-      {data.map((doc) => (
-        <Button
-          key={doc._id}
-          onClick={() => handleClick(doc._id, doc._type)}
-          padding={2}
-          mode="bleed"
-        >
-          <Preview value={doc} type={schema.get(doc._type)} />
-        </Button>
-      ))}
-    </Stack>
+    <>
+      <NewDocument initialValueTemplates={initialValueTemplates} />
+      <Stack padding={2} space={1}>
+        {data.map((doc) => (
+          <Button
+            key={doc._id}
+            onClick={() => handleClick(doc._id, doc._type)}
+            padding={2}
+            mode="bleed"
+          >
+            <Preview value={doc} type={schema.get(doc._type)} />
+          </Button>
+        ))}
+      </Stack>
+    </>
   )
 }

package/src/DocumentsPane.tsx

@@ -1,44 +1,60 @@
 import React from 'react'
-import delve from 'dlv'
 import {Stack} from '@sanity/ui'
-import {SanityDocument} from '@sanity/client'
 
 import Documents from './Documents'
 import Feedback from './Feedback'
 import Debug from './Debug'
-
-type DocumentsPaneOptions = {
-  query: string
-  params: {[key: string]: string}
-  debug: boolean
-  useDraft: boolean
-}
-
-type DocumentsPaneProps = {
-  document: SanityDocument
-  options: DocumentsPaneOptions
-}
+import {DocumentsPaneProps} from './types'
+import resolveParams from './resolveParams'
+import resolveInitialValueTemplates from './resolveInitialValueTemplates'
 
 export default function DocumentsPane(props: DocumentsPaneProps) {
-  const {document: sanityDocument, options} = props
-  const {query, params, useDraft, debug} = options
+  const {document, options} = props
+  const {
+    query,
+    params,
+    useDraft = false,
+    debug = false,
+    initialValueTemplates: initialValueTemplatesResolver,
+  } = options
+
+  if (useDraft && typeof params === 'function') {
+    return (
+      <Stack padding={4} space={5}>
+        <Feedback>
+          <code>useDraft</code> should not be <code>true</code> when supplying a function for
+          <code>params</code>
+        </Feedback>
+        {debug && <Debug query={query} />}
+      </Stack>
+    )
+  }
 
-  const doc = useDraft ? sanityDocument.displayed : sanityDocument.published
-  const {_rev} = doc ?? {}
+  const paramValues = resolveParams({document, params, useDraft})
 
-  const paramValues = Object.keys(params).reduce(
-    (acc, key) => ({...acc, [key]: delve(doc, params[key])}),
-    {}
-  )
+  const initialValueTemplates = resolveInitialValueTemplates({
+    resolver: initialValueTemplatesResolver,
+    document,
+  })
 
-  if (!_rev) {
+  if (!paramValues) {
     return (
       <Stack padding={4} space={5}>
-        <Feedback>Document must be Published to have References</Feedback>
-        {debug && <Debug query={query} params={params} />}
+        <Feedback>
+          Parameters for this query could not be resolved. This may mean the document does not yet
+          exist or is incomplete.
+        </Feedback>
+        {debug && <Debug query={query} />}
       </Stack>
     )
   }
 
-  return <Documents query={query} params={paramValues} debug={debug} />
+  return (
+    <Documents
+      query={query}
+      params={paramValues}
+      debug={debug}
+      initialValueTemplates={initialValueTemplates}
+    />
+  )
 }

package/src/NewDocument.tsx

@@ -0,0 +1,38 @@
+import {Button, Card, Flex} from '@sanity/ui'
+import React from 'react'
+import {DocumentsPaneInitialValueTemplate} from './types'
+import {ComposeIcon} from '@sanity/icons'
+import {usePaneRouter} from '@sanity/desk-tool'
+import {uuid} from "@sanity/uuid"
+
+interface NewDocumentProps {
+  initialValueTemplates: DocumentsPaneInitialValueTemplate[]
+}
+
+export default function NewDocument(props: NewDocumentProps) {
+  const {initialValueTemplates = []} = props
+  const {ReferenceChildLink} = usePaneRouter()
+
+  if (!initialValueTemplates.length) return null
+
+  return (
+    <Card borderBottom={true} padding={2}>
+      <Flex justify="flex-end" gap={1}>
+        {initialValueTemplates.map((template) => {
+          return (
+            <ReferenceChildLink
+              documentId={uuid()}
+              documentType={template.schemaType}
+              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>
+          )
+        })}
+      </Flex>
+    </Card>
+  )
+}

package/src/resolveInitialValueTemplates.ts

@@ -0,0 +1,20 @@
+import {
+  DocumentsPaneInitialValueTemplate,
+  DocumentsPaneInitialValueTemplateResolver,
+  DocumentVersionsCollection,
+} from './types'
+
+interface ResolveInitialValueTemplatesOptions {
+  resolver: DocumentsPaneInitialValueTemplateResolver | undefined
+  document: DocumentVersionsCollection
+}
+
+export default function resolveInitialValueTemplates(
+  options: ResolveInitialValueTemplatesOptions
+): DocumentsPaneInitialValueTemplate[] {
+  const {resolver, document} = options || {}
+
+  if (!resolver) return []
+
+  return resolver({document})
+}

package/src/resolveParams.ts

@@ -0,0 +1,36 @@
+import {DocumentsPaneQueryParams, DocumentVersionsCollection} from './types'
+import delve from 'dlv'
+
+interface ResolveParamsOptions {
+  params?: DocumentsPaneQueryParams
+  document: DocumentVersionsCollection
+  useDraft: boolean
+}
+
+type ResolveParamsReturn = undefined | {[key: string]: string}
+
+function defaultResolver(options: ResolveParamsOptions): {[key: string]: string | undefined} {
+  const {params, document, useDraft} = options
+
+  // params is optional
+  if (!params) return {}
+
+  // legacy useDraft behaviour
+  const doc = useDraft ? document.displayed : document.published
+
+  return Object.keys(params).reduce((acc, key) => ({...acc, [key]: delve(doc, params[key])}), {})
+}
+
+export default function resolveParams(options: ResolveParamsOptions): ResolveParamsReturn {
+  const {params, document} = options
+
+  const resolvedParams = typeof params == 'function' ? params({document}) : defaultResolver(options)
+
+  // if any of the parameters are undefined, the query will error
+  // so return undefined so the UI can show a more appropriate message
+  if (Object.values(resolvedParams).includes(undefined)) return undefined
+
+  // Typescript can't tell that we've guarded against any value being undefined,
+  // so forcing the type
+  return resolvedParams as {[key: string]: string}
+}

package/src/types.ts

@@ -0,0 +1,34 @@
+import {SanityDocument} from '@sanity/client'
+
+export interface DocumentVersionsCollection {
+  displayed: SanityDocument
+  published: SanityDocument
+  draft: SanityDocument
+  historical: SanityDocument
+}
+
+// eslint-disable-next-line prettier/prettier
+export type DocumentsPaneQueryParams = (params: {document: DocumentVersionsCollection}) => ({[key: string]: string}) | {[key: string]: string}
+
+export interface DocumentsPaneInitialValueTemplate {
+  schemaType: string
+  template?: string
+  parameters?: {[key: string]: any}
+  title: string
+}
+
+// eslint-disable-next-line prettier/prettier
+export type DocumentsPaneInitialValueTemplateResolver = (params: {document: DocumentVersionsCollection}) => DocumentsPaneInitialValueTemplate[]
+
+export type DocumentsPaneOptions = {
+  query: string
+  params?: DocumentsPaneQueryParams
+  debug?: boolean
+  useDraft?: boolean
+  initialValueTemplates?: DocumentsPaneInitialValueTemplateResolver
+}
+
+export type DocumentsPaneProps = {
+  document: DocumentVersionsCollection
+  options: DocumentsPaneOptions
+}