@ganaka/sdk 0.0.1

package/LICENSE

@@ -0,0 +1,41 @@
+MIT License
+
+Copyright (c) 2025 Ganaka
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

package/README.md

@@ -0,0 +1,260 @@
+# Ganaka SDK
+
+TypeScript/JavaScript client library for the Ganaka trading platform.
+
+## Installation
+
+Install the package using your preferred package manager:
+
+```bash
+npm install @ganaka/sdk
+# or
+yarn add @ganaka/sdk
+# or
+pnpm add @ganaka/sdk
+```
+
+## Quick Start
+
+```typescript
+import { GanakaClient } from "@ganaka/sdk";
+
+// Initialize the client
+const client = new GanakaClient({
+  apiKey: "your-api-key",
+  baseUrl: "https://api.ganaka.com",
+  debug: true,
+});
+
+// Check API health
+const health = await client.health();
+console.log(health);
+
+// Get shortlists
+const shortlists = await client.getShortlists();
+if (shortlists.success) {
+  console.log("Shortlists:", shortlists.data);
+}
+```
+
+## Configuration
+
+```typescript
+const client = new GanakaClient({
+  apiKey: "your-api-key", // API key for authentication
+  baseUrl: "http://localhost:3000", // API base URL
+  wsUrl: "ws://localhost:3000", // WebSocket URL for real-time data
+  timeout: 30000, // Request timeout in milliseconds
+  debug: false, // Enable debug logging
+});
+```
+
+## API Methods
+
+### Shortlists
+
+```typescript
+// Get all shortlists
+const shortlists = await client.getShortlists();
+
+// Get a specific shortlist
+const shortlist = await client.getShortlist("shortlist-id");
+
+// Create a new shortlist
+const newShortlist = await client.createShortlist({
+  name: "My Watchlist",
+  symbols: ["AAPL", "GOOGL", "MSFT"],
+});
+
+// Update a shortlist
+const updated = await client.updateShortlist("shortlist-id", {
+  name: "Updated Watchlist",
+});
+
+// Delete a shortlist
+await client.deleteShortlist("shortlist-id");
+```
+
+### Instruments
+
+```typescript
+// Search instruments
+const results = await client.searchInstruments("apple");
+
+// Get instrument details
+const instrument = await client.getInstrument("AAPL");
+
+// Get multiple instruments
+const instruments = await client.getInstruments(["AAPL", "GOOGL"]);
+```
+
+### Strategies
+
+```typescript
+// Get all strategies
+const strategies = await client.getStrategies();
+
+// Create a strategy
+const strategy = await client.createStrategy({
+  name: "My Strategy",
+  type: "momentum",
+  parameters: {
+    period: 20,
+    threshold: 0.02,
+  },
+  status: "inactive",
+});
+
+// Start/stop a strategy
+await client.startStrategy("strategy-id");
+await client.stopStrategy("strategy-id");
+```
+
+### Orders
+
+```typescript
+// Place an order
+const order = await client.placeOrder({
+  symbol: "AAPL",
+  quantity: 100,
+  orderType: "market",
+  side: "buy",
+});
+
+// Get orders
+const orders = await client.getOrders();
+
+// Cancel an order
+await client.cancelOrder("order-id");
+```
+
+## WebSocket - Real-time Data
+
+```typescript
+// Get WebSocket client
+const ws = client.getWebSocket();
+
+// Connect to WebSocket
+await client.connectWebSocket();
+
+// Subscribe to events
+ws.on("connected", () => {
+  console.log("Connected to real-time data");
+});
+
+ws.on("tick", (data) => {
+  console.log("Tick data:", data);
+});
+
+ws.on("error", (error) => {
+  console.error("WebSocket error:", error);
+});
+
+// Subscribe to tick data for symbols
+ws.subscribeTicks(["AAPL", "GOOGL"]);
+
+// Unsubscribe
+ws.unsubscribeTicks(["AAPL"]);
+
+// Disconnect
+client.disconnectWebSocket();
+```
+
+## Error Handling
+
+All API methods return an `ApiResponse` object with the following structure:
+
+```typescript
+interface ApiResponse<T> {
+  success: boolean;
+  data?: T;
+  error?: string;
+  message?: string;
+}
+```
+
+Example error handling:
+
+```typescript
+const response = await client.getShortlists();
+
+if (response.success) {
+  console.log("Data:", response.data);
+} else {
+  console.error("Error:", response.error);
+}
+```
+
+## TypeScript Support
+
+This SDK is written in TypeScript and provides full type definitions:
+
+```typescript
+import type { Shortlist, Instrument, Order, Strategy, User } from "@ganaka/sdk";
+```
+
+## Development
+
+### Building
+
+```bash
+# Install dependencies
+pnpm install
+
+# Build the library
+pnpm run build
+
+# Watch mode
+pnpm run dev
+
+# Type checking
+pnpm run lint
+```
+
+### Publishing
+
+To publish a new version to npm:
+
+```bash
+# Build before publishing
+pnpm run build
+
+# Login to npm (if not already logged in)
+npm login
+
+# Publish to npm
+npm publish
+```
+
+**Note:** 
+- You must be a member of the `ganaka` organization on npm to publish
+- The package will be published as `@ganaka/sdk` to the public npm registry
+- Ensure you have the correct version number in `package.json` before publishing
+
+## License
+
+MIT
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

