@independo/inderun-contracts 0.4.0 → 0.5.0-rc.1

package/src/generated/stream-event.ts

@@ -244,7 +244,7 @@ export type ExecutionProvenanceRouteRejection = {
     [property: string]: unknown;
 }
 
-export type Code = "task_not_supported" | "run_not_supported" | "streaming_not_supported" | "streaming_unavailable" | "privacy_constraint" | "cloud_constraint" | "offline" | "capability_unavailable" | "not_in_model_profile";
+export type Code = "task_not_supported" | "run_not_supported" | "streaming_not_supported" | "streaming_unavailable" | "privacy_constraint" | "cloud_constraint" | "offline" | "capability_unavailable" | "not_in_model_profile" | "input_not_supported" | "output_delivery_not_supported" | "output_format_not_supported" | "locale_not_supported" | "voice_not_available";
 
 export type FinishReason = "stop" | "length" | "cancelled" | "error";
 

package/src/generated/stream-terminal-outcome.ts

@@ -248,7 +248,7 @@ export type ExecutionProvenanceRouteRejection = {
     [property: string]: unknown;
 }
 
-export type Code = "task_not_supported" | "run_not_supported" | "streaming_not_supported" | "streaming_unavailable" | "privacy_constraint" | "cloud_constraint" | "offline" | "capability_unavailable" | "not_in_model_profile";
+export type Code = "task_not_supported" | "run_not_supported" | "streaming_not_supported" | "streaming_unavailable" | "privacy_constraint" | "cloud_constraint" | "offline" | "capability_unavailable" | "not_in_model_profile" | "input_not_supported" | "output_delivery_not_supported" | "output_format_not_supported" | "locale_not_supported" | "voice_not_available";
 
 /**
  * How generation ended, mirroring TaskResult.finishReason for Mode 1: 'stop' (natural end),

package/src/generated/task-result.ts

@@ -177,7 +177,7 @@ export type ExecutionProvenanceRouteRejection = {
     [property: string]: unknown;
 }
 
-export type Code = "task_not_supported" | "run_not_supported" | "streaming_not_supported" | "streaming_unavailable" | "privacy_constraint" | "cloud_constraint" | "offline" | "capability_unavailable" | "not_in_model_profile";
+export type Code = "task_not_supported" | "run_not_supported" | "streaming_not_supported" | "streaming_unavailable" | "privacy_constraint" | "cloud_constraint" | "offline" | "capability_unavailable" | "not_in_model_profile" | "input_not_supported" | "output_delivery_not_supported" | "output_format_not_supported" | "locale_not_supported" | "voice_not_available";
 
 /**
  * Required metadata providing an overview of the execution result and performance metrics.

package/src/index.ts

@@ -12,7 +12,7 @@
  * themselves or the runtime validators.
  */
 
-/** The generated request/response, streaming, routing, and telemetry models. */
+/** The generated request/response, streaming, routing, provider-capability, and telemetry models. */
 export type * from "./generated/index.js";
 
 /** The JSON Schemas those models were generated from, for runtime use. */
