@contractspec/module.workspace 1.56.1 → 1.58.0

package/dist/types/spec-types.d.ts

@@ -1,343 +1,342 @@
-import { OpKind } from "@contractspec/lib.contracts";
-
-//#region src/types/spec-types.d.ts
-
-type SpecType = 'operation' | 'event' | 'presentation' | 'form' | 'feature' | 'workflow' | 'data-view' | 'migration' | 'telemetry' | 'experiment' | 'app-config' | 'integration' | 'knowledge';
-type PresentationKind = 'web_component' | 'markdown' | 'data';
-type Stability = 'experimental' | 'beta' | 'stable' | 'deprecated';
-type StepType = 'human' | 'automation' | 'decision';
-interface BaseSpecData {
-  name: string;
-  version: string;
-  description: string;
-  owners: string[];
-  tags: string[];
-  stability: Stability;
-}
-interface OperationSpecData extends BaseSpecData {
-  kind: OpKind;
-  goal: string;
-  context: string;
-  hasInput: boolean;
-  hasOutput: boolean;
-  auth: 'anonymous' | 'user' | 'admin';
-  flags: string[];
-  emitsEvents: boolean;
-}
-interface EventSpecData extends BaseSpecData {
-  piiFields: string[];
-}
-interface PresentationSpecData extends BaseSpecData {
-  presentationKind: PresentationKind;
-}
-type FormSpecData = BaseSpecData;
-interface FeatureSpecData extends BaseSpecData {
-  key: string;
-  operations: {
+/**
+ * Core spec type definitions.
+ * Extracted from cli-contractspec/src/types.ts
+ */
+import type { OpKind } from '@contractspec/lib.contracts';
+export type SpecType = 'operation' | 'event' | 'presentation' | 'form' | 'feature' | 'workflow' | 'data-view' | 'migration' | 'telemetry' | 'experiment' | 'app-config' | 'integration' | 'knowledge';
+export type PresentationKind = 'web_component' | 'markdown' | 'data';
+export type Stability = 'experimental' | 'beta' | 'stable' | 'deprecated';
+export type StepType = 'human' | 'automation' | 'decision';
+export interface BaseSpecData {
     name: string;
     version: string;
-  }[];
-  events: {
-    name: string;
-    version: string;
-  }[];
-  presentations: {
-    name: string;
-    version: string;
-  }[];
-}
-interface WorkflowStepData {
-  id: string;
-  label: string;
-  type: StepType;
-  description?: string;
-  operation?: {
-    name: string;
-    version: string;
-  };
-  form?: {
+    description: string;
+    owners: string[];
+    tags: string[];
+    stability: Stability;
+}
+export interface OperationSpecData extends BaseSpecData {
+    kind: OpKind;
+    goal: string;
+    context: string;
+    hasInput: boolean;
+    hasOutput: boolean;
+    auth: 'anonymous' | 'user' | 'admin';
+    flags: string[];
+    emitsEvents: boolean;
+}
+export interface EventSpecData extends BaseSpecData {
+    piiFields: string[];
+}
+export interface PresentationSpecData extends BaseSpecData {
+    presentationKind: PresentationKind;
+}
+export type FormSpecData = BaseSpecData;
+export interface FeatureSpecData extends BaseSpecData {
     key: string;
-    version: string;
-  };
-}
-interface WorkflowTransitionData {
-  from: string;
-  to: string;
-  condition?: string;
-}
-interface WorkflowSpecData extends BaseSpecData {
-  title: string;
-  domain: string;
-  entryStepId?: string;
-  steps: WorkflowStepData[];
-  transitions: WorkflowTransitionData[];
-  policyFlags: string[];
-}
-type DataViewKind = 'list' | 'detail' | 'table' | 'grid';
-interface DataViewFieldData {
-  key: string;
-  label: string;
-  dataPath: string;
-  format?: string;
-  sortable?: boolean;
-  filterable?: boolean;
-}
-interface DataViewSpecData extends BaseSpecData {
-  title: string;
-  domain: string;
-  entity: string;
-  kind: DataViewKind;
-  primaryOperation: {
+    operations: {
+        name: string;
+        version: string;
+    }[];
+    events: {
+        name: string;
+        version: string;
+    }[];
+    presentations: {
+        name: string;
+        version: string;
+    }[];
+}
+export interface WorkflowStepData {
+    id: string;
+    label: string;
+    type: StepType;
+    description?: string;
+    operation?: {
+        name: string;
+        version: string;
+    };
+    form?: {
+        key: string;
+        version: string;
+    };
+}
+export interface WorkflowTransitionData {
+    from: string;
+    to: string;
+    condition?: string;
+}
+export interface WorkflowSpecData extends BaseSpecData {
+    title: string;
+    domain: string;
+    entryStepId?: string;
+    steps: WorkflowStepData[];
+    transitions: WorkflowTransitionData[];
+    policyFlags: string[];
+}
+export type DataViewKind = 'list' | 'detail' | 'table' | 'grid';
+export interface DataViewFieldData {
+    key: string;
+    label: string;
+    dataPath: string;
+    format?: string;
+    sortable?: boolean;
+    filterable?: boolean;
+}
+export interface DataViewSpecData extends BaseSpecData {
+    title: string;
+    domain: string;
+    entity: string;
+    kind: DataViewKind;
+    primaryOperation: {
+        name: string;
+        version: string;
+    };
+    itemOperation?: {
+        name: string;
+        version: string;
+    };
+    fields: DataViewFieldData[];
+    primaryField?: string;
+    secondaryFields?: string[];
+}
+export type TelemetryPrivacy = 'public' | 'internal' | 'pii' | 'sensitive';
+export interface TelemetryPropertyData {
     name: string;
-    version: string;
-  };
-  itemOperation?: {
+    type: 'string' | 'number' | 'boolean' | 'timestamp' | 'json';
+    required?: boolean;
+    pii?: boolean;
+    redact?: boolean;
+    description?: string;
+}
+export interface TelemetryAnomalyRuleData {
+    metric: string;
+    min?: number;
+    max?: number;
+}
+export interface TelemetryEventData {
     name: string;
     version: string;
-  };
-  fields: DataViewFieldData[];
-  primaryField?: string;
-  secondaryFields?: string[];
-}
-type TelemetryPrivacy = 'public' | 'internal' | 'pii' | 'sensitive';
-interface TelemetryPropertyData {
-  name: string;
-  type: 'string' | 'number' | 'boolean' | 'timestamp' | 'json';
-  required?: boolean;
-  pii?: boolean;
-  redact?: boolean;
-  description?: string;
-}
-interface TelemetryAnomalyRuleData {
-  metric: string;
-  min?: number;
-  max?: number;
-}
-interface TelemetryEventData {
-  name: string;
-  version: string;
-  what: string;
-  who?: string;
-  why?: string;
-  privacy: TelemetryPrivacy;
-  properties: TelemetryPropertyData[];
-  retentionDays?: number;
-  retentionPolicy?: 'archive' | 'delete';
-  samplingRate?: number;
-  samplingConditions?: string;
-  anomalyEnabled?: boolean;
-  anomalyMinimumSample?: number;
-  anomalyRules?: TelemetryAnomalyRuleData[];
-  anomalyActions?: ('alert' | 'log' | 'trigger_regen')[];
-  tags?: string[];
-}
-interface TelemetryProviderData {
-  type: 'posthog' | 'segment' | 'opentelemetry' | 'internal';
-  config: string;
-}
-interface TelemetrySpecData extends BaseSpecData {
-  domain: string;
-  defaultRetentionDays?: number;
-  defaultSamplingRate?: number;
-  providers?: TelemetryProviderData[];
-  anomalyEnabled?: boolean;
-  anomalyCheckIntervalMs?: number;
-  events: TelemetryEventData[];
-}
-interface ExperimentVariantOverrideData {
-  type: 'dataView' | 'workflow' | 'theme' | 'policy' | 'presentation';
-  target: string;
-  version?: string;
-}
-interface ExperimentVariantData {
-  id: string;
-  name: string;
-  description?: string;
-  weight?: number;
-  overrides?: ExperimentVariantOverrideData[];
-}
-interface TargetingRuleData {
-  variantId: string;
-  percentage?: number;
-  policy?: {
-    name: string;
+    what: string;
+    who?: string;
+    why?: string;
+    privacy: TelemetryPrivacy;
+    properties: TelemetryPropertyData[];
+    retentionDays?: number;
+    retentionPolicy?: 'archive' | 'delete';
+    samplingRate?: number;
+    samplingConditions?: string;
+    anomalyEnabled?: boolean;
+    anomalyMinimumSample?: number;
+    anomalyRules?: TelemetryAnomalyRuleData[];
+    anomalyActions?: ('alert' | 'log' | 'trigger_regen')[];
+    tags?: string[];
+}
+export interface TelemetryProviderData {
+    type: 'posthog' | 'segment' | 'opentelemetry' | 'internal';
+    config: string;
+}
+export interface TelemetrySpecData extends BaseSpecData {
+    domain: string;
+    defaultRetentionDays?: number;
+    defaultSamplingRate?: number;
+    providers?: TelemetryProviderData[];
+    anomalyEnabled?: boolean;
+    anomalyCheckIntervalMs?: number;
+    events: TelemetryEventData[];
+}
+export interface ExperimentVariantOverrideData {
+    type: 'dataView' | 'workflow' | 'theme' | 'policy' | 'presentation';
+    target: string;
     version?: string;
-  };
-  expression?: string;
-}
-interface RandomAllocationData {
-  type: 'random';
-  salt?: string;
-}
-interface StickyAllocationData {
-  type: 'sticky';
-  attribute: 'userId' | 'organizationId' | 'sessionId';
-  salt?: string;
-}
-interface TargetedAllocationData {
-  type: 'targeted';
-  fallback?: 'control' | 'random';
-  rules: TargetingRuleData[];
-}
-type ExperimentAllocationData = RandomAllocationData | StickyAllocationData | TargetedAllocationData;
-interface ExperimentMetricData {
-  name: string;
-  eventName: string;
-  eventVersion: string;
-  aggregation: 'count' | 'avg' | 'p75' | 'p90' | 'p95' | 'p99';
-  target?: string;
-}
-interface ExperimentSpecData extends BaseSpecData {
-  domain: string;
-  controlVariant: string;
-  variants: ExperimentVariantData[];
-  allocation: ExperimentAllocationData;
-  successMetrics?: ExperimentMetricData[];
-}
-interface AppConfigMappingData {
-  slot: string;
-  name: string;
-  version?: string;
-}
-interface AppConfigFeatureFlagData {
-  key: string;
-  enabled: boolean;
-  variant?: string;
-  description?: string;
-}
-interface AppRouteConfigData {
-  path: string;
-  label?: string;
-  dataView?: string;
-  workflow?: string;
-  guardName?: string;
-  guardVersion?: string | number;
-  featureFlag?: string;
-  experimentName?: string;
-  experimentVersion?: string | number;
-}
-interface AppBlueprintSpecData extends BaseSpecData {
-  title: string;
-  domain: string;
-  appId: string;
-  capabilitiesEnabled: string[];
-  capabilitiesDisabled: string[];
-  featureIncludes: string[];
-  featureExcludes: string[];
-  dataViews: AppConfigMappingData[];
-  workflows: AppConfigMappingData[];
-  policyRefs: {
-    name: string;
-    version?: string;
-  }[];
-  theme?: {
-    name: string;
-    version: string;
-  };
-  themeFallbacks: {
+}
+export interface ExperimentVariantData {
+    id: string;
     name: string;
-    version: string;
-  }[];
-  telemetry?: {
+    description?: string;
+    weight?: number;
+    overrides?: ExperimentVariantOverrideData[];
+}
+export interface TargetingRuleData {
+    variantId: string;
+    percentage?: number;
+    policy?: {
+        name: string;
+        version?: string;
+    };
+    expression?: string;
+}
+export interface RandomAllocationData {
+    type: 'random';
+    salt?: string;
+}
+export interface StickyAllocationData {
+    type: 'sticky';
+    attribute: 'userId' | 'organizationId' | 'sessionId';
+    salt?: string;
+}
+export interface TargetedAllocationData {
+    type: 'targeted';
+    fallback?: 'control' | 'random';
+    rules: TargetingRuleData[];
+}
+export type ExperimentAllocationData = RandomAllocationData | StickyAllocationData | TargetedAllocationData;
+export interface ExperimentMetricData {
     name: string;
-    version?: string;
-  };
-  activeExperiments: {
+    eventName: string;
+    eventVersion: string;
+    aggregation: 'count' | 'avg' | 'p75' | 'p90' | 'p95' | 'p99';
+    target?: string;
+}
+export interface ExperimentSpecData extends BaseSpecData {
+    domain: string;
+    controlVariant: string;
+    variants: ExperimentVariantData[];
+    allocation: ExperimentAllocationData;
+    successMetrics?: ExperimentMetricData[];
+}
+export interface AppConfigMappingData {
+    slot: string;
     name: string;
     version?: string;
-  }[];
-  pausedExperiments: {
-    name: string;
+}
+export interface AppConfigFeatureFlagData {
+    key: string;
+    enabled: boolean;
+    variant?: string;
+    description?: string;
+}
+export interface AppRouteConfigData {
+    path: string;
+    label?: string;
+    dataView?: string;
+    workflow?: string;
+    guardName?: string;
+    guardVersion?: string | number;
+    featureFlag?: string;
+    experimentName?: string;
+    experimentVersion?: string | number;
+}
+export interface AppBlueprintSpecData extends BaseSpecData {
+    title: string;
+    domain: string;
+    appId: string;
+    capabilitiesEnabled: string[];
+    capabilitiesDisabled: string[];
+    featureIncludes: string[];
+    featureExcludes: string[];
+    dataViews: AppConfigMappingData[];
+    workflows: AppConfigMappingData[];
+    policyRefs: {
+        name: string;
+        version?: string;
+    }[];
+    theme?: {
+        name: string;
+        version: string;
+    };
+    themeFallbacks: {
+        name: string;
+        version: string;
+    }[];
+    telemetry?: {
+        name: string;
+        version?: string;
+    };
+    activeExperiments: {
+        name: string;
+        version?: string;
+    }[];
+    pausedExperiments: {
+        name: string;
+        version?: string;
+    }[];
+    featureFlags: AppConfigFeatureFlagData[];
+    routes: AppRouteConfigData[];
+    notes?: string;
+}
+export type MigrationStepKind = 'schema' | 'data' | 'validation';
+export interface MigrationStepData {
+    kind: MigrationStepKind;
+    description?: string;
+    sql?: string;
+    script?: string;
+    assertion?: string;
+    timeoutMs?: number;
+    retries?: number;
+    preChecks?: {
+        description: string;
+        expression: string;
+    }[];
+    postChecks?: {
+        description: string;
+        expression: string;
+    }[];
+}
+export interface MigrationSpecData extends BaseSpecData {
+    title: string;
+    domain: string;
+    dependencies: string[];
+    up: MigrationStepData[];
+    down?: MigrationStepData[];
+}
+export type IntegrationCategoryData = 'payments' | 'email' | 'calendar' | 'sms' | 'ai-llm' | 'ai-voice' | 'analytics' | 'speech-to-text' | 'vector-db' | 'storage' | 'accounting' | 'crm' | 'helpdesk' | 'project-management' | 'open-banking' | 'database' | 'custom';
+export type IntegrationConfigFieldType = 'string' | 'number' | 'boolean';
+export type IntegrationOwnershipModeData = 'managed' | 'byok';
+export type IntegrationHealthCheckMethod = 'ping' | 'list' | 'custom';
+export interface IntegrationCapabilityRefData {
+    key: string;
+    version: string;
+}
+export interface IntegrationCapabilityRequirementData {
+    key: string;
     version?: string;
-  }[];
-  featureFlags: AppConfigFeatureFlagData[];
-  routes: AppRouteConfigData[];
-  notes?: string;
-}
-type MigrationStepKind = 'schema' | 'data' | 'validation';
-interface MigrationStepData {
-  kind: MigrationStepKind;
-  description?: string;
-  sql?: string;
-  script?: string;
-  assertion?: string;
-  timeoutMs?: number;
-  retries?: number;
-  preChecks?: {
-    description: string;
-    expression: string;
-  }[];
-  postChecks?: {
-    description: string;
-    expression: string;
-  }[];
-}
-interface MigrationSpecData extends BaseSpecData {
-  title: string;
-  domain: string;
-  dependencies: string[];
-  up: MigrationStepData[];
-  down?: MigrationStepData[];
-}
-type IntegrationCategoryData = 'payments' | 'email' | 'calendar' | 'sms' | 'ai-llm' | 'ai-voice' | 'speech-to-text' | 'vector-db' | 'storage' | 'accounting' | 'crm' | 'helpdesk' | 'open-banking' | 'custom';
-type IntegrationConfigFieldType = 'string' | 'number' | 'boolean';
-type IntegrationOwnershipModeData = 'managed' | 'byok';
-type IntegrationHealthCheckMethod = 'ping' | 'list' | 'custom';
-interface IntegrationCapabilityRefData {
-  key: string;
-  version: string;
-}
-interface IntegrationCapabilityRequirementData {
-  key: string;
-  version?: string;
-  optional?: boolean;
-  reason?: string;
-}
-interface IntegrationConfigFieldData {
-  key: string;
-  type: IntegrationConfigFieldType;
-  required: boolean;
-  description?: string;
-}
-type IntegrationSecretFieldData = IntegrationConfigFieldData;
-interface IntegrationSpecData extends BaseSpecData {
-  title: string;
-  domain: string;
-  displayName: string;
-  category: IntegrationCategoryData;
-  supportedModes: IntegrationOwnershipModeData[];
-  capabilitiesProvided: IntegrationCapabilityRefData[];
-  capabilitiesRequired: IntegrationCapabilityRequirementData[];
-  configFields: IntegrationConfigFieldData[];
-  secretFields: IntegrationSecretFieldData[];
-  docsUrl?: string;
-  rateLimitRpm?: number;
-  rateLimitRph?: number;
-  healthCheckMethod: IntegrationHealthCheckMethod;
-  healthCheckTimeoutMs?: number;
-  byokSetupInstructions?: string;
-  byokRequiredScopes?: string[];
-}
-type KnowledgeCategoryData = 'canonical' | 'operational' | 'external' | 'ephemeral';
-type KnowledgeTrustLevel = 'high' | 'medium' | 'low';
-interface KnowledgeRetentionData {
-  ttlDays?: number | null;
-  archiveAfterDays?: number;
-}
-interface KnowledgeSpaceSpecData extends BaseSpecData {
-  title: string;
-  domain: string;
-  displayName: string;
-  category: KnowledgeCategoryData;
-  retention: KnowledgeRetentionData;
-  policyName?: string;
-  policyVersion?: string | number;
-  trustLevel: KnowledgeTrustLevel;
-  automationWritable: boolean;
-  embeddingModel?: string;
-  chunkSize?: number;
-  vectorDbIntegration?: string;
-}
-//#endregion
-export { AppBlueprintSpecData, AppConfigFeatureFlagData, AppConfigMappingData, AppRouteConfigData, BaseSpecData, DataViewFieldData, DataViewKind, DataViewSpecData, EventSpecData, ExperimentAllocationData, ExperimentMetricData, ExperimentSpecData, ExperimentVariantData, ExperimentVariantOverrideData, FeatureSpecData, FormSpecData, IntegrationCapabilityRefData, IntegrationCapabilityRequirementData, IntegrationCategoryData, IntegrationConfigFieldData, IntegrationConfigFieldType, IntegrationHealthCheckMethod, IntegrationOwnershipModeData, IntegrationSecretFieldData, IntegrationSpecData, KnowledgeCategoryData, KnowledgeRetentionData, KnowledgeSpaceSpecData, KnowledgeTrustLevel, MigrationSpecData, MigrationStepData, MigrationStepKind, OperationSpecData, PresentationKind, PresentationSpecData, RandomAllocationData, SpecType, Stability, StepType, StickyAllocationData, TargetedAllocationData, TargetingRuleData, TelemetryAnomalyRuleData, TelemetryEventData, TelemetryPrivacy, TelemetryPropertyData, TelemetryProviderData, TelemetrySpecData, WorkflowSpecData, WorkflowStepData, WorkflowTransitionData };
+    optional?: boolean;
+    reason?: string;
+}
+export interface IntegrationConfigFieldData {
+    key: string;
+    type: IntegrationConfigFieldType;
+    required: boolean;
+    description?: string;
+}
+export type IntegrationSecretFieldData = IntegrationConfigFieldData;
+export interface IntegrationSpecData extends BaseSpecData {
+    title: string;
+    domain: string;
+    displayName: string;
+    category: IntegrationCategoryData;
+    supportedModes: IntegrationOwnershipModeData[];
+    capabilitiesProvided: IntegrationCapabilityRefData[];
+    capabilitiesRequired: IntegrationCapabilityRequirementData[];
+    configFields: IntegrationConfigFieldData[];
+    secretFields: IntegrationSecretFieldData[];
+    docsUrl?: string;
+    rateLimitRpm?: number;
+    rateLimitRph?: number;
+    healthCheckMethod: IntegrationHealthCheckMethod;
+    healthCheckTimeoutMs?: number;
+    byokSetupInstructions?: string;
+    byokRequiredScopes?: string[];
+}
+export type KnowledgeCategoryData = 'canonical' | 'operational' | 'external' | 'ephemeral';
+export type KnowledgeTrustLevel = 'high' | 'medium' | 'low';
+export interface KnowledgeRetentionData {
+    ttlDays?: number | null;
+    archiveAfterDays?: number;
+}
+export interface KnowledgeSpaceSpecData extends BaseSpecData {
+    title: string;
+    domain: string;
+    displayName: string;
+    category: KnowledgeCategoryData;
+    retention: KnowledgeRetentionData;
+    policyName?: string;
+    policyVersion?: string | number;
+    trustLevel: KnowledgeTrustLevel;
+    automationWritable: boolean;
+    embeddingModel?: string;
+    chunkSize?: number;
+    vectorDbIntegration?: string;
+}
 //# sourceMappingURL=spec-types.d.ts.map