@katanaperps/katana-perps-sdk 0.0.0-placeholder

package/dist/types/utils.d.ts

@@ -0,0 +1,67 @@
+/**
+ * An object that can be of any valid values but has string-only keys
+ *
+ * - Slightly better than using `any` or `object` types as it requires the value to
+ *   be a plain object.
+ */
+export type AnyObj = {
+    [key: string]: any;
+};
+export type UnknownObj = Record<PropertyKey, unknown>;
+/**
+ * An object of type `{}` , however Typescript defines that as
+ * "any non-null value", so this represents the same as
+ *
+ * @example
+ * ```typescript
+ * const emptyObj = {}
+ * ```
+ */
+export type EmptyObj = {
+    [key: string]: never;
+};
+/**
+ * Expand will expand an object type by rebuilding the object at the point it is used.
+ * which can be useful when the type is obscured due to utility types and you want
+ * to see the underlying type that is expected.
+ *
+ * - This can be very useful when a type is confusing at first glance, if it is
+ *   using utilities like Extract, Pick, Omit, extends, etc then `Expand` will
+ *   unwrap that into a coherent/flat type you can understand.
+ *
+ * @category Type - Utilities
+ *
+ * @example
+ * ```typescript
+ *  // the ExpandedCandle can be hovered to see the properties of KatanaPerpsCandle directly
+ *  type ExpandedCandle = Expand<KatanaPerpsCandle>;
+ * ```
+ */
+export type Expand<T> = T extends infer O ? {
+    [K in keyof O]: O[K];
+} : never;
+export type ExpandDeep<T, E extends string = never> = T extends ({
+    [key: string]: any;
+}) ? T extends infer O ? {
+    [K in keyof O]: K extends E ? O[K] : ExpandDeep<O[K], E>;
+} : never : T;
+export type AugmentedOptional<T extends AnyObj, K extends keyof T = keyof T> = Expand<T extends T ? Omit<T, K> & Partial<Pick<T, K>> : never>;
+/**
+ * Augments a type so that the provided keys are all changed to required.
+ */
+export type AugmentedRequired<T extends AnyObj, K extends keyof T = keyof T> = Expand<T extends T ? Omit<T, K> & Required<Pick<T, K>> : never>;
+/**
+ * Used to turn a type into the expected type for an actual request with
+ * parameters and signature properties.
+ *
+ * @category Type Utilities
+ */
+export interface RestRequestWithSignature<T extends AnyObj> {
+    readonly parameters: T;
+    readonly signature: string;
+}
+export interface Paginated<I extends AnyObj[]> {
+    count: number;
+    items: I;
+}
+//# sourceMappingURL=utils.d.ts.map

package/dist/types/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/types/utils.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,MAAM,MAAM,MAAM,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,CAAC;AAI5C,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;AAEtD;;;;;;;;GAQG;AACH,MAAM,MAAM,QAAQ,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK,CAAA;CAAE,CAAC;AAEhD;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,MAAM,MAAM,CAAC,CAAC,IAAI,CAAC,SAAS,MAAM,CAAC,GAAG;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAAE,GAAG,KAAK,CAAC;AAM7E,MAAM,MAAM,UAAU,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,GAAG,KAAK,IAChD,CAAC,SAAS,CACR;IACE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB,CACF,GACC,CAAC,SAAS,MAAM,CAAC,GACf;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;CAAE,GAC5D,KAAK,GACP,CAAC,CAAC;AAGN,MAAM,MAAM,iBAAiB,CAC3B,CAAC,SAAS,MAAM,EAChB,CAAC,SAAS,MAAM,CAAC,GAAG,MAAM,CAAC,IACzB,MAAM,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,iBAAiB,CAC3B,CAAC,SAAS,MAAM,EAChB,CAAC,SAAS,MAAM,CAAC,GAAG,MAAM,CAAC,IACzB,MAAM,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC;AAEpE;;;;;GAKG;AACH,MAAM,WAAW,wBAAwB,CAAC,CAAC,SAAS,MAAM;IACxD,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC;IACvB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,SAAS,CAAC,CAAC,SAAS,MAAM,EAAE;IAC3C,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,CAAC,CAAC;CACV"}

package/dist/types/utils.js

