@granular-software/sdk 0.4.74 → 0.4.75

package/dist/spend-ZMtzJoMN.d.mts

@@ -0,0 +1,145 @@
+type SpendLineItemType = "llm_tokens" | "granular_session_time" | string;
+type QuotaScopeType = "tenant" | "sandbox" | "permission_profile" | "subject";
+type QuotaPeriod = "hour" | "day" | "week" | "month";
+type QuotaStatus = "active" | "paused" | "archived";
+interface SpendSummary {
+    amountMicros: number;
+    inputTokens: number;
+    outputTokens: number;
+    cachedInputTokens: number;
+    reasoningTokens: number;
+    quantity: number;
+    eventCount: number;
+}
+interface QuotaLineItemFilter {
+    lineItemTypes?: string[];
+    sources?: string[];
+    providers?: string[];
+    models?: string[];
+}
+interface GranularQuotaPolicy {
+    quotaId: string;
+    tenantId: string;
+    scopeType: QuotaScopeType;
+    sandboxId: string | null;
+    permissionProfileId: string | null;
+    subjectId: string | null;
+    period: QuotaPeriod;
+    limitAmountMicros: number;
+    currency: string;
+    lineItemFilter: QuotaLineItemFilter | null;
+    status: QuotaStatus;
+    description: string | null;
+    createdBy: string | null;
+    startsAt: number | null;
+    endsAt: number | null;
+    createdAt: number;
+    updatedAt: number;
+}
+interface GranularQuotaProgress {
+    unlimited: boolean;
+    allowed: boolean;
+    blocked: boolean;
+    policy: GranularQuotaPolicy | null;
+    period: QuotaPeriod | null;
+    periodStart: number | null;
+    periodEnd: number | null;
+    usedAmountMicros: number;
+    limitAmountMicros: number | null;
+    remainingAmountMicros: number | null;
+    percentUsed: number | null;
+    currency: string;
+    summary: SpendSummary;
+}
+
+interface OpenAIModelPricing {
+    provider: "openai";
+    model: string;
+    currency: "USD";
+    inputUsdPerMillion: number;
+    cachedInputUsdPerMillion: number;
+    cacheWriteUsdPerMillion?: number | null;
+    outputUsdPerMillion: number;
+    contextTier?: "short" | "long";
+    longContextThresholdTokens?: number | null;
+    longContextPricing?: {
+        inputUsdPerMillion: number;
+        cachedInputUsdPerMillion: number;
+        cacheWriteUsdPerMillion?: number | null;
+        outputUsdPerMillion: number;
+    };
+    sourceUrl: string;
+    effectiveDate: string;
+}
+interface NormalizedOpenAIUsage {
+    inputTokens: number;
+    cachedInputTokens: number;
+    cacheWriteTokens: number;
+    uncachedInputTokens: number;
+    outputTokens: number;
+    reasoningTokens: number;
+    totalTokens: number;
+}
+interface OpenAITokenSpend {
+    provider: "openai";
+    model: string;
+    inputTokens: number;
+    cachedInputTokens: number;
+    cacheWriteTokens: number;
+    uncachedInputTokens: number;
+    outputTokens: number;
+    reasoningTokens: number;
+    totalTokens: number;
+    amountMicros: number;
+    currency: "USD";
+    inputPricePerMillionMicros: number;
+    cachedInputPricePerMillionMicros: number;
+    cacheWritePricePerMillionMicros: number | null;
+    cacheWriteCostMicros: number;
+    outputPricePerMillionMicros: number;
+    pricingContextTier: "short" | "long";
+    longContextThresholdTokens: number | null;
+    pricingSource: string;
+    pricingEffectiveAt: string;
+    usage: NormalizedOpenAIUsage;
+}
+declare const OPENAI_MODEL_PRICING_USD_PER_MILLION: Record<string, OpenAIModelPricing>;
+declare function getOpenAIModelPricing(model: string, inputTokens?: number): OpenAIModelPricing | null;
+declare function normalizeOpenAIUsage(rawUsage: unknown): NormalizedOpenAIUsage;
+declare function calculateOpenAITokenSpend(model: string, rawUsage: unknown): OpenAITokenSpend | null;
+
+interface GranularSpendContext {
+    tenantId?: string | null;
+    sandboxId?: string | null;
+    environmentId?: string | null;
+    sessionId?: string | null;
+    subjectId?: string | null;
+    permissionProfileId?: string | null;
+    [key: string]: string | null | undefined;
+}
+interface OpenAIUsageSpendEvent extends OpenAITokenSpend {
+    spendEventId?: string;
+    source?: "openai";
+    lineItemType?: "llm_tokens";
+    operation?: string;
+    requestId?: string | null;
+    usageContext?: GranularSpendContext;
+    rawUsage?: unknown;
+}
+interface RecordOpenAIUsageSpendOptions {
+    apiUrl: string;
+    token: string;
+    usage: OpenAIUsageSpendEvent;
+    context?: GranularSpendContext | null;
+    metadata?: Record<string, unknown> | null;
+}
+interface RecordOpenAIUsageSpendResult {
+    spendEventId: string;
+    inserted: boolean;
+    quota: GranularQuotaProgress | null;
+}
+declare function toGranularHttpBase(apiUrl: string): string;
+declare function buildOpenAISpendEventId(usage: Pick<OpenAIUsageSpendEvent, "requestId">, context?: GranularSpendContext): string | undefined;
+declare function recordOpenAIUsageSpend(options: RecordOpenAIUsageSpendOptions): Promise<RecordOpenAIUsageSpendResult>;
+
+export { type GranularSpendContext as G, type NormalizedOpenAIUsage as N, type OpenAIModelPricing as O, type QuotaLineItemFilter as Q, type RecordOpenAIUsageSpendOptions as R, type SpendLineItemType as S, type OpenAITokenSpend as a, OPENAI_MODEL_PRICING_USD_PER_MILLION as b, calculateOpenAITokenSpend as c, type OpenAIUsageSpendEvent as d, type RecordOpenAIUsageSpendResult as e, buildOpenAISpendEventId as f, getOpenAIModelPricing as g, type GranularQuotaPolicy as h, type GranularQuotaProgress as i, type QuotaPeriod as j, type QuotaScopeType as k, type QuotaStatus as l, type SpendSummary as m, normalizeOpenAIUsage as n, recordOpenAIUsageSpend as r, toGranularHttpBase as t };

