@graphql-hive/core 0.16.0 → 0.17.0

package/cjs/client/agent.js

@@ -4,16 +4,12 @@ exports.createAgent = createAgent;
 const tslib_1 = require("tslib");
 const circuit_js_1 = tslib_1.__importDefault(require("../circuit-breaker/circuit.js"));
 const version_js_1 = require("../version.js");
+const circuit_breaker_js_1 = require("./circuit-breaker.js");
 const http_client_js_1 = require("./http-client.js");
 const utils_js_1 = require("./utils.js");
-const defaultCircuitBreakerConfiguration = {
-    errorThresholdPercentage: 50,
-    volumeThreshold: 10,
-    resetTimeout: 30000,
-};
 function createAgent(pluginOptions, { data, body, headers = () => ({}), }) {
     const options = Object.assign(Object.assign({ timeout: 30000, enabled: true, minTimeout: 200, maxRetries: 3, sendInterval: 10000, maxSize: 25, name: 'hive-client', version: version_js_1.version }, pluginOptions), { circuitBreaker: pluginOptions.circuitBreaker == null || pluginOptions.circuitBreaker === true
-            ? defaultCircuitBreakerConfiguration
+            ? circuit_breaker_js_1.defaultCircuitBreakerConfiguration
             : pluginOptions.circuitBreaker === false
                 ? null
                 : pluginOptions.circuitBreaker });

package/cjs/client/cdn-artifact-fetcher.js

@@ -0,0 +1,98 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createCDNArtifactFetcher = createCDNArtifactFetcher;
+const tslib_1 = require("tslib");
+const circuit_js_1 = tslib_1.__importDefault(require("../circuit-breaker/circuit.js"));
+const version_js_1 = require("../version.js");
+const circuit_breaker_js_1 = require("./circuit-breaker.js");
+const http_client_js_1 = require("./http-client.js");
+const utils_js_1 = require("./utils.js");
+function isRequestOk(response) {
+    return response.status === 304 || response.ok;
+}
+/**
+ * Create a handler for fetching a CDN artifact with built-in cache and circuit breaker.
+ * It is intended for polling supergraph, schema sdl or services.
+ */
+function createCDNArtifactFetcher(args) {
+    var _a, _b;
+    const logger = (0, utils_js_1.chooseLogger)(args.logger);
+    let cacheETag = null;
+    let cached = null;
+    const clientInfo = (_a = args.client) !== null && _a !== void 0 ? _a : { name: 'hive-client', version: version_js_1.version };
+    const circuitBreakerConfig = (_b = args.circuitBreaker) !== null && _b !== void 0 ? _b : circuit_breaker_js_1.defaultCircuitBreakerConfiguration;
+    const endpoints = Array.isArray(args.endpoint) ? args.endpoint : [args.endpoint];
+    function runFetch(circuitBreaker, endpoint) {
+        var _a;
+        const signal = circuitBreaker.getSignal();
+        const headers = {
+            'X-Hive-CDN-Key': args.accessKey,
+            'User-Agent': `${clientInfo.name}/${clientInfo.version}`,
+        };
+        if (cacheETag) {
+            headers['If-None-Match'] = cacheETag;
+        }
+        return http_client_js_1.http.get(endpoint, {
+            headers,
+            isRequestOk,
+            retry: (_a = args.retry) !== null && _a !== void 0 ? _a : {
+                retries: 10,
+                maxTimeout: 200,
+                minTimeout: 1,
+            },
+            timeout: args.timeout,
+            logger,
+            fetchImplementation: args.fetch,
+            signal,
+        });
+    }
+    const circuitBreakers = endpoints.map(endpoint => {
+        const circuitBreaker = new circuit_js_1.default(async function fire() {
+            return await runFetch(circuitBreaker, endpoint);
+        }, Object.assign(Object.assign({}, circuitBreakerConfig), { timeout: false, autoRenewAbortController: true }));
+        return circuitBreaker;
+    });
+    async function attempt(breaker) {
+        var _a;
+        const response = await breaker.fire();
+        if (response.status === 304) {
+            if (cached !== null) {
+                return cached;
+            }
+            throw new Error('Unexpected 304 with no cache');
+        }
+        const contents = await response.text();
+        const result = {
+            hash: await (0, utils_js_1.createHash)('SHA-256').update(contents).digest('base64'),
+            contents,
+            schemaVersionId: (_a = response.headers.get('x-hive-schema-version-id')) !== null && _a !== void 0 ? _a : null,
+        };
+        const etag = response.headers.get('etag');
+        if (etag) {
+            cached = result;
+            cacheETag = etag;
+        }
+        return result;
+    }
+    return {
+        async fetch() {
+            for (const [index, breaker] of circuitBreakers.entries()) {
+                try {
+                    return await attempt(breaker);
+                }
+                catch (error) {
+                    logger.debug({ error });
+                    if (index === circuitBreakers.length - 1) {
+                        if (cached) {
+                            return cached;
+                        }
+                    }
+                }
+            }
+            throw new Error('Could not retrieve artifact.');
+        },
+        dispose() {
+            circuitBreakers.forEach(breaker => breaker.shutdown());
+        },
+    };
+}

package/cjs/client/circuit-breaker.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultCircuitBreakerConfiguration = void 0;
+exports.defaultCircuitBreakerConfiguration = {
+    errorThresholdPercentage: 50,
+    volumeThreshold: 10,
+    resetTimeout: 30000,
+};

package/cjs/client/client.js

@@ -36,6 +36,9 @@ function createHive(options) {
         logger });
     const usage = (0, usage_js_1.createUsage)(mergedOptions);
     const schemaReporter = (0, reporting_js_1.createReporting)(mergedOptions);
