@aventurevc/api-schemas 0.8.7 → 0.8.8

package/README.md

@@ -1,11 +1,30 @@
 # @aventurevc/api-schemas
 
-Zod v4 schemas for the public aVenture API.
+Zod v4 schemas and TypeScript types for the aVenture API: companies, people,
+funding rounds, investors, and news.
 
-Generated from the published aVenture OpenAPI specification; do not edit by hand.
+Calling the API requires an aVenture account. Free and paid plans both work;
+[create an account](https://aventure.vc/sign-up), then create an API key in
+[API key settings](https://aventure.vc/settings/api-keys).
 
 ```bash
-npm install @aventurevc/api-schemas --@aventurevc:registry=https://registry.npmjs.org/
+npm install @aventurevc/api-schemas
 ```
 
-Endpoint reference: https://docs.aventure.vc/api-reference
+## Example
+
+```ts
+import { EntityDetailSchema } from "@aventurevc/api-schemas/entity/detail";
+
+const response = await fetch(
+  "https://api.aventure.vc/v1/entities/lookup-exact?urlDomain=stripe.com",
+  { headers: { Authorization: `Bearer ${process.env.AUTH_TOKEN}` } },
+);
+const stripe = EntityDetailSchema.parse(await response.json());
+console.log(stripe.core.nameBrand);
+```
+
+## Documentation
+
+- [API quickstart](https://docs.aventure.vc/quickstart)
+- [API reference](https://docs.aventure.vc/api-reference)

package/dist/api/key.d.ts

@@ -18,7 +18,7 @@ declare const ApiKeySchemaDefinition: z.ZodObject<{
 }, z.core.$strip>;
 type ApiKeyDefinition = z.infer<typeof ApiKeySchemaDefinition>;
 /**
- * Clerk API-key metadata; never contains the key secret
+ * API key metadata; never contains the key secret
  *
  * @openapiSchema ApiKey
  * @endpoint GET /v1/auth/api-key

package/dist/api/key.js

@@ -7,7 +7,7 @@ const ApiKeySchemaDefinition = z.object({
     description: z.string().nullish(),
     /** Provider expiry timestamp */
     expiresAt: z.iso.datetime({ offset: true }).nullish(),
-    /** Clerk API-key identifier */
+    /** API key identifier */
     id: z.string().regex(/^ak_[0-9A-Fa-f]{32}$/),
     /** Most recent provider-recorded use timestamp */
     lastUsedAt: z.iso.datetime({ offset: true }).nullish(),
@@ -15,17 +15,17 @@ const ApiKeySchemaDefinition = z.object({
     name: z.string(),
     /** Provider revocation explanation */
     revocationReason: z.string().nullish(),
-    /** Clerk scopes assigned to this key */
+    /** Scopes assigned to this key */
     scopes: z.array(z.string()),
     /** Provider-derived current lifecycle state */
     status: z.enum(["ACTIVE", "REVOKED", "EXPIRED"]),
-    /** Owning Clerk user subject */
+    /** Account that owns the key */
     subject: z.string(),
     /** Provider metadata update timestamp */
     updatedAt: z.iso.datetime({ offset: true }),
 });
 /**
- * Clerk API-key metadata; never contains the key secret
+ * API key metadata; never contains the key secret
  *
  * @openapiSchema ApiKey
  * @endpoint GET /v1/auth/api-key

package/dist/auth/provider-catalog.js

@@ -2,7 +2,7 @@
 import { z } from "zod/v4";
 import { AuthClientSchema } from "./client.js";
 const AuthProviderCatalogSchemaDefinition = z.object({
-    /** Clerk publishable key for browser sign-in; absent when the environment has no Clerk instance */
+    /** Publishable key for browser sign-in; absent when browser sign-in is unavailable */
     clerkPublishableKey: z.string().nullish(),
     /** OAuth PKCE client configuration for the CLI; absent until its client configuration is complete */
     oauthClient: AuthClientSchema.nullish(),

package/dist/billing/subscription.d.ts

@@ -186,7 +186,7 @@ declare const BillingSubscriptionSchemaDefinition: z.ZodObject<{
 }, z.core.$strip>;
 type BillingSubscriptionDefinition = z.infer<typeof BillingSubscriptionSchemaDefinition>;
 /**
- * Current Essential, AI Plus, AI Pro, or Unlimited (RBAC operator) subscription and entitlement state.
+ * Current plan (Essential, AI Plus, AI Pro, or Unlimited), subscription status, and monthly usage.
  *
  * @openapiSchema BillingSubscription
  * @endpoint GET /v1/billing/subscription

package/dist/billing/subscription.js

@@ -39,7 +39,7 @@ const BillingSubscriptionSchemaDefinition = z.object({
     tier: z.enum(["ESSENTIAL", "PLUS", "PRO", "UNLIMITED"]),
 });
 /**
- * Current Essential, AI Plus, AI Pro, or Unlimited (RBAC operator) subscription and entitlement state.
+ * Current plan (Essential, AI Plus, AI Pro, or Unlimited), subscription status, and monthly usage.
  *
  * @openapiSchema BillingSubscription
  * @endpoint GET /v1/billing/subscription

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@aventurevc/api-schemas",
-  "version": "0.8.7",
+  "version": "0.8.8",
   "private": false,
-  "description": "Zod v4 schemas for the public aVenture API.",
+  "description": "Zod v4 schemas and TypeScript types for the aVenture API.",
   "license": "Apache-2.0",
   "repository": {
     "type": "git",
@@ -41,7 +41,7 @@
     "zod": "^4.3.6"
   },
   "engines": {
-    "node": ">=24.18.0 <25"
+    "node": ">=24.18.0"
   },
   "scripts": {}
 }