package/dist/spend-ZMtzJoMN.d.ts

@@ -0,0 +1,145 @@
+type SpendLineItemType = "llm_tokens" | "granular_session_time" | string;
+type QuotaScopeType = "tenant" | "sandbox" | "permission_profile" | "subject";
+type QuotaPeriod = "hour" | "day" | "week" | "month";
+type QuotaStatus = "active" | "paused" | "archived";
+interface SpendSummary {
+    amountMicros: number;
+    inputTokens: number;
+    outputTokens: number;
+    cachedInputTokens: number;
+    reasoningTokens: number;
+    quantity: number;
+    eventCount: number;
+}
+interface QuotaLineItemFilter {
+    lineItemTypes?: string[];
+    sources?: string[];
+    providers?: string[];
+    models?: string[];
+}
+interface GranularQuotaPolicy {
+    quotaId: string;
+    tenantId: string;
+    scopeType: QuotaScopeType;
+    sandboxId: string | null;
+    permissionProfileId: string | null;
+    subjectId: string | null;
+    period: QuotaPeriod;
+    limitAmountMicros: number;
+    currency: string;
+    lineItemFilter: QuotaLineItemFilter | null;
+    status: QuotaStatus;
+    description: string | null;
+    createdBy: string | null;
+    startsAt: number | null;
+    endsAt: number | null;
+    createdAt: number;
+    updatedAt: number;
+}
+interface GranularQuotaProgress {
+    unlimited: boolean;
+    allowed: boolean;
+    blocked: boolean;
+    policy: GranularQuotaPolicy | null;
+    period: QuotaPeriod | null;
+    periodStart: number | null;
+    periodEnd: number | null;
+    usedAmountMicros: number;
+    limitAmountMicros: number | null;
+    remainingAmountMicros: number | null;
+    percentUsed: number | null;
+    currency: string;
+    summary: SpendSummary;
+}
+
+interface OpenAIModelPricing {
+    provider: "openai";
+    model: string;
+    currency: "USD";
+    inputUsdPerMillion: number;
+    cachedInputUsdPerMillion: number;
+    cacheWriteUsdPerMillion?: number | null;
+    outputUsdPerMillion: number;
+    contextTier?: "short" | "long";
+    longContextThresholdTokens?: number | null;
+    longContextPricing?: {
+        inputUsdPerMillion: number;
+        cachedInputUsdPerMillion: number;
+        cacheWriteUsdPerMillion?: number | null;
+        outputUsdPerMillion: number;
+    };
+    sourceUrl: string;
+    effectiveDate: string;
+}
+interface NormalizedOpenAIUsage {
+    inputTokens: number;
+    cachedInputTokens: number;
+    cacheWriteTokens: number;
+    uncachedInputTokens: number;
+    outputTokens: number;
+    reasoningTokens: number;
+    totalTokens: number;
+}
+interface OpenAITokenSpend {
+    provider: "openai";
+    model: string;
+    inputTokens: number;
+    cachedInputTokens: number;
+    cacheWriteTokens: number;
+    uncachedInputTokens: number;
+    outputTokens: number;
+    reasoningTokens: number;
+    totalTokens: number;
+    amountMicros: number;
+    currency: "USD";
+    inputPricePerMillionMicros: number;
+    cachedInputPricePerMillionMicros: number;
+    cacheWritePricePerMillionMicros: number | null;
+    cacheWriteCostMicros: number;
+    outputPricePerMillionMicros: number;
+    pricingContextTier: "short" | "long";
+    longContextThresholdTokens: number | null;
+    pricingSource: string;
+    pricingEffectiveAt: string;
+    usage: NormalizedOpenAIUsage;
+}
+declare const OPENAI_MODEL_PRICING_USD_PER_MILLION: Record<string, OpenAIModelPricing>;
+declare function getOpenAIModelPricing(model: string, inputTokens?: number): OpenAIModelPricing | null;
+declare function normalizeOpenAIUsage(rawUsage: unknown): NormalizedOpenAIUsage;
+declare function calculateOpenAITokenSpend(model: string, rawUsage: unknown): OpenAITokenSpend | null;
+
+interface GranularSpendContext {
+    tenantId?: string | null;
+    sandboxId?: string | null;
+    environmentId?: string | null;
+    sessionId?: string | null;
+    subjectId?: string | null;
+    permissionProfileId?: string | null;
+    [key: string]: string | null | undefined;
+}
+interface OpenAIUsageSpendEvent extends OpenAITokenSpend {
+    spendEventId?: string;
+    source?: "openai";
+    lineItemType?: "llm_tokens";
+    operation?: string;
+    requestId?: string | null;
+    usageContext?: GranularSpendContext;
+    rawUsage?: unknown;
+}
+interface RecordOpenAIUsageSpendOptions {
+    apiUrl: string;
+    token: string;
+    usage: OpenAIUsageSpendEvent;
+    context?: GranularSpendContext | null;
+    metadata?: Record<string, unknown> | null;
+}
+interface RecordOpenAIUsageSpendResult {
+    spendEventId: string;
+    inserted: boolean;
+    quota: GranularQuotaProgress | null;
+}
+declare function toGranularHttpBase(apiUrl: string): string;
+declare function buildOpenAISpendEventId(usage: Pick<OpenAIUsageSpendEvent, "requestId">, context?: GranularSpendContext): string | undefined;
+declare function recordOpenAIUsageSpend(options: RecordOpenAIUsageSpendOptions): Promise<RecordOpenAIUsageSpendResult>;
+
+export { type GranularSpendContext as G, type NormalizedOpenAIUsage as N, type OpenAIModelPricing as O, type QuotaLineItemFilter as Q, type RecordOpenAIUsageSpendOptions as R, type SpendLineItemType as S, type OpenAITokenSpend as a, OPENAI_MODEL_PRICING_USD_PER_MILLION as b, calculateOpenAITokenSpend as c, type OpenAIUsageSpendEvent as d, type RecordOpenAIUsageSpendResult as e, buildOpenAISpendEventId as f, getOpenAIModelPricing as g, type GranularQuotaPolicy as h, type GranularQuotaProgress as i, type QuotaPeriod as j, type QuotaScopeType as k, type QuotaStatus as l, type SpendSummary as m, normalizeOpenAIUsage as n, recordOpenAIUsageSpend as r, toGranularHttpBase as t };

