@contentful/field-editor-shared 2.17.0 → 2.17.1

package/dist/cjs/index.js

@@ -75,6 +75,9 @@ _export(exports, {
     PredefinedValuesError: function() {
         return _PredefinedValuesError.PredefinedValuesError;
     },
+    SharedQueryClientProvider: function() {
+        return _queryClient.SharedQueryClientProvider;
+    },
     SpaceAPI: function() {
         return _appsdk.SpaceAPI;
     },
@@ -92,6 +95,12 @@ _export(exports, {
     },
     toLocaleString: function() {
         return _shortenStorageUnit.toLocaleString;
+    },
+    useQuery: function() {
+        return _queryClient.useQuery;
+    },
+    useQueryClient: function() {
+        return _queryClient.useQueryClient;
     }
 });
 const _ModalDialogLauncher = /*#__PURE__*/ _interop_require_wildcard(require("./ModalDialogLauncher"));
@@ -113,6 +122,7 @@ _export_star(require("./ReleaseEntityStatusBadge"), exports);
 _export_star(require("./utils/determineReleaseAction"), exports);
 _export_star(require("./utils/getEntityReleaseStatus"), exports);
 _export_star(require("./utils/getReleaseStatusBadgeConfig"), exports);
+const _queryClient = require("./queryClient");
 function _export_star(from, to) {
     Object.keys(from).forEach(function(k) {
         if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) {

package/dist/cjs/queryClient.js

@@ -0,0 +1,123 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: all[name]
+    });
+}
+_export(exports, {
+    SharedQueryClientProvider: function() {
+        return SharedQueryClientProvider;
+    },
+    useQuery: function() {
+        return useQuery;
+    },
+    useQueryClient: function() {
+        return useQueryClient;
+    }
+});
+const _react = /*#__PURE__*/ _interop_require_wildcard(require("react"));
+function _getRequireWildcardCache(nodeInterop) {
+    if (typeof WeakMap !== "function") return null;
+    var cacheBabelInterop = new WeakMap();
+    var cacheNodeInterop = new WeakMap();
+    return (_getRequireWildcardCache = function(nodeInterop) {
+        return nodeInterop ? cacheNodeInterop : cacheBabelInterop;
+    })(nodeInterop);
+}
+function _interop_require_wildcard(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 = {
+        __proto__: null
+    };
+    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;
+}
+let RQQueryClient;
+let useRQ;
+let useHostQueryClient = ()=>undefined;
+try {
+    const rq = require('@tanstack/react-query');
+    RQQueryClient = rq.QueryClient;
+    useRQ = rq.useQuery;
+    useHostQueryClient = rq.useQueryClient;
+} catch  {}
+const clientContext = /*#__PURE__*/ _react.createContext(undefined);
+function useMaybeHostQueryClient() {
+    try {
+        return useHostQueryClient();
+    } catch  {
+        return undefined;
+    }
+}
+function useQueryClient() {
+    const client = _react.useContext(clientContext);
+    const hostClient = useMaybeHostQueryClient();
+    return _react.useMemo(()=>{
+        if (client) {
+            return client;
+        }
+        if (hostClient) return hostClient;
+        if (!RQQueryClient) {
+            throw new Error('@tanstack/react-query is required to use QueryClient. Please install it as a dependency: npm install @tanstack/react-query');
+        }
+        return new RQQueryClient({
+            defaultOptions: {
+                queries: {
+                    useErrorBoundary: false,
+                    refetchOnWindowFocus: false,
+                    refetchOnReconnect: true,
+                    refetchOnMount: false,
+                    staleTime: Infinity,
+                    retry: false
+                }
+            }
+        });
+    }, [
+        client,
+        hostClient
+    ]);
+}
+function useQuery(queryKey, queryFn, options) {
+    if (!useRQ) {
+        throw new Error('@tanstack/react-query is required to use useQuery. Please install it as a dependency: npm install @tanstack/react-query');
+    }
+    return useRQ(queryKey, queryFn, {
+        ...options,
+        context: clientContext
+    });
+}
+function SharedQueryClientProvider({ children }) {
+    const client = useQueryClient();
+    return /*#__PURE__*/ _react.createElement(clientContext.Provider, {
+        value: client
+    }, children);
+}

package/dist/esm/index.js

@@ -17,3 +17,4 @@ export * from './ReleaseEntityStatusBadge';
 export * from './utils/determineReleaseAction';
 export * from './utils/getEntityReleaseStatus';
 export * from './utils/getReleaseStatusBadgeConfig';
+export { SharedQueryClientProvider, useQueryClient, useQuery } from './queryClient';

package/dist/esm/queryClient.js

@@ -0,0 +1,61 @@
+import * as React from 'react';
+let RQQueryClient;
+let useRQ;
+let useHostQueryClient = ()=>undefined;
+try {
+    const rq = require('@tanstack/react-query');
+    RQQueryClient = rq.QueryClient;
+    useRQ = rq.useQuery;
+    useHostQueryClient = rq.useQueryClient;
+} catch  {}
+const clientContext = /*#__PURE__*/ React.createContext(undefined);
+function useMaybeHostQueryClient() {
+    try {
+        return useHostQueryClient();
+    } catch  {
+        return undefined;
+    }
+}
+export function useQueryClient() {
+    const client = React.useContext(clientContext);
+    const hostClient = useMaybeHostQueryClient();
+    return React.useMemo(()=>{
+        if (client) {
+            return client;
+        }
+        if (hostClient) return hostClient;
+        if (!RQQueryClient) {
+            throw new Error('@tanstack/react-query is required to use QueryClient. Please install it as a dependency: npm install @tanstack/react-query');
+        }
+        return new RQQueryClient({
+            defaultOptions: {
+                queries: {
+                    useErrorBoundary: false,
+                    refetchOnWindowFocus: false,
+                    refetchOnReconnect: true,
+                    refetchOnMount: false,
+                    staleTime: Infinity,
+                    retry: false
+                }
+            }
+        });
+    }, [
+        client,
+        hostClient
+    ]);
+}
+export function useQuery(queryKey, queryFn, options) {
+    if (!useRQ) {
+        throw new Error('@tanstack/react-query is required to use useQuery. Please install it as a dependency: npm install @tanstack/react-query');
+    }
+    return useRQ(queryKey, queryFn, {
+        ...options,
+        context: clientContext
+    });
+}
+export function SharedQueryClientProvider({ children }) {
+    const client = useQueryClient();
+    return /*#__PURE__*/ React.createElement(clientContext.Provider, {
+        value: client
+    }, children);
+}

package/dist/types/index.d.ts

@@ -19,3 +19,4 @@ export * from './ReleaseEntityStatusBadge';
 export * from './utils/determineReleaseAction';
 export * from './utils/getEntityReleaseStatus';
 export * from './utils/getReleaseStatusBadgeConfig';
+export { SharedQueryClientProvider, useQueryClient, useQuery } from './queryClient';

package/dist/types/queryClient.d.ts

@@ -0,0 +1,9 @@
+import * as React from 'react';
+import type { QueryClient, UseQueryOptions, UseQueryResult, QueryKey, QueryFunction } from '@tanstack/react-query';
+export declare function useQueryClient(): QueryClient;
+export declare function useQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(queryKey: TQueryKey, queryFn: QueryFunction<TQueryFnData, TQueryKey>, options?: Omit<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'queryKey' | 'queryFn'>): UseQueryResult<TData, TError>;
+/**
+ * Provides access to a query client either by sharing an existing client or
+ * creating a new one.
+ */
+export declare function SharedQueryClientProvider({ children }: React.PropsWithChildren<{}>): React.JSX.Element;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentful/field-editor-shared",
-  "version": "2.17.0",
+  "version": "2.17.1",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "types": "dist/types/index.d.ts",
@@ -39,6 +39,7 @@
     "@contentful/app-sdk": "^4.42.0",
     "@contentful/field-editor-test-utils": "^1.7.0",
     "@lingui/core": "5.3.0",
+    "@tanstack/react-query": "^4.3.9",
     "@testing-library/react": "16.3.0"
   },
   "dependencies": {
@@ -54,11 +55,17 @@
   "peerDependencies": {
     "@contentful/app-sdk": "^4.29.0",
     "@lingui/core": "^5.3.0",
+    "@tanstack/react-query": "^4.3.9",
     "react": ">=16.8.0",
     "react-dom": ">=16.8.0"
   },
+  "peerDependenciesMeta": {
+    "@tanstack/react-query": {
+      "optional": true
+    }
+  },
   "publishConfig": {
     "registry": "https://npm.pkg.github.com/"
   },
-  "gitHead": "c85b1e8cd6772eb796ed2b22ebb778c717f4a7f4"
+  "gitHead": "c8fbf95fbb880df05fd011b8892523c135c2a5fd"
 }