@aventurevc/api-schemas 0.8.101 → 0.8.102

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (20) hide show
  1. package/dist/entity/filter-search.d.ts +1 -0
  2. package/dist/entity/filter.d.ts +1 -0
  3. package/dist/entity/filter.js +2 -0
  4. package/dist/entity/list-filter.d.ts +1 -0
  5. package/dist/entity/list-filter.js +2 -0
  6. package/dist/entity/natural-search.d.ts +1 -0
  7. package/dist/federated/natural-search.d.ts +1 -0
  8. package/dist/federated/search.d.ts +4 -0
  9. package/dist/link/search.d.ts +4 -0
  10. package/dist/natural/search-result.d.ts +2 -0
  11. package/dist/person/filter.d.ts +1 -0
  12. package/dist/person/natural-search-result.d.ts +2 -0
  13. package/dist/person/natural-search.d.ts +1 -0
  14. package/dist/person/search-interpretation.d.ts +1 -0
  15. package/dist/search/interpretation.d.ts +2 -0
  16. package/dist/search/search.d.ts +1 -0
  17. package/dist/search/search.js +2 -0
  18. package/dist/shared/search.d.ts +4 -0
  19. package/dist/web/search.d.ts +2 -0
  20. package/package.json +1 -1
package/dist/entity/filter-search.d.ts CHANGED
@@ -136,6 +136,7 @@ declare const EntityFilterSearchSchemaDefinition: z.ZodObject<{
136
136
  COMPANY_LISTING_READY: "COMPANY_LISTING_READY";
137
137
  NONE: "NONE";
138
138
  }>>;
139
+ rankByProminence: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
139
140
  slug: z.ZodOptional<z.ZodArray<z.ZodString>>;
140
141
  stage: z.ZodOptional<z.ZodArray<z.ZodString>>;
141
142
  suppressNonOperating: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
package/dist/entity/filter.d.ts CHANGED
@@ -154,6 +154,7 @@ export declare const EntityFilterSchema: z.ZodObject<{
154
154
  COMPANY_LISTING_READY: "COMPANY_LISTING_READY";
155
155
  NONE: "NONE";
156
156
  }>>;
157
+ rankByProminence: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
157
158
  slug: z.ZodOptional<z.ZodArray<z.ZodString>>;
158
159
  stage: z.ZodOptional<z.ZodArray<z.ZodString>>;
159
160
  suppressNonOperating: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
