@graphql-tools/url-loader 7.1.1-alpha-5d885fa3.0 → 7.2.0

package/index.d.ts

@@ -3,6 +3,7 @@
 import { IntrospectionOptions } from 'graphql';
 import { AsyncExecutor, SyncExecutor, Source, Loader, BaseLoaderOptions } from '@graphql-tools/utils';
 import { ClientOptions } from 'graphql-ws';
+import { ClientOptions as GraphQLSSEClientOptions } from 'graphql-sse';
 import WebSocket from 'isomorphic-ws';
 import FormData from 'form-data';
 import { FetchEventSourceInit } from '@ardatan/fetch-event-source';
@@ -29,7 +30,11 @@ export declare enum SubscriptionProtocol {
     /**
      * Use SSE for subscription instead of WebSocket
      */
-    SSE = "SSE"
+    SSE = "SSE",
+    /**
+     * Use `graphql-sse` for subscriptions
+     */
+    GRAPHQL_SSE = "GRAPHQL_SSE"
 }
 /**
  * Additional options for loading from a URL
@@ -81,6 +86,10 @@ export interface LoadFromUrlOptions extends BaseLoaderOptions, Partial<Introspec
      * Use specific protocol for subscriptions
      */
     subscriptionsProtocol?: SubscriptionProtocol;
+    /**
+     * Additional options to pass to the graphql-sse client.
+     */
+    graphqlSseOptions?: Omit<GraphQLSSEClientOptions, 'url' | 'headers' | 'fetchFn' | 'abortControllerImpl'>;
 }
 /**
  * This loader loads a schema from a URL. The loaded schema is a fully-executable,
@@ -115,12 +124,13 @@ export declare class UrlLoader implements Loader<LoadFromUrlOptions> {
     buildWSExecutor(subscriptionsEndpoint: string, webSocketImpl: typeof WebSocket, connectionParams?: ClientOptions['connectionParams']): AsyncExecutor;
     buildWSLegacyExecutor(subscriptionsEndpoint: string, webSocketImpl: typeof WebSocket, connectionParams?: ConnectionParamsOptions): AsyncExecutor;
     buildSSEExecutor(endpoint: string, fetch: AsyncFetchFn, options?: Omit<LoadFromUrlOptions, 'subscriptionEndpoint'>): AsyncExecutor<any, ExecutionExtensions>;
+    buildGraphQLSSEExecutor(endpoint: string, fetch: AsyncFetchFn, options?: Omit<LoadFromUrlOptions, 'subscriptionEndpoint'>): AsyncExecutor;
     getFetch(customFetch: LoadFromUrlOptions['customFetch'], importFn: AsyncImportFn): PromiseLike<AsyncFetchFn>;
     getFetch(customFetch: LoadFromUrlOptions['customFetch'], importFn: SyncImportFn): SyncFetchFn;
     private getDefaultMethodFromOptions;
     getWebSocketImpl(importFn: AsyncImportFn, options?: LoadFromUrlOptions): PromiseLike<typeof WebSocket>;
     getWebSocketImpl(importFn: SyncImportFn, options?: LoadFromUrlOptions): typeof WebSocket;
-    buildSubscriptionExecutor(subscriptionsEndpoint: string, fetch: AsyncFetchFn, options?: Omit<LoadFromUrlOptions, 'subscriptionsEndpoint'>): Promise<AsyncExecutor>;
+    buildSubscriptionExecutor(subscriptionsEndpoint: string, fetch: AsyncFetchFn, options?: LoadFromUrlOptions): Promise<AsyncExecutor>;
     getExecutorAsync(endpoint: string, options?: Omit<LoadFromUrlOptions, 'endpoint'>): Promise<AsyncExecutor>;
     getExecutorSync(endpoint: string, options: Omit<LoadFromUrlOptions, 'endpoint'>): SyncExecutor;
     handleSDL(pointer: string, fetch: SyncFetchFn, options: LoadFromUrlOptions): Source;

package/index.js

@@ -29,6 +29,7 @@ const validUrl = require('valid-url');
 const crossFetch = require('cross-fetch');
 const wrap = require('@graphql-tools/wrap');
 const graphqlWs = require('graphql-ws');
+const graphqlSse = require('graphql-sse');
 const WebSocket = _interopDefault(require('isomorphic-ws'));
 const syncFetchImported = _interopDefault(require('sync-fetch'));
 const isPromise = _interopDefault(require('is-promise'));
@@ -64,6 +65,10 @@ const syncImport = (moduleName) => require(moduleName);
      * Use SSE for subscription instead of WebSocket
      */
     SubscriptionProtocol["SSE"] = "SSE";
