@beignet/core 0.0.47 → 0.0.49

package/src/contracts/schema-shape.ts

@@ -73,3 +73,27 @@ export function formatPathParamsMismatch(args: {
     .filter(Boolean)
     .join("; ");
 }
+
+/** Compare an introspected query schema's fields with its transport fields. */
+export function compareQueryTransportFields(args: {
+  schemaKeys: readonly string[];
+  transportKeys: readonly string[];
+}): boolean {
+  const schemaKeys = [...args.schemaKeys].sort();
+  const transportKeys = [...args.transportKeys].sort();
+  return (
+    schemaKeys.length === transportKeys.length &&
+    schemaKeys.every((key, index) => key === transportKeys[index])
+  );
+}
+
+/** Format a query schema/transport mismatch consistently across consumers. */
+export function formatQueryTransportMismatch(args: {
+  contractName: string;
+  schemaKeys: readonly string[];
+  transportKeys: readonly string[];
+}): string {
+  const schemaKeys = [...args.schemaKeys].sort();
+  const transportKeys = [...args.transportKeys].sort();
+  return `Query transport fields for contract "${args.contractName}" must match its query schema fields (schema: ${schemaKeys.join(", ") || "none"}; transport: ${transportKeys.join(", ") || "none"}).`;
+}

package/src/contracts/types.ts

@@ -2,6 +2,7 @@ import type { StandardSchemaV1 } from "@standard-schema/spec";
 import type { IdempotencyMeta } from "../idempotency/index.js";
 import type { ContractDeprecationMeta } from "./lifecycle.js";
 import type { OpenAPIOperationMeta } from "./openapi-meta.js";
+import type { QueryTransport } from "./query-transport.js";
 import type { RateLimitMeta } from "./rate-limit.js";
 
 /**
@@ -343,6 +344,10 @@ export type HttpContractConfig<
    * Query parameter schema.
    */
   query: TQuery;
+  /**
+   * Deterministic HTTP encoding for the query schema.
+   */
+  queryTransport: QueryTransport | null;
   /**
    * Request header schema or schemas.
    */

package/src/openapi/index.ts

@@ -11,6 +11,8 @@ import {
   getContractHeaderSchemas,
   methodSupportsRequestBody,
   parsePathTemplate,
+  type QueryFieldTransport,
+  queryTransportSchema,
   resolveContract,
   STANDARD_ERROR_RESPONSE_SCHEMA,
 } from "../contracts/index.js";
@@ -20,7 +22,9 @@ import {
 } from "../contracts/lifecycle.js";
 import {
   comparePathParamsToTemplate,
+  compareQueryTransportFields,
   formatPathParamsMismatch,
+  formatQueryTransportMismatch,
 } from "../contracts/schema-shape.js";
 import {
   createZodIntrospector,
@@ -157,6 +161,21 @@ export interface ParameterObject {
    * Parameter schema.
    */
   schema?: SchemaObject | ReferenceObject;
+  /**
+   * OpenAPI parameter serialization style.
+   */
+  style?:
+    | "form"
+    | "simple"
+    | "matrix"
+    | "label"
+    | "spaceDelimited"
+    | "pipeDelimited"
+    | "deepObject";
+  /**
+   * Whether arrays and objects are expanded into separate parameter values.
+   */
+  explode?: boolean;
   /**
    * Parameter description.
    */
@@ -627,12 +646,36 @@ function addQueryParams(
   state: GeneratorState,
 ): void {
   if (!contract.query) return;
+  const transport = contract.queryTransport;
+  if (!transport) {
+    throw new Error(
+      `Contract "${contract.name}" declares a query schema without a query transport.`,
+    );
+  }
 
   const shape = state.introspector.getShape(contract.query);
-  if (!shape) return;
+  if (!shape) {
+    throw new Error(
+      `Unable to inspect query schema for contract "${contract.name}". Pass a schemaIntrospector that can read its fields so OpenAPI requiredness and constraints remain aligned with the declared query transport.`,
+    );
+  }
 
-  for (const key of Object.keys(shape)) {
+  const schemaKeys = Object.keys(shape);
+  const transportKeys = Object.keys(transport.fields);
+  if (!compareQueryTransportFields({ schemaKeys, transportKeys })) {
+    throw new Error(
+      formatQueryTransportMismatch({
+        contractName: contract.name,
+        schemaKeys,
+        transportKeys,
+      }),
+    );
+  }
+
+  for (const key of Object.keys(transport.fields)) {
     const originalField = shape[key];
+    const fieldTransport = transport.fields[key];
+    if (!originalField || !fieldTransport) continue;
     const optional = state.introspector.isOptional(originalField);
 
     const field = originalField;
@@ -644,6 +687,7 @@ function addQueryParams(
       state,
       "input",
     );
+    applyQueryTransportSchema(paramSchemaRef, fieldTransport, state);
 
     const param: ParameterObject = {
       name: key,
@@ -651,12 +695,92 @@ function addQueryParams(
       required: !optional,
       schema: paramSchemaRef,
       description,
+      style: fieldTransport.kind === "deep-object" ? "deepObject" : "form",
+      explode: true,
     };
 
     addParameter(operation, param);
   }
 }
 
+function applyQueryTransportSchema(
+  schema: SchemaObject | ReferenceObject,
+  transport: QueryFieldTransport,
+  state: GeneratorState,
+): void {
+  if (!("$ref" in schema) || typeof schema.$ref !== "string") return;
+  const prefix = "#/components/schemas/";
+  if (!schema.$ref.startsWith(prefix)) return;
+  const name = schema.$ref.slice(prefix.length);
+  const converted = state.components.schemas?.[name];
+  if (!converted || !state.components.schemas) return;
+  state.components.schemas[name] = mergeQueryTransportSchema(
+    converted,
+    transport,
+  );
+}
+
+function mergeQueryTransportSchema(
+  converted: SchemaObject,
+  transport: QueryFieldTransport,
+): SchemaObject {
+  const declared = queryTransportSchema(transport);
+  const merged: SchemaObject = {
+    ...converted,
+    type: declared.type,
+  };
+  if (declared.format) merged.format = declared.format;
+  if (transport.kind === "integer") {
+    merged.minimum = Math.max(
+      typeof converted.minimum === "number"
+        ? converted.minimum
+        : Number.MIN_SAFE_INTEGER,
+      Number.MIN_SAFE_INTEGER,
+    );
+    merged.maximum = Math.min(
+      typeof converted.maximum === "number"
+        ? converted.maximum
+        : Number.MAX_SAFE_INTEGER,
+      Number.MAX_SAFE_INTEGER,
+    );
+  }
+  if (declared["x-beignet-empty-query"]) {
+    merged["x-beignet-empty-query"] = declared["x-beignet-empty-query"];
+  }
+
+  if (transport.kind === "array") {
+    const convertedItems =
+      typeof converted.items === "object" && converted.items !== null
+        ? (converted.items as SchemaObject)
+        : {};
+    merged.items = mergeQueryTransportSchema(convertedItems, transport.item);
+  }
+
+  if (transport.kind === "deep-object") {
+    const convertedProperties =
+      typeof converted.properties === "object" && converted.properties !== null
+        ? (converted.properties as Record<string, unknown>)
+        : {};
+    merged.properties = Object.fromEntries(
+      Object.entries(transport.fields).map(([key, field]) => {
+        const convertedProperty = convertedProperties[key];
+        return [
+          key,
+          mergeQueryTransportSchema(
+            typeof convertedProperty === "object" && convertedProperty !== null
+              ? (convertedProperty as SchemaObject)
+              : {},
+            field,
+          ),
+        ];
+      }),
+    );
+    merged.additionalProperties = false;
+  }
+
+  return merged;
+}
+
 /**
  * Add header parameters from contract to operation.
  */

package/src/outbox/index.ts

@@ -555,7 +555,8 @@ export interface DrainOutboxOptions {
    */
   registry: OutboxRegistry;
   /**
-   * Event bus used for event messages.
+   * Event bus used for event messages. Required when the registry contains
+   * events.
    */
   eventBus?: {
     publish<E extends EventPayloadDef>(
@@ -565,7 +566,8 @@ export interface DrainOutboxOptions {
     ): MaybePromise<void>;
   };
   /**
-   * Job dispatcher used for job messages.
+   * Job dispatcher used for job messages. Required when the registry contains
+   * jobs.
    */
   jobs?: JobDispatcherPort;
   /**
@@ -1476,15 +1478,17 @@ async function deliverOutboxMessage(
  * Claim and deliver one batch of outbox messages.
  *
  * This does not loop forever; production workers should call it on their own
- * polling cadence. Event and job messages require matching registry entries.
- * Failed messages are retried with backoff until `maxAttempts`, then
- * dead-lettered.
+ * polling cadence. Event and job messages require matching registry entries
+ * and delivery transports. Required transports are validated before a batch
+ * is claimed. Failed messages are retried with backoff until `maxAttempts`,
+ * then dead-lettered.
  */
 export async function drainOutbox(
   options: DrainOutboxOptions,
 ): Promise<DrainOutboxResult> {
   const batchSize = options.batchSize ?? 100;
   assertPositiveInteger("batchSize", batchSize);
+  assertOutboxDeliveryCapabilities(options);
   const instrumentation = createProviderInstrumentation(
     options.instrumentation,
     {
@@ -1659,6 +1663,23 @@ export async function drainOutbox(
   return result;
 }
 
+function assertOutboxDeliveryCapabilities(options: DrainOutboxOptions): void {
+  const missing: string[] = [];
+
+  if (options.registry.events.size > 0 && !options.eventBus) {
+    missing.push("events require an event bus");
+  }
+  if (options.registry.jobs.size > 0 && !options.jobs) {
+    missing.push("jobs require a job dispatcher");
+  }
+
+  if (missing.length > 0) {
+    throw new OutboxRegistryError(
+      `Cannot drain this outbox registry: ${missing.join("; ")}.`,
+    );
+  }
+}
+
 /**
  * Domain event recorder port re-exported for outbox integrations.
  */

package/src/ports/cache.ts

@@ -3,11 +3,35 @@
  */
 export interface CacheSetOptions {
   /**
-   * Time-to-live in seconds. Omit this for a value that does not expire.
+   * Time-to-live in seconds. Values must be positive safe integers. Omit this
+   * for a value that does not expire.
    */
   ttlSeconds?: number;
 }
 
+/**
+ * Resolve and validate the optional TTL shared by cache adapters.
+ *
+ * @param options - Cache write options.
+ * @returns The positive TTL, or `undefined` for a persistent value.
+ */
+export function resolveCacheTtlSeconds(
+  options?: CacheSetOptions,
+): number | undefined {
+  const ttlSeconds = options?.ttlSeconds;
+  if (ttlSeconds === undefined) {
+    return undefined;
+  }
+
+  if (!Number.isSafeInteger(ttlSeconds) || ttlSeconds <= 0) {
+    throw new RangeError(
+      "Cache ttlSeconds must be a positive safe integer when provided.",
+    );
+  }
+
+  return ttlSeconds;
+}
+
 /**
  * App-facing string cache port.
  *
@@ -54,15 +78,12 @@ type MemoryCacheEntry = {
 };
 
 function resolveExpiresAt(options: CacheSetOptions | undefined): number | null {
-  if (options?.ttlSeconds == null) {
+  const ttlSeconds = resolveCacheTtlSeconds(options);
+  if (ttlSeconds === undefined) {
     return null;
   }
 
-  if (options.ttlSeconds <= 0) {
-    return Date.now();
-  }
-
-  return Date.now() + options.ttlSeconds * 1000;
+  return Math.min(Number.MAX_SAFE_INTEGER, Date.now() + ttlSeconds * 1000);
 }
 
 function isExpired(entry: MemoryCacheEntry): boolean {
@@ -120,6 +141,7 @@ export function createMemoryCache(
       return (await getFreshEntry(key)) != null;
     },
     async remember(key, factory, options) {
+      resolveCacheTtlSeconds(options);
       const cached = await cache.get(key);
       if (cached != null) {
         return cached;

package/src/ports/index.ts

@@ -483,7 +483,7 @@ export type { CachePort, CacheSetOptions } from "./cache.js";
 /**
  * Cache helper exports.
  */
-export { createMemoryCache } from "./cache.js";
+export { createMemoryCache, resolveCacheTtlSeconds } from "./cache.js";
 /**
  * Clock port exports.
  */

package/src/providers/instrumentation.ts

@@ -502,7 +502,11 @@ export function createProviderInstrumentation(
   function isEnabled(watcher = options.watcher): boolean {
     if (!port) return false;
     if (!watcher) return true;
-    return port.isWatcherEnabled?.(watcher) ?? true;
+    try {
+      return port.isWatcherEnabled?.(watcher) ?? true;
+    } catch {
+      return false;
+    }
   }
 
   function record(event: ProviderInstrumentationEventInput): unknown {
@@ -530,7 +534,16 @@ export function createProviderInstrumentation(
     }
 
     try {
-      return port.record(redacted);
+      const result = port.record(redacted);
+      if (
+        result !== null &&
+        (typeof result === "object" || typeof result === "function") &&
+        "then" in result &&
+        typeof result.then === "function"
+      ) {
+        return Promise.resolve(result).catch(() => undefined);
+      }
+      return result;
     } catch {
       return undefined;
     }

package/src/providers/metadata.ts

@@ -24,6 +24,7 @@ export type ProviderPackageVariantMetadata = {
   displayName?: string;
   env?: readonly string[];
   requiredEnv?: readonly string[];
+  requiredEnvAlternatives?: readonly (readonly string[])[];
   requiredTables?: readonly string[];
   registration?: ProviderPackageRegistrationMetadata;
 };
@@ -34,6 +35,7 @@ export type ProviderPackageMetadata = {
   appPorts?: readonly ProviderPackagePortMetadata[];
   env?: readonly string[];
   requiredEnv?: readonly string[];
+  requiredEnvAlternatives?: readonly (readonly string[])[];
   requiredTables?: readonly string[];
   registration?: ProviderPackageRegistrationMetadata;
   variants?: readonly ProviderPackageVariantMetadata[];
@@ -91,17 +93,43 @@ export function parseProviderPackageMetadata(
   );
   if (requiredEnv !== undefined) {
     metadata.requiredEnv = requiredEnv;
-    const envSet = new Set(env ?? []);
-    for (const envVar of requiredEnv) {
-      if (!envSet.has(envVar)) {
-        issues.push({
-          path: "beignet.provider.requiredEnv",
-          message: `${envVar} must also be listed in beignet.provider.env`,
-        });
-      }
+    validateRequiredEnvMembers(
+      requiredEnv,
+      env,
+      "beignet.provider.requiredEnv",
+      "beignet.provider.env",
+      issues,
+    );
+  }
+
+  const requiredEnvAlternatives = parseStringArrayArray(
+    input.requiredEnvAlternatives,
+    "beignet.provider.requiredEnvAlternatives",
+    issues,
+  );
+  if (requiredEnvAlternatives !== undefined) {
+    metadata.requiredEnvAlternatives = requiredEnvAlternatives;
+    for (const alternative of requiredEnvAlternatives) {
+      validateRequiredEnvMembers(
+        alternative,
+        env,
+        "beignet.provider.requiredEnvAlternatives",
+        "beignet.provider.env",
+        issues,
+      );
     }
   }
 
+  if (
+    input.requiredEnv !== undefined &&
+    input.requiredEnvAlternatives !== undefined
+  ) {
+    issues.push({
+      path: "beignet.provider.requiredEnvAlternatives",
+      message: "must not be set alongside beignet.provider.requiredEnv",
+    });
+  }
+
   const requiredTables = parseStringArray(
     input.requiredTables,
     "beignet.provider.requiredTables",
@@ -137,6 +165,13 @@ export function parseProviderPackageMetadata(
           "must not be set when beignet.provider.variants is present; declare requiredEnv on each variant instead",
       });
     }
+    if (input.requiredEnvAlternatives !== undefined) {
+      issues.push({
+        path: "beignet.provider.requiredEnvAlternatives",
+        message:
+          "must not be set when beignet.provider.variants is present; declare requiredEnvAlternatives on each variant instead",
+      });
+    }
     if (input.registration !== undefined) {
       issues.push({
         path: "beignet.provider.registration",
@@ -186,6 +221,60 @@ function parseStringArray(
   return parsed;
 }
 
+function parseStringArrayArray(
+  value: unknown,
+  path: string,
+  issues: ProviderPackageMetadataIssue[],
+): string[][] | undefined {
+  if (value === undefined) return undefined;
+  if (!Array.isArray(value)) {
+    issues.push({ path, message: "must be an array of string arrays" });
+    return undefined;
+  }
+  if (value.length === 0) {
+    issues.push({
+      path,
+      message: "must include at least one alternative when present",
+    });
+    return undefined;
+  }
+
+  const parsed: string[][] = [];
+  for (const [index, entry] of value.entries()) {
+    const entryPath = `${path}[${index}]`;
+    const alternative = parseStringArray(entry, entryPath, issues);
+    if (alternative === undefined) continue;
+    if (alternative.length === 0) {
+      issues.push({
+        path: entryPath,
+        message: "must include at least one environment variable",
+      });
+      continue;
+    }
+    parsed.push(alternative);
+  }
+
+  return parsed;
+}
+
+function validateRequiredEnvMembers(
+  requiredEnv: readonly string[],
+  env: readonly string[] | undefined,
+  path: string,
+  envPath: string,
+  issues: ProviderPackageMetadataIssue[],
+): void {
+  const envSet = new Set(env ?? []);
+  for (const envVar of requiredEnv) {
+    if (!envSet.has(envVar)) {
+      issues.push({
+        path,
+        message: `${envVar} must also be listed in ${envPath}`,
+      });
+    }
+  }
+}
+
 function parseAppPorts(
   value: unknown,
   issues: ProviderPackageMetadataIssue[],
@@ -280,16 +369,40 @@ function parseVariants(
       issues,
     );
     if (requiredEnv !== undefined) {
-      const envSet = new Set(env ?? []);
-      for (const envVar of requiredEnv) {
-        if (!envSet.has(envVar)) {
-          issues.push({
-            path: `${entryPath}.requiredEnv`,
-            message: `${envVar} must also be listed in ${entryPath}.env`,
-          });
-        }
+      validateRequiredEnvMembers(
+        requiredEnv,
+        env,
+        `${entryPath}.requiredEnv`,
+        `${entryPath}.env`,
+        issues,
+      );
+    }
+
+    const requiredEnvAlternatives = parseStringArrayArray(
+      entry.requiredEnvAlternatives,
+      `${entryPath}.requiredEnvAlternatives`,
+      issues,
+    );
+    if (requiredEnvAlternatives !== undefined) {
+      for (const alternative of requiredEnvAlternatives) {
+        validateRequiredEnvMembers(
+          alternative,
+          env,
+          `${entryPath}.requiredEnvAlternatives`,
+          `${entryPath}.env`,
+          issues,
+        );
       }
     }
+    if (
+      entry.requiredEnv !== undefined &&
+      entry.requiredEnvAlternatives !== undefined
+    ) {
+      issues.push({
+        path: `${entryPath}.requiredEnvAlternatives`,
+        message: `must not be set alongside ${entryPath}.requiredEnv`,
+      });
+    }
 
     const requiredTables = parseStringArray(
       entry.requiredTables,
@@ -308,6 +421,9 @@ function parseVariants(
     if (displayName !== undefined) variant.displayName = displayName;
     if (env !== undefined) variant.env = env;
     if (requiredEnv !== undefined) variant.requiredEnv = requiredEnv;
+    if (requiredEnvAlternatives !== undefined) {
+      variant.requiredEnvAlternatives = requiredEnvAlternatives;
+    }
     if (requiredTables !== undefined) variant.requiredTables = requiredTables;
     if (registration !== undefined) variant.registration = registration;
     parsed.push(variant);