@aventurevc/api-schemas 0.8.375 → 0.8.377

package/dist/research/detail-type.js

@@ -19,7 +19,7 @@ const ResearchDetailTypeSchemaDefinition = z.object({
     typeValue: z.string(),
     /** Write-time value shape token. For numericCountOrRange details, send either discreteValue for an exact count or textValue for an employee range. */
     valueShape: ResearchValueShapeTypeSchema,
-    /** Read projection category; choose write fields from valueShape. */
+    /** Value kind on reads; pick write fields from valueShape. */
     valueType: EntityResearchValueTypeSchema,
     /** How to encode a write for this valueShape: which of valueResearchDetail, discreteValue, textValue, and asOfDate to send, with an example. */
     writeHint: z.string(),

package/dist/research/paragraph-shape.d.ts

@@ -1,6 +1,6 @@
 import { z } from "zod/v4";
 /**
- * Write-time per-paragraph shape rule for governed text bodies. Paragraphs split on `\n\n` (one blank line). Each paragraph must satisfy minChars..maxChars and minSentences..maxSentences; whole body must satisfy minParagraphs..maxParagraphs (null maxParagraphs = unbounded). Sentence boundaries follow Unicode rules (java.text.BreakIterator), so 'Inc.' and 'U.S.' do not split a sentence. Each paragraph ends in terminal punctuation (. ! ? or the CJK full stop, exclamation, and question marks), optionally followed by a closing quote, parenthesis, bracket, or guillemet.
+ * Paragraph rules that text must meet when written. Paragraphs split on `\n\n` (one blank line). Each paragraph must satisfy minChars..maxChars and minSentences..maxSentences; whole body must satisfy minParagraphs..maxParagraphs (null maxParagraphs = unbounded). Sentence boundaries follow Unicode rules (java.text.BreakIterator), so 'Inc.' and 'U.S.' do not split a sentence. Each paragraph ends in terminal punctuation (. ! ? or the CJK full stop, exclamation, and question marks), optionally followed by a closing quote, parenthesis, bracket, or guillemet.
  *
  * @openapiSchema ResearchParagraphShape
  * @endpoint GET /v1/entities/research-snippets/types

package/dist/research/paragraph-shape.js

@@ -1,7 +1,7 @@
 // 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
 import { z } from "zod/v4";
 /**
- * Write-time per-paragraph shape rule for governed text bodies. Paragraphs split on `\n\n` (one blank line). Each paragraph must satisfy minChars..maxChars and minSentences..maxSentences; whole body must satisfy minParagraphs..maxParagraphs (null maxParagraphs = unbounded). Sentence boundaries follow Unicode rules (java.text.BreakIterator), so 'Inc.' and 'U.S.' do not split a sentence. Each paragraph ends in terminal punctuation (. ! ? or the CJK full stop, exclamation, and question marks), optionally followed by a closing quote, parenthesis, bracket, or guillemet.
+ * Paragraph rules that text must meet when written. Paragraphs split on `\n\n` (one blank line). Each paragraph must satisfy minChars..maxChars and minSentences..maxSentences; whole body must satisfy minParagraphs..maxParagraphs (null maxParagraphs = unbounded). Sentence boundaries follow Unicode rules (java.text.BreakIterator), so 'Inc.' and 'U.S.' do not split a sentence. Each paragraph ends in terminal punctuation (. ! ? or the CJK full stop, exclamation, and question marks), optionally followed by a closing quote, parenthesis, bracket, or guillemet.
  *
  * @openapiSchema ResearchParagraphShape
  * @endpoint GET /v1/entities/research-snippets/types

package/dist/research/snippet-type.d.ts

@@ -36,7 +36,7 @@ type ResearchSnippetTypeDefinition = z.infer<typeof ResearchSnippetTypeSchemaDef
 export interface ResearchSnippetTypeSchemaInput extends z.input<typeof ResearchSnippetTypeSchemaDefinition> {
 }
 /**
- * Canonical research snippet type with the governance rules write callers must satisfy.
+ * A research snippet type and the rules text written to it must meet.
  *
  * @openapiSchema ResearchSnippetType
  * @endpoint GET /v1/entities/research-snippets/types

package/dist/research/snippet-type.js

@@ -21,17 +21,17 @@ const ResearchSnippetTypeSchemaDefinition = z.object({
     paragraphShape: ResearchParagraphShapeSchema.nullish(),
     /** One reader-facing question the analysis answers, shown where readers choose an analysis. */
     readerQuestion: z.string(),
-    /** Whether this textType is recognized by the research contract catalog; true for every row returned by this endpoint. */
+    /** Whether aVenture recognizes this text type; true for every row this endpoint returns. */
     recognized: z.boolean(),
     /** Dotted research section path the snippet attaches to. */
     targetPath: z.string(),
-    /** Canonical snippet type token used on the wire. */
+    /** Snippet type value used in requests and responses. */
     typeValue: z.string(),
     /** The strategic question this snippet type answers and how to shape it. Snippets are point-in-time strategic analysis of the company's position against its market and named alternatives: open with the judgment and give dated details only as evidence for it, never as a fact list. */
     writeHint: z.string(),
 });
 /**
- * Canonical research snippet type with the governance rules write callers must satisfy.
+ * A research snippet type and the rules text written to it must meet.
  *
  * @openapiSchema ResearchSnippetType
  * @endpoint GET /v1/entities/research-snippets/types

package/dist/search/cache-mode.d.ts

@@ -1,6 +1,6 @@
 import { z } from "zod/v4";
 /**
- * Search-stage cache policy: use reuses completed and in-flight work; bypass computes independently without retaining search outputs; refresh computes independently and replaces the normal cache entry. Immutable query vectors and canonical record caches retain their own cache policy.
+ * Search-stage cache policy: use reuses completed and in-flight work; bypass computes independently without retaining search outputs; refresh computes independently and replaces the normal cache entry. This setting does not affect cached query embeddings, which never change, or cached record data; both follow their own caching rules.
  *
  * @openapiSchema SearchCacheMode
  * @endpoint GET /v1/web/searches/jobs/{jobId}

package/dist/search/cache-mode.js

@@ -1,7 +1,7 @@
 // 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
 import { z } from "zod/v4";
 /**
- * Search-stage cache policy: use reuses completed and in-flight work; bypass computes independently without retaining search outputs; refresh computes independently and replaces the normal cache entry. Immutable query vectors and canonical record caches retain their own cache policy.
+ * Search-stage cache policy: use reuses completed and in-flight work; bypass computes independently without retaining search outputs; refresh computes independently and replaces the normal cache entry. This setting does not affect cached query embeddings, which never change, or cached record data; both follow their own caching rules.
  *
  * @openapiSchema SearchCacheMode
  * @endpoint GET /v1/web/searches/jobs/{jobId}

package/dist/search/investment.d.ts

@@ -474,7 +474,7 @@ type SearchInvestmentDefinition = z.infer<typeof SearchInvestmentSchemaDefinitio
 export interface SearchInvestmentSchemaInput extends z.input<typeof SearchInvestmentSchemaDefinition> {
 }
 /**
- * Canonical investor participation and matched portfolio offering evidence.
+ * An investor's participation in a round, with evidence for the portfolio product or service it matched.
  *
  * @openapiSchema SearchInvestment
  * @endpoint GET /v1/search/link

package/dist/search/investment.js

@@ -9,7 +9,7 @@ const SearchInvestmentSchemaDefinition = z.object({
     semanticMatch: ContentEmbeddingMatchSchema.nullish(),
 });
 /**
- * Canonical investor participation and matched portfolio offering evidence.
+ * An investor's participation in a round, with evidence for the portfolio product or service it matched.
  *
  * @openapiSchema SearchInvestment
  * @endpoint GET /v1/search/link

package/dist/search/mode-execution.d.ts

@@ -39,7 +39,7 @@ type SearchModeExecutionDefinition = z.infer<typeof SearchModeExecutionSchemaDef
 export interface SearchModeExecutionSchemaInput extends z.input<typeof SearchModeExecutionSchemaDefinition> {
 }
 /**
- * Search strategy requested by the caller and executed by the canonical engine.
+ * Search method the caller asked for and the method the server actually ran.
  *
  * @openapiSchema SearchModeExecution
  * @endpoint GET /v1/search/link

package/dist/search/mode-execution.js

@@ -4,11 +4,11 @@ import { SearchModeSchema } from "./mode.js";
 const SearchModeExecutionSchemaDefinition = z.object({
     /** Search mode requested by the caller. */
     modeRequested: SearchModeSchema,