@@ -22,6 +22,9 @@ export {
   httpResponseSchema,
   inderunErrorSchema,
   modelPackageSchema,
+  providerCapabilitySnapshotSchema,
+  providerDescriptorSchema,
+  providerDynamicCapabilitiesSchema,
   routePlanSchema,
   routePlannerInputSchema,
   streamEventSchema,
@@ -42,6 +45,9 @@ export {
   getHttpResponseValidationIssues,
   getIndeRunErrorValidationIssues,
   getModelPackageValidationIssues,
+  getProviderCapabilitySnapshotValidationIssues,
+  getProviderDescriptorValidationIssues,
+  getProviderDynamicCapabilitiesValidationIssues,
   getRoutePlanValidationIssues,
   getRoutePlannerInputValidationIssues,
   getStreamEventValidationIssues,
@@ -55,6 +61,9 @@ export {
   validateHttpResponse,
   validateIndeRunError,
   validateModelPackage,
+  validateProviderCapabilitySnapshot,
+  validateProviderDescriptor,
+  validateProviderDynamicCapabilities,
   validateRoutePlan,
   validateRoutePlannerInput,
   validateStreamEvent,
@@ -70,10 +79,13 @@ export {
  * and the routing input/output shapes under the names the engines use.
  */
 export type {
+  CancelSemantics,
   FinishReason,
   IndeRunErrorClass,
   ModelPackageFormat,
   ModelSourceType,
+  ProviderTransport,
+  ProviderType,
   SchemaVersion,
   SharedRoutePlan,
   SharedRoutePlannerInput,

package/src/types.ts

@@ -1,6 +1,7 @@
 import type {
   IndeRunError,
   ModelPackage,
+  ProviderDescriptor,
   RoutePlan,
   RoutePlannerInput,
   TaskRequest,
@@ -30,3 +31,9 @@ export type RoutingPreferences = NonNullable<TaskRequest["preferences"]>;
 export type ModelPackageFormat = ModelPackage["format"];
 /** How a model package's files are supplied to a provider (`registry`, `bundled`, ...). */
 export type ModelSourceType = NonNullable<ModelPackage["source"]>["sourceType"];
+/** Execution placement a provider declares (`local`, `edge`, `cloud`). */
+export type ProviderType = ProviderDescriptor["type"];
+/** Cancellation guarantee a provider declares (`hard`, `soft`, `none`). */
+export type CancelSemantics = ProviderDescriptor["cancel"];
+/** How the engine reaches a provider (`in_process`, `system_service`, `http`, ...). */
+export type ProviderTransport = ProviderDescriptor["transport"];

package/src/validators.ts

@@ -6,6 +6,9 @@ import type { IndeRunError } from "./generated/inderun-error.js";
 import type { HttpRequest } from "./generated/http-request.js";
 import type { HttpResponse } from "./generated/http-response.js";
 import type { ModelPackage } from "./generated/model-package.js";
+import type { ProviderCapabilitySnapshot } from "./generated/provider-capability-snapshot.js";
+import type { ProviderDescriptor } from "./generated/provider-descriptor.js";
+import type { ProviderDynamicCapabilities } from "./generated/provider-dynamic-capabilities.js";
 import type { RoutePlan } from "./generated/route-plan.js";
 import type { RoutePlannerInput } from "./generated/route-planner-input.js";
 import {
@@ -14,6 +17,9 @@ import {
   httpResponseSchema,
   inderunErrorSchema,
   modelPackageSchema,
+  providerCapabilitySnapshotSchema,
+  providerDescriptorSchema,
+  providerDynamicCapabilitiesSchema,
   routePlanSchema,
   routePlannerInputSchema,
   streamEventSchema,
@@ -50,6 +56,11 @@ const ajv = new Ajv2020Constructor({
 // Referenced by `$ref` from every schema that carries provenance, so it has to be known
 // to Ajv before any of them compiles. Compiling it registers it under its `$id`.
 const validateExecutionProvenanceSchema = ajv.compile(executionProvenanceSchema);
+// Likewise, the provider descriptor and dynamic capabilities are referenced from the
+// capability snapshot and the route-planner input.
+const validateProviderDescriptorSchema = ajv.compile(providerDescriptorSchema);
+const validateProviderDynamicCapabilitiesSchema = ajv.compile(providerDynamicCapabilitiesSchema);
+const validateProviderCapabilitySnapshotSchema = ajv.compile(providerCapabilitySnapshotSchema);
 const validateTaskRequestSchema = ajv.compile(taskRequestSchema);
 const validateTaskResultSchema = ajv.compile(taskResultSchema);
 const validateIndeRunErrorSchema = ajv.compile(inderunErrorSchema);
@@ -99,6 +110,22 @@ export function validateModelPackage(value: unknown): value is ModelPackage {
   return getModelPackageValidationIssues(value).length === 0;
 }
 
+export function validateProviderDescriptor(value: unknown): value is ProviderDescriptor {
+  return getProviderDescriptorValidationIssues(value).length === 0;
+}
+
+export function validateProviderDynamicCapabilities(
+  value: unknown
+): value is ProviderDynamicCapabilities {
+  return getProviderDynamicCapabilitiesValidationIssues(value).length === 0;
+}
+
+export function validateProviderCapabilitySnapshot(
+  value: unknown
+): value is ProviderCapabilitySnapshot {
+  return getProviderCapabilitySnapshotValidationIssues(value).length === 0;
+}
+
 export function validateStreamRunHandle(value: unknown): value is StreamRunHandle {
   return getStreamRunHandleValidationIssues(value).length === 0;
 }
@@ -170,6 +197,18 @@ export function getModelPackageValidationIssues(value: unknown): ValidationIssue
   });
 }
 
+export function getProviderDescriptorValidationIssues(value: unknown): ValidationIssue[] {
+  return getValidationIssues(validateProviderDescriptorSchema, value);
+}
+
+export function getProviderDynamicCapabilitiesValidationIssues(value: unknown): ValidationIssue[] {
+  return getValidationIssues(validateProviderDynamicCapabilitiesSchema, value);
+}
+
+export function getProviderCapabilitySnapshotValidationIssues(value: unknown): ValidationIssue[] {
+  return getValidationIssues(validateProviderCapabilitySnapshotSchema, value);
+}
+
 export function getStreamRunHandleValidationIssues(value: unknown): ValidationIssue[] {
   return getValidationIssues(validateStreamRunHandleSchema, value);
 }