promptopskit 0.2.6 → 0.3.0

package/dist/usagetap/index.d.ts

@@ -0,0 +1,147 @@
+import { a as ProviderRequest } from '../types-CQhlfAnR.js';
+import '../schema-DIOA4OiO.js';
+import 'zod';
+
+type UsageTapReasoningLevel = 'NONE' | 'LOW' | 'MEDIUM' | 'HIGH';
+type UsageTapEntitlementMode = 'off' | 'apply';
+type UsageTapAllowedCapability = 'standard' | 'premium' | 'audio' | 'image' | 'search';
+interface UsageTapAllowed {
+    standard?: boolean;
+    premium?: boolean;
+    audio?: boolean;
+    image?: boolean;
+    search?: boolean;
+    reasoningLevel?: UsageTapReasoningLevel;
+}
+interface UsageTapBeginRequest {
+    customerId: string;
+    feature?: string;
+    tags?: string[];
+    customerName?: string;
+    customerEmail?: string;
+    stripeCustomerId?: string;
+    requested?: Record<string, boolean | string>;
+    idempotencyKey?: string;
+    batch?: boolean;
+    pricingMode?: 'batch' | 'standard';
+}
+interface UsageTapBeginResponse {
+    data: {
+        callId: string;
+        allowed: UsageTapAllowed;
+        entitlementHints?: Record<string, unknown>;
+        subscription?: Record<string, unknown>;
+        plan?: Record<string, unknown>;
+        balances?: Record<string, unknown>;
+        stripeCustomerId?: string | null;
+        [key: string]: unknown;
+    };
+    [key: string]: unknown;
+}
+interface UsageTapErrorPayload {
+    code: string;
+    message: string;
+}
+interface UsageTapEndUsage {
+    modelUsed?: string;
+    inputTokens?: number;
+    cachedInputTokens?: number;
+    responseTokens?: number;
+    reasoningTokens?: number;
+    searches?: number;
+    audio?: number;
+    audioSeconds?: number;
+    isPremium?: boolean;
+    stripeCustomerId?: string;
+    responseStatusCode?: number;
+    batch?: boolean;
+    pricingMode?: 'batch' | 'standard';
+    error?: UsageTapErrorPayload;
+}
+interface UsageTapEndRequest extends UsageTapEndUsage {
+    callId: string;
+}
+interface UsageTapEndResponse {
+    data?: Record<string, unknown>;
+    [key: string]: unknown;
+}
+interface UsageTapClientConfig {
+    apiKey: string;
+    baseUrl?: string;
+    fetch?: typeof globalThis.fetch;
+}
+interface UsageTapRequestInit {
+    signal?: AbortSignal;
+}
+interface UsageTapClient {
+    request<T>(path: string, body: unknown, init?: UsageTapRequestInit): Promise<T>;
+    beginCall(begin: UsageTapBeginRequest, init?: UsageTapRequestInit): Promise<UsageTapBeginResponse>;
+    endCall(end: UsageTapEndRequest, init?: UsageTapRequestInit): Promise<UsageTapEndResponse>;
+}
+interface UsageTapInvokeContext {
+    begin: UsageTapBeginResponse;
+    setUsage: (usage: UsageTapEndUsage) => void;
+    signal?: AbortSignal;
+}
+interface UsageTapInvokeResult<TResult> {
+    result: TResult;
+    usage: UsageTapEndUsage;
+}
+interface UsageTapCallOptions<TResult> {
+    begin: UsageTapBeginRequest;
+    invoke: (context: UsageTapInvokeContext) => Promise<TResult | UsageTapInvokeResult<TResult>>;
+    onError?: (error: unknown) => UsageTapErrorPayload;
+    signal?: AbortSignal;
+}
+interface UsageTapCallResult<TResult> {
+    result: TResult;
+    begin: UsageTapBeginResponse;
+    end: UsageTapEndResponse;
+    effectiveUsage: UsageTapEndUsage;
+}
+interface UsageTapEntitlementOptions {
+    modelTiers?: {
+        standard?: string;
+        premium?: string;
+    };
+    toolEntitlements?: Record<string, UsageTapAllowedCapability>;
+}
+interface UsageTapProviderRunOptions<TResult> extends UsageTapEntitlementOptions {
+    request: ProviderRequest;
+    begin: UsageTapBeginRequest;
+    invoke: (request: ProviderRequest) => Promise<TResult | UsageTapInvokeResult<TResult>>;
+    extractUsage?: (response: TResult) => UsageTapEndUsage;
+    entitlementMode?: UsageTapEntitlementMode;
+    signal?: AbortSignal;
+    onError?: (error: unknown) => UsageTapErrorPayload;
+}
+interface UsageTapProviderRunResult<TResult> {
+    response: TResult;
+    begin: UsageTapBeginResponse;
+    end: UsageTapEndResponse;
+    requestUsed: ProviderRequest;
+    effectiveUsage: UsageTapEndUsage;
+    allowed: UsageTapAllowed;
+}
+
+declare function createUsageTapClient(config: UsageTapClientConfig): UsageTapClient;
+
+declare function defaultUsageTapErrorMapper(error: unknown): UsageTapErrorPayload;
+declare function beginUsageTapCall(client: UsageTapClient, begin: Parameters<UsageTapClient['beginCall']>[0], init?: UsageTapRequestInit): Promise<UsageTapBeginResponse>;
+declare function endUsageTapCall(client: UsageTapClient, end: UsageTapEndRequest, init?: UsageTapRequestInit): Promise<UsageTapEndResponse>;
+declare function withUsageTapCall<TResult>(client: UsageTapClient, options: UsageTapCallOptions<TResult>): Promise<UsageTapCallResult<TResult>>;
+
+declare function applyUsageTapEntitlements(request: ProviderRequest, begin: UsageTapBeginResponse, options?: UsageTapEntitlementOptions): ProviderRequest;
+interface UsageMeta {
+    modelUsed?: string;
+    responseStatusCode?: number;
+}
+declare function extractOpenAIUsage(response: unknown, meta?: UsageMeta): UsageTapEndUsage;
+declare function extractAnthropicUsage(response: unknown, meta?: UsageMeta): UsageTapEndUsage;
+declare function extractGeminiUsage(response: unknown, meta?: UsageMeta): UsageTapEndUsage;
+declare function runOpenAIWithUsageTap<TResult>(client: UsageTapClient, options: UsageTapProviderRunOptions<TResult>): Promise<UsageTapProviderRunResult<TResult>>;
+declare function runOpenRouterWithUsageTap<TResult>(client: UsageTapClient, options: UsageTapProviderRunOptions<TResult>): Promise<UsageTapProviderRunResult<TResult>>;
+declare function runAnthropicWithUsageTap<TResult>(client: UsageTapClient, options: UsageTapProviderRunOptions<TResult>): Promise<UsageTapProviderRunResult<TResult>>;
+declare function runGeminiWithUsageTap<TResult>(client: UsageTapClient, options: UsageTapProviderRunOptions<TResult>): Promise<UsageTapProviderRunResult<TResult>>;
+
+export { type UsageTapAllowed, type UsageTapAllowedCapability, type UsageTapBeginRequest, type UsageTapBeginResponse, type UsageTapCallOptions, type UsageTapCallResult, type UsageTapClient, type UsageTapClientConfig, type UsageTapEndRequest, type UsageTapEndResponse, type UsageTapEndUsage, type UsageTapEntitlementMode, type UsageTapEntitlementOptions, type UsageTapErrorPayload, type UsageTapInvokeContext, type UsageTapInvokeResult, type UsageTapProviderRunOptions, type UsageTapProviderRunResult, type UsageTapReasoningLevel, applyUsageTapEntitlements, beginUsageTapCall, createUsageTapClient, defaultUsageTapErrorMapper, endUsageTapCall, extractAnthropicUsage, extractGeminiUsage, extractOpenAIUsage, runAnthropicWithUsageTap, runGeminiWithUsageTap, runOpenAIWithUsageTap, runOpenRouterWithUsageTap, withUsageTapCall };

