@aventurevc/api-schemas 0.8.136 → 0.8.139

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.
@@ -180,6 +180,7 @@ declare const EntityNaturalSearchSchemaDefinition: z.ZodObject<{
180
180
  model?: string | null | undefined;
181
181
  query: string;
182
182
  reasoningEffort?: string | null | undefined;
183
+ searchCatalogRevision?: number | null | undefined;
183
184
  }, import("../natural/search.ts").NaturalSearchSchemaInput, z.core.$ZodTypeInternals<{
184
185
  answerModel?: string | null | undefined;
185
186
  cacheMode?: "bypass" | "refresh" | "use" | undefined;
@@ -187,6 +188,7 @@ declare const EntityNaturalSearchSchemaDefinition: z.ZodObject<{
187
188
  model?: string | null | undefined;
188
189
  query: string;
189
190
  reasoningEffort?: string | null | undefined;
191
+ searchCatalogRevision?: number | null | undefined;
190
192
  }, import("../natural/search.ts").NaturalSearchSchemaInput>>;
191
193
  }, z.core.$strip>;
192
194
  type EntityNaturalSearchDefinition = z.infer<typeof EntityNaturalSearchSchemaDefinition>;
@@ -199,6 +199,7 @@ declare const FederatedNaturalSearchSchemaDefinition: z.ZodObject<{
199
199
  minimal: "minimal";
200
200
  xhigh: "xhigh";
201
201
  }>, z.ZodString]>>>;
202
+ searchCatalogRevision: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
202
203
  }, z.core.$strip>;
203
204
  type FederatedNaturalSearchDefinition = z.infer<typeof FederatedNaturalSearchSchemaDefinition>;
