@ganaka/sdk 1.2.0 → 1.4.0

package/dist/index.d.ts

@@ -131,6 +131,14 @@ declare const fetchShortlist: ({ developerToken, apiDomain, runId, currentTimest
     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>;
 
+declare const fetchShortlistPersistence: ({ developerToken, apiDomain, runId, currentTimestamp, currentTimezone, }: {
+    developerToken: string;
+    apiDomain: string;
+    runId: string | null;
+    currentTimestamp: string;
+    currentTimezone?: string;
+}) => (queryParams: default_2.infer<typeof v1_developer_shortlist_persistence_schemas.getShortlistPersistence.query>) => Promise<default_2.infer<typeof v1_developer_shortlist_persistence_schemas.getShortlistPersistence.response>["data"] | null>;
+
 export declare type FetchShortlistResponse = Awaited<ReturnType<ReturnType<typeof fetchShortlist>>>;
 
 export declare function ganaka<T>({ fn, startTime, endTime, intervalMinutes, deleteRunAfterCompletion, name, tags, }: {
@@ -428,7 +436,8 @@ declare const getGrowwQuote: {
 declare const getGrowwQuoteTimeline: {
     query: z.ZodObject<{
         symbol: z.ZodString;
-        date: z.ZodString;
+        end_datetime: z.ZodString;
+        timezone: z.ZodOptional<z.ZodString>;
     }, z.core.$strip>;
     response: z.ZodObject<{
         statusCode: z.ZodNumber;
@@ -646,6 +655,38 @@ declare const getRunTags: {
     }, z.core.$strip>;
 };
 
+declare const getShortlistPersistence: {
+    query: z.ZodObject<{
+        type: z.ZodEnum<{
+            "top-gainers": "top-gainers";
+            "volume-shockers": "volume-shockers";
+        }>;
+        start_datetime: z.ZodString;
+        end_datetime: z.ZodString;
+        timezone: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+    response: z.ZodObject<{
+        statusCode: z.ZodNumber;
+        message: z.ZodString;
+        data: z.ZodObject<{
+            start_datetime: z.ZodString;
+            end_datetime: z.ZodString;
+            type: z.ZodEnum<{
+                "top-gainers": "top-gainers";
+                "volume-shockers": "volume-shockers";
+            }>;
+            totalSnapshots: z.ZodNumber;
+            instruments: z.ZodArray<z.ZodObject<{
+                nseSymbol: z.ZodString;
+                name: z.ZodString;
+                appearanceCount: z.ZodNumber;
+                totalSnapshots: z.ZodNumber;
+                percentage: z.ZodNumber;
+            }, z.core.$strip>>;
+        }, z.core.$strip>;
+    }, z.core.$strip>;
+};
+
 declare const getShortlists: {
     query: z.ZodObject<{
         datetime: z.ZodString;
@@ -849,8 +890,20 @@ export declare interface RunContext {
     fetchCandles: ReturnType<typeof fetchCandles>;
     fetchQuote: ReturnType<typeof fetchQuote>;
     fetchNiftyQuote: ReturnType<typeof fetchNiftyQuote>;
+    /**
+     * Given a symbol and a end_datetime, returns the quote timeline for the given date
+     */
     fetchQuoteTimeline: ReturnType<typeof fetchQuoteTimeline>;
     fetchShortlist: ReturnType<typeof fetchShortlist>;
+    /**
+     * Given a shortlist type and a start and end datetime,
+     * returns the list of instruments that appeared in the shortlist during the time range
+     * in descending order of appearance count
+     *
+     * This helps identify the stocks that have been consistently appearing in the shortlist
+     * over a given period of time.
+     */
+    fetchShortlistPersistence: ReturnType<typeof fetchShortlistPersistence>;
     /**
      * Current timestamp in IST string format (YYYY-MM-DDTHH:mm:ss)
      * for every loop iteration
@@ -980,4 +1033,10 @@ declare namespace v1_developer_lists_schemas {
     }
 }
 
+declare namespace v1_developer_shortlist_persistence_schemas {
+    export {
+        getShortlistPersistence
+    }
+}
+
 export { }

package/dist/index.js

@@ -4174,7 +4174,7 @@ object({
   statusCode: number$1(),
   message: string()
 });
-const m = [
+const c = [
   "1minute",
   "2minute",
   "3minute",
@@ -4227,7 +4227,7 @@ const m = [
   name: string(),
   price: number$1(),
   quoteData: a.nullable().optional()
-}), c = _enum(["TOP_GAINERS", "VOLUME_SHOCKERS"]), b = object({
+}), m = _enum(["TOP_GAINERS", "VOLUME_SHOCKERS"]), b = object({
   nseSymbol: string(),
   quoteData: a
 });
@@ -4236,7 +4236,7 @@ const m = [
     data: object({
       timestamp: n,
       timezone: o.optional(),
-      shortlistType: c,
+      shortlistType: m,
       entries: array(d)
     })
   }),
@@ -4245,7 +4245,7 @@ const m = [
       id: string(),
       timestamp: string(),
       // Format: YYYY-MM-DDTHH:mm:ss (UTC)
-      shortlistType: c,
+      shortlistType: m,
       entriesCount: number$1()
     })
   })
@@ -4296,10 +4296,10 @@ const p = object({
     end_time: string(),
     interval_in_minutes: number$1()
   })
-}), f = {
+}), v = {
   query: object({
     symbol: string(),
-    interval: _enum(m),
+    interval: _enum(c),
     start_datetime: n,
     end_datetime: n,
     timezone: o.optional()
@@ -4307,7 +4307,7 @@ const p = object({
   response: t.extend({
     data: p
   })
-}, v = {
+}, f = {
   query: object({
     symbol: string(),
     exchange: _enum(["NSE", "BSE"]).optional(),
@@ -4325,7 +4325,8 @@ const p = object({
 }, x = {
   query: object({
     symbol: string(),
-    date: i
+    end_datetime: n,
+    timezone: o.optional()
   }),
   response: t.extend({
     data: object({
@@ -4352,11 +4353,11 @@ const p = object({
   response: t.extend({
     data: a.nullable()
   })
-}, ye = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
+}, je = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
   __proto__: null,
-  getGrowwHistoricalCandles: f,
+  getGrowwHistoricalCandles: v,
   getGrowwNiftyQuote: P,
-  getGrowwQuote: v,
+  getGrowwQuote: f,
   getGrowwQuoteTimeline: x,
   getGrowwToken: T,
   growwHistoricalCandlesSchema: p
@@ -4364,7 +4365,7 @@ const p = object({
   name: string(),
   price: number$1(),
   nseSymbol: string()
-}), q = {
+}), O = {
   query: object({
     type: _enum(["top-gainers", "volume-shockers"]),
     datetime: n.optional(),
@@ -4373,11 +4374,38 @@ const p = object({
   response: t.extend({
     data: array(g).nullable()
   })
-}, je = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
+}, he = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
   __proto__: null,
-  getLists: q,
+  getLists: O,
   listSchema: g
-}, Symbol.toStringTag, { value: "Module" })), O = {
+}, Symbol.toStringTag, { value: "Module" })), q = {
+  query: object({
+    type: _enum(["top-gainers", "volume-shockers"]),
+    start_datetime: n,
+    end_datetime: n,
+    timezone: o.optional()
+  }),
+  response: t.extend({
+    data: object({
+      start_datetime: string(),
+      end_datetime: string(),
+      type: _enum(["top-gainers", "volume-shockers"]),
+      totalSnapshots: number$1(),
+      instruments: array(
+        object({
+          nseSymbol: string(),
+          name: string(),
+          appearanceCount: number$1(),
+          totalSnapshots: number$1(),
+          percentage: number$1()
+        })
+      )
+    })
+  })
+}, Se = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
+  __proto__: null,
+  getShortlistPersistence: q
+}, Symbol.toStringTag, { value: "Module" })), z = {
   query: object({}),
   response: t.extend({
     data: object({
@@ -4393,12 +4421,12 @@ const p = object({
   })
 }, w = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
   __proto__: null,
-  getAvailableDatetimes: O
-}, Symbol.toStringTag, { value: "Module" })), z = {
+  getAvailableDatetimes: z
+}, Symbol.toStringTag, { value: "Module" })), D = {
   query: object({
     symbol: string(),
     date: i,
-    interval: _enum(m).optional()
+    interval: _enum(c).optional()
   }),
   response: t.extend({
     data: object({
@@ -4416,10 +4444,10 @@ const p = object({
       interval_in_minutes: number$1()
     })
   })
-}, D = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
+}, C = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
   __proto__: null,
-  getCandles: z
-}, Symbol.toStringTag, { value: "Module" })), C = {
+  getCandles: D
+}, Symbol.toStringTag, { value: "Module" })), M = {
   query: object({
     date: i,
     type: _enum(t$1)
@@ -4439,10 +4467,10 @@ const p = object({
       )
     })
   })
-}, M = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
+}, R = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
   __proto__: null,
-  getDailyPersistentCompanies: C
-}, Symbol.toStringTag, { value: "Module" })), R = {
+  getDailyPersistentCompanies: M
+}, Symbol.toStringTag, { value: "Module" })), A = {
   query: object({
     date: i,
     type: _enum(t$1)
@@ -4454,23 +4482,23 @@ const p = object({
       uniqueCount: number$1()
     })
   })
-}, A = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
+}, k = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
   __proto__: null,
-  getDailyUniqueCompanies: R
-}, Symbol.toStringTag, { value: "Module" })), k = object({
+  getDailyUniqueCompanies: A
+}, Symbol.toStringTag, { value: "Module" })), E = object({
   id: uuid(),
   username: string()
-}), E = {
+}), I = {
   body: object({
     developerToken: string().nonempty("Developer token is required")
   }),
   response: t.extend({
-    data: k
+    data: E
   })
-}, I = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
+}, L = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
   __proto__: null,
-  signIn: E
-}, Symbol.toStringTag, { value: "Module" })), L = {
+  signIn: I
+}, Symbol.toStringTag, { value: "Module" })), N = {
   query: object({
     symbol: string(),
     date: i
@@ -4492,10 +4520,10 @@ const p = object({
       )
     })
   })
-}, N = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
+}, G = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
   __proto__: null,
-  getQuoteTimeline: L
-}, Symbol.toStringTag, { value: "Module" })), G = object({
+  getQuoteTimeline: N
+}, Symbol.toStringTag, { value: "Module" })), U = object({
   id: uuid(),
   start_datetime: string(),
   end_datetime: string(),
@@ -4503,15 +4531,15 @@ const p = object({
   orderCount: number$1(),
   name: string().nullable().optional(),
   tags: array(string()).optional()
-}), U = record(
+}), Q = record(
   string(),
   // date string (YYYY-MM-DD)
-  array(G)
-), Q = {
+  array(U)
+), Y = {
   response: t.extend({
-    data: U
+    data: Q
   })
-}, Y = object({
+}, H = object({
   id: uuid(),
   nseSymbol: string(),
   entryPrice: number(),
@@ -4530,7 +4558,7 @@ const p = object({
   stopLossHit: boolean().optional(),
   stopLossTimestamp: string().optional(),
   timeToStopLossMinutes: number$1().optional()
-}), H = {
+}), $ = {
   params: object({
     runId: uuid()
   }),
@@ -4538,46 +4566,46 @@ const p = object({
     targetGainPercentage: number().optional()
   }),
   response: t.extend({
-    data: array(Y)
+    data: array(H)
   })
-}, $ = object({
+}, F = object({
   start_datetime: n,
   end_datetime: n,
   timezone: o.optional(),
   name: string().optional(),
   tags: array(string().min(1).max(50)).optional()
-}), F = object({
+}), B = object({
   id: uuid(),
   start_datetime: n,
   end_datetime: n,
   completed: boolean(),
   name: string().nullable().optional(),
   tags: array(string()).optional()
-}), B = {
-  body: $,
+}), K = {
+  body: F,
   response: t.extend({
-    data: F
+    data: B
   })
-}, K = object({
+}, Z = object({
   completed: boolean().optional(),
   name: string().nullable().optional(),
   tags: array(string().min(1).max(50)).optional()
-}), Z = object({
+}), V = object({
   id: uuid(),
   start_datetime: string(),
   end_datetime: string(),
   completed: boolean(),
   name: string().nullable().optional(),
   tags: array(string()).optional()
-}), V = {
+}), J = {
   params: object({
     runId: uuid()
   }),
-  body: K,
+  body: Z,
   response: t.extend({
-    data: Z
+    data: V
   })
-}, J = {
+}, W = {
   params: object({
     runId: uuid()
   }),
@@ -4586,14 +4614,14 @@ const p = object({
       id: uuid()
     })
   })
-}, W = object({
+}, X = object({
   nseSymbol: string(),
   entryPrice: number(),
   stopLossPrice: number(),
   takeProfitPrice: number(),
   datetime: n,
   timezone: o.optional()
-}), X = object({
+}), ee = object({
   id: uuid(),
   nseSymbol: string(),
   entryPrice: number(),
@@ -4601,28 +4629,28 @@ const p = object({
   takeProfitPrice: number(),
   datetime: string(),
   runId: uuid()
-}), ee = {
+}), te = {
   params: object({
     runId: uuid()
   }),
-  body: W,
+  body: X,
   response: t.extend({
-    data: X
+    data: ee
   })
-}, te = {
+}, ne = {
   response: t.extend({
     data: array(string())
   })
-}, ne = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
+}, oe = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
   __proto__: null,
-  createOrder: ee,
-  createRun: B,
-  deleteRun: J,
-  getRunOrders: H,
-  getRunTags: te,
-  getRuns: Q,
-  updateRun: V
-}, Symbol.toStringTag, { value: "Module" })), oe = {
+  createOrder: te,
+  createRun: K,
+  deleteRun: W,
+  getRunOrders: $,
+  getRunTags: ne,
+  getRuns: Y,
+  updateRun: J
+}, Symbol.toStringTag, { value: "Module" })), ae = {
   query: object({
     datetime: n,
     timezone: o.optional(),
@@ -4639,19 +4667,19 @@ const p = object({
       }).nullable()
     })
   })
-}, ae = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
+}, re = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
   __proto__: null,
-  getShortlists: oe
-}, Symbol.toStringTag, { value: "Module" })), he = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
+  getShortlists: ae
+}, Symbol.toStringTag, { value: "Module" })), ve = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
   __proto__: null,
-  v1_dashboard_auth_schemas: I,
+  v1_dashboard_auth_schemas: L,
   v1_dashboard_available_datetimes_schemas: w,
-  v1_dashboard_candles_schemas: D,
-  v1_dashboard_daily_persistent_companies_schemas: M,
-  v1_dashboard_daily_unique_companies_schemas: A,
-  v1_dashboard_quote_timeline_schemas: N,
-  v1_dashboard_runs_schemas: ne,
-  v1_dashboard_shortlists_schemas: ae
+  v1_dashboard_candles_schemas: C,
+  v1_dashboard_daily_persistent_companies_schemas: R,
+  v1_dashboard_daily_unique_companies_schemas: k,
+  v1_dashboard_quote_timeline_schemas: G,
+  v1_dashboard_runs_schemas: oe,
+  v1_dashboard_shortlists_schemas: re
 }, Symbol.toStringTag, { value: "Module" }));
 ({
   response: t.extend({
@@ -7940,7 +7968,7 @@ const fetchCandles = ({
     );
   }
   try {
-    const validatedParams = ye.getGrowwHistoricalCandles.query.parse(params);
+    const validatedParams = je.getGrowwHistoricalCandles.query.parse(params);
     const headers = {
       Authorization: `Bearer ${developerToken}`
     };
@@ -7984,7 +8012,7 @@ const fetchQuote = ({
     );
   }
   try {
-    const validatedParams = ye.getGrowwQuote.query.parse(params);
+    const validatedParams = je.getGrowwQuote.query.parse(params);
     const headers = {
       Authorization: `Bearer ${developerToken}`
     };
@@ -8024,7 +8052,7 @@ const fetchQuoteTimeline = ({
     throw new Error("Developer token not found. Please set DEVELOPER_KEY environment variable.");
   }
   try {
-    const validatedParams = ye.getGrowwQuoteTimeline.query.parse({
+    const validatedParams = je.getGrowwQuoteTimeline.query.parse({
       symbol,
       date: date2
     });
@@ -8071,7 +8099,7 @@ const fetchShortlist = ({
     );
   }
   try {
-    const validatedParams = je.getLists.query.parse(queryParams);
+    const validatedParams = he.getLists.query.parse(queryParams);
     const headers = {
       Authorization: `Bearer ${developerToken}`
     };
@@ -8102,6 +8130,52 @@ const fetchShortlist = ({
 };
 dayjs.extend(utc);
 dayjs.extend(timezone);
+const fetchShortlistPersistence = ({
+  developerToken,
+  apiDomain,
+  runId,
+  currentTimestamp,
+  currentTimezone = "Asia/Kolkata"
+}) => async (queryParams) => {
+  if (!developerToken) {
+    throw new Error(
+      "Developer token not found. Please set DEVELOPER_TOKEN environment variable."
+    );
+  }
+  try {
+    const validatedParams = Se.getShortlistPersistence.query.parse(queryParams);
+    const headers = {
+      Authorization: `Bearer ${developerToken}`
+    };
+    if (runId) {
+      headers["X-Run-Id"] = runId;
+    }
+    if (currentTimestamp) {
+      headers["X-Current-Timestamp"] = currentTimestamp;
+    }
+    if (currentTimezone) {
+      headers["X-Current-Timezone"] = currentTimezone;
+    }
+    const response = await axios.get(`${apiDomain}/v1/developer/shortlists/persistence`, {
+      params: validatedParams,
+      headers
+    });
+    return response.data.data;
+  } catch (error) {
+    if (axios.isAxiosError(error)) {
+      logger.error(
+        `Error fetching shortlist persistence for ${queryParams.type}: ${error.message}`
+      );
+      throw new Error(
+        `Failed to fetch shortlist persistence: ${error.response?.data?.message || error.message}`
+      );
+    }
+    logger.error(`Unexpected error fetching shortlist persistence: ${error}`);
+    throw error;
+  }
+};
+dayjs.extend(utc);
+dayjs.extend(timezone);
 const fetchNiftyQuote = ({
   developerToken,
   apiDomain,
@@ -8113,7 +8187,7 @@ const fetchNiftyQuote = ({
     throw new Error("Developer token not found. Please set DEVELOPER_KEY environment variable.");
   }
   try {
-    const validatedParams = ye.getGrowwNiftyQuote.query.parse(params);
+    const validatedParams = je.getGrowwNiftyQuote.query.parse(params);
     const headers = {
       Authorization: `Bearer ${developerToken}`
     };
@@ -8220,7 +8294,7 @@ const placeOrder = ({ runId, apiClient }) => async (data) => {
     try {
       await retryWithBackoff(
         async () => {
-          const validatedData = he.v1_dashboard_runs_schemas.createOrder.body.parse(data);
+          const validatedData = ve.v1_dashboard_runs_schemas.createOrder.body.parse(data);
           await apiClient.post(`/v1/dashboard/runs/${runId}/orders`, validatedData);
           logger.debug(`Order persisted for ${data.nseSymbol} in runId: ${runId}`);
         },
@@ -8566,6 +8640,13 @@ async function ganaka({
             currentTimestamp,
             currentTimezone: "Asia/Kolkata"
           }),
+          fetchShortlistPersistence: fetchShortlistPersistence({
+            developerToken,
+            apiDomain,
+            runId,
+            currentTimestamp,
+            currentTimezone: "Asia/Kolkata"
+          }),
           currentTimestamp
         });
       }