@aventurevc/api-schemas 0.8.371 → 0.8.373
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.
- package/dist/entity/sitemap.d.ts +1 -1
- package/dist/entity/sitemap.js +2 -2
- package/dist/lookup/job-mutation.js +1 -1
- package/dist/lookup/job.d.ts +2 -0
- package/dist/lookup/source-kind.d.ts +3 -1
- package/dist/lookup/source-kind.js +2 -2
- package/dist/lookup/source-read.d.ts +3 -1
- package/dist/lookup/source-read.js +1 -1
- package/dist/mention/lookup.d.ts +2 -0
- package/package.json +1 -1
package/dist/entity/sitemap.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { z } from "zod/v4";
|
|
2
2
|
/**
|
|
3
|
-
* Sub-route eligibility GATE for sitemap.xml emission, not a write receipt. Each boolean is true only when the underlying rows EXIST AND every entity that sub-route renders (this entity and any counterpart, e.g. the acquired/acquirer company behind `hasAcquisitions`) currently passes publication visibility (not hidden, on sitemap).
|
|
3
|
+
* Sub-route eligibility GATE for sitemap.xml emission, not a write receipt. Each boolean is true only when the underlying rows EXIST AND every entity that sub-route renders (this entity and any counterpart, e.g. the acquired/acquirer company behind `hasAcquisitions`) currently passes publication visibility (not hidden, on sitemap). Served from the materialized projection `mv_entity_sitemap_url_slots`, which the `sitemap-boundaries-refresh` job rebuilds on `app.materialized-view-refresh.sitemap-boundaries.interval` and which skips write-driven requests within its `min-success-interval` of the last performed refresh. A `false` flag whose qualifying write is newer than that refresh (the `Last-Modified` time that sitemap reads report) is refresh lag that clears on the next performed refresh; polling sooner changes nothing. A `false` flag whose write is older than that refresh is the gate result: an unmet visibility prerequisite -- publish the hidden entity -- confirmed against the owning command-side read.
|
|
4
4
|
*
|
|
5
5
|
* @openapiSchema EntitySitemap
|
|
6
6
|
* @endpoint GET /v1/entities
|
package/dist/entity/sitemap.js
CHANGED
|
@@ -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
|
-
* Sub-route eligibility GATE for sitemap.xml emission, not a write receipt. Each boolean is true only when the underlying rows EXIST AND every entity that sub-route renders (this entity and any counterpart, e.g. the acquired/acquirer company behind `hasAcquisitions`) currently passes publication visibility (not hidden, on sitemap).
|
|
4
|
+
* Sub-route eligibility GATE for sitemap.xml emission, not a write receipt. Each boolean is true only when the underlying rows EXIST AND every entity that sub-route renders (this entity and any counterpart, e.g. the acquired/acquirer company behind `hasAcquisitions`) currently passes publication visibility (not hidden, on sitemap). Served from the materialized projection `mv_entity_sitemap_url_slots`, which the `sitemap-boundaries-refresh` job rebuilds on `app.materialized-view-refresh.sitemap-boundaries.interval` and which skips write-driven requests within its `min-success-interval` of the last performed refresh. A `false` flag whose qualifying write is newer than that refresh (the `Last-Modified` time that sitemap reads report) is refresh lag that clears on the next performed refresh; polling sooner changes nothing. A `false` flag whose write is older than that refresh is the gate result: an unmet visibility prerequisite -- publish the hidden entity -- confirmed against the owning command-side read.
|
|
5
5
|
*
|
|
6
6
|
* @openapiSchema EntitySitemap
|
|
7
7
|
* @endpoint GET /v1/entities
|
|
@@ -53,7 +53,7 @@ import { z } from "zod/v4";
|
|
|
53
53
|
* @contractRole canonical
|
|
54
54
|
*/
|
|
55
55
|
export const EntitySitemapSchema = z.object({
|
|
56
|
-
/** Whether `/companies/<slug>/acquisitions` should be emitted. True only when an acquisition relationship exists AND both the acquired and acquirer entities are publicly visible. A confirmed acquisition relationship row with this flag `false` (or with `entities acquisitions list` returning zero rows) means a counterpart entity is still hidden -- publish it
|
|
56
|
+
/** Whether `/companies/<slug>/acquisitions` should be emitted. True only when an acquisition relationship exists AND both the acquired and acquirer entities are publicly visible. A confirmed acquisition relationship row older than the projection's last refresh with this flag `false` (or with `entities acquisitions list` returning zero rows) means a counterpart entity is still hidden -- publish it; a newer row is refresh lag (see `EntitySitemap`). */
|
|
57
57
|
hasAcquisitions: z.boolean().default(false).optional(),
|
|
58
58
|
/** Whether the profile Analysis sub-route should be emitted. */
|
|
59
59
|
hasAnalysis: z.boolean(),
|
|
@@ -9,7 +9,7 @@ const LookupJobMutationSchemaDefinition = z.object({
|
|
|
9
9
|
mention: z.array(LookupMentionSchema).optional(),
|
|
10
10
|
/** POST /v1/lookup/mentions only: true answers each name with only its name, mentionType, failureReason, and identification status, stage, match, officialUrl, and detail: no entity or person rows and empty candidate and duplicate lists. Defaults to false, the full answer. */
|
|
11
11
|
omitRecords: z.boolean().optional(),
|
|
12
|
-
/** Id of a stored source document whose text is the article; send it alone.
|
|
12
|
+
/** Id of a stored source document whose text is the article; send it alone. A durable source read (Prefer respond-async, source-read) accepts any signed-in user's own captured PDF; a live read needs editing rights. */
|
|
13
13
|
sourceDocumentId: z.uuid().nullish(),
|
|
14
14
|
/** aVenture news id of the article; an id that names no stored article is an error. */
|
|
15
15
|
sourceNewsId: z.int().nullish(),
|
package/dist/lookup/job.d.ts
CHANGED
|
@@ -2314,11 +2314,13 @@ declare const LookupJobSchemaDefinition: z.ZodObject<{
|
|
|
2314
2314
|
faviconUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2315
2315
|
kind: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodEnum<{
|
|
2316
2316
|
ARTICLE: "ARTICLE";
|
|
2317
|
+
DOCUMENT: "DOCUMENT";
|
|
2317
2318
|
POST: "POST";
|
|
2318
2319
|
PROFILE: "PROFILE";
|
|
2319
2320
|
}>, z.ZodString]> & {
|
|
2320
2321
|
enum: {
|
|
2321
2322
|
ARTICLE: "ARTICLE";
|
|
2323
|
+
DOCUMENT: "DOCUMENT";
|
|
2322
2324
|
POST: "POST";
|
|
2323
2325
|
PROFILE: "PROFILE";
|
|
2324
2326
|
};
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { z } from "zod/v4";
|
|
2
2
|
/**
|
|
3
|
-
* What a lookup's source is, so a client names it while it loads: a news article, a LinkedIn or X post,
|
|
3
|
+
* What a lookup's source is, so a client names it while it loads: a news article, a LinkedIn or X post, a supplied profile, or the caller's own captured document (sourceDocumentId). An unknown future kind reads as a generic source.
|
|
4
4
|
*
|
|
5
5
|
* @openapiSchema LookupSourceKind
|
|
6
6
|
* @endpoint GET /v1/lookup-jobs/{jobId}
|
|
@@ -13,11 +13,13 @@ import { z } from "zod/v4";
|
|
|
13
13
|
*/
|
|
14
14
|
export declare const LookupSourceKindSchema: z.ZodUnion<readonly [z.ZodEnum<{
|
|
15
15
|
ARTICLE: "ARTICLE";
|
|
16
|
+
DOCUMENT: "DOCUMENT";
|
|
16
17
|
POST: "POST";
|
|
17
18
|
PROFILE: "PROFILE";
|
|
18
19
|
}>, z.ZodString]> & {
|
|
19
20
|
enum: {
|
|
20
21
|
ARTICLE: "ARTICLE";
|
|
22
|
+
DOCUMENT: "DOCUMENT";
|
|
21
23
|
POST: "POST";
|
|
22
24
|
PROFILE: "PROFILE";
|
|
23
25
|
};
|
|
@@ -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 LookupSourceKindSchemaKnownMembers = z.enum(["ARTICLE", "POST", "PROFILE"]);
|
|
3
|
+
const LookupSourceKindSchemaKnownMembers = z.enum(["ARTICLE", "POST", "PROFILE", "DOCUMENT"]);
|
|
4
4
|
/**
|
|
5
|
-
* What a lookup's source is, so a client names it while it loads: a news article, a LinkedIn or X post,
|
|
5
|
+
* What a lookup's source is, so a client names it while it loads: a news article, a LinkedIn or X post, a supplied profile, or the caller's own captured document (sourceDocumentId). An unknown future kind reads as a generic source.
|
|
6
6
|
*
|
|
7
7
|
* @openapiSchema LookupSourceKind
|
|
8
8
|
* @endpoint GET /v1/lookup-jobs/{jobId}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { z } from "zod/v4";
|
|
2
2
|
/**
|
|
3
|
-
* Source context and honest reading activity for a shared article, post, or
|
|
3
|
+
* Source context and honest reading activity for a shared article, post, profile, or the caller's own captured document.
|
|
4
4
|
*
|
|
5
5
|
* @openapiSchema LookupSourceRead
|
|
6
6
|
* @endpoint GET /v1/lookup-jobs/{jobId}
|
|
@@ -22,11 +22,13 @@ export declare const LookupSourceReadSchema: z.ZodObject<{
|
|
|
22
22
|
faviconUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
23
23
|
kind: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodEnum<{
|
|
24
24
|
ARTICLE: "ARTICLE";
|
|
25
|
+
DOCUMENT: "DOCUMENT";
|
|
25
26
|
POST: "POST";
|
|
26
27
|
PROFILE: "PROFILE";
|
|
27
28
|
}>, z.ZodString]> & {
|
|
28
29
|
enum: {
|
|
29
30
|
ARTICLE: "ARTICLE";
|
|
31
|
+
DOCUMENT: "DOCUMENT";
|
|
30
32
|
POST: "POST";
|
|
31
33
|
PROFILE: "PROFILE";
|
|
32
34
|
};
|
|
@@ -4,7 +4,7 @@ import { JobEnqueueSchema } from "../job/enqueue.js";
|
|
|
4
4
|
import { LookupSourceKindSchema } from "./source-kind.js";
|
|
5
5
|
import { LookupSourceReadPhaseSchema } from "./source-read-phase.js";
|
|
6
6
|
/**
|
|
7
|
-
* Source context and honest reading activity for a shared article, post, or
|
|
7
|
+
* Source context and honest reading activity for a shared article, post, profile, or the caller's own captured document.
|
|
8
8
|
*
|
|
9
9
|
* @openapiSchema LookupSourceRead
|
|
10
10
|
* @endpoint GET /v1/lookup-jobs/{jobId}
|
package/dist/mention/lookup.d.ts
CHANGED
|
@@ -1940,11 +1940,13 @@ declare const MentionLookupSchemaDefinition: z.ZodObject<{
|
|
|
1940
1940
|
faviconUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1941
1941
|
kind: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodEnum<{
|
|
1942
1942
|
ARTICLE: "ARTICLE";
|
|
1943
|
+
DOCUMENT: "DOCUMENT";
|
|
1943
1944
|
POST: "POST";
|
|
1944
1945
|
PROFILE: "PROFILE";
|
|
1945
1946
|
}>, z.ZodString]> & {
|
|
1946
1947
|
enum: {
|
|
1947
1948
|
ARTICLE: "ARTICLE";
|
|
1949
|
+
DOCUMENT: "DOCUMENT";
|
|
1948
1950
|
POST: "POST";
|
|
1949
1951
|
PROFILE: "PROFILE";
|
|
1950
1952
|
};
|