package/dist/spend.d.mts

@@ -1 +1 @@
-export { aI as GranularSpendContext, aJ as OpenAIUsageSpendEvent, aK as RecordOpenAIUsageSpendOptions, aL as RecordOpenAIUsageSpendResult, aN as buildOpenAISpendEventId, aO as recordOpenAIUsageSpend, aM as toGranularHttpBase } from './spend-DBRQOSaj.mjs';
+export { G as GranularSpendContext, d as OpenAIUsageSpendEvent, R as RecordOpenAIUsageSpendOptions, e as RecordOpenAIUsageSpendResult, f as buildOpenAISpendEventId, r as recordOpenAIUsageSpend, t as toGranularHttpBase } from './spend-ZMtzJoMN.mjs';

package/dist/spend.d.ts

@@ -1 +1 @@
-export { aI as GranularSpendContext, aJ as OpenAIUsageSpendEvent, aK as RecordOpenAIUsageSpendOptions, aL as RecordOpenAIUsageSpendResult, aN as buildOpenAISpendEventId, aO as recordOpenAIUsageSpend, aM as toGranularHttpBase } from './spend-DBRQOSaj.js';
+export { G as GranularSpendContext, d as OpenAIUsageSpendEvent, R as RecordOpenAIUsageSpendOptions, e as RecordOpenAIUsageSpendResult, f as buildOpenAISpendEventId, r as recordOpenAIUsageSpend, t as toGranularHttpBase } from './spend-ZMtzJoMN.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@granular-software/sdk",
-  "version": "0.4.74",
+  "version": "0.4.75",
   "description": "TypeScript SDK and CLI for Granular - define, build, and deploy AI sandboxes",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",