204
205
  export interface FederatedNaturalSearchSchemaInput extends z.input<typeof FederatedNaturalSearchSchemaDefinition> {
@@ -23,6 +23,8 @@ const FederatedNaturalSearchSchemaDefinition = z.object({
23
23
  query: z.string().min(1),
24
24
  /** Optional reasoning effort for every model call this search makes: the query planner and the synthesis answer. Each call sends the nearest level its model supports, the lower one on a tie. Callers without private-data access are capped at `medium`. Null keeps the configured per-call and per-model defaults. */
25
25
  reasoningEffort: ReasoningEffortSchema.nullish(),
26
+ /** Search catalog revision this search reads its qualifier prompts and startup vocabulary from, to compare catalog edits; null reads the current revision. Callers without private-data access always read the current revision. An unknown revision returns 404. */
27
+ searchCatalogRevision: z.int().nullish(),
26
28
  });
27
29
  /**
28
30
  * Plain-English search across companies, people, and news, plus optional per-scope entity constraints and page sizes.
@@ -6866,6 +6866,17 @@ declare const FederatedSearchSchemaDefinition: z.ZodObject<{
6866
6866
  }[];
6867
6867
  unavailable: ("entity" | "news" | "person")[];
6868
6868
  }, import("./search-provenance.ts").FederatedSearchProvenanceSchemaInput>>;
6869
+ qualifier: z.ZodOptional<z.ZodNullable<z.ZodObject<{
6870
+ key: z.ZodString;
6871
+ option: z.ZodArray<z.ZodType<{
6872
+ label: string;
6873
+ query: string;
6874
+ }, import("../search/qualifier-option.ts").SearchQualifierOptionSchemaInput, z.core.$ZodTypeInternals<{
6875
+ label: string;
6876
+ query: string;
6877
+ }, import("../search/qualifier-option.ts").SearchQualifierOptionSchemaInput>>>;
6878
+ prompt: z.ZodString;
6879
+ }, z.core.$strip>>>;
6869
6880
  }, z.core.$strip>;
6870
6881
  type FederatedSearchDefinition = z.infer<typeof FederatedSearchSchemaDefinition>;
6871
6882
  export interface FederatedSearchSchemaInput extends z.input<typeof FederatedSearchSchemaDefinition> {
@@ -7,6 +7,7 @@ import { NewsEntityMentionSchema } from "../news/entity-mention.js";
7
7
  import { PageResultNewsSchema } from "../pagination/schemas.js";
8
8
  import { PersonDetailSchema } from "../person/detail.js";
9
9
  import { PersonNaturalSearchResultSchema } from "../person/natural-search-result.js";
10
+ import { SearchQualifierSchema } from "../search/qualifier.js";
10
11
  const FederatedSearchSchemaDefinition = z.object({
11
12
  /** Canonical entity natural-search result. */
12
13
  entity: NaturalSearchResultSchema,
@@ -22,6 +23,8 @@ const FederatedSearchSchemaDefinition = z.object({
22
23
  personDetail: z.array(PersonDetailSchema),
23
24
  /** Requested and executed strategy for each search scope. */
24
25
  provenance: FederatedSearchProvenanceSchema,
26
+ /** A prompt with rewritten queries offered beside a broad query's results, from the search catalog revision the search read; null when no qualifier rule matches. */
27
+ qualifier: SearchQualifierSchema.nullish(),
25
28
  });
26
29
  /**
27
30
  * Federated entity, person, and news search result composed from each domain's canonical search result owner, with the strategy used for every scope.
@@ -3454,6 +3454,14 @@ declare const LinkSearchSchemaDefinition: z.ZodObject<{
3454
3454
  }[];
3455
3455
  unavailable: ("entity" | "news" | "person")[];
3456
3456
  };
3457
+ qualifier?: {
3458
+ key: string;
3459
+ option: {
3460
+ label: string;
3461
+ query: string;
3462
+ }[];
3463
+ prompt: string;
3464
+ } | null | undefined;
3457
3465
  }, import("../federated/search.ts").FederatedSearchSchemaInput, z.core.$ZodTypeInternals<{
3458
3466
  entity: {
3459
3467
  answer?: {
@@ -6907,6 +6915,14 @@ declare const LinkSearchSchemaDefinition: z.ZodObject<{
6907
6915
  }[];
6908
6916
  unavailable: ("entity" | "news" | "person")[];
6909
6917
  };
6918
+ qualifier?: {
6919
+ key: string;
6920
+ option: {
6921
+ label: string;
6922
+ query: string;
6923
+ }[];
6924
+ prompt: string;
6925
+ } | null | undefined;
6910
6926
  }, import("../federated/search.ts").FederatedSearchSchemaInput>>;
6911
6927
  url: z.ZodString;
6912
6928
  }, z.core.$strip>;
@@ -24,6 +24,7 @@ declare const NaturalSearchSchemaDefinition: z.ZodObject<{
24
24
  minimal: "minimal";
25
25
  xhigh: "xhigh";
26
26
  }>, z.ZodString]>>>;
27
+ searchCatalogRevision: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
27
28
  }, z.core.$strip>;
28
29
  type NaturalSearchDefinition = z.infer<typeof NaturalSearchSchemaDefinition>;
29
30
  export interface NaturalSearchSchemaInput extends z.input<typeof NaturalSearchSchemaDefinition> {
@@ -16,6 +16,8 @@ const NaturalSearchSchemaDefinition = z.object({
16
16
  query: z.string().min(1),
17
17
  /** Optional reasoning effort for every model call this search makes: the query planner and the synthesis answer. Each call sends the nearest level its model supports, the lower one on a tie. Callers without private-data access are capped at `medium`. Null keeps the configured per-call and per-model defaults. */
18
18
  reasoningEffort: ReasoningEffortSchema.nullish(),
19
+ /** Search catalog revision this search reads its qualifier prompts and startup vocabulary from, to compare catalog edits; null reads the current revision. Callers without private-data access always read the current revision. An unknown revision returns 404. */
20
+ searchCatalogRevision: z.int().nullish(),
19
21
  });
20
22
  /**
21
23
  * Plain-English search request. The server plans the query into the target domain filter plus sort, then runs that domain's canonical list engine.
@@ -888,6 +888,11 @@ export const OPENAPI_COMPONENT_MANIFEST = Object.freeze({
888
888
  schemaName: "SearchOrderingPersonSortFieldSchema",
889
889
  },
890
890
  SearchPassage: { modulePath: "search/passage", schemaName: "SearchPassageSchema" },
891
+ SearchQualifier: { modulePath: "search/qualifier", schemaName: "SearchQualifierSchema" },
892
+ SearchQualifierOption: {
893
+ modulePath: "search/qualifier-option",
894
+ schemaName: "SearchQualifierOptionSchema",
895
+ },
891
896
  SearchRelevance: { modulePath: "search/relevance", schemaName: "SearchRelevanceSchema" },
892
897
  SecCompany: { modulePath: "sec/company", schemaName: "SecCompanySchema" },
893
898
  SecListingProspectus: {
@@ -271,6 +271,7 @@ declare const PersonNaturalSearchSchemaDefinition: z.ZodObject<{
271
271
  model?: string | null | undefined;
272
272
  query: string;
273
273
  reasoningEffort?: string | null | undefined;
274
+ searchCatalogRevision?: number | null | undefined;
274
275
  }, import("../natural/search.ts").NaturalSearchSchemaInput, z.core.$ZodTypeInternals<{
275
276
  answerModel?: string | null | undefined;
276
277
  cacheMode?: "bypass" | "refresh" | "use" | undefined;
@@ -278,6 +279,7 @@ declare const PersonNaturalSearchSchemaDefinition: z.ZodObject<{
278
279
  model?: string | null | undefined;
279
280
  query: string;
280
281
  reasoningEffort?: string | null | undefined;
282
+ searchCatalogRevision?: number | null | undefined;
281
283
  }, import("../natural/search.ts").NaturalSearchSchemaInput>>;
282
284
  }, z.core.$strip>;
283
285
  type PersonNaturalSearchDefinition = z.infer<typeof PersonNaturalSearchSchemaDefinition>;
@@ -1,6 +1,7 @@
1
1
  import { z } from "zod/v4";
2
2
  declare const ResearchSnippetTypeSchemaDefinition: z.ZodObject<{
3
3
  analysisRenderable: z.ZodBoolean;
4
+ analysisSectionLabel: z.ZodOptional<z.ZodArray<z.ZodString>>;
4
5
  curated: z.ZodBoolean;
5
6
  defaultVisible: z.ZodBoolean;
6
7
  label: z.ZodString;
@@ -4,6 +4,8 @@ import { ResearchParagraphShapeSchema } from "./paragraph-shape.js";
4
4
  const ResearchSnippetTypeSchemaDefinition = z.object({
5
5
  /** Whether curated rows of this snippet type can make the public company Analysis page eligible. */
