@quicknode/sdk 2.5.2 → 3.0.0-alpha.11

package/sdk.d.ts

@@ -0,0 +1,389 @@
+// sdk.d.ts
+import {
+  QuicknodeSdk as _QuicknodeSdk,
+  SdkFullConfig,
+  WebhookAttributes,
+  S3Attributes,
+  AzureAttributes,
+  PostgresAttributes,
+  MysqlAttributes,
+  MongoAttributes,
+  ClickhouseAttributes,
+  SnowflakeAttributes,
+  KafkaAttributes,
+  RedisAttributes,
+  WebhookTemplateId,
+  EvmWalletFilterTemplate,
+  EvmContractEventsTemplate,
+  EvmAbiFilterTemplate,
+  SolanaWalletFilterTemplate,
+  BitcoinWalletFilterTemplate,
+  XrplWalletFilterTemplate,
+  HyperliquidWalletEventsFilterTemplate,
+  StellarWalletTransactionsFilterTemplate,
+} from "./index";
+
+// Stream destination attributes (input). The inner key is `attributes` rather
+// than the wire's `destination_attributes` to avoid
+// `destinationAttributes.destinationAttributes.url`; the Node binding renames
+// it back before the request.
+export type StreamDestinationAttributesInput =
+  | { destination: "webhook"; attributes: WebhookAttributes }
+  | { destination: "s3"; attributes: S3Attributes }
+  | { destination: "azure"; attributes: AzureAttributes }
+  | { destination: "postgres"; attributes: PostgresAttributes }
+  | { destination: "mysql"; attributes: MysqlAttributes }
+  | { destination: "mongo"; attributes: MongoAttributes }
+  | { destination: "clickhouse"; attributes: ClickhouseAttributes }
+  | { destination: "snowflake"; attributes: SnowflakeAttributes }
+  | { destination: "kafka"; attributes: KafkaAttributes }
+  | { destination: "redis"; attributes: RedisAttributes };
+
+// Stream destination attributes (response). Mirrors the input shape so a
+// response can be round-tripped back into an update call without renaming.
+// The Node binding renames the wire `destination_attributes` key to
+// `attributes` on the way out.
+export type StreamDestinationAttributesResponse = StreamDestinationAttributesInput;
+
+// Replace the napi-generated JSON-blob destinationAttributes with typed unions.
+type _CreateStreamParamsNode = import("./index").CreateStreamParamsNode;
+type _UpdateStreamParamsNode = import("./index").UpdateStreamParamsNode;
+type _StreamNode = import("./index").StreamNode;
+type _ListStreamsResponseNode = import("./index").ListStreamsResponseNode;
+
+export type CreateStreamParams =
+  Omit<_CreateStreamParamsNode, "destinationAttributes" | "extraDestinations"> & {
+    destinationAttributes: StreamDestinationAttributesInput;
+    extraDestinations?: StreamDestinationAttributesInput[] | null;
+  };
+
+export type UpdateStreamParams =
+  Omit<_UpdateStreamParamsNode, "destinationAttributes" | "extraDestinations"> & {
+    destinationAttributes?: StreamDestinationAttributesInput;
+    extraDestinations?: StreamDestinationAttributesInput[] | null;
+  };
+
+export type Stream = Omit<_StreamNode, "destinationAttributes" | "extraDestinations"> & {
+  destinationAttributes?: StreamDestinationAttributesResponse;
+  extraDestinations?: StreamDestinationAttributesResponse[] | null;
+};
+
+export type ListStreamsResponse = Omit<_ListStreamsResponseNode, "data"> & {
+  data: Stream[];
+};
+
+// Webhook template args (input). The inner key is `args` rather than the
+// wire's `templateArgs` to avoid `templateArgs.templateArgs.wallets`; the
+// Node binding renames it back before the request.
+export type TemplateArgsInput =
+  | { templateId: "evmWalletFilter"; args: EvmWalletFilterTemplate }
+  | { templateId: "evmContractEvents"; args: EvmContractEventsTemplate }
+  | { templateId: "evmAbiFilter"; args: EvmAbiFilterTemplate }
+  | { templateId: "solanaWalletFilter"; args: SolanaWalletFilterTemplate }
+  | { templateId: "bitcoinWalletFilter"; args: BitcoinWalletFilterTemplate }
+  | { templateId: "xrplWalletFilter"; args: XrplWalletFilterTemplate }
+  | { templateId: "hyperliquidWalletEventsFilter"; args: HyperliquidWalletEventsFilterTemplate }
+  | {
+      templateId: "stellarWalletTransactionsSourceAccountFilter";
+      args: StellarWalletTransactionsFilterTemplate;
+    };
+
+// Replace the napi-generated JSON-blob templateArgs with typed unions.
+type _CreateWebhookFromTemplateParamsNode = import("./index").CreateWebhookFromTemplateParamsNode;
+type _UpdateWebhookTemplateParamsNode = import("./index").UpdateWebhookTemplateParamsNode;
+
+export type CreateWebhookFromTemplateParams =
+  Omit<_CreateWebhookFromTemplateParamsNode, "templateArgs"> & {
+    templateArgs: TemplateArgsInput;
+  };
+
+export type UpdateWebhookTemplateParams =
+  Omit<_UpdateWebhookTemplateParamsNode, "templateArgs"> & {
+    templateArgs: TemplateArgsInput;
+  };
+
+export type {
+  SdkFullConfig,
+  HttpConfig,
+  AdminConfig,
+  StreamsConfig,
+  // streams
+  ListStreamsParams,
+  PageInfo,
+  TestFilterParams,
+  TestFilterResponse,
+  EnabledCountResponse,
+  WebhookAttributes,
+  S3Attributes,
+  AzureAttributes,
+  PostgresAttributes,
+  MysqlAttributes,
+  MongoAttributes,
+  ClickhouseAttributes,
+  SnowflakeAttributes,
+  KafkaAttributes,
+  RedisAttributes,
+  AddressBookConfig,
+  StreamsApiClient,
+  // billing
+  InvoiceLine,
+  Invoice,
+  ListInvoicesResponse,
+  ListInvoicesData,
+  Payment,
+  ListPaymentsResponse,
+  ListPaymentsData,
+  // chains
+  ChainNetwork,
+  Chain,
+  ListChainsResponse,
+  // metrics
+  GetEndpointMetricsRequest,
+  GetAccountMetricsRequest,
+  EndpointMetric,
+  GetEndpointMetricsResponse,
+  GetAccountMetricsResponse,
+  // rate limits
+  MethodRateLimiter,
+  GetMethodRateLimitsData,
+  GetMethodRateLimitsResponse,
+  CreateMethodRateLimitRequest,
+  CreateMethodRateLimitResponse,
+  UpdateMethodRateLimitRequest,
+  UpdateMethodRateLimitResponse,
+  RateLimitSettings,
+  UpdateRateLimitsRequest,
+  // security options
+  SecurityOption,
+  GetSecurityOptionsResponse,
+  SecurityOptionsUpdate,
+  UpdateSecurityOptionsRequest,
+  UpdateSecurityOptionsResponse,
+  CreateReferrerRequest,
+  CreateIpRequest,
+  CreateDomainMaskRequest,
+  CreateJwtRequest,
+  CreateRequestFilterRequest,
+  CreateRequestFilterResponse,
+  CreateRequestFilterData,
+  UpdateRequestFilterRequest,
+  CreateOrUpdateIpCustomHeaderRequest,
+  IpCustomHeaderData,
+  CreateOrUpdateIpCustomHeaderResponse,
+  DeleteBoolResponse,
+  // endpoints
+  GetEndpointsRequest,
+  GetEndpointsResponse,
+  Endpoint,
+  EndpointTag,
+  CreateEndpointRequest,
+  CreateEndpointResponse,
+  SingleEndpoint,
+  EndpointRateLimits,
+  EndpointSecurity,
+  EndpointSecurityOptions,
+  EndpointIpCustomHeaderOption,
+  EndpointToken,
+  EndpointJwt,
+  EndpointReferrer,
+  EndpointDomainMask,
+  EndpointIp,
+  EndpointRequestFilter,
+  ShowEndpointResponse,
+  UpdateEndpointRequest,
+  UpdateEndpointStatusRequest,
+  UpdateEndpointStatusResponse,
+  CreateTagRequest,
+  Pagination,
+  GetEndpointSecurityResponse,
+  // bulk
+  BulkOperationResult,
+  BulkUpdateEndpointStatusRequest,
+  BulkUpdateEndpointStatusData,
+  BulkUpdateEndpointStatusResponse,
+  BulkTag,
+  BulkAddTagRequest,
+  BulkAddTagData,
+  BulkAddTagResponse,
+  BulkRemoveTagRequest,
+  BulkRemoveTagData,
+  BulkRemoveTagResponse,
+  // account tags
+  AccountTag,
+  ListTagsData,
+  ListTagsResponse,
+  RenameTagRequest,
+  RenameTagResponse,
+  DeleteAccountTagData,
+  DeleteAccountTagResponse,
+  // logs
+  GetEndpointLogsRequest,
+  LogDetails,
+  EndpointLog,
+  GetEndpointLogsResponse,
+  GetLogDetailsResponse,
+  // teams
+  TeamUser,
+  TeamSummary,
+  TeamDetail,
+  ListTeamsResponse,
+  CreateTeamRequest,
+  CreateTeamData,
+  CreateTeamResponse,
+  GetTeamResponse,
+  DeleteTeamData,
+  DeleteTeamResponse,
+  TeamEndpoint,
+  ListTeamEndpointsResponse,
+  UpdateTeamEndpointsRequest,
+  UpdateTeamEndpointsData,
+  UpdateTeamEndpointsResponse,
+  InviteTeamMemberRequest,
+  InviteTeamMemberResponse,
+  RemoveTeamMemberRequest,
+  TeamMessageData,
+  RemoveTeamMemberResponse,
+  ResendTeamInviteResponse,
+  // usage
+  GetUsageRequest,
+  UsageData,
+  GetUsageResponse,
+  EndpointUsage,
+  MethodUsage,
+  ChainUsage,
+  UsageByEndpointData,
+  GetUsageByEndpointResponse,
+  UsageByMethodData,
+  GetUsageByMethodResponse,
+  UsageByChainData,
+  GetUsageByChainResponse,
+  TagUsage,
+  UsageByTagData,
+  GetUsageByTagResponse,
+  // webhooks
+  WebhooksConfig,
+  GetWebhooksParams,
+  UpdateWebhookParams,
+  Webhook,
+  ListWebhooksResponse,
+  WebhookPageInfo,
+  WebhookEnabledCountResponse,
+  WebhookDestinationAttributes,
+  ActivateWebhookParams,
+  EvmWalletFilterTemplate,
+  EvmContractEventsTemplate,
+  EvmAbiFilterTemplate,
+  SolanaWalletFilterTemplate,
+  BitcoinWalletFilterTemplate,
+  XrplWalletFilterTemplate,
+  HyperliquidWalletEventsFilterTemplate,
+  StellarWalletTransactionsFilterTemplate,
+  WebhooksApiClient,
+  // kvstore
+  KvStoreConfig,
+  KvStoreApiClient,
+  KvSetEntry,
+  CreateSetParams,
+  GetSetsParams,
+  GetSetsResponse,
+  GetSetResponse,
+  BulkSetsParams,
+  CreateListParams,
+  GetListsParams,
+  GetListsData,
+  GetListsResponse,
+  GetListParams,
+  GetListData,
+  GetListResponse,
+  UpdateListParams,
+  AddListItemParams,
+  ListContainsItemResponse,
+} from "./index";
+
+// const enums must use `export` (not `export type`) so they are usable as values
+export {
+  StreamRegion,
+  StreamDataset,
+  StreamDestination,
+  FilterLanguage,
+  StreamMetadataLocation,
+  ProductType,
+  StreamStatus,
+  WebhookTemplateId,
+  WebhookStartFrom,
+} from "./index";
+
+// Retypes napi's `any` destination_attributes to the discriminated unions.
+// NOTE: keep these method signatures in sync with the napi-generated
+// StreamsApiClient in ./index.d.ts. Adding a method to crates/node/src/lib.rs
+// requires adding it here too; there is no automated check.
+export interface StreamsApiClientTyped {
+  createStream(params: CreateStreamParams): Promise<Stream>;
+  listStreams(params?: import("./index").ListStreamsParams | undefined | null): Promise<ListStreamsResponse>;
+  deleteAllStreams(): Promise<void>;
+  getStream(id: string): Promise<Stream>;
+  updateStream(id: string, params: UpdateStreamParams): Promise<Stream>;
+  deleteStream(id: string): Promise<void>;
+  activateStream(id: string): Promise<void>;
+  pauseStream(id: string): Promise<void>;
+  testFilter(params: import("./index").TestFilterParams): Promise<import("./index").TestFilterResponse>;
+  getEnabledCount(streamType?: string | undefined | null): Promise<import("./index").EnabledCountResponse>;
+}
+
+// Retypes napi's `any` templateArgs to the discriminated union. Keep method
+// signatures in sync with the napi-generated WebhooksApiClient in ./index.d.ts.
+export interface WebhooksApiClientTyped {
+  listWebhooks(params?: import("./index").GetWebhooksParams | undefined | null): Promise<import("./index").ListWebhooksResponse>;
+  deleteAllWebhooks(): Promise<void>;
+  getWebhook(id: string): Promise<import("./index").Webhook>;
+  updateWebhook(
+    id: string,
+    params: import("./index").UpdateWebhookParams
+  ): Promise<import("./index").Webhook>;
+  deleteWebhook(id: string): Promise<void>;
+  pauseWebhook(id: string): Promise<void>;
+  activateWebhook(id: string, params: import("./index").ActivateWebhookParams): Promise<void>;
+  getEnabledCount(): Promise<import("./index").WebhookEnabledCountResponse>;
+  createWebhookFromTemplate(params: CreateWebhookFromTemplateParams): Promise<import("./index").Webhook>;
+  updateWebhookTemplate(
+    webhookId: string,
+    params: UpdateWebhookTemplateParams
+  ): Promise<import("./index").Webhook>;
+}
+
+export class QuicknodeSdk {
+  constructor(config: SdkFullConfig);
+  static fromEnv(): QuicknodeSdk;
+  admin: _QuicknodeSdk["admin"];
+  streams: StreamsApiClientTyped;
+  webhooks: WebhooksApiClientTyped;
+  kvstore: _QuicknodeSdk["kvstore"];
+}
+
+// Typed static factory methods producing each discriminated variant of
+// TemplateArgsInput. Consumers can also construct the object literal directly.
+export const TemplateArgs: {
+  evmWalletFilter(attrs: EvmWalletFilterTemplate): Extract<TemplateArgsInput, { templateId: "evmWalletFilter" }>;
+  evmContractEvents(attrs: EvmContractEventsTemplate): Extract<TemplateArgsInput, { templateId: "evmContractEvents" }>;
+  evmAbiFilter(attrs: EvmAbiFilterTemplate): Extract<TemplateArgsInput, { templateId: "evmAbiFilter" }>;
+  solanaWalletFilter(attrs: SolanaWalletFilterTemplate): Extract<TemplateArgsInput, { templateId: "solanaWalletFilter" }>;
+  bitcoinWalletFilter(attrs: BitcoinWalletFilterTemplate): Extract<TemplateArgsInput, { templateId: "bitcoinWalletFilter" }>;
+  xrplWalletFilter(attrs: XrplWalletFilterTemplate): Extract<TemplateArgsInput, { templateId: "xrplWalletFilter" }>;
+  hyperliquidWalletEventsFilter(attrs: HyperliquidWalletEventsFilterTemplate): Extract<TemplateArgsInput, { templateId: "hyperliquidWalletEventsFilter" }>;
+  stellarWalletTransactionsFilter(attrs: StellarWalletTransactionsFilterTemplate): Extract<TemplateArgsInput, { templateId: "stellarWalletTransactionsSourceAccountFilter" }>;
+};
+
+// Typed error hierarchy. Any SDK call can throw one of these; catch
+// QuicknodeError to handle them all, or a specific subclass for finer control.
+export class QuicknodeError extends Error {}
+export class ConfigError extends QuicknodeError {}
+export class HttpError extends QuicknodeError {}
+export class TimeoutError extends HttpError {}
+export class ConnectionError extends HttpError {}
+export class ApiError extends QuicknodeError {
+  status: number;
+  body: string;
+}
+export class DecodeError extends QuicknodeError {
+  body: string;
+}