+    const persistedDocuments = options.experimental__persistedDocuments
+        ? (0, persisted_documents_js_1.createPersistedDocuments)(Object.assign(Object.assign({}, options.experimental__persistedDocuments), { logger, fetch: options.experimental__persistedDocuments.fetch }))
+        : null;
     function reportSchema({ schema }) {
         schemaReporter.report({ schema });
     }
@@ -46,7 +49,7 @@ function createHive(options) {
         return usage.collectRequest(...args);
     }
     async function dispose() {
-        await Promise.all([schemaReporter.dispose(), usage.dispose()]);
+        await Promise.all([schemaReporter.dispose(), usage.dispose(), persistedDocuments === null || persistedDocuments === void 0 ? void 0 : persistedDocuments.dispose()]);
     }
     const isOrganizationAccessToken = !(0, utils_js_1.isLegacyAccessToken)((_b = options.token) !== null && _b !== void 0 ? _b : '');
     // enabledOnly when `printTokenInfo` is `true` or `debug` is true and `printTokenInfo` is not `false`
@@ -189,9 +192,7 @@ function createHive(options) {
         collectSubscriptionUsage: usage.collectSubscription,
         createInstrumentedSubscribe,
         createInstrumentedExecute,
-        experimental__persistedDocuments: options.experimental__persistedDocuments
-            ? (0, persisted_documents_js_1.createPersistedDocuments)(Object.assign(Object.assign({}, options.experimental__persistedDocuments), { logger, fetch: options.experimental__persistedDocuments.fetch }))
-            : null,
+        experimental__persistedDocuments: persistedDocuments,
     };
 }
 exports.hiveClientSymbol = Symbol('hive-client');

package/cjs/client/persisted-documents.js

@@ -3,7 +3,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.createPersistedDocuments = createPersistedDocuments;
 const tslib_1 = require("tslib");
 const tiny_lru_1 = tslib_1.__importDefault(require("tiny-lru"));
+const circuit_js_1 = tslib_1.__importDefault(require("../circuit-breaker/circuit.js"));
+const circuit_breaker_js_1 = require("./circuit-breaker.js");
 const http_client_js_1 = require("./http-client.js");
