visual-ai-assertions 0.4.0 → 0.5.0

package/dist/index.d.cts

@@ -1,6 +1,6 @@
 import { z } from 'zod';
 
-/** Supported provider identifiers for configuring `visualAI()`. */
+/** Supported provider identifiers used internally for pricing and provider selection. */
 declare const Provider: {
     readonly ANTHROPIC: "anthropic";
     readonly OPENAI: "openai";
@@ -16,6 +16,8 @@ declare const Model: {
     readonly OpenAI: {
         readonly GPT_5_4: "gpt-5.4";
         readonly GPT_5_4_PRO: "gpt-5.4-pro";
+        readonly GPT_5_4_MINI: "gpt-5.4-mini";
+        readonly GPT_5_4_NANO: "gpt-5.4-nano";
         readonly GPT_5_2: "gpt-5.2";
         readonly GPT_5_MINI: "gpt-5-mini";
     };
@@ -29,11 +31,9 @@ type KnownModelName = (typeof Model.Anthropic)[keyof typeof Model.Anthropic] | (
 /** Default model selection used when a caller omits `config.model`. */
 declare const DEFAULT_MODELS: {
     readonly anthropic: "claude-sonnet-4-6";
-    readonly openai: "gpt-5-mini";
+    readonly openai: "gpt-5.4-mini";
     readonly google: "gemini-3-flash-preview";
 };
-/** List of accepted provider names for validation and public consumption. */
-declare const VALID_PROVIDERS: readonly ProviderName[];
 /** Built-in content checks available through `client.content()`. */
 declare const Content: {
     /** Detects Lorem ipsum, TODO, TBD, and similar placeholder text */
@@ -392,14 +392,12 @@ type ReasoningEffort = "low" | "medium" | "high" | "xhigh";
  * @example
  * ```ts
  * const client = visualAI({
- *   provider: "openai",
  *   model: "gpt-5-mini",
  *   apiKey: process.env.OPENAI_API_KEY,
  * });
  * ```
  */
 interface VisualAIConfig {
-    provider?: ProviderName;
     apiKey?: string;
     model?: string;
     debug?: boolean;
@@ -458,7 +456,7 @@ interface ContentOptions {
  *
  * @example
  * ```ts
- * const client = visualAI({ provider: "openai" });
+ * const client = visualAI({ model: "gpt-5-mini" });
  * const result = await client.check("./tests/fixtures/small.png", "The button is visible");
  * ```
  */
@@ -608,7 +606,7 @@ interface VisualAIClient {
 /**
  * Creates a configured visual AI client.
  *
- * @param config Provider selection and runtime options for subsequent requests.
+ * @param config Model selection and runtime options for subsequent requests.
  * @returns A `VisualAIClient` instance with check, compare, ask, and template helpers.
  * @throws {VisualAIConfigError} When the provider or model configuration is invalid.
  * @throws {VisualAIAuthError} When required API credentials are missing.
@@ -619,7 +617,7 @@ interface VisualAIClient {
  *
  * test("hero loads correctly", async ({ page }) => {
  *   const client = visualAI({
- *     provider: "openai",
+ *     model: "gpt-5-mini",
  *     apiKey: process.env.OPENAI_API_KEY,
  *   });
  *
@@ -836,4 +834,4 @@ declare function assertVisualResult(result: CheckResult, label?: string): void;
  */
 declare function assertVisualCompareResult(result: CompareResult, label?: string): void;
 
-export { Accessibility, type AccessibilityCheckName, type AccessibilityOptions, type AskOptions, type AskResult, AskResultSchema, type ChangeEntry, ChangeEntrySchema, type CheckOptions, type CheckResult, CheckResultSchema, type CompareOptions, type CompareResult, CompareResultSchema, type Confidence, ConfidenceSchema, Content, type ContentCheckName, type ContentOptions, DEFAULT_MODELS, type DiffImageResult, type ElementsVisibilityOptions, type ImageInput, type Issue, type IssueCategory, IssueCategorySchema, type IssuePriority, IssuePrioritySchema, IssueSchema, type KnownModelName, Layout, type LayoutCheckName, type LayoutOptions, Model, type PageLoadOptions, Provider, type ProviderName, type ReasoningEffort, type StatementResult, StatementResultSchema, type SupportedMimeType, type UsageInfo, UsageInfoSchema, VALID_PROVIDERS, VisualAIAssertionError, VisualAIAuthError, type VisualAIClient, type VisualAIConfig, VisualAIConfigError, VisualAIError, type VisualAIErrorCode, VisualAIImageError, type VisualAIKnownError, VisualAIProviderError, VisualAIRateLimitError, VisualAIResponseParseError, assertVisualCompareResult, assertVisualResult, formatCheckResult, formatCompareResult, isVisualAIKnownError, visualAI };
+export { Accessibility, type AccessibilityCheckName, type AccessibilityOptions, type AskOptions, type AskResult, AskResultSchema, type ChangeEntry, ChangeEntrySchema, type CheckOptions, type CheckResult, CheckResultSchema, type CompareOptions, type CompareResult, CompareResultSchema, type Confidence, ConfidenceSchema, Content, type ContentCheckName, type ContentOptions, DEFAULT_MODELS, type DiffImageResult, type ElementsVisibilityOptions, type ImageInput, type Issue, type IssueCategory, IssueCategorySchema, type IssuePriority, IssuePrioritySchema, IssueSchema, type KnownModelName, Layout, type LayoutCheckName, type LayoutOptions, Model, type PageLoadOptions, Provider, type ProviderName, type ReasoningEffort, type StatementResult, StatementResultSchema, type SupportedMimeType, type UsageInfo, UsageInfoSchema, VisualAIAssertionError, VisualAIAuthError, type VisualAIClient, type VisualAIConfig, VisualAIConfigError, VisualAIError, type VisualAIErrorCode, VisualAIImageError, type VisualAIKnownError, VisualAIProviderError, VisualAIRateLimitError, VisualAIResponseParseError, assertVisualCompareResult, assertVisualResult, formatCheckResult, formatCompareResult, isVisualAIKnownError, visualAI };

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { z } from 'zod';
 
-/** Supported provider identifiers for configuring `visualAI()`. */
+/** Supported provider identifiers used internally for pricing and provider selection. */
 declare const Provider: {
     readonly ANTHROPIC: "anthropic";
     readonly OPENAI: "openai";
@@ -16,6 +16,8 @@ declare const Model: {
     readonly OpenAI: {
         readonly GPT_5_4: "gpt-5.4";
         readonly GPT_5_4_PRO: "gpt-5.4-pro";
+        readonly GPT_5_4_MINI: "gpt-5.4-mini";
+        readonly GPT_5_4_NANO: "gpt-5.4-nano";
         readonly GPT_5_2: "gpt-5.2";
         readonly GPT_5_MINI: "gpt-5-mini";
     };
@@ -29,11 +31,9 @@ type KnownModelName = (typeof Model.Anthropic)[keyof typeof Model.Anthropic] | (
 /** Default model selection used when a caller omits `config.model`. */
 declare const DEFAULT_MODELS: {
     readonly anthropic: "claude-sonnet-4-6";
-    readonly openai: "gpt-5-mini";
+    readonly openai: "gpt-5.4-mini";
     readonly google: "gemini-3-flash-preview";
 };
-/** List of accepted provider names for validation and public consumption. */
-declare const VALID_PROVIDERS: readonly ProviderName[];
 /** Built-in content checks available through `client.content()`. */
 declare const Content: {
     /** Detects Lorem ipsum, TODO, TBD, and similar placeholder text */
@@ -392,14 +392,12 @@ type ReasoningEffort = "low" | "medium" | "high" | "xhigh";
  * @example
  * ```ts
  * const client = visualAI({
- *   provider: "openai",
  *   model: "gpt-5-mini",
  *   apiKey: process.env.OPENAI_API_KEY,
  * });
  * ```
  */
 interface VisualAIConfig {
-    provider?: ProviderName;
     apiKey?: string;
     model?: string;
     debug?: boolean;
@@ -458,7 +456,7 @@ interface ContentOptions {
  *
  * @example
  * ```ts
- * const client = visualAI({ provider: "openai" });
+ * const client = visualAI({ model: "gpt-5-mini" });
  * const result = await client.check("./tests/fixtures/small.png", "The button is visible");
  * ```
  */
@@ -608,7 +606,7 @@ interface VisualAIClient {
 /**
  * Creates a configured visual AI client.
  *
- * @param config Provider selection and runtime options for subsequent requests.
+ * @param config Model selection and runtime options for subsequent requests.
  * @returns A `VisualAIClient` instance with check, compare, ask, and template helpers.
  * @throws {VisualAIConfigError} When the provider or model configuration is invalid.
  * @throws {VisualAIAuthError} When required API credentials are missing.
@@ -619,7 +617,7 @@ interface VisualAIClient {
  *
  * test("hero loads correctly", async ({ page }) => {
  *   const client = visualAI({
- *     provider: "openai",
+ *     model: "gpt-5-mini",
  *     apiKey: process.env.OPENAI_API_KEY,
  *   });
  *
@@ -836,4 +834,4 @@ declare function assertVisualResult(result: CheckResult, label?: string): void;
  */
 declare function assertVisualCompareResult(result: CompareResult, label?: string): void;
 
-export { Accessibility, type AccessibilityCheckName, type AccessibilityOptions, type AskOptions, type AskResult, AskResultSchema, type ChangeEntry, ChangeEntrySchema, type CheckOptions, type CheckResult, CheckResultSchema, type CompareOptions, type CompareResult, CompareResultSchema, type Confidence, ConfidenceSchema, Content, type ContentCheckName, type ContentOptions, DEFAULT_MODELS, type DiffImageResult, type ElementsVisibilityOptions, type ImageInput, type Issue, type IssueCategory, IssueCategorySchema, type IssuePriority, IssuePrioritySchema, IssueSchema, type KnownModelName, Layout, type LayoutCheckName, type LayoutOptions, Model, type PageLoadOptions, Provider, type ProviderName, type ReasoningEffort, type StatementResult, StatementResultSchema, type SupportedMimeType, type UsageInfo, UsageInfoSchema, VALID_PROVIDERS, VisualAIAssertionError, VisualAIAuthError, type VisualAIClient, type VisualAIConfig, VisualAIConfigError, VisualAIError, type VisualAIErrorCode, VisualAIImageError, type VisualAIKnownError, VisualAIProviderError, VisualAIRateLimitError, VisualAIResponseParseError, assertVisualCompareResult, assertVisualResult, formatCheckResult, formatCompareResult, isVisualAIKnownError, visualAI };
+export { Accessibility, type AccessibilityCheckName, type AccessibilityOptions, type AskOptions, type AskResult, AskResultSchema, type ChangeEntry, ChangeEntrySchema, type CheckOptions, type CheckResult, CheckResultSchema, type CompareOptions, type CompareResult, CompareResultSchema, type Confidence, ConfidenceSchema, Content, type ContentCheckName, type ContentOptions, DEFAULT_MODELS, type DiffImageResult, type ElementsVisibilityOptions, type ImageInput, type Issue, type IssueCategory, IssueCategorySchema, type IssuePriority, IssuePrioritySchema, IssueSchema, type KnownModelName, Layout, type LayoutCheckName, type LayoutOptions, Model, type PageLoadOptions, Provider, type ProviderName, type ReasoningEffort, type StatementResult, StatementResultSchema, type SupportedMimeType, type UsageInfo, UsageInfoSchema, VisualAIAssertionError, VisualAIAuthError, type VisualAIClient, type VisualAIConfig, VisualAIConfigError, VisualAIError, type VisualAIErrorCode, VisualAIImageError, type VisualAIKnownError, VisualAIProviderError, VisualAIRateLimitError, VisualAIResponseParseError, assertVisualCompareResult, assertVisualResult, formatCheckResult, formatCompareResult, isVisualAIKnownError, visualAI };

package/dist/index.js

@@ -13,6 +13,8 @@ var Model = {
   OpenAI: {
     GPT_5_4: "gpt-5.4",
     GPT_5_4_PRO: "gpt-5.4-pro",
+    GPT_5_4_MINI: "gpt-5.4-mini",
+    GPT_5_4_NANO: "gpt-5.4-nano",
     GPT_5_2: "gpt-5.2",
     GPT_5_MINI: "gpt-5-mini"
   },
@@ -23,7 +25,7 @@ var Model = {
 };
 var DEFAULT_MODELS = {
   [Provider.ANTHROPIC]: Model.Anthropic.SONNET_4_6,
-  [Provider.OPENAI]: Model.OpenAI.GPT_5_MINI,
+  [Provider.OPENAI]: Model.OpenAI.GPT_5_4_MINI,
   [Provider.GOOGLE]: Model.Google.GEMINI_3_FLASH_PREVIEW
 };
 var DEFAULT_MAX_TOKENS = 4096;
@@ -660,23 +662,6 @@ function inferProviderFromModel(model) {
   return prefixMatch?.[1];
 }
 function resolveProvider(config) {
-  if (config.provider) {
-    if (!VALID_PROVIDERS.includes(config.provider)) {
-      throw new VisualAIConfigError(
-        `Unknown provider: "${config.provider}". Supported: ${VALID_PROVIDERS.join(", ")}`
-      );
-    }
-    return config.provider;
-  }
-  const envProvider = process.env.VISUAL_AI_PROVIDER;
-  if (envProvider) {
-    if (VALID_PROVIDERS.includes(envProvider)) {
-      return envProvider;
-    }
-    throw new VisualAIConfigError(
-      `Invalid VISUAL_AI_PROVIDER: "${envProvider}". Supported: ${VALID_PROVIDERS.join(", ")}`
-    );
-  }
   const model = config.model ?? process.env.VISUAL_AI_MODEL;
   if (model) {
     const inferred = inferProviderFromModel(model);
@@ -690,7 +675,7 @@ function resolveProvider(config) {
   const detected = apiKeyProviderMap.find(([key]) => process.env[key]);
   if (detected) return detected[1];
   throw new VisualAIConfigError(
-    "No provider specified. Set `provider` in config, `VISUAL_AI_PROVIDER` env variable, or an API key env variable (ANTHROPIC_API_KEY, OPENAI_API_KEY, GOOGLE_API_KEY)."
+    "Cannot determine provider. Set a model name (config or VISUAL_AI_MODEL) or an API key env variable (ANTHROPIC_API_KEY, OPENAI_API_KEY, GOOGLE_API_KEY)."
   );
 }
 function parseBooleanEnv(envName, value) {
@@ -705,12 +690,6 @@ function parseBooleanEnv(envName, value) {
 function resolveConfig(config) {
   const provider = resolveProvider(config);
   const model = config.model ?? process.env.VISUAL_AI_MODEL ?? DEFAULT_MODELS[provider];
-  const modelProvider = inferProviderFromModel(model);
-  if (modelProvider && modelProvider !== provider) {
-    throw new VisualAIConfigError(
-      `Model "${model}" appears to be a ${modelProvider} model, but provider is "${provider}". Either change the provider or use a ${provider}-compatible model.`
-    );
-  }
   return {
     provider,
     apiKey: config.apiKey,
@@ -749,6 +728,14 @@ var PRICING_TABLE = {
     inputPricePerToken: 1.75 / PER_MILLION,
     outputPricePerToken: 14 / PER_MILLION
   },
+  [`${Provider.OPENAI}:${Model.OpenAI.GPT_5_4_MINI}`]: {
+    inputPricePerToken: 0.75 / PER_MILLION,
+    outputPricePerToken: 4.5 / PER_MILLION
+  },
+  [`${Provider.OPENAI}:${Model.OpenAI.GPT_5_4_NANO}`]: {
+    inputPricePerToken: 0.2 / PER_MILLION,
+    outputPricePerToken: 1.25 / PER_MILLION
+  },
   [`${Provider.OPENAI}:${Model.OpenAI.GPT_5_MINI}`]: {
     inputPricePerToken: 0.25 / PER_MILLION,
     outputPricePerToken: 2 / PER_MILLION
@@ -1330,7 +1317,6 @@ export {
   Provider,
   StatementResultSchema,
   UsageInfoSchema,
-  VALID_PROVIDERS,
   VisualAIAssertionError,
   VisualAIAuthError,
   VisualAIConfigError,