@@ -0,0 +1,3 @@
+"use strict";
+/* eslint-disable @typescript-eslint/no-explicit-any */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/webSocket/base.d.ts

@@ -0,0 +1,83 @@
+import type { MessageEventType, SubscriptionNamePublic, SubscriptionNameAuthenticated } from '#types/enums/index';
+/**
+ * - `subscription` Websocket messages always include a {@link MessageEventType type} property
+ *   which dictates the shape of its `data` property.
+ *   - `type` will be the name of the subscription that the message correlates to.
+ * - {@link MessageEventType.subscriptions subscriptions} type messages will instead have a
+ *   `subscriptions` property when dispatched.
+ * - **Tip:** Using the enum {@link MessageEventType} will make it easier to narrow the messages.
+ *
+ * <div>
+ * [[include:websocket-response-example.md]]
+ * </div>
+ *
+ * @privateRemarks
+ * <div>
+ *  The divs are a hack to get code highlighting to work in ts doc while not showing the include in the IDE
+ *  since the language server doesnt handle includes
+ * </div>
+ *
+ * @see enum {@link MessageEventType}
+ * @category Base Types
+ */
+export interface KatanaPerpsEventBase {
+    /**
+     * The type property is used to determine the shape of the data property of the update event.
+     *
+     * - Subscription update events will match {@link KatanaPerpsSubscriptionEventBase} with the subscription
+     *   name as the value for the {@link KatanaPerpsSubscriptionEventBase.type type} property.
+     * - Otherwise the {@link MessageEventType type} will be:
+     *   - {@link MessageEventType.subscriptions subscriptions} if you requested a list of all current subscriptions
+     *   - {@link MessageEventType.error error} if your request resulted in a server error
+     *
+     * @see enum {@link MessageEventType}
+     */
+    type: MessageEventType;
+    /**
+     * If the request provided a `cid` parameter, the response will include the `cid` provided.
+     */
+    cid?: string;
+    /**
+     * The data object will change based on the {@link type} of the message.
+     */
+    data?: object;
+    /**
+     * A list of all active subscriptions if the `type` is {@link MessageEventType.subscriptions subscriptions}
+     */
+    subscriptions?: unknown[];
+}
+/**
+ * - `subscription` Websocket messages always include a {@link MessageEventType type} property
+ *   which dictates the shape of its `data` property.
+ *   - `type` will be the name of the subscription that the message correlates to.
+ *   - Each `KatanaPerps<name>Event` interface will document its provided `data` shape and properties.
+ * - {@link MessageEventType.subscriptions subscriptions} type messages will instead have a
+ *   `subscriptions` property when dispatched.
+ * - **Tip:** Using the enum {@link MessageEventType} will make it easier to narrow the messages.
+ *
+ * <div>
+ * [[include:websocket-response-example.md]]
+ * </div>
+ *
+ * @privateRemarks
+ * <div>
+ *  The divs are a hack to get code highlighting to work in ts doc while not showing the include in the IDE
+ *  since the language server doesnt handle includes
+ * </div>
+ *
+ * @see enum {@link MessageEventType}
+ * @category Base Types
+ */
+export interface KatanaPerpsSubscriptionEventBase extends KatanaPerpsEventBase {
+    /**
+     * @inheritDoc
+     */
+    type: Extract<KatanaPerpsEventBase['type'], SubscriptionNamePublic | SubscriptionNameAuthenticated>;
+    /**
+     * @inheritDoc
+     */
+    data: object;
+    subscriptions?: undefined;
+    cid?: undefined;
+}
+//# sourceMappingURL=base.d.ts.map

package/dist/types/webSocket/base.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../../src/types/webSocket/base.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,gBAAgB,EAChB,sBAAsB,EACtB,6BAA6B,EAC9B,MAAM,oBAAoB,CAAC;AAE5B;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;;;;;;;OAUG;IACH,IAAI,EAAE,gBAAgB,CAAC;IACvB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,EAAE,CAAC;CAC3B;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,WAAW,gCAAiC,SAAQ,oBAAoB;IAC5E;;OAEG;IACH,IAAI,EAAE,OAAO,CACX,oBAAoB,CAAC,MAAM,CAAC,EAC5B,sBAAsB,GAAG,6BAA6B,CACvD,CAAC;IACF;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,CAAC,EAAE,SAAS,CAAC;IAC1B,GAAG,CAAC,EAAE,SAAS,CAAC;CACjB"}