package/dist/index.d.ts

@@ -0,0 +1,96 @@
+import { default as default_2 } from 'zod';
+import { growwQuotePayloadSchema } from '@ganaka/schemas';
+import { growwQuoteSchema } from '@ganaka/schemas';
+import { v1_dashboard_schemas } from '@ganaka/schemas';
+import { v1_developer_groww_schemas } from '@ganaka/schemas';
+import { v1_developer_lists_schemas } from '@ganaka/schemas';
+import { z } from 'zod';
+
+declare class ApiClient {
+    private developerToken;
+    private apiDomain;
+    constructor({ developerToken, apiDomain }: ApiClientConfig);
+    private getHeaders;
+    get<T>(path: string, params?: Record<string, any>): Promise<T>;
+    post<T>(path: string, data?: any): Promise<T>;
+    patch<T>(path: string, data?: any): Promise<T>;
+    delete<T>(path: string): Promise<T>;
+}
+
+declare interface ApiClientConfig {
+    developerToken: string;
+    apiDomain: string;
+}
+
+declare const fetchCandles: ({ developerToken, apiDomain, runId, currentTimestamp, currentTimezone, }: {
+    developerToken: string;
+    apiDomain: string;
+    runId: string | null;
+    currentTimestamp: Date;
+    currentTimezone?: string;
+}) => (params: default_2.infer<typeof v1_developer_groww_schemas.getGrowwHistoricalCandles.query>) => Promise<default_2.infer<typeof v1_developer_groww_schemas.getGrowwHistoricalCandles.response>["data"]>;
+
+export declare type FetchCandlesResponse = Awaited<ReturnType<ReturnType<typeof fetchCandles>>>;
+
+declare const fetchQuote: ({ developerToken, apiDomain, runId, currentTimestamp, currentTimezone, }: {
+    developerToken: string;
+    apiDomain: string;
+    runId: string | null;
+    currentTimestamp: Date;
+    currentTimezone?: string;
+}) => (params: default_2.infer<typeof v1_developer_groww_schemas.getGrowwQuote.query>) => Promise<default_2.infer<typeof v1_developer_groww_schemas.getGrowwQuote.response>["data"] | null>;
+
+export declare type FetchQuoteResponse = Awaited<ReturnType<ReturnType<typeof fetchQuote>>>;
+
+declare const fetchQuoteTimeline: ({ developerToken, apiDomain, runId, currentTimestamp, currentTimezone, }: {
+    developerToken: string;
+    apiDomain: string;
+    runId: string | null;
+    currentTimestamp: Date;
+    currentTimezone?: string;
+}) => (symbol: string, date: Date) => Promise<default_2.infer<typeof v1_developer_groww_schemas.getGrowwQuoteTimeline.response>["data"]["quoteTimeline"]>;
+
+export declare type FetchQuoteTimelineResponse = Awaited<ReturnType<ReturnType<typeof fetchQuoteTimeline>>>;
+
+declare const fetchShortlist: ({ developerToken, apiDomain, runId, currentTimestamp, currentTimezone, }: {
+    developerToken: string;
+    apiDomain: string;
+    runId: string | null;
+    currentTimestamp: Date;
+    currentTimezone?: string;
+}) => (queryParams: default_2.infer<typeof v1_developer_lists_schemas.getLists.query>) => Promise<default_2.infer<typeof v1_developer_lists_schemas.getLists.response>["data"] | null>;
+
+export declare type FetchShortlistResponse = Awaited<ReturnType<ReturnType<typeof fetchShortlist>>>;
+
+export declare function ganaka<T>({ fn, startTime, endTime, intervalMinutes, deleteRunAfterCompletion, }: {
+    fn: (context: RunContext) => Promise<T>;
+    startTime: Date;
+    endTime: Date;
+    intervalMinutes: number;
+    /**
+     * Delete run after completion.
+     * Used to test the function without keeping the run and related data in the database
+     * @default false
+     */
+    deleteRunAfterCompletion?: boolean;
+}): Promise<void>;
+
+export { growwQuotePayloadSchema }
+
+export { growwQuoteSchema }
+
+declare const placeOrder: ({ runId, apiClient }: {
+    runId: string | null;
+    apiClient: ApiClient;
+}) => (data: z.infer<typeof v1_dashboard_schemas.v1_dashboard_runs_schemas.createOrder.body>) => Promise<void>;
+
+export declare interface RunContext {
+    placeOrder: ReturnType<typeof placeOrder>;
+    fetchCandles: ReturnType<typeof fetchCandles>;
+    fetchQuote: ReturnType<typeof fetchQuote>;
+    fetchQuoteTimeline: ReturnType<typeof fetchQuoteTimeline>;
+    fetchShortlist: ReturnType<typeof fetchShortlist>;
+    currentTimestamp: Date;
+}
+
+export { }