@sanity/client 2.24.3-pte.128 → 3.0.2

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2016 - 2021 Sanity.io
+Copyright (c) 2016 - 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

@@ -298,7 +298,7 @@ One or more documents can be deleted by specifying a GROQ query (and optionally,
 // Without params
 
 client
-  .delete({ query: '*[_type == "bike"][0]' })
+  .delete({query: '*[_type == "bike"][0]'})
   .then(() => {
     console.log('The document matching *[_type == "bike"][0] was deleted')
   })
@@ -311,7 +311,7 @@ client
 // With params
 
 client
-  .delete({ query: '*[_type == $type][0..1]', params: { type: 'bike' } })
+  .delete({query: '*[_type == $type][0..1]', params: {type: 'bike'}})
   .then(() => {
     console.log('The documents matching *[_type == "bike"][0..1] was deleted')
   })
@@ -513,3 +513,7 @@ client.config({dataset: 'newDataset'})
 `client.config(options)`
 
 Set client configuration. Required options are `projectId` and `dataset`.
+
+## License
+
+MIT © [Sanity.io](https://www.sanity.io/)

package/lib/assets/assetsClient.js

@@ -14,11 +14,9 @@ function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
 
 var assign = require('object-assign');
 
-var _require = require('@sanity/observable/operators/map'),
-    map = _require.map;
-
-var _require2 = require('@sanity/observable/operators/filter'),
-    filter = _require2.filter;
+var _require = require('../util/observable'),
+    map = _require.map,
+    filter = _require.filter;
 
 var queryString = require('../http/queryString');
 
@@ -28,20 +26,6 @@ function AssetsClient(client) {
   this.client = client;
 }
 
-function toDocument(body) {
-  // todo: rewrite to just return body.document in a while
-  var document = body.document;
-  Object.defineProperty(document, 'document', {
-    enumerable: false,
-    get: function get() {
-      // eslint-disable-next-line no-console
-      console.warn('The promise returned from client.asset.upload(...) now resolves with the asset document');
-      return document;
-    }
-  });
-  return document;
-}
-
 function optionsFromFile(opts, file) {
   if (typeof window === 'undefined' || !(file instanceof window.File)) {
     return opts;
@@ -129,7 +113,7 @@ assign(AssetsClient.prototype, {
     return this.client.isPromiseAPI() ? observable.pipe(filter(function (event) {
       return event.type === 'response';
     }), map(function (event) {
-      return toDocument(event.body);
+      return event.body.document;
     })).toPromise() : observable;
   },
   delete: function _delete(type, id) {

package/lib/config.js

@@ -13,7 +13,6 @@ var defaultConfig = {
   apiHost: 'https://api.sanity.io',
   apiVersion: '1',
   useProjectHostname: true,
-  gradientMode: false,
   isPromiseAPI: true
 };
 var LOCALHOSTS = ['localhost', '127.0.0.1', '0.0.0.0'];
@@ -32,18 +31,13 @@ exports.initConfig = function (config, prevConfig) {
   }
 
   var newConfig = assign({}, defaultConfig, specifiedConfig);
-  var gradientMode = newConfig.gradientMode;
-  var projectBased = !gradientMode && newConfig.useProjectHostname;
+  var projectBased = newConfig.useProjectHostname;
 
   if (typeof Promise === 'undefined') {
     var helpUrl = generateHelpUrl('js-client-promise-polyfill');
     throw new Error("No native Promise-implementation found, polyfill needed - see ".concat(helpUrl));
   }
 
-  if (gradientMode && !newConfig.namespace) {
-    throw new Error('Configuration must contain `namespace` when running in gradient mode');
-  }
-
   if (projectBased && !newConfig.projectId) {
     throw new Error('Configuration must contain `projectId`');
   }
@@ -53,8 +47,6 @@ exports.initConfig = function (config, prevConfig) {
 
   if (isBrowser && isLocalhost && newConfig.token && newConfig.ignoreBrowserTokenWarning !== true) {
     warnings.printBrowserTokenWarning();
-  } else if ((!isBrowser || isLocalhost) && newConfig.useCdn && newConfig.token) {
-    warnings.printCdnTokenWarning();
   } else if (typeof newConfig.useCdn === 'undefined') {
     warnings.printCdnWarning();
   }
@@ -63,8 +55,8 @@ exports.initConfig = function (config, prevConfig) {
     validate.projectId(newConfig.projectId);
   }
 
-  if (!gradientMode && newConfig.dataset) {
-    validate.dataset(newConfig.dataset, newConfig.gradientMode);
+  if (newConfig.dataset) {
+    validate.dataset(newConfig.dataset);
   }
 
   if ('requestTagPrefix' in newConfig) {
@@ -74,25 +66,19 @@ exports.initConfig = function (config, prevConfig) {
 
   newConfig.apiVersion = "".concat(newConfig.apiVersion).replace(/^v/, '');
   newConfig.isDefaultApi = newConfig.apiHost === defaultConfig.apiHost;
-  newConfig.useCdn = Boolean(newConfig.useCdn) && !newConfig.token && !newConfig.withCredentials;
+  newConfig.useCdn = Boolean(newConfig.useCdn) && !newConfig.withCredentials;
   exports.validateApiVersion(newConfig.apiVersion);
-
-  if (newConfig.gradientMode) {
-    newConfig.url = newConfig.apiHost;
-    newConfig.cdnUrl = newConfig.apiHost;
+  var hostParts = newConfig.apiHost.split('://', 2);
+  var protocol = hostParts[0];
+  var host = hostParts[1];
+  var cdnHost = newConfig.isDefaultApi ? defaultCdnHost : host;
+
+  if (newConfig.useProjectHostname) {
+    newConfig.url = "".concat(protocol, "://").concat(newConfig.projectId, ".").concat(host, "/v").concat(newConfig.apiVersion);
+    newConfig.cdnUrl = "".concat(protocol, "://").concat(newConfig.projectId, ".").concat(cdnHost, "/v").concat(newConfig.apiVersion);
   } else {
-    var hostParts = newConfig.apiHost.split('://', 2);
-    var protocol = hostParts[0];
-    var host = hostParts[1];
-    var cdnHost = newConfig.isDefaultApi ? defaultCdnHost : host;
-
-    if (newConfig.useProjectHostname) {
-      newConfig.url = "".concat(protocol, "://").concat(newConfig.projectId, ".").concat(host, "/v").concat(newConfig.apiVersion);
-      newConfig.cdnUrl = "".concat(protocol, "://").concat(newConfig.projectId, ".").concat(cdnHost, "/v").concat(newConfig.apiVersion);
-    } else {
-      newConfig.url = "".concat(newConfig.apiHost, "/v").concat(newConfig.apiVersion);
-      newConfig.cdnUrl = newConfig.url;
-    }
+    newConfig.url = "".concat(newConfig.apiHost, "/v").concat(newConfig.apiVersion);
+    newConfig.cdnUrl = newConfig.url;
   }
 
   return newConfig;

package/lib/data/dataMethods.js

@@ -4,12 +4,10 @@ function _defineProperty(obj, key, value) { if (key in obj) { Object.definePrope
 
 var assign = require('object-assign');
 
-var _require = require('@sanity/observable/operators/filter'),
+var _require = require('../util/observable'),
+    map = _require.map,
     filter = _require.filter;
 
-var _require2 = require('@sanity/observable/operators/map'),
-    map = _require2.map;
-
 var validators = require('../validators');
 
 var getSelection = require('../util/getSelection');
@@ -60,10 +58,10 @@ module.exports = {
   listen: listen,
   getDataUrl: function getDataUrl(operation, path) {
     var config = this.clientConfig;
-    var catalog = config.gradientMode ? config.namespace : validators.hasDataset(config);
+    var catalog = validators.hasDataset(config);
     var baseUri = "/".concat(operation, "/").concat(catalog);
     var uri = path ? "".concat(baseUri, "/").concat(path) : baseUri;
-    return (this.clientConfig.gradientMode ? uri : "/data".concat(uri)).replace(/\/($|\?)/, '$1');
+    return "/data".concat(uri).replace(/\/($|\?)/, '$1');
   },
   fetch: function fetch(query, params) {
     var options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};

package/lib/data/listen.js

@@ -8,7 +8,8 @@ function _defineProperty(obj, key, value) { if (key in obj) { Object.definePrope
 
 var assign = require('object-assign');
 
-var Observable = require('@sanity/observable/minimal');
+var _require = require('../util/observable'),
+    Observable = _require.Observable;
 
 var polyfilledEventSource = require('@sanity/eventsource');
 

package/lib/data/patch.js

@@ -2,8 +2,6 @@
 
 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; }
 
-var deepAssign = require('deep-assign');
-
 var assign = require('object-assign');
 
 var getSelection = require('../util/getSelection');
@@ -25,14 +23,6 @@ assign(Patch.prototype, {
   clone: function clone() {
     return new Patch(this.selection, assign({}, this.operations), this.client);
   },
-  merge: function merge(props) {
-    validateObject('merge', props);
-    var stack = new Error().stack.toString().split('\n').filter(function (str) {
-      return str.trim();
-    }).slice(2);
-    console.warn("The \"merge\" patch has been deprecated and will be removed in the future\n".concat(stack.join('\n')));
-    return this._assign('merge', deepAssign(this.operations.merge || {}, props));
-  },
   set: function set(props) {
     return this._assign('set', props);
   },

package/lib/http/request.js

@@ -13,11 +13,12 @@ var jsonResponse = require('get-it/lib/middleware/jsonResponse');
 
 var progress = require('get-it/lib/middleware/progress');
 
-var Observable = require('@sanity/observable/minimal');
+var _require = require('../util/observable'),
+    Observable = _require.Observable;
 
-var _require = require('./errors'),
-    ClientError = _require.ClientError,
-    ServerError = _require.ServerError;
+var _require2 = require('./errors'),
+    ClientError = _require2.ClientError,
+    ServerError = _require2.ServerError;
 
 var httpError = {
   onResponse: function onResponse(res) {

package/lib/sanityClient.js

@@ -8,12 +8,11 @@ function _defineProperty(obj, key, value) { if (key in obj) { Object.definePrope
 
 var assign = require('object-assign');
 
-var _require = require('@sanity/observable/operators/filter'),
+var _require = require('./util/observable'),
+    Observable = _require.Observable,
+    map = _require.map,
     filter = _require.filter;
 
-var _require2 = require('@sanity/observable/operators/map'),
-    map = _require2.map;
-
 var Patch = require('./data/patch');
 
 var Transaction = require('./data/transaction');
@@ -34,9 +33,9 @@ var httpRequest = require('./http/request');
 
 var getRequestOptions = require('./http/requestOptions');
 
-var _require3 = require('./config'),
-    defaultConfig = _require3.defaultConfig,
-    initConfig = _require3.initConfig;
+var _require2 = require('./config'),
+    defaultConfig = _require2.defaultConfig,
+    initConfig = _require2.initConfig;
 
 var validate = require('./validators');
 
@@ -98,6 +97,8 @@ assign(SanityClient.prototype, {
     return this.clientConfig.isPromiseAPI;
   },
   _requestObservable: function _requestObservable(options) {
+    var _this = this;
+
     var uri = options.url || options.uri; // If the `canUseCdn`-option is not set we detect it automatically based on the method + URL.
     // Only the /data endpoint is currently available through API-CDN.
 
@@ -114,7 +115,9 @@ assign(SanityClient.prototype, {
     var reqOptions = getRequestOptions(this.clientConfig, assign({}, options, {
       url: this.getUrl(uri, useCdn)
     }));
-    return httpRequest(reqOptions, this.clientConfig.requester);
+    return new Observable(function (subscriber) {
+      return httpRequest(reqOptions, _this.clientConfig.requester).subscribe(subscriber);
+    });
   },
   request: function request(options) {
     var observable = this._requestObservable(options).pipe(filter(function (event) {

package/lib/util/observable.js

@@ -0,0 +1,18 @@
+"use strict";
+
+//  Since `@sanity/client` doesn't offer ESM exports (yet) const {filter} = require('rxjs/operators') will cause the the whole of rxjs to be included in the bundle.
+//  The internal import paths here is a stop-gap measure and will become less of a problem when @sanity/client export tree-shakeable esm bundles
+var _require = require('rxjs/internal/Observable'),
+    Observable = _require.Observable;
+
+var _require2 = require('rxjs/internal/operators/filter'),
+    filter = _require2.filter;
+
+var _require3 = require('rxjs/internal/operators/map'),
+    map = _require3.map;
+
+module.exports = {
+  Observable: Observable,
+  filter: filter,
+  map: map
+};

package/lib/validators.js

@@ -63,7 +63,7 @@ exports.validateInsert = function (at, selector, items) {
 };
 
 exports.hasDataset = function (config) {
-  if (!config.gradientMode && !config.dataset) {
+  if (!config.dataset) {
     throw new Error('`dataset` must be provided to perform queries');
   }
 

package/lib/warnings.js

@@ -20,5 +20,4 @@ var createWarningPrinter = function createWarningPrinter(message) {
 
 exports.printCdnWarning = createWarningPrinter(['You are not using the Sanity CDN. That means your data is always fresh, but the CDN is faster and', "cheaper. Think about it! For more info, see ".concat(generateHelpUrl('js-client-cdn-configuration'), "."), 'To hide this warning, please set the `useCdn` option to either `true` or `false` when creating', 'the client.']);
 exports.printBrowserTokenWarning = createWarningPrinter(['You have configured Sanity client to use a token in the browser. This may cause unintentional security issues.', "See ".concat(generateHelpUrl('js-client-browser-token'), " for more information and how to hide this warning.")]);
-exports.printCdnTokenWarning = createWarningPrinter(['You have set `useCdn` to `true` while also specifying a token. This is usually not what you', 'want. The CDN cannot be used with an authorization token, since private data cannot be cached.', "See ".concat(generateHelpUrl('js-client-usecdn-token'), " for more information.")]);
 exports.printNoApiVersionSpecifiedWarning = createWarningPrinter(['Using the Sanity client without specifying an API version is deprecated.', "See ".concat(generateHelpUrl('js-client-api-version'))]);

package/package.json

@@ -1,61 +1,60 @@
 {
   "name": "@sanity/client",
-  "version": "2.24.3-pte.128+5c3cdaaa08",
-  "description": "Client for retrieving data from Sanity",
+  "version": "3.0.2",
+  "description": "Client for retrieving, creating and patching data from Sanity.io",
   "main": "lib/sanityClient.js",
   "umd": "umd/sanityClient.min.js",
   "unpkg": "umd/sanityClient.min.js",
   "types": "./sanityClient.d.ts",
   "scripts": {
-    "analyze": "NODE_ENV=production BROWSERIFY_ENV=build DEBUG='' browserify --full-paths -t envify -g uglifyify lib/sanityClient.js --standalone=SanityClient | discify --open",
     "browserify": "NODE_ENV=production BROWSERIFY_ENV=build DEBUG='' browserify -t envify -g uglifyify lib/sanityClient.js -o umd/sanityClient.js --standalone=SanityClient",
-    "build": "babel src --copy-files --out-dir lib && npm run browserify && npm run minify && npm run size",
-    "size": "node -r @babel/register src/scripts/print-bundle-size",
+    "compile": "babel -d lib src",
+    "build": "npm run compile && npm run browserify && npm run minify",
+    "lint": "eslint .",
     "clean": "rimraf lib coverage .nyc_output umd/*.js",
     "coverage": "DEBUG=sanity NODE_ENV=test nyc --reporter=html --reporter=lcov --reporter=text npm test",
     "minify": "terser -c -m -- umd/sanityClient.js > umd/sanityClient.min.js",
     "prepublishOnly": "npm run build",
-    "test": "tape -r @babel/register test/*.test.js"
+    "test": "NODE_ENV=test tape test/*.test.js",
+    "posttest": "npm run lint"
   },
   "browser": {
     "./src/http/nodeMiddleware.js": "./src/http/browserMiddleware.js",
     "./lib/http/nodeMiddleware.js": "./lib/http/browserMiddleware.js"
   },
+  "engines": {
+    "node": ">=12"
+  },
   "dependencies": {
-    "@sanity/eventsource": "2.24.3-pte.128+5c3cdaaa08",
-    "@sanity/generate-help-url": "2.24.3-pte.128+5c3cdaaa08",
-    "@sanity/observable": "2.0.9",
-    "deep-assign": "^2.0.0",
+    "@sanity/eventsource": "^2.23.0",
+    "@sanity/generate-help-url": "^2.18.0",
     "get-it": "^5.2.1",
     "make-error": "^1.3.0",
-    "object-assign": "^4.1.1"
+    "object-assign": "^4.1.1",
+    "rxjs": "^6.0.0"
   },
   "devDependencies": {
     "@babel/cli": "^7.11.6",
     "@babel/core": "^7.11.6",
     "@babel/preset-env": "^7.11.5",
-    "boxen": "^4.1.0",
-    "browserify": "^14.3.0",
-    "chalk": "^2.4.2",
-    "disc": "^1.3.2",
+    "browserify": "^17.0.0",
     "envify": "^4.0.0",
-    "gzip-size": "^3.0.0",
-    "hard-rejection": "^2.1.0",
-    "nock": "^9.0.5",
-    "nyc": "^11.0.3",
-    "pretty-bytes": "^4.0.2",
-    "rimraf": "^2.7.1",
-    "rxjs": "^6.5.3",
-    "sse-channel": "^2.0.6",
-    "tape": "^4.8.0",
+    "eslint": "^8.7.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-config-sanity": "^5.1.0",
+    "nock": "^13.2.2",
+    "nyc": "^15.1.0",
+    "prettier": "^2.5.1",
+    "rimraf": "^3.0.2",
+    "sse-channel": "^4.0.0",
+    "tape": "^5.4.1",
     "terser": "^5.7.2",
     "uglifyify": "^5.0.1",
     "xtend": "4.0.2"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/sanity-io/sanity.git",
-    "directory": "packages/@sanity/client"
+    "url": "git+https://github.com/sanity-io/client.git"
   },
   "keywords": [
     "sanity",
@@ -65,23 +64,24 @@
     "content",
     "client",
     "fetch",
-    "api",
-    "gradient"
+    "api"
   ],
   "author": "Sanity.io <hello@sanity.io>",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/sanity-io/sanity/issues"
+    "url": "https://github.com/sanity-io/client/issues"
   },
   "homepage": "https://www.sanity.io/",
   "nyc": {
     "include": [
       "src/**/*.js"
     ],
-    "require": [
-      "@babel/register"
-    ],
     "sourceMap": false
   },
-  "gitHead": "5c3cdaaa082559232fe3c60bdbf9ce2da337f776"
+  "prettier": {
+    "semi": false,
+    "printWidth": 100,
+    "bracketSpacing": false,
+    "singleQuote": true
+  }
 }

package/sanityClient.d.ts

@@ -1,5 +1,5 @@
 /* eslint-disable no-dupe-class-members, @typescript-eslint/no-misused-new */
-import Observable from '@sanity/observable/minimal'
+import type {Observable} from 'rxjs'
 
 export type AssetMetadataType =
   | 'location'
@@ -51,6 +51,7 @@ interface RawRequestOptions {
   timeout?: number
   proxy?: string
   body?: any
+  maxRedirects?: number
 }
 
 interface AuthProvider {
@@ -190,7 +191,6 @@ export type InsertPatch =
 export interface PatchOperations {
   set?: {[key: string]: any}
   setIfMissing?: {[key: string]: any}
-  merge?: {[key: string]: any}
   diffMatchPatch?: {[key: string]: any}
   unset?: string[]
   inc?: {[key: string]: number}
@@ -230,15 +230,6 @@ export class Patch {
    */
   clone(): Patch
 
-  /**
-   * DEPRECATED: Don't use.
-   * The operation is added to the current patch, ready to be commited by `commit()`
-   *
-   * @deprecated
-   * @param attrs Attributes to merge
-   */
-  merge(attrs: AttributeSet): this
-
   /**
    * DEPRECATED: Don't use.
    * The operation is added to the current patch, ready to be commited by `commit()`
@@ -512,16 +503,6 @@ export interface ClientConfig {
   ignoreBrowserTokenWarning?: boolean
   withCredentials?: boolean
 
-  /**
-   * @deprecated Don't use
-   */
-  gradientMode?: boolean
-
-  /**
-   * @deprecated Don't use
-   */
-  namespace?: string
-
   /**
    * @deprecated Don't use
    */