@contractspec/lib.contracts 1.44.0

package/dist/app-config/events.js

@@ -0,0 +1,174 @@
+import { defineEvent } from "../events.js";
+import { OwnersEnum, StabilityEnum, TagsEnum } from "../ownership.js";
+import { ScalarTypeEnum, SchemaModel } from "@contractspec/lib.schema";
+
+//#region src/app-config/events.ts
+const lifecycleOwnership = {
+	title: "Tenant App Config Lifecycle",
+	description: "Events emitted when tenant app configurations move through lifecycle stages.",
+	domain: "app-config.lifecycle",
+	owners: [OwnersEnum.PlatformSigil],
+	tags: [TagsEnum.Hygiene],
+	stability: StabilityEnum.Beta
+};
+const ConfigDraftCreatedEvent = defineEvent({
+	meta: {
+		...lifecycleOwnership,
+		key: "app_config.draft_created",
+		version: 1,
+		description: "A new tenant config draft was created."
+	},
+	payload: new SchemaModel({
+		name: "ConfigDraftCreatedPayload",
+		fields: {
+			tenantId: {
+				type: ScalarTypeEnum.ID(),
+				isOptional: false
+			},
+			appId: {
+				type: ScalarTypeEnum.ID(),
+				isOptional: false
+			},
+			version: {
+				type: ScalarTypeEnum.Int_unsecure(),
+				isOptional: false
+			},
+			blueprintName: {
+				type: ScalarTypeEnum.String_unsecure(),
+				isOptional: false
+			},
+			blueprintVersion: {
+				type: ScalarTypeEnum.Int_unsecure(),
+				isOptional: false
+			},
+			createdBy: {
+				type: ScalarTypeEnum.String_unsecure(),
+				isOptional: false
+			},
+			clonedFrom: {
+				type: ScalarTypeEnum.Int_unsecure(),
+				isOptional: true
+			}
+		}
+	})
+});
+const ConfigPromotedToPreviewEvent = defineEvent({
+	meta: {
+		...lifecycleOwnership,
+		key: "app_config.promoted_to_preview",
+		version: 1,
+		description: "A tenant config draft was promoted to preview."
+	},
+	payload: new SchemaModel({
+		name: "ConfigPromotedToPreviewPayload",
+		fields: {
+			tenantId: {
+				type: ScalarTypeEnum.ID(),
+				isOptional: false
+			},
+			appId: {
+				type: ScalarTypeEnum.ID(),
+				isOptional: false
+			},
+			version: {
+				type: ScalarTypeEnum.Int_unsecure(),
+				isOptional: false
+			},
+			promotedBy: {
+				type: ScalarTypeEnum.String_unsecure(),
+				isOptional: false
+			},
+			warnings: {
+				type: ScalarTypeEnum.String_unsecure(),
+				isOptional: true,
+				isArray: true
+			}
+		}
+	})
+});
+const ConfigPublishedEvent = defineEvent({
+	meta: {
+		...lifecycleOwnership,
+		key: "app_config.published",
+		version: 1,
+		description: "A tenant config version was published to production."
+	},
+	payload: new SchemaModel({
+		name: "ConfigPublishedPayload",
+		fields: {
+			tenantId: {
+				type: ScalarTypeEnum.ID(),
+				isOptional: false
+			},
+			appId: {
+				type: ScalarTypeEnum.ID(),
+				isOptional: false
+			},
+			version: {
+				type: ScalarTypeEnum.Int_unsecure(),
+				isOptional: false
+			},
+			previousVersion: {
+				type: ScalarTypeEnum.Int_unsecure(),
+				isOptional: true
+			},
+			publishedBy: {
+				type: ScalarTypeEnum.String_unsecure(),
+				isOptional: false
+			},
+			changeSummary: {
+				type: ScalarTypeEnum.String_unsecure(),
+				isOptional: true
+			},
+			changedSections: {
+				type: ScalarTypeEnum.String_unsecure(),
+				isOptional: true,
+				isArray: true
+			}
+		}
+	})
+});
+const ConfigRolledBackEvent = defineEvent({
+	meta: {
+		...lifecycleOwnership,
+		key: "app_config.rolled_back",
+		version: 1,
+		description: "A tenant config was rolled back to a previous version."
+	},
+	payload: new SchemaModel({
+		name: "ConfigRolledBackPayload",
+		fields: {
+			tenantId: {
+				type: ScalarTypeEnum.ID(),
+				isOptional: false
+			},
+			appId: {
+				type: ScalarTypeEnum.ID(),
+				isOptional: false
+			},
+			newVersion: {
+				type: ScalarTypeEnum.Int_unsecure(),
+				isOptional: false
+			},
+			rolledBackFrom: {
+				type: ScalarTypeEnum.Int_unsecure(),
+				isOptional: false
+			},
+			rolledBackTo: {
+				type: ScalarTypeEnum.Int_unsecure(),
+				isOptional: false
+			},
+			rolledBackBy: {
+				type: ScalarTypeEnum.String_unsecure(),
+				isOptional: false
+			},
+			reason: {
+				type: ScalarTypeEnum.String_unsecure(),
+				isOptional: false
+			}
+		}
+	})
+});
+
+//#endregion
+export { ConfigDraftCreatedEvent, ConfigPromotedToPreviewEvent, ConfigPublishedEvent, ConfigRolledBackEvent };