package/dist/entity/filter.js CHANGED
@@ -83,6 +83,8 @@ export const EntityFilterSchema = z.strictObject({
83
83
  portfolioHeadquartersState: z.array(z.string()).optional(),
84
84
  /** Named server-owned list quality gate. */
85
85
  qualityGate: EntityListQualityGateSchema.optional(),
86
+ /** Rank most prominent first (funding, stage, headcount, momentum, recent news, investor breadth), ahead of sort: what best, top, or most promising mean. */
87
+ rankByProminence: z.boolean().nullish(),
86
88
  /** Restrict results to entity slugs. */
87
89
  slug: z
88
90
  .array(z
package/dist/entity/list-filter.d.ts CHANGED
@@ -132,6 +132,7 @@ declare const EntityListFilterSchemaDefinition: z.ZodObject<{
132
132
  COMPANY_LISTING_READY: "COMPANY_LISTING_READY";
133
133
  NONE: "NONE";
134
134
  }>>;
135
+ rankByProminence: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
135
136
  semanticQuery: z.ZodOptional<z.ZodNullable<z.ZodString>>;
136
137
  slug: z.ZodOptional<z.ZodArray<z.ZodString>>;
137
138
  stage: z.ZodOptional<z.ZodArray<z.ZodString>>;
package/dist/entity/list-filter.js CHANGED
@@ -61,6 +61,8 @@ const EntityListFilterSchemaDefinition = z.strictObject({
61
61
  portfolioHeadquartersState: z.array(z.string()).optional(),
62
62
  /** Named server-owned list quality gate. */
63
63
  qualityGate: EntityListQualityGateSchema.optional(),
64
+ /** Rank most prominent first (funding, stage, headcount, momentum, recent news, investor breadth), ahead of sort: what best, top, or most promising mean. */
65
+ rankByProminence: z.boolean().nullish(),
64
66
  /** Semantic entity search phrase. Executable on POST /v1/entities/search; saved views persist it for replay. A semantic page ranks a bounded nearest-neighbor window: totalElements counts the ranked candidates reachable through continuation, not every matching entity. */
65
67
  semanticQuery: z.string().nullish(),
66
68
  /** Restrict results to entity slugs. */
package/dist/entity/natural-search.d.ts CHANGED
@@ -133,6 +133,7 @@ declare const EntityNaturalSearchSchemaDefinition: z.ZodObject<{
133
133
  COMPANY_LISTING_READY: "COMPANY_LISTING_READY";
134
134
  NONE: "NONE";
135
135
  }>>;
136
+ rankByProminence: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
136
137
  slug: z.ZodOptional<z.ZodArray<z.ZodString>>;
137
138
  stage: z.ZodOptional<z.ZodArray<z.ZodString>>;
138
139
  suppressNonOperating: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
package/dist/federated/natural-search.d.ts CHANGED
@@ -138,6 +138,7 @@ declare const FederatedNaturalSearchSchemaDefinition: z.ZodObject<{
138
138
  COMPANY_LISTING_READY: "COMPANY_LISTING_READY";
139
139
  NONE: "NONE";
140
140
  }>>;
141
+ rankByProminence: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
141
142
  slug: z.ZodOptional<z.ZodArray<z.ZodString>>;
142
143
  stage: z.ZodOptional<z.ZodArray<z.ZodString>>;
143
144
  suppressNonOperating: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
package/dist/federated/search.d.ts CHANGED
@@ -116,6 +116,7 @@ declare const FederatedSearchSchemaDefinition: z.ZodObject<{
116
116
  portfolioHeadquartersCountry?: string[] | undefined;
117
117
  portfolioHeadquartersState?: string[] | undefined;
118
118
  qualityGate?: "COMPANY_LISTING_READY" | "NONE" | undefined;
119
+ rankByProminence?: boolean | null | undefined;
119
120
  semanticQuery?: string | null | undefined;
120
121
  slug?: string[] | undefined;
121
122
  stage?: string[] | undefined;
@@ -2366,6 +2367,7 @@ declare const FederatedSearchSchemaDefinition: z.ZodObject<{
2366
2367
  portfolioHeadquartersCountry?: string[] | undefined;
2367
2368
  portfolioHeadquartersState?: string[] | undefined;
2368
2369
  qualityGate?: "COMPANY_LISTING_READY" | "NONE" | undefined;
2370
+ rankByProminence?: boolean | null | undefined;
2369
2371
  semanticQuery?: string | null | undefined;
2370
2372
  slug?: string[] | undefined;
2371
2373
  stage?: string[] | undefined;
@@ -6473,6 +6475,7 @@ declare const FederatedSearchSchemaDefinition: z.ZodObject<{
6473
6475
  portfolioHeadquartersCountry?: string[] | undefined;
6474
6476
  portfolioHeadquartersState?: string[] | undefined;
6475
6477
  qualityGate?: "COMPANY_LISTING_READY" | "NONE" | undefined;
6478
+ rankByProminence?: boolean | null | undefined;
6476
6479
  slug?: string[] | undefined;
6477
6480
  stage?: string[] | undefined;
6478
6481
  suppressNonOperating?: boolean | null | undefined;
@@ -6830,6 +6833,7 @@ declare const FederatedSearchSchemaDefinition: z.ZodObject<{
6830
6833
  portfolioHeadquartersCountry?: string[] | undefined;
6831
6834
  portfolioHeadquartersState?: string[] | undefined;
6832
6835
  qualityGate?: "COMPANY_LISTING_READY" | "NONE" | undefined;
6836
+ rankByProminence?: boolean | null | undefined;
6833
6837
  slug?: string[] | undefined;
6834
6838
  stage?: string[] | undefined;
6835
6839
  suppressNonOperating?: boolean | null | undefined;
package/dist/link/search.d.ts CHANGED
@@ -118,6 +118,7 @@ declare const LinkSearchSchemaDefinition: z.ZodObject<{
118
118
  portfolioHeadquartersCountry?: string[] | undefined;
119
119
  portfolioHeadquartersState?: string[] | undefined;
120
120
  qualityGate?: "COMPANY_LISTING_READY" | "NONE" | undefined;
121
+ rankByProminence?: boolean | null | undefined;
121
122
  semanticQuery?: string | null | undefined;
122
123
  slug?: string[] | undefined;
123
124
  stage?: string[] | undefined;
@@ -3313,6 +3314,7 @@ declare const LinkSearchSchemaDefinition: z.ZodObject<{
3313
3314
  portfolioHeadquartersCountry?: string[] | undefined;
3314
3315
  portfolioHeadquartersState?: string[] | undefined;
3315
3316
  qualityGate?: "COMPANY_LISTING_READY" | "NONE" | undefined;
3317
+ rankByProminence?: boolean | null | undefined;
3316
3318
  slug?: string[] | undefined;
3317
3319
  stage?: string[] | undefined;
3318
3320
  suppressNonOperating?: boolean | null | undefined;
@@ -4028,6 +4030,7 @@ declare const LinkSearchSchemaDefinition: z.ZodObject<{
4028
4030
  portfolioHeadquartersCountry?: string[] | undefined;
4029
4031
  portfolioHeadquartersState?: string[] | undefined;
4030
4032
  qualityGate?: "COMPANY_LISTING_READY" | "NONE" | undefined;
4033
+ rankByProminence?: boolean | null | undefined;
4031
4034
  semanticQuery?: string | null | undefined;
4032
4035
  slug?: string[] | undefined;
4033
4036
  stage?: string[] | undefined;
@@ -7223,6 +7226,7 @@ declare const LinkSearchSchemaDefinition: z.ZodObject<{
7223
7226
  portfolioHeadquartersCountry?: string[] | undefined;
7224
7227
  portfolioHeadquartersState?: string[] | undefined;
7225
7228
  qualityGate?: "COMPANY_LISTING_READY" | "NONE" | undefined;
7229
+ rankByProminence?: boolean | null | undefined;
7226
7230
  slug?: string[] | undefined;
7227
7231
  stage?: string[] | undefined;
7228
7232
  suppressNonOperating?: boolean | null | undefined;
package/dist/natural/search-result.d.ts CHANGED
@@ -131,6 +131,7 @@ declare const NaturalSearchResultSchemaDefinition: z.ZodObject<{
131
131
  portfolioHeadquartersCountry?: string[] | undefined;
132
132
  portfolioHeadquartersState?: string[] | undefined;
133
133
  qualityGate?: "COMPANY_LISTING_READY" | "NONE" | undefined;
134
+ rankByProminence?: boolean | null | undefined;
134
135
  semanticQuery?: string | null | undefined;
135
136
  slug?: string[] | undefined;
136
137
  stage?: string[] | undefined;
@@ -258,6 +259,7 @@ declare const NaturalSearchResultSchemaDefinition: z.ZodObject<{
258
259
  portfolioHeadquartersCountry?: string[] | undefined;
259
260
  portfolioHeadquartersState?: string[] | undefined;
260
261
  qualityGate?: "COMPANY_LISTING_READY" | "NONE" | undefined;
262
+ rankByProminence?: boolean | null | undefined;
261
263
  semanticQuery?: string | null | undefined;
262
264
  slug?: string[] | undefined;
263
265
  stage?: string[] | undefined;
package/dist/person/filter.d.ts CHANGED
@@ -188,6 +188,7 @@ export declare const PersonFilterSchema: z.ZodObject<{
188
188
  COMPANY_LISTING_READY: "COMPANY_LISTING_READY";
189
189
  NONE: "NONE";
190
190
  }>>;
191
+ rankByProminence: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
191
192
  slug: z.ZodOptional<z.ZodArray<z.ZodString>>;
192
193
  stage: z.ZodOptional<z.ZodArray<z.ZodString>>;
193
194
  suppressNonOperating: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
package/dist/person/natural-search-result.d.ts CHANGED
@@ -113,6 +113,7 @@ declare const PersonNaturalSearchResultSchemaDefinition: z.ZodObject<{
113
113
  portfolioHeadquartersCountry?: string[] | undefined;
114
114
  portfolioHeadquartersState?: string[] | undefined;
115
115
  qualityGate?: "COMPANY_LISTING_READY" | "NONE" | undefined;
116
+ rankByProminence?: boolean | null | undefined;
116
117
  slug?: string[] | undefined;
117
118
  stage?: string[] | undefined;
118
119
  suppressNonOperating?: boolean | null | undefined;
@@ -294,6 +295,7 @@ declare const PersonNaturalSearchResultSchemaDefinition: z.ZodObject<{
294
295
  portfolioHeadquartersCountry?: string[] | undefined;
295
296
  portfolioHeadquartersState?: string[] | undefined;
296
297
  qualityGate?: "COMPANY_LISTING_READY" | "NONE" | undefined;
298
+ rankByProminence?: boolean | null | undefined;
297
299
  slug?: string[] | undefined;
298
300
  stage?: string[] | undefined;
299
301
  suppressNonOperating?: boolean | null | undefined;
package/dist/person/natural-search.d.ts CHANGED
@@ -172,6 +172,7 @@ declare const PersonNaturalSearchSchemaDefinition: z.ZodObject<{
172
172
  COMPANY_LISTING_READY: "COMPANY_LISTING_READY";
173
173
  NONE: "NONE";
174
174
  }>>;
175
+ rankByProminence: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
175
176
  slug: z.ZodOptional<z.ZodArray<z.ZodString>>;
176
177
  stage: z.ZodOptional<z.ZodArray<z.ZodString>>;
177
178
  suppressNonOperating: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
package/dist/person/search-interpretation.d.ts CHANGED
@@ -185,6 +185,7 @@ declare const PersonSearchInterpretationSchemaDefinition: z.ZodObject<{
185
185
  COMPANY_LISTING_READY: "COMPANY_LISTING_READY";
186
186
  NONE: "NONE";
187
187
  }>>;
188
+ rankByProminence: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
188
189
  slug: z.ZodOptional<z.ZodArray<z.ZodString>>;
189
190
  stage: z.ZodOptional<z.ZodArray<z.ZodString>>;
190
191
  suppressNonOperating: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
package/dist/search/interpretation.d.ts CHANGED
@@ -99,6 +99,7 @@ declare const SearchInterpretationSchemaDefinition: z.ZodObject<{
99
99
  portfolioHeadquartersCountry?: string[] | undefined;
100
100
  portfolioHeadquartersState?: string[] | undefined;
101
101
  qualityGate?: "COMPANY_LISTING_READY" | "NONE" | undefined;
102
+ rankByProminence?: boolean | null | undefined;
102
103
  semanticQuery?: string | null | undefined;
103
104
  slug?: string[] | undefined;
104
105
  stage?: string[] | undefined;
@@ -206,6 +207,7 @@ declare const SearchInterpretationSchemaDefinition: z.ZodObject<{
206
207
  portfolioHeadquartersCountry?: string[] | undefined;
207
208
  portfolioHeadquartersState?: string[] | undefined;
208
209
  qualityGate?: "COMPANY_LISTING_READY" | "NONE" | undefined;
210
+ rankByProminence?: boolean | null | undefined;
209
211
  semanticQuery?: string | null | undefined;
210
212
  slug?: string[] | undefined;
211
213
  stage?: string[] | undefined;
package/dist/search/search.d.ts CHANGED
@@ -3,6 +3,7 @@ declare const SearchSchemaDefinition: z.ZodObject<{
3
3
  allowSuspectedShellStrip: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
4
4
  bypassCache: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
5
5
  cacheKey: z.ZodOptional<z.ZodNullable<z.ZodString>>;
6
+ deep: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
6
7
  language: z.ZodOptional<z.ZodNullable<z.ZodString>>;
7
8
  region: z.ZodOptional<z.ZodNullable<z.ZodString>>;
8
9
  resultLimit: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
package/dist/search/search.js CHANGED
@@ -8,6 +8,8 @@ const SearchSchemaDefinition = z.object({
8
8
  bypassCache: z.boolean().default(false).optional(),
9
9
  /** Stable lookup text for cache keying when generated search text varies between runs */
10
10
  cacheKey: z.string().nullish(),
11
+ /** Run Exa's slower, broader deep search instead of the default provider: higher recall for market and provider questions, about 3-6 s per search, answered synchronously (`Prefer: respond-async` does not apply). Charged like any search. */
12
+ deep: z.boolean().default(false).optional(),
11
13
  /** Search language code */
12
14
  language: z.string().nullish(),
13
15
  /** Search region code */
package/dist/shared/search.d.ts CHANGED
@@ -128,6 +128,7 @@ declare const SharedSearchSchemaDefinition: z.ZodObject<{
128
128
  portfolioHeadquartersCountry?: string[] | undefined;
129
129
  portfolioHeadquartersState?: string[] | undefined;
130
130
  qualityGate?: "COMPANY_LISTING_READY" | "NONE" | undefined;
131
+ rankByProminence?: boolean | null | undefined;
131
132
  semanticQuery?: string | null | undefined;
132
133
  slug?: string[] | undefined;
133
134
  stage?: string[] | undefined;
@@ -3323,6 +3324,7 @@ declare const SharedSearchSchemaDefinition: z.ZodObject<{
3323
3324
  portfolioHeadquartersCountry?: string[] | undefined;
3324
3325
  portfolioHeadquartersState?: string[] | undefined;
3325
3326
  qualityGate?: "COMPANY_LISTING_READY" | "NONE" | undefined;
3327
+ rankByProminence?: boolean | null | undefined;
3326
3328
  slug?: string[] | undefined;
3327
3329
  stage?: string[] | undefined;
3328
3330
  suppressNonOperating?: boolean | null | undefined;
@@ -4038,6 +4040,7 @@ declare const SharedSearchSchemaDefinition: z.ZodObject<{
4038
4040
  portfolioHeadquartersCountry?: string[] | undefined;
4039
4041
  portfolioHeadquartersState?: string[] | undefined;
4040
4042
  qualityGate?: "COMPANY_LISTING_READY" | "NONE" | undefined;
4043
+ rankByProminence?: boolean | null | undefined;
4041
4044
  semanticQuery?: string | null | undefined;
4042
4045
  slug?: string[] | undefined;
4043
4046
  stage?: string[] | undefined;
@@ -7233,6 +7236,7 @@ declare const SharedSearchSchemaDefinition: z.ZodObject<{
7233
7236
  portfolioHeadquartersCountry?: string[] | undefined;
7234
7237
  portfolioHeadquartersState?: string[] | undefined;
7235
7238
  qualityGate?: "COMPANY_LISTING_READY" | "NONE" | undefined;
7239
+ rankByProminence?: boolean | null | undefined;
7236
7240
  slug?: string[] | undefined;
7237
7241
  stage?: string[] | undefined;
7238
7242
  suppressNonOperating?: boolean | null | undefined;
package/dist/web/search.d.ts CHANGED
@@ -46,6 +46,7 @@ declare const WebSearchSchemaDefinition: z.ZodObject<{
46
46
  allowSuspectedShellStrip?: boolean | null | undefined;
47
47
  bypassCache?: boolean | undefined;
48
48
  cacheKey?: string | null | undefined;
49
+ deep?: boolean | undefined;
49
50
  language?: string | null | undefined;
50
51
  region?: string | null | undefined;
51
52
  resultLimit?: number | null | undefined;
@@ -59,6 +60,7 @@ declare const WebSearchSchemaDefinition: z.ZodObject<{
59
60
  allowSuspectedShellStrip?: boolean | null | undefined;
60
61
  bypassCache?: boolean | undefined;
61
62
  cacheKey?: string | null | undefined;
63
+ deep?: boolean | undefined;
62
64
  language?: string | null | undefined;
63
65
  region?: string | null | undefined;
64
66
  resultLimit?: number | null | undefined;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aventurevc/api-schemas",
3
- "version": "0.8.101",
3
+ "version": "0.8.102",
4
4
  "private": false,
5
5
  "description": "Zod v4 schemas and TypeScript types for the aVenture API.",
6
6
  "license": "Apache-2.0",