@aventurevc/api-schemas 0.8.31 → 0.8.33

package/dist/lookup/job-mention.d.ts

@@ -1169,7 +1169,7 @@ declare const LookupJobMentionSchemaDefinition: z.ZodObject<{
 }, z.core.$strip>;
 type LookupJobMentionDefinition = z.infer<typeof LookupJobMentionSchemaDefinition>;
 /**
- * One company or person a source names, which stored record it is, and, from a lookup job or a streaming lookup, the hidden shell record filed for it when it is new.
+ * One company or person a source names, which stored record it is, and, from a standard article job or streaming lookup, the hidden shell record filed when it is new. Bulk lookup only identifies names and files no shells.
  *
  * @openapiSchema LookupJobMention
  * @endpoint GET /v1/lookup-jobs/{jobId}

package/dist/lookup/job-mention.js

@@ -19,13 +19,13 @@ const LookupJobMentionSchemaDefinition = z.object({
     name: z.string(),
     /** POST /v1/lookup-mentions only: the candidate people as search results show them, ranked like entity. */
     person: z.array(PersonSchema),
-    /** The hidden record filed for a NO_MATCH name whose own site web search found and whose live page names it, or the stored hidden record that already holds that site. A background enrichment run graduates or merges it (enrichmentRunId). Absent when no record was filed. */
+    /** The hidden record filed for a NO_MATCH name when web search finds its own site and the live page names it, or the stored hidden record already holding that site. An article job also requires its article as an independent source. A background enrichment run graduates or merges it (enrichmentRunId). Absent for bulk lookups. */
     shell: EntityPersonOwnerSchema.nullish(),
     /** One sentence on why no shell was filed for a NO_MATCH name; absent otherwise. */
     shellDetail: z.string().nullish(),
 });
 /**
- * One company or person a source names, which stored record it is, and, from a lookup job or a streaming lookup, the hidden shell record filed for it when it is new.
+ * One company or person a source names, which stored record it is, and, from a standard article job or streaming lookup, the hidden shell record filed when it is new. Bulk lookup only identifies names and files no shells.
  *
  * @openapiSchema LookupJobMention
  * @endpoint GET /v1/lookup-jobs/{jobId}

package/dist/lookup/job-mutation.d.ts

@@ -14,7 +14,7 @@ declare const LookupJobMutationSchemaDefinition: z.ZodObject<{
 }, z.core.$strip>;
 type LookupJobMutationDefinition = z.infer<typeof LookupJobMutationSchemaDefinition>;
 /**
- * The article whose companies and people a lookup job identifies. Send sourceUrl, sourceNewsId, or both; POST /v1/lookup-mentions also takes mention instead.
+ * The article whose companies and people a lookup identifies. Send sourceUrl, sourceNewsId, or both; lookup-only bulk jobs and POST /v1/lookup-mentions also accept mention instead.
  *
  * @openapiSchema LookupJobMutation
  * @endpoint GET /v1/lookup-jobs/{jobId}

package/dist/lookup/job-mutation.js

@@ -2,7 +2,7 @@
 import { z } from "zod/v4";
 import { LookupMentionSchema } from "./mention.js";
 const LookupJobMutationSchemaDefinition = z.object({
-    /** POST /v1/lookup-mentions only: the companies and people a caller already read from a page or screenshot it keeps on its device, identified without either being sent. Send it alone, without sourceUrl, sourceNewsId, or a file. Any signed-in user may send it, with or without a plan. */
+    /** Companies and people the caller already read, identified without sending the page or screenshot. Send them alone, without an article or file. On lookup jobs, maxNames is required and no shell records or enrichment are scheduled. */
     mention: z.array(LookupMentionSchema).optional(),
     /** aVenture news id of the article; an id that names no stored article is an error. */
     sourceNewsId: z.int().nullish(),
@@ -10,7 +10,7 @@ const LookupJobMutationSchemaDefinition = z.object({
     sourceUrl: z.string().max(2000).nullish(),
 });
 /**
- * The article whose companies and people a lookup job identifies. Send sourceUrl, sourceNewsId, or both; POST /v1/lookup-mentions also takes mention instead.
+ * The article whose companies and people a lookup identifies. Send sourceUrl, sourceNewsId, or both; lookup-only bulk jobs and POST /v1/lookup-mentions also accept mention instead.
  *
  * @openapiSchema LookupJobMutation
  * @endpoint GET /v1/lookup-jobs/{jobId}

package/dist/lookup/job.d.ts

@@ -3,6 +3,8 @@ declare const LookupJobSchemaDefinition: z.ZodObject<{
     createdAt: z.ZodISODateTime;
     failureReason: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     jobId: z.ZodUUID;
+    limitReached: z.ZodBoolean;
+    maxNames: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
     mention: z.ZodArray<z.ZodType<{
         enrichmentRunId?: string | null | undefined;
         entity: {
@@ -1204,6 +1206,8 @@ declare const LookupJobSchemaDefinition: z.ZodObject<{
         } | null | undefined;
         shellDetail?: string | null | undefined;
     }, unknown>>>;
+    namesFound: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
+    namesProcessed: z.ZodInt;
     source: z.ZodType<{
         mention?: {
             name: string;
@@ -1233,7 +1237,7 @@ declare const LookupJobSchemaDefinition: z.ZodObject<{
 }, z.core.$strip>;
 type LookupJobDefinition = z.infer<typeof LookupJobSchemaDefinition>;
 /**
- * An async lookup job's state and, once COMPLETED, every company and person the article names, each identified against stored records.
+ * An async lookup job's state and, once COMPLETED, identified companies and people from its article or supplied names.
  *
  * @openapiSchema LookupJob
  * @endpoint GET /v1/lookup-jobs/{jobId}

package/dist/lookup/job.js

@@ -10,9 +10,17 @@ const LookupJobSchemaDefinition = z.object({
     failureReason: z.string().nullish(),
     /** Lookup job id. */
     jobId: z.uuid(),
-    /** Each distinct company and person the article names; empty until COMPLETED. */
+    /** True when a bulk lookup returned its name bound; more names may remain. False does not prove that extraction found every name on a page. */
+    limitReached: z.boolean(),
+    /** Bulk lookup name bound; absent for legacy article jobs. */
+    maxNames: z.int().nullish(),
+    /** Each identified company and person; bulk results are available while running. */
     mention: z.array(LookupJobMentionSchema),
-    /** The article the job reads. */
+    /** Distinct names found for a bulk lookup; absent on standard jobs. */
+    namesFound: z.int().nullish(),
+    /** Names processed so far, including per-name failures. */
+    namesProcessed: z.int(),
+    /** The article the job reads or names supplied for a bulk lookup. */
     source: LookupJobMutationSchema,
     /** Current job state. */
     state: JobStateSchema,
@@ -20,7 +28,7 @@ const LookupJobSchemaDefinition = z.object({
     updatedAt: z.iso.datetime({ offset: true }),
 });
 /**
- * An async lookup job's state and, once COMPLETED, every company and person the article names, each identified against stored records.
+ * An async lookup job's state and, once COMPLETED, identified companies and people from its article or supplied names.
  *
  * @openapiSchema LookupJob
  * @endpoint GET /v1/lookup-jobs/{jobId}

package/package.json

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