package/dist/app-config/index.d.ts

@@ -0,0 +1,9 @@
+import { BrandingAssetRef, BrandingDefaults, ResolvedBranding, TenantBrandingAsset, TenantBrandingConfig } from "./branding.js";
+import { ConfigStatus, ConfigTransition, ConfigVersionHistory, TenantAppConfigVersion } from "./lifecycle.js";
+import { AppBlueprintMeta, AppBlueprintRegistry, AppBlueprintSpec, AppIntegrationSlot, AppRouteConfig, AppThemeBinding, FeatureFlagState, SpecPointer, TelemetryBinding, TenantAppConfig, TenantAppConfigMeta, TenantRouteOverride, TenantSpecOverride, TranslationCatalogPointer, makeAppBlueprintKey } from "./spec.js";
+import { AppComposition, AppCompositionDeps, ComposeOptions, MissingReference, ResolveAppConfigDeps, ResolvedAppConfig, ResolvedIntegration, ResolvedKnowledge, ResolvedTranslation, composeAppConfig, resolveAppConfig } from "./runtime.js";
+import { AppConfigFeature } from "./app-config.feature.js";
+import { ValidationContext, ValidationIssue, ValidationResult, ValidationSeverity, validateBlueprint, validateConfig, validateResolvedConfig, validateTenantConfig } from "./validation.js";
+import { ConfigDraftCreatedEvent, ConfigPromotedToPreviewEvent, ConfigPublishedEvent, ConfigRolledBackEvent } from "./events.js";
+import { CreateTenantConfigDraftCommand, GetTenantConfigVersionQuery, ListTenantConfigVersionsQuery, PromoteTenantConfigToPreviewCommand, PublishTenantConfigCommand, RollbackTenantConfigCommand, lifecycleContracts, registerAppConfigLifecycleContracts } from "./lifecycle-contracts.js";
+export { AppBlueprintMeta, AppBlueprintRegistry, AppBlueprintSpec, AppComposition, AppCompositionDeps, AppConfigFeature, AppIntegrationSlot, AppRouteConfig, AppThemeBinding, BrandingAssetRef, BrandingDefaults, ComposeOptions, ConfigDraftCreatedEvent, ConfigPromotedToPreviewEvent, ConfigPublishedEvent, ConfigRolledBackEvent, ConfigStatus, ConfigTransition, ConfigVersionHistory, CreateTenantConfigDraftCommand, FeatureFlagState, GetTenantConfigVersionQuery, ListTenantConfigVersionsQuery, MissingReference, PromoteTenantConfigToPreviewCommand, PublishTenantConfigCommand, ResolveAppConfigDeps, ResolvedAppConfig, ResolvedBranding, ResolvedIntegration, ResolvedKnowledge, ResolvedTranslation, RollbackTenantConfigCommand, SpecPointer, TelemetryBinding, TenantAppConfig, TenantAppConfigMeta, TenantAppConfigVersion, TenantBrandingAsset, TenantBrandingConfig, TenantRouteOverride, TenantSpecOverride, TranslationCatalogPointer, ValidationContext, ValidationIssue, ValidationResult, ValidationSeverity, composeAppConfig, lifecycleContracts, makeAppBlueprintKey, registerAppConfigLifecycleContracts, resolveAppConfig, validateBlueprint, validateConfig, validateResolvedConfig, validateTenantConfig };

