@spottoai/types-package 1.0.2-beta.43 → 1.0.2-beta.430

package/dist/esm/ai/workspaceArtifacts.js

@@ -0,0 +1,158 @@
+export const AI_CHAT_WORKSPACE_CAPABILITIES = [
+    {
+        viewId: 'azure.security.secureScoreTrend',
+        version: 1,
+        artifactKind: 'chart',
+        presentations: ['line'],
+        dataModes: ['snapshot', 'snapshotWithLiveRefresh'],
+    },
+    {
+        viewId: 'azure.cost.subscriptionSpendTrend',
+        version: 1,
+        artifactKind: 'chart',
+        presentations: ['area', 'line'],
+        dataModes: ['snapshot', 'snapshotWithLiveRefresh'],
+    },
+    {
+        viewId: 'azure.serviceRetirement.upcoming',
+        version: 1,
+        artifactKind: 'table',
+        presentations: ['table'],
+        dataModes: ['snapshot', 'snapshotWithLiveRefresh'],
+    },
+    {
+        viewId: 'azure.governance.complianceSummary',
+        version: 1,
+        artifactKind: 'metricGroup',
+        presentations: ['metricGroup'],
+        dataModes: ['snapshot', 'snapshotWithLiveRefresh'],
+    },
+    {
+        viewId: 'azure.resource.metrics',
+        version: 1,
+        artifactKind: 'chart',
+        presentations: ['line', 'area', 'bar'],
+        dataModes: ['liveView', 'snapshotWithLiveRefresh'],
+    },
+    /**
+     * Report strategies are fixed, reviewed Portal renderers over existing report-domain loaders and
+     * pure models. The model selects only the strategy, an authorized subject reference and a title;
+     * it never supplies report data, markup, endpoint names or URLs.
+     */
+    {
+        viewId: 'security.landscape',
+        version: 1,
+        artifactKind: 'document',
+        presentations: ['report'],
+        dataModes: ['liveView'],
+    },
+    {
+        viewId: 'cost.changeWaterfall',
+        version: 1,
+        artifactKind: 'document',
+        presentations: ['report'],
+        dataModes: ['liveView'],
+    },
+    {
+        viewId: 'changes.recent',
+        version: 1,
+        artifactKind: 'document',
+        presentations: ['report'],
+        dataModes: ['liveView'],
+    },
+    {
+        viewId: 'cost.analysis',
+        version: 1,
+        artifactKind: 'document',
+        presentations: ['report'],
+        dataModes: ['liveView'],
+    },
+    {
+        viewId: 'cost.tree',
+        version: 1,
+        artifactKind: 'document',
+        presentations: ['report'],
+        dataModes: ['liveView'],
+    },
+    {
+        viewId: 'commitments.planning',
+        version: 1,
+        artifactKind: 'document',
+        presentations: ['report'],
+        dataModes: ['liveView'],
+    },
+    {
+        viewId: 'licensing.hybridBenefit',
+        version: 1,
+        artifactKind: 'document',
+        presentations: ['report'],
+        dataModes: ['liveView'],
+    },
+    {
+        viewId: 'governance.posture',
+        version: 1,
+        artifactKind: 'document',
+        presentations: ['report'],
+        dataModes: ['liveView'],
+    },
+    {
+        viewId: 'backups.posture',
+        version: 1,
+        artifactKind: 'document',
+        presentations: ['report'],
+        dataModes: ['liveView'],
+    },
+    {
+        viewId: 'retirement.tracker',
+        version: 1,
+        artifactKind: 'document',
+        presentations: ['report'],
+        dataModes: ['liveView'],
+    },
+    /**
+     * Generic views are server-produced snapshots over an authorized tool result already held by the
+     * turn. They have no live recipe and no endpoint binding: the API builds the payload from the same
+     * shaped tool output that grounded the answer, so the model never selects data, endpoint or shape.
+     */
+    {
+        viewId: 'genericTable',
+        version: 1,
+        artifactKind: 'table',
+        presentations: ['table'],
+        dataModes: ['snapshot'],
+    },
+    {
+        viewId: 'genericBarChart',
+        version: 1,
+        artifactKind: 'chart',
+        presentations: ['bar'],
+        dataModes: ['snapshot'],
+    },
+    {
+        viewId: 'genericLineChart',
+        version: 1,
+        artifactKind: 'chart',
+        presentations: ['line'],
+        dataModes: ['snapshot'],
+    },
+    {
+        viewId: 'genericKpi',
+        version: 1,
+        artifactKind: 'kpi',
+        presentations: ['kpi'],
+        dataModes: ['snapshot'],
+    },
+];
+export const AI_CHAT_WORKSPACE_GENERIC_VIEW_IDS = ['genericTable', 'genericBarChart', 'genericLineChart', 'genericKpi'];
+export const AI_CHAT_REPORT_STRATEGY_IDS = [
+    'security.landscape@1',
+    'cost.changeWaterfall@1',
+    'changes.recent@1',
+    'cost.analysis@1',
+    'cost.tree@1',
+    'commitments.planning@1',
+    'licensing.hybridBenefit@1',
+    'governance.posture@1',
+    'backups.posture@1',
+    'retirement.tracker@1',
+];