-    /** Search mode executed by the canonical engine. */
+    /** Search method the server actually ran. */
     modeUsed: SearchModeSchema,
 });
 /**
- * Search strategy requested by the caller and executed by the canonical engine.
+ * Search method the caller asked for and the method the server actually ran.
  *
  * @openapiSchema SearchModeExecution
  * @endpoint GET /v1/search/link

package/dist/sec/company.js

@@ -2,7 +2,7 @@
 import { z } from "zod/v4";
 import { SecListingProspectusSchema } from "./listing-prospectus.js";
 const SecCompanySchemaDefinition = z.object({
-    /** SEC Central Index Key, 10-digit zero-padded. The stable cross-sync join key. */
+    /** SEC Central Index Key, 10 digits with leading zeros. It stays the same across SEC data syncs. */
     cik: z.string(),
     /** Employer Identification Number (tax id), when SEC supplies one. */
     ein: z.string().nullish(),

package/dist/shared/directory-list.js

@@ -8,7 +8,7 @@ const SharedDirectoryListSchemaDefinition = z.object({
     heading: z.string(),
     /** Stable shared-directory UUID */
     id: z.uuid(),
-    /** Canonical lowercase URL slug for the resource */
+    /** Lowercase URL slug that identifies the record. */
     slug: z
         .string()
         .regex(/^[a-z0-9_-]+$/)

package/dist/shared/search-list.js

@@ -5,7 +5,7 @@ const SharedSearchListSchemaDefinition = z.object({
     /** Stable shared-search UUID */
     id: z.uuid(),
     query: z.string(),
-    /** Canonical lowercase URL slug for the resource */
+    /** Lowercase URL slug that identifies the record. */
     slug: z
         .string()
         .regex(/^[a-z0-9_-]+$/)

package/dist/source/document-list.d.ts

@@ -21,7 +21,7 @@ type SourceDocumentListDefinition = z.infer<typeof SourceDocumentListSchemaDefin
 export interface SourceDocumentListSchemaInput extends z.input<typeof SourceDocumentListSchemaDefinition> {
 }
 /**
- * Metadata-only ledger row for source-document lists
+ * A stored source document's metadata, without its content.
  *
  * @openapiSchema SourceDocumentList
  * @endpoint GET /v1/web/searches/jobs/{jobId}

package/dist/source/document-list.js

@@ -16,14 +16,14 @@ const SourceDocumentListSchemaDefinition = z.object({
     rawByteCount: z.number().int().nullish(),
     rawCharset: z.string().nullish(),
     rawMediaType: z.string().nullish(),
-    /** Canonical fetch identity: canonical URL, query hash, or dataset + external id */
+    /** What identifies this fetch: the normalized URL, a hash of the query, or a dataset name plus an external id */
     sourceKey: z.string(),
     upstreamContentEncoding: z.string().nullish(),
-    /** Fetched page URL; recency keyset continuation uses this value */
+    /** Fetched page URL; also used to page through results by recency */
     url: z.string().nullish(),
 });
 /**
- * Metadata-only ledger row for source-document lists
+ * A stored source document's metadata, without its content.
  *
  * @openapiSchema SourceDocumentList
  * @endpoint GET /v1/web/searches/jobs/{jobId}

package/dist/stage/frequency.d.ts

@@ -7,7 +7,7 @@ type StageFrequencyDefinition = z.infer<typeof StageFrequencySchemaDefinition>;
 export interface StageFrequencySchemaInput extends z.input<typeof StageFrequencySchemaDefinition> {
 }
 /**
- * Canonical equity stage derived from a transaction calculatedRoundLabel, with deal frequency ranked by count descending.
+ * Equity stage computed from each round's calculatedRoundLabel, with how many deals reached it, most frequent first.
  *
  * @openapiSchema StageFrequency
  * @endpoint GET /v1/entities/lookup-exact

package/dist/stage/frequency.js

@@ -5,7 +5,7 @@ const StageFrequencySchemaDefinition = z.object({
     stage: z.string(),
 });
 /**
- * Canonical equity stage derived from a transaction calculatedRoundLabel, with deal frequency ranked by count descending.
+ * Equity stage computed from each round's calculatedRoundLabel, with how many deals reached it, most frequent first.
  *
  * @openapiSchema StageFrequency
  * @endpoint GET /v1/entities/lookup-exact

package/dist/standardized/classification-filter.js

@@ -9,7 +9,7 @@ const StandardizedClassificationFilterSchemaDefinition = z.object({
     codeText: z.string().max(255).nullish(),
     /** Exact supplied codebook edition; omitted does not assume the current edition. */
     edition: z.string().max(128).nullish(),
-    /** true selects recorded editions; false selects unknown edition; omitted imposes no presence predicate. */
+    /** true selects recorded editions; false selects unknown edition; omit it to match either. */
     hasEdition: z.boolean().nullish(),
 });
 /**

package/dist/text/type-option.d.ts

@@ -19,7 +19,7 @@ type TextTypeOptionDefinition = z.infer<typeof TextTypeOptionSchemaDefinition>;
 export interface TextTypeOptionSchemaInput extends z.input<typeof TextTypeOptionSchemaDefinition> {
 }
 /**
- * Canonical textType value accepted by text endpoints; entity rows include minWords, maxWords, rewriteHint, and paragraphShape when a governed text contract applies.
+ * A text type the text endpoints accept; entity rows include minWords, maxWords, rewriteHint, and paragraphShape when that type has length and paragraph rules.
  *
  * @openapiSchema TextTypeOption
  * @endpoint GET /v1/entities/texts/types

package/dist/text/type-option.js

@@ -4,19 +4,19 @@ import { ResearchParagraphShapeSchema } from "../research/paragraph-shape.js";
 const TextTypeOptionSchemaDefinition = z.object({
     /** Canonical textType value. */
     canonical: z.string(),
