@investment-finder/api-contract 0.4.0 → 0.6.0

package/dist/watchlist.d.ts

@@ -5,6 +5,19 @@ export declare const WatchlistItemSchema: z.ZodObject<{
     assetType: z.ZodString;
     name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     addedAt: z.ZodString;
+    marketCap: z.ZodNullable<z.ZodNumber>;
+    sector: z.ZodNullable<z.ZodString>;
+    shortDescription: z.ZodNullable<z.ZodString>;
+    price: z.ZodNullable<z.ZodNumber>;
+    dayChangePct: z.ZodNullable<z.ZodNumber>;
+    indexCodes: z.ZodArray<z.ZodEnum<{
+        sp500: "sp500";
+        nasdaq100: "nasdaq100";
+        russell2000: "russell2000";
+        etf: "etf";
+        crypto: "crypto";
+        commodity: "commodity";
+    }>>;
 }, z.core.$strip>;
 export declare const WatchlistListResponseSchema: z.ZodObject<{
     items: z.ZodArray<z.ZodObject<{
@@ -13,6 +26,19 @@ export declare const WatchlistListResponseSchema: z.ZodObject<{
         assetType: z.ZodString;
         name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
         addedAt: z.ZodString;
+        marketCap: z.ZodNullable<z.ZodNumber>;
+        sector: z.ZodNullable<z.ZodString>;
+        shortDescription: z.ZodNullable<z.ZodString>;
+        price: z.ZodNullable<z.ZodNumber>;
+        dayChangePct: z.ZodNullable<z.ZodNumber>;
+        indexCodes: z.ZodArray<z.ZodEnum<{
+            sp500: "sp500";
+            nasdaq100: "nasdaq100";
+            russell2000: "russell2000";
+            etf: "etf";
+            crypto: "crypto";
+            commodity: "commodity";
+        }>>;
     }, z.core.$strip>>;
 }, z.core.$strip>;
 export declare const WatchlistAddBodySchema: z.ZodObject<{
@@ -26,6 +52,19 @@ export declare const WatchlistAddResponseSchema: z.ZodObject<{
         assetType: z.ZodString;
         name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
         addedAt: z.ZodString;
+        marketCap: z.ZodNullable<z.ZodNumber>;
+        sector: z.ZodNullable<z.ZodString>;
+        shortDescription: z.ZodNullable<z.ZodString>;
+        price: z.ZodNullable<z.ZodNumber>;
+        dayChangePct: z.ZodNullable<z.ZodNumber>;
+        indexCodes: z.ZodArray<z.ZodEnum<{
+            sp500: "sp500";
+            nasdaq100: "nasdaq100";
+            russell2000: "russell2000";
+            etf: "etf";
+            crypto: "crypto";
+            commodity: "commodity";
+        }>>;
     }, z.core.$strip>;
 }, z.core.$strip>;
 export declare const WatchlistPickerTickerSchema: z.ZodObject<{
@@ -42,6 +81,69 @@ export declare const WatchlistPickerResponseSchema: z.ZodObject<{
 export declare const WatchlistBatchRemoveBodySchema: z.ZodObject<{
     tickers: z.ZodArray<z.ZodString>;
 }, z.core.$strip>;
+export declare const WatchlistSuggestionReasonApiEnum: z.ZodEnum<{
+    trending: "trending";
+    mover: "mover";
+    related: "related";
+}>;
+export declare const WatchlistSuggestionItemSchema: z.ZodObject<{
+    ticker: z.ZodString;
+    name: z.ZodNullable<z.ZodString>;
+    reason: z.ZodEnum<{
+        trending: "trending";
+        mover: "mover";
+        related: "related";
+    }>;
+    onWatchlist: z.ZodLiteral<false>;
+    marketCap: z.ZodNullable<z.ZodNumber>;
+    sector: z.ZodNullable<z.ZodString>;
+    assetType: z.ZodEnum<{
+        etf: "etf";
+        crypto: "crypto";
+        commodity: "commodity";
+        stock: "stock";
+    }>;
+    indexCodes: z.ZodArray<z.ZodEnum<{
+        sp500: "sp500";
+        nasdaq100: "nasdaq100";
+        russell2000: "russell2000";
+        etf: "etf";
+        crypto: "crypto";
+        commodity: "commodity";
+    }>>;
+    price: z.ZodNullable<z.ZodNumber>;
+    dayChangePct: z.ZodNullable<z.ZodNumber>;
+}, z.core.$strip>;
+export declare const WatchlistSuggestionsResponseSchema: z.ZodObject<{
+    items: z.ZodArray<z.ZodObject<{
+        ticker: z.ZodString;
+        name: z.ZodNullable<z.ZodString>;
+        reason: z.ZodEnum<{
+            trending: "trending";
+            mover: "mover";
+            related: "related";
+        }>;
+        onWatchlist: z.ZodLiteral<false>;
+        marketCap: z.ZodNullable<z.ZodNumber>;
+        sector: z.ZodNullable<z.ZodString>;
+        assetType: z.ZodEnum<{
+            etf: "etf";
+            crypto: "crypto";
+            commodity: "commodity";
+            stock: "stock";
+        }>;
+        indexCodes: z.ZodArray<z.ZodEnum<{
+            sp500: "sp500";
+            nasdaq100: "nasdaq100";
+            russell2000: "russell2000";
+            etf: "etf";
+            crypto: "crypto";
+            commodity: "commodity";
+        }>>;
+        price: z.ZodNullable<z.ZodNumber>;
+        dayChangePct: z.ZodNullable<z.ZodNumber>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
 export type WatchlistItem = z.infer<typeof WatchlistItemSchema>;
 export type WatchlistListResponse = z.infer<typeof WatchlistListResponseSchema>;
 export type WatchlistAddBody = z.infer<typeof WatchlistAddBodySchema>;
@@ -49,4 +151,7 @@ export type WatchlistAddResponse = z.infer<typeof WatchlistAddResponseSchema>;
 export type WatchlistPickerTicker = z.infer<typeof WatchlistPickerTickerSchema>;
 export type WatchlistPickerResponse = z.infer<typeof WatchlistPickerResponseSchema>;
 export type WatchlistBatchRemoveBody = z.infer<typeof WatchlistBatchRemoveBodySchema>;
+export type WatchlistSuggestionReasonApi = z.infer<typeof WatchlistSuggestionReasonApiEnum>;
+export type WatchlistSuggestionItem = z.infer<typeof WatchlistSuggestionItemSchema>;
+export type WatchlistSuggestionsResponse = z.infer<typeof WatchlistSuggestionsResponseSchema>;
 //# sourceMappingURL=watchlist.d.ts.map

package/dist/watchlist.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"watchlist.d.ts","sourceRoot":"","sources":["../src/watchlist.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,eAAO,MAAM,mBAAmB;;;;;;iBAM9B,CAAC;AAEH,eAAO,MAAM,2BAA2B;;;;;;;;iBAEtC,CAAC;AAEH,eAAO,MAAM,sBAAsB;;;iBAGjC,CAAC;AAEH,eAAO,MAAM,0BAA0B;;;;;;;;iBAErC,CAAC;AAEH,eAAO,MAAM,2BAA2B;;;iBAGtC,CAAC;AAEH,eAAO,MAAM,6BAA6B;;;;;;iBAGxC,CAAC;AAEH,eAAO,MAAM,8BAA8B;;iBAEzC,CAAC;AAEH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAEhE,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAEhF,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAEtE,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAE9E,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAEhF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAC3C,OAAO,6BAA6B,CACrC,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAC5C,OAAO,8BAA8B,CACtC,CAAC"}
+{"version":3,"file":"watchlist.d.ts","sourceRoot":"","sources":["../src/watchlist.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAOxB,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;iBAY9B,CAAC;AAEH,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;;;;;iBAEtC,CAAC;AAEH,eAAO,MAAM,sBAAsB;;;iBAGjC,CAAC;AAEH,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;;iBAErC,CAAC;AAEH,eAAO,MAAM,2BAA2B;;;iBAGtC,CAAC;AAEH,eAAO,MAAM,6BAA6B;;;;;;iBAGxC,CAAC;AAEH,eAAO,MAAM,8BAA8B;;iBAEzC,CAAC;AAEH,eAAO,MAAM,gCAAgC;;;;EAI3C,CAAC;AAEH,eAAO,MAAM,6BAA6B;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAWxC,CAAC;AAEH,eAAO,MAAM,kCAAkC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAE7C,CAAC;AAEH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAEhE,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAEhF,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAEtE,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAE9E,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAEhF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAC3C,OAAO,6BAA6B,CACrC,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAC5C,OAAO,8BAA8B,CACtC,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAChD,OAAO,gCAAgC,CACxC,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAC3C,OAAO,6BAA6B,CACrC,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAChD,OAAO,kCAAkC,CAC1C,CAAC"}

package/dist/watchlist.js

@@ -1,13 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.WatchlistBatchRemoveBodySchema = exports.WatchlistPickerResponseSchema = exports.WatchlistPickerTickerSchema = exports.WatchlistAddResponseSchema = exports.WatchlistAddBodySchema = exports.WatchlistListResponseSchema = exports.WatchlistItemSchema = void 0;
+exports.WatchlistSuggestionsResponseSchema = exports.WatchlistSuggestionItemSchema = exports.WatchlistSuggestionReasonApiEnum = exports.WatchlistBatchRemoveBodySchema = exports.WatchlistPickerResponseSchema = exports.WatchlistPickerTickerSchema = exports.WatchlistAddResponseSchema = exports.WatchlistAddBodySchema = exports.WatchlistListResponseSchema = exports.WatchlistItemSchema = void 0;
 const zod_1 = require("zod");
+const universe_js_1 = require("./universe.js");
 exports.WatchlistItemSchema = zod_1.z.object({
     id: zod_1.z.number().int().positive(),
     ticker: zod_1.z.string(),
     assetType: zod_1.z.string(),
     name: zod_1.z.string().nullable().optional(),
     addedAt: zod_1.z.string(),
+    marketCap: zod_1.z.number().nullable(),
+    sector: zod_1.z.string().nullable(),
+    shortDescription: zod_1.z.string().nullable(),
+    price: zod_1.z.number().nullable(),
+    dayChangePct: zod_1.z.number().nullable(),
+    indexCodes: zod_1.z.array(universe_js_1.UniverseIndexCodeApiEnum),
 });
 exports.WatchlistListResponseSchema = zod_1.z.object({
     items: zod_1.z.array(exports.WatchlistItemSchema),
@@ -30,4 +37,24 @@ exports.WatchlistPickerResponseSchema = zod_1.z.object({
 exports.WatchlistBatchRemoveBodySchema = zod_1.z.object({
     tickers: zod_1.z.array(zod_1.z.string().min(1).max(20)).min(1).max(50),
 });
+exports.WatchlistSuggestionReasonApiEnum = zod_1.z.enum([
+    'trending',
+    'mover',
+    'related',
+]);
+exports.WatchlistSuggestionItemSchema = zod_1.z.object({
+    ticker: zod_1.z.string(),
+    name: zod_1.z.string().nullable(),
+    reason: exports.WatchlistSuggestionReasonApiEnum,
+    onWatchlist: zod_1.z.literal(false),
+    marketCap: zod_1.z.number().nullable(),
+    sector: zod_1.z.string().nullable(),
+    assetType: universe_js_1.UniverseAssetTypeApiEnum,
+    indexCodes: zod_1.z.array(universe_js_1.UniverseIndexCodeApiEnum),
+    price: zod_1.z.number().nullable(),
+    dayChangePct: zod_1.z.number().nullable(),
+});
+exports.WatchlistSuggestionsResponseSchema = zod_1.z.object({
+    items: zod_1.z.array(exports.WatchlistSuggestionItemSchema),
+});
 //# sourceMappingURL=watchlist.js.map

package/dist/watchlist.js.map

@@ -1 +1 @@
-{"version":3,"file":"watchlist.js","sourceRoot":"","sources":["../src/watchlist.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AAEX,QAAA,mBAAmB,GAAG,OAAC,CAAC,MAAM,CAAC;IAC1C,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IAC/B,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE;IAClB,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE;IACrB,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IACtC,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE;CACpB,CAAC,CAAC;AAEU,QAAA,2BAA2B,GAAG,OAAC,CAAC,MAAM,CAAC;IAClD,KAAK,EAAE,OAAC,CAAC,KAAK,CAAC,2BAAmB,CAAC;CACpC,CAAC,CAAC;AAEU,QAAA,sBAAsB,GAAG,OAAC,CAAC,MAAM,CAAC;IAC7C,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;IACjC,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,QAAQ,EAAE;CAChD,CAAC,CAAC;AAEU,QAAA,0BAA0B,GAAG,OAAC,CAAC,MAAM,CAAC;IACjD,IAAI,EAAE,2BAAmB;CAC1B,CAAC,CAAC;AAEU,QAAA,2BAA2B,GAAG,OAAC,CAAC,MAAM,CAAC;IAClD,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE;IAClB,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE;CACtB,CAAC,CAAC;AAEU,QAAA,6BAA6B,GAAG,OAAC,CAAC,MAAM,CAAC;IACpD,UAAU,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC;IAC/B,kBAAkB,EAAE,OAAC,CAAC,MAAM,CAAC,OAAC,CAAC,MAAM,EAAE,EAAE,OAAC,CAAC,KAAK,CAAC,mCAA2B,CAAC,CAAC;CAC/E,CAAC,CAAC;AAEU,QAAA,8BAA8B,GAAG,OAAC,CAAC,MAAM,CAAC;IACrD,OAAO,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;CAC3D,CAAC,CAAC"}
+{"version":3,"file":"watchlist.js","sourceRoot":"","sources":["../src/watchlist.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AAExB,+CAGuB;AAEV,QAAA,mBAAmB,GAAG,OAAC,CAAC,MAAM,CAAC;IAC1C,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IAC/B,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE;IAClB,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE;IACrB,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IACtC,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE;IACnB,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,gBAAgB,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACvC,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,YAAY,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACnC,UAAU,EAAE,OAAC,CAAC,KAAK,CAAC,sCAAwB,CAAC;CAC9C,CAAC,CAAC;AAEU,QAAA,2BAA2B,GAAG,OAAC,CAAC,MAAM,CAAC;IAClD,KAAK,EAAE,OAAC,CAAC,KAAK,CAAC,2BAAmB,CAAC;CACpC,CAAC,CAAC;AAEU,QAAA,sBAAsB,GAAG,OAAC,CAAC,MAAM,CAAC;IAC7C,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;IACjC,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,QAAQ,EAAE;CAChD,CAAC,CAAC;AAEU,QAAA,0BAA0B,GAAG,OAAC,CAAC,MAAM,CAAC;IACjD,IAAI,EAAE,2BAAmB;CAC1B,CAAC,CAAC;AAEU,QAAA,2BAA2B,GAAG,OAAC,CAAC,MAAM,CAAC;IAClD,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE;IAClB,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE;CACtB,CAAC,CAAC;AAEU,QAAA,6BAA6B,GAAG,OAAC,CAAC,MAAM,CAAC;IACpD,UAAU,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC;IAC/B,kBAAkB,EAAE,OAAC,CAAC,MAAM,CAAC,OAAC,CAAC,MAAM,EAAE,EAAE,OAAC,CAAC,KAAK,CAAC,mCAA2B,CAAC,CAAC;CAC/E,CAAC,CAAC;AAEU,QAAA,8BAA8B,GAAG,OAAC,CAAC,MAAM,CAAC;IACrD,OAAO,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;CAC3D,CAAC,CAAC;AAEU,QAAA,gCAAgC,GAAG,OAAC,CAAC,IAAI,CAAC;IACrD,UAAU;IACV,OAAO;IACP,SAAS;CACV,CAAC,CAAC;AAEU,QAAA,6BAA6B,GAAG,OAAC,CAAC,MAAM,CAAC;IACpD,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE;IAClB,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,MAAM,EAAE,wCAAgC;IACxC,WAAW,EAAE,OAAC,CAAC,OAAO,CAAC,KAAK,CAAC;IAC7B,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,SAAS,EAAE,sCAAwB;IACnC,UAAU,EAAE,OAAC,CAAC,KAAK,CAAC,sCAAwB,CAAC;IAC7C,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,YAAY,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACpC,CAAC,CAAC;AAEU,QAAA,kCAAkC,GAAG,OAAC,CAAC,MAAM,CAAC;IACzD,KAAK,EAAE,OAAC,CAAC,KAAK,CAAC,qCAA6B,CAAC;CAC9C,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@investment-finder/api-contract",
-  "version": "0.4.0",
+  "version": "0.6.0",
   "description": "Zod schemas for the Investment Finder /api/v1 JSON API",
   "license": "UNLICENSED",
   "main": "./dist/index.js",