package/dist/esm/assessments/artifact.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/assessments/catalogue.js

@@ -0,0 +1,12 @@
+export const ARCHITECTURE_ASSESSMENT_REQUIRED_CONTEXT_CATEGORIES = [
+    'company-profile',
+    'architecture',
+    'operations',
+    'reliability',
+    'roadmap',
+];
+export const ARCHITECTURE_ASSESSMENT_OPTIONAL_CONTEXT_CATEGORIES = [
+    'security',
+    'performance',
+    'finops',
+];

package/dist/esm/assessments/common.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/assessments/evidence.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/assessments/export.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/assessments/index.js

@@ -0,0 +1,10 @@
+export * from './status.js';
+export * from './common.js';
+export * from './catalogue.js';
+export * from './run.js';
+export * from './evidence.js';
+export * from './artifact.js';
+export * from './review.js';
+export * from './queue.js';
+export * from './export.js';
+export * from './sow.js';

package/dist/esm/assessments/queue.js

@@ -0,0 +1,2 @@
+export const ASSESSMENT_QUEUE_ENTITY = 'assessment';
+export const ASSESSMENT_GENERATE_ACTION = 'generate-assessment';

package/dist/esm/assessments/review.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/assessments/run.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/assessments/sow.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/assessments/status.js

@@ -0,0 +1,23 @@
+export const ARCHITECTURE_ASSESSMENT_TYPE = 'architecture';
+export const ASSESSMENT_TYPES = [ARCHITECTURE_ASSESSMENT_TYPE];
+export const ASSESSMENT_PROVIDER_NAMES = ['azure'];
+export const ASSESSMENT_RELEASE_STAGES = ['preview', 'ga'];
+export const ASSESSMENT_RUN_STATUSES = ['draft', 'queued', 'running', 'needs_review', 'approved', 'published', 'failed'];
+export const ASSESSMENT_EXPORT_FORMATS = ['docx'];
+export const ASSESSMENT_EXPORT_STATUSES = ['requested', 'completed', 'failed'];
+export const ASSESSMENT_EVIDENCE_SOURCE_TYPES = [
+    'company_context_note',
+    'subscription_report_evidence_pack',
+    'portal_artifact',
+    'raw_artifact',
+    'conformed_artifact',
+    'review_checklist',
+    'derived_summary',
+    'ai_inference',
+    'evidence_gap',
+];
+export const ASSESSMENT_EVIDENCE_CONFIDENCE_LEVELS = ['confirmed', 'customer_supplied', 'derived', 'inferred', 'gap'];
+export const ASSESSMENT_PRIORITY_LEVELS = ['critical', 'high', 'medium', 'low', 'informational'];
+export const ASSESSMENT_EFFORT_BANDS = ['low', 'medium', 'high', 'unknown'];
+export const ASSESSMENT_IMPACT_LEVELS = ['low', 'medium', 'high', 'unknown'];
+export const ASSESSMENT_PILLARS = ['architecture', 'security', 'reliability', 'performance', 'operations', 'finops', 'roadmap'];

