altair-graphql-core 4.4.2 → 4.5.2

package/build/config.d.ts

@@ -13,9 +13,14 @@ export interface AltairWindowOptions {
      */
     endpointURL?: string;
     /**
-    * URL to set as the subscription endpoint
+    * URL to set as the subscription endpoint. This can be relative or absolute.
     */
     subscriptionsEndpoint?: string;
+    /**
+     * URL protocol for the subscription endpoint. This is used if the specified subscriptions endpoint is relative.
+     * e.g. wss
+     */
+    subscriptionsProtocol?: string;
     /**
     * Initial query to be added
     */
@@ -131,6 +136,7 @@ export declare class AltairConfig {
     initialData: {
         url: string;
         subscriptionsEndpoint: string;
+        subscriptionsProtocol: string;
         query: string;
         variables: string;
         headers: IDictionary<any>;
@@ -145,7 +151,7 @@ export declare class AltairConfig {
         preserveState: boolean;
         windows: AltairWindowOptions[];
     };
-    constructor({ endpointURL, subscriptionsEndpoint, initialQuery, initialHeaders, initialEnvironments, initialVariables, initialPreRequestScript, initialPostRequestScript, instanceStorageNamespace, initialSettings, initialSubscriptionsProvider, initialSubscriptionsPayload, initialHttpMethod, preserveState, initialWindows, }?: AltairConfigOptions);
+    constructor({ endpointURL, subscriptionsEndpoint, subscriptionsProtocol, initialQuery, initialHeaders, initialEnvironments, initialVariables, initialPreRequestScript, initialPostRequestScript, instanceStorageNamespace, initialSettings, initialSubscriptionsProvider, initialSubscriptionsPayload, initialHttpMethod, preserveState, initialWindows, }?: AltairConfigOptions);
 }
 export declare const setAltairConfig: (_config: AltairConfig) => void;
 export declare const getAltairConfig: () => AltairConfig;

package/build/config.js

@@ -2,7 +2,7 @@ import { WEBSOCKET_PROVIDER_ID } from './subscriptions';
 import isElectron from './utils/is_electron';
 const isTranslateMode = window.__ALTAIR_TRANSLATE__;
 export class AltairConfig {
-    constructor({ endpointURL, subscriptionsEndpoint, initialQuery, initialHeaders, initialEnvironments, initialVariables, initialPreRequestScript, initialPostRequestScript = '', instanceStorageNamespace, initialSettings, initialSubscriptionsProvider = WEBSOCKET_PROVIDER_ID, initialSubscriptionsPayload = {}, initialHttpMethod = 'POST', preserveState = true, initialWindows = [], } = {}) {
+    constructor({ endpointURL, subscriptionsEndpoint, subscriptionsProtocol, initialQuery, initialHeaders, initialEnvironments, initialVariables, initialPreRequestScript, initialPostRequestScript = '', instanceStorageNamespace, initialSettings, initialSubscriptionsProvider = WEBSOCKET_PROVIDER_ID, initialSubscriptionsPayload = {}, initialHttpMethod = 'POST', preserveState = true, initialWindows = [], } = {}) {
         this.donation = {
             url: 'https://opencollective.com/altair/donate',
             action_count_threshold: 50
@@ -38,6 +38,7 @@ export class AltairConfig {
         this.initialData = {
             url: '',
             subscriptionsEndpoint: '',
+            subscriptionsProtocol: '',
             query: '',
             variables: '',
             // Force type of header, since initial value inference is wrong
@@ -55,6 +56,7 @@ export class AltairConfig {
         };
         this.initialData.url = window.__ALTAIR_ENDPOINT_URL__ || endpointURL || '';
         this.initialData.subscriptionsEndpoint = window.__ALTAIR_SUBSCRIPTIONS_ENDPOINT__ || subscriptionsEndpoint || '';
+        this.initialData.subscriptionsProtocol = subscriptionsProtocol;
         this.initialData.query = window.__ALTAIR_INITIAL_QUERY__ || initialQuery || '';
         this.initialData.variables = window.__ALTAIR_INITIAL_VARIABLES__ || initialVariables || '';
         this.initialData.headers = window.__ALTAIR_INITIAL_HEADERS__ || initialHeaders || '';

package/build/subscriptions/index.d.ts

@@ -3,11 +3,13 @@ export declare const WEBSOCKET_PROVIDER_ID = "websocket";
 export declare const GRAPHQL_WS_PROVIDER_ID = "graphql-ws";
 export declare const APP_SYNC_PROVIDER_ID = "app-sync";
 export declare const ACTION_CABLE_PROVIDER_ID = "action-cable";
+export declare const GRAPHQL_SSE_ID = "graphql-sse";
 export declare const SUBSCRIPTION_PROVIDER_IDS: {
     readonly WEBSOCKET: "websocket";
     readonly GRAPHQL_WS: "graphql-ws";
     readonly APP_SYNC: "app-sync";
     readonly ACTION_CABLE: "action-cable";
+    readonly GRAPHQL_SSE: "graphql-sse";
 };
 export declare type SubscriptionProviderIds = typeof SUBSCRIPTION_PROVIDER_IDS[keyof typeof SUBSCRIPTION_PROVIDER_IDS];
 export interface SubscriptionProviderData {

package/build/subscriptions/index.js

@@ -2,9 +2,11 @@ export const WEBSOCKET_PROVIDER_ID = 'websocket';
 export const GRAPHQL_WS_PROVIDER_ID = 'graphql-ws';
 export const APP_SYNC_PROVIDER_ID = 'app-sync';
 export const ACTION_CABLE_PROVIDER_ID = 'action-cable';
+export const GRAPHQL_SSE_ID = 'graphql-sse';
 export const SUBSCRIPTION_PROVIDER_IDS = {
     WEBSOCKET: WEBSOCKET_PROVIDER_ID,
     GRAPHQL_WS: GRAPHQL_WS_PROVIDER_ID,
     APP_SYNC: APP_SYNC_PROVIDER_ID,
-    ACTION_CABLE: ACTION_CABLE_PROVIDER_ID
+    ACTION_CABLE: ACTION_CABLE_PROVIDER_ID,
+    GRAPHQL_SSE: GRAPHQL_SSE_ID,
 };

package/build/subscriptions/providers/graphql-sse.d.ts

@@ -0,0 +1,11 @@
+import { SubscriptionProvider, SubscriptionProviderExecuteOptions } from '../subscription-provider';
+import { Observable } from 'rxjs';
+import { Client } from 'graphql-sse';
+export declare class GraphQLSSESubscriptionProvider extends SubscriptionProvider {
+    client?: Client;
+    cleanup?: () => void;
+    createClient(): void;
+    execute(options: SubscriptionProviderExecuteOptions): Observable<unknown>;
+    close(): Promise<void>;
+}
+//# sourceMappingURL=graphql-sse.d.ts.map

package/build/subscriptions/providers/graphql-sse.js

@@ -0,0 +1,39 @@
+import { SubscriptionProvider } from '../subscription-provider';
+import { Observable } from 'rxjs';
+import { createClient } from 'graphql-sse';
+export class GraphQLSSESubscriptionProvider extends SubscriptionProvider {
+    createClient() {
+        this.client = createClient({
+            url: this.subscriptionUrl,
+            headers: this.extraOptions.headers,
+        });
+    }
+    execute(options) {
+        this.createClient();
+        if (!this.client) {
+            throw new Error('Could not create subscription client!');
+        }
+        return new Observable((subscriber) => {
+            this.cleanup = this.client.subscribe({
+                query: options.query,
+                variables: options.variables,
+                operationName: options.operationName,
+            }, {
+                next: (...args) => subscriber.next(...args),
+                error: (...args) => subscriber.error(...args),
+                complete: () => subscriber.complete(),
+            });
+        });
+    }
+    async close() {
+        try {
+            this.cleanup?.();
+            this.cleanup = undefined;
+            await this.client?.dispose();
+            this.client = undefined;
+        }
+        catch (err) {
+            console.error(err);
+        }
+    }
+}

package/build/subscriptions/providers/graphql-ws.d.ts

@@ -6,6 +6,6 @@ export declare class GraphQLWsSubscriptionProvider extends SubscriptionProvider
     cleanup?: () => void;
     createClient(): void;
     execute(options: SubscriptionProviderExecuteOptions): Observable<unknown>;
-    close(): void;
+    close(): Promise<void>;
 }
 //# sourceMappingURL=graphql-ws.d.ts.map

package/build/subscriptions/providers/graphql-ws.js

@@ -6,6 +6,10 @@ export class GraphQLWsSubscriptionProvider extends SubscriptionProvider {
         this.client = createClient({
             url: this.subscriptionUrl,
             connectionParams: this.connectionParams,
+            lazy: false,
+            onNonLazyError: (err) => {
+                this.extraOptions?.onConnected?.(err, undefined);
+            },
             on: {
                 connected: () => {
                     this.extraOptions?.onConnected?.(undefined, undefined);
@@ -33,10 +37,16 @@ export class GraphQLWsSubscriptionProvider extends SubscriptionProvider {
             });
         });
     }
-    close() {
-        this.cleanup?.();
-        this.cleanup = undefined;
-        this.client?.dispose();
-        this.client = undefined;
+    async close() {
+        try {
+            this.cleanup?.();
+            this.cleanup = undefined;
+            // This causes the 'Error: Uncaught (in promise): Event: {"isTrusted":true}' error
+            await this.client?.dispose();
+            this.client = undefined;
+        }
+        catch (err) {
+            console.error(err);
+        }
     }
 }

package/build/subscriptions/subscription-provider.d.ts

@@ -2,6 +2,7 @@ import { Observable } from 'rxjs';
 import { IDictionary } from '../types/shared';
 export interface SubscriptionProviderExtraOptions {
     onConnected?: (error: any, data: any) => void;
+    headers?: IDictionary;
 }
 export interface SubscriptionProviderExecuteOptions {
     query: string;

package/build/types/state/collection.interfaces.d.ts

@@ -1,3 +1,5 @@
+import { PostrequestState } from './postrequest.interfaces';
+import { PrerequestState } from './prerequest.interfaces';
 import { ExportWindowState } from './window.interfaces';
 export declare type SortByOptions = 'a-z' | 'z-a' | 'newest' | 'oldest';
 export interface CollectionState {
@@ -12,11 +14,13 @@ export interface IQuery extends ExportWindowState {
     updated_at?: number;
 }
 export interface IQueryCollection {
-    id?: number;
+    id?: number | string;
     serverId?: number;
     title: string;
     queries: IQuery[];
     description?: string;
+    preRequest?: PrerequestState;
+    postRequest?: PostrequestState;
     /**
      * path of the collection in the collection tree
      * e.g. '/123/456'
@@ -26,7 +30,7 @@ export interface IQueryCollection {
     updated_at?: number;
 }
 export interface IQueryCollectionTree extends IQueryCollection {
-    id: number;
+    id: number | string;
     collections?: IQueryCollectionTree[];
 }
 export interface ExportCollectionState extends IQueryCollectionTree {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "altair-graphql-core",
-  "version": "4.4.2",
+  "version": "4.5.2",
   "description": "Several of the core logic for altair graphql client",
   "main": "./build/index.js",
   "types": "./build/index.d.ts",
@@ -53,13 +53,14 @@
     "convert-css-color-name-to-hex": "^0.1.1",
     "deepmerge": "^4.2.2",
     "graphql": "^15.5.1",
-    "graphql-ws": "^5.1.2",
+    "graphql-sse": "^1.2.2",
+    "graphql-ws": "^5.8.2",
     "loglevel": "^1.7.1",
     "loglevel-plugin-prefix": "^0.8.4",
     "rxjs": "^7.1.0",
-    "subscriptions-transport-ws": "^0.9.19",
+    "subscriptions-transport-ws": "0.9.19",
     "util": "^0.12.4",
     "uuid": "^8.3.2"
   },
-  "gitHead": "44bf6dbb486b9afb51be1cb56228903346f515d4"
+  "gitHead": "9536b57d20d1e05b013adf3c0885a8bfef8e2b88"
 }