@aventurevc/api-schemas 0.8.115 → 0.8.124

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 (58) hide show
  1. package/dist/address/address.js +1 -1
  2. package/dist/address/association-role.d.ts +1 -1
  3. package/dist/address/association-role.js +1 -1
  4. package/dist/agent/help.d.ts +20 -4
  5. package/dist/datasource/data-source-type.d.ts +24 -0
  6. package/dist/datasource/data-source-type.js +24 -0
  7. package/dist/entity/enrichment.js +1 -1
  8. package/dist/entity/filter-sortable.d.ts +39 -0
  9. package/dist/entity/filter-sortable.js +42 -0
  10. package/dist/entity/filter.js +2 -2
  11. package/dist/entity/list-filter.js +2 -2
  12. package/dist/entity/natural-search.d.ts +2 -0
  13. package/dist/entity/person-association.js +1 -1
  14. package/dist/federated/natural-search.d.ts +12 -12
  15. package/dist/federated/natural-search.js +14 -11
  16. package/dist/federated/search.d.ts +4 -2
  17. package/dist/harness/task-plan-step.d.ts +8 -0
  18. package/dist/harness/task-plan-step.js +3 -0
  19. package/dist/harness/task-plan.d.ts +16 -0
  20. package/dist/harness/task-write-guidance.d.ts +21 -0
  21. package/dist/harness/task-write-guidance.js +27 -0
  22. package/dist/help/citation.d.ts +4 -2
  23. package/dist/help/resolution.d.ts +18 -2
  24. package/dist/help/source-type.d.ts +4 -2
  25. package/dist/help/source-type.js +11 -6
  26. package/dist/http/problem-detail.d.ts +12 -0
  27. package/dist/http/problem-detail.js +5 -0
  28. package/dist/link/search.d.ts +4 -2
  29. package/dist/lookup/job-mutation.js +1 -1
  30. package/dist/natural/search-result.d.ts +3 -2
  31. package/dist/natural/search.d.ts +1 -0
  32. package/dist/natural/search.js +3 -1
  33. package/dist/openapi-component-manifest.js +15 -0
  34. package/dist/person/natural-search.d.ts +2 -0
  35. package/dist/prose/problem.d.ts +24 -0
  36. package/dist/prose/problem.js +27 -0
  37. package/dist/prose/violation.d.ts +32 -0
  38. package/dist/prose/violation.js +24 -0
  39. package/dist/reasoning/effort.d.ts +1 -0
  40. package/dist/reasoning/effort.js +1 -0
  41. package/dist/research/snippet-type.d.ts +1 -0
  42. package/dist/research/snippet-type.js +2 -0
  43. package/dist/search/answer.d.ts +1 -0
  44. package/dist/search/answer.js +3 -1
  45. package/dist/search/cache-mode.d.ts +1 -0
  46. package/dist/search/cache-mode.js +1 -0
  47. package/dist/search/interpretation.d.ts +2 -2
  48. package/dist/search/layer.d.ts +2 -0
  49. package/dist/search/layer.js +2 -0
  50. package/dist/search/ordering-entity-filter-sortable.d.ts +2 -2
  51. package/dist/shared/search-mutation.d.ts +208 -0
  52. package/dist/shared/search-mutation.js +8 -0
  53. package/dist/shared/search.d.ts +4 -2
  54. package/dist/sort/order-entity-filter-sortable.d.ts +4 -2
  55. package/dist/sort/order-entity-filter-sortable.js +2 -19
  56. package/dist/suppression/reason.d.ts +17 -0
  57. package/dist/suppression/reason.js +16 -0
  58. package/package.json +1 -1
