@sanity/client 3.3.1 → 3.3.3-esm.1

package/lib/sanityClient.js

@@ -1,13 +1,15 @@
 "use strict";
 
+var _objectAssign = _interopRequireDefault(require("object-assign"));
+
+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; }
 
-var assign = require('object-assign');
-
 var _require = require('./util/observable'),
     Observable = _require.Observable,
     map = _require.map,
@@ -58,25 +60,25 @@ function SanityClient() {
   this.auth = new AuthClient(this);
 
   if (this.clientConfig.isPromiseAPI) {
-    var observableConfig = assign({}, this.clientConfig, {
+    var observableConfig = (0, _objectAssign.default)({}, this.clientConfig, {
       isPromiseAPI: false
     });
     this.observable = new SanityClient(observableConfig);
   }
 }
 
-assign(SanityClient.prototype, dataMethods);
-assign(SanityClient.prototype, {
+(0, _objectAssign.default)(SanityClient.prototype, dataMethods);
+(0, _objectAssign.default)(SanityClient.prototype, {
   clone: function clone() {
     return new SanityClient(this.config());
   },
   config: function config(newConfig) {
     if (typeof newConfig === 'undefined') {
-      return assign({}, this.clientConfig);
+      return (0, _objectAssign.default)({}, this.clientConfig);
     }
 
     if (this.observable) {
-      var observableConfig = assign({}, newConfig, {
+      var observableConfig = (0, _objectAssign.default)({}, newConfig, {
         isPromiseAPI: false
       });
       this.observable.config(observableConfig);
@@ -112,7 +114,7 @@ assign(SanityClient.prototype, {
       }, options.query);
     }
 
-    var reqOptions = getRequestOptions(this.clientConfig, assign({}, options, {
+    var reqOptions = getRequestOptions(this.clientConfig, (0, _objectAssign.default)({}, options, {
       url: this.getUrl(uri, useCdn)
     }));
     return new Observable(function (subscriber) {

package/lib/users/usersClient.js

@@ -1,12 +1,14 @@
 "use strict";
 
-var assign = require('object-assign');
+var _objectAssign = _interopRequireDefault(require("object-assign"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 function UsersClient(client) {
   this.client = client;
 }
 
-assign(UsersClient.prototype, {
+(0, _objectAssign.default)(UsersClient.prototype, {
   getById: function getById(id) {
     return this.client.request({
       uri: "/users/".concat(id)

package/lib/util/observable.js

@@ -1,18 +1,15 @@
 "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 _Observable = require("rxjs/internal/Observable");
 
-var _require2 = require('rxjs/internal/operators/filter'),
-    filter = _require2.filter;
+var _filter = require("rxjs/internal/operators/filter");
 
-var _require3 = require('rxjs/internal/operators/map'),
-    map = _require3.map;
+var _map = require("rxjs/internal/operators/map");
 
+//  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
 module.exports = {
-  Observable: Observable,
-  filter: filter,
-  map: map
+  Observable: _Observable.Observable,
+  filter: _filter.filter,
+  map: _map.map
 };

package/lib/warnings.js

@@ -1,6 +1,6 @@
 "use strict";
 
-var generateHelpUrl = require('@sanity/generate-help-url').generateHelpUrl;
+var generateHelpUrl = require('./generateHelpUrl');
 
 var once = require('./util/once');
 

package/package.json

@@ -1,22 +1,41 @@
 {
   "name": "@sanity/client",
-  "version": "3.3.1",
+  "version": "3.3.3-esm.1",
   "description": "Client for retrieving, creating and patching data from Sanity.io",
+  "type": "commonjs",
   "main": "lib/sanityClient.js",
   "umd": "umd/sanityClient.min.js",
   "unpkg": "umd/sanityClient.min.js",
   "types": "./sanityClient.d.ts",
+  "exports": {
+    ".": {
+      "source": "./src/sanityClient.js",
+      "types": "./sanityClient.d.ts",
+      "browser": "./dist/sanityClient.browser.mjs",
+      "deno": "./dist/sanityClient.browser.mjs",
+      "default": "./lib/sanityClient.js"
+    }
+  },
+  "files": [
+    "dist",
+    "lib",
+    "umd",
+    "sanityClient.d.ts"
+  ],
   "scripts": {
     "browserify": "NODE_ENV=production BROWSERIFY_ENV=build DEBUG='' browserify -t envify -g uglifyify lib/sanityClient.js -o umd/sanityClient.js --standalone=SanityClient",
     "compile": "babel -d lib src",
-    "build": "npm run compile && npm run browserify && npm run minify",
+    "build": "npm run compile && npm run browserify && npm run minify && npm run esbuild:browser",
+    "esbuild": "esbuild src/sanityClient.js --bundle --sourcemap --external:object-assign --external:rxjs --external:@sanity/eventsource --external:get-it --external:make-error",
+    "esbuild:browser": "npm run esbuild -- --format=esm --outfile=dist/sanityClient.browser.mjs --platform=browser",
     "lint": "eslint .",
-    "clean": "rimraf lib coverage .nyc_output umd/*.js",
+    "clean": "rimraf dist lib coverage .nyc_output umd/*.js",
+    "typecheck": "tsc --lib es2015 --lib dom,es2015  --noEmit sanityClient.d.ts",
     "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",
+    "prepublishOnly": "npm run clean && npm run build",
     "test": "NODE_ENV=test tape test/*.test.js",
-    "posttest": "npm run lint"
+    "posttest": "npm run lint && npm run typecheck"
   },
   "browser": {
     "./src/http/nodeMiddleware.js": "./src/http/browserMiddleware.js",
@@ -27,29 +46,31 @@
   },
   "dependencies": {
     "@sanity/eventsource": "^4.0.0",
-    "@sanity/generate-help-url": "^3.0.0",
-    "get-it": "^6.0.1",
+    "get-it": "^6.1.1",
     "make-error": "^1.3.0",
     "object-assign": "^4.1.1",
     "rxjs": "^6.0.0"
   },
   "devDependencies": {
-    "@babel/cli": "^7.17.6",
-    "@babel/core": "^7.17.7",
-    "@babel/preset-env": "^7.11.5",
+    "@babel/cli": "^7.18.10",
+    "@babel/core": "^7.18.10",
+    "@babel/preset-env": "^7.18.10",
+    "@types/node": "^16.11.49",
     "browserify": "^17.0.0",
     "envify": "^4.0.0",
-    "eslint": "^8.11.0",
+    "esbuild": "^0.15.5",
+    "eslint": "^8.21.0",
     "eslint-config-prettier": "^8.5.0",
-    "eslint-config-sanity": "^5.1.0",
-    "nock": "^13.2.4",
+    "eslint-config-sanity": "^6.0.0",
+    "nock": "^13.2.9",
     "nyc": "^15.1.0",
-    "prettier": "^2.6.0",
+    "prettier": "^2.7.1",
     "rimraf": "^3.0.2",
     "sse-channel": "^4.0.0",
-    "tape": "^5.5.2",
+    "tape": "^5.5.3",
     "terser": "^5.12.1",
-    "uglifyify": "^5.0.1",
+    "typescript": "^4.7.4",
+    "uglifyify": "^5.0.0",
     "xtend": "4.0.2"
   },
   "repository": {

package/sanityClient.d.ts

@@ -12,6 +12,7 @@ export type AssetMetadataType =
 export type DatasetAclMode = 'public' | 'private' | 'custom'
 export type ListenVisibility = 'sync' | 'async' | 'query'
 export type ListenEventName = 'mutation' | 'welcome' | 'reconnect'
+export type MutationOperation = 'create' | 'delete' | 'update' | 'none'
 
 export interface ResponseEvent<T = unknown> {
   type: 'response'
@@ -214,23 +215,16 @@ export type Mutation<R = any> =
 export interface SingleMutationResult {
   transactionId: string
   documentId: string
-  results: {id: string}[]
+  results: {id: string; operation: MutationOperation}[]
 }
 
 export interface MultipleMutationResult {
   transactionId: string
   documentIds: string[]
-  results: {id: string}[]
+  results: {id: string; operation: MutationOperation}[]
 }
 
-export class Patch {
-  constructor(documentId: string, operations?: PatchOperations, client?: SanityClient)
-
-  /**
-   * Clones the patch
-   */
-  clone(): Patch
-
+export abstract class BasePatch {
   /**
    * DEPRECATED: Don't use.
    * The operation is added to the current patch, ready to be commited by `commit()`
@@ -338,6 +332,20 @@ export class Patch {
    */
   toJSON(): PatchMutationOperation
 
+  /**
+   * Clears the patch of all operations
+   */
+  reset(): this
+}
+
+export class Patch extends BasePatch {
+  constructor(documentId: string, operations?: PatchOperations, client?: SanityClient)
+
+  /**
+   * Clones the patch
+   */
+  clone(): Patch
+
   /**
    * Commit the patch, returning a promise that resolves to the first patched document
    *
@@ -372,17 +380,53 @@ export class Patch {
    * @param options Options for the mutation operation
    */
   commit<R = any>(options?: BaseMutationOptions): Promise<SanityDocument<R>>
+}
+
+export class ObservablePatch extends BasePatch {
+  constructor(documentId: string, operations?: PatchOperations, client?: ObservableSanityClient)
 
   /**
-   * Clears the patch of all operations
+   * Clones the patch
    */
-  reset(): this
-}
+  clone(): ObservablePatch
 
-export class Transaction {
-  constructor(operations?: Mutation[], client?: SanityClient, transactionId?: string)
-  clone(): Transaction
+  /**
+   * Commit the patch, returning an observable that produces the first patched document
+   *
+   * @param options Options for the mutation operation
+   */
+  commit<R = any>(options: FirstDocumentMutationOptions): Observable<SanityDocument<R>>
+
+  /**
+   * Commit the patch, returning an observable that produces an array of the mutated documents
+   *
+   * @param options Options for the mutation operation
+   */
+  commit<R = any>(options: AllDocumentsMutationOptions): Observable<SanityDocument<R>[]>
+
+  /**
+   * Commit the patch, returning an observable that produces a mutation result object
+   *
+   * @param options Options for the mutation operation
+   */
+  commit(options: FirstDocumentIdMutationOptions): Observable<SingleMutationResult>
+
+  /**
+   * Commit the patch, returning an observable that produces a mutation result object
+   *
+   * @param options Options for the mutation operation
+   */
+  commit(options: AllDocumentIdsMutationOptions): Observable<MultipleMutationResult>
+
+  /**
+   * Commit the patch, returning an observable that produces the first patched document
+   *
+   * @param options Options for the mutation operation
+   */
+  commit<R = any>(options?: BaseMutationOptions): Observable<SanityDocument<R>>
+}
 
+export abstract class BaseTransaction {
   /**
    * Creates a new Sanity document. If `_id` is provided and already exists, the mutation will fail. If no `_id` is given, one will automatically be generated by the database.
    * The operation is added to the current transaction, ready to be commited by `commit()`
@@ -451,6 +495,20 @@ export class Transaction {
    */
   toJSON(): Mutation[]
 
+  /**
+   * Clears the transaction of all operations
+   */
+  reset(): this
+}
+
+export class Transaction extends BaseTransaction {
+  constructor(operations?: Mutation[], client?: SanityClient, transactionId?: string)
+
+  /**
+   * Clones the transaction
+   */
+  clone(): Transaction
+
   /**
    * Commit the transaction, returning a promise that resolves to the first mutated document
    *
@@ -485,11 +543,50 @@ export class Transaction {
    * @param options Options for the mutation operation
    */
   commit(options?: BaseMutationOptions): Promise<MultipleMutationResult>
+}
+
+export class ObservableTransaction {
+  constructor(operations?: Mutation[], client?: ObservableSanityClient, transactionId?: string)
 
   /**
-   * Clears the transaction of all operations
+   * Clones the transaction
    */
-  reset(): this
+  clone(): ObservableTransaction
+
+  /**
+   * Commit the transaction, returning an observable that produces the first mutated document
+   *
+   * @param options Options for the mutation operation
+   */
+  commit<R>(options: TransactionFirstDocumentMutationOptions): Observable<SanityDocument<R>>
+
+  /**
+   * Commit the transaction, returning an observable that produces an array of the mutated documents
+   *
+   * @param options Options for the mutation operation
+   */
+  commit<R>(options: TransactionAllDocumentsMutationOptions): Observable<SanityDocument<R>[]>
+
+  /**
+   * Commit the transaction, returning an observable that produces a mutation result object
+   *
+   * @param options Options for the mutation operation
+   */
+  commit(options: TransactionFirstDocumentIdMutationOptions): Observable<SingleMutationResult>
+
+  /**
+   * Commit the transaction, returning an observable that produces a mutation result object
+   *
+   * @param options Options for the mutation operation
+   */
+  commit(options: TransactionAllDocumentIdsMutationOptions): Observable<MultipleMutationResult>
+
+  /**
+   * Commit the transaction, returning an observable that produces a mutation result object
+   *
+   * @param options Options for the mutation operation
+   */
+  commit(options?: BaseMutationOptions): Observable<MultipleMutationResult>
 }
 
 export interface ClientConfig {
@@ -1384,14 +1481,14 @@ export class ObservableSanityClient {
    * @param documentId Document ID to patch
    * @param operations Optional object of patch operations to initialize the patch instance with
    */
-  patch(documentId: string | MutationSelection, operations?: PatchOperations): Patch
+  patch(documentId: string | MutationSelection, operations?: PatchOperations): ObservablePatch
 
   /**
    * Create a new transaction of mutations
    *
    * @param operations Optional array of mutation operations to initialize the transaction instance with
    */
-  transaction<R = any>(operations?: Mutation<R>[]): Transaction
+  transaction<R = any>(operations?: Mutation<R>[]): ObservableTransaction
 
   // "Internals", should generally not be used externally
   /**