@awesomate/platform-sdk 0.7.0 → 0.8.0

package/README.md

@@ -79,6 +79,9 @@ const admin = new ServiceClient({
 
 await admin.upsertTenant("dale", { contact_id: 42, display_name: "Dale", plan: "pro" }, `kt:dale:${version}`);
 const minted = await admin.mintKey("dale", { class: "p", name: "social console", allowed_origins: ["https://social.awesomate.ai"] }, "key:dale:console:1");
+// a website chatbot key with its own ceilings: 30 answers/min for the key, 1,000 a month
+// (q and p keys only). The platform answers 429 monthly_cap_exceeded once the month is spent.
+const capped = await admin.mintKey("dale", { class: "p", name: "site chatbot", agent_id, allowed_origins: ["https://dale.example"], per_minute_cap: 30, monthly_answer_cap: 1000 }, "key:dale:chatbot:1");
 // minted.data.key is returned exactly once — hand it to its destination and discard.
 ```
 

package/dist/cjs/types.d.ts

@@ -346,6 +346,8 @@ export type CreateImportBody = {
 export interface TenantLimits {
     chat_per_minute?: number;
     public_chat_per_minute?: number;
+    /** Per-visitor ceiling on p-key answers (hashed connecting address). Default 6. */
+    public_visitor_per_minute?: number;
     session_chat_per_minute?: number;
     max_queued_jobs?: number;
     /** hard storage ceiling, checked at upload time */
@@ -413,6 +415,14 @@ export interface MintKeyBody {
     /** The audience the key serves. p keys are always public (anything else is a 400); q keys
      *  default to private (the owner) and may be minted narrower; omit for the class default. */
     audience?: Audience;
+    /**
+     * This key's own monthly answer ceiling (q and p keys only; others are a 400). Once the
+     * key's metered answers in the current UTC month reach it the platform answers
+     * `429 monthly_cap_exceeded` with `Retry-After` = seconds to the next UTC month.
+     */
+    monthly_answer_cap?: number;
+    /** This key's own per-minute ceiling (q and p only). Only ever narrows the class bucket. */
+    per_minute_cap?: number;
 }
 export interface AgentScope {
     source_ids: string[];
@@ -562,6 +572,9 @@ export interface MintedKey {
     key_prefix: string;
     /** The audience the key serves. Absent on platforms that predate it. */
     audience?: Audience;
+    /** The per-key caps as stored; null when none was set. Absent on older platforms. */
+    monthly_answer_cap?: number | null;
+    per_minute_cap?: number | null;
     /** Plaintext — returned by the platform exactly ONCE. Hand it to its destination and discard. */
     key: string;
 }
@@ -569,6 +582,8 @@ export interface TenantKeyMeta {
     key_id: string;
     key_prefix: string;
     class?: string;
+    monthly_answer_cap?: number | null;
+    per_minute_cap?: number | null;
     scopes?: string[];
     expires_at?: string | null;
 }

package/dist/esm/types.d.ts

@@ -346,6 +346,8 @@ export type CreateImportBody = {
 export interface TenantLimits {
     chat_per_minute?: number;
     public_chat_per_minute?: number;
+    /** Per-visitor ceiling on p-key answers (hashed connecting address). Default 6. */
+    public_visitor_per_minute?: number;
     session_chat_per_minute?: number;
     max_queued_jobs?: number;
     /** hard storage ceiling, checked at upload time */
@@ -413,6 +415,14 @@ export interface MintKeyBody {
     /** The audience the key serves. p keys are always public (anything else is a 400); q keys
      *  default to private (the owner) and may be minted narrower; omit for the class default. */
     audience?: Audience;
+    /**
+     * This key's own monthly answer ceiling (q and p keys only; others are a 400). Once the
+     * key's metered answers in the current UTC month reach it the platform answers
+     * `429 monthly_cap_exceeded` with `Retry-After` = seconds to the next UTC month.
+     */
+    monthly_answer_cap?: number;
+    /** This key's own per-minute ceiling (q and p only). Only ever narrows the class bucket. */
+    per_minute_cap?: number;
 }
 export interface AgentScope {
     source_ids: string[];
@@ -562,6 +572,9 @@ export interface MintedKey {
     key_prefix: string;
     /** The audience the key serves. Absent on platforms that predate it. */
     audience?: Audience;
+    /** The per-key caps as stored; null when none was set. Absent on older platforms. */
+    monthly_answer_cap?: number | null;
+    per_minute_cap?: number | null;
     /** Plaintext — returned by the platform exactly ONCE. Hand it to its destination and discard. */
     key: string;
 }
@@ -569,6 +582,8 @@ export interface TenantKeyMeta {
     key_id: string;
     key_prefix: string;
     class?: string;
+    monthly_answer_cap?: number | null;
+    per_minute_cap?: number | null;
     scopes?: string[];
     expires_at?: string | null;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@awesomate/platform-sdk",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "description": "Typed client for the Awesomate platform /v1 API — tenant API (answer, query, media, ingest, data) and the hub service channel. Browser + Node, no dependencies.",
   "license": "UNLICENSED",
   "repository": {