@sanity/client 3.2.2 → 4.0.0-alpha.esm.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +43 -26
- package/dist/browser/sanityClient.js +956 -0
- package/dist/node/sanityClient.js +969 -0
- package/lib/assets/assetsClient.js +132 -106
- package/lib/auth/authClient.js +38 -19
- package/lib/config.js +25 -13
- package/lib/data/dataMethods.js +35 -30
- package/lib/data/encodeQueryString.js +8 -2
- package/lib/data/listen.js +25 -21
- package/lib/data/patch.js +169 -118
- package/lib/data/transaction.js +134 -88
- package/lib/datasets/datasetsClient.js +63 -32
- package/lib/http/browserMiddleware.js +6 -1
- package/lib/http/errors.js +12 -8
- package/lib/http/nodeMiddleware.js +16 -9
- package/lib/http/queryString.js +9 -2
- package/lib/http/request.js +27 -24
- package/lib/http/requestOptions.js +10 -6
- package/lib/projects/projectsClient.js +37 -18
- package/lib/sanityClient.js +143 -105
- package/lib/users/usersClient.js +28 -11
- package/lib/util/defaults.js +12 -4
- package/lib/util/getSelection.js +7 -2
- package/lib/util/observable.js +24 -13
- package/lib/util/once.js +9 -2
- package/lib/util/pick.js +9 -2
- package/lib/validators.js +38 -15
- package/lib/warnings.js +14 -6
- package/package.json +22 -3
- package/sanityClient.d.ts +3 -13
- package/src/assets/assetsClient.js +132 -0
- package/src/auth/authClient.js +13 -0
- package/src/config.js +93 -0
- package/src/data/dataMethods.js +182 -0
- package/src/data/encodeQueryString.js +18 -0
- package/src/data/listen.js +159 -0
- package/src/data/patch.js +119 -0
- package/src/data/transaction.js +103 -0
- package/src/datasets/datasetsClient.js +28 -0
- package/src/http/browserMiddleware.js +1 -0
- package/src/http/errors.js +53 -0
- package/src/http/nodeMiddleware.js +11 -0
- package/src/http/queryString.js +10 -0
- package/src/http/request.js +50 -0
- package/src/http/requestOptions.js +29 -0
- package/src/projects/projectsClient.js +13 -0
- package/src/sanityClient.js +124 -0
- package/src/users/usersClient.js +9 -0
- package/src/util/defaults.js +9 -0
- package/src/util/getSelection.js +17 -0
- package/src/util/observable.js +6 -0
- package/src/util/once.js +12 -0
- package/src/util/pick.js +9 -0
- package/src/validators.js +76 -0
- package/src/warnings.js +25 -0
- package/test/client.test.js +188 -41
- package/test/encodeQueryString.test.js +3 -1
- package/test/helpers/sseServer.js +2 -1
- package/test/listen.test.js +4 -2
- package/test/warnings.test.disabled.js +8 -4
- package/umd/sanityClient.js +38 -38
- package/umd/sanityClient.min.js +1 -1
|
@@ -1,35 +1,66 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
function DatasetsClient(client) {
|
|
8
|
-
this.request = client.request.bind(client);
|
|
9
|
-
}
|
|
10
|
-
|
|
11
|
-
assign(DatasetsClient.prototype, {
|
|
12
|
-
create: function create(name, options) {
|
|
13
|
-
return this._modify('PUT', name, options);
|
|
14
|
-
},
|
|
15
|
-
edit: function edit(name, options) {
|
|
16
|
-
return this._modify('PATCH', name, options);
|
|
17
|
-
},
|
|
18
|
-
delete: function _delete(name) {
|
|
19
|
-
return this._modify('DELETE', name);
|
|
20
|
-
},
|
|
21
|
-
list: function list() {
|
|
22
|
-
return this.request({
|
|
23
|
-
uri: '/datasets'
|
|
24
|
-
});
|
|
25
|
-
},
|
|
26
|
-
_modify: function _modify(method, name, body) {
|
|
27
|
-
validate.dataset(name);
|
|
28
|
-
return this.request({
|
|
29
|
-
method: method,
|
|
30
|
-
uri: "/datasets/".concat(name),
|
|
31
|
-
body: body
|
|
32
|
-
});
|
|
33
|
-
}
|
|
3
|
+
function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
|
|
4
|
+
|
|
5
|
+
Object.defineProperty(exports, "__esModule", {
|
|
6
|
+
value: true
|
|
34
7
|
});
|
|
35
|
-
|
|
8
|
+
exports.DatasetsClient = void 0;
|
|
9
|
+
|
|
10
|
+
var validate = _interopRequireWildcard(require("../validators"));
|
|
11
|
+
|
|
12
|
+
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); }
|
|
13
|
+
|
|
14
|
+
function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
|
|
15
|
+
|
|
16
|
+
function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
|
|
17
|
+
|
|
18
|
+
function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
|
|
19
|
+
|
|
20
|
+
function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
|
|
21
|
+
|
|
22
|
+
var DatasetsClient = /*#__PURE__*/function () {
|
|
23
|
+
function DatasetsClient(client) {
|
|
24
|
+
_classCallCheck(this, DatasetsClient);
|
|
25
|
+
|
|
26
|
+
this.request = client.request.bind(client);
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
_createClass(DatasetsClient, [{
|
|
30
|
+
key: "create",
|
|
31
|
+
value: function create(name, options) {
|
|
32
|
+
return this._modify('PUT', name, options);
|
|
33
|
+
}
|
|
34
|
+
}, {
|
|
35
|
+
key: "edit",
|
|
36
|
+
value: function edit(name, options) {
|
|
37
|
+
return this._modify('PATCH', name, options);
|
|
38
|
+
}
|
|
39
|
+
}, {
|
|
40
|
+
key: "delete",
|
|
41
|
+
value: function _delete(name) {
|
|
42
|
+
return this._modify('DELETE', name);
|
|
43
|
+
}
|
|
44
|
+
}, {
|
|
45
|
+
key: "list",
|
|
46
|
+
value: function list() {
|
|
47
|
+
return this.request({
|
|
48
|
+
uri: '/datasets'
|
|
49
|
+
});
|
|
50
|
+
}
|
|
51
|
+
}, {
|
|
52
|
+
key: "_modify",
|
|
53
|
+
value: function _modify(method, name, body) {
|
|
54
|
+
validate.dataset(name);
|
|
55
|
+
return this.request({
|
|
56
|
+
method: method,
|
|
57
|
+
uri: "/datasets/".concat(name),
|
|
58
|
+
body: body
|
|
59
|
+
});
|
|
60
|
+
}
|
|
61
|
+
}]);
|
|
62
|
+
|
|
63
|
+
return DatasetsClient;
|
|
64
|
+
}();
|
|
65
|
+
|
|
66
|
+
exports.DatasetsClient = DatasetsClient;
|
package/lib/http/errors.js
CHANGED
|
@@ -1,19 +1,25 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Object.defineProperty(exports, "__esModule", {
|
|
4
|
+
value: true
|
|
5
|
+
});
|
|
6
|
+
exports.ClientError = ClientError;
|
|
7
|
+
exports.ServerError = ServerError;
|
|
8
|
+
|
|
9
|
+
var _makeError = _interopRequireDefault(require("make-error"));
|
|
4
10
|
|
|
5
|
-
|
|
11
|
+
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
|
|
6
12
|
|
|
7
13
|
function ClientError(res) {
|
|
8
14
|
var props = extractErrorProps(res);
|
|
9
15
|
ClientError.super.call(this, props.message);
|
|
10
|
-
assign(this, props);
|
|
16
|
+
Object.assign(this, props);
|
|
11
17
|
}
|
|
12
18
|
|
|
13
19
|
function ServerError(res) {
|
|
14
20
|
var props = extractErrorProps(res);
|
|
15
21
|
ServerError.super.call(this, props.message);
|
|
16
|
-
assign(this, props);
|
|
22
|
+
Object.assign(this, props);
|
|
17
23
|
}
|
|
18
24
|
|
|
19
25
|
function extractErrorProps(res) {
|
|
@@ -52,7 +58,5 @@ function stringifyBody(body, res) {
|
|
|
52
58
|
return isJson ? JSON.stringify(body, null, 2) : body;
|
|
53
59
|
}
|
|
54
60
|
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
exports.ClientError = ClientError;
|
|
58
|
-
exports.ServerError = ServerError;
|
|
61
|
+
(0, _makeError.default)(ClientError);
|
|
62
|
+
(0, _makeError.default)(ServerError);
|
|
@@ -1,19 +1,26 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Object.defineProperty(exports, "__esModule", {
|
|
4
|
+
value: true
|
|
5
|
+
});
|
|
6
|
+
exports.middleware = void 0;
|
|
4
7
|
|
|
5
|
-
var
|
|
8
|
+
var _retry = _interopRequireDefault(require("get-it/lib-node/middleware/retry"));
|
|
6
9
|
|
|
7
|
-
var
|
|
10
|
+
var _debug = _interopRequireDefault(require("get-it/lib-node/middleware/debug"));
|
|
8
11
|
|
|
9
|
-
var
|
|
12
|
+
var _headers = _interopRequireDefault(require("get-it/lib-node/middleware/headers"));
|
|
10
13
|
|
|
11
|
-
var
|
|
14
|
+
var _package = require("../../package.json");
|
|
15
|
+
|
|
16
|
+
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
|
|
17
|
+
|
|
18
|
+
var middleware = [(0, _debug.default)({
|
|
12
19
|
verbose: true,
|
|
13
20
|
namespace: 'sanity:client'
|
|
14
|
-
}),
|
|
15
|
-
'User-Agent': "".concat(
|
|
16
|
-
}),
|
|
21
|
+
}), (0, _headers.default)({
|
|
22
|
+
'User-Agent': "".concat(_package.name, " ").concat(_package.version)
|
|
23
|
+
}), (0, _retry.default)({
|
|
17
24
|
maxRetries: 3
|
|
18
25
|
})];
|
|
19
|
-
|
|
26
|
+
exports.middleware = middleware;
|
package/lib/http/queryString.js
CHANGED
|
@@ -1,6 +1,11 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Object.defineProperty(exports, "__esModule", {
|
|
4
|
+
value: true
|
|
5
|
+
});
|
|
6
|
+
exports.queryString = void 0;
|
|
7
|
+
|
|
8
|
+
var queryString = function queryString(params) {
|
|
4
9
|
var qs = [];
|
|
5
10
|
|
|
6
11
|
for (var key in params) {
|
|
@@ -10,4 +15,6 @@ module.exports = function (params) {
|
|
|
10
15
|
}
|
|
11
16
|
|
|
12
17
|
return qs.length > 0 ? "?".concat(qs.join('&')) : '';
|
|
13
|
-
};
|
|
18
|
+
};
|
|
19
|
+
|
|
20
|
+
exports.queryString = queryString;
|
package/lib/http/request.js
CHANGED
|
@@ -1,31 +1,36 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
3
|
+
Object.defineProperty(exports, "__esModule", {
|
|
4
|
+
value: true
|
|
5
|
+
});
|
|
6
|
+
exports.httpRequest = httpRequest;
|
|
7
|
+
|
|
8
|
+
var _getIt = _interopRequireDefault(require("get-it"));
|
|
5
9
|
|
|
6
|
-
var
|
|
10
|
+
var _observable = _interopRequireDefault(require("get-it/lib/middleware/observable"));
|
|
7
11
|
|
|
8
|
-
var
|
|
12
|
+
var _jsonRequest = _interopRequireDefault(require("get-it/lib/middleware/jsonRequest"));
|
|
9
13
|
|
|
10
|
-
var
|
|
14
|
+
var _jsonResponse = _interopRequireDefault(require("get-it/lib/middleware/jsonResponse"));
|
|
11
15
|
|
|
12
|
-
var
|
|
16
|
+
var _progress = _interopRequireDefault(require("get-it/lib/middleware/progress"));
|
|
13
17
|
|
|
14
|
-
var
|
|
18
|
+
var _observable2 = require("../util/observable");
|
|
15
19
|
|
|
16
|
-
var
|
|
17
|
-
Observable = _require.Observable;
|
|
20
|
+
var _errors = require("./errors");
|
|
18
21
|
|
|
19
|
-
var
|
|
20
|
-
ClientError = _require2.ClientError,
|
|
21
|
-
ServerError = _require2.ServerError;
|
|
22
|
+
var _nodeMiddleware = require("./nodeMiddleware");
|
|
22
23
|
|
|
24
|
+
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
|
|
25
|
+
|
|
26
|
+
/* eslint-disable no-empty-function, no-process-env */
|
|
27
|
+
// Environment-specific middleware.
|
|
23
28
|
var httpError = {
|
|
24
29
|
onResponse: function onResponse(res) {
|
|
25
30
|
if (res.statusCode >= 500) {
|
|
26
|
-
throw new ServerError(res);
|
|
31
|
+
throw new _errors.ServerError(res);
|
|
27
32
|
} else if (res.statusCode >= 400) {
|
|
28
|
-
throw new ClientError(res);
|
|
33
|
+
throw new _errors.ClientError(res);
|
|
29
34
|
}
|
|
30
35
|
|
|
31
36
|
return res;
|
|
@@ -41,23 +46,21 @@ var printWarnings = {
|
|
|
41
46
|
|
|
42
47
|
return res;
|
|
43
48
|
}
|
|
44
|
-
};
|
|
45
|
-
|
|
46
|
-
var envSpecific = require('./nodeMiddleware');
|
|
49
|
+
};
|
|
47
50
|
|
|
48
|
-
var middleware =
|
|
49
|
-
implementation: Observable
|
|
51
|
+
var middleware = _nodeMiddleware.middleware.concat([printWarnings, (0, _jsonRequest.default)(), (0, _jsonResponse.default)(), (0, _progress.default)(), httpError, (0, _observable.default)({
|
|
52
|
+
implementation: _observable2.Observable
|
|
50
53
|
})]);
|
|
51
|
-
|
|
54
|
+
|
|
55
|
+
var request = (0, _getIt.default)(middleware);
|
|
52
56
|
|
|
53
57
|
function httpRequest(options) {
|
|
54
58
|
var requester = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : request;
|
|
55
|
-
return requester(assign({
|
|
59
|
+
return requester(Object.assign({
|
|
56
60
|
maxRedirects: 0
|
|
57
61
|
}, options));
|
|
58
62
|
}
|
|
59
63
|
|
|
60
64
|
httpRequest.defaultRequester = request;
|
|
61
|
-
httpRequest.ClientError = ClientError;
|
|
62
|
-
httpRequest.ServerError = ServerError;
|
|
63
|
-
module.exports = httpRequest;
|
|
65
|
+
httpRequest.ClientError = _errors.ClientError;
|
|
66
|
+
httpRequest.ServerError = _errors.ServerError;
|
|
@@ -1,10 +1,12 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
3
|
+
Object.defineProperty(exports, "__esModule", {
|
|
4
|
+
value: true
|
|
5
|
+
});
|
|
6
|
+
exports.requestOptions = void 0;
|
|
5
7
|
var projectHeader = 'X-Sanity-Project-ID';
|
|
6
8
|
|
|
7
|
-
|
|
9
|
+
var requestOptions = function requestOptions(config) {
|
|
8
10
|
var overrides = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
|
|
9
11
|
var headers = {};
|
|
10
12
|
var token = overrides.token || config.token;
|
|
@@ -19,11 +21,13 @@ module.exports = function (config) {
|
|
|
19
21
|
|
|
20
22
|
var withCredentials = Boolean(typeof overrides.withCredentials === 'undefined' ? config.token || config.withCredentials : overrides.withCredentials);
|
|
21
23
|
var timeout = typeof overrides.timeout === 'undefined' ? config.timeout : overrides.timeout;
|
|
22
|
-
return assign({}, overrides, {
|
|
23
|
-
headers: assign({}, headers, overrides.headers || {}),
|
|
24
|
+
return Object.assign({}, overrides, {
|
|
25
|
+
headers: Object.assign({}, headers, overrides.headers || {}),
|
|
24
26
|
timeout: typeof timeout === 'undefined' ? 5 * 60 * 1000 : timeout,
|
|
25
27
|
proxy: overrides.proxy || config.proxy,
|
|
26
28
|
json: true,
|
|
27
29
|
withCredentials: withCredentials
|
|
28
30
|
});
|
|
29
|
-
};
|
|
31
|
+
};
|
|
32
|
+
|
|
33
|
+
exports.requestOptions = requestOptions;
|
|
@@ -1,21 +1,40 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
function ProjectsClient(client) {
|
|
6
|
-
this.client = client;
|
|
7
|
-
}
|
|
8
|
-
|
|
9
|
-
assign(ProjectsClient.prototype, {
|
|
10
|
-
list: function list() {
|
|
11
|
-
return this.client.request({
|
|
12
|
-
uri: '/projects'
|
|
13
|
-
});
|
|
14
|
-
},
|
|
15
|
-
getById: function getById(id) {
|
|
16
|
-
return this.client.request({
|
|
17
|
-
uri: "/projects/".concat(id)
|
|
18
|
-
});
|
|
19
|
-
}
|
|
3
|
+
Object.defineProperty(exports, "__esModule", {
|
|
4
|
+
value: true
|
|
20
5
|
});
|
|
21
|
-
|
|
6
|
+
exports.ProjectsClient = void 0;
|
|
7
|
+
|
|
8
|
+
function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
|
|
9
|
+
|
|
10
|
+
function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
|
|
11
|
+
|
|
12
|
+
function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
|
|
13
|
+
|
|
14
|
+
var ProjectsClient = /*#__PURE__*/function () {
|
|
15
|
+
function ProjectsClient(client) {
|
|
16
|
+
_classCallCheck(this, ProjectsClient);
|
|
17
|
+
|
|
18
|
+
this.client = client;
|
|
19
|
+
}
|
|
20
|
+
|
|
21
|
+
_createClass(ProjectsClient, [{
|
|
22
|
+
key: "list",
|
|
23
|
+
value: function list() {
|
|
24
|
+
return this.client.request({
|
|
25
|
+
uri: '/projects'
|
|
26
|
+
});
|
|
27
|
+
}
|
|
28
|
+
}, {
|
|
29
|
+
key: "getById",
|
|
30
|
+
value: function getById(id) {
|
|
31
|
+
return this.client.request({
|
|
32
|
+
uri: "/projects/".concat(id)
|
|
33
|
+
});
|
|
34
|
+
}
|
|
35
|
+
}]);
|
|
36
|
+
|
|
37
|
+
return ProjectsClient;
|
|
38
|
+
}();
|
|
39
|
+
|
|
40
|
+
exports.ProjectsClient = ProjectsClient;
|