6
6
  analysisRenderable: z.boolean(),
7
+ /** Ordered headings for the fixed paragraphs of a framework analysis. Empty means ordinary prose; preserve legacy prose when its paragraph count differs. */
8
+ analysisSectionLabel: z.array(z.string()).optional(),
7
9
  /** Whether the type is curated; with analysisRenderable this gates public Analysis-page eligibility. It does not gate snippet display — every type listed here is recognized and defaults to visible, and the row-level visible flag controls display. */
8
10
  curated: z.boolean(),
9
11
  /** Default visible flag when a write omits visible; true for recognized snippet types even when curated=false. */
@@ -0,0 +1,26 @@
1
+ import { z } from "zod/v4";
2
+ declare const SearchQualifierOptionSchemaDefinition: z.ZodObject<{
3
+ label: z.ZodString;
4
+ query: z.ZodString;
5
+ }, z.core.$strip>;
6
+ type SearchQualifierOptionDefinition = z.infer<typeof SearchQualifierOptionSchemaDefinition>;
7
+ export interface SearchQualifierOptionSchemaInput extends z.input<typeof SearchQualifierOptionSchemaDefinition> {
8
+ }
9
+ /**
10
+ * One rewritten query a qualifier offers.
11
+ *
12
+ * @openapiSchema SearchQualifierOption
13
+ * @endpoint GET /v1/search/link
14
+ * @endpoint GET /v1/search/link/jobs/{jobId}
15
+ * @endpoint GET /v1/search/shared/{id}
16
+ * @endpoint GET /v1/search/shared/slug/{slug}
17
+ * @endpoint POST /v1/search
18
+ * @endpoint POST /v1/search/shared
19
+ * @usedBySchema SearchQualifierSchema
20
+ * @contractShape search.qualifier-option
21
+ * @contractRole canonical
22
+ */
23
+ export declare const SearchQualifierOptionSchema: z.ZodType<SearchQualifierOptionDefinition, SearchQualifierOptionSchemaInput>;
24
+ export type SearchQualifierOption = z.infer<typeof SearchQualifierOptionSchema>;
25
+ export {};
26
+ //# sourceMappingURL=qualifier-option.d.ts.map
@@ -0,0 +1,24 @@
1
+ // LLM AGENTS MAY NOT EDIT THIS FILE UNDER ANY CIRCUMSTANCES. DO NOT EDIT - generated from Kotlin data classes via OpenAPI. Edit the backend owner and run: make docs-openapi && make docs-zod
2
+ import { z } from "zod/v4";
3
+ const SearchQualifierOptionSchemaDefinition = z.object({
4
+ /** Option label. */
5
+ label: z.string(),
6
+ /** Search query the option runs. */
7
+ query: z.string(),
8
+ });
9
+ /**
10
+ * One rewritten query a qualifier offers.
11
+ *
12
+ * @openapiSchema SearchQualifierOption
13
+ * @endpoint GET /v1/search/link
14
+ * @endpoint GET /v1/search/link/jobs/{jobId}
15
+ * @endpoint GET /v1/search/shared/{id}
16
+ * @endpoint GET /v1/search/shared/slug/{slug}
17
+ * @endpoint POST /v1/search
18
+ * @endpoint POST /v1/search/shared
19
+ * @usedBySchema SearchQualifierSchema
20
+ * @contractShape search.qualifier-option
21
+ * @contractRole canonical
22
+ */
23
+ export const SearchQualifierOptionSchema = SearchQualifierOptionSchemaDefinition;
24
+ //# sourceMappingURL=qualifier-option.js.map
@@ -0,0 +1,28 @@
1
+ import { z } from "zod/v4";
2
+ /**
3
+ * A prompt offered beside a broad query's results, with rewritten queries that narrow or widen it.
4
+ *
5
+ * @openapiSchema SearchQualifier
6
+ * @endpoint GET /v1/search/link
7
+ * @endpoint GET /v1/search/link/jobs/{jobId}
8
+ * @endpoint GET /v1/search/shared/{id}
9
+ * @endpoint GET /v1/search/shared/slug/{slug}
10
+ * @endpoint POST /v1/search
11
+ * @endpoint POST /v1/search/shared
12
+ * @usedBySchema FederatedSearchSchema
13
+ * @contractShape search.qualifier
14
+ * @contractRole canonical
15
+ */
16
+ export declare const SearchQualifierSchema: z.ZodObject<{
17
+ key: z.ZodString;
18
+ option: z.ZodArray<z.ZodType<{
19
+ label: string;
20
+ query: string;
21
+ }, import("./qualifier-option.ts").SearchQualifierOptionSchemaInput, z.core.$ZodTypeInternals<{
22
+ label: string;
23
+ query: string;
24
+ }, import("./qualifier-option.ts").SearchQualifierOptionSchemaInput>>>;
25
+ prompt: z.ZodString;
26
+ }, z.core.$strip>;
27
+ export type SearchQualifier = z.infer<typeof SearchQualifierSchema>;
28
+ //# sourceMappingURL=qualifier.d.ts.map
@@ -0,0 +1,26 @@
1
+ // LLM AGENTS MAY NOT EDIT THIS FILE UNDER ANY CIRCUMSTANCES. DO NOT EDIT - generated from Kotlin data classes via OpenAPI. Edit the backend owner and run: make docs-openapi && make docs-zod
2
+ import { z } from "zod/v4";
3
+ import { SearchQualifierOptionSchema } from "./qualifier-option.js";
4
+ /**
5
+ * A prompt offered beside a broad query's results, with rewritten queries that narrow or widen it.
6
+ *
7
+ * @openapiSchema SearchQualifier
8
+ * @endpoint GET /v1/search/link
9
+ * @endpoint GET /v1/search/link/jobs/{jobId}
10
+ * @endpoint GET /v1/search/shared/{id}
11
+ * @endpoint GET /v1/search/shared/slug/{slug}
12
+ * @endpoint POST /v1/search
13
+ * @endpoint POST /v1/search/shared
14
+ * @usedBySchema FederatedSearchSchema
15
+ * @contractShape search.qualifier
16
+ * @contractRole canonical
17
+ */
18
+ export const SearchQualifierSchema = z.object({
19
+ /** Stable qualifier key. */
20
+ key: z.string(),
21
+ /** Rewritten queries the reader can run instead, in display order. */
22
+ option: z.array(SearchQualifierOptionSchema),
23
+ /** Text shown above the options. */
24
+ prompt: z.string(),
25
+ });
26
+ //# sourceMappingURL=qualifier.js.map
@@ -3465,6 +3465,14 @@ declare const SharedSearchSchemaDefinition: z.ZodObject<{
3465
3465
  }[];