+function isRequestOk(response) {
+    return response.status === 200 || response.status === 404;
+}
 function createPersistedDocuments(config) {
     var _a;
     const persistedDocumentsCache = (0, tiny_lru_1.default)((_a = config.cache) !== null && _a !== void 0 ? _a : 10000);
@@ -20,42 +25,77 @@ function createPersistedDocuments(config) {
     }
     /** if there is already a in-flight request for a document, we re-use it. */
     const fetchCache = new Map();
-    /** Batch load a persisted documents */
-    function loadPersistedDocument(documentId) {
-        const document = persistedDocumentsCache.get(documentId);
-        if (document) {
-            return document;
-        }
-        const cdnDocumentId = documentId.replaceAll('~', '/');
-        const url = config.cdn.endpoint + '/apps/' + cdnDocumentId;
-        let promise = fetchCache.get(url);
-        if (!promise) {
-            promise = http_client_js_1.http
-                .get(url, {
+    const endpoints = Array.isArray(config.cdn.endpoint)
+        ? config.cdn.endpoint
+        : [config.cdn.endpoint];
+    const circuitBreakers = endpoints.map(endpoint => {
+        var _a;
+        const circuitBreaker = new circuit_js_1.default(async function doFetch(cdnDocumentId) {
+            const signal = circuitBreaker.getSignal();
+            return await http_client_js_1.http
+                .get(endpoint + '/apps/' + cdnDocumentId, {
                 headers: {
                     'X-Hive-CDN-Key': config.cdn.accessToken,
                 },
                 logger: config.logger,
-                isRequestOk: response => response.status === 200 || response.status === 404,
+                isRequestOk,
                 fetchImplementation: config.fetch,
+                signal,
+                retry: config.retry,
             })
                 .then(async (response) => {
                 if (response.status !== 200) {
                     return null;
                 }
                 const text = await response.text();
-                persistedDocumentsCache.set(documentId, text);
                 return text;
-            })
-                .finally(() => {
-                fetchCache.delete(url);
             });
-            fetchCache.set(url, promise);
+        }, Object.assign(Object.assign({}, ((_a = config.circuitBreaker) !== null && _a !== void 0 ? _a : circuit_breaker_js_1.defaultCircuitBreakerConfiguration)), { timeout: false, autoRenewAbortController: true }));
+        return circuitBreaker;
+    });
+    /** Batch load a persisted documents */
+    function loadPersistedDocument(documentId) {
+        const document = persistedDocumentsCache.get(documentId);
+        if (document) {
+            return document;
+        }
+        let promise = fetchCache.get(documentId);
+        if (promise) {
+            return promise;
         }
+        promise = Promise.resolve()
+            .then(async () => {
+            const cdnDocumentId = documentId.replaceAll('~', '/');
+            let lastError = null;
+            for (const breaker of circuitBreakers) {
+                try {
+                    return await breaker.fire(cdnDocumentId);
+                }
+                catch (error) {
+                    config.logger.debug({ error });
+                    lastError = error;
+                }
+            }
+            if (lastError) {
+                config.logger.error({ error: lastError });
+            }
+            throw new Error('Failed to look up persisted operation.');
+        })
+            .then(result => {
+            persistedDocumentsCache.set(documentId, result);
+            return result;
+        })
+            .finally(() => {
+            fetchCache.delete(documentId);
+        });
+        fetchCache.set(documentId, promise);
         return promise;
     }
     return {
         allowArbitraryDocuments,
         resolve: loadPersistedDocument,
+        dispose() {
+            circuitBreakers.map(breaker => breaker.shutdown());
+        },
     };
 }

package/cjs/client/supergraph.js

@@ -4,6 +4,9 @@ exports.createSupergraphSDLFetcher = createSupergraphSDLFetcher;
 const version_js_1 = require("../version.js");
 const http_client_js_1 = require("./http-client.js");
 const utils_js_1 = require("./utils.js");
+/**
+ * @deprecated Please use {createCDNArtifactFetcher} instead.
+ */
 function createSupergraphSDLFetcher(options) {
     let cacheETag = null;
     let cached = null;

package/cjs/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createSupergraphSDLFetcher = exports.URL = exports.http = exports.joinUrl = exports.createHash = exports.isAsyncIterable = exports.isHiveClient = exports.atLeastOnceSampler = exports.autoDisposeSymbol = exports.createHive = exports.createServicesFetcher = exports.createSchemaFetcher = exports.collectSchemaCoordinates = void 0;
+exports.createCDNArtifactFetcher = exports.createSupergraphSDLFetcher = exports.URL = exports.http = exports.joinUrl = exports.createHash = exports.isAsyncIterable = exports.isHiveClient = exports.atLeastOnceSampler = exports.autoDisposeSymbol = exports.createHive = exports.createServicesFetcher = exports.createSchemaFetcher = exports.collectSchemaCoordinates = void 0;
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./normalize/operation.js"), exports);
 var collect_schema_coordinates_js_1 = require("./client/collect-schema-coordinates.js");
@@ -23,3 +23,5 @@ Object.defineProperty(exports, "http", { enumerable: true, get: function () { re
 Object.defineProperty(exports, "URL", { enumerable: true, get: function () { return http_client_js_1.URL; } });
 var supergraph_js_1 = require("./client/supergraph.js");
 Object.defineProperty(exports, "createSupergraphSDLFetcher", { enumerable: true, get: function () { return supergraph_js_1.createSupergraphSDLFetcher; } });
+var cdn_artifact_fetcher_js_1 = require("./client/cdn-artifact-fetcher.js");
+Object.defineProperty(exports, "createCDNArtifactFetcher", { enumerable: true, get: function () { return cdn_artifact_fetcher_js_1.createCDNArtifactFetcher; } });

package/cjs/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.version = void 0;
-exports.version = '0.16.0';
+exports.version = '0.17.0';

package/esm/client/agent.js

@@ -1,12 +1,8 @@
 import CircuitBreaker from '../circuit-breaker/circuit.js';
 import { version } from '../version.js';
+import { defaultCircuitBreakerConfiguration, } from './circuit-breaker.js';
 import { http } from './http-client.js';
 import { chooseLogger } from './utils.js';
-const defaultCircuitBreakerConfiguration = {
-    errorThresholdPercentage: 50,
-    volumeThreshold: 10,
-    resetTimeout: 30000,
-};
 export function createAgent(pluginOptions, { data, body, headers = () => ({}), }) {
     const options = Object.assign(Object.assign({ timeout: 30000, enabled: true, minTimeout: 200, maxRetries: 3, sendInterval: 10000, maxSize: 25, name: 'hive-client', version }, pluginOptions), { circuitBreaker: pluginOptions.circuitBreaker == null || pluginOptions.circuitBreaker === true
             ? defaultCircuitBreakerConfiguration

package/esm/client/cdn-artifact-fetcher.js

@@ -0,0 +1,94 @@
+import CircuitBreaker from '../circuit-breaker/circuit.js';
+import { version } from '../version.js';
+import { defaultCircuitBreakerConfiguration, } from './circuit-breaker.js';
+import { http } from './http-client.js';
+import { chooseLogger, createHash } from './utils.js';
+function isRequestOk(response) {
+    return response.status === 304 || response.ok;
+}
+/**
+ * Create a handler for fetching a CDN artifact with built-in cache and circuit breaker.
+ * It is intended for polling supergraph, schema sdl or services.
+ */
+export function createCDNArtifactFetcher(args) {
+    var _a, _b;
+    const logger = chooseLogger(args.logger);
+    let cacheETag = null;
+    let cached = null;
+    const clientInfo = (_a = args.client) !== null && _a !== void 0 ? _a : { name: 'hive-client', version };
+    const circuitBreakerConfig = (_b = args.circuitBreaker) !== null && _b !== void 0 ? _b : defaultCircuitBreakerConfiguration;
+    const endpoints = Array.isArray(args.endpoint) ? args.endpoint : [args.endpoint];
+    function runFetch(circuitBreaker, endpoint) {
+        var _a;
+        const signal = circuitBreaker.getSignal();
+        const headers = {
+            'X-Hive-CDN-Key': args.accessKey,
+            'User-Agent': `${clientInfo.name}/${clientInfo.version}`,
+        };
+        if (cacheETag) {
+            headers['If-None-Match'] = cacheETag;
+        }
+        return http.get(endpoint, {
+            headers,
+            isRequestOk,
+            retry: (_a = args.retry) !== null && _a !== void 0 ? _a : {
+                retries: 10,
+                maxTimeout: 200,
+                minTimeout: 1,
+            },
+            timeout: args.timeout,
+            logger,
+            fetchImplementation: args.fetch,
+            signal,
+        });
+    }
+    const circuitBreakers = endpoints.map(endpoint => {
+        const circuitBreaker = new CircuitBreaker(async function fire() {
+            return await runFetch(circuitBreaker, endpoint);
+        }, Object.assign(Object.assign({}, circuitBreakerConfig), { timeout: false, autoRenewAbortController: true }));
+        return circuitBreaker;
+    });
+    async function attempt(breaker) {
+        var _a;
+        const response = await breaker.fire();
+        if (response.status === 304) {
+            if (cached !== null) {
+                return cached;
+            }
+            throw new Error('Unexpected 304 with no cache');
+        }
+        const contents = await response.text();
+        const result = {
+            hash: await createHash('SHA-256').update(contents).digest('base64'),
+            contents,
+            schemaVersionId: (_a = response.headers.get('x-hive-schema-version-id')) !== null && _a !== void 0 ? _a : null,
+        };
+        const etag = response.headers.get('etag');
+        if (etag) {
+            cached = result;
+            cacheETag = etag;
+        }
+        return result;
+    }
+    return {
+        async fetch() {
+            for (const [index, breaker] of circuitBreakers.entries()) {
+                try {
+                    return await attempt(breaker);
+                }
+                catch (error) {
+                    logger.debug({ error });
+                    if (index === circuitBreakers.length - 1) {
+                        if (cached) {
+                            return cached;
+                        }
+                    }
+                }
+            }
+            throw new Error('Could not retrieve artifact.');
+        },
+        dispose() {
+            circuitBreakers.forEach(breaker => breaker.shutdown());
+        },
+    };
+}

package/esm/client/circuit-breaker.js

@@ -0,0 +1,5 @@
+export const defaultCircuitBreakerConfiguration = {
+    errorThresholdPercentage: 50,
+    volumeThreshold: 10,
+    resetTimeout: 30000,
+};

package/esm/client/client.js

@@ -32,6 +32,9 @@ export function createHive(options) {
         logger });
     const usage = createUsage(mergedOptions);
     const schemaReporter = createReporting(mergedOptions);
+    const persistedDocuments = options.experimental__persistedDocuments
+        ? createPersistedDocuments(Object.assign(Object.assign({}, options.experimental__persistedDocuments), { logger, fetch: options.experimental__persistedDocuments.fetch }))
+        : null;
     function reportSchema({ schema }) {
         schemaReporter.report({ schema });
     }
@@ -42,7 +45,7 @@ export function createHive(options) {
         return usage.collectRequest(...args);
     }
     async function dispose() {
-        await Promise.all([schemaReporter.dispose(), usage.dispose()]);
+        await Promise.all([schemaReporter.dispose(), usage.dispose(), persistedDocuments === null || persistedDocuments === void 0 ? void 0 : persistedDocuments.dispose()]);
     }
     const isOrganizationAccessToken = !isLegacyAccessToken((_b = options.token) !== null && _b !== void 0 ? _b : '');
     // enabledOnly when `printTokenInfo` is `true` or `debug` is true and `printTokenInfo` is not `false`
@@ -185,9 +188,7 @@ export function createHive(options) {
         collectSubscriptionUsage: usage.collectSubscription,
         createInstrumentedSubscribe,
         createInstrumentedExecute,
-        experimental__persistedDocuments: options.experimental__persistedDocuments
-            ? createPersistedDocuments(Object.assign(Object.assign({}, options.experimental__persistedDocuments), { logger, fetch: options.experimental__persistedDocuments.fetch }))
-            : null,
+        experimental__persistedDocuments: persistedDocuments,
     };
 }
 export const hiveClientSymbol = Symbol('hive-client');

package/esm/client/persisted-documents.js

@@ -1,5 +1,10 @@
 import LRU from 'tiny-lru';
+import CircuitBreaker from '../circuit-breaker/circuit.js';
+import { defaultCircuitBreakerConfiguration } from './circuit-breaker.js';
 import { http } from './http-client.js';
+function isRequestOk(response) {
+    return response.status === 200 || response.status === 404;
+}
 export function createPersistedDocuments(config) {
     var _a;
     const persistedDocumentsCache = LRU((_a = config.cache) !== null && _a !== void 0 ? _a : 10000);
@@ -16,42 +21,77 @@ export function createPersistedDocuments(config) {
     }
     /** if there is already a in-flight request for a document, we re-use it. */
     const fetchCache = new Map();
-    /** Batch load a persisted documents */
-    function loadPersistedDocument(documentId) {
-        const document = persistedDocumentsCache.get(documentId);
-        if (document) {
-            return document;
-        }
-        const cdnDocumentId = documentId.replaceAll('~', '/');
-        const url = config.cdn.endpoint + '/apps/' + cdnDocumentId;
-        let promise = fetchCache.get(url);
-        if (!promise) {
-            promise = http
-                .get(url, {
+    const endpoints = Array.isArray(config.cdn.endpoint)
+        ? config.cdn.endpoint
+        : [config.cdn.endpoint];
+    const circuitBreakers = endpoints.map(endpoint => {
+        var _a;
+        const circuitBreaker = new CircuitBreaker(async function doFetch(cdnDocumentId) {
+            const signal = circuitBreaker.getSignal();
+            return await http
+                .get(endpoint + '/apps/' + cdnDocumentId, {
                 headers: {
                     'X-Hive-CDN-Key': config.cdn.accessToken,
                 },
                 logger: config.logger,
-                isRequestOk: response => response.status === 200 || response.status === 404,
+                isRequestOk,
                 fetchImplementation: config.fetch,
+                signal,
+                retry: config.retry,
             })
                 .then(async (response) => {
                 if (response.status !== 200) {
                     return null;
                 }
                 const text = await response.text();
-                persistedDocumentsCache.set(documentId, text);
                 return text;
-            })
-                .finally(() => {
-                fetchCache.delete(url);
             });
-            fetchCache.set(url, promise);
+        }, Object.assign(Object.assign({}, ((_a = config.circuitBreaker) !== null && _a !== void 0 ? _a : defaultCircuitBreakerConfiguration)), { timeout: false, autoRenewAbortController: true }));
+        return circuitBreaker;
+    });
+    /** Batch load a persisted documents */
+    function loadPersistedDocument(documentId) {
+        const document = persistedDocumentsCache.get(documentId);
+        if (document) {
+            return document;
+        }
+        let promise = fetchCache.get(documentId);
+        if (promise) {
+            return promise;
         }
+        promise = Promise.resolve()
+            .then(async () => {
+            const cdnDocumentId = documentId.replaceAll('~', '/');
+            let lastError = null;
+            for (const breaker of circuitBreakers) {
+                try {
+                    return await breaker.fire(cdnDocumentId);
+                }
+                catch (error) {
+                    config.logger.debug({ error });
+                    lastError = error;
+                }
+            }
+            if (lastError) {
+                config.logger.error({ error: lastError });
+            }
+            throw new Error('Failed to look up persisted operation.');
+        })
+            .then(result => {
+            persistedDocumentsCache.set(documentId, result);
+            return result;
+        })
+            .finally(() => {
+            fetchCache.delete(documentId);
+        });
+        fetchCache.set(documentId, promise);
         return promise;
     }
     return {
         allowArbitraryDocuments,
         resolve: loadPersistedDocument,
+        dispose() {
+            circuitBreakers.map(breaker => breaker.shutdown());
+        },
     };
 }

package/esm/client/supergraph.js

@@ -1,6 +1,9 @@
 import { version } from '../version.js';
 import { http } from './http-client.js';
 import { createHash, joinUrl } from './utils.js';
+/**
+ * @deprecated Please use {createCDNArtifactFetcher} instead.
+ */
 export function createSupergraphSDLFetcher(options) {
     let cacheETag = null;
     let cached = null;

package/esm/index.js

@@ -6,3 +6,4 @@ export { atLeastOnceSampler } from './client/samplers.js';
 export { isHiveClient, isAsyncIterable, createHash, joinUrl } from './client/utils.js';
 export { http, URL } from './client/http-client.js';
 export { createSupergraphSDLFetcher } from './client/supergraph.js';
+export { createCDNArtifactFetcher, } from './client/cdn-artifact-fetcher.js';

package/esm/version.js

@@ -1 +1 @@
-export const version = '0.16.0';
+export const version = '0.17.0';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-hive/core",
-  "version": "0.16.0",
+  "version": "0.17.0",
   "sideEffects": false,
   "peerDependencies": {
     "graphql": "^0.13.0 || ^14.0.0 || ^15.0.0 || ^16.0.0"

package/typings/client/agent.d.cts

@@ -1,22 +1,6 @@
+import { CircuitBreakerConfiguration } from './circuit-breaker.cjs';
 import type { LegacyLogger } from './types.cjs';
 type ReadOnlyResponse = Pick<Response, 'status' | 'text' | 'json' | 'statusText'>;
-export type AgentCircuitBreakerConfiguration = {
-    /**
-     * Percentage after what the circuit breaker should kick in.
-     * Default: 50
-     */
-    errorThresholdPercentage: number;
-    /**
-     * Count of requests before starting evaluating.
-     * Default: 5
-     */
-    volumeThreshold: number;
-    /**
-     * After what time the circuit breaker is attempting to retry sending requests in milliseconds
-     * Default: 30_000
-     */
-    resetTimeout: number;
-};
 export interface AgentOptions {
     enabled?: boolean;
     name?: string;
@@ -63,7 +47,7 @@ export interface AgentOptions {
      * false -> Disable
      * object -> use custom configuration see {AgentCircuitBreakerConfiguration}
      */
-    circuitBreaker?: boolean | AgentCircuitBreakerConfiguration;
+    circuitBreaker?: boolean | CircuitBreakerConfiguration;
     /**
      * WHATWG Compatible fetch implementation
      * used by the agent to send reports

package/typings/client/agent.d.ts

@@ -1,22 +1,6 @@
+import { CircuitBreakerConfiguration } from './circuit-breaker.js';
 import type { LegacyLogger } from './types.js';
 type ReadOnlyResponse = Pick<Response, 'status' | 'text' | 'json' | 'statusText'>;
-export type AgentCircuitBreakerConfiguration = {
-    /**
-     * Percentage after what the circuit breaker should kick in.
-     * Default: 50
-     */
-    errorThresholdPercentage: number;
-    /**
-     * Count of requests before starting evaluating.
-     * Default: 5
-     */
-    volumeThreshold: number;
-    /**
-     * After what time the circuit breaker is attempting to retry sending requests in milliseconds
-     * Default: 30_000
-     */
-    resetTimeout: number;
-};
 export interface AgentOptions {
     enabled?: boolean;
     name?: string;
@@ -63,7 +47,7 @@ export interface AgentOptions {
      * false -> Disable
      * object -> use custom configuration see {AgentCircuitBreakerConfiguration}
      */
-    circuitBreaker?: boolean | AgentCircuitBreakerConfiguration;
+    circuitBreaker?: boolean | CircuitBreakerConfiguration;
     /**
      * WHATWG Compatible fetch implementation
      * used by the agent to send reports

package/typings/client/cdn-artifact-fetcher.d.cts

@@ -0,0 +1,63 @@
+import { Logger } from '@graphql-hive/logger';
+import { CircuitBreakerConfiguration } from './circuit-breaker.cjs';
+import { HttpCallConfig } from './http-client.cjs';
+type CreateCDNArtifactFetcherArgs = {
+    /**
+     * The endpoint that should be fetched.
+     *
+     * It is possible to provide an endpoint list. The first endpoint will be treated as the primary source.
+     * The secondary endpoint will be used in case the first endpoint fails to respond.
+     *
+     * Example:
+     *
+     * ```
+     * [
+     *          "https://cdn.graphql-hive.com/artifacts/v1/9fb37bc4-e520-4019-843a-0c8698c25688/supergraph",
+     *   "https://cdn-mirror.graphql-hive.com/artifacts/v1/9fb37bc4-e520-4019-843a-0c8698c25688/supergraph"
+     * ]
+     * ```
+     */
+    endpoint: string | [string, string];
+    /**
+     * The access key that is used for authenticating on the endpoints (via the `X-Hive-CDN-Key` header).
+     */
+    accessKey: string;
+    logger?: Logger;
+    circuitBreaker?: CircuitBreakerConfiguration;
+    /**
+     * Custom fetch implementation used for calling the endpoint.
+     */
+    fetch?: typeof fetch;
+    /** Amount of retries per endpoint lookup attempt */
+    retry?: HttpCallConfig['retry'];
+    /** Timeout per retry for endpoint lookup */
+    timeout?: HttpCallConfig['timeout'];
+    /**
+     * Optional client meta configuration.
+     **/
+    client?: {
+        name: string;
+        version: string;
+    };
+};
+type CDNFetchResult = {
+    /** Text contents of the artifact */
+    contents: string;
+    /** SHA-256 Hash */
+    hash: string;
+    /** Schema Version ID as on Hive Console (optional) */
+    schemaVersionId: null | string;
+};
+export type CDNArtifactFetcher = {
+    /** Call the CDN and retrieve the lastest artifact version. */
+    fetch(): Promise<CDNFetchResult>;
+    /** Dispose the fetcher and cleanup existing timers (e.g. used for circuit breaker) */
+    dispose(): void;
+};
+/**
+ * Create a handler for fetching a CDN artifact with built-in cache and circuit breaker.
+ * It is intended for polling supergraph, schema sdl or services.
+ */
+export declare function createCDNArtifactFetcher(args: CreateCDNArtifactFetcherArgs): CDNArtifactFetcher;
+export {};
+//# sourceMappingURL=cdn-artifact-fetcher.d.ts.map

package/typings/client/cdn-artifact-fetcher.d.ts

@@ -0,0 +1,63 @@
+import { Logger } from '@graphql-hive/logger';
+import { CircuitBreakerConfiguration } from './circuit-breaker.js';
+import { HttpCallConfig } from './http-client.js';
+type CreateCDNArtifactFetcherArgs = {
+    /**
+     * The endpoint that should be fetched.
+     *
+     * It is possible to provide an endpoint list. The first endpoint will be treated as the primary source.
+     * The secondary endpoint will be used in case the first endpoint fails to respond.
+     *
+     * Example:
+     *
+     * ```
+     * [
+     *          "https://cdn.graphql-hive.com/artifacts/v1/9fb37bc4-e520-4019-843a-0c8698c25688/supergraph",
+     *   "https://cdn-mirror.graphql-hive.com/artifacts/v1/9fb37bc4-e520-4019-843a-0c8698c25688/supergraph"
+     * ]
+     * ```
+     */
+    endpoint: string | [string, string];
+    /**
+     * The access key that is used for authenticating on the endpoints (via the `X-Hive-CDN-Key` header).
+     */
+    accessKey: string;
+    logger?: Logger;
+    circuitBreaker?: CircuitBreakerConfiguration;
+    /**
+     * Custom fetch implementation used for calling the endpoint.
+     */
+    fetch?: typeof fetch;
+    /** Amount of retries per endpoint lookup attempt */
+    retry?: HttpCallConfig['retry'];
+    /** Timeout per retry for endpoint lookup */
+    timeout?: HttpCallConfig['timeout'];
+    /**
+     * Optional client meta configuration.
+     **/
+    client?: {
+        name: string;
+        version: string;
+    };
+};
+type CDNFetchResult = {
+    /** Text contents of the artifact */
+    contents: string;
+    /** SHA-256 Hash */
+    hash: string;
+    /** Schema Version ID as on Hive Console (optional) */
+    schemaVersionId: null | string;
+};
+export type CDNArtifactFetcher = {
+    /** Call the CDN and retrieve the lastest artifact version. */
+    fetch(): Promise<CDNFetchResult>;
+    /** Dispose the fetcher and cleanup existing timers (e.g. used for circuit breaker) */
+    dispose(): void;
+};
+/**
+ * Create a handler for fetching a CDN artifact with built-in cache and circuit breaker.
+ * It is intended for polling supergraph, schema sdl or services.
+ */
+export declare function createCDNArtifactFetcher(args: CreateCDNArtifactFetcherArgs): CDNArtifactFetcher;
+export {};
+//# sourceMappingURL=cdn-artifact-fetcher.d.ts.map

package/typings/client/circuit-breaker.d.cts

@@ -0,0 +1,19 @@
+export type CircuitBreakerConfiguration = {
+    /**
+     * Percentage after what the circuit breaker should kick in.
+     * Default: 50
+     */
+    errorThresholdPercentage: number;
+    /**
+     * Count of requests before starting evaluating.
+     * Default: 5
+     */
+    volumeThreshold: number;
+    /**
+     * After what time the circuit breaker is attempting to retry sending requests in milliseconds
+     * Default: 30_000
+     */
+    resetTimeout: number;
+};
+export declare const defaultCircuitBreakerConfiguration: CircuitBreakerConfiguration;
+//# sourceMappingURL=circuit-breaker.d.ts.map

package/typings/client/circuit-breaker.d.ts

@@ -0,0 +1,19 @@
+export type CircuitBreakerConfiguration = {
+    /**
+     * Percentage after what the circuit breaker should kick in.
+     * Default: 50
+     */
+    errorThresholdPercentage: number;
+    /**
+     * Count of requests before starting evaluating.
+     * Default: 5
+     */
+    volumeThreshold: number;
+    /**
+     * After what time the circuit breaker is attempting to retry sending requests in milliseconds
+     * Default: 30_000
+     */
+    resetTimeout: number;
+};
+export declare const defaultCircuitBreakerConfiguration: CircuitBreakerConfiguration;
+//# sourceMappingURL=circuit-breaker.d.ts.map

package/typings/client/http-client.d.cts

@@ -1,7 +1,7 @@
 import asyncRetry from 'async-retry';
 import { fetch, URL } from '@whatwg-node/fetch';
 import type { LegacyLogger } from './types';
-interface SharedConfig {
+export interface HttpCallConfig {
     headers: Record<string, string>;
     /**
      * timeout in milliseconds (for each single fetch call)
@@ -27,9 +27,9 @@ interface SharedConfig {
  * Return a string that contains the reason on why the request should be retried.
  */
 type ResponseAssertFunction = (response: Response) => boolean;
-type RetryOptions = Parameters<typeof asyncRetry>[1];
-declare function get(endpoint: string, config: SharedConfig): Promise<Response>;
-declare function post(endpoint: string, data: string | Buffer, config: SharedConfig): Promise<Response>;
+export type RetryOptions = Parameters<typeof asyncRetry>[1];
+declare function get(endpoint: string, config: HttpCallConfig): Promise<Response>;
+declare function post(endpoint: string, data: string | Buffer, config: HttpCallConfig): Promise<Response>;
 export declare const http: {
     get: typeof get;
     post: typeof post;

package/typings/client/http-client.d.ts

@@ -1,7 +1,7 @@
 import asyncRetry from 'async-retry';
 import { fetch, URL } from '@whatwg-node/fetch';
 import type { LegacyLogger } from './types';
-interface SharedConfig {
+export interface HttpCallConfig {
     headers: Record<string, string>;
     /**
      * timeout in milliseconds (for each single fetch call)
@@ -27,9 +27,9 @@ interface SharedConfig {
  * Return a string that contains the reason on why the request should be retried.
  */
 type ResponseAssertFunction = (response: Response) => boolean;
-type RetryOptions = Parameters<typeof asyncRetry>[1];
-declare function get(endpoint: string, config: SharedConfig): Promise<Response>;
-declare function post(endpoint: string, data: string | Buffer, config: SharedConfig): Promise<Response>;
+export type RetryOptions = Parameters<typeof asyncRetry>[1];
+declare function get(endpoint: string, config: HttpCallConfig): Promise<Response>;
+declare function post(endpoint: string, data: string | Buffer, config: HttpCallConfig): Promise<Response>;
 export declare const http: {
     get: typeof get;
     post: typeof post;

package/typings/client/persisted-documents.d.cts

@@ -1,17 +1,22 @@
 import type { PromiseOrValue } from 'graphql/jsutils/PromiseOrValue.cjs';
 import { Logger } from '@graphql-hive/logger';
+import { HttpCallConfig } from './http-client.cjs';
 import type { PersistedDocumentsConfiguration } from './types';
 type HeadersObject = {
     get(name: string): string | null;
 };
-export declare function createPersistedDocuments(config: PersistedDocumentsConfiguration & {
-    logger: Logger;
-    fetch?: typeof fetch;
-}): null | {
+type PersistedDocuments = {
     resolve(documentId: string): PromiseOrValue<string | null>;
     allowArbitraryDocuments(context: {
         headers?: HeadersObject;
     }): PromiseOrValue<boolean>;
+    dispose: () => void;
 };
+export declare function createPersistedDocuments(config: PersistedDocumentsConfiguration & {
+    logger: Logger;
+    fetch?: typeof fetch;
+    retry?: HttpCallConfig['retry'];
+    timeout?: HttpCallConfig['retry'];
+}): PersistedDocuments;
 export {};
 //# sourceMappingURL=persisted-documents.d.ts.map

package/typings/client/persisted-documents.d.ts

@@ -1,17 +1,22 @@
 import type { PromiseOrValue } from 'graphql/jsutils/PromiseOrValue.js';
 import { Logger } from '@graphql-hive/logger';
+import { HttpCallConfig } from './http-client.js';
 import type { PersistedDocumentsConfiguration } from './types';
 type HeadersObject = {
     get(name: string): string | null;
 };
-export declare function createPersistedDocuments(config: PersistedDocumentsConfiguration & {
-    logger: Logger;
-    fetch?: typeof fetch;
-}): null | {
+type PersistedDocuments = {
     resolve(documentId: string): PromiseOrValue<string | null>;
     allowArbitraryDocuments(context: {
         headers?: HeadersObject;
     }): PromiseOrValue<boolean>;
+    dispose: () => void;
 };
+export declare function createPersistedDocuments(config: PersistedDocumentsConfiguration & {
+    logger: Logger;
+    fetch?: typeof fetch;
+    retry?: HttpCallConfig['retry'];
+    timeout?: HttpCallConfig['retry'];
+}): PersistedDocuments;
 export {};
 //# sourceMappingURL=persisted-documents.d.ts.map

package/typings/client/supergraph.d.cts

@@ -1,5 +1,8 @@
 import { Logger } from '@graphql-hive/logger';
 import type { LegacyLogger } from './types.cjs';
+/**
+ * @deprecated Please use {createCDNArtifactFetcher} instead of createSupergraphSDLFetcher.
+ */
 export interface SupergraphSDLFetcherOptions {
     endpoint: string;
     key: string;
@@ -8,6 +11,9 @@ export interface SupergraphSDLFetcherOptions {
     name?: string;
     version?: string;
 }
+/**
+ * @deprecated Please use {createCDNArtifactFetcher} instead.
+ */
 export declare function createSupergraphSDLFetcher(options: SupergraphSDLFetcherOptions): () => Promise<{
     id: string;
     supergraphSdl: string;

package/typings/client/supergraph.d.ts

@@ -1,5 +1,8 @@
 import { Logger } from '@graphql-hive/logger';
 import type { LegacyLogger } from './types.js';
+/**
+ * @deprecated Please use {createCDNArtifactFetcher} instead of createSupergraphSDLFetcher.
+ */
 export interface SupergraphSDLFetcherOptions {
     endpoint: string;
     key: string;
@@ -8,6 +11,9 @@ export interface SupergraphSDLFetcherOptions {
     name?: string;
     version?: string;
 }
+/**
+ * @deprecated Please use {createCDNArtifactFetcher} instead.
+ */
 export declare function createSupergraphSDLFetcher(options: SupergraphSDLFetcherOptions): () => Promise<{
     id: string;
     supergraphSdl: string;

package/typings/client/types.d.cts

@@ -2,6 +2,7 @@ import type { ExecutionArgs } from 'graphql';
 import type { PromiseOrValue } from 'graphql/jsutils/PromiseOrValue.cjs';
 import { LogLevel as HiveLoggerLevel, Logger } from '@graphql-hive/logger';
 import type { AgentOptions } from './agent.cjs';
+import { CircuitBreakerConfiguration } from './circuit-breaker.cjs';
 import type { autoDisposeSymbol, hiveClientSymbol } from './client.cjs';
 import type { SchemaReporter } from './reporting.cjs';
 type HeadersObject = {
@@ -277,10 +278,20 @@ export type PersistedDocumentsConfiguration = {
      **/
     cdn: {
         /**
-         * CDN endpoint
-         * @example https://cdn.graphql-hive.com/artifacts/v1/5d80a1c2-2532-419c-8bb5-75bb04ea1112
+         * CDN endpoint(s) for looking up persisted documents.
+         *
+         * It is possible to provide an endpoint list. The first endpoint will be treated as the primary source.
+         * The secondary endpoint will be used in case the first endpoint fails to respond.
+         *
+         * @example
+         * ```
+         * [
+         *          "https://cdn.graphql-hive.com/artifacts/v1/9fb37bc4-e520-4019-843a-0c8698c25688",
+         *   "https://cdn-mirror.graphql-hive.com/artifacts/v1/9fb37bc4-e520-4019-843a-0c8698c25688"
+         * ]
+         * ```
          */
-        endpoint: string;
+        endpoint: string | [string, string];
         /**
          * CDN access token
          * @example hv2ZjUxNGUzN2MtNjVhNS0=
@@ -303,6 +314,8 @@ export type PersistedDocumentsConfiguration = {
      * used for doing HTTP requests.
      */
     fetch?: typeof fetch;
+    /** Configuration for the circuit breaker. */
+    circuitBreaker?: CircuitBreakerConfiguration;
 };
 export type AllowArbitraryDocumentsFunction = (context: {
     /** an object for accessing the request headers. */

package/typings/client/types.d.ts

@@ -2,6 +2,7 @@ import type { ExecutionArgs } from 'graphql';
 import type { PromiseOrValue } from 'graphql/jsutils/PromiseOrValue.js';
 import { LogLevel as HiveLoggerLevel, Logger } from '@graphql-hive/logger';
 import type { AgentOptions } from './agent.js';
+import { CircuitBreakerConfiguration } from './circuit-breaker.js';
 import type { autoDisposeSymbol, hiveClientSymbol } from './client.js';
 import type { SchemaReporter } from './reporting.js';
 type HeadersObject = {
@@ -277,10 +278,20 @@ export type PersistedDocumentsConfiguration = {
      **/
     cdn: {
         /**
-         * CDN endpoint
-         * @example https://cdn.graphql-hive.com/artifacts/v1/5d80a1c2-2532-419c-8bb5-75bb04ea1112
+         * CDN endpoint(s) for looking up persisted documents.
+         *
+         * It is possible to provide an endpoint list. The first endpoint will be treated as the primary source.
+         * The secondary endpoint will be used in case the first endpoint fails to respond.
+         *
+         * @example
+         * ```
+         * [
+         *          "https://cdn.graphql-hive.com/artifacts/v1/9fb37bc4-e520-4019-843a-0c8698c25688",
+         *   "https://cdn-mirror.graphql-hive.com/artifacts/v1/9fb37bc4-e520-4019-843a-0c8698c25688"
+         * ]
+         * ```
          */
-        endpoint: string;
+        endpoint: string | [string, string];
         /**
          * CDN access token
          * @example hv2ZjUxNGUzN2MtNjVhNS0=
@@ -303,6 +314,8 @@ export type PersistedDocumentsConfiguration = {
      * used for doing HTTP requests.
      */
     fetch?: typeof fetch;
+    /** Configuration for the circuit breaker. */
+    circuitBreaker?: CircuitBreakerConfiguration;
 };
 export type AllowArbitraryDocumentsFunction = (context: {
     /** an object for accessing the request headers. */

package/typings/index.d.cts

@@ -8,4 +8,6 @@ export { isHiveClient, isAsyncIterable, createHash, joinUrl } from './client/uti
 export { http, URL } from './client/http-client.cjs';
 export { createSupergraphSDLFetcher } from './client/supergraph.cjs';
 export type { SupergraphSDLFetcherOptions } from './client/supergraph.cjs';
+export { createCDNArtifactFetcher, type CDNArtifactFetcher, } from './client/cdn-artifact-fetcher.cjs';
+export type { CircuitBreakerConfiguration } from './client/circuit-breaker.cjs';
 //# sourceMappingURL=index.d.ts.map

package/typings/index.d.ts

@@ -8,4 +8,6 @@ export { isHiveClient, isAsyncIterable, createHash, joinUrl } from './client/uti
 export { http, URL } from './client/http-client.js';
 export { createSupergraphSDLFetcher } from './client/supergraph.js';
 export type { SupergraphSDLFetcherOptions } from './client/supergraph.js';
+export { createCDNArtifactFetcher, type CDNArtifactFetcher, } from './client/cdn-artifact-fetcher.js';
+export type { CircuitBreakerConfiguration } from './client/circuit-breaker.js';
 //# sourceMappingURL=index.d.ts.map

package/typings/version.d.cts

@@ -1,2 +1,2 @@
-export declare const version = "0.16.0";
+export declare const version = "0.17.0";
 //# sourceMappingURL=version.d.ts.map

package/typings/version.d.ts

@@ -1,2 +1,2 @@
-export declare const version = "0.16.0";
+export declare const version = "0.17.0";
 //# sourceMappingURL=version.d.ts.map