@tradejs/connectors 1.0.0

package/README.md

@@ -0,0 +1,39 @@
+# @tradejs/connectors
+
+Built-in TradeJS connector package.
+
+- Homepage: https://tradejs.dev
+- Documentation: https://docs.tradejs.dev
+- Quickstart: https://docs.tradejs.dev/getting-started/quickstart
+
+## What It Provides
+
+This package contains the built-in connector plugin catalog used by TradeJS runtime:
+
+- exchange connectors
+- market data providers
+- built-in test connector support used by backtests/runtime flows
+
+## Install
+
+```bash
+npm i @tradejs/connectors @tradejs/core
+```
+
+## Usage
+
+Most projects should not add this package manually. It is already included by `@tradejs/base`.
+
+If you want to reference it explicitly:
+
+```ts
+import { defineConfig } from '@tradejs/core/config';
+
+export default defineConfig({
+  connectors: ['@tradejs/connectors'],
+});
+```
+
+## For Custom Connectors
+
+Use `defineConnectorPlugin(...)` from `@tradejs/core/config` in your own package and add that package to `connectors` in `tradejs.config.ts`.

package/dist/index.d.mts

@@ -0,0 +1,65 @@
+import * as _tradejs_types from '@tradejs/types';
+import { KlineChartData, ConnectorRegistryEntry, ConnectorCreator } from '@tradejs/types';
+import { DerivativesInterval, DerivativesRow, SpreadRow } from '@tradejs/infra/timescale';
+
+type SpotKlineRequest = {
+    symbol: string;
+    interval: DerivativesInterval;
+    start: number;
+    end: number;
+};
+type SpotKlineProvider = {
+    kline: (request: SpotKlineRequest) => Promise<KlineChartData>;
+};
+declare const spotKlineProviders: {
+    binance: SpotKlineProvider;
+    coinbase: SpotKlineProvider;
+};
+
+type MarketDataProviderName = 'coinalyze' | 'binance_coinbase_spread';
+type ProviderWindowParams = {
+    symbol: string;
+    marketSymbol?: string;
+    interval: DerivativesInterval;
+    fromMs: number;
+    toMs: number;
+};
+type ProviderWindowResult = {
+    derivativesRows?: DerivativesRow[];
+    spreadRows?: SpreadRow[];
+};
+interface MarketDataProvider {
+    name: MarketDataProviderName;
+    fetchWindow: (params: ProviderWindowParams) => Promise<ProviderWindowResult>;
+}
+
+declare const marketDataProviders: Record<MarketDataProviderName, MarketDataProvider>;
+
+declare enum ConnectorNames {
+    ByBit = "ByBit",
+    Binance = "Binance",
+    Coinbase = "Coinbase",
+    Test = "Test"
+}
+declare enum ConnectorProviders {
+    bybit = "bybit",
+    binance = "binance",
+    coinbase = "coinbase"
+}
+declare const providerToConnectorName: Record<ConnectorProviders, ConnectorNames>;
+declare const getConnectorProviders: () => ConnectorProviders[];
+declare const resolveConnectorNameByProvider: (provider: unknown) => ConnectorNames | null;
+declare const connectors: {
+    readonly ByBit: ConnectorCreator;
+    readonly Binance: ConnectorCreator;
+    readonly Coinbase: ConnectorCreator;
+    readonly Test: _tradejs_types.TestConnectorCreator;
+};
+declare const connectorEntries: ConnectorRegistryEntry[];
+declare const getConnectorCreatorByProvider: (provider: unknown) => ConnectorCreator | null;
+
+declare const _default: {
+    connectorEntries: ConnectorRegistryEntry[];
+};
+
+export { ConnectorNames, ConnectorProviders, type MarketDataProvider, type MarketDataProviderName, connectorEntries, connectors, _default as default, getConnectorCreatorByProvider, getConnectorProviders, marketDataProviders, providerToConnectorName, resolveConnectorNameByProvider, spotKlineProviders };

package/dist/index.d.ts

@@ -0,0 +1,65 @@
+import * as _tradejs_types from '@tradejs/types';
+import { KlineChartData, ConnectorRegistryEntry, ConnectorCreator } from '@tradejs/types';
+import { DerivativesInterval, DerivativesRow, SpreadRow } from '@tradejs/infra/timescale';
+
+type SpotKlineRequest = {
+    symbol: string;
+    interval: DerivativesInterval;
+    start: number;
+    end: number;
+};
+type SpotKlineProvider = {
+    kline: (request: SpotKlineRequest) => Promise<KlineChartData>;
+};
+declare const spotKlineProviders: {
+    binance: SpotKlineProvider;
+    coinbase: SpotKlineProvider;
+};
+
+type MarketDataProviderName = 'coinalyze' | 'binance_coinbase_spread';
+type ProviderWindowParams = {
+    symbol: string;
+    marketSymbol?: string;
+    interval: DerivativesInterval;
+    fromMs: number;
+    toMs: number;
+};
+type ProviderWindowResult = {
+    derivativesRows?: DerivativesRow[];
+    spreadRows?: SpreadRow[];
+};
+interface MarketDataProvider {
+    name: MarketDataProviderName;
+    fetchWindow: (params: ProviderWindowParams) => Promise<ProviderWindowResult>;
+}
+
+declare const marketDataProviders: Record<MarketDataProviderName, MarketDataProvider>;
+
+declare enum ConnectorNames {
+    ByBit = "ByBit",
+    Binance = "Binance",
+    Coinbase = "Coinbase",
+    Test = "Test"
+}
+declare enum ConnectorProviders {
+    bybit = "bybit",
+    binance = "binance",
+    coinbase = "coinbase"
+}
+declare const providerToConnectorName: Record<ConnectorProviders, ConnectorNames>;
+declare const getConnectorProviders: () => ConnectorProviders[];
+declare const resolveConnectorNameByProvider: (provider: unknown) => ConnectorNames | null;
+declare const connectors: {
+    readonly ByBit: ConnectorCreator;
+    readonly Binance: ConnectorCreator;
+    readonly Coinbase: ConnectorCreator;
+    readonly Test: _tradejs_types.TestConnectorCreator;
+};
+declare const connectorEntries: ConnectorRegistryEntry[];
+declare const getConnectorCreatorByProvider: (provider: unknown) => ConnectorCreator | null;
+
+declare const _default: {
+    connectorEntries: ConnectorRegistryEntry[];
+};
+
+export { ConnectorNames, ConnectorProviders, type MarketDataProvider, type MarketDataProviderName, connectorEntries, connectors, _default as default, getConnectorCreatorByProvider, getConnectorProviders, marketDataProviders, providerToConnectorName, resolveConnectorNameByProvider, spotKlineProviders };