@aui.io/aui-client-staging 0.0.1

package/README.md

@@ -0,0 +1,244 @@
+# Aui TypeScript Library
+
+[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Faui-io%2Faui-client-staging-typescript)
+[![npm shield](https://img.shields.io/npm/v/@aui.io/aui-client-staging)](https://www.npmjs.com/package/@aui.io/aui-client-staging)
+
+The Aui TypeScript library provides convenient access to the Aui APIs from TypeScript.
+
+## Installation
+
+```sh
+npm i -s @aui.io/aui-client-staging
+```
+
+## Reference
+
+A full reference for this library is available [here](https://github.com/aui-io/aui-client-staging-typescript/blob/HEAD/./reference.md).
+
+## Usage
+
+Instantiate and use the client with the following:
+
+```typescript
+import { ApolloClient } from "@aui.io/aui-client-staging";
+
+const client = new ApolloClient({ networkApiKey: "YOUR_NETWORK_API_KEY" });
+await client.controllerApi.createTask({
+    user_id: "user_id",
+    task_origin_type: "stores"
+});
+```
+
+## Request And Response Types
+
+The SDK exports all request and response types as TypeScript interfaces. Simply import them with the
+following namespace:
+
+```typescript
+import { Apollo } from "@aui.io/aui-client-staging";
+
+const request: Apollo.ListUserTasksRequest = {
+    ...
+};
+```
+
+## Exception Handling
+
+When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
+will be thrown.
+
+```typescript
+import { ApolloError } from "@aui.io/aui-client-staging";
+
+try {
+    await client.controllerApi.createTask(...);
+} catch (err) {
+    if (err instanceof ApolloError) {
+        console.log(err.statusCode);
+        console.log(err.message);
+        console.log(err.body);
+        console.log(err.rawResponse);
+    }
+}
+```
+
+## Advanced
+
+### Additional Headers
+
+If you would like to send additional headers as part of the request, use the `headers` request option.
+
+```typescript
+const response = await client.controllerApi.createTask(..., {
+    headers: {
+        'X-Custom-Header': 'custom value'
+    }
+});
+```
+
+### Additional Query String Parameters
+
+If you would like to send additional query string parameters as part of the request, use the `queryParams` request option.
+
+```typescript
+const response = await client.controllerApi.createTask(..., {
+    queryParams: {
+        'customQueryParamKey': 'custom query param value'
+    }
+});
+```
+
+### Retries
+
+The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
+as the request is deemed retryable and the number of retry attempts has not grown larger than the configured
+retry limit (default: 2).
+
+A request is deemed retryable when any of the following HTTP status codes is returned:
+
+- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
+- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
+
+Use the `maxRetries` request option to configure this behavior.
+
+```typescript
+const response = await client.controllerApi.createTask(..., {
+    maxRetries: 0 // override maxRetries at the request level
+});
+```
+
+### Timeouts
+
+The SDK defaults to a 60 second timeout. Use the `timeoutInSeconds` option to configure this behavior.
+
+```typescript
+const response = await client.controllerApi.createTask(..., {
+    timeoutInSeconds: 30 // override timeout to 30s
+});
+```
+
+### Aborting Requests
+
+The SDK allows users to abort requests at any point by passing in an abort signal.
+
+```typescript
+const controller = new AbortController();
+const response = await client.controllerApi.createTask(..., {
+    abortSignal: controller.signal
+});
+controller.abort(); // aborts the request
+```
+
+### Access Raw Response Data
+
+The SDK provides access to raw response data, including headers, through the `.withRawResponse()` method.
+The `.withRawResponse()` method returns a promise that results to an object with a `data` and a `rawResponse` property.
+
+```typescript
+const { data, rawResponse } = await client.controllerApi.createTask(...).withRawResponse();
+
+console.log(data);
+console.log(rawResponse.headers['X-My-Header']);
+```
+
+### Logging
+
+The SDK supports logging. You can configure the logger by passing in a `logging` object to the client options.
+
+```typescript
+import { ApolloClient, logging } from "@aui.io/aui-client-staging";
+
+const client = new ApolloClient({
+    ...
+    logging: {
+        level: logging.LogLevel.Debug, // defaults to logging.LogLevel.Info
+        logger: new logging.ConsoleLogger(), // defaults to ConsoleLogger
+        silent: false, // defaults to true, set to false to enable logging
+    }
+});
+```
+The `logging` object can have the following properties:
+- `level`: The log level to use. Defaults to `logging.LogLevel.Info`.
+- `logger`: The logger to use. Defaults to a `logging.ConsoleLogger`.
+- `silent`: Whether to silence the logger. Defaults to `true`.
+
+The `level` property can be one of the following values:
+- `logging.LogLevel.Debug`
+- `logging.LogLevel.Info`
+- `logging.LogLevel.Warn`
+- `logging.LogLevel.Error`
+
+To provide a custom logger, you can pass in an object that implements the `logging.ILogger` interface.
+
+<details>
+<summary>Custom logger examples</summary>
+
+Here's an example using the popular `winston` logging library.
+```ts
+import winston from 'winston';
+
+const winstonLogger = winston.createLogger({...});
+
+const logger: logging.ILogger = {
+    debug: (msg, ...args) => winstonLogger.debug(msg, ...args),
+    info: (msg, ...args) => winstonLogger.info(msg, ...args),
+    warn: (msg, ...args) => winstonLogger.warn(msg, ...args),
+    error: (msg, ...args) => winstonLogger.error(msg, ...args),
+};
+```
+
+Here's an example using the popular `pino` logging library.
+
+```ts
+import pino from 'pino';
+
+const pinoLogger = pino({...});
+
+const logger: logging.ILogger = {
+  debug: (msg, ...args) => pinoLogger.debug(args, msg),
+  info: (msg, ...args) => pinoLogger.info(args, msg),
+  warn: (msg, ...args) => pinoLogger.warn(args, msg),
+  error: (msg, ...args) => pinoLogger.error(args, msg),
+};
+```
+</details>
+
+
+### Runtime Compatibility
+
+
+The SDK works in the following runtimes:
+
+
+
+- Node.js 18+
+- Vercel
+- Cloudflare Workers
+- Deno v1.25+
+- Bun 1.0+
+- React Native
+
+### Customizing Fetch Client
+
+The SDK provides a way for you to customize the underlying HTTP client / Fetch function. If you're running in an
+unsupported environment, this provides a way for you to break glass and ensure the SDK works.
+
+```typescript
+import { ApolloClient } from "@aui.io/aui-client-staging";
+
+const client = new ApolloClient({
+    ...
+    fetcher: // provide your implementation here
+});
+```
+
+## Contributing
+
+While we value open-source contributions to this SDK, this library is generated programmatically.
+Additions made directly to this library would have to be moved over to our generation code,
+otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
+a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
+an issue first to discuss with us!
+
+On the other hand, contributions to the README are always very welcome!

package/dist/cjs/BaseClient.d.ts

@@ -0,0 +1,33 @@
+import type * as core from "./core/index.js";
+import type * as environments from "./environments.js";
+export interface BaseClientOptions {
+    environment?: core.Supplier<environments.ApolloEnvironment | environments.ApolloEnvironmentUrls>;
+    /** Specify a custom URL to connect the client to. */
+    baseUrl?: core.Supplier<string>;
+    /** Override the x-network-api-key header */
+    networkApiKey?: core.Supplier<string | undefined>;
+    /** Additional headers to include in requests. */
+    headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+    /** The default maximum time to wait for a response in seconds. */
+    timeoutInSeconds?: number;
+    /** The default number of times to retry the request. Defaults to 2. */
+    maxRetries?: number;
+    /** Provide a custom fetch implementation. Useful for platforms that don't have a built-in fetch or need a custom implementation. */
+    fetch?: typeof fetch;
+    /** Configure logging for the client. */
+    logging?: core.logging.LogConfig | core.logging.Logger;
+}
+export interface BaseRequestOptions {
+    /** The maximum time to wait for a response in seconds. */
+    timeoutInSeconds?: number;
+    /** The number of times to retry the request. Defaults to 2. */
+    maxRetries?: number;
+    /** A hook to abort the request. */
+    abortSignal?: AbortSignal;
+    /** Override the x-network-api-key header */
+    networkApiKey?: string | undefined;
+    /** Additional query string parameters to include in the request. */
+    queryParams?: Record<string, unknown>;
+    /** Additional headers to include in the request. */
+    headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+}

package/dist/cjs/BaseClient.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/Client.d.ts

@@ -0,0 +1,17 @@
+import { ApolloWsSession } from "./api/resources/apolloWsSession/client/Client.js";
+import { ControllerApi } from "./api/resources/controllerApi/client/Client.js";
+import type { BaseClientOptions, BaseRequestOptions } from "./BaseClient.js";
+export declare namespace ApolloClient {
+    interface Options extends BaseClientOptions {
+    }
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class ApolloClient {
+    protected readonly _options: ApolloClient.Options;
+    protected _controllerApi: ControllerApi | undefined;
+    protected _apolloWsSession: ApolloWsSession | undefined;
+    constructor(_options?: ApolloClient.Options);
+    get controllerApi(): ControllerApi;
+    get apolloWsSession(): ApolloWsSession;
+}

package/dist/cjs/Client.js

@@ -0,0 +1,63 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApolloClient = void 0;
+const Client_js_1 = require("./api/resources/apolloWsSession/client/Client.js");
+const Client_js_2 = require("./api/resources/controllerApi/client/Client.js");
+const headers_js_1 = require("./core/headers.js");
+const core = __importStar(require("./core/index.js"));
+class ApolloClient {
+    constructor(_options = {}) {
+        this._options = Object.assign(Object.assign({}, _options), { logging: core.logging.createLogger(_options === null || _options === void 0 ? void 0 : _options.logging), headers: (0, headers_js_1.mergeHeaders)({
+                "x-network-api-key": _options === null || _options === void 0 ? void 0 : _options.networkApiKey,
+                "X-Fern-Language": "JavaScript",
+                "X-Fern-SDK-Name": "@aui.io/aui-client-staging",
+                "X-Fern-SDK-Version": "0.0.1",
+                "User-Agent": "@aui.io/aui-client-staging/0.0.1",
+                "X-Fern-Runtime": core.RUNTIME.type,
+                "X-Fern-Runtime-Version": core.RUNTIME.version,
+            }, _options === null || _options === void 0 ? void 0 : _options.headers) });
+    }
+    get controllerApi() {
+        var _a;
+        return ((_a = this._controllerApi) !== null && _a !== void 0 ? _a : (this._controllerApi = new Client_js_2.ControllerApi(this._options)));
+    }
+    get apolloWsSession() {
+        var _a;
+        return ((_a = this._apolloWsSession) !== null && _a !== void 0 ? _a : (this._apolloWsSession = new Client_js_1.ApolloWsSession(this._options)));
+    }
+}
+exports.ApolloClient = ApolloClient;

package/dist/cjs/api/errors/UnprocessableEntityError.d.ts

@@ -0,0 +1,6 @@
+import type * as core from "../../core/index.js";
+import * as errors from "../../errors/index.js";
+import type * as Apollo from "../index.js";
+export declare class UnprocessableEntityError extends errors.ApolloError {
+    constructor(body: Apollo.HttpValidationError, rawResponse?: core.RawResponse);
+}

package/dist/cjs/api/errors/UnprocessableEntityError.js

@@ -0,0 +1,50 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UnprocessableEntityError = void 0;
+const errors = __importStar(require("../../errors/index.js"));
+class UnprocessableEntityError extends errors.ApolloError {
+    constructor(body, rawResponse) {
+        super({
+            message: "UnprocessableEntityError",
+            statusCode: 422,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, UnprocessableEntityError.prototype);
+    }
+}
+exports.UnprocessableEntityError = UnprocessableEntityError;

package/dist/cjs/api/errors/index.d.ts

@@ -0,0 +1 @@
+export * from "./UnprocessableEntityError.js";

package/dist/cjs/api/errors/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./UnprocessableEntityError.js"), exports);

package/dist/cjs/api/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./errors/index.js";
+export * from "./resources/index.js";
+export * from "./types/index.js";

package/dist/cjs/api/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./errors/index.js"), exports);
+__exportStar(require("./resources/index.js"), exports);
+__exportStar(require("./types/index.js"), exports);

package/dist/cjs/api/resources/apolloWsSession/client/Client.d.ts

@@ -0,0 +1,19 @@
+import type { BaseClientOptions } from "../../../../BaseClient.js";
+import { ApolloWsSessionSocket } from "./Socket.js";
+export declare namespace ApolloWsSession {
+    interface Options extends BaseClientOptions {
+    }
+    interface ConnectArgs {
+        /** Arbitrary headers to send with the websocket connect request. */
+        headers?: Record<string, string>;
+        /** Enable debug mode on the websocket. Defaults to false. */
+        debug?: boolean;
+        /** Number of reconnect attempts. Defaults to 30. */
+        reconnectAttempts?: number;
+    }
+}
+export declare class ApolloWsSession {
+    protected readonly _options: ApolloWsSession.Options;
+    constructor(_options?: ApolloWsSession.Options);
+    connect(args?: ApolloWsSession.ConnectArgs): Promise<ApolloWsSessionSocket>;
+}

package/dist/cjs/api/resources/apolloWsSession/client/Client.js

@@ -0,0 +1,70 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApolloWsSession = void 0;
+const core = __importStar(require("../../../../core/index.js"));
+const environments = __importStar(require("../../../../environments.js"));
+const Socket_js_1 = require("./Socket.js");
+class ApolloWsSession {
+    constructor(_options = {}) {
+        this._options = _options;
+    }
+    connect() {
+        return __awaiter(this, arguments, void 0, function* (args = {}) {
+            var _a, _b;
+            const { headers, debug, reconnectAttempts } = args;
+            const _headers = Object.assign({}, headers);
+            const socket = new core.ReconnectingWebSocket({
+                url: core.url.join((_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : ((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.ApolloEnvironment.Gcp).gcp, "/ia-controller/api/v1/external/session"),
+                protocols: [],
+                queryParameters: {},
+                headers: _headers,
+                options: { debug: debug !== null && debug !== void 0 ? debug : false, maxRetries: reconnectAttempts !== null && reconnectAttempts !== void 0 ? reconnectAttempts : 30 },
+            });
+            return new Socket_js_1.ApolloWsSessionSocket({ socket });
+        });
+    }
+}
+exports.ApolloWsSession = ApolloWsSession;

package/dist/cjs/api/resources/apolloWsSession/client/Socket.d.ts

@@ -0,0 +1,49 @@
+import * as core from "../../../../core/index.js";
+import type * as Apollo from "../../../index.js";
+export declare namespace ApolloWsSessionSocket {
+    interface Args {
+        socket: core.ReconnectingWebSocket;
+    }
+    type Response = Apollo.StreamingUpdatePayload | Apollo.FinalMessagePayload | Apollo.ErrorMessagePayload;
+    type EventHandlers = {
+        open?: () => void;
+        message?: (message: Response) => void;
+        close?: (event: core.CloseEvent) => void;
+        error?: (error: Error) => void;
+    };
+}
+export declare class ApolloWsSessionSocket {
+    readonly socket: core.ReconnectingWebSocket;
+    protected readonly eventHandlers: ApolloWsSessionSocket.EventHandlers;
+    private handleOpen;
+    private handleMessage;
+    private handleClose;
+    private handleError;
+    constructor(args: ApolloWsSessionSocket.Args);
+    /** The current state of the connection; this is one of the readyState constants. */
+    get readyState(): number;
+    /**
+     * @param event - The event to attach to.
+     * @param callback - The callback to run when the event is triggered.
+     * Usage:
+     * ```typescript
+     * this.on('open', () => {
+     *     console.log('The websocket is open');
+     * });
+     * ```
+     */
+    on<T extends keyof ApolloWsSessionSocket.EventHandlers>(event: T, callback: ApolloWsSessionSocket.EventHandlers[T]): void;
+    sendUserMessage(message: Apollo.UserMessagePayload): void;
+    /** Connect to the websocket and register event handlers. */
+    connect(): ApolloWsSessionSocket;
+    /** Close the websocket and unregister event handlers. */
+    close(): void;
+    /** Returns a promise that resolves when the websocket is open. */
+    waitForOpen(): Promise<core.ReconnectingWebSocket>;
+    /** Asserts that the websocket is open. */
+    private assertSocketIsOpen;
+    /** Send a binary payload to the websocket. */
+    protected sendBinary(payload: ArrayBufferLike | Blob | ArrayBufferView): void;
+    /** Send a JSON payload to the websocket. */
+    protected sendJson(payload: Apollo.UserMessagePayload): void;
+}