package/dist/types/webSocket/base.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/webSocket/constants.d.ts

@@ -0,0 +1,41 @@
+import { SubscriptionNameAuthenticated } from '#types/enums/request';
+/**
+ * - No changes from {@link SubscriptionNameAuthenticated}, all authenticated subscriptions
+ *   may use the "short" name-only subscribe capability.
+ *
+ * @see alias {@link SubscriptionNameAuthenticated}
+ *
+ * @enum
+ * @internal
+ */
+export declare const WebSocketSubscriptionShortNameAuthenticated: {
+    readonly deposits: "deposits";
+    readonly fundingPayments: "fundingPayments";
+    readonly orders: "orders";
+    readonly positions: "positions";
+    readonly withdrawals: "withdrawals";
+    readonly webclient: "webclient";
+};
+export type WebSocketSubscriptionShortNameAuthenticated = (typeof SubscriptionNameAuthenticated)[keyof typeof SubscriptionNameAuthenticated];
+/**
+ * - For public subscriptions, all subscription types except {@link SubscriptionNamePublic.candles}
+ *   may use the "short" name-only subscribe capability.
+ *
+ * @see related {@link SubscriptionNamePublic}
+ *
+ * @enum
+ * @internal
+ */
+export declare const WebSocketSubscriptionShortNamePublic: {
+    readonly webclient: "webclient";
+    readonly tickers: "tickers";
+    readonly trades: "trades";
+    readonly liquidations: "liquidations";
+    readonly l1orderbook: "l1orderbook";
+    readonly l2orderbook: "l2orderbook";
+};
+export type WebSocketSubscriptionShortNamePublic = (typeof WebSocketSubscriptionShortNamePublic)[keyof typeof WebSocketSubscriptionShortNamePublic];
+export declare const WebSocketSubscriptionShortNamesAuthenticated: readonly ("deposits" | "fundingPayments" | "orders" | "positions" | "withdrawals" | "webclient")[];
+export declare const WebSocketSubscriptionShortNamesPublic: readonly ("webclient" | "tickers" | "trades" | "liquidations" | "l1orderbook" | "l2orderbook")[];
+export declare const WebSocketSubscriptionShortNames: readonly ("deposits" | "fundingPayments" | "orders" | "positions" | "withdrawals" | "webclient" | "tickers" | "trades" | "liquidations" | "l1orderbook" | "l2orderbook")[];
+//# sourceMappingURL=constants.d.ts.map

package/dist/types/webSocket/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../src/types/webSocket/constants.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,6BAA6B,EAC9B,MAAM,sBAAsB,CAAC;AA0B9B;;;;;;;;GAQG;AACH,eAAO,MAAM,2CAA2C;;;;;;;CACzB,CAAC;AAEhC,MAAM,MAAM,2CAA2C,GACrD,CAAC,OAAO,6BAA6B,CAAC,CAAC,MAAM,OAAO,6BAA6B,CAAC,CAAC;AAErF;;;;;;;;GAQG;AACH,eAAO,MAAM,oCAAoC;;;;;;;CAIU,CAAC;AAE5D,MAAM,MAAM,oCAAoC,GAC9C,CAAC,OAAO,oCAAoC,CAAC,CAAC,MAAM,OAAO,oCAAoC,CAAC,CAAC;AAEnG,eAAO,MAAM,4CAA4C,oGAEvD,CAAC;AAEH,eAAO,MAAM,qCAAqC,kGAEhD,CAAC;AAEH,eAAO,MAAM,+BAA+B,4KAGjC,CAAC"}

