@databutton/firebase-types 1.85.24 → 1.85.25

package/lib/types/published/enums.d.ts

@@ -65,6 +65,7 @@ export declare enum CollectionName {
     THREADS = "threads",
     UPGRADE_REQUESTS = "upgrade-requests",
     USAGE_RECORDS = "usage-records",
+    AI_USAGE_RECORDS = "ai-usage-records",
     USER_SEGMENTS = "user-segments",
     VERSIONS = "versions",
     VIEWERS = "viewers",

package/lib/types/published/enums.js

@@ -66,6 +66,7 @@ export var CollectionName;
     CollectionName["THREADS"] = "threads";
     CollectionName["UPGRADE_REQUESTS"] = "upgrade-requests";
     CollectionName["USAGE_RECORDS"] = "usage-records";
+    CollectionName["AI_USAGE_RECORDS"] = "ai-usage-records";
     CollectionName["USER_SEGMENTS"] = "user-segments";
     CollectionName["VERSIONS"] = "versions";
     CollectionName["VIEWERS"] = "viewers";

package/lib/types/published/persisted.d.ts

@@ -1717,6 +1717,7 @@ export interface PublicUsernameRecord {
 }
 export interface CreditTransactionRecord {
     customerId: string;
+    comment?: string | null;
     amountInCents: number;
     createdAt: Timestamp;
     projectId: string | null;
@@ -1950,4 +1951,72 @@ export interface ProjectPlan {
     previewComponentCode: string | null;
     projectTemplateId: string;
 }
+export interface AiUsageRecord {
+    /**
+     * Who the usage should consume credits from.
+     * Usually the project owner
+     */
+    customerId: string;
+    /**
+     * Who performed the action that triggered the usage record
+     * Can be both owner of the project, a collaborator, or someone from support
+     */
+    performedBy: PerformedBy;
+    /**
+     * If the usage is associated with a project
+     * we track it, so customers can see which apps are using most credits
+     */
+    projectId: string | null;
+    /**
+     * Timestamp when the usage was recorded
+     */
+    recordedAt: Timestamp;
+    /**
+     * In case we need to differentiate between different types of usage
+     */
+    type: "agent";
+    /**
+     * Type of prompt used
+     */
+    promptType: "chat" | "one-shot" | "structured-output";
+    /**
+     * Total cost in USD for us
+     */
+    totalCostUsd: number;
+    streak: {
+        /**
+         * Identifier for the streak
+         * Usually set to the user message that triggered the streak
+         */
+        id: string;
+        /**
+         * Number of iterations in the streak
+         */
+        iterations: number;
+    };
+    agent: {
+        id: string;
+        model: {
+            provider: "openai" | "anthropic" | "google";
+            identifier: string;
+        };
+        contextWindow: {
+            name: "low" | "standard" | "high";
+            sizeInTokens: number;
+        };
+    };
+    entries: AiUageRecordEntry[];
+}
+export interface AiUageRecordEntry {
+    costUsd: number;
+    toolCalls: string[];
+    provider: "openai" | "anthropic" | "google" | "morph" | "perplexity";
+    identifier: string;
+    finish_reason: "stop" | "length" | "tool_calls" | "content_filter" | "function_call" | "cancelled_by_user";
+    /**
+     * Usage reported by the provider in their own format.
+     * Only used for debugging purposes and potentially correcting misreporting
+     */
+    rawUsage: object;
+}
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@databutton/firebase-types",
-  "version": "1.85.24",
+  "version": "1.85.25",
   "main": "lib/types/published/index.js",
   "type": "module",
   "engines": {