package/dist/app-config/index.js

@@ -0,0 +1,8 @@
+import { AppBlueprintRegistry, makeAppBlueprintKey } from "./spec.js";
+import { composeAppConfig, resolveAppConfig } from "./runtime.js";
+import { validateBlueprint, validateConfig, validateResolvedConfig, validateTenantConfig } from "./validation.js";
+import { AppConfigFeature } from "./app-config.feature.js";
+import { ConfigDraftCreatedEvent, ConfigPromotedToPreviewEvent, ConfigPublishedEvent, ConfigRolledBackEvent } from "./events.js";
+import { CreateTenantConfigDraftCommand, GetTenantConfigVersionQuery, ListTenantConfigVersionsQuery, PromoteTenantConfigToPreviewCommand, PublishTenantConfigCommand, RollbackTenantConfigCommand, lifecycleContracts, registerAppConfigLifecycleContracts } from "./lifecycle-contracts.js";
+
+export { AppBlueprintRegistry, AppConfigFeature, ConfigDraftCreatedEvent, ConfigPromotedToPreviewEvent, ConfigPublishedEvent, ConfigRolledBackEvent, CreateTenantConfigDraftCommand, GetTenantConfigVersionQuery, ListTenantConfigVersionsQuery, PromoteTenantConfigToPreviewCommand, PublishTenantConfigCommand, RollbackTenantConfigCommand, composeAppConfig, lifecycleContracts, makeAppBlueprintKey, registerAppConfigLifecycleContracts, resolveAppConfig, validateBlueprint, validateConfig, validateResolvedConfig, validateTenantConfig };

package/dist/app-config/lifecycle-contracts.d.ts

