@aventurevc/api-schemas 0.8.196 → 0.8.199

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.
@@ -50,7 +50,9 @@ import { AddressStateSchema } from "./state.js";
50
50
  export const AddressSchema = z.object({
51
51
  /** Legacy address row identifier */
52
52
  address: z.int().nullish(),
53
+ /** Canonical street address line. */
53
54
  addressLine1: z.string().nullish(),
55
+ /** Canonical suite, floor, or secondary address line. */
54
56
  addressLine2: z.string().nullish(),
55
57
  /** Role-period associations for this physical address */
56
58
  association: z.array(AddressAssociationSchema).optional(),
@@ -72,9 +74,11 @@ export const AddressSchema = z.object({
72
74
  isPrimary: z.boolean().nullish(),
73
75
  latitude: z.number().nullish(),
74
76
  longitude: z.number().nullish(),
77
+ /** Canonical postal or ZIP code. */
75
78
  postalCode: z.string().nullish(),
76
79
  /** State or region reference */
77
80
  state: AddressStateSchema.nullish(),
81
+ /** Canonical state or region abbreviation. */
78
82
  stateAbbrev: z.string().nullish(),
79
83
  street: z.string().nullish(),
80
84
  updatedAt: z.iso.datetime({ offset: true }).nullish(),
@@ -35,6 +35,12 @@ declare const EnrichmentSchemaDefinition: z.ZodObject<{
35
35
  error: z.ZodOptional<z.ZodNullable<z.ZodString>>;
36
36
  failureClass: z.ZodOptional<z.ZodNullable<z.ZodString>>;
37
37
  finishedAt: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
38
+ followUpAdmission: z.ZodOptional<z.ZodEnum<{
39
+ PENDING: "PENDING";
40
+ REJECTED: "REJECTED";
41
+ SETTLED: "SETTLED";
42
+ UNTRACKED: "UNTRACKED";
43
+ }>>;
38
44
  hasSourceDocument: z.ZodBoolean;
39
45
  id: z.ZodUUID;
40
46
  iteration: z.ZodInt;
@@ -12,6 +12,7 @@ import { z } from "zod/v4";
12
12
  * @usedBySchema IdentificationSubjectSchema
13
13
  * @usedBySchema NewsResolvedEntityLinkSchema
14
14
  * @usedBySchema PersonListArrayFilterSchema
15
+ * @usedBySchema ResearchSnippetTypeSchema
15
16
  * @usedBySchema SearchDuplicateCandidateScoreSchema
16
17
  * @contractShape entity.type
17
18
  * @contractRole canonical
@@ -13,6 +13,7 @@ import { z } from "zod/v4";
13
13
  * @usedBySchema IdentificationSubjectSchema
14
14
  * @usedBySchema NewsResolvedEntityLinkSchema
15
15
  * @usedBySchema PersonListArrayFilterSchema
16
+ * @usedBySchema ResearchSnippetTypeSchema
16
17
  * @usedBySchema SearchDuplicateCandidateScoreSchema
17
18
  * @contractShape entity.type
18
19
  * @contractRole canonical
@@ -50,6 +50,16 @@ declare const HarnessRunDetailSchemaDefinition: z.ZodObject<{
50
50
  }>;
51
51
  updatedAt: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
52
52
  }, z.core.$strip>>>;
53
+ followUp: z.ZodOptional<z.ZodObject<{
54
+ admission: z.ZodEnum<{
55
+ PENDING: "PENDING";
56
+ REJECTED: "REJECTED";
57
+ SETTLED: "SETTLED";
58
+ UNTRACKED: "UNTRACKED";
59
+ }>;
60
+ hasMore: z.ZodBoolean;
61
+ runId: z.ZodArray<z.ZodUUID>;
62
+ }, z.core.$strip>>;
53
63
  latestStatus: z.ZodOptional<z.ZodNullable<z.ZodObject<{
54
64
  complete: z.ZodBoolean;
55
65
  entitySlug: z.ZodNullable<z.ZodString>;
@@ -127,6 +137,12 @@ declare const HarnessRunDetailSchemaDefinition: z.ZodObject<{
127
137
  error: z.ZodOptional<z.ZodNullable<z.ZodString>>;
128
138
  failureClass: z.ZodOptional<z.ZodNullable<z.ZodString>>;
129
139
  finishedAt: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
140
+ followUpAdmission: z.ZodOptional<z.ZodEnum<{
141
+ PENDING: "PENDING";
142
+ REJECTED: "REJECTED";
143
+ SETTLED: "SETTLED";
144
+ UNTRACKED: "UNTRACKED";
145
+ }>>;
130
146
  hasSourceDocument: z.ZodBoolean;
131
147
  id: z.ZodUUID;
132
148
  iteration: z.ZodInt;
@@ -1,11 +1,14 @@
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 { EntitySchema } from "../entity/entity.js";
4
+ import { HarnessRunFollowUpSchema } from "./run-follow-up.js";
4
5
  import { HarnessRunProgressSchema } from "./run-progress.js";
5
6
  import { HarnessRunSchema } from "./run.js";
6
7
  const HarnessRunDetailSchemaDefinition = z.object({
7
8
  /** Current public profile the run resolved to */
8
9
  entity: EntitySchema.nullish(),
10
+ /** Follow-up admission and direct child run ids for this terminal generation */
11
+ followUp: HarnessRunFollowUpSchema.optional(),
9
12
  /** Latest research progress; null when none is available */
10
13
  latestStatus: HarnessRunProgressSchema.nullish(),
11
14
  /** Parent organization's core record when the resolved entity is a Product/Service; null for every other entity type */
@@ -0,0 +1,23 @@
1
+ import { z } from "zod/v4";
2
+ /**
3
+ * Durable admission state for one terminal run generation's follow-up work
4
+ *
5
+ * @openapiSchema HarnessRunFollowUpAdmission
6
+ * @endpoint GET /v1/research-runs/{runId}
7
+ * @endpoint POST /v1/enrichments
8
+ * @endpoint POST /v1/entities/{entityId}/enrichments
9
+ * @endpoint POST /v1/people/{personId}/enrichments
10
+ * @endpoint POST /v1/research-runs
11
+ * @usedBySchema HarnessRunFollowUpSchema
12
+ * @usedBySchema HarnessRunSchema
13
+ * @contractShape harness.run-follow-up-admission
14
+ * @contractRole canonical
15
+ */
16
+ export declare const HarnessRunFollowUpAdmissionSchema: z.ZodEnum<{
17
+ PENDING: "PENDING";
18
+ REJECTED: "REJECTED";
19
+ SETTLED: "SETTLED";
20
+ UNTRACKED: "UNTRACKED";
21
+ }>;
22
+ export type HarnessRunFollowUpAdmission = z.infer<typeof HarnessRunFollowUpAdmissionSchema>;
23
+ //# sourceMappingURL=run-follow-up-admission.d.ts.map
@@ -0,0 +1,23 @@
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
+ * Durable admission state for one terminal run generation's follow-up work
5
+ *
6
+ * @openapiSchema HarnessRunFollowUpAdmission
7
+ * @endpoint GET /v1/research-runs/{runId}
8
+ * @endpoint POST /v1/enrichments
9
+ * @endpoint POST /v1/entities/{entityId}/enrichments
10
+ * @endpoint POST /v1/people/{personId}/enrichments
11
+ * @endpoint POST /v1/research-runs
12
+ * @usedBySchema HarnessRunFollowUpSchema
13
+ * @usedBySchema HarnessRunSchema
14
+ * @contractShape harness.run-follow-up-admission
15
+ * @contractRole canonical
16
+ */
17
+ export const HarnessRunFollowUpAdmissionSchema = z.enum([
18
+ "UNTRACKED",
19
+ "PENDING",
20
+ "SETTLED",
21
+ "REJECTED",
22
+ ]);
23
+ //# sourceMappingURL=run-follow-up-admission.js.map
@@ -0,0 +1,22 @@
1
+ import { z } from "zod/v4";
2
+ /**
3
+ * Durable completion barrier and direct child run ids
4
+ *
5
+ * @openapiSchema HarnessRunFollowUp
6
+ * @endpoint GET /v1/research-runs/{runId}
7
+ * @usedBySchema HarnessRunDetailSchema
8
+ * @contractShape harness.run-follow-up
9
+ * @contractRole canonical
10
+ */
11
+ export declare const HarnessRunFollowUpSchema: z.ZodObject<{
12
+ admission: z.ZodEnum<{
13
+ PENDING: "PENDING";
14
+ REJECTED: "REJECTED";
15
+ SETTLED: "SETTLED";
16
+ UNTRACKED: "UNTRACKED";
17
+ }>;
18
+ hasMore: z.ZodBoolean;
19
+ runId: z.ZodArray<z.ZodUUID>;
20
+ }, z.core.$strip>;
21
+ export type HarnessRunFollowUp = z.infer<typeof HarnessRunFollowUpSchema>;
22
+ //# sourceMappingURL=run-follow-up.d.ts.map
@@ -0,0 +1,21 @@
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 { HarnessRunFollowUpAdmissionSchema } from "./run-follow-up-admission.js";
4
+ /**
5
+ * Durable completion barrier and direct child run ids
6
+ *
7
+ * @openapiSchema HarnessRunFollowUp
8
+ * @endpoint GET /v1/research-runs/{runId}
9
+ * @usedBySchema HarnessRunDetailSchema
10
+ * @contractShape harness.run-follow-up
11
+ * @contractRole canonical
12
+ */
13
+ export const HarnessRunFollowUpSchema = z.object({
14
+ /** PENDING until every follow-up admission is durable; REJECTED when the bounded redo is exhausted */
15
+ admission: HarnessRunFollowUpAdmissionSchema,
16
+ /** More than the bounded child count exists; completion is unproven */
17
+ hasMore: z.boolean(),
18
+ /** Direct appointed run ids; read each run's detail recursively */
19
+ runId: z.array(z.uuid()),
20
+ });
21
+ //# sourceMappingURL=run-follow-up.js.map
@@ -31,6 +31,12 @@ export declare const HarnessRunSchema: z.ZodObject<{
31
31
  error: z.ZodOptional<z.ZodNullable<z.ZodString>>;
32
32
  failureClass: z.ZodOptional<z.ZodNullable<z.ZodString>>;
33
33
  finishedAt: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
34
+ followUpAdmission: z.ZodOptional<z.ZodEnum<{
35
+ PENDING: "PENDING";
36
+ REJECTED: "REJECTED";
37
+ SETTLED: "SETTLED";
38
+ UNTRACKED: "UNTRACKED";
39
+ }>>;
34
40
  hasSourceDocument: z.ZodBoolean;
35
41
  id: z.ZodUUID;
36
42
  iteration: z.ZodInt;
@@ -4,6 +4,7 @@ import { EnrichmentModeSchema } from "../enrichment/mode.js";
4
4
  import { HarnessChassisSchema } from "./chassis.js";
5
5
  import { HarnessLlmApiSchema } from "./llm-api.js";
6
6
  import { HarnessRunEnvironmentSchema } from "./run-environment.js";
7
+ import { HarnessRunFollowUpAdmissionSchema } from "./run-follow-up-admission.js";
7
8
  import { HarnessRunLaneSchema } from "./run-lane.js";
8
9
  import { HarnessRunStatusSchema } from "./run-status.js";
9
10
  import { HarnessRunTypeSchema } from "./run-type.js";
@@ -41,6 +42,8 @@ export const HarnessRunSchema = z.object({
41
42
  failureClass: z.string().nullish(),
42
43
  /** Run completion timestamp */
43
44
  finishedAt: z.iso.datetime({ offset: true }).nullish(),
45
+ /** Follow-up admission for the exact current terminal generation; old engine terminals remain PENDING */
46
+ followUpAdmission: HarnessRunFollowUpAdmissionSchema.optional(),
44
47
  /** Whether this run consumes an immutable private source document */
45
48
  hasSourceDocument: z.boolean(),
46
49
  /** Run id */
@@ -17,7 +17,7 @@ export const HarnessTaskPlanSchema = z.object({
17
17
  catalogRevision: z.int().optional(),
18
18
  /** Canonical completion gate ids this task is responsible for; the ids resolve through the completion contract catalog. */
19
19
  gateId: z.array(z.string()).optional(),
20
- /** Typed inputs the task needs before it runs. */
20
+ /** Typed task inputs; required inputs must be bound before it runs. */
21
21
  input: z.array(HarnessTaskSchema),
22
22
  /** Steps in run order; an empty list means this catalog task is unplanned. */
23
23
  step: z.array(HarnessTaskPlanStepSchema),
@@ -37,6 +37,7 @@ declare const MediaUploadSchemaDefinition: z.ZodObject<{
37
37
  PERSON: "PERSON";
38
38
  }>;
39
39
  path: z.ZodString;
40
+ squareOriginalValidated: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
40
41
  targetId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
41
42
  }, z.core.$strip>;
42
43
  type MediaUploadDefinition = z.infer<typeof MediaUploadSchemaDefinition>;
@@ -13,6 +13,8 @@ const MediaUploadSchemaDefinition = z.object({
13
13
  mediaType: MediaObjectTypeSchema,
14
14
  /** Attached managed storage path; never an external image URL */
15
15
  path: z.string(),
16
+ /** True only when this read fetched and validated the stored entity SQUARE original; absent on ordinary metadata reads and other media slots. */
17
+ squareOriginalValidated: z.boolean().nullish(),
16
18
  /** Attached entity/person/news target id, when known */
17
19
  targetId: z.string().nullish(),
18
20
  });
@@ -556,6 +556,14 @@ export const OPENAPI_COMPONENT_MANIFEST = Object.freeze({
556
556
  modulePath: "harness/run-environment",
557
557
  schemaName: "HarnessRunEnvironmentSchema",
558
558
  },
559
+ HarnessRunFollowUp: {
560
+ modulePath: "harness/run-follow-up",
561
+ schemaName: "HarnessRunFollowUpSchema",
562
+ },
563
+ HarnessRunFollowUpAdmission: {
564
+ modulePath: "harness/run-follow-up-admission",
565
+ schemaName: "HarnessRunFollowUpAdmissionSchema",
566
+ },
559
567
  HarnessRunLane: { modulePath: "harness/run-lane", schemaName: "HarnessRunLaneSchema" },
560
568
  HarnessRunProgress: {
561
569
  modulePath: "harness/run-progress",
@@ -37,6 +37,7 @@ export declare const ProblemTypeSchema: z.ZodUnion<readonly [z.ZodEnum<{
37
37
  readonly AUTH_METRICS_UNAUTHORIZED: "https://api.aventure.vc/errors/auth.metrics-unauthorized";
38
38
  readonly ACCESS_DENIED: "https://api.aventure.vc/errors/access-denied";
39
39
  readonly NOT_FOUND: "https://api.aventure.vc/errors/not-found";
40
+ readonly ENDPOINT_NOT_FOUND: "https://api.aventure.vc/errors/endpoint-not-found";
40
41
  readonly GONE: "https://api.aventure.vc/errors/gone";
41
42
  readonly RATE_LIMITED: "https://api.aventure.vc/errors/rate-limited";
42
43
  readonly PRECONDITION_FAILED: "https://api.aventure.vc/errors/precondition-failed";
@@ -97,6 +98,7 @@ export declare const ProblemTypeSchema: z.ZodUnion<readonly [z.ZodEnum<{
97
98
  readonly AUTH_METRICS_UNAUTHORIZED: "https://api.aventure.vc/errors/auth.metrics-unauthorized";
98
99
  readonly ACCESS_DENIED: "https://api.aventure.vc/errors/access-denied";
99
100
  readonly NOT_FOUND: "https://api.aventure.vc/errors/not-found";
101
+ readonly ENDPOINT_NOT_FOUND: "https://api.aventure.vc/errors/endpoint-not-found";
100
102
  readonly GONE: "https://api.aventure.vc/errors/gone";
101
103
  readonly RATE_LIMITED: "https://api.aventure.vc/errors/rate-limited";
102
104
  readonly PRECONDITION_FAILED: "https://api.aventure.vc/errors/precondition-failed";
@@ -29,6 +29,7 @@ const ProblemTypeSchemaKnownMembers = z.enum({
29
29
  AUTH_METRICS_UNAUTHORIZED: "https://api.aventure.vc/errors/auth.metrics-unauthorized",
30
30
  ACCESS_DENIED: "https://api.aventure.vc/errors/access-denied",
31
31
  NOT_FOUND: "https://api.aventure.vc/errors/not-found",
32
+ ENDPOINT_NOT_FOUND: "https://api.aventure.vc/errors/endpoint-not-found",
32
33
  GONE: "https://api.aventure.vc/errors/gone",
33
34
  RATE_LIMITED: "https://api.aventure.vc/errors/rate-limited",
34
35
  PRECONDITION_FAILED: "https://api.aventure.vc/errors/precondition-failed",
@@ -2,6 +2,17 @@ import { z } from "zod/v4";
2
2
  declare const ResearchSnippetTypeSchemaDefinition: z.ZodObject<{
3
3
  analysisRenderable: z.ZodBoolean;
4
4
  analysisSectionLabel: z.ZodOptional<z.ZodArray<z.ZodString>>;
5
+ appliesToType: z.ZodArray<z.ZodEnum<{
6
+ "Business Line": "Business Line";
7
+ Company: "Company";
8
+ Fund: "Fund";
9
+ Government: "Government";
10
+ "Investment Firm": "Investment Firm";
11
+ Nonprofit: "Nonprofit";
12
+ Organization: "Organization";
13
+ Product: "Product";
14
+ Service: "Service";
15
+ }>>;
5
16
  curated: z.ZodBoolean;
6
17
  defaultVisible: z.ZodBoolean;
7
18
  label: z.ZodString;
@@ -1,11 +1,14 @@
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 { EntityTypeSchema } from "../entity/type.js";
3
4
  import { ResearchParagraphShapeSchema } from "./paragraph-shape.js";
4
5
  const ResearchSnippetTypeSchemaDefinition = z.object({
5
6
  /** Whether curated rows of this snippet type can make the public company Analysis page eligible. */
6
7
  analysisRenderable: z.boolean(),
7
8
  /** Ordered headings for the fixed paragraphs of a framework analysis. Empty means ordinary prose; preserve legacy prose when its paragraph count differs. */
8
9
  analysisSectionLabel: z.array(z.string()).optional(),
10
+ /** Entity types for which this snippet is meaningful; empty means every type. */
11
+ appliesToType: z.array(EntityTypeSchema),
9
12
  /** 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. */
10
13
  curated: z.boolean(),
11
14
  /** Default visible flag when a write omits visible; true for recognized snippet types even when curated=false. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aventurevc/api-schemas",
3
- "version": "0.8.196",
3
+ "version": "0.8.199",
4
4
  "private": false,
5
5
  "description": "Zod v4 schemas and TypeScript types for the aVenture API.",
6
6
  "license": "Apache-2.0",