@aventurevc/api-schemas 0.8.151 → 0.8.153
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/billing/subscription.d.ts +1 -0
- package/dist/billing/subscription.js +2 -0
- package/dist/openapi-component-manifest.js +1 -0
- package/dist/search/search.d.ts +5 -0
- package/dist/search/search.js +5 -2
- package/dist/web/search-provider.d.ts +18 -0
- package/dist/web/search-provider.js +17 -0
- package/dist/web/search.d.ts +2 -0
- package/dist/web/search.js +1 -1
- package/package.json +1 -1
|
@@ -156,6 +156,7 @@ declare const BillingSubscriptionSchemaDefinition: z.ZodObject<{
|
|
|
156
156
|
}, import("../research/allowance-usage.ts").ResearchAllowanceUsageSchemaInput>>;
|
|
157
157
|
cancelAtPeriodEnd: z.ZodBoolean;
|
|
158
158
|
entitled: z.ZodBoolean;
|
|
159
|
+
originalStart: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
|
|
159
160
|
pendingPlan: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
|
|
160
161
|
PLUS_MONTHLY: "PLUS_MONTHLY";
|
|
161
162
|
PLUS_YEARLY: "PLUS_YEARLY";
|
|
@@ -12,6 +12,8 @@ const BillingSubscriptionSchemaDefinition = z.object({
|
|
|
12
12
|
cancelAtPeriodEnd: z.boolean(),
|
|
13
13
|
/** True while the subscription grants its paid tier */
|
|
14
14
|
entitled: z.boolean(),
|
|
15
|
+
/** Original start of the continuing paid subscription; absent when the provider did not supply it */
|
|
16
|
+
originalStart: z.iso.datetime({ offset: true }).nullish(),
|
|
15
17
|
/** Plan a scheduled change moves the subscription to at pendingPlanAt; absent when nothing is scheduled */
|
|
16
18
|
pendingPlan: BillingPlanTypeSchema.nullish(),
|
|
17
19
|
/** When pendingPlan takes effect; absent when nothing is scheduled */
|
|
@@ -966,5 +966,6 @@ export const OPENAPI_COMPONENT_MANIFEST = Object.freeze({
|
|
|
966
966
|
UrlTypeAlias: { modulePath: "url/type-alias", schemaName: "UrlTypeAliasSchema" },
|
|
967
967
|
ValuationType: { modulePath: "valuation/type", schemaName: "ValuationTypeSchema" },
|
|
968
968
|
WebSearch: { modulePath: "web/search", schemaName: "WebSearchSchema" },
|
|
969
|
+
WebSearchProvider: { modulePath: "web/search-provider", schemaName: "WebSearchProviderSchema" },
|
|
969
970
|
});
|
|
970
971
|
//# sourceMappingURL=openapi-component-manifest.js.map
|
package/dist/search/search.d.ts
CHANGED
|
@@ -7,6 +7,11 @@ declare const SearchSchemaDefinition: z.ZodObject<{
|
|
|
7
7
|
deep: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
|
|
8
8
|
deferredAiOverview: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
|
|
9
9
|
language: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
10
|
+
provider: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodEnum<{
|
|
11
|
+
EXA: "EXA";
|
|
12
|
+
EXA_DEEP: "EXA_DEEP";
|
|
13
|
+
SERPAPI: "SERPAPI";
|
|
14
|
+
}>, z.ZodString]>>>;
|
|
10
15
|
region: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
11
16
|
resultLimit: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
|
|
12
17
|
retrievedFor: z.ZodOptional<z.ZodNullable<z.ZodObject<{
|
package/dist/search/search.js
CHANGED
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
import { z } from "zod/v4";
|
|
3
3
|
import { EntityPersonOwnerSchema } from "../entity/person-owner.js";
|
|
4
4
|
import { HarnessRunEnvironmentSchema } from "../harness/run-environment.js";
|
|
5
|
+
import { WebSearchProviderSchema } from "../web/search-provider.js";
|
|
5
6
|
const SearchSchemaDefinition = z.object({
|
|
6
7
|
/** Allow intentional money-like text without a currency marker; prefer --from-file. */
|
|
7
8
|
allowSuspectedShellStrip: z.boolean().nullish(),
|
|
@@ -11,12 +12,14 @@ const SearchSchemaDefinition = z.object({
|
|
|
11
12
|
cacheKey: z.string().nullish(),
|
|
12
13
|
/** Server-selected search catalog revision. */
|
|
13
14
|
catalogRevision: z.int().nullish(),
|
|
14
|
-
/**
|
|
15
|
+
/** Deprecated alias for `provider: EXA_DEEP`; `true` with any other `provider` is refused with 400. */
|
|
15
16
|
deep: z.boolean().default(false).optional(),
|
|
16
|
-
/** Wait in-request for Google's AI Overview when Google defers it to a follow-up request, as it does for most company and person lookups: one extra SerpAPI search per overview not already stored
|
|
17
|
+
/** Wait in-request for Google's AI Overview when Google defers it to a follow-up request, as it does for most company and person lookups: one extra SerpAPI search per overview not already stored. An explicit `true` also reruns a stored search older than SerpAPI's one-hour cache to get a fresh token (its one-minute overview token expired and the cache would return it unchanged). A harness-run credential fetches from a live token only and never reruns a search. Without either, no deferred overview is fetched; one an earlier fetch stored still comes back at no extra cost. A fetch that returns no overview is not retried for six hours. An overview Google returns inline always comes back in `aiOverview` at no extra cost. Exa results never carry one. */
|
|
17
18
|
deferredAiOverview: z.boolean().default(false).optional(),
|
|
18
19
|
/** Search language code */
|
|
19
20
|
language: z.string().nullish(),
|
|
21
|
+
/** Provider to search; omitted keeps the default, SerpAPI. EXA runs Exa's instant search with highlights and never falls back to SerpAPI: an Exa failure answers 503. EXA_DEEP runs Exa's slower, broader deep search (higher recall for market and provider questions, about 3-6 s) and falls back to SerpAPI on an Exa failure. Both Exa providers answer synchronously (`Prefer: respond-async` does not apply), are stored apart from SerpAPI results, and are charged like any search. */
|
|
22
|
+
provider: WebSearchProviderSchema.nullish(),
|
|
20
23
|
/** Search region code */
|
|
21
24
|
region: z.string().nullish(),
|
|
22
25
|
/** Maximum number of normalized results to keep */
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import { z } from "zod/v4";
|
|
2
|
+
/**
|
|
3
|
+
* Upstream web search provider: SERPAPI is Google results through SerpAPI, EXA is Exa's instant search with highlights, and EXA_DEEP is Exa's slower, broader deep search.
|
|
4
|
+
*
|
|
5
|
+
* @openapiSchema WebSearchProvider
|
|
6
|
+
* @endpoint GET /v1/web/searches/jobs/{jobId}
|
|
7
|
+
* @endpoint POST /v1/web/search
|
|
8
|
+
* @usedBySchema SearchSchema
|
|
9
|
+
* @contractShape web.search-provider
|
|
10
|
+
* @contractRole canonical
|
|
11
|
+
*/
|
|
12
|
+
export declare const WebSearchProviderSchema: z.ZodUnion<readonly [z.ZodEnum<{
|
|
13
|
+
EXA: "EXA";
|
|
14
|
+
EXA_DEEP: "EXA_DEEP";
|
|
15
|
+
SERPAPI: "SERPAPI";
|
|
16
|
+
}>, z.ZodString]>;
|
|
17
|
+
export type WebSearchProvider = z.infer<typeof WebSearchProviderSchema>;
|
|
18
|
+
//# sourceMappingURL=search-provider.d.ts.map
|
|
@@ -0,0 +1,17 @@
|
|
|
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
|
+
* Upstream web search provider: SERPAPI is Google results through SerpAPI, EXA is Exa's instant search with highlights, and EXA_DEEP is Exa's slower, broader deep search.
|
|
5
|
+
*
|
|
6
|
+
* @openapiSchema WebSearchProvider
|
|
7
|
+
* @endpoint GET /v1/web/searches/jobs/{jobId}
|
|
8
|
+
* @endpoint POST /v1/web/search
|
|
9
|
+
* @usedBySchema SearchSchema
|
|
10
|
+
* @contractShape web.search-provider
|
|
11
|
+
* @contractRole canonical
|
|
12
|
+
*/
|
|
13
|
+
export const WebSearchProviderSchema = z.union([
|
|
14
|
+
z.enum(["SERPAPI", "EXA", "EXA_DEEP"]),
|
|
15
|
+
z.string(),
|
|
16
|
+
]);
|
|
17
|
+
//# sourceMappingURL=search-provider.js.map
|
package/dist/web/search.d.ts
CHANGED
|
@@ -66,6 +66,7 @@ declare const WebSearchSchemaDefinition: z.ZodObject<{
|
|
|
66
66
|
deep?: boolean | undefined;
|
|
67
67
|
deferredAiOverview?: boolean | undefined;
|
|
68
68
|
language?: string | null | undefined;
|
|
69
|
+
provider?: string | null | undefined;
|
|
69
70
|
region?: string | null | undefined;
|
|
70
71
|
resultLimit?: number | null | undefined;
|
|
71
72
|
retrievedFor?: {
|
|
@@ -84,6 +85,7 @@ declare const WebSearchSchemaDefinition: z.ZodObject<{
|
|
|
84
85
|
deep?: boolean | undefined;
|
|
85
86
|
deferredAiOverview?: boolean | undefined;
|
|
86
87
|
language?: string | null | undefined;
|
|
88
|
+
provider?: string | null | undefined;
|
|
87
89
|
region?: string | null | undefined;
|
|
88
90
|
resultLimit?: number | null | undefined;
|
|
89
91
|
retrievedFor?: {
|
package/dist/web/search.js
CHANGED
|
@@ -5,7 +5,7 @@ import { SearchHitSchema } from "../search/hit.js";
|
|
|
5
5
|
import { SearchSchema } from "../search/search.js";
|
|
6
6
|
import { SourceDocumentListSchema } from "../source/document-list.js";
|
|
7
7
|
const WebSearchSchemaDefinition = z.object({
|
|
8
|
-
/** Google's AI Overview: returned whenever Google answers inline or its deferred overview is stored (fetched
|
|
8
|
+
/** Google's AI Overview: returned whenever Google answers inline or its deferred overview is stored (fetched by this or an earlier search that set `deferredAiOverview`); null when Google produced none or no such fetch stored its deferred overview */
|
|
9
9
|
aiOverview: SearchAiOverviewSchema.nullish(),
|
|
10
10
|
/** Source-document ledger row backing this result */
|
|
11
11
|
document: SourceDocumentListSchema,
|