3466
3466
  unavailable: ("entity" | "news" | "person")[];
3467
3467
  };
3468
+ qualifier?: {
3469
+ key: string;
3470
+ option: {
3471
+ label: string;
3472
+ query: string;
3473
+ }[];
3474
+ prompt: string;
3475
+ } | null | undefined;
3468
3476
  }, import("../federated/search.ts").FederatedSearchSchemaInput, z.core.$ZodTypeInternals<{
3469
3477
  entity: {
3470
3478
  answer?: {
@@ -6918,6 +6926,14 @@ declare const SharedSearchSchemaDefinition: z.ZodObject<{
6918
6926
  }[];
6919
6927
  unavailable: ("entity" | "news" | "person")[];
6920
6928
  };
6929
+ qualifier?: {
6930
+ key: string;
6931
+ option: {
6932
+ label: string;
6933
+ query: string;
6934
+ }[];
6935
+ prompt: string;
6936
+ } | null | undefined;
6921
6937
  }, import("../federated/search.ts").FederatedSearchSchemaInput>>;
6922
6938
  }, z.core.$strip>;
6923
6939
  type SharedSearchDefinition = z.infer<typeof SharedSearchSchemaDefinition>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aventurevc/api-schemas",
3
- "version": "0.8.136",
3
+ "version": "0.8.139",
4
4
  "private": false,
5
5
  "description": "Zod v4 schemas and TypeScript types for the aVenture API.",
6
6
  "license": "Apache-2.0",