package/dist/usagetap/index.js

@@ -0,0 +1,31 @@
+import {
+  applyUsageTapEntitlements,
+  beginUsageTapCall,
+  createUsageTapClient,
+  defaultUsageTapErrorMapper,
+  endUsageTapCall,
+  extractAnthropicUsage,
+  extractGeminiUsage,
+  extractOpenAIUsage,
+  runAnthropicWithUsageTap,
+  runGeminiWithUsageTap,
+  runOpenAIWithUsageTap,
+  runOpenRouterWithUsageTap,
+  withUsageTapCall
+} from "../chunk-HWEVRBKZ.js";
+export {
+  applyUsageTapEntitlements,
+  beginUsageTapCall,
+  createUsageTapClient,
+  defaultUsageTapErrorMapper,
+  endUsageTapCall,
+  extractAnthropicUsage,
+  extractGeminiUsage,
+  extractOpenAIUsage,
+  runAnthropicWithUsageTap,
+  runGeminiWithUsageTap,
+  runOpenAIWithUsageTap,
+  runOpenRouterWithUsageTap,
+  withUsageTapCall
+};
+//# sourceMappingURL=index.js.map

package/dist/usagetap/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "promptopskit",
-  "version": "0.2.6",
+  "version": "0.3.0",
   "description": "Manage prompts, system instructions, tools, and model settings as code",
   "type": "module",
   "bin": {
@@ -30,6 +30,16 @@
         "default": "./dist/testing.cjs"
       }
     },
