@ganaka/sdk 1.1.0 → 1.2.0

package/dist/index.d.ts

@@ -49,6 +49,8 @@ declare const createRun: {
         start_datetime: z.ZodString;
         end_datetime: z.ZodString;
         timezone: z.ZodOptional<z.ZodString>;
+        name: z.ZodOptional<z.ZodString>;
+        tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
     }, z.core.$strip>;
     response: z.ZodObject<{
         statusCode: z.ZodNumber;
@@ -58,6 +60,8 @@ declare const createRun: {
             start_datetime: z.ZodString;
             end_datetime: z.ZodString;
             completed: z.ZodBoolean;
+            name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
         }, z.core.$strip>;
     }, z.core.$strip>;
 };
@@ -129,7 +133,7 @@ declare const fetchShortlist: ({ developerToken, apiDomain, runId, currentTimest
 
 export declare type FetchShortlistResponse = Awaited<ReturnType<ReturnType<typeof fetchShortlist>>>;
 
-export declare function ganaka<T>({ fn, startTime, endTime, intervalMinutes, deleteRunAfterCompletion, }: {
+export declare function ganaka<T>({ fn, startTime, endTime, intervalMinutes, deleteRunAfterCompletion, name, tags, }: {
     fn: (context: RunContext) => Promise<T>;
     /** Start time in IST string format (YYYY-MM-DDTHH:mm:ss) */
     startTime: string;
@@ -142,6 +146,14 @@ export declare function ganaka<T>({ fn, startTime, endTime, intervalMinutes, del
      * @default false
      */
     deleteRunAfterCompletion?: boolean;
+    /**
+     * Optional name for the run
+     */
+    name?: string;
+    /**
+     * Optional array of tags to classify and group the run
+     */
+    tags?: string[];
 }): Promise<void>;
 
 declare const getAvailableDatetimes: {
@@ -620,10 +632,20 @@ declare const getRuns: {
             end_datetime: z.ZodString;
             completed: z.ZodBoolean;
             orderCount: z.ZodNumber;
+            name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
         }, z.core.$strip>>>;
     }, z.core.$strip>;
 };
 
+declare const getRunTags: {
+    response: z.ZodObject<{
+        statusCode: z.ZodNumber;
+        message: z.ZodString;
+        data: z.ZodArray<z.ZodString>;
+    }, z.core.$strip>;
+};
+
 declare const getShortlists: {
     query: z.ZodObject<{
         datetime: z.ZodString;
@@ -856,6 +878,8 @@ declare const updateRun: {
     }, z.core.$strip>;
     body: z.ZodObject<{
         completed: z.ZodOptional<z.ZodBoolean>;
+        name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
     }, z.core.$strip>;
     response: z.ZodObject<{
         statusCode: z.ZodNumber;
@@ -865,6 +889,8 @@ declare const updateRun: {
             start_datetime: z.ZodString;
             end_datetime: z.ZodString;
             completed: z.ZodBoolean;
+            name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
         }, z.core.$strip>;
     }, z.core.$strip>;
 };
@@ -912,7 +938,8 @@ declare namespace v1_dashboard_runs_schemas {
         createRun,
         updateRun,
         deleteRun,
-        createOrder
+        createOrder,
+        getRunTags
     }
 }
 

package/dist/index.js

@@ -4110,7 +4110,7 @@ const t$1 = [
   "TOP_GAINERS",
   "VOLUME_SHOCKERS"
 ];
-const g = object({
+const _ = object({
   average_price: number$1().nullable(),
   bid_quantity: number$1().nullable(),
   bid_price: number$1().nullable(),
@@ -4158,7 +4158,7 @@ const g = object({
   week_52_low: number$1().nullable()
 }), a = object({
   status: _enum(["SUCCESS", "FAILURE"]),
-  payload: g
+  payload: _
 }), y = object({
   nseSymbol: string(),
   name: string(),
@@ -4322,7 +4322,7 @@ const p = object({
   response: t.extend({
     data: string()
   })
-}, P = {
+}, x = {
   query: object({
     symbol: string(),
     date: i
@@ -4344,7 +4344,7 @@ const p = object({
       )
     })
   })
-}, q = {
+}, P = {
   query: object({
     datetime: n.optional(),
     timezone: o.optional()
@@ -4352,31 +4352,31 @@ const p = object({
   response: t.extend({
     data: a.nullable()
   })
-}, ge = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
+}, ye = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
   __proto__: null,
   getGrowwHistoricalCandles: f,
-  getGrowwNiftyQuote: q,
+  getGrowwNiftyQuote: P,
   getGrowwQuote: v,
-  getGrowwQuoteTimeline: P,
+  getGrowwQuoteTimeline: x,
   getGrowwToken: T,
   growwHistoricalCandlesSchema: p
-}, Symbol.toStringTag, { value: "Module" })), _ = object({
+}, Symbol.toStringTag, { value: "Module" })), g = object({
   name: string(),
   price: number$1(),
   nseSymbol: string()
-}), x = {
+}), q = {
   query: object({
     type: _enum(["top-gainers", "volume-shockers"]),
     datetime: n.optional(),
     timezone: o.optional()
   }),
   response: t.extend({
-    data: array(_).nullable()
+    data: array(g).nullable()
   })
-}, ye = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
+}, je = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
   __proto__: null,
-  getLists: x,
-  listSchema: _
+  getLists: q,
+  listSchema: g
 }, Symbol.toStringTag, { value: "Module" })), O = {
   query: object({}),
   response: t.extend({
@@ -4442,7 +4442,7 @@ const p = object({
 }, M = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
   __proto__: null,
   getDailyPersistentCompanies: C
-}, Symbol.toStringTag, { value: "Module" })), A = {
+}, Symbol.toStringTag, { value: "Module" })), R = {
   query: object({
     date: i,
     type: _enum(t$1)
@@ -4454,9 +4454,9 @@ const p = object({
       uniqueCount: number$1()
     })
   })
-}, R = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
+}, A = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
   __proto__: null,
-  getDailyUniqueCompanies: A
+  getDailyUniqueCompanies: R
 }, Symbol.toStringTag, { value: "Module" })), k = object({
   id: uuid(),
   username: string()
@@ -4500,7 +4500,9 @@ const p = object({
   start_datetime: string(),
   end_datetime: string(),
   completed: boolean(),
-  orderCount: number$1()
+  orderCount: number$1(),
+  name: string().nullable().optional(),
+  tags: array(string()).optional()
 }), U = record(
   string(),
   // date string (YYYY-MM-DD)
@@ -4541,24 +4543,32 @@ const p = object({
 }, $ = object({
   start_datetime: n,
   end_datetime: n,
-  timezone: o.optional()
+  timezone: o.optional(),
+  name: string().optional(),
+  tags: array(string().min(1).max(50)).optional()
 }), F = object({
   id: uuid(),
   start_datetime: n,
   end_datetime: n,
-  completed: boolean()
+  completed: boolean(),
+  name: string().nullable().optional(),
+  tags: array(string()).optional()
 }), B = {
   body: $,
   response: t.extend({
     data: F
   })
 }, K = object({
-  completed: boolean().optional()
+  completed: boolean().optional(),
+  name: string().nullable().optional(),
+  tags: array(string().min(1).max(50)).optional()
 }), Z = object({
   id: uuid(),
   start_datetime: string(),
   end_datetime: string(),
-  completed: boolean()
+  completed: boolean(),
+  name: string().nullable().optional(),
+  tags: array(string()).optional()
 }), V = {
   params: object({
     runId: uuid()
@@ -4599,15 +4609,20 @@ const p = object({
   response: t.extend({
     data: X
   })
-}, te = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
+}, te = {
+  response: t.extend({
+    data: array(string())
+  })
+}, ne = /* @__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" })), ne = {
+}, Symbol.toStringTag, { value: "Module" })), oe = {
   query: object({
     datetime: n,
     timezone: o.optional(),
@@ -4624,19 +4639,19 @@ const p = object({
       }).nullable()
     })
   })
-}, oe = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
+}, ae = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
   __proto__: null,
-  getShortlists: ne
-}, Symbol.toStringTag, { value: "Module" })), je = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
+  getShortlists: oe
+}, Symbol.toStringTag, { value: "Module" })), he = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
   __proto__: null,
   v1_dashboard_auth_schemas: I,
   v1_dashboard_available_datetimes_schemas: w,
   v1_dashboard_candles_schemas: D,
   v1_dashboard_daily_persistent_companies_schemas: M,
-  v1_dashboard_daily_unique_companies_schemas: R,
+  v1_dashboard_daily_unique_companies_schemas: A,
   v1_dashboard_quote_timeline_schemas: N,
-  v1_dashboard_runs_schemas: te,
-  v1_dashboard_shortlists_schemas: oe
+  v1_dashboard_runs_schemas: ne,
+  v1_dashboard_shortlists_schemas: ae
 }, Symbol.toStringTag, { value: "Module" }));
 ({
   response: t.extend({
@@ -7925,7 +7940,7 @@ const fetchCandles = ({
     );
   }
   try {
-    const validatedParams = ge.getGrowwHistoricalCandles.query.parse(params);
+    const validatedParams = ye.getGrowwHistoricalCandles.query.parse(params);
     const headers = {
       Authorization: `Bearer ${developerToken}`
     };
@@ -7969,7 +7984,7 @@ const fetchQuote = ({
     );
   }
   try {
-    const validatedParams = ge.getGrowwQuote.query.parse(params);
+    const validatedParams = ye.getGrowwQuote.query.parse(params);
     const headers = {
       Authorization: `Bearer ${developerToken}`
     };
@@ -8009,7 +8024,7 @@ const fetchQuoteTimeline = ({
     throw new Error("Developer token not found. Please set DEVELOPER_KEY environment variable.");
   }
   try {
-    const validatedParams = ge.getGrowwQuoteTimeline.query.parse({
+    const validatedParams = ye.getGrowwQuoteTimeline.query.parse({
       symbol,
       date: date2
     });
@@ -8056,7 +8071,7 @@ const fetchShortlist = ({
     );
   }
   try {
-    const validatedParams = ye.getLists.query.parse(queryParams);
+    const validatedParams = je.getLists.query.parse(queryParams);
     const headers = {
       Authorization: `Bearer ${developerToken}`
     };
@@ -8098,7 +8113,7 @@ const fetchNiftyQuote = ({
     throw new Error("Developer token not found. Please set DEVELOPER_KEY environment variable.");
   }
   try {
-    const validatedParams = ge.getGrowwNiftyQuote.query.parse(params);
+    const validatedParams = ye.getGrowwNiftyQuote.query.parse(params);
     const headers = {
       Authorization: `Bearer ${developerToken}`
     };
@@ -8205,7 +8220,7 @@ const placeOrder = ({ runId, apiClient }) => async (data) => {
     try {
       await retryWithBackoff(
         async () => {
-          const validatedData = je.v1_dashboard_runs_schemas.createOrder.body.parse(data);
+          const validatedData = he.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}`);
         },
@@ -8464,7 +8479,9 @@ async function ganaka({
   startTime,
   endTime,
   intervalMinutes = 1,
-  deleteRunAfterCompletion = false
+  deleteRunAfterCompletion = false,
+  name,
+  tags
 }) {
   const developerToken = process.env.DEVELOPER_KEY;
   const apiDomain = process.env.API_DOMAIN || "https://api.ganaka.live";
@@ -8483,7 +8500,9 @@ async function ganaka({
   const createRunBody = {
     start_datetime: startTime,
     end_datetime: endTime,
-    timezone: "Asia/Kolkata"
+    timezone: "Asia/Kolkata",
+    ...name !== void 0 && { name },
+    ...tags !== void 0 && { tags }
   };
   try {
     const createRunResponse = await apiClient.post("/v1/dashboard/runs", createRunBody);
@@ -8574,6 +8593,6 @@ async function ganaka({
   }
 }
 exports.ganaka = ganaka;
-exports.growwQuotePayloadSchema = g;
+exports.growwQuotePayloadSchema = _;
 exports.growwQuoteSchema = a;
 //# sourceMappingURL=index.js.map