@@ -0,0 +1,273 @@
+import { EventSpecMeta } from "../events.js";
+import { OperationSpec } from "../operations/operation.js";
+import { OperationSpecRegistry } from "../operations/registry.js";
+import "../operations/index.js";
+import "../index.js";
+import * as _contractspec_lib_schema156 from "@contractspec/lib.schema";
+import { SchemaModel } from "@contractspec/lib.schema";
+
+//#region src/app-config/lifecycle-contracts.d.ts
+declare const CreateTenantConfigDraftCommand: OperationSpec<SchemaModel<{
+  tenantId: {
+    type: _contractspec_lib_schema156.FieldType<string, string>;
+    isOptional: false;
+  };
+  appId: {
+    type: _contractspec_lib_schema156.FieldType<string, string>;
+    isOptional: false;
+  };
+  blueprintName: {
+    type: _contractspec_lib_schema156.FieldType<string, string>;
+    isOptional: false;
+  };
+  blueprintVersion: {
+    type: _contractspec_lib_schema156.FieldType<number, number>;
+    isOptional: false;
+  };
+  environment: {
+    type: _contractspec_lib_schema156.FieldType<string, string>;
+    isOptional: true;
+  };
+  fromVersion: {
+    type: _contractspec_lib_schema156.FieldType<number, number>;
+    isOptional: true;
+  };
+  createdBy: {
+    type: _contractspec_lib_schema156.FieldType<string, string>;
+    isOptional: false;
+  };
+}>, SchemaModel<{
+  version: {
+    type: _contractspec_lib_schema156.FieldType<number, number>;
+    isOptional: false;
+  };
+  status: {
+    type: _contractspec_lib_schema156.FieldType<string, string>;
+    isOptional: false;
+  };
+  createdAt: {
+    type: _contractspec_lib_schema156.FieldType<Date, string>;
+    isOptional: false;
+  };
+}>, {
+  ref: EventSpecMeta;
+  when: string;
+}[]>;
+declare const PromoteTenantConfigToPreviewCommand: OperationSpec<SchemaModel<{
+  tenantId: {
+    type: _contractspec_lib_schema156.FieldType<string, string>;
+    isOptional: false;
+  };
+  appId: {
+    type: _contractspec_lib_schema156.FieldType<string, string>;
+    isOptional: false;
+  };
+  version: {
+    type: _contractspec_lib_schema156.FieldType<number, number>;
+    isOptional: false;
+  };
+  promotedBy: {
+    type: _contractspec_lib_schema156.FieldType<string, string>;
+    isOptional: false;
+  };
+}>, SchemaModel<{
+  version: {
+    type: _contractspec_lib_schema156.FieldType<number, number>;
+    isOptional: false;
+  };
+  status: {
+    type: _contractspec_lib_schema156.FieldType<string, string>;
+    isOptional: false;
+  };
+  warnings: {
+    type: _contractspec_lib_schema156.FieldType<string, string>;
+    isOptional: true;
+    isArray: true;
+  };
+}>, {
+  ref: EventSpecMeta;
+  when: string;
+}[]>;
+declare const PublishTenantConfigCommand: OperationSpec<SchemaModel<{
+  tenantId: {
+    type: _contractspec_lib_schema156.FieldType<string, string>;
+    isOptional: false;
+  };
+  appId: {
+    type: _contractspec_lib_schema156.FieldType<string, string>;
+    isOptional: false;
+  };
+  version: {
+    type: _contractspec_lib_schema156.FieldType<number, number>;
+    isOptional: false;
+  };
+  environment: {
+    type: _contractspec_lib_schema156.FieldType<string, string>;
+    isOptional: true;
+  };
+  publishedBy: {
+    type: _contractspec_lib_schema156.FieldType<string, string>;
+    isOptional: false;
+  };
+  changeSummary: {
+    type: _contractspec_lib_schema156.FieldType<string, string>;
+    isOptional: true;
+  };
+}>, SchemaModel<{
+  version: {
+    type: _contractspec_lib_schema156.FieldType<number, number>;
+    isOptional: false;
+  };
+  status: {
+    type: _contractspec_lib_schema156.FieldType<string, string>;
+    isOptional: false;
+  };
+  previousVersion: {
+    type: _contractspec_lib_schema156.FieldType<number, number>;
+    isOptional: true;
+  };
+  publishedAt: {
+    type: _contractspec_lib_schema156.FieldType<Date, string>;
+    isOptional: false;
+  };
+}>, {
+  ref: EventSpecMeta;
+  when: string;
+}[]>;
+declare const RollbackTenantConfigCommand: OperationSpec<SchemaModel<{
+  tenantId: {
+    type: _contractspec_lib_schema156.FieldType<string, string>;
+    isOptional: false;
+  };
+  appId: {
+    type: _contractspec_lib_schema156.FieldType<string, string>;
+    isOptional: false;
+  };
+  toVersion: {
+    type: _contractspec_lib_schema156.FieldType<number, number>;
+    isOptional: false;
+  };
+  environment: {
+    type: _contractspec_lib_schema156.FieldType<string, string>;
+    isOptional: true;
+  };
+  rolledBackBy: {
+    type: _contractspec_lib_schema156.FieldType<string, string>;
+    isOptional: false;
+  };
+  reason: {
+    type: _contractspec_lib_schema156.FieldType<string, string>;
+    isOptional: false;
+  };
+}>, SchemaModel<{
+  newVersion: {
+    type: _contractspec_lib_schema156.FieldType<number, number>;
+    isOptional: false;
+  };
+  status: {
+    type: _contractspec_lib_schema156.FieldType<string, string>;
+    isOptional: false;
+  };
+  rolledBackFrom: {
+    type: _contractspec_lib_schema156.FieldType<number, number>;
+    isOptional: false;
+  };
+}>, {
+  ref: EventSpecMeta;
+  when: string;
+}[]>;
+declare const ListTenantConfigVersionsQuery: OperationSpec<SchemaModel<{
+  tenantId: {
+    type: _contractspec_lib_schema156.FieldType<string, string>;
+    isOptional: false;
+  };
+  appId: {
+    type: _contractspec_lib_schema156.FieldType<string, string>;
+    isOptional: false;
+  };
+}>, SchemaModel<{
+  versions: {
+    type: SchemaModel<{
+      meta: {
+        type: _contractspec_lib_schema156.FieldType<Record<string, unknown>, Record<string, unknown>>;
+        isOptional: false;
+      };
+      config: {
+        type: _contractspec_lib_schema156.FieldType<Record<string, unknown>, Record<string, unknown>>;
+        isOptional: false;
+      };
+    }>;
+    isOptional: false;
+    isArray: true;
+  };
+  transitions: {
+    type: SchemaModel<{
+      tenantId: {
+        type: _contractspec_lib_schema156.FieldType<string, string>;
+        isOptional: false;
+      };
+      appId: {
+        type: _contractspec_lib_schema156.FieldType<string, string>;
+        isOptional: false;
+      };
+      fromStatus: {
+        type: _contractspec_lib_schema156.FieldType<string, string>;
+        isOptional: false;
+      };
+      toStatus: {
+        type: _contractspec_lib_schema156.FieldType<string, string>;
+        isOptional: false;
+      };
+      version: {
+        type: _contractspec_lib_schema156.FieldType<number, number>;
+        isOptional: false;
+      };
+      timestamp: {
+        type: _contractspec_lib_schema156.FieldType<Date, string>;
+        isOptional: false;
+      };
+      actor: {
+        type: _contractspec_lib_schema156.FieldType<string, string>;
+        isOptional: false;
+      };
+      reason: {
+        type: _contractspec_lib_schema156.FieldType<string, string>;
+        isOptional: true;
+      };
+    }>;
+    isOptional: true;
+    isArray: true;
+  };
+}>, undefined>;
+declare const GetTenantConfigVersionQuery: OperationSpec<SchemaModel<{
+  tenantId: {
+    type: _contractspec_lib_schema156.FieldType<string, string>;
+    isOptional: false;
+  };
+  appId: {
+    type: _contractspec_lib_schema156.FieldType<string, string>;
+    isOptional: false;
+  };
+  version: {
+    type: _contractspec_lib_schema156.FieldType<number, number>;
+    isOptional: false;
+  };
+}>, SchemaModel<{
+  version: {
+    type: SchemaModel<{
+      meta: {
+        type: _contractspec_lib_schema156.FieldType<Record<string, unknown>, Record<string, unknown>>;
+        isOptional: false;
+      };
+      config: {
+        type: _contractspec_lib_schema156.FieldType<Record<string, unknown>, Record<string, unknown>>;
+        isOptional: false;
+      };
+    }>;
+    isOptional: false;
+  };
+}>, undefined>;
+declare const lifecycleContracts: Record<string, OperationSpec<any, any>>;
+declare function registerAppConfigLifecycleContracts(registry: OperationSpecRegistry): OperationSpecRegistry;
+//#endregion
+export { CreateTenantConfigDraftCommand, GetTenantConfigVersionQuery, ListTenantConfigVersionsQuery, PromoteTenantConfigToPreviewCommand, PublishTenantConfigCommand, RollbackTenantConfigCommand, lifecycleContracts, registerAppConfigLifecycleContracts };