fix(insights): fix schema for more recent yahoo results

gadicc · Mar 6, 2022 · c71a400 · c71a400
1 parent 82ba1cb
commit c71a400
Show file tree

Hide file tree

Showing 2 changed files with 164 additions and 10 deletions.
diff --git a/schema.json b/schema.json
@@ -837,7 +837,6 @@
             }
           },
           "required": [
-            "targetPrice",
             "provider",
             "rating"
           ],
@@ -863,6 +862,24 @@
         },
         "upsell": {
           "$ref": "#/definitions/InsightsUpsell"
+        },
+        "upsellSearchDD": {
+          "type": "object",
+          "properties": {
+            "researchReports": {
+              "$ref": "#/definitions/InsightsResearchReport"
+            }
+          },
+          "required": [
+            "researchReports"
+          ],
+          "additionalProperties": false
+        },
+        "secReports": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/InsightsSecReport"
+          }
         }
       },
       "required": [
@@ -1115,13 +1132,32 @@
           "type": "string"
         },
         "reportDate": {
-          "type": "string"
+          "yahooFinanceType": "date"
         },
         "reportTitle": {
           "type": "string"
         },
         "reportType": {
           "type": "string"
+        },
+        "targetPrice": {
+          "yahooFinanceType": "number"
+        },
+        "targetPriceStatus": {
+          "type": "string",
+          "enum": [
+            "Increased",
+            "Maintained",
+            "Decreased"
+          ]
+        },
+        "investmentRating": {
+          "type": "string",
+          "enum": [
+            "Bullish",
+            "Neutral",
+            "Bearish"
+          ]
         }
       },
       "required": [
@@ -1151,6 +1187,21 @@
     "InsightsUpsell": {
       "type": "object",
       "properties": {
+        "msBullishSummary": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "msBearishSummary": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "msBullishBearishSummariesPublishDate": {
+          "yahooFinanceType": "DateInMs"
+        },
         "companyName": {
           "type": "string"
         },
@@ -1159,10 +1210,85 @@
         }
       },
       "required": [
-        "companyName",
-        "upsellReportType"
+        "companyName"
       ]
     },
+    "DateInMs": {
+      "yahooFinanceType": "date"
+    },
+    "InsightsResearchReport": {
+      "type": "object",
+      "properties": {
+        "reportId": {
+          "type": "string"
+        },
+        "provider": {
+          "type": "string"
+        },
+        "title": {
+          "type": "string"
+        },
+        "reportDate": {
+          "yahooFinanceType": "date"
+        },
+        "summary": {
+          "type": "string"
+        },
+        "investmentRating": {
+          "type": "string",
+          "enum": [
+            "Bullish",
+            "Neutral",
+            "Bearish"
+          ]
+        }
+      },
+      "required": [
+        "reportId",
+        "provider",
+        "title",
+        "reportDate",
+        "summary",
+        "investmentRating"
+      ],
+      "additionalProperties": false
+    },
+    "InsightsSecReport": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string"
+        },
+        "type": {
+          "type": "string"
+        },
+        "title": {
+          "type": "string"
+        },
+        "description": {
+          "type": "string"
+        },
+        "filingDate": {
+          "yahooFinanceType": "DateInMs"
+        },
+        "snapshotUrl": {
+          "type": "string"
+        },
+        "formType": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "id",
+        "type",
+        "title",
+        "description",
+        "filingDate",
+        "snapshotUrl",
+        "formType"
+      ],
+      "additionalProperties": false
+    },
     "InsightsOptions": {
       "type": "object",
       "properties": {
@@ -1531,9 +1657,6 @@
       ],
       "additionalProperties": false
     },
-    "DateInMs": {
-      "yahooFinanceType": "date"
-    },
     "QuoteCryptoCurrency": {
       "type": "object",
       "properties": {

diff --git a/src/modules/insights.ts b/src/modules/insights.ts
@@ -5,20 +5,26 @@ import type {
   ModuleThis,
 } from "../lib/moduleCommon.js";
 
+import type { DateInMs } from "../lib/commonTypes.js";
+
 export interface InsightsResult {
   [key: string]: any;
   symbol: string;
   instrumentInfo?: InsightsInstrumentInfo;
   companySnapshot?: InsightsCompanySnapshot;
   recommendation?: {
-    targetPrice: number;
+    targetPrice?: number;
     provider: string;
     rating: "BUY" | "SELL" | "HOLD";
   };
   events?: InsightsEvent[];
   reports?: InsightsReport[];
   sigDevs: InsightsSigDev[];
   upsell?: InsightsUpsell;
+  upsellSearchDD?: {
+    researchReports: InsightsResearchReport;
+  };
+  secReports?: InsightsSecReport[];
 }
 
 export interface InsightsSigDev {
@@ -32,9 +38,31 @@ export interface InsightsReport {
   id: string;
   headHtml: string;
   provider: string;
-  reportDate: string;
+  reportDate: Date;
   reportTitle: string;
   reportType: string;
+  targetPrice?: number;
+  targetPriceStatus?: "Increased" | "Maintained" | "Decreased";
+  investmentRating?: "Bullish" | "Neutral" | "Bearish";
+}
+
+export interface InsightsResearchReport {
+  reportId: string;
+  provider: string;
+  title: string;
+  reportDate: Date;
+  summary: string;
+  investmentRating: "Bullish" | "Neutral" | "Bearish";
+}
+
+export interface InsightsSecReport {
+  id: string;
+  type: string;
+  title: string;
+  description: string;
+  filingDate: DateInMs;
+  snapshotUrl: string;
+  formType: string;
 }
 
 export interface InsightsEvent {
@@ -116,8 +144,11 @@ export interface InsightsOutlook {
 
 export interface InsightsUpsell {
   [key: string]: any;
+  msBullishSummary?: Array<string>;
+  msBearishSummary?: Array<string>;
+  msBullishBearishSummariesPublishDate?: DateInMs;
   companyName: string;
-  upsellReportType: string;
+  upsellReportType?: string;
 }
 
 export interface InsightsOptions {