package/dist/types/webSocket/constants.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebSocketSubscriptionShortNames = exports.WebSocketSubscriptionShortNamesPublic = exports.WebSocketSubscriptionShortNamesAuthenticated = exports.WebSocketSubscriptionShortNamePublic = exports.WebSocketSubscriptionShortNameAuthenticated = void 0;
+const request_1 = require("#types/enums/request");
+/**
+ * <div>
+ * [[include:base.md]]
+ * </div>
+ *
+ * A Base type that all authenticated WebSocket subscriptions extend upon.
+ *
+ * @see         [WebSocket API Docs](https://api-docs-v1-perps.katana.network/#websocket-api-interaction)
+ * @see names   {@link SubscriptionNameAuthenticated}
+ * @see related {@link KatanaPerpsSubscribeTypeAuthenticated}
+ */
+/**
+ * Simple filter function to remove the `candles` that is both type safe
+ * and does not require a type assertion.
+ *
+ * @internal
+ */
+function filterCandles(value) {
+    return value !== request_1.SubscriptionNamePublic.candles;
+}
+/**
+ * - No changes from {@link SubscriptionNameAuthenticated}, all authenticated subscriptions
+ *   may use the "short" name-only subscribe capability.
+ *
+ * @see alias {@link SubscriptionNameAuthenticated}
+ *
+ * @enum
+ * @internal
+ */
+exports.WebSocketSubscriptionShortNameAuthenticated = request_1.SubscriptionNameAuthenticated;
+/**
+ * - For public subscriptions, all subscription types except {@link SubscriptionNamePublic.candles}
+ *   may use the "short" name-only subscribe capability.
+ *
+ * @see related {@link SubscriptionNamePublic}
+ *
+ * @enum
+ * @internal
+ */
+exports.WebSocketSubscriptionShortNamePublic = Object.fromEntries(Object.entries(request_1.SubscriptionNamePublic).filter(([, value]) => filterCandles(value)));
+exports.WebSocketSubscriptionShortNamesAuthenticated = Object.freeze([
+    ...Object.values(exports.WebSocketSubscriptionShortNameAuthenticated),
+]);
+exports.WebSocketSubscriptionShortNamesPublic = Object.freeze([
+    ...Object.values(exports.WebSocketSubscriptionShortNamePublic),
+]);
+exports.WebSocketSubscriptionShortNames = Object.freeze([
+    ...exports.WebSocketSubscriptionShortNamesAuthenticated,
+    ...exports.WebSocketSubscriptionShortNamesPublic,
+]);

package/dist/types/webSocket/index.d.ts

@@ -0,0 +1,6 @@
+export * from '#types/webSocket/request/index';
+export * from '#types/webSocket/base';
+export * from '#types/webSocket/response/index';
+export * from '#types/webSocket/constants';
+export * from '#types/webSocket/options';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/webSocket/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/types/webSocket/index.ts"],"names":[],"mappings":"AAAA,cAAc,gCAAgC,CAAC;AAC/C,cAAc,uBAAuB,CAAC;AACtC,cAAc,iCAAiC,CAAC;AAChD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,0BAA0B,CAAC"}

package/dist/types/webSocket/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("#types/webSocket/request/index"), exports);
+tslib_1.__exportStar(require("#types/webSocket/base"), exports);
+tslib_1.__exportStar(require("#types/webSocket/response/index"), exports);
+tslib_1.__exportStar(require("#types/webSocket/constants"), exports);
+tslib_1.__exportStar(require("#types/webSocket/options"), exports);

package/dist/types/webSocket/options.d.ts