@@ -61,7 +61,7 @@ export const AddressSchema = z.object({
61
61
  createdAt: z.iso.datetime({ offset: true }).nullish(),
62
62
  /** Single-line formatted address */
63
63
  fullAddress: z.string().nullish(),
64
- /** Address record identifier */
64
+ /** Id of this listed row's first association; PATCH and DELETE address one association by its association[].id, so a row holding several roles needs one call each */
65
65
  id: z.int().nullish(),
66
66
  /** Deprecated aggregate compatibility flag; true when any association is current */
67
67
  isCurrent: z.boolean().nullish(),
@@ -1,6 +1,6 @@
1
1
  import { z } from "zod/v4";
2
2
  /**
3
- * Meaning of an entity or person address association. Domicile is a legal or registered seat and is not evidence of operational presence; dominant is the predominant display location; origin is the founding or historical location.
3
+ * Meaning of an entity or person address association. Dominant is the operating headquarters; domicile is the legal or registered seat and is not evidence of operational presence; origin is the founding or historical location.
4
4
  *
5
5
  * @openapiSchema AddressAssociationRole
6
6
  * @endpoint GET /v1/entities
@@ -1,7 +1,7 @@
1
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
2
  import { z } from "zod/v4";
3
3
  /**
4
- * Meaning of an entity or person address association. Domicile is a legal or registered seat and is not evidence of operational presence; dominant is the predominant display location; origin is the founding or historical location.
4
+ * Meaning of an entity or person address association. Dominant is the operating headquarters; domicile is the legal or registered seat and is not evidence of operational presence; origin is the founding or historical location.
5
5
  *
6
6
  * @openapiSchema AddressAssociationRole
7
7
  * @endpoint GET /v1/entities
@@ -4,12 +4,12 @@ declare const AgentHelpSchemaDefinition: z.ZodObject<{
4
4
  citation: z.ZodArray<z.ZodType<{
5
5
  excerpt: string;
6
6
  sourceId: string;
7
- sourceType: "COMPLETION_GATE" | "OPERATION" | "PROMPT" | "RESEARCH_DETAIL_TYPE" | "SKILL";
7
+ sourceType: string;
8
8
  sourceVersion?: string | null | undefined;
9
9
  }, unknown, z.core.$ZodTypeInternals<{
10
10
  excerpt: string;
11
11
  sourceId: string;
12
- sourceType: "COMPLETION_GATE" | "OPERATION" | "PROMPT" | "RESEARCH_DETAIL_TYPE" | "SKILL";
12
+ sourceType: string;
13
13
  sourceVersion?: string | null | undefined;
14
14
  }, unknown>>>;
15
15
  confidence: z.ZodEnum<{
@@ -21,12 +21,12 @@ declare const AgentHelpSchemaDefinition: z.ZodObject<{
21
21
  candidate: z.ZodArray<z.ZodType<{
22
22
  excerpt: string;
23
23
  sourceId: string;
24
- sourceType: "COMPLETION_GATE" | "OPERATION" | "PROMPT" | "RESEARCH_DETAIL_TYPE" | "SKILL";
24
+ sourceType: string;
25
25
  sourceVersion?: string | null | undefined;
26
26
  }, unknown, z.core.$ZodTypeInternals<{
27
27
  excerpt: string;
28
28
  sourceId: string;
29
- sourceType: "COMPLETION_GATE" | "OPERATION" | "PROMPT" | "RESEARCH_DETAIL_TYPE" | "SKILL";
29
+ sourceType: string;
30
30
  sourceVersion?: string | null | undefined;
31
31
  }, unknown>>>;
32
32
  operationId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -58,6 +58,14 @@ declare const AgentHelpSchemaDefinition: z.ZodObject<{
58
58
  operationId: string;
59
59
  stepKey: string;
60
60
  };
61
+ writeGuidance?: {
62
+ body: string;
63
+ expectation: string;
64
+ method: string[];
65
+ override: string;
66
+ reject: string[];
67
+ typeCatalog: string;
68
+ } | null | undefined;
61
69
  }, unknown, z.core.$ZodTypeInternals<{
62
70
  cliCommand: string;
63
71
  mcpTool?: string | null | undefined;
@@ -66,6 +74,14 @@ declare const AgentHelpSchemaDefinition: z.ZodObject<{
66
74
  operationId: string;
67
75
  stepKey: string;
68
76
  };
77
+ writeGuidance?: {
78
+ body: string;
79
+ expectation: string;
80
+ method: string[];
81
+ override: string;
82
+ reject: string[];
83
+ typeCatalog: string;
84
+ } | null | undefined;
69
85
  }, unknown>>>;
70
86
  taskKey: z.ZodString;
71
87
  }, z.core.$strip>>>;
@@ -0,0 +1,24 @@
1
+ import { z } from "zod/v4";
2
+ /**
3
+ * Full read/storage source type for field-level provenance rows. Write query parameters use DatasourceWritableDataSourceType.
4
+ *
5
+ * @openapiSchema DatasourceDataSourceType
6
+ * @endpoint GET /v1/entities
7
+ * @contractShape datasource.data-source-type
8
+ * @contractRole canonical
9
+ */
10
+ export declare const DatasourceDataSourceTypeSchema: z.ZodEnum<{
11
+ api: "api";
12
+ aventureStaff: "aventureStaff";
13
+ blogArticle: "blogArticle";
14
+ firstPartyWebsite: "firstPartyWebsite";
15
+ import: "import";
16
+ llm: "llm";
17
+ manual: "manual";
18
+ newsArticle: "newsArticle";
19
+ relatedPartyWebsite: "relatedPartyWebsite";
20
+ requestChangeForm: "requestChangeForm";
21
+ thirdPartyWebsite: "thirdPartyWebsite";
22
+ }>;
23
+ export type DatasourceDataSourceType = z.infer<typeof DatasourceDataSourceTypeSchema>;
24
+ //# sourceMappingURL=data-source-type.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
+ /**
4
+ * Full read/storage source type for field-level provenance rows. Write query parameters use DatasourceWritableDataSourceType.
5
+ *
6
+ * @openapiSchema DatasourceDataSourceType
7
+ * @endpoint GET /v1/entities
8
+ * @contractShape datasource.data-source-type
9
+ * @contractRole canonical
10
+ */
11
+ export const DatasourceDataSourceTypeSchema = z.enum([
12
+ "requestChangeForm",
13
+ "newsArticle",
14
+ "blogArticle",
15
+ "firstPartyWebsite",
16
+ "relatedPartyWebsite",
17
+ "thirdPartyWebsite",
18
+ "llm",
19
+ "aventureStaff",
20
+ "api",
21
+ "manual",
22
+ "import",
23
+ ]);
24
+ //# sourceMappingURL=data-source-type.js.map
@@ -10,7 +10,7 @@ const EntityEnrichmentSchemaDefinition = z.object({
10
10
  /** Entity classification join projection for this read surface. Single-detail and full-detail batch reads include full history; list, default batch, and similar-entity reads may filter to current joins. Use GET /v1/entities/{entityId}/classifications?includeInactive=true for authoritative join history. */
11
11
  classification: EntityClassificationSchema,
12
12
  fundingDetail: EntityFundingDetailSchema.nullish(),
13
- /** Address id of the current headquarters: the current dominant (operating) address, else the current domicile (legal seat); absent when neither is on record. Read this instead of the deprecated isHq flag, which marks the legal seat. */
13
+ /** Address id of the current headquarters: the current dominant (operating) address; absent when none is on record, even when a domicile (legal seat) exists. Read this instead of the deprecated isHq flag, which marks the legal seat. */
14
14
  headquartersAddressId: z.int().nullish(),
15
15
  text: EntityTextBundleSchema,
16
16
  /** URL link filter values */
@@ -0,0 +1,39 @@
1
+ import { z } from "zod/v4";
2
+ /**
3
+ * Entity filter sortable
4
+ *
5
+ * @openapiSchema EntityFilterSortable
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/natural/entities
12
+ * @endpoint POST /v1/search/shared
13
+ * @usedBySchema SortOrderEntityFilterSortableSchema
14
+ * @contractShape entity.filter-sortable
15
+ * @contractRole canonical
16
+ */
17
+ export declare const EntityFilterSortableSchema: z.ZodUnion<readonly [z.ZodEnum<{
18
+ ACCELERATOR_BRAND: "ACCELERATOR_BRAND";
19
+ ACCELERATOR_COHORT: "ACCELERATOR_COHORT";
20
+ AMOUNT_INVESTED: "AMOUNT_INVESTED";
21
+ CREATED_AT: "CREATED_AT";
22
+ DATA_COMPLETION_COVERAGE: "DATA_COMPLETION_COVERAGE";
23
+ EMPLOYEE_COUNT: "EMPLOYEE_COUNT";
24
+ HEADQUARTERS_COUNTRY: "HEADQUARTERS_COUNTRY";
25
+ ID: "ID";
26
+ LATEST_VALUATION: "LATEST_VALUATION";
27
+ MOST_RECENT_AMOUNT: "MOST_RECENT_AMOUNT";
28
+ MOST_RECENT_DATE: "MOST_RECENT_DATE";
29
+ NAME_BRAND: "NAME_BRAND";
30
+ NEXT_DUE_AT: "NEXT_DUE_AT";
31
+ RECENT_INVESTMENT_AT: "RECENT_INVESTMENT_AT";
32
+ STAGE: "STAGE";
33
+ STATUS_OPERATING: "STATUS_OPERATING";
34
+ TOTAL_RAISED: "TOTAL_RAISED";
35
+ UPDATED_AT: "UPDATED_AT";
36
+ YEAR_FOUNDED: "YEAR_FOUNDED";
37
+ }>, z.ZodString]>;
38
+ export type EntityFilterSortable = z.infer<typeof EntityFilterSortableSchema>;
39
+ //# sourceMappingURL=filter-sortable.d.ts.map
@@ -0,0 +1,42 @@
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
+ /**
4
+ * Entity filter sortable
5
+ *
6
+ * @openapiSchema EntityFilterSortable
7
+ * @endpoint GET /v1/search/link
8
+ * @endpoint GET /v1/search/link/jobs/{jobId}
9
+ * @endpoint GET /v1/search/shared/{id}
10
+ * @endpoint GET /v1/search/shared/slug/{slug}
11
+ * @endpoint POST /v1/search
12
+ * @endpoint POST /v1/search/natural/entities
13
+ * @endpoint POST /v1/search/shared
14
+ * @usedBySchema SortOrderEntityFilterSortableSchema
15
+ * @contractShape entity.filter-sortable
16
+ * @contractRole canonical
17
+ */
18
+ export const EntityFilterSortableSchema = z.union([
19
+ z.enum([
20
+ "ID",
21
+ "NAME_BRAND",
22
+ "YEAR_FOUNDED",
23
+ "STATUS_OPERATING",
24
+ "UPDATED_AT",
25
+ "CREATED_AT",
26
+ "NEXT_DUE_AT",
27
+ "DATA_COMPLETION_COVERAGE",
28
+ "TOTAL_RAISED",
29
+ "AMOUNT_INVESTED",
30
+ "RECENT_INVESTMENT_AT",
31
+ "STAGE",
32
+ "MOST_RECENT_AMOUNT",
33
+ "LATEST_VALUATION",
34
+ "MOST_RECENT_DATE",
35
+ "ACCELERATOR_BRAND",
36
+ "ACCELERATOR_COHORT",
37
+ "HEADQUARTERS_COUNTRY",
38
+ "EMPLOYEE_COUNT",
39
+ ]),
40
+ z.string(),
41
+ ]);
42
+ //# sourceMappingURL=filter-sortable.js.map
@@ -83,7 +83,7 @@ export const EntityFilterSchema = z.strictObject({
83
83
  portfolioHeadquartersCountry: z.array(z.string()).optional(),
84
84
  /** Portfolio-company headquarters state or region values. */
85
85
  portfolioHeadquartersState: z.array(z.string()).optional(),
86
- /** Named server-owned list quality gate. */
86
+ /** Server-owned list quality gate. */
87
87
  qualityGate: EntityListQualityGateSchema.optional(),
88
88
  /** Rank most prominent first (funding, stage, headcount, momentum, recent news, investor breadth), ahead of sort: what best, top, or most promising mean. */
89
89
  rankByProminence: z.boolean().nullish(),
@@ -100,7 +100,7 @@ export const EntityFilterSchema = z.strictObject({
100
100
  suppressLateStage: z.boolean().nullish(),
101
101
  /** Suppress entities with terminal operating status. */
102
102
  suppressNonOperating: z.boolean().nullish(),
103
- /** Suppress entities whose USD-converted total raised is zero or unknown. */
103
+ /** Suppress entities with zero or unknown USD total raised. */
104
104
  suppressZeroTotalRaised: z.boolean().nullish(),
105
105
  /** General classification tag values. */
106
106
  tag: z.array(z.string()).optional(),
@@ -61,7 +61,7 @@ const EntityListFilterSchemaDefinition = z.strictObject({
61
61
  portfolioHeadquartersCountry: z.array(z.string()).optional(),
62
62
  /** Portfolio-company headquarters state or region values. */
63
63
  portfolioHeadquartersState: z.array(z.string()).optional(),
64
- /** Named server-owned list quality gate. */
64
+ /** Server-owned list quality gate. */
65
65
  qualityGate: EntityListQualityGateSchema.optional(),
66
66
  /** Rank most prominent first (funding, stage, headcount, momentum, recent news, investor breadth), ahead of sort: what best, top, or most promising mean. */
67
67
  rankByProminence: z.boolean().nullish(),
@@ -80,7 +80,7 @@ const EntityListFilterSchemaDefinition = z.strictObject({
80
80
  suppressLateStage: z.boolean().nullish(),
81
81
  /** Suppress entities with terminal operating status. */
82
82
  suppressNonOperating: z.boolean().nullish(),
83
- /** Suppress entities whose USD-converted total raised is zero or unknown. */
83
+ /** Suppress entities with zero or unknown USD total raised. */
84
84
  suppressZeroTotalRaised: z.boolean().nullish(),
85
85
  /** General classification tag values. */
86
86
  tag: z.array(z.string()).optional(),
@@ -174,12 +174,14 @@ declare const EntityNaturalSearchSchemaDefinition: z.ZodObject<{
174
174
  }, unknown>>>>;
175
175
  }, z.core.$strict>>;
176
176
  search: z.ZodType<{
177
+ answerModel?: string | null | undefined;
177
178
  cacheMode?: "bypass" | "refresh" | "use" | undefined;
178
179
  mode?: string | undefined;
179
180
  model?: string | null | undefined;
180
181
  query: string;
181
182
  reasoningEffort?: string | null | undefined;
182
183
  }, unknown, z.core.$ZodTypeInternals<{
184
+ answerModel?: string | null | undefined;
183
185
  cacheMode?: "bypass" | "refresh" | "use" | undefined;
184
186
  mode?: string | undefined;
185
187
  model?: string | null | undefined;
@@ -44,7 +44,7 @@ export const EntityPersonAssociationSchema = z.object({
44
44
  .string()
45
45
  .regex(/^(?!0000)[0-9]{4}(?:-(?:0[1-9]|1[0-2])(?:-(?:0[1-9]|[12][0-9]|3[01])(?:T(?:[01][0-9]|2[0-3]):[0-5][0-9](?::[0-5][0-9](?:\.[0-9]{1,9})?)?(?:Z|[+-][0-9]{2}:[0-5][0-9]))?)?)?$/)
46
46
  .nullish(),
47
- /** Entity addresses carried on the association projection */
47
+ /** Entity addresses carried on the association projection. Person detail carries at most one: the entity's current headquarters, else its most recently updated current address; GET /v1/entities/{entityId}/addresses lists them all */
48
48
  entityAddress: z.array(AddressSchema),
49
49
  /** Associated entity id */
50
50
  entityId: z.uuid(),
@@ -1,5 +1,16 @@
1
1
  import { z } from "zod/v4";
2
- declare const FederatedNaturalSearchSchemaDefinition: z.ZodObject<{
2
+ /**
3
+ * Plain-English search across companies, people, and news, plus optional per-scope entity constraints and page sizes.
4
+ *
5
+ * @openapiSchema FederatedNaturalSearch
6
+ * @endpoint POST /v1/search
7
+ * @endpoint POST /v1/search/shared
8
+ * @usedBySchema SharedSearchMutationSchema
9
+ * @contractShape federated.natural-search
10
+ * @contractRole canonical
11
+ */
12
+ export declare const FederatedNaturalSearchSchema: z.ZodObject<{
13
+ answerModel: z.ZodOptional<z.ZodNullable<z.ZodString>>;
3
14
  cacheMode: z.ZodOptional<z.ZodDefault<z.ZodEnum<{
4
15
  bypass: "bypass";
5
16
  refresh: "refresh";
@@ -199,16 +210,5 @@ declare const FederatedNaturalSearchSchemaDefinition: z.ZodObject<{
199
210
  xhigh: "xhigh";
200
211
  }>, z.ZodString]>>>;
201
212
  }, z.core.$strip>;
202
- type FederatedNaturalSearchDefinition = z.infer<typeof FederatedNaturalSearchSchemaDefinition>;
203
- /**
204
- * Plain-English search across companies, people, and news, plus optional per-scope entity constraints and page sizes.
205
- *
206
- * @openapiSchema FederatedNaturalSearch
207
- * @endpoint POST /v1/search
208
- * @contractShape federated.natural-search
209
- * @contractRole canonical
210
- */
211
- export declare const FederatedNaturalSearchSchema: z.ZodType<FederatedNaturalSearchDefinition>;
212
213
  export type FederatedNaturalSearch = z.infer<typeof FederatedNaturalSearchSchema>;
213
- export {};
214
214
  //# sourceMappingURL=natural-search.d.ts.map
@@ -4,8 +4,20 @@ import { EntityFilterSchema } from "../entity/filter.js";
4
4
  import { ReasoningEffortSchema } from "../reasoning/effort.js";
5
5
  import { SearchCacheModeSchema } from "../search/cache-mode.js";
6
6
  import { SearchModeSchema } from "../search/mode.js";
7
- const FederatedNaturalSearchSchemaDefinition = z.object({
8
- /** Search-stage cache policy. use reuses cached search work; bypass computes fresh without retaining outputs; refresh computes fresh and replaces normal entries. Record and immutable query-vector caches retain their own policy. */
7
+ /**
8
+ * Plain-English search across companies, people, and news, plus optional per-scope entity constraints and page sizes.
9
+ *
10
+ * @openapiSchema FederatedNaturalSearch
11
+ * @endpoint POST /v1/search
12
+ * @endpoint POST /v1/search/shared
13
+ * @usedBySchema SharedSearchMutationSchema
14
+ * @contractShape federated.natural-search
15
+ * @contractRole canonical
16
+ */
17
+ export const FederatedNaturalSearchSchema = z.object({
18
+ /** Optional chat model for the synthesis answer; null uses the catalog's search answer model. The same allowlist as `model` applies. The answer writes the page heading, title, and description, so this compares answer models without changing the catalog. */
19
+ answerModel: z.string().nullish(),
20
+ /** Search-stage cache policy. use reuses cached search work; bypass computes fresh without retaining outputs; refresh computes fresh and replaces normal entries. Record and immutable query-vector caches retain their own policy. Callers without private-data access always run use. */
9
21
  cacheMode: SearchCacheModeSchema.default("use").optional(),
10
22
  /** Explicit entity constraints for the entity scope only, as on POST /v1/search/natural/entities: caller-supplied fields override planner values. The person and news scopes ignore it. */
11
23
  entityFilter: EntityFilterSchema.optional(),
@@ -22,13 +34,4 @@ const FederatedNaturalSearchSchemaDefinition = z.object({
22
34
  /** 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. */
23
35
  reasoningEffort: ReasoningEffortSchema.nullish(),
24
36
  });
25
- /**
26
- * Plain-English search across companies, people, and news, plus optional per-scope entity constraints and page sizes.
27
- *
28
- * @openapiSchema FederatedNaturalSearch
29
- * @endpoint POST /v1/search
30
- * @contractShape federated.natural-search
31
- * @contractRole canonical
32
- */
33
- export const FederatedNaturalSearchSchema = FederatedNaturalSearchSchemaDefinition;
34
37
  //# sourceMappingURL=natural-search.js.map
@@ -9,6 +9,7 @@ declare const FederatedSearchSchemaDefinition: z.ZodObject<{
9
9
  }[];
10
10
  confidence: "HIGH" | "LOW" | "MEDIUM";
11
11
  description?: string | null | undefined;
12
+ heading?: string | null | undefined;
12
13
  paragraph: {
13
14
  citation: {
14
15
  entityId: string;
@@ -146,7 +147,7 @@ declare const FederatedSearchSchemaDefinition: z.ZodObject<{
146
147
  sort: {
147
148
  order: {
148
149
  descending: boolean;
149
- field: "ACCELERATOR_BRAND" | "ACCELERATOR_COHORT" | "AMOUNT_INVESTED" | "CREATED_AT" | "EMPLOYEE_COUNT" | "HEADQUARTERS_COUNTRY" | "ID" | "LATEST_VALUATION" | "MOST_RECENT_AMOUNT" | "MOST_RECENT_DATE" | "NAME_BRAND" | "RECENT_INVESTMENT_AT" | "STAGE" | "STATUS_OPERATING" | "TOTAL_RAISED" | "UPDATED_AT" | "YEAR_FOUNDED";
150
+ field: string;
150
151
  sortKey?: string | null | undefined;
151
152
  }[];
152
153
  relevance?: "keyword" | "semantic" | null | undefined;
@@ -1795,6 +1796,7 @@ declare const FederatedSearchSchemaDefinition: z.ZodObject<{
1795
1796
  }[];
1796
1797
  confidence: "HIGH" | "LOW" | "MEDIUM";
1797
1798
  description?: string | null | undefined;
1799
+ heading?: string | null | undefined;
1798
1800
  paragraph: {
1799
1801
  citation: {
1800
1802
  entityId: string;
@@ -1932,7 +1934,7 @@ declare const FederatedSearchSchemaDefinition: z.ZodObject<{
1932
1934
  sort: {
1933
1935
  order: {
1934
1936
  descending: boolean;
1935
- field: "ACCELERATOR_BRAND" | "ACCELERATOR_COHORT" | "AMOUNT_INVESTED" | "CREATED_AT" | "EMPLOYEE_COUNT" | "HEADQUARTERS_COUNTRY" | "ID" | "LATEST_VALUATION" | "MOST_RECENT_AMOUNT" | "MOST_RECENT_DATE" | "NAME_BRAND" | "RECENT_INVESTMENT_AT" | "STAGE" | "STATUS_OPERATING" | "TOTAL_RAISED" | "UPDATED_AT" | "YEAR_FOUNDED";
1937
+ field: string;
1936
1938
  sortKey?: string | null | undefined;
1937
1939
  }[];
1938
1940
  relevance?: "keyword" | "semantic" | null | undefined;
@@ -11,6 +11,14 @@ declare const HarnessTaskPlanStepSchemaDefinition: z.ZodObject<{
11
11
  operationId: string;
12
12
  stepKey: string;
13
13
  }, unknown>>;
14
+ writeGuidance: z.ZodOptional<z.ZodNullable<z.ZodObject<{
15
+ body: z.ZodString;
16
+ expectation: z.ZodString;
17
+ method: z.ZodArray<z.ZodString>;
18
+ override: z.ZodString;
19
+ reject: z.ZodArray<z.ZodString>;
20
+ typeCatalog: z.ZodString;
21
+ }, z.core.$strip>>>;
14
22
  }, z.core.$strip>;
15
23
  type HarnessTaskPlanStepDefinition = z.infer<typeof HarnessTaskPlanStepSchemaDefinition>;
16
24
  /**
@@ -1,6 +1,7 @@
1
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
2
  import { z } from "zod/v4";
3
3
  import { HarnessTaskStepSchema } from "./task-step.js";
4
+ import { HarnessTaskWriteGuidanceSchema } from "./task-write-guidance.js";
4
5
  const HarnessTaskPlanStepSchemaDefinition = z.object({
5
6
  /** CLI command path that runs the step's operation; the caller supplies required flags. */
6
7
  cliCommand: z.string(),
@@ -8,6 +9,8 @@ const HarnessTaskPlanStepSchemaDefinition = z.object({
8
9
  mcpTool: z.string().nullish(),
9
10
  /** The stored step. */
10
11
  step: HarnessTaskStepSchema,
12
+ /** What the server expects of the prose this step writes, derived from the operation's judged prose type when the plan is read; null when the step writes no judged prose. */
13
+ writeGuidance: HarnessTaskWriteGuidanceSchema.nullish(),
11
14
  });
12
15
  /**
13
16
  * One task step with the CLI command and MCP tool that run its operation.
@@ -29,6 +29,14 @@ export declare const HarnessTaskPlanSchema: z.ZodObject<{
29
29
  operationId: string;
30
30
  stepKey: string;
31
31
  };
32
+ writeGuidance?: {
33
+ body: string;
34
+ expectation: string;
35
+ method: string[];
36
+ override: string;
37
+ reject: string[];
38
+ typeCatalog: string;
39
+ } | null | undefined;
32
40
  }, unknown, z.core.$ZodTypeInternals<{
33
41
  cliCommand: string;
34
42
  mcpTool?: string | null | undefined;
@@ -37,6 +45,14 @@ export declare const HarnessTaskPlanSchema: z.ZodObject<{
37
45
  operationId: string;
38
46
  stepKey: string;
39
47
  };
48
+ writeGuidance?: {
49
+ body: string;
50
+ expectation: string;
51
+ method: string[];
52
+ override: string;
53
+ reject: string[];
54
+ typeCatalog: string;
55
+ } | null | undefined;
40
56
  }, unknown>>>;
41
57
  taskKey: z.ZodString;
42
58
  }, z.core.$strip>;
@@ -0,0 +1,21 @@
1
+ import { z } from "zod/v4";
2
+ /**
3
+ * The expectation, body, type hints, rejections, override, and method for one judged prose write.
4
+ *
5
+ * @openapiSchema HarnessTaskWriteGuidance
6
+ * @endpoint POST /v1/agents/help
7
+ * @endpoint POST /v1/help
8
+ * @usedBySchema HarnessTaskPlanStepSchema
9
+ * @contractShape harness.task-write-guidance
10
+ * @contractRole canonical
11
+ */
12
+ export declare const HarnessTaskWriteGuidanceSchema: z.ZodObject<{
13
+ body: z.ZodString;
14
+ expectation: z.ZodString;
15
+ method: z.ZodArray<z.ZodString>;
16
+ override: z.ZodString;
17
+ reject: z.ZodArray<z.ZodString>;
18
+ typeCatalog: z.ZodString;
19
+ }, z.core.$strip>;
20
+ export type HarnessTaskWriteGuidance = z.infer<typeof HarnessTaskWriteGuidanceSchema>;
21
+ //# sourceMappingURL=task-write-guidance.d.ts.map
@@ -0,0 +1,27 @@
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
+ /**
4
+ * The expectation, body, type hints, rejections, override, and method for one judged prose write.
5
+ *
6
+ * @openapiSchema HarnessTaskWriteGuidance
7
+ * @endpoint POST /v1/agents/help
8
+ * @endpoint POST /v1/help
9
+ * @usedBySchema HarnessTaskPlanStepSchema
10
+ * @contractShape harness.task-write-guidance
11
+ * @contractRole canonical
12
+ */
13
+ export const HarnessTaskWriteGuidanceSchema = z.object({
14
+ /** The request body keys, the key that carries the prose, and a minimal JSON example. */
15
+ body: z.string(),
16
+ /** The one sentence the prose aims for. */
17
+ expectation: z.string(),
18
+ /** Help sections that teach this prose, each with the command that retrieves it. */
19
+ method: z.array(z.string()),
20
+ /** The override field, the problems it may waive, and its terms. */
21
+ override: z.string(),
22
+ /** Each problem that rejects this prose: what fails it and the fix. */
23
+ reject: z.array(z.string()),
24
+ /** The read that serves this write's per-type hints; read it before writing. */
25
+ typeCatalog: z.string(),
26
+ });
27
+ //# sourceMappingURL=task-write-guidance.js.map
@@ -2,13 +2,15 @@ import { z } from "zod/v4";
2
2
  declare const HelpCitationSchemaDefinition: z.ZodObject<{
3
3
  excerpt: z.ZodString;
4
4
  sourceId: z.ZodString;
5
- sourceType: z.ZodEnum<{
5
+ sourceType: z.ZodUnion<readonly [z.ZodEnum<{
6
6
  COMPLETION_GATE: "COMPLETION_GATE";
7
7
  OPERATION: "OPERATION";
8
8
  PROMPT: "PROMPT";
9
9
  RESEARCH_DETAIL_TYPE: "RESEARCH_DETAIL_TYPE";
10
+ RESEARCH_SNIPPET_TYPE: "RESEARCH_SNIPPET_TYPE";
10
11
  SKILL: "SKILL";
11
- }>;
12
+ TEXT_TYPE: "TEXT_TYPE";
13
+ }>, z.ZodString]>;
12
14
  sourceVersion: z.ZodOptional<z.ZodNullable<z.ZodString>>;
13
15
  }, z.core.$strip>;
14
16
  type HelpCitationDefinition = z.infer<typeof HelpCitationSchemaDefinition>;
@@ -13,12 +13,12 @@ export declare const HelpResolutionSchema: z.ZodObject<{
13
13
  candidate: z.ZodArray<z.ZodType<{
14
14
  excerpt: string;
15
15
  sourceId: string;
16
- sourceType: "COMPLETION_GATE" | "OPERATION" | "PROMPT" | "RESEARCH_DETAIL_TYPE" | "SKILL";
16
+ sourceType: string;
17
17
  sourceVersion?: string | null | undefined;
18
18
  }, unknown, z.core.$ZodTypeInternals<{
19
19
  excerpt: string;
20
20
  sourceId: string;
21
- sourceType: "COMPLETION_GATE" | "OPERATION" | "PROMPT" | "RESEARCH_DETAIL_TYPE" | "SKILL";
21
+ sourceType: string;
22
22
  sourceVersion?: string | null | undefined;
23
23
  }, unknown>>>;
24
24
  operationId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -50,6 +50,14 @@ export declare const HelpResolutionSchema: z.ZodObject<{
50
50
  operationId: string;
51
51
  stepKey: string;
52
52
  };
53
+ writeGuidance?: {
54
+ body: string;
55
+ expectation: string;
56
+ method: string[];
57
+ override: string;
58
+ reject: string[];
59
+ typeCatalog: string;
60
+ } | null | undefined;
53
61
  }, unknown, z.core.$ZodTypeInternals<{
54
62
  cliCommand: string;
55
63
  mcpTool?: string | null | undefined;
@@ -58,6 +66,14 @@ export declare const HelpResolutionSchema: z.ZodObject<{
58
66
  operationId: string;
59
67
  stepKey: string;
60
68
  };
69
+ writeGuidance?: {
70
+ body: string;
71
+ expectation: string;
72
+ method: string[];
73
+ override: string;
74
+ reject: string[];
75
+ typeCatalog: string;
76
+ } | null | undefined;
61
77
  }, unknown>>>;
62
78
  taskKey: z.ZodString;
63
79
  }, z.core.$strip>>>;
@@ -9,12 +9,14 @@ import { z } from "zod/v4";
9
9
  * @contractShape help.source-type
10
10
  * @contractRole canonical
11
11
  */
12
- export declare const HelpSourceTypeSchema: z.ZodEnum<{
12
+ export declare const HelpSourceTypeSchema: z.ZodUnion<readonly [z.ZodEnum<{
13
13
  COMPLETION_GATE: "COMPLETION_GATE";
14
14
  OPERATION: "OPERATION";
15
15
  PROMPT: "PROMPT";
16
16
  RESEARCH_DETAIL_TYPE: "RESEARCH_DETAIL_TYPE";
17
+ RESEARCH_SNIPPET_TYPE: "RESEARCH_SNIPPET_TYPE";
17
18
  SKILL: "SKILL";
18
- }>;
19
+ TEXT_TYPE: "TEXT_TYPE";
20
+ }>, z.ZodString]>;
19
21
  export type HelpSourceType = z.infer<typeof HelpSourceTypeSchema>;
20
22
  //# sourceMappingURL=source-type.d.ts.map
@@ -10,11 +10,16 @@ import { z } from "zod/v4";
10
10
  * @contractShape help.source-type
11
11
  * @contractRole canonical
12
12
  */
13
- export const HelpSourceTypeSchema = z.enum([
14
- "OPERATION",
15
- "SKILL",
16
- "PROMPT",
17
- "COMPLETION_GATE",
18
- "RESEARCH_DETAIL_TYPE",
13
+ export const HelpSourceTypeSchema = z.union([
14
+ z.enum([
15
+ "OPERATION",
16
+ "SKILL",
17
+ "PROMPT",
18
+ "COMPLETION_GATE",
19
+ "RESEARCH_DETAIL_TYPE",
20
+ "RESEARCH_SNIPPET_TYPE",
21
+ "TEXT_TYPE",
22
+ ]),
23
+ z.string(),
19
24
  ]);
20
25
  //# sourceMappingURL=source-type.js.map