package/dist/esm/aws/commitments-planning.js

@@ -0,0 +1,6 @@
+export { validateAwsCommitmentsPlanningViewIdentity } from './commitmentsPlanningValidation.js';
+export * from './organizationCommitments.js';
+export * from './organizationCommitmentsApiValidation.js';
+export * from './organizationCommitmentsValidation.js';
+export * from './portalOrganizationCommitmentsPlanningPublicArtifacts.js';
+export * from './portalOrganizationCommitmentsPlanningPublicArtifactValidation.js';

package/dist/esm/aws/commitmentsPlanningValidation.js

@@ -0,0 +1,121 @@
+import { ProviderName } from '../common/provider.js';
+import { asRecord, assertAccount, assertExactKeys, assertValue } from './pluginPublicArtifactValidationHelpers.js';
+const FORBIDDEN_AWS_COMMITMENTS_KEYS = new Set([
+    'billingScopeId',
+    'breakCostEstimate',
+    'cloudAccountId',
+    'companyId',
+    'credentialHealth',
+    'credentialId',
+    'managementGroupId',
+    'pricingQuote',
+    'quotePolicy',
+    'resourceGroupId',
+    'storageCapacity',
+    'storageDimensions',
+    'subscription',
+    'subscriptionId',
+    'tenantId',
+    'unlockFinancialLedger',
+]);
+/**
+ * Validates the security-sensitive AWS identity boundary of a commitments view.
+ * A full public-artifact validator should call this before publication or response.
+ */
+export function validateAwsCommitmentsPlanningViewIdentity(value, expectedAccountId) {
+    const view = asRecord(value, 'commitmentsPlanning');
+    const providerScope = asRecord(view.providerScope, 'commitmentsPlanning.providerScope');
+    assertExactKeys(providerScope, ['providerName', 'providerScopeId'], 'commitmentsPlanning.providerScope');
+    assertValue(providerScope.providerName, ProviderName.Aws, 'commitmentsPlanning.providerScope.providerName');
+    const accountId = String(providerScope.providerScopeId ?? '');
+    assertAccount(providerScope.providerScopeId, accountId, 'commitmentsPlanning.providerScope.providerScopeId');
+    if (expectedAccountId !== undefined) {
+        assertAccount(expectedAccountId, accountId, 'expectedAccountId');
+    }
+    validateInventory(view.inventory, accountId);
+    validatePurchaseRecommendations(view.purchaseRecommendations, accountId);
+    validateBoundIdentities(view, accountId, 'commitmentsPlanning');
+}
+function validateInventory(value, accountId) {
+    if (!Array.isArray(value))
+        throw new Error('commitmentsPlanning.inventory must be an array.');
+    value.forEach((item, index) => {
+        const field = `commitmentsPlanning.inventory[${index}]`;
+        const record = asRecord(item, field);
+        assertValue(record.sourceKind, 'aws-native', `${field}.sourceKind`);
+        assertValue(record.provider, ProviderName.Aws, `${field}.provider`);
+        assertValue(record.appliedScopeType, 'linked-account', `${field}.appliedScopeType`);
+        validateAppliedScope(record.appliedScopeProperties, accountId, `${field}.appliedScopeProperties`);
+        validateAwsShape(record.shape, `${field}.shape`);
+    });
+}
+function validatePurchaseRecommendations(value, accountId) {
+    if (value === undefined)
+        return;
+    if (!Array.isArray(value))
+        throw new Error('commitmentsPlanning.purchaseRecommendations must be an array.');
+    value.forEach((item, index) => {
+        const field = `commitmentsPlanning.purchaseRecommendations[${index}]`;
+        const record = asRecord(item, field);
+        assertValue(record.purchaseScope, 'linked-account', `${field}.purchaseScope`);
+        validateAppliedScope(record.appliedScopeProperties, accountId, `${field}.appliedScopeProperties`);
+        validateAwsSource(record.source, `${field}.source`);
+        validateAwsShape(record.currentShape, `${field}.currentShape`);
+        validateAwsShape(record.targetShape, `${field}.targetShape`, true);
+        if (record.eligibility !== undefined) {
+            const eligibility = asRecord(record.eligibility, `${field}.eligibility`);
+            validateAwsShape(eligibility.currentShape, `${field}.eligibility.currentShape`);
+            validateAwsShape(eligibility.targetShape, `${field}.eligibility.targetShape`);
+            if (eligibility.source !== undefined)
+                validateAwsSource(eligibility.source, `${field}.eligibility.source`);
+        }
+    });
+}
+function validateAppliedScope(value, accountId, field) {
+    const scope = asRecord(value, field);
+    assertExactKeys(scope, ['accountId', 'region', 'availabilityZone'], field);
+    assertAccount(scope.accountId, accountId, `${field}.accountId`);
+}
+function validateAwsSource(value, field) {
+    const source = asRecord(value, field);
+    assertValue(source.sourceKind, 'aws-native', `${field}.sourceKind`);
+}
+function validateAwsShape(value, field, required = false) {
+    if (value === undefined && !required)
+        return;
+    const shape = asRecord(value, field);
+    assertValue(shape.provider, 'aws', `${field}.provider`);
+}
+function validateBoundIdentities(value, accountId, field) {
+    if (Array.isArray(value)) {
+        value.forEach((item, index) => validateBoundIdentities(item, accountId, `${field}[${index}]`));
+        return;
+    }
+    if (!value || typeof value !== 'object') {
+        if (typeof value === 'string')
+            validateArnAccount(value, accountId, field);
+        return;
+    }
+    for (const [key, child] of Object.entries(value)) {
+        if (FORBIDDEN_AWS_COMMITMENTS_KEYS.has(key)) {
+            throw new Error(`${field}.${key} is not allowed in an AWS commitments artifact.`);
+        }
+        if (key === 'accountId')
+            assertAccount(child, accountId, `${field}.${key}`);
+        if (key === 'providerName')
+            assertValue(child, ProviderName.Aws, `${field}.${key}`);
+        if (key === 'provider')
+            assertValue(child, 'aws', `${field}.${key}`);
+        if (key === 'sourceKind' && child === 'azure-native') {
+            throw new Error(`${field}.${key} cannot contain Azure-native evidence.`);
+        }
+        validateBoundIdentities(child, accountId, `${field}.${key}`);
+    }
+}
+function validateArnAccount(value, accountId, field) {
+    if (!value.startsWith('arn:'))
+        return;
+    const arnAccountId = value.split(':', 6)[4];
+    if (arnAccountId)
+        assertAccount(arnAccountId, accountId, field);
+}