@@ -0,0 +1,276 @@
+import type { AugmentedRequired } from '#types/utils';
+/**
+ * Providing the `auth` property to the {@link _WebSocketClient WebSocketClient} constructor will allow you
+ * to make {@link _WebSocketSubscribeAuthenticatedType authenticated subscriptions} using the
+ * {@link _WebSocketClient.subscribeAuthenticated subscribeAuthenticated} method
+ *
+ * @example
+ * ```typescript
+ *   import { WebSocketClient } from '@katanaperps/katana-perps-sdk'
+ *
+ *   const client = new WebSocketClient({
+ *    // Edit the values before for your environment
+ *    auth: {
+ *      apiKey: '1f7c4f52-4af7-4e1b-aa94-94fac8d931aa',
+ *      apiSecret: 'axuh3ywgg854aq7m73oy6gnnpj5ar9a67szuw5lclbz77zqu0j',
+ *      wallet: '0x...',
+ *    }
+ *    // sandbox: true,
+ *    // logger: console.log
+ *  });
+ * ```
+ *
+ * <br />
+ *
+ * ---
+ *
+ * @see parent {@link WebSocketClientOptions}
+ */
+export interface WebSocketClientAuthOptions {
+    /**
+     * The user's API Key for the account they wish to make authenticated subscriptions with,
+     * this is used to retrieve a [WebSocket Token](https://api-docs-v1-perps.katana.network/#websocket-authentication-endpoints)
+     * that can be used to authenticate the connection.
+     *
+     * @see [WebSocket Token API Docs](https://api-docs-v1-perps.katana.network/#websocket-authentication-endpoints)
+     */
+    apiKey: string;
+    /**
+     * Used to compute HMAC signature when refreshing the
+     * [WebSocket Token](https://api-docs-v1-perps.katana.network/#websocket-authentication-endpoints)
+     *
+     * @see [WebSocket Token API Docs](https://api-docs-v1-perps.katana.network/#websocket-authentication-endpoints)
+     */
+    apiSecret: string;
+    /**
+     * The wallet that should be used when subscribing to authenticated channels.
+     */
+    wallet: string;
+}
+export interface WebSocketClientOptionsBase {
+    /**
+     * If subscribing to {@link _WebSocketSubscribeAuthenticatedType authenticated subscriptions} is
+     * desired, you must provide this property matching {@link WebSocketClientAuthOptions} which includes:
+     *  - {@link WebSocketClientAuthOptions.apiKey apiKey}
+     *  - {@link WebSocketClientAuthOptions.apiSecret apiSecret}
+     *  - {@link WebSocketClientAuthOptions.wallet wallet}
+     *
+     * ---
+     *
+     * - These properties are used to fetch a [WebSocket Token](https://api-docs-v1-perps.katana.network/#websocket-authentication-endpoints)
+     *   from the REST API.
+     *
+     * ---
+     *
+     * @see [WebSocket Token API Docs](https://api-docs-v1-perps.katana.network/#websocket-authentication-endpoints)
+     */
+    readonly auth?: WebSocketClientAuthOptions;
+    /**
+     * If `true`, client will point to the sandbox API endpoint.
+     *
+     * @see [Sandbox API Documentation](https://api-docs-v1-perps.katana.network/#sandbox)
+     *
+     * @defaultValue false
+     */
+    sandbox?: boolean;
+    /**
+     * Provide a logging function if you would like the client to log internal messages.  The function
+     * should match `console.log` signature.
+     *
+     * @example
+     * ```typescript
+     * new WebSocketClient({
+     *  logger: console.log
+     * })
+     * ```
+     */
+    logger?: typeof console.log;
+    /**
+     * May be used to uniquely identify this client if the {@link logger} function is utilized.
+     *
+     * - If not provided, clients will receive id's which increment each time they are created.
+     */
+    clientId?: string;
+    /**
+     * If `true` (default), automatically reconnects when connection is closed by the server or network errors
+     *
+     * @see [WebSocket Connection Maintenance](https://api-docs-v1-perps.katana.network/#connection-maintenance)
+     *
+     * @defaultValue
+     * ```typescript
+     * true
+     * ```
+     */
+    shouldReconnectAutomatically?: boolean;
+    /**
+     * The base URL to use when connecting to the WebSocket API.
+     *
+     * - Allows you to use a custom URL to connect to the WebSocket API.
+     * - *This is unlikely to be useful for most users.*
+     *   - The `baseWebSocketURL` is automatically set based on
+     *     whether you indicate you want to use the {@link sandbox} or not.
+     *
+     * @internal
+     *
+     * @example
+     * 'wss://websocket-perps.katana.network/v1'
+     */
+    baseWebSocketURL?: string;
+    /**
+     * The base URL to use when connecting to the REST API for WebSocket tokens.
+     *
+     * - Allows you to use a custom URL to connect to a REST API serving websocket tokens.
+     * - Only used for authenticated subscriptions
+     * - *This is unlikely to be useful for most users.*
+     *   - The `baseRestApiURL` is automatically set based on
+     *     whether you indicate you want to use the {@link sandbox} or not.
+     *
+     * @internal
+     *
+     * @example
+     *  `https://api-perps.katana.network/v1`
+     */
+    baseRestApiURL?: string;
+    /**
+     * [INTERNAL USE ONLY] - Will not have any functionality in normal circumstances.
+     *
+     * - Note that `wallet` is passed to the {@link auth} object for authenticated cases with
+     *   WebSocket.
+     *
+     * @internal
+     */
+    readonly wallet?: string;
+    /**
+     * [INTERNAL USE ONLY]
+     *
+     * @see [WebSocket API Documentation](https://api-docs-v1-perps.katana.network/#websocket-authentication-endpoints)
+     *
+     * @internal
+     */
+    readonly websocketAuthTokenFetch?: (options: WebSocketClientOptionsWithFetch) => string | Promise<string>;
+}
+/**
+ * WebSocket constructor options which will only allow you to subscribe to
+ * {@link _WebSocketSubscribePublicType public subscriptions}.
+ *
+ * - All properties are optional, thus `new WebSocketClient()` is valid for public subscriptions.
+ *
+ * @example
+ * ```typescript
+ *   import { WebSocketClient } from '@katanaperps/katana-perps-sdk';
+ *
+ *   // all options are optional for public only clients
+ *   const webSocketClientPublicOnly = new WebSocketClient({
+ *     // sandbox: true,
+ *   });
+ * ```
+ *
+ * @category WebSocket - Client Options
+ */
+export interface WebSocketClientOptionsPublicOnly extends WebSocketClientOptionsBase {
+    readonly auth?: undefined;
+    readonly wallet?: undefined;
+    readonly websocketAuthTokenFetch?: undefined;
+}
+/**
+ * @internal
+ */
+export interface WebSocketClientOptionsWithFetch extends WebSocketClientOptionsBase {
+    readonly auth?: undefined;
+    /**
+     * @inheritDoc
+     */
+    readonly wallet: string;
+    /**
+     * @inheritDoc
+     */
+    readonly websocketAuthTokenFetch: WebSocketClientOptionsBase['websocketAuthTokenFetch'] & {};
+}
+/**
+ * Providing the required {@link WebSocketClientAuthOptions} object will allow the client to
+ * make {@link _WebSocketSubscribeAuthenticatedType authenticated subscriptions}
+ * as well as {@link _WebSocketSubscribePublicType public subscriptions}
+ *
+ * @example
+ * ```typescript
+ *   import { WebSocketClient } from '@katanaperps/katana-perps-sdk'
+ *
+ *   const client = new WebSocketClient({
+ *    // Edit the values before for your environment
+ *    auth: {
+ *      apiKey: '1f7c4f52-4af7-4e1b-aa94-94fac8d931aa',
+ *      apiSecret: 'axuh3ywgg854aq7m73oy6gnnpj5ar9a67szuw5lclbz77zqu0j',
+ *      wallet: '0x...',
+ *    }
+ *    // sandbox: true,
+ *    // logger: console.log
+ *  });
+ * ```
+ *
+ * <br />
+ *
+ * ---
+ *
+ * @see docs [WebSocket API Documentation](https://api-docs-v1-perps.katana.network/#subscriptions)
+ *
+ * @category WebSocket - Client Options
+ */
+export interface WebSocketClientOptionsWithAPIKey extends WebSocketClientOptionsBase {
+    /**
+     * @inheritDoc
+     */
+    readonly auth: WebSocketClientOptionsBase['auth'] & {};
+    readonly wallet?: undefined;
+    readonly websocketAuthTokenFetch?: undefined;
+}
+/**
+ * WebSocket API client options
+ *
+ * You must provide options that match either:
+ *
+ * - To make {@link _WebSocketSubscribePublicType public subscriptions}, all options are optional.
+ * - To make {@link _WebSocketSubscribeAuthenticatedType authenticated subscriptions}:
+ *   - you must provide a valid {@link WebSocketClientAuthOptions auth}
+ *     property in the constructor options which includes:
+ *     - {@link WebSocketClientAuthOptions.apiKey apiKey}
+ *     - {@link WebSocketClientAuthOptions.apiSecret apiSecret}
+ *     - {@link WebSocketClientAuthOptions.wallet wallet}
+ *
+ * @example
+ * ```typescript
+ *   import { WebSocketClient } from '@katanaperps/katana-perps-sdk';
+ *
+ *   // all options are optional for public only clients
+ *   const webSocketClientPublicOnly = new WebSocketClient();
+ *
+ *   const client = new WebSocketClient({
+ *    // Edit the values before for your environment
+ *    auth: {
+ *      apiKey: '1f7c4f52-4af7-4e1b-aa94-94fac8d931aa',
+ *      apiSecret: 'axuh3ywgg854aq7m73oy6gnnpj5ar9a67szuw5lclbz77zqu0j',
+ *      wallet: '0x...',
+ *    }
+ *    // sandbox: true,
+ *    // logger: console.log
+ *  });
+ * ```
+ *
+ * <br />
+ *
+ * ---
+ *
+ * @see docs    [WebSocket API Documentation](https://api-docs-v1-perps.katana.network/#subscriptions)
+ * @see related {@link WebSocketClientOptionsWithAPIKey}
+ * @see related {@link WebSocketClientOptionsPublicOnly}
+ *
+ * @category WebSocket - Client Options
+ * @category API Clients
+ */
+export type WebSocketClientOptions = WebSocketClientOptionsWithAPIKey | WebSocketClientOptionsPublicOnly | WebSocketClientOptionsWithFetch;
+/**
+ * Represents the shape of the options after being initialized during runtime.
+ *
+ * @internal
+ */
+export type WebSocketClientOptionsInitialized = AugmentedRequired<WebSocketClientOptionsBase, 'baseWebSocketURL' | 'baseRestApiURL' | 'sandbox' | 'shouldReconnectAutomatically' | 'clientId'>;
+//# sourceMappingURL=options.d.ts.map