-    /** Maximum words allowed by the governed text contract. */
+    /** Maximum words allowed for this text type. */
     maxWords: z.int().nullish(),
-    /** Minimum words allowed by the governed text contract. */
+    /** Minimum words allowed for this text type. */
     minWords: z.int().nullish(),
-    /** Paragraph-shape rule returned by the governed text contract. */
+    /** Paragraph rules for this text type. */
     paragraphShape: ResearchParagraphShapeSchema.nullish(),
     /** Whether the textType requires trusted read visibility. */
     privateType: z.boolean(),
-    /** Rewrite guidance returned by the governed text contract. */
+    /** Advice for rewriting text that breaks this type's rules. */
     rewriteHint: z.string().nullish(),
 });
 /**
- * Canonical textType value accepted by text endpoints; entity rows include minWords, maxWords, rewriteHint, and paragraphShape when a governed text contract applies.
+ * A text type the text endpoints accept; entity rows include minWords, maxWords, rewriteHint, and paragraphShape when that type has length and paragraph rules.
  *
  * @openapiSchema TextTypeOption
  * @endpoint GET /v1/entities/texts/types

package/dist/unique/id-mutation.js

@@ -34,7 +34,7 @@ export const UniqueIdMutationSchema = z.object({
     shareClass: z.string().nullish(),
     /** Optional attribution source label for the mapping. */
     source: z.string().nullish(),
