@sanity/client 3.3.2 → 3.3.3-esm.10

package/lib/warnings.js

@@ -1,12 +1,19 @@
 "use strict";
 
-var generateHelpUrl = require('@sanity/generate-help-url').generateHelpUrl;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.printNoApiVersionSpecifiedWarning = exports.printCdnWarning = exports.printBrowserTokenWarning = void 0;
 
-var once = require('./util/once');
+var _generateHelpUrl = _interopRequireDefault(require("./generateHelpUrl"));
+
+var _once = _interopRequireDefault(require("./util/once"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 var createWarningPrinter = function createWarningPrinter(message) {
   return (// eslint-disable-next-line no-console
-    once(function () {
+    (0, _once.default)(function () {
       var _console;
 
       for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
@@ -18,6 +25,9 @@ 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.printNoApiVersionSpecifiedWarning = createWarningPrinter(['Using the Sanity client without specifying an API version is deprecated.', "See ".concat(generateHelpUrl('js-client-api-version'))]);
+var 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((0, _generateHelpUrl.default)('js-client-cdn-configuration'), "."), 'To hide this warning, please set the `useCdn` option to either `true` or `false` when creating', 'the client.']);
+exports.printCdnWarning = printCdnWarning;
+var printBrowserTokenWarning = createWarningPrinter(['You have configured Sanity client to use a token in the browser. This may cause unintentional security issues.', "See ".concat((0, _generateHelpUrl.default)('js-client-browser-token'), " for more information and how to hide this warning.")]);
+exports.printBrowserTokenWarning = printBrowserTokenWarning;
+var printNoApiVersionSpecifiedWarning = createWarningPrinter(['Using the Sanity client without specifying an API version is deprecated.', "See ".concat((0, _generateHelpUrl.default)('js-client-api-version'))]);
+exports.printNoApiVersionSpecifiedWarning = printNoApiVersionSpecifiedWarning;

package/package.json

@@ -1,22 +1,43 @@
 {
   "name": "@sanity/client",
-  "version": "3.3.2",
+  "version": "3.3.3-esm.10",
   "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"
+    },
+    "./package.json": "./package.json"
+  },
+  "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:get-it",
+    "esbuild-when-upstream-deps-works-in-deno-cloudflare-and-vercel": "esbuild src/sanityClient.js --bundle --sourcemap --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",
-    "test": "NODE_ENV=test tape test/*.test.js",
-    "posttest": "npm run lint"
+    "prepublishOnly": "npm run clean && npm run build",
+    "test": "NODE_ENV=test babel-tape-runner test/*.test.js",
+    "posttest": "npm run lint && npm run typecheck"
   },
   "browser": {
     "./src/http/nodeMiddleware.js": "./src/http/browserMiddleware.js",
@@ -27,29 +48,34 @@
   },
   "dependencies": {
     "@sanity/eventsource": "^4.0.0",
-    "@sanity/generate-help-url": "^3.0.0",
-    "get-it": "^6.0.1",
+    "get-it": "6.1.1-esm.8",
     "make-error": "^1.3.0",
-    "object-assign": "^4.1.1",
-    "rxjs": "^6.0.0"
+    "rxjs": "^6.6.7"
   },
   "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/plugin-transform-object-assign": "^7.18.6",
+    "@babel/preset-env": "^7.18.10",
+    "@types/node": "^16.11.49",
+    "babel-plugin-add-module-exports": "^1.0.4",
+    "babel-plugin-istanbul": "^6.1.1",
+    "babel-tape-runner": "^3.0.0",
     "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

@@ -224,14 +224,7 @@ export interface MultipleMutationResult {
   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()`
@@ -339,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
    *
@@ -373,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()`
@@ -452,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
    *
@@ -486,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 {
@@ -1385,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
   /**