package/dist/esm/aws/estates.js

@@ -0,0 +1,27 @@
+import { AWS_FORBIDDEN_CREDENTIAL_FIELDS } from './requests.js';
+/** Schema version for the API-owned AWS company estate manifest. */
+export const AWS_ESTATES_MANIFEST_SCHEMA_VERSION = 1;
+/** Public provider discriminator used by the AWS estate manifest API. */
+export const AWS_ESTATES_MANIFEST_PROVIDER = 'AWS';
+export const AWS_ESTATE_KINDS = ['standalone', 'organization'];
+export const AWS_ESTATE_ACCOUNT_SOURCES = ['manual'];
+export const AWS_ESTATE_ROLE_DEPLOYMENT_MODES = ['customer-managed'];
+export const AWS_ESTATE_ACCOUNT_PURPOSES = [
+    'resource-discovery',
+    'organization-discovery',
+    'commitments-planning',
+    'billing-definition',
+    'billing-storage',
+];
+/**
+ * Credential-shaped fields that manifest API boundaries must reject
+ * recursively before persisting untyped JSON.
+ */
+export const AWS_ESTATES_MANIFEST_FORBIDDEN_CREDENTIAL_FIELDS = [
+    ...AWS_FORBIDDEN_CREDENTIAL_FIELDS,
+    'externalId',
+    'accessToken',
+    'connectionString',
+    'sasToken',
+    'storageCredential',
+];

package/dist/esm/aws/index.js