-    /** Source-effective date of the standing assertion at supplied precision. */
+    /** Date from which the source says this listing standing applies, at the precision supplied. */
     standingAsOf: z
         .string()
         .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[0-9]|1[0-7]):[0-5][0-9]|18:00)))?)?)?$/)

package/dist/unique/id-type-alias.d.ts

@@ -13,7 +13,7 @@ type UniqueIdTypeAliasDefinition = z.infer<typeof UniqueIdTypeAliasSchemaDefinit
 export interface UniqueIdTypeAliasSchemaInput extends z.input<typeof UniqueIdTypeAliasSchemaDefinition> {
 }
 /**
- * Canonical uniqueId type value plus its label, accepted aliases, owner scope, and format pattern.
+ * An identifier type with its label, accepted spellings, whether it applies to entities or people, and its format pattern.
  *
  * @openapiSchema UniqueIdTypeAlias
  * @endpoint GET /v1/unique-ids/types

package/dist/unique/id-type-alias.js

@@ -2,9 +2,9 @@
 import { z } from "zod/v4";
 import { UniqueIdOwnerScopeSchema } from "./id-owner-scope.js";
 const UniqueIdTypeAliasSchemaDefinition = z.object({
-    /** Alias tokens accepted by the write boundary. */
+    /** Other spellings accepted for this identifier type on writes. */
     alias: z.array(z.string()),
