@sanity/client 6.1.2 → 6.1.3-perspective.1

package/README.md

@@ -65,6 +65,9 @@ export async function updateDocumentTitle(_id, title) {
     - [UMD](#umd)
   - [Specifying API version](#specifying-api-version)
   - [Performing queries](#performing-queries)
+  - [Using perspectives](#using-perspectives)
+    - [`published`](#published)
+    - [`previewDrafts`](#previewdrafts)
   - [Fetching Content Source Maps](#fetching-content-source-maps)
   - [Listening to queries](#listening-to-queries)
   - [Fetch a single document](#fetch-a-single-document)
@@ -405,6 +408,162 @@ client.fetch(query, params).then((bikes) => {
 
 Perform a query using the given parameters (if any).
 
+### Using perspectives
+
+The `perspective` option can be used to specify special filtering behavior for queries. The default value is `raw`, which means no special filtering is applied, while [`published`](#published) and [`previewDrafts`](#previewdrafts) can be used to optimize for specific use cases.
+
+#### `published`
+
+Useful for when you want to be sure that draft documents are not returned in production. Pairs well with private datasets.
+
+With a dataset that looks like this:
+
+```json
+[
+  {
+    "_type": "author",
+    "_id": "ecfef291-60f0-4609-bbfc-263d11a48c43",
+    "name": "George Martin"
+  },
+  {
+    "_type": "author",
+    "_id": "drafts.ecfef291-60f0-4609-bbfc-263d11a48c43",
+    "name": "George R.R. Martin"
+  },
+  {
+    "_type": "author",
+    "_id": "drafts.f4898efe-92c4-4dc0-9c8c-f7480aef17e2",
+    "name": "Stephen King"
+  }
+]
+```
+
+And a query like this:
+
+```ts
+import {createClient} from '@sanity/client'
+
+const client = createClient({
+  ...config,
+  useCdn: true, // set to `false` to bypass the edge cache
+  perspective: 'published',
+})
+
+const authors = await client.fetch('*[_type == "author"]')
+```
+
+Then `authors` will only contain documents that don't have a `drafts.` prefix in their `_id`, in this case just "George Martin":
+
+```json
+[
+  {
+    "_type": "author",
+    "_id": "ecfef291-60f0-4609-bbfc-263d11a48c43",
+    "name": "George Martin"
+  }
+]
+```
+
+#### `previewDrafts`
+
+Designed to help answer the question "What is our app going to look like after all the draft documents are published?".
+
+Given a dataset like this:
+
+```json
+[
+  {
+    "_type": "author",
+    "_id": "ecfef291-60f0-4609-bbfc-263d11a48c43",
+    "name": "George Martin"
+  },
+  {
+    "_type": "author",
+    "_id": "drafts.ecfef291-60f0-4609-bbfc-263d11a48c43",
+    "name": "George R.R. Martin"
+  },
+  {
+    "_type": "author",
+    "_id": "drafts.f4898efe-92c4-4dc0-9c8c-f7480aef17e2",
+    "name": "Stephen King"
+  },
+  {
+    "_type": "author",
+    "_id": "6b3792d2-a9e8-4c79-9982-c7e89f2d1e75",
+    "name": "Terry Pratchett"
+  }
+]
+```
+
+And a query like this:
+
+```ts
+import {createClient} from '@sanity/client'
+
+const client = createClient({
+  ...config,
+  useCdn: false, // the `previewDrafts` perspective requires this to be `false`
+  perspective: 'previewDrafts',
+})
+
+const authors = await client.fetch('*[_type == "author"]')
+```
+
+Then `authors` will look like this. Note that the result dedupes documents with a preference for the draft version:
+
+```json
+[
+  {
+    "_type": "author",
+    "_id": "ecfef291-60f0-4609-bbfc-263d11a48c43",
+    "_originalId": "drafts.ecfef291-60f0-4609-bbfc-263d11a48c43",
+    "name": "George R.R. Martin"
+  },
+  {
+    "_type": "author",
+    "_id": "f4898efe-92c4-4dc0-9c8c-f7480aef17e2",
+    "_originalId": "drafts.f4898efe-92c4-4dc0-9c8c-f7480aef17e2",
+    "name": "Stephen King"
+  },
+  {
+    "_type": "author",
+    "_id": "6b3792d2-a9e8-4c79-9982-c7e89f2d1e75",
+    "_originalId": "6b3792d2-a9e8-4c79-9982-c7e89f2d1e75",
+    "name": "Terry Pratchett"
+  }
+]
+```
+
+Since the query simulates what the result will be after publishing the drafts, the `_id` doesn't contain the `drafts.` prefix. If you want to check if a document is a draft or not you can use the `_originalId` field, which is only available when using the `previewDrafts` perspective.
+
+```ts
+const authors = await client.fetch(`*[_type == "author"]{..., "status": select(
+  _originalId in path("drafts.**") => "draft",
+  "published"
+)}`)
+```
+
+Which changes the result to be:
+
+```json
+[
+  {
+    "_type": "author",
+    "_id": "ecfef291-60f0-4609-bbfc-263d11a48c43",
+    "_originalId": "drafts.ecfef291-60f0-4609-bbfc-263d11a48c43",
+    "name": "George R.R. Martin",
+    "status": "draft"
+  },
+  {
+    "_type": "author",
+    "_id": "f4898efe-92c4-4dc0-9c8c-f7480aef17e2",
+    "_originalId": "f4898efe-92c4-4dc0-9c8c-f7480aef17e2",
+    "name": "Stephen King",
+    "status": "published"
+  }
+]
+```
+
 ### Fetching Content Source Maps
 
 Content Source Maps annotate fragments in your query results with metadata about its origin: the field, document, and dataset it originated from.

package/dist/index.browser.cjs

@@ -8,12 +8,26 @@ var middleware = require('get-it/middleware');
 var rxjs = require('rxjs');
 var operators = require('rxjs/operators');
 var envMiddleware = [];
+var __defProp$3 = Object.defineProperty;
+var __defNormalProp$3 = (obj, key, value) => key in obj ? __defProp$3(obj, key, {
+  enumerable: true,
+  configurable: true,
+  writable: true,
+  value
+}) : obj[key] = value;
+var __publicField$3 = (obj, key, value) => {
+  __defNormalProp$3(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
 const MAX_ITEMS_IN_ERROR_MESSAGE = 5;
 class ClientError extends Error {
   constructor(res) {
     const props = extractErrorProps(res);
     super(props.message);
-    this.statusCode = 400;
+    __publicField$3(this, "response");
+    __publicField$3(this, "statusCode", 400);
+    __publicField$3(this, "responseBody");
+    __publicField$3(this, "details");
     Object.assign(this, props);
   }
 }
@@ -21,7 +35,10 @@ class ServerError extends Error {
   constructor(res) {
     const props = extractErrorProps(res);
     super(props.message);
-    this.statusCode = 500;
+    __publicField$3(this, "response");
+    __publicField$3(this, "statusCode", 500);
+    __publicField$3(this, "responseBody");
+    __publicField$3(this, "details");
     Object.assign(this, props);
   }
 }
@@ -242,6 +259,17 @@ const encodeQueryString = _ref2 => {
   }
   return "?".concat(searchParams);
 };
+var __defProp$2 = Object.defineProperty;
+var __defNormalProp$2 = (obj, key, value) => key in obj ? __defProp$2(obj, key, {
+  enumerable: true,
+  configurable: true,
+  writable: true,
+  value
+}) : obj[key] = value;
+var __publicField$2 = (obj, key, value) => {
+  __defNormalProp$2(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
 var __accessCheck$6 = (obj, member, msg) => {
   if (!member.has(obj)) throw TypeError("Cannot " + msg);
 };
@@ -262,6 +290,8 @@ var _client$5, _client2$5;
 class BasePatch {
   constructor(selection) {
     let operations = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+    __publicField$2(this, "selection");
+    __publicField$2(this, "operations");
     this.selection = selection;
     this.operations = operations;
   }
@@ -415,7 +445,7 @@ class BasePatch {
     return this._assign(op, props, false);
   }
 }
-const _ObservablePatch = class extends BasePatch {
+const _ObservablePatch = class _ObservablePatch extends BasePatch {
   constructor(selection, operations, client) {
     super(selection, operations);
     __privateAdd$6(this, _client$5, void 0);
@@ -443,9 +473,9 @@ const _ObservablePatch = class extends BasePatch {
     }, opts);
   }
 };
-let ObservablePatch = _ObservablePatch;
 _client$5 = new WeakMap();
-const _Patch = class extends BasePatch {
+let ObservablePatch = _ObservablePatch;
+const _Patch = class _Patch extends BasePatch {
   constructor(selection, operations, client) {
     super(selection, operations);
     __privateAdd$6(this, _client2$5, void 0);
@@ -473,8 +503,19 @@ const _Patch = class extends BasePatch {
     }, opts);
   }
 };
-let Patch = _Patch;
 _client2$5 = new WeakMap();
+let Patch = _Patch;
+var __defProp$1 = Object.defineProperty;
+var __defNormalProp$1 = (obj, key, value) => key in obj ? __defProp$1(obj, key, {
+  enumerable: true,
+  configurable: true,
+  writable: true,
+  value
+}) : obj[key] = value;
+var __publicField$1 = (obj, key, value) => {
+  __defNormalProp$1(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
 var __accessCheck$5 = (obj, member, msg) => {
   if (!member.has(obj)) throw TypeError("Cannot " + msg);
 };
@@ -499,6 +540,8 @@ class BaseTransaction {
   constructor() {
     let operations = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [];
     let transactionId = arguments.length > 1 ? arguments[1] : undefined;
+    __publicField$1(this, "operations");
+    __publicField$1(this, "trxId");
     this.operations = operations;
     this.trxId = transactionId;
   }
@@ -587,7 +630,7 @@ class BaseTransaction {
     return this;
   }
 }
-const _Transaction = class extends BaseTransaction {
+const _Transaction = class _Transaction extends BaseTransaction {
   constructor(operations, client, transactionId) {
     super(operations, transactionId);
     __privateAdd$5(this, _client$4, void 0);
@@ -632,9 +675,9 @@ const _Transaction = class extends BaseTransaction {
     });
   }
 };
-let Transaction = _Transaction;
 _client$4 = new WeakMap();
-const _ObservableTransaction = class extends BaseTransaction {
+let Transaction = _Transaction;
+const _ObservableTransaction = class _ObservableTransaction extends BaseTransaction {
   constructor(operations, client, transactionId) {
     super(operations, transactionId);
     __privateAdd$5(this, _client2$4, void 0);
@@ -679,8 +722,8 @@ const _ObservableTransaction = class extends BaseTransaction {
     });
   }
 };
-let ObservableTransaction = _ObservableTransaction;
 _client2$4 = new WeakMap();
+let ObservableTransaction = _ObservableTransaction;
 const excludeFalsey = (param, defValue) => {
   const value = typeof param === "undefined" ? defValue : param;
   return param === false ? void 0 : value;
@@ -842,7 +885,7 @@ function _requestObservable(client, httpRequest, options) {
         ...options.query
       };
     }
-    if (typeof config.perspective === "string" && config.perspective !== "all") {
+    if (typeof config.perspective === "string" && config.perspective !== "raw") {
       options.query = {
         perspective: config.perspective,
         ...options.query
@@ -1493,6 +1536,17 @@ class UsersClient {
 }
 _client2 = new WeakMap();
 _httpRequest2$1 = new WeakMap();
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, {
+  enumerable: true,
+  configurable: true,
+  writable: true,
+  value
+}) : obj[key] = value;
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
 var __accessCheck = (obj, member, msg) => {
   if (!member.has(obj)) throw TypeError("Cannot " + msg);
 };
@@ -1510,9 +1564,13 @@ var __privateSet = (obj, member, value, setter) => {
   return value;
 };
 var _clientConfig, _httpRequest, _clientConfig2, _httpRequest2;
-const _ObservableSanityClient = class {
+const _ObservableSanityClient = class _ObservableSanityClient {
   constructor(httpRequest) {
     let config = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : defaultConfig;
+    __publicField(this, "assets");
+    __publicField(this, "datasets");
+    __publicField(this, "projects");
+    __publicField(this, "users");
     /**
      * Private properties
      */
@@ -1521,7 +1579,7 @@ const _ObservableSanityClient = class {
     /**
      * Instance properties
      */
-    this.listen = _listen;
+    __publicField(this, "listen", _listen);
     this.config(config);
     __privateSet(this, _httpRequest, httpRequest);
     this.assets = new ObservableAssetsClient(this, __privateGet(this, _httpRequest));
@@ -1643,12 +1701,20 @@ const _ObservableSanityClient = class {
     return _getDataUrl(this, operation, path);
   }
 };
-let ObservableSanityClient = _ObservableSanityClient;
 _clientConfig = new WeakMap();
 _httpRequest = new WeakMap();
-const _SanityClient = class {
+let ObservableSanityClient = _ObservableSanityClient;
+const _SanityClient = class _SanityClient {
   constructor(httpRequest) {
     let config = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : defaultConfig;
+    __publicField(this, "assets");
+    __publicField(this, "datasets");
+    __publicField(this, "projects");
+    __publicField(this, "users");
+    /**
+     * Observable version of the Sanity client, with the same configuration as the promise-based one
+     */
+    __publicField(this, "observable");
     /**
      * Private properties
      */
@@ -1657,7 +1723,7 @@ const _SanityClient = class {
     /**
      * Instance properties
      */
-    this.listen = _listen;
+    __publicField(this, "listen", _listen);
     this.config(config);
     __privateSet(this, _httpRequest2, httpRequest);
     this.assets = new AssetsClient(this, __privateGet(this, _httpRequest2));
@@ -1797,9 +1863,9 @@ const _SanityClient = class {
     return _getDataUrl(this, operation, path);
   }
 };
-let SanityClient = _SanityClient;
 _clientConfig2 = new WeakMap();
 _httpRequest2 = new WeakMap();
+let SanityClient = _SanityClient;
 const httpRequest = defineHttpRequest(envMiddleware, {});
 const requester = httpRequest.defaultRequester;
 const createClient = config => new SanityClient(defineHttpRequest(envMiddleware, {