@spottoai/types-package 1.0.2-dev1138.2 → 1.0.2-dev1138.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -0
- package/dist/accounts/accounts.d.ts +77 -4
- package/dist/accounts/accounts.d.ts.map +1 -1
- package/dist/accounts/accounts.js +2 -1
- package/dist/accounts/accounts.js.map +1 -1
- package/dist/accounts/azureManualOnboarding.d.ts +114 -0
- package/dist/accounts/azureManualOnboarding.d.ts.map +1 -0
- package/dist/accounts/azureManualOnboarding.js +12 -0
- package/dist/accounts/azureManualOnboarding.js.map +1 -0
- package/dist/accounts/azureSpSetup.d.ts +128 -31
- package/dist/accounts/azureSpSetup.d.ts.map +1 -1
- package/dist/accounts/azureSpSetup.js +15 -0
- package/dist/accounts/azureSpSetup.js.map +1 -1
- package/dist/accounts/azureSpSetupDurable.d.ts +8 -0
- package/dist/accounts/azureSpSetupDurable.d.ts.map +1 -1
- package/dist/accounts/azureSpSetupDurable.js +28 -0
- package/dist/accounts/azureSpSetupDurable.js.map +1 -1
- package/dist/accounts/index.d.ts +1 -0
- package/dist/accounts/index.d.ts.map +1 -1
- package/dist/accounts/index.js +1 -0
- package/dist/accounts/index.js.map +1 -1
- package/dist/accounts/readPermissions.d.ts +1 -1
- package/dist/accounts/readPermissions.d.ts.map +1 -1
- package/dist/accounts/readPermissions.js.map +1 -1
- package/dist/accounts/validation.d.ts +24 -0
- package/dist/accounts/validation.d.ts.map +1 -1
- package/dist/ai/index.d.ts +14 -1
- package/dist/ai/index.d.ts.map +1 -1
- package/dist/ai/index.js +12 -0
- package/dist/ai/index.js.map +1 -1
- package/dist/aws/commitments-planning.d.ts +5 -0
- package/dist/aws/commitments-planning.d.ts.map +1 -1
- package/dist/aws/commitments-planning.js +19 -0
- package/dist/aws/commitments-planning.js.map +1 -1
- package/dist/aws/estates.d.ts +1 -1
- package/dist/aws/estates.d.ts.map +1 -1
- package/dist/aws/estates.js +7 -1
- package/dist/aws/estates.js.map +1 -1
- package/dist/aws/index.d.ts +5 -0
- package/dist/aws/index.d.ts.map +1 -1
- package/dist/aws/index.js +5 -0
- package/dist/aws/index.js.map +1 -1
- package/dist/aws/onboarding.d.ts +3 -0
- package/dist/aws/onboarding.d.ts.map +1 -1
- package/dist/aws/organizationCommitments.d.ts +260 -0
- package/dist/aws/organizationCommitments.d.ts.map +1 -0
- package/dist/aws/organizationCommitments.js +53 -0
- package/dist/aws/organizationCommitments.js.map +1 -0
- package/dist/aws/organizationCommitmentsApiValidation.d.ts +21 -0
- package/dist/aws/organizationCommitmentsApiValidation.d.ts.map +1 -0
- package/dist/aws/organizationCommitmentsApiValidation.js +226 -0
- package/dist/aws/organizationCommitmentsApiValidation.js.map +1 -0
- package/dist/aws/organizationCommitmentsValidation.d.ts +12 -0
- package/dist/aws/organizationCommitmentsValidation.d.ts.map +1 -0
- package/dist/aws/organizationCommitmentsValidation.js +228 -0
- package/dist/aws/organizationCommitmentsValidation.js.map +1 -0
- package/dist/aws/portalOrganizationCommitmentsPlanningPublicArtifactValidation.d.ts +9 -0
- package/dist/aws/portalOrganizationCommitmentsPlanningPublicArtifactValidation.d.ts.map +1 -0
- package/dist/aws/portalOrganizationCommitmentsPlanningPublicArtifactValidation.js +407 -0
- package/dist/aws/portalOrganizationCommitmentsPlanningPublicArtifactValidation.js.map +1 -0
- package/dist/aws/portalOrganizationCommitmentsPlanningPublicArtifacts.d.ts +17 -0
- package/dist/aws/portalOrganizationCommitmentsPlanningPublicArtifacts.d.ts.map +1 -0
- package/dist/aws/portalOrganizationCommitmentsPlanningPublicArtifacts.js +6 -0
- package/dist/aws/portalOrganizationCommitmentsPlanningPublicArtifacts.js.map +1 -0
- package/dist/aws/requests.d.ts +13 -2
- package/dist/aws/requests.d.ts.map +1 -1
- package/dist/aws/requests.js +1 -1
- package/dist/aws/requests.js.map +1 -1
- package/dist/azure/commitmentsPlanning.d.ts +2 -2
- package/dist/azure/commitmentsPlanning.d.ts.map +1 -1
- package/dist/azure/financialAnalytics.d.ts +68 -2
- package/dist/azure/financialAnalytics.d.ts.map +1 -1
- package/dist/azure/financialAnalyticsDelivery.d.ts +2 -0
- package/dist/azure/financialAnalyticsDelivery.d.ts.map +1 -1
- package/dist/azure/financialAnalyticsDelivery.js +4 -1
- package/dist/azure/financialAnalyticsDelivery.js.map +1 -1
- package/dist/azure/financialAnalyticsDisplayKernel.d.ts +12 -0
- package/dist/azure/financialAnalyticsDisplayKernel.d.ts.map +1 -0
- package/dist/azure/financialAnalyticsDisplayKernel.js +144 -0
- package/dist/azure/financialAnalyticsDisplayKernel.js.map +1 -0
- package/dist/azure/financialAnalyticsValidation.d.ts.map +1 -1
- package/dist/azure/financialAnalyticsValidation.js +61 -7
- package/dist/azure/financialAnalyticsValidation.js.map +1 -1
- package/dist/azure/financialAuthorityProjectionKernel.d.ts +7 -0
- package/dist/azure/financialAuthorityProjectionKernel.d.ts.map +1 -0
- package/dist/azure/financialAuthorityProjectionKernel.js +165 -0
- package/dist/azure/financialAuthorityProjectionKernel.js.map +1 -0
- package/dist/azure/financialAuthorityView.d.ts +4 -0
- package/dist/azure/financialAuthorityView.d.ts.map +1 -1
- package/dist/azure/financialAuthorityView.js.map +1 -1
- package/dist/azure/financialAuthorityViewValidation.d.ts +3 -1
- package/dist/azure/financialAuthorityViewValidation.d.ts.map +1 -1
- package/dist/azure/financialAuthorityViewValidation.js +206 -2
- package/dist/azure/financialAuthorityViewValidation.js.map +1 -1
- package/dist/azure/financialChargeComposition.d.ts +81 -0
- package/dist/azure/financialChargeComposition.d.ts.map +1 -0
- package/dist/azure/financialChargeComposition.js +41 -0
- package/dist/azure/financialChargeComposition.js.map +1 -0
- package/dist/azure/financialChargeCompositionKernel.d.ts +3 -0
- package/dist/azure/financialChargeCompositionKernel.d.ts.map +1 -0
- package/dist/azure/financialChargeCompositionKernel.js +53 -0
- package/dist/azure/financialChargeCompositionKernel.js.map +1 -0
- package/dist/azure/financialChargeCompositionValidation.d.ts +8 -0
- package/dist/azure/financialChargeCompositionValidation.d.ts.map +1 -0
- package/dist/azure/financialChargeCompositionValidation.js +164 -0
- package/dist/azure/financialChargeCompositionValidation.js.map +1 -0
- package/dist/azure/financialDataflow.d.ts +8 -1
- package/dist/azure/financialDataflow.d.ts.map +1 -1
- package/dist/azure/financialDataflow.js.map +1 -1
- package/dist/azure/financialDataflowKernel.d.ts +2 -0
- package/dist/azure/financialDataflowKernel.d.ts.map +1 -1
- package/dist/azure/financialDataflowKernel.js +60 -7
- package/dist/azure/financialDataflowKernel.js.map +1 -1
- package/dist/azure/financialDataflowValidation.d.ts +1 -1
- package/dist/azure/financialDataflowValidation.d.ts.map +1 -1
- package/dist/azure/financialDataflowValidation.js +146 -28
- package/dist/azure/financialDataflowValidation.js.map +1 -1
- package/dist/azure/financialPolicy.d.ts +3 -0
- package/dist/azure/financialPolicy.d.ts.map +1 -1
- package/dist/azure/financialPolicy.js.map +1 -1
- package/dist/azure/financialPolicyValidation.d.ts.map +1 -1
- package/dist/azure/financialPolicyValidation.js +5 -0
- package/dist/azure/financialPolicyValidation.js.map +1 -1
- package/dist/azure/financialProjection.d.ts +11 -1
- package/dist/azure/financialProjection.d.ts.map +1 -1
- package/dist/azure/financialProjection.js.map +1 -1
- package/dist/azure/financialProjectionValidation.d.ts.map +1 -1
- package/dist/azure/financialProjectionValidation.js +43 -3
- package/dist/azure/financialProjectionValidation.js.map +1 -1
- package/dist/azure/financialSavingsAuthority.d.ts +25 -4
- package/dist/azure/financialSavingsAuthority.d.ts.map +1 -1
- package/dist/azure/financialSavingsAuthorityValidation.d.ts +6 -2
- package/dist/azure/financialSavingsAuthorityValidation.d.ts.map +1 -1
- package/dist/azure/financialSavingsAuthorityValidation.js +126 -2
- package/dist/azure/financialSavingsAuthorityValidation.js.map +1 -1
- package/dist/azure/financialSavingsCoordinateValidation.d.ts.map +1 -1
- package/dist/azure/financialSavingsCoordinateValidation.js +62 -19
- package/dist/azure/financialSavingsCoordinateValidation.js.map +1 -1
- package/dist/azure/financialSavingsSurfaceProjection.d.ts +58 -3
- package/dist/azure/financialSavingsSurfaceProjection.d.ts.map +1 -1
- package/dist/azure/financialSavingsSurfaceProjection.js +3 -1
- package/dist/azure/financialSavingsSurfaceProjection.js.map +1 -1
- package/dist/azure/financialSavingsSurfaceProjectionKernel.d.ts +14 -0
- package/dist/azure/financialSavingsSurfaceProjectionKernel.d.ts.map +1 -0
- package/dist/azure/financialSavingsSurfaceProjectionKernel.js +326 -0
- package/dist/azure/financialSavingsSurfaceProjectionKernel.js.map +1 -0
- package/dist/azure/financialSavingsSurfaceProjectionValidation.d.ts.map +1 -1
- package/dist/azure/financialSavingsSurfaceProjectionValidation.js +126 -12
- package/dist/azure/financialSavingsSurfaceProjectionValidation.js.map +1 -1
- package/dist/azure/financialScope.d.ts +6 -0
- package/dist/azure/financialScope.d.ts.map +1 -1
- package/dist/azure/financialScope.js +6 -0
- package/dist/azure/financialScope.js.map +1 -1
- package/dist/azure/governance.d.ts +145 -0
- package/dist/azure/governance.d.ts.map +1 -1
- package/dist/azure/governance.js +2 -1
- package/dist/azure/governance.js.map +1 -1
- package/dist/azure/metrics.d.ts +2 -2
- package/dist/azure/metrics.d.ts.map +1 -1
- package/dist/azure/payloads.d.ts +19 -0
- package/dist/azure/payloads.d.ts.map +1 -1
- package/dist/azure/prices.d.ts +16 -3
- package/dist/azure/prices.d.ts.map +1 -1
- package/dist/azure/recommendationState.d.ts +1 -1
- package/dist/azure/recommendationState.d.ts.map +1 -1
- package/dist/azure/recommendations.d.ts +15 -5
- package/dist/azure/recommendations.d.ts.map +1 -1
- package/dist/azure/reports.d.ts +3 -2
- package/dist/azure/reports.d.ts.map +1 -1
- package/dist/azure/reports.js.map +1 -1
- package/dist/azure/resources.d.ts +12 -0
- package/dist/azure/resources.d.ts.map +1 -1
- package/dist/azure/serviceRetirement.d.ts +33 -2
- package/dist/azure/serviceRetirement.d.ts.map +1 -1
- package/dist/azure/subscriptions.d.ts +13 -2
- package/dist/azure/subscriptions.d.ts.map +1 -1
- package/dist/azure/views.d.ts +26 -3
- package/dist/azure/views.d.ts.map +1 -1
- package/dist/azure/views.js.map +1 -1
- package/dist/azure/vmPatchManagement.d.ts +109 -0
- package/dist/azure/vmPatchManagement.d.ts.map +1 -0
- package/dist/azure/vmPatchManagement.js +7 -0
- package/dist/azure/vmPatchManagement.js.map +1 -0
- package/dist/common/provider.d.ts +53 -0
- package/dist/common/provider.d.ts.map +1 -1
- package/dist/common/provider.js.map +1 -1
- package/dist/environment/canonicalization.d.ts +12 -0
- package/dist/environment/canonicalization.d.ts.map +1 -0
- package/dist/environment/canonicalization.js +40 -0
- package/dist/environment/canonicalization.js.map +1 -0
- package/dist/environment/contracts.d.ts +196 -0
- package/dist/environment/contracts.d.ts.map +1 -0
- package/dist/environment/contracts.js +21 -0
- package/dist/environment/contracts.js.map +1 -0
- package/dist/environment/index.d.ts +5 -0
- package/dist/environment/index.d.ts.map +1 -0
- package/dist/environment/index.js +21 -0
- package/dist/environment/index.js.map +1 -0
- package/dist/environment/internal.d.ts +21 -0
- package/dist/environment/internal.d.ts.map +1 -0
- package/dist/environment/internal.js +113 -0
- package/dist/environment/internal.js.map +1 -0
- package/dist/environment/references.d.ts +18 -0
- package/dist/environment/references.d.ts.map +1 -0
- package/dist/environment/references.js +206 -0
- package/dist/environment/references.js.map +1 -0
- package/dist/environment/validation.d.ts +28 -0
- package/dist/environment/validation.d.ts.map +1 -0
- package/dist/environment/validation.js +320 -0
- package/dist/environment/validation.js.map +1 -0
- package/dist/esm/accounts/accounts.js +1 -0
- package/dist/esm/accounts/azureManualOnboarding.js +8 -0
- package/dist/esm/accounts/azureSpSetup.js +14 -1
- package/dist/esm/accounts/azureSpSetupDurable.js +27 -1
- package/dist/esm/accounts/index.js +1 -0
- package/dist/esm/ai/index.js +10 -1
- package/dist/esm/aws/commitments-planning.js +5 -0
- package/dist/esm/aws/estates.js +7 -1
- package/dist/esm/aws/index.js +5 -0
- package/dist/esm/aws/organizationCommitments.js +48 -0
- package/dist/esm/aws/organizationCommitmentsApiValidation.js +220 -0
- package/dist/esm/aws/organizationCommitmentsValidation.js +224 -0
- package/dist/esm/aws/portalOrganizationCommitmentsPlanningPublicArtifactValidation.js +402 -0
- package/dist/esm/aws/portalOrganizationCommitmentsPlanningPublicArtifacts.js +2 -0
- package/dist/esm/aws/requests.js +1 -1
- package/dist/esm/azure/financialAnalyticsDelivery.js +2 -0
- package/dist/esm/azure/financialAnalyticsDisplayKernel.js +139 -0
- package/dist/esm/azure/financialAnalyticsValidation.js +61 -7
- package/dist/esm/azure/financialAuthorityProjectionKernel.js +159 -0
- package/dist/esm/azure/financialAuthorityViewValidation.js +204 -1
- package/dist/esm/azure/financialChargeComposition.js +36 -0
- package/dist/esm/azure/financialChargeCompositionKernel.js +48 -0
- package/dist/esm/azure/financialChargeCompositionValidation.js +155 -0
- package/dist/esm/azure/financialDataflowKernel.js +60 -7
- package/dist/esm/azure/financialDataflowValidation.js +146 -28
- package/dist/esm/azure/financialPolicyValidation.js +5 -0
- package/dist/esm/azure/financialProjectionValidation.js +43 -3
- package/dist/esm/azure/financialSavingsAuthorityValidation.js +124 -2
- package/dist/esm/azure/financialSavingsCoordinateValidation.js +62 -19
- package/dist/esm/azure/financialSavingsSurfaceProjection.js +2 -0
- package/dist/esm/azure/financialSavingsSurfaceProjectionKernel.js +318 -0
- package/dist/esm/azure/financialSavingsSurfaceProjectionValidation.js +126 -12
- package/dist/esm/azure/financialScope.js +6 -0
- package/dist/esm/azure/governance.js +1 -0
- package/dist/esm/azure/vmPatchManagement.js +3 -0
- package/dist/esm/entries/commitments-planning.js +2 -2
- package/dist/esm/entries/environment.js +3 -0
- package/dist/esm/environment/canonicalization.js +34 -0
- package/dist/esm/environment/contracts.js +17 -0
- package/dist/esm/environment/index.js +4 -0
- package/dist/esm/environment/internal.js +97 -0
- package/dist/esm/environment/references.js +194 -0
- package/dist/esm/environment/validation.js +303 -0
- package/dist/esm/index.js +2 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +2 -0
- package/dist/index.js.map +1 -1
- package/dist/portfolio/portfolioOperations.d.ts +1 -1
- package/dist/portfolio/portfolioOperations.d.ts.map +1 -1
- package/package.json +15 -3
|
@@ -0,0 +1,402 @@
|
|
|
1
|
+
import { AWS_ORGANIZATION_COMMITMENTS_ATTRIBUTION_UNAVAILABLE_REASONS, } from './organizationCommitments.js';
|
|
2
|
+
import { validateAwsOrganizationCommitmentsPlanningViewIdentity, } from './organizationCommitmentsValidation.js';
|
|
3
|
+
import { AWS_ORGANIZATION_COMMITMENTS_PLANNING_LOGICAL_NAME, AWS_ORGANIZATION_COMMITMENTS_PUBLIC_ARTIFACT_SCHEMA_VERSION, } from './portalOrganizationCommitmentsPlanningPublicArtifacts.js';
|
|
4
|
+
import { AWS_PORTAL_PUBLIC_ARTIFACT_SCHEMA_VERSION } from './portalPublicArtifacts.js';
|
|
5
|
+
import { asRecord, assertExactKeys, assertPublicJson, assertValue, finiteNumber, isoTimestamp, requiredEnum, requiredString, validateGeneration, } from './portalPublicArtifactValidationCommon.js';
|
|
6
|
+
const TOP_LEVEL_KEYS = [
|
|
7
|
+
'schemaVersion',
|
|
8
|
+
'portalSchemaVersion',
|
|
9
|
+
'provider',
|
|
10
|
+
'artifactType',
|
|
11
|
+
'artifactGeneration',
|
|
12
|
+
'logicalName',
|
|
13
|
+
'manifestRevision',
|
|
14
|
+
'version',
|
|
15
|
+
'generatedAt',
|
|
16
|
+
'month',
|
|
17
|
+
'providerScope',
|
|
18
|
+
'accounts',
|
|
19
|
+
'utilizationSummary',
|
|
20
|
+
'expirySummary',
|
|
21
|
+
'inventory',
|
|
22
|
+
'payerAggregates',
|
|
23
|
+
'sharingPosture',
|
|
24
|
+
'pricingContext',
|
|
25
|
+
'freshness',
|
|
26
|
+
'purchaseRecommendations',
|
|
27
|
+
'allocation',
|
|
28
|
+
'resourceAttribution',
|
|
29
|
+
];
|
|
30
|
+
/** Validates one untrusted organization Commitments Planning view without its Portal envelope. */
|
|
31
|
+
export function validateAwsOrganizationCommitmentsPlanningView(value, expected) {
|
|
32
|
+
validateAwsOrganizationCommitmentsPlanningViewIdentity(value, expected);
|
|
33
|
+
validateBody(value);
|
|
34
|
+
assertPublicJson(value, 'organizationCommitmentsPlanning');
|
|
35
|
+
return value;
|
|
36
|
+
}
|
|
37
|
+
/** Validates one untrusted immutable AWS organization Commitments Planning artifact. */
|
|
38
|
+
export function validateAwsPortalOrganizationCommitmentsPlanningArtifact(value, expected) {
|
|
39
|
+
const artifact = asRecord(value, 'artifact');
|
|
40
|
+
assertExactKeys(artifact, TOP_LEVEL_KEYS, 'artifact');
|
|
41
|
+
assertValue(artifact.schemaVersion, AWS_ORGANIZATION_COMMITMENTS_PUBLIC_ARTIFACT_SCHEMA_VERSION, 'artifact.schemaVersion');
|
|
42
|
+
assertValue(artifact.portalSchemaVersion, AWS_PORTAL_PUBLIC_ARTIFACT_SCHEMA_VERSION, 'artifact.portalSchemaVersion');
|
|
43
|
+
assertValue(artifact.provider, 'aws', 'artifact.provider');
|
|
44
|
+
assertValue(artifact.artifactType, 'organization-commitments-planning', 'artifact.artifactType');
|
|
45
|
+
assertValue(artifact.logicalName, AWS_ORGANIZATION_COMMITMENTS_PLANNING_LOGICAL_NAME, 'artifact.logicalName');
|
|
46
|
+
requiredString(artifact.manifestRevision, 'artifact.manifestRevision');
|
|
47
|
+
assertValue(artifact.version, '1.0', 'artifact.version');
|
|
48
|
+
const generation = validateGeneration(artifact.artifactGeneration, 'artifact.artifactGeneration');
|
|
49
|
+
const generatedAt = isoTimestamp(artifact.generatedAt, 'artifact.generatedAt');
|
|
50
|
+
if (Date.parse(generatedAt) > Date.parse(generation.generatedAt)) {
|
|
51
|
+
throw new Error('artifact.generatedAt must not be newer than the Portal generation.');
|
|
52
|
+
}
|
|
53
|
+
if (artifact.month !== undefined)
|
|
54
|
+
requiredString(artifact.month, 'artifact.month');
|
|
55
|
+
validateAwsOrganizationCommitmentsPlanningView(artifact, expected);
|
|
56
|
+
assertPublicJson(artifact, 'artifact');
|
|
57
|
+
return value;
|
|
58
|
+
}
|
|
59
|
+
function validateBody(view) {
|
|
60
|
+
records(view.accounts, 'artifact.accounts', validateAccount);
|
|
61
|
+
validateUtilizationSummary(view.utilizationSummary, 'artifact.utilizationSummary');
|
|
62
|
+
exact(view.expirySummary, ['expired', 'expiring30d', 'expiring60d', 'expiring90d', 'expiring180d'], 'artifact.expirySummary');
|
|
63
|
+
records(view.inventory, 'artifact.inventory', validateInventory);
|
|
64
|
+
records(view.payerAggregates, 'artifact.payerAggregates', validatePayerAggregate);
|
|
65
|
+
validateSharingPosture(view.sharingPosture, 'artifact.sharingPosture');
|
|
66
|
+
validatePricingContext(view.pricingContext, 'artifact.pricingContext');
|
|
67
|
+
optionalRecord(view.freshness, 'artifact.freshness', validateFreshness);
|
|
68
|
+
optionalRecords(view.purchaseRecommendations, 'artifact.purchaseRecommendations', validatePurchaseRecommendation);
|
|
69
|
+
validateAttribution(view.allocation, 'artifact.allocation', validateAllocationRecord);
|
|
70
|
+
validateAttribution(view.resourceAttribution, 'artifact.resourceAttribution', validateResourceAttributionRecord);
|
|
71
|
+
}
|
|
72
|
+
function validateSharingPosture(value, field) {
|
|
73
|
+
const posture = exact(value, ['status', 'reason'], field);
|
|
74
|
+
assertValue(posture.status, 'unknown', `${field}.status`);
|
|
75
|
+
assertValue(posture.reason, 'not-collected', `${field}.reason`);
|
|
76
|
+
}
|
|
77
|
+
function validateAccount(value, field) {
|
|
78
|
+
const account = exact(value, ['accountId', 'displayName', 'role', 'inventoryStatus', 'lastSuccessfulRefreshAt'], field);
|
|
79
|
+
requiredString(account.accountId, `${field}.accountId`);
|
|
80
|
+
optionalString(account.displayName, `${field}.displayName`);
|
|
81
|
+
requiredEnum(account.role, ['management', 'member'], `${field}.role`);
|
|
82
|
+
requiredEnum(account.inventoryStatus, ['current', 'stale', 'partial', 'unavailable'], `${field}.inventoryStatus`);
|
|
83
|
+
optionalTimestamp(account.lastSuccessfulRefreshAt, `${field}.lastSuccessfulRefreshAt`);
|
|
84
|
+
}
|
|
85
|
+
function validateUtilizationSummary(value, field) {
|
|
86
|
+
const summary = exact(value, ['total', 'withData', 'sevenDayAverage', 'thirtyDayAverage', 'sevenDayAggregates', 'thirtyDayAggregates', 'byBenefitType'], field);
|
|
87
|
+
nonNegative(summary.total, `${field}.total`);
|
|
88
|
+
nonNegative(summary.withData, `${field}.withData`);
|
|
89
|
+
optionalNumber(summary.sevenDayAverage, `${field}.sevenDayAverage`);
|
|
90
|
+
optionalNumber(summary.thirtyDayAverage, `${field}.thirtyDayAverage`);
|
|
91
|
+
optionalRecords(summary.sevenDayAggregates, `${field}.sevenDayAggregates`, validateWeightedAggregate);
|
|
92
|
+
optionalRecords(summary.thirtyDayAggregates, `${field}.thirtyDayAggregates`, validateWeightedAggregate);
|
|
93
|
+
records(summary.byBenefitType, `${field}.byBenefitType`, (entry, itemField) => {
|
|
94
|
+
const item = exact(entry, ['benefitType', 'total', 'withData', 'sevenDayAverage', 'thirtyDayAverage', 'sevenDayAggregates', 'thirtyDayAggregates'], itemField);
|
|
95
|
+
requiredEnum(item.benefitType, ['reservation', 'savings-plan'], `${itemField}.benefitType`);
|
|
96
|
+
nonNegative(item.total, `${itemField}.total`);
|
|
97
|
+
nonNegative(item.withData, `${itemField}.withData`);
|
|
98
|
+
optionalNumber(item.sevenDayAverage, `${itemField}.sevenDayAverage`);
|
|
99
|
+
optionalNumber(item.thirtyDayAverage, `${itemField}.thirtyDayAverage`);
|
|
100
|
+
optionalRecords(item.sevenDayAggregates, `${itemField}.sevenDayAggregates`, validateWeightedAggregate);
|
|
101
|
+
optionalRecords(item.thirtyDayAggregates, `${itemField}.thirtyDayAggregates`, validateWeightedAggregate);
|
|
102
|
+
});
|
|
103
|
+
}
|
|
104
|
+
function validateWeightedAggregate(value, field) {
|
|
105
|
+
const aggregate = exact(value, ['used', 'reserved', 'percentage', 'sampleCount', 'unit', 'currency'], field);
|
|
106
|
+
finiteNumber(aggregate.used, `${field}.used`);
|
|
107
|
+
finiteNumber(aggregate.reserved, `${field}.reserved`);
|
|
108
|
+
optionalNumber(aggregate.percentage, `${field}.percentage`);
|
|
109
|
+
if (aggregate.sampleCount !== undefined)
|
|
110
|
+
nonNegative(aggregate.sampleCount, `${field}.sampleCount`);
|
|
111
|
+
requiredEnum(aggregate.unit, ['hours', 'quantity', 'currency'], `${field}.unit`);
|
|
112
|
+
optionalString(aggregate.currency, `${field}.currency`);
|
|
113
|
+
}
|
|
114
|
+
function validateInventory(value, field) {
|
|
115
|
+
const item = exact(value, [
|
|
116
|
+
'id',
|
|
117
|
+
'benefitType',
|
|
118
|
+
'commitmentFamily',
|
|
119
|
+
'sourceKind',
|
|
120
|
+
'sourceId',
|
|
121
|
+
'provider',
|
|
122
|
+
'ownerAccountId',
|
|
123
|
+
'shape',
|
|
124
|
+
'scope',
|
|
125
|
+
'type',
|
|
126
|
+
'displayName',
|
|
127
|
+
'status',
|
|
128
|
+
'purchaseDate',
|
|
129
|
+
'expiryDate',
|
|
130
|
+
'daysToExpiry',
|
|
131
|
+
'commitmentAmount',
|
|
132
|
+
'commitmentCurrencyCode',
|
|
133
|
+
'commitmentGrain',
|
|
134
|
+
'commitmentUnit',
|
|
135
|
+
'skuName',
|
|
136
|
+
'location',
|
|
137
|
+
'term',
|
|
138
|
+
'termMonths',
|
|
139
|
+
'billingPlan',
|
|
140
|
+
'utilization',
|
|
141
|
+
], field);
|
|
142
|
+
requiredString(item.id, `${field}.id`);
|
|
143
|
+
requiredEnum(item.benefitType, ['reservation', 'savings-plan'], `${field}.benefitType`);
|
|
144
|
+
optionalString(item.commitmentFamily, `${field}.commitmentFamily`);
|
|
145
|
+
assertValue(item.sourceKind, 'aws-native', `${field}.sourceKind`);
|
|
146
|
+
optionalString(item.sourceId, `${field}.sourceId`);
|
|
147
|
+
assertValue(item.provider, 'aws', `${field}.provider`);
|
|
148
|
+
requiredString(item.ownerAccountId, `${field}.ownerAccountId`);
|
|
149
|
+
optionalRecord(item.shape, `${field}.shape`, validateShape);
|
|
150
|
+
requiredEnum(item.scope, ['Shared', 'Single', 'ManagementGroup', 'Unknown'], `${field}.scope`);
|
|
151
|
+
requiredString(item.type, `${field}.type`);
|
|
152
|
+
optionalString(item.displayName, `${field}.displayName`);
|
|
153
|
+
requiredString(item.status, `${field}.status`);
|
|
154
|
+
optionalString(item.purchaseDate, `${field}.purchaseDate`);
|
|
155
|
+
optionalString(item.expiryDate, `${field}.expiryDate`);
|
|
156
|
+
optionalNumber(item.daysToExpiry, `${field}.daysToExpiry`);
|
|
157
|
+
optionalNumber(item.commitmentAmount, `${field}.commitmentAmount`);
|
|
158
|
+
optionalString(item.commitmentCurrencyCode, `${field}.commitmentCurrencyCode`);
|
|
159
|
+
optionalString(item.commitmentGrain, `${field}.commitmentGrain`);
|
|
160
|
+
optionalString(item.commitmentUnit, `${field}.commitmentUnit`);
|
|
161
|
+
optionalString(item.skuName, `${field}.skuName`);
|
|
162
|
+
optionalString(item.location, `${field}.location`);
|
|
163
|
+
optionalString(item.term, `${field}.term`);
|
|
164
|
+
optionalNumber(item.termMonths, `${field}.termMonths`);
|
|
165
|
+
optionalString(item.billingPlan, `${field}.billingPlan`);
|
|
166
|
+
optionalRecord(item.utilization, `${field}.utilization`, validateUtilization);
|
|
167
|
+
}
|
|
168
|
+
function validatePayerAggregate(value, field) {
|
|
169
|
+
const aggregate = exact(value, [
|
|
170
|
+
'benefitType',
|
|
171
|
+
'commitmentFamily',
|
|
172
|
+
'payerAccountId',
|
|
173
|
+
'windowStart',
|
|
174
|
+
'windowEnd',
|
|
175
|
+
'eligibleCost',
|
|
176
|
+
'coveredCost',
|
|
177
|
+
'uncoveredCost',
|
|
178
|
+
'coveragePercent',
|
|
179
|
+
'utilization',
|
|
180
|
+
'source',
|
|
181
|
+
], field);
|
|
182
|
+
requiredEnum(aggregate.benefitType, ['reservation', 'savings-plan'], `${field}.benefitType`);
|
|
183
|
+
requiredString(aggregate.commitmentFamily, `${field}.commitmentFamily`);
|
|
184
|
+
requiredString(aggregate.payerAccountId, `${field}.payerAccountId`);
|
|
185
|
+
requiredString(aggregate.windowStart, `${field}.windowStart`);
|
|
186
|
+
requiredString(aggregate.windowEnd, `${field}.windowEnd`);
|
|
187
|
+
optionalRecord(aggregate.eligibleCost, `${field}.eligibleCost`, validateMoney);
|
|
188
|
+
optionalRecord(aggregate.coveredCost, `${field}.coveredCost`, validateMoney);
|
|
189
|
+
optionalRecord(aggregate.uncoveredCost, `${field}.uncoveredCost`, validateMoney);
|
|
190
|
+
optionalNumber(aggregate.coveragePercent, `${field}.coveragePercent`);
|
|
191
|
+
optionalRecord(aggregate.utilization, `${field}.utilization`, validateUtilization);
|
|
192
|
+
validateSource(aggregate.source, `${field}.source`, false);
|
|
193
|
+
}
|
|
194
|
+
function validatePurchaseRecommendation(value, field) {
|
|
195
|
+
const recommendation = exact(value, [
|
|
196
|
+
'id',
|
|
197
|
+
'groupKey',
|
|
198
|
+
'commitmentFamily',
|
|
199
|
+
'action',
|
|
200
|
+
'purchaseScope',
|
|
201
|
+
'payerAccountId',
|
|
202
|
+
'recommendedAccountId',
|
|
203
|
+
'source',
|
|
204
|
+
'targetShape',
|
|
205
|
+
'title',
|
|
206
|
+
'description',
|
|
207
|
+
'confidence',
|
|
208
|
+
'riskLevel',
|
|
209
|
+
'termMonths',
|
|
210
|
+
'quantity',
|
|
211
|
+
'estimatedAnnualSavings',
|
|
212
|
+
'estimatedAnnualCost',
|
|
213
|
+
'estimatedTermSavings',
|
|
214
|
+
'estimatedTermCost',
|
|
215
|
+
'notes',
|
|
216
|
+
], field);
|
|
217
|
+
requiredString(recommendation.id, `${field}.id`);
|
|
218
|
+
requiredString(recommendation.groupKey, `${field}.groupKey`);
|
|
219
|
+
requiredString(recommendation.commitmentFamily, `${field}.commitmentFamily`);
|
|
220
|
+
requiredEnum(recommendation.action, ['buy', 'unlock', 'savings-plan', 'none'], `${field}.action`);
|
|
221
|
+
assertValue(recommendation.purchaseScope, 'payer', `${field}.purchaseScope`);
|
|
222
|
+
requiredString(recommendation.payerAccountId, `${field}.payerAccountId`);
|
|
223
|
+
optionalString(recommendation.recommendedAccountId, `${field}.recommendedAccountId`);
|
|
224
|
+
validateSource(recommendation.source, `${field}.source`, false);
|
|
225
|
+
validateShape(recommendation.targetShape, `${field}.targetShape`);
|
|
226
|
+
optionalString(recommendation.title, `${field}.title`);
|
|
227
|
+
optionalString(recommendation.description, `${field}.description`);
|
|
228
|
+
optionalString(recommendation.confidence, `${field}.confidence`);
|
|
229
|
+
optionalString(recommendation.riskLevel, `${field}.riskLevel`);
|
|
230
|
+
optionalNumber(recommendation.termMonths, `${field}.termMonths`);
|
|
231
|
+
optionalNumber(recommendation.quantity, `${field}.quantity`);
|
|
232
|
+
optionalRecord(recommendation.estimatedAnnualSavings, `${field}.estimatedAnnualSavings`, validateMoney);
|
|
233
|
+
optionalRecord(recommendation.estimatedAnnualCost, `${field}.estimatedAnnualCost`, validateMoney);
|
|
234
|
+
optionalRecord(recommendation.estimatedTermSavings, `${field}.estimatedTermSavings`, validateMoney);
|
|
235
|
+
optionalRecord(recommendation.estimatedTermCost, `${field}.estimatedTermCost`, validateMoney);
|
|
236
|
+
optionalStrings(recommendation.notes, `${field}.notes`);
|
|
237
|
+
}
|
|
238
|
+
function validateAttribution(value, field, validateRecord) {
|
|
239
|
+
const evidence = asRecord(value, field);
|
|
240
|
+
if (evidence.status === 'unavailable') {
|
|
241
|
+
assertExactKeys(evidence, ['status', 'reason'], field);
|
|
242
|
+
requiredEnum(evidence.reason, AWS_ORGANIZATION_COMMITMENTS_ATTRIBUTION_UNAVAILABLE_REASONS, `${field}.reason`);
|
|
243
|
+
return;
|
|
244
|
+
}
|
|
245
|
+
assertValue(evidence.status, 'available', `${field}.status`);
|
|
246
|
+
assertExactKeys(evidence, ['status', 'source', 'records'], field);
|
|
247
|
+
validateSource(evidence.source, `${field}.source`, true);
|
|
248
|
+
records(evidence.records, `${field}.records`, validateRecord, true);
|
|
249
|
+
}
|
|
250
|
+
function validateAllocationRecord(value, field) {
|
|
251
|
+
const record = exact(value, [
|
|
252
|
+
'beneficiaryAccountId',
|
|
253
|
+
'ownerAccountId',
|
|
254
|
+
'commitmentId',
|
|
255
|
+
'benefitType',
|
|
256
|
+
'commitmentFamily',
|
|
257
|
+
'windowStart',
|
|
258
|
+
'windowEnd',
|
|
259
|
+
'eligibleCost',
|
|
260
|
+
'coveredCost',
|
|
261
|
+
'uncoveredCost',
|
|
262
|
+
], field);
|
|
263
|
+
requiredString(record.beneficiaryAccountId, `${field}.beneficiaryAccountId`);
|
|
264
|
+
optionalString(record.ownerAccountId, `${field}.ownerAccountId`);
|
|
265
|
+
optionalString(record.commitmentId, `${field}.commitmentId`);
|
|
266
|
+
requiredEnum(record.benefitType, ['reservation', 'savings-plan'], `${field}.benefitType`);
|
|
267
|
+
requiredString(record.commitmentFamily, `${field}.commitmentFamily`);
|
|
268
|
+
requiredString(record.windowStart, `${field}.windowStart`);
|
|
269
|
+
requiredString(record.windowEnd, `${field}.windowEnd`);
|
|
270
|
+
optionalRecord(record.eligibleCost, `${field}.eligibleCost`, validateMoney);
|
|
271
|
+
optionalRecord(record.coveredCost, `${field}.coveredCost`, validateMoney);
|
|
272
|
+
optionalRecord(record.uncoveredCost, `${field}.uncoveredCost`, validateMoney);
|
|
273
|
+
}
|
|
274
|
+
function validateResourceAttributionRecord(value, field) {
|
|
275
|
+
const record = exact(value, ['accountId', 'resourceId', 'resourceName', 'resourceType', 'benefitIds', 'windowStart', 'windowEnd', 'coveredCost'], field);
|
|
276
|
+
requiredString(record.accountId, `${field}.accountId`);
|
|
277
|
+
requiredString(record.resourceId, `${field}.resourceId`);
|
|
278
|
+
optionalString(record.resourceName, `${field}.resourceName`);
|
|
279
|
+
optionalString(record.resourceType, `${field}.resourceType`);
|
|
280
|
+
strings(record.benefitIds, `${field}.benefitIds`);
|
|
281
|
+
requiredString(record.windowStart, `${field}.windowStart`);
|
|
282
|
+
requiredString(record.windowEnd, `${field}.windowEnd`);
|
|
283
|
+
optionalRecord(record.coveredCost, `${field}.coveredCost`, validateMoney);
|
|
284
|
+
}
|
|
285
|
+
function validateShape(value, field) {
|
|
286
|
+
const shape = exact(value, [
|
|
287
|
+
'provider',
|
|
288
|
+
'resourceType',
|
|
289
|
+
'commitmentFamily',
|
|
290
|
+
'skuName',
|
|
291
|
+
'normalizedSkuName',
|
|
292
|
+
'location',
|
|
293
|
+
'region',
|
|
294
|
+
'availabilityZone',
|
|
295
|
+
'platform',
|
|
296
|
+
'reservationProductName',
|
|
297
|
+
'reservedResourceType',
|
|
298
|
+
'meterCategory',
|
|
299
|
+
'meterSubCategory',
|
|
300
|
+
'meterName',
|
|
301
|
+
'unit',
|
|
302
|
+
'attributes',
|
|
303
|
+
], field);
|
|
304
|
+
assertValue(shape.provider, 'aws', `${field}.provider`);
|
|
305
|
+
if (shape.attributes !== undefined)
|
|
306
|
+
asRecord(shape.attributes, `${field}.attributes`);
|
|
307
|
+
}
|
|
308
|
+
function validateSource(value, field, allowDerived) {
|
|
309
|
+
const source = exact(value, ['sourceKind', 'sourceId', 'sourceName', 'generatedAt', 'observedAt', 'notes'], field);
|
|
310
|
+
requiredEnum(source.sourceKind, allowDerived ? ['aws-native', 'spotto-derived'] : ['aws-native'], `${field}.sourceKind`);
|
|
311
|
+
optionalString(source.sourceId, `${field}.sourceId`);
|
|
312
|
+
optionalString(source.sourceName, `${field}.sourceName`);
|
|
313
|
+
optionalTimestamp(source.generatedAt, `${field}.generatedAt`);
|
|
314
|
+
optionalTimestamp(source.observedAt, `${field}.observedAt`);
|
|
315
|
+
optionalStrings(source.notes, `${field}.notes`);
|
|
316
|
+
}
|
|
317
|
+
function validateMoney(value, field) {
|
|
318
|
+
const money = exact(value, ['amount', 'currency', 'source', 'windowStart', 'windowEnd', 'flags'], field);
|
|
319
|
+
finiteNumber(money.amount, `${field}.amount`);
|
|
320
|
+
requiredString(money.currency, `${field}.currency`);
|
|
321
|
+
optionalString(money.source, `${field}.source`);
|
|
322
|
+
optionalString(money.windowStart, `${field}.windowStart`);
|
|
323
|
+
optionalString(money.windowEnd, `${field}.windowEnd`);
|
|
324
|
+
optionalStrings(money.flags, `${field}.flags`);
|
|
325
|
+
}
|
|
326
|
+
function validateUtilization(value, field) {
|
|
327
|
+
const utilization = exact(value, ['trend', 'oneDay', 'sevenDay', 'thirtyDay', 'source'], field);
|
|
328
|
+
optionalString(utilization.trend, `${field}.trend`);
|
|
329
|
+
optionalNumber(utilization.oneDay, `${field}.oneDay`);
|
|
330
|
+
optionalNumber(utilization.sevenDay, `${field}.sevenDay`);
|
|
331
|
+
optionalNumber(utilization.thirtyDay, `${field}.thirtyDay`);
|
|
332
|
+
optionalString(utilization.source, `${field}.source`);
|
|
333
|
+
}
|
|
334
|
+
function validatePricingContext(value, field) {
|
|
335
|
+
const pricing = exact(value, ['source', 'currency', 'assumptions', 'confidenceNotes', 'calculatorDeepLink'], field);
|
|
336
|
+
requiredEnum(pricing.source, ['retail', 'negotiated', 'unknown', 'recommendation-apis'], `${field}.source`);
|
|
337
|
+
optionalString(pricing.currency, `${field}.currency`);
|
|
338
|
+
optionalStrings(pricing.assumptions, `${field}.assumptions`);
|
|
339
|
+
optionalString(pricing.confidenceNotes, `${field}.confidenceNotes`);
|
|
340
|
+
optionalString(pricing.calculatorDeepLink, `${field}.calculatorDeepLink`);
|
|
341
|
+
}
|
|
342
|
+
function validateFreshness(value, field) {
|
|
343
|
+
const freshness = exact(value, ['status', 'generatedAt', 'entries', 'warnings'], field);
|
|
344
|
+
requiredEnum(freshness.status, ['current', 'stale', 'partial', 'unavailable'], `${field}.status`);
|
|
345
|
+
isoTimestamp(freshness.generatedAt, `${field}.generatedAt`);
|
|
346
|
+
records(freshness.entries, `${field}.entries`, (entry, itemField) => {
|
|
347
|
+
const item = exact(entry, ['section', 'status', 'generatedAt', 'observedAt', 'lastSuccessfulSyncAt', 'reason', 'sourceKind'], itemField);
|
|
348
|
+
requiredString(item.section, `${itemField}.section`);
|
|
349
|
+
requiredEnum(item.status, ['current', 'stale', 'partial', 'unavailable'], `${itemField}.status`);
|
|
350
|
+
optionalTimestamp(item.generatedAt, `${itemField}.generatedAt`);
|
|
351
|
+
optionalTimestamp(item.observedAt, `${itemField}.observedAt`);
|
|
352
|
+
optionalTimestamp(item.lastSuccessfulSyncAt, `${itemField}.lastSuccessfulSyncAt`);
|
|
353
|
+
optionalString(item.reason, `${itemField}.reason`);
|
|
354
|
+
optionalString(item.sourceKind, `${itemField}.sourceKind`);
|
|
355
|
+
});
|
|
356
|
+
optionalStrings(freshness.warnings, `${field}.warnings`);
|
|
357
|
+
}
|
|
358
|
+
function exact(value, allowed, field) {
|
|
359
|
+
const record = asRecord(value, field);
|
|
360
|
+
assertExactKeys(record, allowed, field);
|
|
361
|
+
return record;
|
|
362
|
+
}
|
|
363
|
+
function records(value, field, validate, nonEmpty = false) {
|
|
364
|
+
if (!Array.isArray(value) || (nonEmpty && value.length === 0)) {
|
|
365
|
+
throw new Error(`${field} must be ${nonEmpty ? 'a non-empty' : 'an'} array.`);
|
|
366
|
+
}
|
|
367
|
+
value.forEach((entry, index) => validate(entry, `${field}[${index}]`));
|
|
368
|
+
}
|
|
369
|
+
function optionalRecords(value, field, validate) {
|
|
370
|
+
if (value !== undefined)
|
|
371
|
+
records(value, field, validate);
|
|
372
|
+
}
|
|
373
|
+
function optionalRecord(value, field, validate) {
|
|
374
|
+
if (value !== undefined)
|
|
375
|
+
validate(value, field);
|
|
376
|
+
}
|
|
377
|
+
function strings(value, field) {
|
|
378
|
+
if (!Array.isArray(value))
|
|
379
|
+
throw new Error(`${field} must be an array.`);
|
|
380
|
+
value.forEach((entry, index) => requiredString(entry, `${field}[${index}]`));
|
|
381
|
+
}
|
|
382
|
+
function optionalStrings(value, field) {
|
|
383
|
+
if (value !== undefined)
|
|
384
|
+
strings(value, field);
|
|
385
|
+
}
|
|
386
|
+
function optionalString(value, field) {
|
|
387
|
+
if (value !== undefined)
|
|
388
|
+
requiredString(value, field);
|
|
389
|
+
}
|
|
390
|
+
function optionalTimestamp(value, field) {
|
|
391
|
+
if (value !== undefined)
|
|
392
|
+
isoTimestamp(value, field);
|
|
393
|
+
}
|
|
394
|
+
function optionalNumber(value, field) {
|
|
395
|
+
if (value !== undefined)
|
|
396
|
+
finiteNumber(value, field);
|
|
397
|
+
}
|
|
398
|
+
function nonNegative(value, field) {
|
|
399
|
+
const number = finiteNumber(value, field);
|
|
400
|
+
if (number < 0)
|
|
401
|
+
throw new Error(`${field} must not be negative.`);
|
|
402
|
+
}
|
package/dist/esm/aws/requests.js
CHANGED
|
@@ -3,7 +3,7 @@ export const AWS_COMMAND_SCHEMA_VERSION = 1;
|
|
|
3
3
|
/** Canonical provider wire value for AWS commands. */
|
|
4
4
|
export const AWS_COMMAND_PROVIDER = 'aws';
|
|
5
5
|
/** Entities handled by AWS estate orchestration. */
|
|
6
|
-
export const AWS_COMMAND_ENTITIES = ['estate', 'account', 'billing-source'];
|
|
6
|
+
export const AWS_COMMAND_ENTITIES = ['estate', 'account', 'billing-source', 'organization-commitments'];
|
|
7
7
|
/** Actions supported across AWS estate orchestration commands. */
|
|
8
8
|
export const AWS_COMMAND_ACTIONS = ['reconcile', 'refresh', 'delete'];
|
|
9
9
|
/** Credential-shaped keys forbidden from shared AWS configuration and commands. */
|
|
@@ -1,7 +1,9 @@
|
|
|
1
1
|
export const FINANCIAL_ANALYTICS_JOB_REQUEST_CONTRACT_VERSION_V1 = 'financial-analytics-job-request/v1';
|
|
2
2
|
export const FINANCIAL_ANALYTICS_CURRENT_POINTER_CONTRACT_VERSION_V1 = 'financial-analytics-current-pointer/v1';
|
|
3
3
|
export const FINANCIAL_ANALYTICS_INPUT_LOGICAL_NAME_V1 = 'financial-analytics-input.json.gz';
|
|
4
|
+
export const FINANCIAL_ANALYTICS_INPUT_BY_ID_ROOT_V1 = 'financial-analytics/inputs-by-id';
|
|
4
5
|
export const FINANCIAL_ANALYTICS_PROJECTION_LOGICAL_NAME_V1 = 'financial-analytics-projection.json.gz';
|
|
5
6
|
export const FINANCIAL_ANALYTICS_BATCH_QUERY_CONTRACT_VERSION_V1 = 'financial-analytics-batch-query/v1';
|
|
6
7
|
export const FINANCIAL_ANALYTICS_BATCH_RESPONSE_CONTRACT_VERSION_V1 = 'financial-analytics-batch-response/v1';
|
|
7
8
|
export const FINANCIAL_ANALYTICS_OUTPUT_MANIFEST_CONTRACT_VERSION_V1 = 'financial-analytics-output-manifest/v1';
|
|
9
|
+
export const financialAnalyticsInputByIdPathV1 = (analyticsInputId) => `${FINANCIAL_ANALYTICS_INPUT_BY_ID_ROOT_V1}/${analyticsInputId}/${FINANCIAL_ANALYTICS_INPUT_LOGICAL_NAME_V1}`;
|
|
@@ -0,0 +1,139 @@
|
|
|
1
|
+
import { formatExactDecimalValue, parseCanonicalDecimal, sumCanonicalDecimals } from '../common/exactDecimal.js';
|
|
2
|
+
import { isFinancialAnalyticsInputSeriesV1 } from './financialAnalyticsValidation.js';
|
|
3
|
+
const DAY_MS = 86400000;
|
|
4
|
+
const HISTORY_NOT_PRODUCED = 'history-not-produced';
|
|
5
|
+
const CALENDAR_PERIOD_INCOMPLETE = 'calendar-period-incomplete';
|
|
6
|
+
const addUtcDays = (date, days) => new Date(Date.parse(`${date}T00:00:00.000Z`) + days * DAY_MS).toISOString().slice(0, 10);
|
|
7
|
+
const shiftUtcMonths = (date, months) => {
|
|
8
|
+
const parsed = new Date(`${date}T00:00:00.000Z`);
|
|
9
|
+
return new Date(Date.UTC(parsed.getUTCFullYear(), parsed.getUTCMonth() + months, 1)).toISOString().slice(0, 10);
|
|
10
|
+
};
|
|
11
|
+
const uniqueReasons = (values) => {
|
|
12
|
+
const reasons = [...new Set(values)].sort();
|
|
13
|
+
return (reasons.length > 0 ? reasons : [HISTORY_NOT_PRODUCED]);
|
|
14
|
+
};
|
|
15
|
+
/** Twelve-decimal half-away-from-zero display average; totals remain exact. */
|
|
16
|
+
const averageKnownPerDay = (amount, dayCount) => {
|
|
17
|
+
if (!Number.isSafeInteger(dayCount) || dayCount < 1)
|
|
18
|
+
throw new RangeError('Display average requires a positive day count.');
|
|
19
|
+
const value = parseCanonicalDecimal(amount);
|
|
20
|
+
const precision = 12;
|
|
21
|
+
const numerator = (value.coefficient < 0n ? -value.coefficient : value.coefficient) * 10n ** BigInt(precision);
|
|
22
|
+
const scaledDivisor = BigInt(dayCount) * 10n ** BigInt(value.scale);
|
|
23
|
+
let quotient = numerator / scaledDivisor;
|
|
24
|
+
const remainder = numerator % scaledDivisor;
|
|
25
|
+
if (remainder * 2n >= scaledDivisor)
|
|
26
|
+
quotient += 1n;
|
|
27
|
+
return formatExactDecimalValue({ coefficient: value.coefficient < 0n ? -quotient : quotient, scale: precision });
|
|
28
|
+
};
|
|
29
|
+
const requestedInterval = (input, periodKey) => {
|
|
30
|
+
const endDateExclusive = input.coordinate.period.requested.endDateExclusive;
|
|
31
|
+
const startDate = periodKey === 'last-7-days'
|
|
32
|
+
? addUtcDays(endDateExclusive, -7)
|
|
33
|
+
: periodKey === 'rolling-30-days'
|
|
34
|
+
? addUtcDays(endDateExclusive, -30)
|
|
35
|
+
: periodKey === 'rolling-90-days'
|
|
36
|
+
? addUtcDays(endDateExclusive, -90)
|
|
37
|
+
: shiftUtcMonths(addUtcDays(endDateExclusive, -1), -11);
|
|
38
|
+
return {
|
|
39
|
+
startDate,
|
|
40
|
+
endDateExclusive,
|
|
41
|
+
dateBasis: input.coordinate.period.requested.dateBasis,
|
|
42
|
+
...(input.coordinate.period.requested.timeZone === undefined
|
|
43
|
+
? {}
|
|
44
|
+
: { timeZone: input.coordinate.period.requested.timeZone }),
|
|
45
|
+
};
|
|
46
|
+
};
|
|
47
|
+
const displayDays = (input, startDate, endDateExclusive) => {
|
|
48
|
+
const pointByDate = new Map(input.points.map(point => [point.date, point]));
|
|
49
|
+
const gapReasons = (date) => input.gaps
|
|
50
|
+
.filter(gap => gap.startDate <= date && gap.endDateExclusive > date)
|
|
51
|
+
.flatMap(gap => gap.reasonCodes);
|
|
52
|
+
const days = [];
|
|
53
|
+
for (let date = startDate; date < endDateExclusive; date = addUtcDays(date, 1)) {
|
|
54
|
+
const point = pointByDate.get(date);
|
|
55
|
+
if (point?.status === 'available') {
|
|
56
|
+
days.push({ date, status: 'available', knownAmount: point.amount, reasonCodes: [] });
|
|
57
|
+
}
|
|
58
|
+
else if (point?.status === 'partial') {
|
|
59
|
+
days.push({ date, status: 'partial', knownAmount: point.knownAmount, reasonCodes: point.reasonCodes });
|
|
60
|
+
}
|
|
61
|
+
else {
|
|
62
|
+
const reasons = gapReasons(date);
|
|
63
|
+
days.push({ date, status: 'unavailable', reasonCodes: reasons.length > 0 ? reasons : [HISTORY_NOT_PRODUCED] });
|
|
64
|
+
}
|
|
65
|
+
}
|
|
66
|
+
return days;
|
|
67
|
+
};
|
|
68
|
+
const toBucket = (bucketKey, startDate, endDateExclusive, days) => {
|
|
69
|
+
const knownAmounts = days.flatMap(day => (day.knownAmount === undefined ? [] : [day.knownAmount]));
|
|
70
|
+
const coversWholeBucket = days[0]?.date === startDate && days.length > 0 && addUtcDays(days[days.length - 1].date, 1) === endDateExclusive;
|
|
71
|
+
const reasonCodes = uniqueReasons([
|
|
72
|
+
...days.flatMap(day => day.reasonCodes),
|
|
73
|
+
...(coversWholeBucket ? [] : [CALENDAR_PERIOD_INCOMPLETE]),
|
|
74
|
+
]);
|
|
75
|
+
if (knownAmounts.length === 0) {
|
|
76
|
+
return { bucketKey, startDate, endDateExclusive, status: 'unavailable', reasonCodes };
|
|
77
|
+
}
|
|
78
|
+
const knownAmount = formatExactDecimalValue(sumCanonicalDecimals(knownAmounts));
|
|
79
|
+
const average = averageKnownPerDay(knownAmount, knownAmounts.length);
|
|
80
|
+
if (coversWholeBucket && days.every(day => day.status === 'available')) {
|
|
81
|
+
return { bucketKey, startDate, endDateExclusive, status: 'available', amount: knownAmount, averageKnownPerDay: average };
|
|
82
|
+
}
|
|
83
|
+
return { bucketKey, startDate, endDateExclusive, status: 'partial', knownAmount, averageKnownPerDay: average, reasonCodes };
|
|
84
|
+
};
|
|
85
|
+
const dailyBuckets = (days) => days.map(day => toBucket(day.date, day.date, addUtcDays(day.date, 1), [day]));
|
|
86
|
+
const monthlyBuckets = (days) => {
|
|
87
|
+
const byMonth = new Map();
|
|
88
|
+
days.forEach(day => {
|
|
89
|
+
const month = day.date.slice(0, 7);
|
|
90
|
+
byMonth.set(month, [...(byMonth.get(month) ?? []), day]);
|
|
91
|
+
});
|
|
92
|
+
return [...byMonth.entries()].map(([month, monthDays]) => toBucket(month, `${month}-01`, shiftUtcMonths(`${month}-01`, 1), monthDays));
|
|
93
|
+
};
|
|
94
|
+
/**
|
|
95
|
+
* Exact, non-authoritative display rollup over one producer-owned analytics
|
|
96
|
+
* input. The function never changes charge inclusion, estimates, cost basis,
|
|
97
|
+
* currency, or source evidence; uncovered dates remain explicit.
|
|
98
|
+
*/
|
|
99
|
+
export const projectFinancialAnalyticsDisplayPeriodV1 = (request) => {
|
|
100
|
+
if (!isFinancialAnalyticsInputSeriesV1(request.input)) {
|
|
101
|
+
throw new TypeError('Financial analytics display projection requires a valid input series.');
|
|
102
|
+
}
|
|
103
|
+
const current = request.input.referenceCompositions.find(composition => composition.coordinate.periodRole === 'current-spend' && composition.compositionId === request.currentSpendCompositionId);
|
|
104
|
+
if (!current) {
|
|
105
|
+
throw new TypeError('Financial analytics input does not bind the requested current-spend composition.');
|
|
106
|
+
}
|
|
107
|
+
const accountingCurrency = request.input.coordinate.accountingCurrency;
|
|
108
|
+
if (accountingCurrency.status !== 'resolved') {
|
|
109
|
+
throw new TypeError('Financial analytics display projection requires a resolved accounting currency.');
|
|
110
|
+
}
|
|
111
|
+
const requested = requestedInterval(request.input, request.periodKey);
|
|
112
|
+
const days = displayDays(request.input, requested.startDate, requested.endDateExclusive);
|
|
113
|
+
const buckets = request.periodKey === 'trailing-12-calendar-months' ? monthlyBuckets(days) : dailyBuckets(days);
|
|
114
|
+
const common = {
|
|
115
|
+
analyticsInputId: request.input.analyticsInputId,
|
|
116
|
+
currentSpendCompositionId: current.compositionId,
|
|
117
|
+
chargeInclusionPolicyRef: current.coordinate.chargeInclusionPolicyRef,
|
|
118
|
+
periodKey: request.periodKey,
|
|
119
|
+
requested,
|
|
120
|
+
bucketGranularity: request.periodKey === 'trailing-12-calendar-months' ? 'calendar-month' : 'daily',
|
|
121
|
+
currencyCode: accountingCurrency.currencyCode,
|
|
122
|
+
buckets,
|
|
123
|
+
};
|
|
124
|
+
const knownAmounts = days.flatMap(day => (day.knownAmount === undefined ? [] : [day.knownAmount]));
|
|
125
|
+
const calendarPeriodIncomplete = request.periodKey === 'trailing-12-calendar-months' &&
|
|
126
|
+
requested.endDateExclusive !== shiftUtcMonths(addUtcDays(requested.endDateExclusive, -1), 1);
|
|
127
|
+
const reasonCodes = uniqueReasons([
|
|
128
|
+
...days.flatMap(day => day.reasonCodes),
|
|
129
|
+
...(calendarPeriodIncomplete ? [CALENDAR_PERIOD_INCOMPLETE] : []),
|
|
130
|
+
]);
|
|
131
|
+
if (knownAmounts.length === 0)
|
|
132
|
+
return { ...common, status: 'unavailable', reasonCodes };
|
|
133
|
+
const knownAmount = formatExactDecimalValue(sumCanonicalDecimals(knownAmounts));
|
|
134
|
+
const average = averageKnownPerDay(knownAmount, knownAmounts.length);
|
|
135
|
+
if (!calendarPeriodIncomplete && days.every(day => day.status === 'available')) {
|
|
136
|
+
return { ...common, status: 'available', amount: knownAmount, averageKnownPerDay: average };
|
|
137
|
+
}
|
|
138
|
+
return { ...common, status: 'partial', knownAmount, averageKnownPerDay: average, reasonCodes };
|
|
139
|
+
};
|