-    /** Canonical uniqueId type value persisted in id_type. */
+    /** Identifier type value, as returned in responses and accepted on writes. */
     canonical: z.string(),
     /** Human-readable label. */
     label: z.string(),
@@ -14,7 +14,7 @@ const UniqueIdTypeAliasSchemaDefinition = z.object({
     pattern: z.string().nullish(),
 });
 /**
- * Canonical uniqueId type value plus its label, accepted aliases, owner scope, and format pattern.
+ * An identifier type with its label, accepted spellings, whether it applies to entities or people, and its format pattern.
  *
  * @openapiSchema UniqueIdTypeAlias
  * @endpoint GET /v1/unique-ids/types

package/dist/unique/id.js

@@ -30,7 +30,7 @@ const UniqueIdSchemaDefinition = z.object({
     shareClass: z.string().nullish(),
     /** Attribution source label for the mapping, when recorded. */
     source: z.string().nullish(),
-    /** Source-effective date of the standing assertion at supplied precision. */
+    /** Date from which the source says this listing standing applies, at the precision supplied. */
     standingAsOf: z
         .string()
         .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[0-9]|1[0-7]):[0-5][0-9]|18:00)))?)?)?$/)

package/dist/url/duplicate-conflict.js

@@ -6,7 +6,7 @@ import { UrlDuplicateJoinSchema } from "./duplicate-join.js";
 const UrlDuplicateConflictSchemaDefinition = z.object({
     /** Conflict kind that identifies this details shape. */
     conflictType: DomainConflictTypeSchema,
-    /** Every current owner that already holds the normalized URL with this urlType. Non-empty when this conflict is emitted. */
+    /** Every entity or person that already has this URL (after normalization) with this urlType. Non-empty when this conflict is emitted. */
     existingJoin: z.array(UrlDuplicateJoinSchema),
     /** True when URL fragment differences were ignored during duplicate matching (i.e., the conflict ignores everything after '#'). */
     fragmentIgnored: z.boolean(),
@@ -14,7 +14,7 @@ const UrlDuplicateConflictSchemaDefinition = z.object({
     guidance: z.string(),
     /** Normalized URL match key used for duplicate detection. Null when normalization could not produce a stable key (e.g., malformed input). */
     normalizedUrl: z.string().nullish(),
-    /** Owner the caller attempted to attach the URL to. */
+    /** Entity or person you tried to add the URL to. */
     requestedOwner: EntityPersonOwnerSchema,
     /** Raw URL as submitted by the caller (pre-normalization). */
     url: z.string(),

package/dist/url/duplicate-join.d.ts

@@ -10,7 +10,7 @@ type UrlDuplicateJoinDefinition = z.infer<typeof UrlDuplicateJoinSchemaDefinitio
 export interface UrlDuplicateJoinSchemaInput extends z.input<typeof UrlDuplicateJoinSchemaDefinition> {
 }
 /**
- * Entity or person that currently owns a normalized URL.
+ * Entity or person that currently has this URL (after normalization).
  *
  * @openapiSchema UrlDuplicateJoin
  * @standardProblemResponse

package/dist/url/duplicate-join.js

@@ -8,7 +8,7 @@ const UrlDuplicateJoinSchemaDefinition = z.object({
     urlId: z.int(),
 });
 /**
- * Entity or person that currently owns a normalized URL.
+ * Entity or person that currently has this URL (after normalization).
  *
  * @openapiSchema UrlDuplicateJoin
  * @standardProblemResponse

package/dist/url/type-alias.d.ts

@@ -8,7 +8,7 @@ type UrlTypeAliasDefinition = z.infer<typeof UrlTypeAliasSchemaDefinition>;
 export interface UrlTypeAliasSchemaInput extends z.input<typeof UrlTypeAliasSchemaDefinition> {
 }
 /**
- * Canonical urlType value plus accepted alias and platform host tokens.
+ * A URL type, its accepted spellings, and the website hosts that identify it.
  *
  * @openapiSchema UrlTypeAlias
  * @endpoint GET /v1/url-types

package/dist/url/type-alias.js

@@ -1,7 +1,7 @@
 // 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
 import { z } from "zod/v4";
 const UrlTypeAliasSchemaDefinition = z.object({
-    /** Alias tokens accepted by UrlTypeCatalog.fromRaw. */
+    /** Other spellings accepted for this URL type. */
     alias: z.array(z.string()),
     /** Canonical urlType value. */
     canonical: z.string(),
@@ -9,7 +9,7 @@ const UrlTypeAliasSchemaDefinition = z.object({
     hostDomain: z.array(z.string()),
 });
 /**
- * Canonical urlType value plus accepted alias and platform host tokens.
+ * A URL type, its accepted spellings, and the website hosts that identify it.
  *
  * @openapiSchema UrlTypeAlias
  * @endpoint GET /v1/url-types

package/dist/web/search.js

@@ -13,7 +13,7 @@ const WebSearchSchemaDefinition = z.object({
     aiOverview: SearchAiOverviewSchema.nullish(),
     /** Google's direct answer box; null when the page shows none */
     answerBox: SearchAnswerBoxSchema.nullish(),
-    /** Source-document ledger row backing this result */
+    /** Stored record, metadata only, of the page this web search fetched */
     document: SourceDocumentListSchema,
     /** Google's knowledge panel; null when the page shows none */
     knowledgeGraph: SearchKnowledgeGraphSchema.nullish(),

package/dist/writer/claim-surface.d.ts

@@ -1,6 +1,6 @@
 import { z } from "zod/v4";
 /**
- * Output surface selected for a sourced writer claim.
+ * Where a sourced claim appears in the written output.
  *
  * @openapiSchema WriterClaimSurface
  * @endpoint POST /v1/entities/{entityId}/enrichments

package/dist/writer/claim-surface.js

@@ -2,7 +2,7 @@
 import { z } from "zod/v4";
 const WriterClaimSurfaceSchemaKnownMembers = z.enum(["ENTITY_TEXT", "RESEARCH_SNIPPET", "BOTH"]);
 /**
- * Output surface selected for a sourced writer claim.
+ * Where a sourced claim appears in the written output.
  *
  * @openapiSchema WriterClaimSurface
  * @endpoint POST /v1/entities/{entityId}/enrichments

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aventurevc/api-schemas",
-  "version": "0.8.375",
+  "version": "0.8.377",
   "private": false,
   "description": "Zod v4 schemas and TypeScript types for the aVenture API.",
   "license": "Apache-2.0",