@jsnw/kalshi-client 0.0.1

package/dist/index.d.mts

@@ -0,0 +1,463 @@
+import { z } from "zod";
+import { Agent } from "node:http";
+
+//#region src/consts.d.ts
+declare const HTTP_METHOD: readonly ["get", "post", "put", "patch", "delete", "head", "options"];
+declare const KALSHI_ENVIRONMENT: readonly ["development", "production"];
+type HttpMethod = typeof HTTP_METHOD[number] | Uppercase<typeof HTTP_METHOD[number]>;
+type KalshiEnvironment = typeof KALSHI_ENVIRONMENT[number];
+//#endregion
+//#region src/request-signer.d.ts
+interface SignatureParameters {
+  timestamp: Date | number;
+  httpMethod: HttpMethod;
+  path: string;
+}
+interface IRequestSigner {
+  getSignature(params: SignatureParameters): string;
+}
+interface RequestSignerOptions {
+  privateKey: string;
+}
+declare class RequestSigner implements IRequestSigner {
+  private readonly privkey;
+  /**
+   * @param {RequestSignerOptions} options
+   */
+  constructor(options: RequestSignerOptions);
+  /**
+   * @param {SignatureParameters} params
+   * @return {string}
+   */
+  getSignature({
+    timestamp,
+    httpMethod,
+    path
+  }: SignatureParameters): string;
+}
+//#endregion
+//#region src/credentials-provider.d.ts
+interface ICredentialsProvider {
+  getAccessKey(): string;
+  getSignature(options: SignatureParameters): string;
+}
+interface InMemoryCredentialsProviderOptions {
+  accessKey: string;
+  privateKey: string;
+}
+declare class InMemoryCredentialsProvider implements ICredentialsProvider {
+  private accessKey;
+  private privateKey;
+  private signer;
+  /**
+   * @param {InMemoryCredentialsProviderOptions} options
+   */
+  constructor(options: InMemoryCredentialsProviderOptions);
+  /**
+   * @param {string} accessKey
+   */
+  setAccessKey(accessKey: string): void;
+  /**
+   * @param {string} privateKey
+   */
+  setPrivateKey(privateKey: string): void;
+  /**
+   * @return {string}
+   */
+  getAccessKey(): string;
+  /**
+   * @param {SignatureParameters} options
+   * @return {string}
+   */
+  getSignature(options: SignatureParameters): string;
+}
+//#endregion
+//#region src/schemas/primitives.d.ts
+declare const primitives$fixedPointSchema: z.ZodString;
+type Primitives$FixedPoint = z.infer<typeof primitives$fixedPointSchema>;
+declare const primitives$orderSideSchema: z.ZodEnum<{
+  yes: "yes";
+  no: "no";
+}>;
+type Primitives$OrderSide = z.infer<typeof primitives$orderSideSchema>;
+declare const primitives$bookSideSchema: z.ZodEnum<{
+  bid: "bid";
+  ask: "ask";
+}>;
+type Primitives$BookSide = z.infer<typeof primitives$bookSideSchema>;
+declare const primitives$orderActionSchema: z.ZodEnum<{
+  buy: "buy";
+  sell: "sell";
+}>;
+type Primitives$OrderAction = z.infer<typeof primitives$orderActionSchema>;
+//#endregion
+//#region src/schemas/orders.d.ts
+declare const orders$orderStatusSchema: z.ZodEnum<{
+  resting: "resting";
+  canceled: "canceled";
+  executed: "executed";
+}>;
+type Orders$OrderStatus = z.infer<typeof orders$orderStatusSchema>;
+declare const orders$orderTypeSchema: z.ZodEnum<{
+  limit: "limit";
+  market: "market";
+}>;
+type orders$OrderType = z.infer<typeof orders$orderTypeSchema>;
+declare const orders$selfTradePreventionTypeSchema: z.ZodEnum<{
+  taker_at_cross: "taker_at_cross";
+  maker: "maker";
+}>;
+type orders$SelfTradePreventionType = z.infer<typeof orders$selfTradePreventionTypeSchema>;
+declare const orders$orderDetailedSchema: z.ZodObject<{
+  order_id: z.ZodUUID;
+  user_id: z.ZodUUID;
+  subaccount_number: z.ZodDefault<z.ZodNumber>;
+  order_group_id: z.ZodOptional<z.ZodNullable<z.ZodUUID>>;
+  exchange_index: z.ZodDefault<z.ZodNumber>;
+  client_order_id: z.ZodString;
+  ticker: z.ZodString;
+  outcome_side: z.ZodEnum<{
+    yes: "yes";
+    no: "no";
+  }>;
+  book_side: z.ZodEnum<{
+    bid: "bid";
+    ask: "ask";
+  }>;
+  type: z.ZodEnum<{
+    limit: "limit";
+    market: "market";
+  }>;
+  status: z.ZodEnum<{
+    resting: "resting";
+    canceled: "canceled";
+    executed: "executed";
+  }>;
+  yes_price_dollars: z.ZodString;
+  no_price_dollars: z.ZodString;
+  fill_count_fp: z.ZodString;
+  remaining_count_fp: z.ZodString;
+  initial_count_fp: z.ZodString;
+  taker_fill_cost_dollars: z.ZodString;
+  maker_fill_cost_dollars: z.ZodString;
+  taker_fees_dollars: z.ZodString;
+  maker_fees_dollars: z.ZodString;
+  self_trade_prevention_type: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+    taker_at_cross: "taker_at_cross";
+    maker: "maker";
+  }>>>;
+  cancel_order_on_pause: z.ZodBoolean;
+  created_time: z.ZodISODateTime;
+  expiration_time: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
+  last_update_time: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
+}, z.core.$strip>;
+type Orders$OrderDetailed = z.infer<typeof orders$orderDetailedSchema>;
+declare const orders$orderWsSchema: z.ZodObject<{
+  outcome_side: z.ZodEnum<{
+    yes: "yes";
+    no: "no";
+  }>;
+  book_side: z.ZodEnum<{
+    bid: "bid";
+    ask: "ask";
+  }>;
+  status: z.ZodEnum<{
+    resting: "resting";
+    canceled: "canceled";
+    executed: "executed";
+  }>;
+  yes_price_dollars: z.ZodString;
+  fill_count_fp: z.ZodString;
+  remaining_count_fp: z.ZodString;
+  initial_count_fp: z.ZodString;
+  taker_fill_cost_dollars: z.ZodString;
+  maker_fill_cost_dollars: z.ZodString;
+  taker_fees_dollars: z.ZodString;
+  maker_fees_dollars: z.ZodString;
+  order_id: z.ZodUUID;
+  user_id: z.ZodUUID;
+  subaccount_number: z.ZodDefault<z.ZodNumber>;
+  order_group_id: z.ZodOptional<z.ZodNullable<z.ZodUUID>>;
+  client_order_id: z.ZodString;
+  ticker: z.ZodString;
+  self_trade_prevention_type: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+    taker_at_cross: "taker_at_cross";
+    maker: "maker";
+  }>>>;
+  created_time: z.ZodISODateTime;
+  expiration_time: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
+  last_update_time: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
+  side: z.ZodEnum<{
+    yes: "yes";
+    no: "no";
+  }>;
+  created_ts_ms: z.ZodNumber;
+  last_updated_ts_ms: z.ZodOptional<z.ZodNumber>;
+  expiration_ts_ms: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+type Orders$OrderWs = z.infer<typeof orders$orderWsSchema>;
+//#endregion
+//#region src/typed-emitter.d.ts
+type Listener<T extends unknown[]> = (...args: T) => void;
+declare class TypedEmitter<TEvents extends Record<string, unknown[]>> {
+  private readonly listeners;
+  private readonly wrappers;
+  on<K extends keyof TEvents>(event: K, listener: Listener<TEvents[K]>): void;
+  once<K extends keyof TEvents>(event: K, listener: Listener<TEvents[K]>): void;
+  off<K extends keyof TEvents>(event: K, listener: Listener<TEvents[K]>): void;
+  protected emit<K extends keyof TEvents>(event: K, ...args: TEvents[K]): void;
+  removeListeners<K extends keyof TEvents>(event: K): void;
+  removeAllListeners(): void;
+  listenersCount<K extends keyof TEvents>(event?: K): number;
+}
+//#endregion
+//#region src/ws-wrapper/types.d.ts
+type HeadersFn = () => Record<string, string>;
+type ReconnectStrategy = ((attempt: number) => number | false) | {
+  interval: number | number[] | ((attempt: number) => number) | {
+    min: number;
+    max: number;
+  };
+  maxAttempts: number;
+};
+interface WsWrapperOptions {
+  address: string;
+  agent?: Agent;
+  headers?: Record<string, string> | HeadersFn;
+  reconnect: ReconnectStrategy;
+}
+//#endregion
+//#region src/logging.d.ts
+type LogLevel = 'debug' | 'info' | 'warn' | 'error' | 'fatal';
+type LogFunction = (level: LogLevel, message: string, context?: any) => void;
+//#endregion
+//#region src/ws/types.d.ts
+interface WsClientOptions {
+  id?: string;
+  environment?: KalshiEnvironment;
+  credentialsProvider: ICredentialsProvider;
+  wsOptions: Omit<WsWrapperOptions, 'address' | 'headers'>;
+  log?: LogFunction;
+}
+//#endregion
+//#region src/ws/ws-client.d.ts
+declare class WsClient extends TypedEmitter<any> {
+  readonly id: string;
+  private readonly baseURL;
+  private readonly credentialsProvider;
+  private readonly log;
+  private readonly ws;
+  private lastMessageId;
+  private readonly subscribeAwaiters;
+  /**
+   * @param {WsClientOptions} options
+   */
+  constructor(options: WsClientOptions);
+  private onReady;
+  /**
+   * @param {WebSocket.RawData} data
+   * @param {boolean} isBinary
+   * @return {Promise<void>}
+   */
+  private onMessage;
+  /**
+   * @param {number} attempt
+   */
+  private onReconnecting;
+  /**
+   * @param {Error} err
+   */
+  private onError;
+  /**
+   */
+  private onClose;
+  /**
+   * @param {WsAnyMessage} msg
+   * @private
+   */
+  private processMessage;
+}
+//#endregion
+//#region src/ws/errors.d.ts
+declare class WsKalshiError extends Error {
+  readonly id: number;
+  readonly code: number;
+  /**
+   * @param {number} id
+   * @param {number} code
+   * @param {string} message
+   */
+  constructor(id: number, code: number, message?: string);
+}
+//#endregion
+//#region src/ws/common.d.ts
+declare const WS_KALSHI_ERRORS: {
+  readonly UNABLE_TO_PROCESS: 1;
+  readonly PARAMS_REQUIRED: 2;
+  readonly CHANNELS_REQUIRED: 3;
+  readonly SUBSCRIPTION_IDS_REQUIRED: 4;
+  readonly UNKNOWN_COMMAND: 5;
+  readonly ALREADY_SUBSCRIBED: 6;
+  readonly UNKNOWN_SUBSCRIPTION_ID: 7;
+  readonly UNKNOWN_CHANNEL_NAME: 8;
+  readonly AUTHENTICATION_REQUIRED: 9;
+  readonly CHANNEL_ERROR: 10;
+  readonly INVALID_PARAMETER: 11;
+  readonly EXACTLY_ONE_SUBSCRIPTION_ID_IS_REQUIRED: 12;
+  readonly UNSUPPORTED_ACTION: 13;
+  readonly MARKET_TICKER_REQUIRED: 14;
+  readonly ACTION_REQUIRED: 15;
+  readonly MARKET_NOT_FOUND: 16;
+  readonly INTERNAL_ERROR: 17;
+  readonly COMMAND_TIMEOUT: 18;
+  readonly SHARD_FACTOR_MUST_BE_GT0: 19;
+  readonly SHARD_FACTOR_IS_REQUIRED: 20;
+  readonly INVALID_SHARD_KEY: 21;
+  readonly SHARD_FACTOR_MUST_BE_LT100: 22;
+  readonly SUBSCRIPTION_BUFFER_OVERFLOW: 25;
+};
+declare const WS_KALSHI_SERVER_ERRORS: number[];
+//#endregion
+//#region src/ws/messages.d.ts
+declare const wsOkMessageSchema: z.ZodObject<{
+  id: z.ZodNumber;
+  sid: z.ZodNumber;
+  type: z.ZodLiteral<"ok">;
+  msg: z.ZodOptional<z.ZodAny>;
+}, z.core.$strip>;
+type WsOkMessage = z.infer<typeof wsOkMessageSchema>;
+declare const wsErrorMessageSchema: z.ZodObject<{
+  id: z.ZodNumber;
+  type: z.ZodLiteral<"error">;
+  msg: z.ZodObject<{
+    code: z.ZodNumber;
+    msg: z.ZodString;
+  }, z.core.$strip>;
+}, z.core.$strip>;
+type WsErrorMessage = z.infer<typeof wsErrorMessageSchema>;
+declare const wsSubscribedMessageSchema: z.ZodObject<{
+  id: z.ZodNumber;
+  type: z.ZodLiteral<"subscribed">;
+  msg: z.ZodObject<{
+    channel: z.ZodString;
+    sid: z.ZodNumber;
+  }, z.core.$strip>;
+}, z.core.$strip>;
+type WsSubscribedMessage = z.infer<typeof wsSubscribedMessageSchema>;
+declare const wsUserOrderMessageSchema: z.ZodObject<{
+  sid: z.ZodNumber;
+  type: z.ZodLiteral<"user_order">;
+  msg: z.ZodObject<{
+    outcome_side: z.ZodEnum<{
+      yes: "yes";
+      no: "no";
+    }>;
+    book_side: z.ZodEnum<{
+      bid: "bid";
+      ask: "ask";
+    }>;
+    status: z.ZodEnum<{
+      resting: "resting";
+      canceled: "canceled";
+      executed: "executed";
+    }>;
+    yes_price_dollars: z.ZodString;
+    fill_count_fp: z.ZodString;
+    remaining_count_fp: z.ZodString;
+    initial_count_fp: z.ZodString;
+    taker_fill_cost_dollars: z.ZodString;
+    maker_fill_cost_dollars: z.ZodString;
+    taker_fees_dollars: z.ZodString;
+    maker_fees_dollars: z.ZodString;
+    order_id: z.ZodUUID;
+    user_id: z.ZodUUID;
+    subaccount_number: z.ZodDefault<z.ZodNumber>;
+    order_group_id: z.ZodOptional<z.ZodNullable<z.ZodUUID>>;
+    client_order_id: z.ZodString;
+    ticker: z.ZodString;
+    self_trade_prevention_type: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+      taker_at_cross: "taker_at_cross";
+      maker: "maker";
+    }>>>;
+    created_time: z.ZodISODateTime;
+    expiration_time: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
+    last_update_time: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
+    side: z.ZodEnum<{
+      yes: "yes";
+      no: "no";
+    }>;
+    created_ts_ms: z.ZodNumber;
+    last_updated_ts_ms: z.ZodOptional<z.ZodNumber>;
+    expiration_ts_ms: z.ZodOptional<z.ZodNumber>;
+  }, z.core.$strip>;
+}, z.core.$strip>;
+type WsUserOrderMessage = z.infer<typeof wsUserOrderMessageSchema>;
+declare const wsAnyMessageSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+  id: z.ZodNumber;
+  sid: z.ZodNumber;
+  type: z.ZodLiteral<"ok">;
+  msg: z.ZodOptional<z.ZodAny>;
+}, z.core.$strip>, z.ZodObject<{
+  id: z.ZodNumber;
+  type: z.ZodLiteral<"error">;
+  msg: z.ZodObject<{
+    code: z.ZodNumber;
+    msg: z.ZodString;
+  }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+  id: z.ZodNumber;
+  type: z.ZodLiteral<"subscribed">;
+  msg: z.ZodObject<{
+    channel: z.ZodString;
+    sid: z.ZodNumber;
+  }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+  sid: z.ZodNumber;
+  type: z.ZodLiteral<"user_order">;
+  msg: z.ZodObject<{
+    outcome_side: z.ZodEnum<{
+      yes: "yes";
+      no: "no";
+    }>;
+    book_side: z.ZodEnum<{
+      bid: "bid";
+      ask: "ask";
+    }>;
+    status: z.ZodEnum<{
+      resting: "resting";
+      canceled: "canceled";
+      executed: "executed";
+    }>;
+    yes_price_dollars: z.ZodString;
+    fill_count_fp: z.ZodString;
+    remaining_count_fp: z.ZodString;
+    initial_count_fp: z.ZodString;
+    taker_fill_cost_dollars: z.ZodString;
+    maker_fill_cost_dollars: z.ZodString;
+    taker_fees_dollars: z.ZodString;
+    maker_fees_dollars: z.ZodString;
+    order_id: z.ZodUUID;
+    user_id: z.ZodUUID;
+    subaccount_number: z.ZodDefault<z.ZodNumber>;
+    order_group_id: z.ZodOptional<z.ZodNullable<z.ZodUUID>>;
+    client_order_id: z.ZodString;
+    ticker: z.ZodString;
+    self_trade_prevention_type: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+      taker_at_cross: "taker_at_cross";
+      maker: "maker";
+    }>>>;
+    created_time: z.ZodISODateTime;
+    expiration_time: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
+    last_update_time: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
+    side: z.ZodEnum<{
+      yes: "yes";
+      no: "no";
+    }>;
+    created_ts_ms: z.ZodNumber;
+    last_updated_ts_ms: z.ZodOptional<z.ZodNumber>;
+    expiration_ts_ms: z.ZodOptional<z.ZodNumber>;
+  }, z.core.$strip>;
+}, z.core.$strip>], "type">;
+type WsAnyMessage = z.infer<typeof wsAnyMessageSchema>;
+//#endregion
+export { type ICredentialsProvider, type IRequestSigner, InMemoryCredentialsProvider, type InMemoryCredentialsProviderOptions, Orders$OrderDetailed, Orders$OrderStatus, Orders$OrderWs, Primitives$BookSide, Primitives$FixedPoint, Primitives$OrderAction, Primitives$OrderSide, RequestSigner, type RequestSignerOptions, type SignatureParameters, WS_KALSHI_ERRORS, WS_KALSHI_SERVER_ERRORS, WsAnyMessage, WsClient, type WsClientOptions, WsErrorMessage, WsKalshiError, WsOkMessage, WsSubscribedMessage, WsUserOrderMessage, orders$OrderType, orders$SelfTradePreventionType, orders$orderDetailedSchema, orders$orderStatusSchema, orders$orderTypeSchema, orders$orderWsSchema, orders$selfTradePreventionTypeSchema, primitives$bookSideSchema, primitives$fixedPointSchema, primitives$orderActionSchema, primitives$orderSideSchema, wsAnyMessageSchema, wsErrorMessageSchema, wsOkMessageSchema, wsSubscribedMessageSchema, wsUserOrderMessageSchema };