@aventurevc/api-schemas 0.8.349 → 0.8.351

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.
@@ -1,6 +1,19 @@
1
1
  import { z } from "zod/v4";
2
2
  declare const EnrichmentBatchSchemaDefinition: z.ZodObject<{
3
3
  entityId: z.ZodOptional<z.ZodArray<z.ZodUUID>>;
4
+ instruction: z.ZodOptional<z.ZodArray<z.ZodType<{
5
+ record: {
6
+ entityId?: string | null | undefined;
7
+ personId?: string | null | undefined;
8
+ };
9
+ userPrompt?: string | null | undefined;
10
+ }, import("./instruction.ts").EnrichmentInstructionSchemaInput, z.core.$ZodTypeInternals<{
11
+ record: {
12
+ entityId?: string | null | undefined;
13
+ personId?: string | null | undefined;
14
+ };
15
+ userPrompt?: string | null | undefined;
16
+ }, import("./instruction.ts").EnrichmentInstructionSchemaInput>>>>;
4
17
  mode: z.ZodOptional<z.ZodEnum<{
5
18
  COMPREHENSIVE: "COMPREHENSIVE";
6
19
  INDIVIDUAL: "INDIVIDUAL";
@@ -15,7 +28,7 @@ type EnrichmentBatchDefinition = z.infer<typeof EnrichmentBatchSchemaDefinition>
15
28
  export interface EnrichmentBatchSchemaInput extends z.input<typeof EnrichmentBatchSchemaDefinition> {
16
29
  }
17
30
  /**
18
- * Existing records to enrich in one call, with the run options every run shares
31
+ * Existing records to enrich in one call, with shared run options and optional additional instructions for individual selected records
19
32
  *
20
33
  * @openapiSchema EnrichmentBatch
21
34
  * @endpoint POST /v1/enrichments
@@ -1,9 +1,12 @@
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
+ import { EnrichmentInstructionSchema } from "./instruction.js";
3
4
  import { EnrichmentModeSchema } from "./mode.js";
4
5
  const EnrichmentBatchSchemaDefinition = z.object({
5
6
  /** Canonical entity UUIDs to enrich, filed in order before any person */
6
7
  entityId: z.array(z.uuid()).optional(),
8
+ /** Additional instructions for selected records, one entry per owner. Each entry appends to the shared userPrompt for that owner only. Duplicate or unselected owners and combined prompts longer than the run limit are rejected before any run is filed. Omit for identical instructions on every run. */
9
+ instruction: z.array(EnrichmentInstructionSchema).optional(),
7
10
  /** COMPREHENSIVE (the default) researches each whole profile; INDIVIDUAL runs only the tasks named in taskPresetKey */
8
11
  mode: EnrichmentModeSchema.optional(),
9
12
  /** Model id for each run's lead agent; omit to use aVenture's default model */
@@ -18,7 +21,7 @@ const EnrichmentBatchSchemaDefinition = z.object({
18
21
  userPrompt: z.string().max(2000).nullish(),
19
22
  });
20
23
  /**
21
- * Existing records to enrich in one call, with the run options every run shares
24
+ * Existing records to enrich in one call, with shared run options and optional additional instructions for individual selected records
22
25
  *
23
26
  * @openapiSchema EnrichmentBatch
24
27
  * @endpoint POST /v1/enrichments
@@ -47,11 +47,15 @@ declare const EnrichmentSchemaDefinition: z.ZodObject<{
47
47
  iteration: z.ZodInt;
48
48
  lane: z.ZodUnion<readonly [z.ZodEnum<{
49
49
  background: "background";
50
+ bulk: "bulk";
50
51
  interactive: "interactive";
52
+ live: "live";
51
53
  }>, z.ZodString]> & {
52
54
  enum: {
53
55
  background: "background";
56
+ bulk: "bulk";
54
57
  interactive: "interactive";
58
+ live: "live";
55
59
  };
56
60
  };
57
61
  latestStatus: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -0,0 +1,24 @@
1
+ import { z } from "zod/v4";
2
+ declare const EnrichmentInstructionSchemaDefinition: z.ZodObject<{
3
+ record: z.ZodObject<{
4
+ entityId: z.ZodOptional<z.ZodNullable<z.ZodUUID>>;
5
+ personId: z.ZodOptional<z.ZodNullable<z.ZodUUID>>;
6
+ }, z.core.$strip>;
7
+ userPrompt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
8
+ }, z.core.$strip>;
9
+ type EnrichmentInstructionDefinition = z.infer<typeof EnrichmentInstructionSchemaDefinition>;
10
+ export interface EnrichmentInstructionSchemaInput extends z.input<typeof EnrichmentInstructionSchemaDefinition> {
11
+ }
12
+ /**
13
+ * Instructions appended to the shared userPrompt for exactly one selected record
14
+ *
15
+ * @openapiSchema EnrichmentInstruction
16
+ * @endpoint POST /v1/enrichments
17
+ * @usedBySchema EnrichmentBatchSchema
18
+ * @contractShape enrichment.instruction
19
+ * @contractRole canonical
20
+ */
21
+ export declare const EnrichmentInstructionSchema: z.ZodType<EnrichmentInstructionDefinition, EnrichmentInstructionSchemaInput>;
22
+ export type EnrichmentInstruction = z.infer<typeof EnrichmentInstructionSchema>;
23
+ export {};
24
+ //# sourceMappingURL=instruction.d.ts.map
@@ -0,0 +1,20 @@
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 { EntityPersonOwnerSchema } from "../entity/person-owner.js";
4
+ const EnrichmentInstructionSchemaDefinition = z.object({
5
+ /** Selected company or person these instructions apply to */
6
+ record: EntityPersonOwnerSchema,
7
+ /** Additional instructions for this record only; shared and additional instructions together, separated by a blank line, must fit the run's userPrompt limit */
8
+ userPrompt: z.string().max(2000).nullish(),
9
+ });
10
+ /**
11
+ * Instructions appended to the shared userPrompt for exactly one selected record
12
+ *
13
+ * @openapiSchema EnrichmentInstruction
14
+ * @endpoint POST /v1/enrichments
15
+ * @usedBySchema EnrichmentBatchSchema
16
+ * @contractShape enrichment.instruction
17
+ * @contractRole canonical
18
+ */
19
+ export const EnrichmentInstructionSchema = EnrichmentInstructionSchemaDefinition;
20
+ //# sourceMappingURL=instruction.js.map
@@ -7,6 +7,7 @@ import { z } from "zod/v4";
7
7
  * @usedBySchema AddressLinkSchema
8
8
  * @usedBySchema BlogPostSchema
9
9
  * @usedBySchema ContactDetailSchema
10
+ * @usedBySchema EnrichmentInstructionSchema
10
11
  * @usedBySchema EnrichmentSchema
11
12
  * @usedBySchema EntityFundraiseInvestorJoinSchema
12
13
  * @usedBySchema EntityTextSchema
@@ -8,6 +8,7 @@ import { z } from "zod/v4";
8
8
  * @usedBySchema AddressLinkSchema
9
9
  * @usedBySchema BlogPostSchema
10
10
  * @usedBySchema ContactDetailSchema
11
+ * @usedBySchema EnrichmentInstructionSchema
11
12
  * @usedBySchema EnrichmentSchema
12
13
  * @usedBySchema EntityFundraiseInvestorJoinSchema
13
14
  * @usedBySchema EntityTextSchema
@@ -196,11 +196,15 @@ declare const HarnessRunDetailSchemaDefinition: z.ZodObject<{
196
196
  iteration: z.ZodInt;
197
197
  lane: z.ZodUnion<readonly [z.ZodEnum<{
198
198
  background: "background";
199
+ bulk: "bulk";
199
200
  interactive: "interactive";
201
+ live: "live";
200
202
  }>, z.ZodString]> & {
201
203
  enum: {
202
204
  background: "background";
205
+ bulk: "bulk";
203
206
  interactive: "interactive";
207
+ live: "live";
204
208
  };
205
209
  };
206
210
  latestStatus: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -1,6 +1,6 @@
1
1
  import { z } from "zod/v4";
2
2
  /**
3
- * Queue lane for admission priority: interactive client work vs background backlog
3
+ * Queue lane for admission priority: live (search and lookup) and interactive (one client run) take interactive admission; bulk (client batch) and background (system backlog) take background admission
4
4
  *
5
5
  * @openapiSchema HarnessRunLane
6
6
  * @endpoint GET /v1/research-runs
@@ -18,11 +18,15 @@ import { z } from "zod/v4";
18
18
  */
19
19
  export declare const HarnessRunLaneSchema: z.ZodUnion<readonly [z.ZodEnum<{
20
20
  background: "background";
21
+ bulk: "bulk";
21
22
  interactive: "interactive";
23
+ live: "live";
22
24
  }>, z.ZodString]> & {
23
25
  enum: {
24
26
  background: "background";
27
+ bulk: "bulk";
25
28
  interactive: "interactive";
29
+ live: "live";
26
30
  };
27
31
  };
28
32
  export type HarnessRunLane = z.infer<typeof HarnessRunLaneSchema>;
@@ -1,8 +1,8 @@
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
- const HarnessRunLaneSchemaKnownMembers = z.enum(["interactive", "background"]);
3
+ const HarnessRunLaneSchemaKnownMembers = z.enum(["live", "interactive", "bulk", "background"]);
4
4
  /**
5
- * Queue lane for admission priority: interactive client work vs background backlog
5
+ * Queue lane for admission priority: live (search and lookup) and interactive (one client run) take interactive admission; bulk (client batch) and background (system backlog) take background admission
6
6
  *
7
7
  * @openapiSchema HarnessRunLane
8
8
  * @endpoint GET /v1/research-runs
@@ -48,11 +48,15 @@ export declare const HarnessRunSchema: z.ZodObject<{
48
48
  iteration: z.ZodInt;
49
49
  lane: z.ZodUnion<readonly [z.ZodEnum<{
50
50
  background: "background";
51
+ bulk: "bulk";
51
52
  interactive: "interactive";
53
+ live: "live";
52
54
  }>, z.ZodString]> & {
53
55
  enum: {
54
56
  background: "background";
57
+ bulk: "bulk";
55
58
  interactive: "interactive";
59
+ live: "live";
56
60
  };
57
61
  };
58
62
  latestStatus: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -290,6 +290,10 @@ export const OPENAPI_COMPONENT_MANIFEST = Object.freeze({
290
290
  },
291
291
  Enrichment: { modulePath: "enrichment/enrichment", schemaName: "EnrichmentSchema" },
292
292
  EnrichmentBatch: { modulePath: "enrichment/batch", schemaName: "EnrichmentBatchSchema" },
293
+ EnrichmentInstruction: {
294
+ modulePath: "enrichment/instruction",
295
+ schemaName: "EnrichmentInstructionSchema",
296
+ },
293
297
  EnrichmentMode: { modulePath: "enrichment/mode", schemaName: "EnrichmentModeSchema" },
294
298
  EnrichmentPrompt: { modulePath: "enrichment/prompt", schemaName: "EnrichmentPromptSchema" },
295
299
  EnrichmentRefusalType: {
@@ -12964,11 +12964,15 @@ declare const PageHarnessRunSchemaDefinition: z.ZodObject<{
12964
12964
  iteration: z.ZodInt;
12965
12965
  lane: z.ZodUnion<readonly [z.ZodEnum<{
12966
12966
  background: "background";
12967
+ bulk: "bulk";
12967
12968
  interactive: "interactive";
12969
+ live: "live";
12968
12970
  }>, z.ZodString]> & {
12969
12971
  enum: {
12970
12972
  background: "background";
12973
+ bulk: "bulk";
12971
12974
  interactive: "interactive";
12975
+ live: "live";
12972
12976
  };
12973
12977
  };
12974
12978
  latestStatus: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -68,6 +68,7 @@ export declare const ProblemTypeSchema: z.ZodUnion<readonly [z.ZodEnum<{
68
68
  readonly NON_ENGLISH_ARTICLE: "https://api.aventure.vc/errors/non-english-article";
69
69
  readonly INVALID_IMAGE: "https://api.aventure.vc/errors/invalid-image";
70
70
  readonly UPSTREAM_EDGE_CHALLENGED: "https://api.aventure.vc/errors/upstream-edge-challenged";
71
+ readonly UPSTREAM_TARGET_THROTTLED: "https://api.aventure.vc/errors/upstream-target-throttled";
71
72
  readonly ACCELERATOR_DETAIL_RESTATES_TARGET: "https://api.aventure.vc/errors/accelerator-detail-restates-target";
72
73
  }>, z.ZodString]> & {
73
74
  enum: {
@@ -130,6 +131,7 @@ export declare const ProblemTypeSchema: z.ZodUnion<readonly [z.ZodEnum<{
130
131
  readonly NON_ENGLISH_ARTICLE: "https://api.aventure.vc/errors/non-english-article";
131
132
  readonly INVALID_IMAGE: "https://api.aventure.vc/errors/invalid-image";
132
133
  readonly UPSTREAM_EDGE_CHALLENGED: "https://api.aventure.vc/errors/upstream-edge-challenged";
134
+ readonly UPSTREAM_TARGET_THROTTLED: "https://api.aventure.vc/errors/upstream-target-throttled";
133
135
  readonly ACCELERATOR_DETAIL_RESTATES_TARGET: "https://api.aventure.vc/errors/accelerator-detail-restates-target";
134
136
  };
135
137
  };
@@ -60,6 +60,7 @@ const ProblemTypeSchemaKnownMembers = z.enum({
60
60
  NON_ENGLISH_ARTICLE: "https://api.aventure.vc/errors/non-english-article",
61
61
  INVALID_IMAGE: "https://api.aventure.vc/errors/invalid-image",
62
62
  UPSTREAM_EDGE_CHALLENGED: "https://api.aventure.vc/errors/upstream-edge-challenged",
63
+ UPSTREAM_TARGET_THROTTLED: "https://api.aventure.vc/errors/upstream-target-throttled",
63
64
  ACCELERATOR_DETAIL_RESTATES_TARGET: "https://api.aventure.vc/errors/accelerator-detail-restates-target",
64
65
  });
65
66
  /**
@@ -30,6 +30,7 @@ export declare const UniqueIdTypeSchema: z.ZodUnion<readonly [z.ZodEnum<{
30
30
  duns: "duns";
31
31
  ein: "ein";
32
32
  fdicCert: "fdicCert";
33
+ federalAgencyCode: "federalAgencyCode";
33
34
  firmCrd: "firmCrd";
34
35
  folk: "folk";
35
36
  holdingCompanyRssd: "holdingCompanyRssd";
@@ -44,6 +45,7 @@ export declare const UniqueIdTypeSchema: z.ZodUnion<readonly [z.ZodEnum<{
44
45
  npi: "npi";
45
46
  orcid: "orcid";
46
47
  rssd: "rssd";
48
+ samUei: "samUei";
47
49
  secCik: "secCik";
48
50
  secPrivateFundId: "secPrivateFundId";
49
51
  signalNfxCompany: "signalNfxCompany";
@@ -58,6 +60,7 @@ export declare const UniqueIdTypeSchema: z.ZodUnion<readonly [z.ZodEnum<{
58
60
  duns: "duns";
59
61
  ein: "ein";
60
62
  fdicCert: "fdicCert";
63
+ federalAgencyCode: "federalAgencyCode";
61
64
  firmCrd: "firmCrd";
62
65
  folk: "folk";
63
66
  holdingCompanyRssd: "holdingCompanyRssd";
@@ -72,6 +75,7 @@ export declare const UniqueIdTypeSchema: z.ZodUnion<readonly [z.ZodEnum<{
72
75
  npi: "npi";
73
76
  orcid: "orcid";
74
77
  rssd: "rssd";
78
+ samUei: "samUei";
75
79
  secCik: "secCik";
76
80
  secPrivateFundId: "secPrivateFundId";
77
81
  signalNfxCompany: "signalNfxCompany";
@@ -23,6 +23,8 @@ const UniqueIdTypeSchemaKnownMembers = z.enum([
23
23
  "rssd",
24
24
  "holdingCompanyRssd",
25
25
  "naicCompanyCode",
26
+ "samUei",
27
+ "federalAgencyCode",
26
28
  "signalNfxFirm",
27
29
  "signalNfxPerson",
28
30
  "signalNfxCompany",
@@ -11,6 +11,7 @@ declare const UniqueIdSchemaDefinition: z.ZodObject<{
11
11
  duns: "duns";
12
12
  ein: "ein";
13
13
  fdicCert: "fdicCert";
14
+ federalAgencyCode: "federalAgencyCode";
14
15
  firmCrd: "firmCrd";
15
16
  folk: "folk";
16
17
  holdingCompanyRssd: "holdingCompanyRssd";
@@ -25,6 +26,7 @@ declare const UniqueIdSchemaDefinition: z.ZodObject<{
25
26
  npi: "npi";
26
27
  orcid: "orcid";
27
28
  rssd: "rssd";
29
+ samUei: "samUei";
28
30
  secCik: "secCik";
29
31
  secPrivateFundId: "secPrivateFundId";
30
32
  signalNfxCompany: "signalNfxCompany";
@@ -39,6 +41,7 @@ declare const UniqueIdSchemaDefinition: z.ZodObject<{
39
41
  duns: "duns";
40
42
  ein: "ein";
41
43
  fdicCert: "fdicCert";
44
+ federalAgencyCode: "federalAgencyCode";
42
45
  firmCrd: "firmCrd";
43
46
  folk: "folk";
44
47
  holdingCompanyRssd: "holdingCompanyRssd";
@@ -53,6 +56,7 @@ declare const UniqueIdSchemaDefinition: z.ZodObject<{
53
56
  npi: "npi";
54
57
  orcid: "orcid";
55
58
  rssd: "rssd";
59
+ samUei: "samUei";
56
60
  secCik: "secCik";
57
61
  secPrivateFundId: "secPrivateFundId";
58
62
  signalNfxCompany: "signalNfxCompany";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aventurevc/api-schemas",
3
- "version": "0.8.349",
3
+ "version": "0.8.351",
4
4
  "private": false,
5
5
  "description": "Zod v4 schemas and TypeScript types for the aVenture API.",
6
6
  "license": "Apache-2.0",