@@ -0,0 +1,23 @@
+export * from './estates.js';
+export * from './commitmentsPlanningValidation.js';
+export * from './organizationCommitments.js';
+export * from './organizationCommitmentsApiValidation.js';
+export * from './organizationCommitmentsValidation.js';
+export * from './onboarding.js';
+export * from './pluginPublicArtifacts.js';
+export * from './pluginPublicArtifactEvidence.js';
+export * from './pluginPublicArtifactValidation.js';
+export * from './portalPublicArtifacts.js';
+export * from './portalCommitmentsPlanningPublicArtifacts.js';
+export * from './portalCommitmentsPlanningPublicArtifactValidation.js';
+export * from './portalOrganizationCommitmentsPlanningPublicArtifacts.js';
+export * from './portalOrganizationCommitmentsPlanningPublicArtifactValidation.js';
+export * from './portalRelationshipPublicArtifacts.js';
+export * from './portalRelationshipResourceNodeTypes.js';
+export * from './portalRelationshipPublicArtifactValidation.js';
+export * from './portalPublicArtifactHistoryTypes.js';
+export * from './portalPublicArtifactNestedEvidence.js';
+export * from './portalPublicArtifactNestedEvidenceValidation.js';
+export * from './portalPublicArtifactValidation.js';
+export * from './publicArtifacts.js';
+export * from './requests.js';

package/dist/esm/aws/onboarding.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/aws/organizationCommitments.js

@@ -0,0 +1,48 @@
+import { sha256AwsPluginIdentity } from './pluginPublicArtifacts.js';
+export const AWS_ORGANIZATION_COMMITMENTS_SCHEMA_VERSION = 1;
+export const AWS_ORGANIZATION_COMMITMENTS_REFRESH_STAGES = [
+    'account-inventory',
+    'payer-analytics',
+    'payer-recommendations',
+    'materialization',
+    'publication',
+];
+export const AWS_ORGANIZATION_COMMITMENTS_REFRESH_STATES = ['not-started', 'pending', 'processing', 'fresh', 'partial', 'failed'];
+export const AWS_ORGANIZATION_COMMITMENTS_REFRESH_STAGE_STATUSES = ['pending', 'processing', 'fresh', 'partial', 'failed', 'skipped'];
+export const AWS_ORGANIZATION_COMMITMENTS_SCOPE_UNAVAILABLE_REASONS = [
+    'estate-disabled',
+    'estate-not-ready',
+    'management-account-missing',
+    'commitments-permission-missing',
+    'not-authorized',
+    'unknown',
+];
+export const AWS_ORGANIZATION_COMMITMENTS_ATTRIBUTION_UNAVAILABLE_REASONS = ['not-collected', 'not-proved', 'source-unavailable'];
+export const AWS_ORGANIZATION_COMMITMENTS_ISSUE_CODES = [
+    'estate-disabled',
+    'manifest-revision-mismatch',
+    'organization-identity-invalid',
+    'management-account-unavailable',
+    'commitments-permission-missing',
+    'account-inventory-partial',
+    'payer-analytics-unavailable',
+    'payer-recommendations-unavailable',
+    'source-refresh-failed',
+    'materialization-failed',
+    'publication-failed',
+    'refresh-cooldown',
+    'unknown',
+];
+export const AWS_ORGANIZATION_COMMITMENTS_SESSION_ID_PREFIX = 'aws-org-commitments:';
+/** Builds the bounded Service Bus session identity shared by API and engine. */
+export function buildAwsOrganizationCommitmentsSessionId(companyId, estateId) {
+    const company = requiredSessionIdentity(companyId, 'companyId');
+    const estate = requiredSessionIdentity(estateId, 'estateId');
+    return `${AWS_ORGANIZATION_COMMITMENTS_SESSION_ID_PREFIX}${sha256AwsPluginIdentity(JSON.stringify(['aws-organization-commitments', company, estate]))}`;
+}
+function requiredSessionIdentity(value, field) {
+    if (typeof value !== 'string' || value.trim() !== value || value.length === 0) {
+        throw new Error(`${field} must be a non-empty trimmed string.`);
+    }
+    return value;
+}