+    /**
+     * Use `graphql-sse` for subscriptions
+     */
+    SubscriptionProtocol["GRAPHQL_SSE"] = "GRAPHQL_SSE";
 })(exports.SubscriptionProtocol || (exports.SubscriptionProtocol = {}));
 const isCompatibleUri = (uri) => {
     if (validUrl.isWebUri(uri)) {
@@ -356,6 +361,31 @@ class UrlLoader {
             });
         };
     }
+    buildGraphQLSSEExecutor(endpoint, fetch, options = {}) {
+        const { headers } = options;
+        const client = graphqlSse.createClient({
+            ...options.graphqlSseOptions,
+            url: endpoint,
+            fetchFn: fetch,
+            abortControllerImpl: AbortController,
+            headers,
+        });
+        return async ({ document, variables, operationName, extensions }) => {
+            return utils.observableToAsyncIterable({
+                subscribe: observer => {
+                    const unsubscribe = client.subscribe({
+                        query: document,
+                        variables: variables,
+                        operationName,
+                        extensions,
+                    }, observer);
+                    return {
+                        unsubscribe,
+                    };
+                },
+            });
+        };
+    }
     getFetch(customFetch, importFn) {
         if (customFetch) {
             if (typeof customFetch === 'string') {
@@ -400,6 +430,14 @@ class UrlLoader {
         if ((options === null || options === void 0 ? void 0 : options.subscriptionsProtocol) === exports.SubscriptionProtocol.SSE) {
             return this.buildSSEExecutor(subscriptionsEndpoint, fetch, options);
         }
+        else if ((options === null || options === void 0 ? void 0 : options.subscriptionsProtocol) === exports.SubscriptionProtocol.GRAPHQL_SSE) {
+            if (!(options === null || options === void 0 ? void 0 : options.subscriptionsEndpoint)) {
+                // when no custom subscriptions endpoint is specified,
+                // graphql-sse is recommended to be used on `/graphql/stream`
+                subscriptionsEndpoint += '/stream';
+            }
+            return this.buildGraphQLSSEExecutor(subscriptionsEndpoint, fetch, options);
+        }
         else {
             const webSocketImpl = await this.getWebSocketImpl(asyncImport, options);
             const connectionParams = () => ({ headers: options === null || options === void 0 ? void 0 : options.headers });

package/index.mjs

@@ -4,6 +4,7 @@ import { isWebUri } from 'valid-url';
 import { fetch as fetch$1 } from 'cross-fetch';
 import { introspectSchema, wrapSchema } from '@graphql-tools/wrap';
 import { createClient } from 'graphql-ws';
+import { createClient as createClient$1 } from 'graphql-sse';
 import WebSocket from 'isomorphic-ws';
 import syncFetchImported from 'sync-fetch';
 import isPromise from 'is-promise';
@@ -40,6 +41,10 @@ var SubscriptionProtocol;
      * Use SSE for subscription instead of WebSocket
      */
     SubscriptionProtocol["SSE"] = "SSE";
+    /**
+     * Use `graphql-sse` for subscriptions
+     */
+    SubscriptionProtocol["GRAPHQL_SSE"] = "GRAPHQL_SSE";
 })(SubscriptionProtocol || (SubscriptionProtocol = {}));
 const isCompatibleUri = (uri) => {
     if (isWebUri(uri)) {
@@ -332,6 +337,31 @@ class UrlLoader {
             });
         };
     }
+    buildGraphQLSSEExecutor(endpoint, fetch, options = {}) {
+        const { headers } = options;
+        const client = createClient$1({
+            ...options.graphqlSseOptions,
+            url: endpoint,
+            fetchFn: fetch,
+            abortControllerImpl: AbortController,
+            headers,
+        });
+        return async ({ document, variables, operationName, extensions }) => {
+            return observableToAsyncIterable({
+                subscribe: observer => {
+                    const unsubscribe = client.subscribe({
+                        query: document,
+                        variables: variables,
+                        operationName,
+                        extensions,
+                    }, observer);
+                    return {
+                        unsubscribe,
+                    };
+                },
+            });
+        };
+    }
     getFetch(customFetch, importFn) {
         if (customFetch) {
             if (typeof customFetch === 'string') {
@@ -376,6 +406,14 @@ class UrlLoader {
         if ((options === null || options === void 0 ? void 0 : options.subscriptionsProtocol) === SubscriptionProtocol.SSE) {
             return this.buildSSEExecutor(subscriptionsEndpoint, fetch, options);
         }
+        else if ((options === null || options === void 0 ? void 0 : options.subscriptionsProtocol) === SubscriptionProtocol.GRAPHQL_SSE) {
+            if (!(options === null || options === void 0 ? void 0 : options.subscriptionsEndpoint)) {
+                // when no custom subscriptions endpoint is specified,
+                // graphql-sse is recommended to be used on `/graphql/stream`
+                subscriptionsEndpoint += '/stream';
+            }
+            return this.buildGraphQLSSEExecutor(subscriptionsEndpoint, fetch, options);
+        }
         else {
             const webSocketImpl = await this.getWebSocketImpl(asyncImport, options);
             const connectionParams = () => ({ headers: options === null || options === void 0 ? void 0 : options.headers });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-tools/url-loader",
-  "version": "7.1.1-alpha-5d885fa3.0",
+  "version": "7.2.0",
   "description": "A set of utils for faster development of GraphQL tools",
   "sideEffects": false,
   "peerDependencies": {
@@ -8,16 +8,17 @@
   },
   "dependencies": {
     "@ardatan/fetch-event-source": "2.0.2",
-    "@graphql-tools/delegate": "8.2.2-alpha-5d885fa3.0",
+    "@graphql-tools/delegate": "^8.2.0",
     "@graphql-tools/utils": "^8.2.0",
-    "@graphql-tools/wrap": "8.1.1-alpha-5d885fa3.0",
-    "@n1ru4l/graphql-live-query": "0.7.1",
+    "@graphql-tools/wrap": "^8.1.0",
+    "@n1ru4l/graphql-live-query": "0.8.1",
     "@types/websocket": "1.0.4",
     "@types/ws": "^7.4.7",
     "abort-controller": "3.0.0",
     "cross-fetch": "3.1.4",
     "extract-files": "11.0.0",
     "form-data": "4.0.0",
+    "graphql-sse": "^1.0.1",
     "graphql-ws": "^5.4.1",
     "is-promise": "4.0.0",
     "isomorphic-ws": "4.0.1",
@@ -28,7 +29,7 @@
     "tslib": "~2.3.0",
     "valid-url": "1.0.9",
     "value-or-promise": "1.0.10",
-    "ws": "8.2.1"
+    "ws": "8.2.2"
   },
   "repository": {
     "type": "git",

package/es5/index.d.ts

@@ -1,131 +0,0 @@
-/// <reference types="ws" />
-/// <reference lib="dom" />
-import { IntrospectionOptions } from 'graphql';
-import { AsyncExecutor, SyncExecutor, Source, Loader, BaseLoaderOptions } from '@graphql-tools/utils';
-import { ClientOptions } from 'graphql-ws';
-import WebSocket from 'isomorphic-ws';
-import FormData from 'form-data';
-import { FetchEventSourceInit } from '@ardatan/fetch-event-source';
-import { ConnectionParamsOptions } from 'subscriptions-transport-ws';
-export declare type AsyncFetchFn = typeof import('cross-fetch').fetch;
-export declare type SyncFetchFn = (input: RequestInfo, init?: RequestInit) => SyncResponse;
-export declare type SyncResponse = Omit<Response, 'json' | 'text'> & {
-    json: () => any;
-    text: () => string;
-};
-export declare type FetchFn = AsyncFetchFn | SyncFetchFn;
-export declare type AsyncImportFn = (moduleName: string) => PromiseLike<any>;
-export declare type SyncImportFn = (moduleName: string) => any;
-declare type HeadersConfig = Record<string, string>;
-interface ExecutionExtensions {
-    headers?: HeadersConfig;
-}
-export declare enum SubscriptionProtocol {
-    WS = "WS",
-    /**
-     * Use legacy web socket protocol `graphql-ws` instead of the more current standard `graphql-transport-ws`
-     */
-    LEGACY_WS = "LEGACY_WS",
-    /**
-     * Use SSE for subscription instead of WebSocket
-     */
-    SSE = "SSE"
-}
-/**
- * Additional options for loading from a URL
- */
-export interface LoadFromUrlOptions extends BaseLoaderOptions, Partial<IntrospectionOptions> {
-    /**
-     * Additional headers to include when querying the original schema
-     */
-    headers?: HeadersConfig;
-    /**
-     * A custom `fetch` implementation to use when querying the original schema.
-     * Defaults to `cross-fetch`
-     */
-    customFetch?: FetchFn | string;
-    /**
-     * HTTP method to use when querying the original schema.
-     */
-    method?: 'GET' | 'POST';
-    /**
-     * Custom WebSocket implementation used by the loaded schema if subscriptions
-     * are enabled
-     */
-    webSocketImpl?: typeof WebSocket | string;
-    /**
-     * Whether to use the GET HTTP method for queries when querying the original schema
-     */
-    useGETForQueries?: boolean;
-    /**
-     * Use multipart for POST requests
-     */
-    multipart?: boolean;
-    /**
-     * Additional options to pass to the constructor of the underlying EventSource instance.
-     */
-    eventSourceOptions?: FetchEventSourceInit;
-    /**
-     * Handle URL as schema SDL
-     */
-    handleAsSDL?: boolean;
-    /**
-     * Regular HTTP endpoint; defaults to the pointer
-     */
-    endpoint?: string;
-    /**
-     * Subscriptions endpoint; defaults to the endpoint given as HTTP endpoint
-     */
-    subscriptionsEndpoint?: string;
-    /**
-     * Use specific protocol for subscriptions
-     */
-    subscriptionsProtocol?: SubscriptionProtocol;
-}
-/**
- * This loader loads a schema from a URL. The loaded schema is a fully-executable,
- * remote schema since it's created using [@graphql-tools/wrap](/docs/remote-schemas).
- *
- * ```
- * const schema = await loadSchema('http://localhost:3000/graphql', {
- *   loaders: [
- *     new UrlLoader(),
- *   ]
- * });
- * ```
- */
-export declare class UrlLoader implements Loader<LoadFromUrlOptions> {
-    canLoad(pointer: string, options: LoadFromUrlOptions): Promise<boolean>;
-    canLoadSync(pointer: string, _options: LoadFromUrlOptions): boolean;
-    createFormDataFromVariables<TVariables>({ query, variables, operationName, extensions, }: {
-        query: string;
-        variables: TVariables;
-        operationName?: string;
-        extensions?: any;
-    }): FormData | Promise<FormData>;
-    prepareGETUrl({ baseUrl, query, variables, operationName, extensions, }: {
-        baseUrl: string;
-        query: string;
-        variables: any;
-        operationName?: string;
-        extensions?: any;
-    }): string;
-    buildHTTPExecutor(endpoint: string, fetch: SyncFetchFn, options?: LoadFromUrlOptions): SyncExecutor<any, ExecutionExtensions>;
-    buildHTTPExecutor(endpoint: string, fetch: AsyncFetchFn, options?: LoadFromUrlOptions): AsyncExecutor<any, ExecutionExtensions>;
-    buildWSExecutor(subscriptionsEndpoint: string, webSocketImpl: typeof WebSocket, connectionParams?: ClientOptions['connectionParams']): AsyncExecutor;
-    buildWSLegacyExecutor(subscriptionsEndpoint: string, webSocketImpl: typeof WebSocket, connectionParams?: ConnectionParamsOptions): AsyncExecutor;
-    buildSSEExecutor(endpoint: string, fetch: AsyncFetchFn, options?: Omit<LoadFromUrlOptions, 'subscriptionEndpoint'>): AsyncExecutor<any, ExecutionExtensions>;
-    getFetch(customFetch: LoadFromUrlOptions['customFetch'], importFn: AsyncImportFn): PromiseLike<AsyncFetchFn>;
-    getFetch(customFetch: LoadFromUrlOptions['customFetch'], importFn: SyncImportFn): SyncFetchFn;
-    private getDefaultMethodFromOptions;
-    getWebSocketImpl(importFn: AsyncImportFn, options?: LoadFromUrlOptions): PromiseLike<typeof WebSocket>;
-    getWebSocketImpl(importFn: SyncImportFn, options?: LoadFromUrlOptions): typeof WebSocket;
-    buildSubscriptionExecutor(subscriptionsEndpoint: string, fetch: AsyncFetchFn, options?: Omit<LoadFromUrlOptions, 'subscriptionsEndpoint'>): Promise<AsyncExecutor>;
-    getExecutorAsync(endpoint: string, options?: Omit<LoadFromUrlOptions, 'endpoint'>): Promise<AsyncExecutor>;
-    getExecutorSync(endpoint: string, options: Omit<LoadFromUrlOptions, 'endpoint'>): SyncExecutor;
-    handleSDL(pointer: string, fetch: SyncFetchFn, options: LoadFromUrlOptions): Source;
-    handleSDL(pointer: string, fetch: AsyncFetchFn, options: LoadFromUrlOptions): Promise<Source>;
-    load(pointer: string, options: LoadFromUrlOptions): Promise<Source[]>;
-    loadSync(pointer: string, options: LoadFromUrlOptions): Source[];
-}
-export {};