package/sdk.js

@@ -0,0 +1,88 @@
+// Exported main sdk file that imports from autogenerated napi-rs file
+//
+const _index = require("./index.js");
+const { QuicknodeSdk: _QuicknodeSdk } = _index;
+const errors = require("./errors.js");
+
+class QuicknodeSdk {
+  constructor(config) {
+    try {
+      this._inner = new _QuicknodeSdk(config);
+    } catch (e) {
+      throw errors.fromNapiError(e);
+    }
+    this.admin = errors.wrapClient(this._inner.admin);
+    this.streams = errors.wrapClient(this._inner.streams);
+    this.webhooks = errors.wrapClient(this._inner.webhooks);
+    this.kvstore = errors.wrapClient(this._inner.kvstore);
+  }
+
+  static fromEnv() {
+    const instance = Object.create(QuicknodeSdk.prototype);
+    try {
+      instance._inner = _QuicknodeSdk.fromEnv();
+    } catch (e) {
+      throw errors.fromNapiError(e);
+    }
+    instance.admin = errors.wrapClient(instance._inner.admin);
+    instance.streams = errors.wrapClient(instance._inner.streams);
+    instance.webhooks = errors.wrapClient(instance._inner.webhooks);
+    instance.kvstore = errors.wrapClient(instance._inner.kvstore);
+    return instance;
+  }
+}
+
+// TemplateArgs wraps the webhook template input with typed static factory
+// methods. The underlying object is `{ templateId, args }` — callers should
+// use the factory methods rather than constructing the object directly.
+class TemplateArgs {
+  constructor(templateId, args) {
+    this.templateId = templateId;
+    this.args = args;
+  }
+
+  static evmWalletFilter(attrs) {
+    return new TemplateArgs("evmWalletFilter", attrs);
+  }
+
+  static evmContractEvents(attrs) {
+    return new TemplateArgs("evmContractEvents", attrs);
+  }
+
+  static evmAbiFilter(attrs) {
+    return new TemplateArgs("evmAbiFilter", attrs);
+  }
+
+  static solanaWalletFilter(attrs) {
+    return new TemplateArgs("solanaWalletFilter", attrs);
+  }
+
+  static bitcoinWalletFilter(attrs) {
+    return new TemplateArgs("bitcoinWalletFilter", attrs);
+  }
+
+  static xrplWalletFilter(attrs) {
+    return new TemplateArgs("xrplWalletFilter", attrs);
+  }
+
+  static hyperliquidWalletEventsFilter(attrs) {
+    return new TemplateArgs("hyperliquidWalletEventsFilter", attrs);
+  }
+
+  static stellarWalletTransactionsFilter(attrs) {
+    return new TemplateArgs("stellarWalletTransactionsSourceAccountFilter", attrs);
+  }
+}
+
+module.exports = {
+  ..._index,
+  QuicknodeSdk,
+  TemplateArgs,
+  QuicknodeError: errors.QuicknodeError,
+  ConfigError: errors.ConfigError,
+  HttpError: errors.HttpError,
+  TimeoutError: errors.TimeoutError,
+  ConnectionError: errors.ConnectionError,
+  ApiError: errors.ApiError,
+  DecodeError: errors.DecodeError,
+};

package/sdk.mjs

@@ -0,0 +1,34 @@
+// ESM wrapper: re-exports the CJS entry via dynamic import.
+// The native .node binary loader (index.js) uses require() for platform
+// detection and cannot be expressed as static ESM — this wrapper bridges
+// the gap for ESM consumers while keeping the loader intact.
+//
+// We re-export everything from the default export so that new types added
+// to sdk.js are automatically available here without manual updates.
+import cjs from './sdk.js';
+
+export default cjs;
+export const {
+  QuicknodeSdk,
+  TemplateArgs,
+  StreamRegion,
+  StreamDataset,
+  StreamDestination,
+  FilterLanguage,
+  StreamMetadataLocation,
+  ProductType,
+  StreamStatus,
+  WebhookTemplateId,
+  WebhookStartFrom,
+  AdminApiClient,
+  StreamsApiClient,
+  WebhooksApiClient,
+  KvStoreApiClient,
+  QuicknodeError,
+  ConfigError,
+  HttpError,
+  TimeoutError,
+  ConnectionError,
+  ApiError,
+  DecodeError,
+} = cjs;