package/dist/types/webSocket/options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../../../src/types/webSocket/options.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAMtD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,WAAW,0BAA0B;IACzC;;;;;;OAMG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;;;OAKG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,0BAA0B;IACzC;;;;;;;;;;;;;;;OAeG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,0BAA0B,CAAC;IAE3C;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,OAAO,OAAO,CAAC,GAAG,CAAC;IAE5B;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;;;;;;OASG;IACH,4BAA4B,CAAC,EAAE,OAAO,CAAC;IAEvC;;;;;;;;;;;;OAYG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;;;;;;;;;;;;OAaG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;;;;OAOG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAEzB;;;;;;OAMG;IACH,QAAQ,CAAC,uBAAuB,CAAC,EAAE,CACjC,OAAO,EAAE,+BAA+B,KACrC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;CAC/B;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,WAAW,gCACf,SAAQ,0BAA0B;IAClC,QAAQ,CAAC,IAAI,CAAC,EAAE,SAAS,CAAC;IAC1B,QAAQ,CAAC,MAAM,CAAC,EAAE,SAAS,CAAC;IAC5B,QAAQ,CAAC,uBAAuB,CAAC,EAAE,SAAS,CAAC;CAC9C;AAED;;GAEG;AACH,MAAM,WAAW,+BACf,SAAQ,0BAA0B;IAClC,QAAQ,CAAC,IAAI,CAAC,EAAE,SAAS,CAAC;IAC1B;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,QAAQ,CAAC,uBAAuB,EAAE,0BAA0B,CAAC,yBAAyB,CAAC,GAAG,EAAE,CAAC;CAC9F;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,WAAW,gCACf,SAAQ,0BAA0B;IAClC;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,0BAA0B,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC;IACvD,QAAQ,CAAC,MAAM,CAAC,EAAE,SAAS,CAAC;IAC5B,QAAQ,CAAC,uBAAuB,CAAC,EAAE,SAAS,CAAC;CAC9C;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,MAAM,MAAM,sBAAsB,GAC9B,gCAAgC,GAChC,gCAAgC,GAChC,+BAA+B,CAAC;AAEpC;;;;GAIG;AACH,MAAM,MAAM,iCAAiC,GAAG,iBAAiB,CAC/D,0BAA0B,EACxB,kBAAkB,GAClB,gBAAgB,GAChB,SAAS,GACT,8BAA8B,GAC9B,UAAU,CACb,CAAC"}

package/dist/types/webSocket/options.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/webSocket/request/index.d.ts

@@ -0,0 +1,3 @@
+export * from '#types/webSocket/request/request';
+export * from '#types/webSocket/request/subscriptions';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/webSocket/request/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/types/webSocket/request/index.ts"],"names":[],"mappings":"AAAA,cAAc,kCAAkC,CAAC;AACjD,cAAc,wCAAwC,CAAC"}

package/dist/types/webSocket/request/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("#types/webSocket/request/request"), exports);
+tslib_1.__exportStar(require("#types/webSocket/request/subscriptions"), exports);