+    "./usagetap": {
+      "import": {
+        "types": "./dist/usagetap/index.d.ts",
+        "default": "./dist/usagetap/index.js"
+      },
+      "require": {
+        "types": "./dist/usagetap/index.d.cts",
+        "default": "./dist/usagetap/index.cjs"
+      }
+    },
     "./openai": {
       "import": {
         "types": "./dist/providers/openai.d.ts",

package/dist/{schema-DJ7C8Q6y.d.cts → schema-DIOA4OiO.d.cts}

@@ -211,21 +211,21 @@ declare const PromptAssetSchema: z.ZodObject<{
             max_items?: number | undefined;
         }>>;
     }, "strip", z.ZodTypeAny, {
-        history?: {
-            max_items?: number | undefined;
-        } | undefined;
         inputs?: (string | {
             name: string;
             max_size?: number | undefined;
         })[] | undefined;
-    }, {
         history?: {
             max_items?: number | undefined;
         } | undefined;
+    }, {
         inputs?: (string | {
             name: string;
             max_size?: number | undefined;
         })[] | undefined;
+        history?: {
+            max_items?: number | undefined;
+        } | undefined;
     }>>;
     includes: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
     environments: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
@@ -484,14 +484,9 @@ declare const PromptAssetSchema: z.ZodObject<{
 }, "strip", z.ZodTypeAny, {
     id: string;
     schema_version: number;
-    source?: {
-        file_path?: string | undefined;
-        checksum?: string | undefined;
-    } | undefined;
-    provider?: "openai" | "anthropic" | "google" | "gemini" | "openrouter" | "any" | undefined;
     description?: string | undefined;
-    model?: string | undefined;
     includes?: string[] | undefined;
+    model?: string | undefined;
     fallback_models?: string[] | undefined;
     reasoning?: {
         effort?: "low" | "medium" | "high" | undefined;
@@ -514,6 +509,18 @@ declare const PromptAssetSchema: z.ZodObject<{
         description?: string | undefined;
         input_schema?: Record<string, unknown> | undefined;
     })[] | undefined;
+    provider?: "openai" | "anthropic" | "google" | "gemini" | "openrouter" | "any" | undefined;
+    metadata?: {
+        owner?: string | undefined;
+        tags?: string[] | undefined;
+        review_required?: boolean | undefined;
+        stable?: boolean | undefined;
+    } | undefined;
+    sections?: {
+        system_instructions?: string | undefined;
+        prompt_template?: string | undefined;
+        notes?: string | undefined;
+    } | undefined;
     mcp?: {
         servers?: (string | {
             name: string;
@@ -521,13 +528,13 @@ declare const PromptAssetSchema: z.ZodObject<{
         })[] | undefined;
     } | undefined;
     context?: {
-        history?: {
-            max_items?: number | undefined;
-        } | undefined;
         inputs?: (string | {
             name: string;
             max_size?: number | undefined;
         })[] | undefined;
+        history?: {
+            max_items?: number | undefined;
+        } | undefined;
     } | undefined;
     environments?: Record<string, {
         model?: string | undefined;
@@ -579,28 +586,15 @@ declare const PromptAssetSchema: z.ZodObject<{
             input_schema?: Record<string, unknown> | undefined;
         })[] | undefined;
     }> | undefined;
-    metadata?: {
-        owner?: string | undefined;
-        tags?: string[] | undefined;
-        review_required?: boolean | undefined;
-        stable?: boolean | undefined;
-    } | undefined;
-    sections?: {
-        system_instructions?: string | undefined;
-        prompt_template?: string | undefined;
-        notes?: string | undefined;
-    } | undefined;
-}, {
-    id: string;
     source?: {
         file_path?: string | undefined;
         checksum?: string | undefined;
     } | undefined;
-    provider?: "openai" | "anthropic" | "google" | "gemini" | "openrouter" | "any" | undefined;
-    schema_version?: number | undefined;
+}, {
+    id: string;
     description?: string | undefined;
-    model?: string | undefined;
     includes?: string[] | undefined;
+    model?: string | undefined;
     fallback_models?: string[] | undefined;
     reasoning?: {
         effort?: "low" | "medium" | "high" | undefined;
@@ -623,6 +617,19 @@ declare const PromptAssetSchema: z.ZodObject<{
         description?: string | undefined;
         input_schema?: Record<string, unknown> | undefined;
     })[] | undefined;
+    provider?: "openai" | "anthropic" | "google" | "gemini" | "openrouter" | "any" | undefined;
+    metadata?: {
+        owner?: string | undefined;
+        tags?: string[] | undefined;
+        review_required?: boolean | undefined;
+        stable?: boolean | undefined;
+    } | undefined;
+    sections?: {
+        system_instructions?: string | undefined;
+        prompt_template?: string | undefined;
+        notes?: string | undefined;
+    } | undefined;
+    schema_version?: number | undefined;
     mcp?: {
         servers?: (string | {
             name: string;
@@ -630,13 +637,13 @@ declare const PromptAssetSchema: z.ZodObject<{
         })[] | undefined;
     } | undefined;
     context?: {
-        history?: {
-            max_items?: number | undefined;
-        } | undefined;
         inputs?: (string | {
             name: string;
             max_size?: number | undefined;
         })[] | undefined;
+        history?: {
+            max_items?: number | undefined;
+        } | undefined;
     } | undefined;
     environments?: Record<string, {
         model?: string | undefined;
@@ -688,16 +695,9 @@ declare const PromptAssetSchema: z.ZodObject<{
             input_schema?: Record<string, unknown> | undefined;
         })[] | undefined;
     }> | undefined;
-    metadata?: {
-        owner?: string | undefined;
-        tags?: string[] | undefined;
-        review_required?: boolean | undefined;
-        stable?: boolean | undefined;
-    } | undefined;
-    sections?: {
-        system_instructions?: string | undefined;
-        prompt_template?: string | undefined;
-        notes?: string | undefined;
+    source?: {
+        file_path?: string | undefined;
+        checksum?: string | undefined;
     } | undefined;
 }>;
 type PromptAsset = z.infer<typeof PromptAssetSchema>;

package/dist/{schema-DJ7C8Q6y.d.ts → schema-DIOA4OiO.d.ts}

@@ -211,21 +211,21 @@ declare const PromptAssetSchema: z.ZodObject<{
             max_items?: number | undefined;
         }>>;
     }, "strip", z.ZodTypeAny, {
-        history?: {
-            max_items?: number | undefined;
-        } | undefined;
         inputs?: (string | {
             name: string;
             max_size?: number | undefined;
         })[] | undefined;
-    }, {
         history?: {
             max_items?: number | undefined;
         } | undefined;
+    }, {
         inputs?: (string | {
             name: string;
             max_size?: number | undefined;
         })[] | undefined;
+        history?: {
+            max_items?: number | undefined;
+        } | undefined;
     }>>;
     includes: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
     environments: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
@@ -484,14 +484,9 @@ declare const PromptAssetSchema: z.ZodObject<{
 }, "strip", z.ZodTypeAny, {
     id: string;
     schema_version: number;
-    source?: {
-        file_path?: string | undefined;
-        checksum?: string | undefined;
-    } | undefined;
-    provider?: "openai" | "anthropic" | "google" | "gemini" | "openrouter" | "any" | undefined;
     description?: string | undefined;
-    model?: string | undefined;
     includes?: string[] | undefined;
+    model?: string | undefined;
     fallback_models?: string[] | undefined;
     reasoning?: {
         effort?: "low" | "medium" | "high" | undefined;
@@ -514,6 +509,18 @@ declare const PromptAssetSchema: z.ZodObject<{
         description?: string | undefined;
         input_schema?: Record<string, unknown> | undefined;
     })[] | undefined;
+    provider?: "openai" | "anthropic" | "google" | "gemini" | "openrouter" | "any" | undefined;
+    metadata?: {
+        owner?: string | undefined;
+        tags?: string[] | undefined;
+        review_required?: boolean | undefined;
+        stable?: boolean | undefined;
+    } | undefined;
+    sections?: {
+        system_instructions?: string | undefined;
+        prompt_template?: string | undefined;
+        notes?: string | undefined;
+    } | undefined;
     mcp?: {
         servers?: (string | {
             name: string;
@@ -521,13 +528,13 @@ declare const PromptAssetSchema: z.ZodObject<{
         })[] | undefined;
     } | undefined;
     context?: {
-        history?: {
-            max_items?: number | undefined;
-        } | undefined;
         inputs?: (string | {
             name: string;
             max_size?: number | undefined;
         })[] | undefined;
+        history?: {
+            max_items?: number | undefined;
+        } | undefined;
     } | undefined;
     environments?: Record<string, {
         model?: string | undefined;
@@ -579,28 +586,15 @@ declare const PromptAssetSchema: z.ZodObject<{
             input_schema?: Record<string, unknown> | undefined;
         })[] | undefined;
     }> | undefined;
-    metadata?: {
-        owner?: string | undefined;
-        tags?: string[] | undefined;
-        review_required?: boolean | undefined;
-        stable?: boolean | undefined;
-    } | undefined;
-    sections?: {
-        system_instructions?: string | undefined;
-        prompt_template?: string | undefined;
-        notes?: string | undefined;
-    } | undefined;
-}, {
-    id: string;
     source?: {
         file_path?: string | undefined;
         checksum?: string | undefined;
     } | undefined;
-    provider?: "openai" | "anthropic" | "google" | "gemini" | "openrouter" | "any" | undefined;
-    schema_version?: number | undefined;
+}, {
+    id: string;
     description?: string | undefined;
-    model?: string | undefined;
     includes?: string[] | undefined;
+    model?: string | undefined;
     fallback_models?: string[] | undefined;
     reasoning?: {
         effort?: "low" | "medium" | "high" | undefined;
@@ -623,6 +617,19 @@ declare const PromptAssetSchema: z.ZodObject<{
         description?: string | undefined;
         input_schema?: Record<string, unknown> | undefined;
     })[] | undefined;
+    provider?: "openai" | "anthropic" | "google" | "gemini" | "openrouter" | "any" | undefined;
+    metadata?: {
+        owner?: string | undefined;
+        tags?: string[] | undefined;
+        review_required?: boolean | undefined;
+        stable?: boolean | undefined;
+    } | undefined;
+    sections?: {
+        system_instructions?: string | undefined;
+        prompt_template?: string | undefined;
+        notes?: string | undefined;
+    } | undefined;
+    schema_version?: number | undefined;
     mcp?: {
         servers?: (string | {
             name: string;
@@ -630,13 +637,13 @@ declare const PromptAssetSchema: z.ZodObject<{
         })[] | undefined;
     } | undefined;
     context?: {
-        history?: {
-            max_items?: number | undefined;
-        } | undefined;
         inputs?: (string | {
             name: string;
             max_size?: number | undefined;
         })[] | undefined;
+        history?: {
+            max_items?: number | undefined;
+        } | undefined;
     } | undefined;
     environments?: Record<string, {
         model?: string | undefined;
@@ -688,16 +695,9 @@ declare const PromptAssetSchema: z.ZodObject<{
             input_schema?: Record<string, unknown> | undefined;
         })[] | undefined;
     }> | undefined;
-    metadata?: {
-        owner?: string | undefined;
-        tags?: string[] | undefined;
-        review_required?: boolean | undefined;
-        stable?: boolean | undefined;
-    } | undefined;
-    sections?: {
-        system_instructions?: string | undefined;
-        prompt_template?: string | undefined;
-        notes?: string | undefined;
+    source?: {
+        file_path?: string | undefined;
+        checksum?: string | undefined;
     } | undefined;
 }>;
 type PromptAsset = z.infer<typeof PromptAssetSchema>;