@salesforce/lds-adapters-analytics-wave 1.464.0 → 1.466.0
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/dist/es/es2018/analytics-wave.js +3054 -2748
- package/dist/es/es2018/types/src/generated/adapters/cancelPlatformAudit.d.ts +15 -0
- package/dist/es/es2018/types/src/generated/adapters/getPlatformAuditReport.d.ts +7 -7
- package/dist/es/es2018/types/src/generated/adapters/getRecipes.d.ts +1 -0
- package/dist/es/es2018/types/src/generated/artifacts/main.d.ts +1 -0
- package/dist/es/es2018/types/src/generated/artifacts/sfdc.d.ts +2 -1
- package/dist/es/es2018/types/src/generated/resources/getWavePlatformAuditReportByAuditId.d.ts +4 -4
- package/dist/es/es2018/types/src/generated/resources/getWaveRecipes.d.ts +1 -0
- package/dist/es/es2018/types/src/generated/resources/postWavePlatformAuditByAuditId.d.ts +12 -0
- package/dist/es/es2018/types/src/generated/types/PlatformAuditCheckCollectionRepresentation.d.ts +2 -2
- package/dist/es/es2018/types/src/generated/types/PlatformAuditCheckRepresentation.d.ts +15 -15
- package/dist/es/es2018/types/src/generated/types/PlatformAuditFindingRepresentation.d.ts +6 -6
- package/dist/es/es2018/types/src/generated/types/PlatformAuditReportReferenceRepresentation.d.ts +41 -0
- package/dist/es/es2018/types/src/generated/types/PlatformAuditRepresentation.d.ts +7 -7
- package/dist/es/es2018/types/src/generated/types/PlatformAuditSnapshotRepresentation.d.ts +7 -7
- package/dist/es/es2018/types/src/generated/types/PlatformAuditSummaryRepresentation.d.ts +6 -6
- package/dist/es/es2018/types/src/generated/types/PlatformAuditUrgencyRepresentation.d.ts +5 -5
- package/package.json +3 -3
- package/sfdc/index.js +4820 -4507
- package/src/raml/api.raml +269 -79
- package/src/raml/luvio.raml +15 -3
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { AdapterConfigMetadata as $64$luvio_engine_AdapterConfigMetadata, Luvio as $64$luvio_engine_Luvio, DispatchResourceRequestContext as $64$luvio_engine_DispatchResourceRequestContext, AdapterFactory as $64$luvio_engine_AdapterFactory } from '@luvio/engine';
|
|
2
|
+
import { Untrusted as adapter$45$utils_Untrusted, AdapterValidationConfig as adapter$45$utils_AdapterValidationConfig } from './adapter-utils';
|
|
3
|
+
import { ResourceRequestConfig as resources_postWavePlatformAuditByAuditId_ResourceRequestConfig } from '../resources/postWavePlatformAuditByAuditId';
|
|
4
|
+
import { PlatformAuditRepresentation as types_PlatformAuditRepresentation_PlatformAuditRepresentation } from '../types/PlatformAuditRepresentation';
|
|
5
|
+
export declare const adapterName = "cancelPlatformAudit";
|
|
6
|
+
export declare const cancelPlatformAudit_ConfigPropertyMetadata: $64$luvio_engine_AdapterConfigMetadata[];
|
|
7
|
+
export declare const cancelPlatformAudit_ConfigPropertyNames: adapter$45$utils_AdapterValidationConfig;
|
|
8
|
+
export interface CancelPlatformAuditConfig {
|
|
9
|
+
auditId: string;
|
|
10
|
+
}
|
|
11
|
+
export declare const createResourceParams: (config: CancelPlatformAuditConfig) => resources_postWavePlatformAuditByAuditId_ResourceRequestConfig;
|
|
12
|
+
export declare function typeCheckConfig(untrustedConfig: adapter$45$utils_Untrusted<CancelPlatformAuditConfig>): adapter$45$utils_Untrusted<CancelPlatformAuditConfig>;
|
|
13
|
+
export declare function validateAdapterConfig(untrustedConfig: unknown, configPropertyNames: adapter$45$utils_AdapterValidationConfig): CancelPlatformAuditConfig | null;
|
|
14
|
+
export declare function buildNetworkSnapshot(luvio: $64$luvio_engine_Luvio, config: CancelPlatformAuditConfig, options?: $64$luvio_engine_DispatchResourceRequestContext): Promise<import("@luvio/engine").FulfilledSnapshot<types_PlatformAuditRepresentation_PlatformAuditRepresentation, {}> | import("@luvio/engine").StaleSnapshot<types_PlatformAuditRepresentation_PlatformAuditRepresentation, {}> | import("@luvio/engine").PendingSnapshot<types_PlatformAuditRepresentation_PlatformAuditRepresentation, any>>;
|
|
15
|
+
export declare const cancelPlatformAuditAdapterFactory: $64$luvio_engine_AdapterFactory<CancelPlatformAuditConfig, types_PlatformAuditRepresentation_PlatformAuditRepresentation>;
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { AdapterConfigMetadata as $64$luvio_engine_AdapterConfigMetadata, Luvio as $64$luvio_engine_Luvio, NormalizedKeyMetadata as $64$luvio_engine_NormalizedKeyMetadata, Fragment as $64$luvio_engine_Fragment, Snapshot as $64$luvio_engine_Snapshot, FetchResponse as $64$luvio_engine_FetchResponse, ErrorResponse as $64$luvio_engine_ErrorResponse, DispatchResourceRequestContext as $64$luvio_engine_DispatchResourceRequestContext, CoercedAdapterRequestContext as $64$luvio_engine_CoercedAdapterRequestContext, StoreLookup as $64$luvio_engine_StoreLookup, AdapterFactory as $64$luvio_engine_AdapterFactory } from '@luvio/engine';
|
|
2
2
|
import { Untrusted as adapter$45$utils_Untrusted, AdapterValidationConfig as adapter$45$utils_AdapterValidationConfig } from './adapter-utils';
|
|
3
3
|
import { ResourceRequestConfig as resources_getWavePlatformAuditReportByAuditId_ResourceRequestConfig } from '../resources/getWavePlatformAuditReportByAuditId';
|
|
4
|
-
import {
|
|
4
|
+
import { PlatformAuditReportReferenceRepresentation as types_PlatformAuditReportReferenceRepresentation_PlatformAuditReportReferenceRepresentation } from '../types/PlatformAuditReportReferenceRepresentation';
|
|
5
5
|
export declare const adapterName = "getPlatformAuditReport";
|
|
6
6
|
export declare const getPlatformAuditReport_ConfigPropertyMetadata: $64$luvio_engine_AdapterConfigMetadata[];
|
|
7
7
|
export declare const getPlatformAuditReport_ConfigPropertyNames: adapter$45$utils_AdapterValidationConfig;
|
|
@@ -14,14 +14,14 @@ export declare function keyBuilder_StructuredKey(luvio: $64$luvio_engine_Luvio,
|
|
|
14
14
|
export declare function typeCheckConfig(untrustedConfig: adapter$45$utils_Untrusted<GetPlatformAuditReportConfig>): adapter$45$utils_Untrusted<GetPlatformAuditReportConfig>;
|
|
15
15
|
export declare function validateAdapterConfig(untrustedConfig: unknown, configPropertyNames: adapter$45$utils_AdapterValidationConfig): GetPlatformAuditReportConfig | null;
|
|
16
16
|
export declare function adapterFragment(luvio: $64$luvio_engine_Luvio, config: GetPlatformAuditReportConfig): $64$luvio_engine_Fragment;
|
|
17
|
-
export declare function buildCachedSnapshot(luvio: $64$luvio_engine_Luvio, config: GetPlatformAuditReportConfig): $64$luvio_engine_Snapshot<
|
|
18
|
-
export declare function onFetchResponseSuccess(luvio: $64$luvio_engine_Luvio, config: GetPlatformAuditReportConfig, resourceParams: resources_getWavePlatformAuditReportByAuditId_ResourceRequestConfig, response: $64$luvio_engine_FetchResponse<
|
|
17
|
+
export declare function buildCachedSnapshot(luvio: $64$luvio_engine_Luvio, config: GetPlatformAuditReportConfig): $64$luvio_engine_Snapshot<types_PlatformAuditReportReferenceRepresentation_PlatformAuditReportReferenceRepresentation, any>;
|
|
18
|
+
export declare function onFetchResponseSuccess(luvio: $64$luvio_engine_Luvio, config: GetPlatformAuditReportConfig, resourceParams: resources_getWavePlatformAuditReportByAuditId_ResourceRequestConfig, response: $64$luvio_engine_FetchResponse<types_PlatformAuditReportReferenceRepresentation_PlatformAuditReportReferenceRepresentation>): Promise<import("@luvio/engine").FulfilledSnapshot<types_PlatformAuditReportReferenceRepresentation_PlatformAuditReportReferenceRepresentation, {}> | import("@luvio/engine").StaleSnapshot<types_PlatformAuditReportReferenceRepresentation_PlatformAuditReportReferenceRepresentation, {}> | import("@luvio/engine").PendingSnapshot<types_PlatformAuditReportReferenceRepresentation_PlatformAuditReportReferenceRepresentation, any>>;
|
|
19
19
|
export declare function onFetchResponseError(luvio: $64$luvio_engine_Luvio, config: GetPlatformAuditReportConfig, resourceParams: resources_getWavePlatformAuditReportByAuditId_ResourceRequestConfig, response: $64$luvio_engine_ErrorResponse): Promise<import("@luvio/engine").ErrorSnapshot>;
|
|
20
|
-
export declare function buildNetworkSnapshot(luvio: $64$luvio_engine_Luvio, config: GetPlatformAuditReportConfig, options?: $64$luvio_engine_DispatchResourceRequestContext): Promise<$64$luvio_engine_Snapshot<
|
|
20
|
+
export declare function buildNetworkSnapshot(luvio: $64$luvio_engine_Luvio, config: GetPlatformAuditReportConfig, options?: $64$luvio_engine_DispatchResourceRequestContext): Promise<$64$luvio_engine_Snapshot<types_PlatformAuditReportReferenceRepresentation_PlatformAuditReportReferenceRepresentation, any>>;
|
|
21
21
|
export type BuildSnapshotContext = {
|
|
22
22
|
luvio: $64$luvio_engine_Luvio;
|
|
23
23
|
config: GetPlatformAuditReportConfig;
|
|
24
24
|
};
|
|
25
|
-
export declare function buildNetworkSnapshotCachePolicy(context: BuildSnapshotContext, coercedAdapterRequestContext: $64$luvio_engine_CoercedAdapterRequestContext): Promise<$64$luvio_engine_Snapshot<
|
|
26
|
-
export declare function buildCachedSnapshotCachePolicy(context: BuildSnapshotContext, storeLookup: $64$luvio_engine_StoreLookup<
|
|
27
|
-
export declare const getPlatformAuditReportAdapterFactory: $64$luvio_engine_AdapterFactory<GetPlatformAuditReportConfig,
|
|
25
|
+
export declare function buildNetworkSnapshotCachePolicy(context: BuildSnapshotContext, coercedAdapterRequestContext: $64$luvio_engine_CoercedAdapterRequestContext): Promise<$64$luvio_engine_Snapshot<types_PlatformAuditReportReferenceRepresentation_PlatformAuditReportReferenceRepresentation, any>>;
|
|
26
|
+
export declare function buildCachedSnapshotCachePolicy(context: BuildSnapshotContext, storeLookup: $64$luvio_engine_StoreLookup<types_PlatformAuditReportReferenceRepresentation_PlatformAuditReportReferenceRepresentation>): $64$luvio_engine_Snapshot<types_PlatformAuditReportReferenceRepresentation_PlatformAuditReportReferenceRepresentation, any>;
|
|
27
|
+
export declare const getPlatformAuditReportAdapterFactory: $64$luvio_engine_AdapterFactory<GetPlatformAuditReportConfig, types_PlatformAuditReportReferenceRepresentation_PlatformAuditReportReferenceRepresentation>;
|
|
@@ -46,6 +46,7 @@ export { getAnalyticsLimitsAdapterFactory } from '../adapters/getAnalyticsLimits
|
|
|
46
46
|
export { getLatestPlatformAuditAdapterFactory } from '../adapters/getLatestPlatformAudit';
|
|
47
47
|
export { triggerPlatformAuditAdapterFactory } from '../adapters/triggerPlatformAudit';
|
|
48
48
|
export { getPlatformAuditAdapterFactory } from '../adapters/getPlatformAudit';
|
|
49
|
+
export { cancelPlatformAuditAdapterFactory } from '../adapters/cancelPlatformAudit';
|
|
49
50
|
export { getPlatformAuditCheckAdapterFactory } from '../adapters/getPlatformAuditCheck';
|
|
50
51
|
export { getPlatformAuditReportAdapterFactory } from '../adapters/getPlatformAuditReport';
|
|
51
52
|
export { generatePlatformAuditReportAdapterFactory } from '../adapters/generatePlatformAuditReport';
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
declare let cancelPlatformAudit: any;
|
|
1
2
|
declare let createDataConnector: any;
|
|
2
3
|
declare let createDataflowJob: any;
|
|
3
4
|
declare let createDataset: any;
|
|
@@ -151,4 +152,4 @@ declare let getWaveTemplateReleaseNotes_imperative: any;
|
|
|
151
152
|
declare let getWaveTemplates_imperative: any;
|
|
152
153
|
declare let getWaveUnsupportedFeatures_imperative: any;
|
|
153
154
|
declare let getXmd_imperative: any;
|
|
154
|
-
export { createDataConnector, createDataflowJob, createDataset, createDatasetVersion, createReplicatedDataset, createWaveFolder, deleteDataConnector, deleteDataset, deleteRecipe, deleteReplicatedDataset, deleteWaveFolder, executeQuery, generatePlatformAuditReport, getActions, getAnalyticsLimits, getAsset, getAssetNotifyChange, getDataConnector, getDataConnectorNotifyChange, getDataConnectorSourceFields, getDataConnectorSourceFieldsNotifyChange, getDataConnectorSourceFieldsWithAdvProps, getDataConnectorSourceFieldsWithAdvPropsNotifyChange, getDataConnectorSourceObject, getDataConnectorSourceObjectDataPreviewWithFields, getDataConnectorSourceObjectNotifyChange, getDataConnectorSourceObjects, getDataConnectorStatus, getDataConnectorTypes, getDataConnectors, getDataflowJob, getDataflowJobNode, getDataflowJobNodeNotifyChange, getDataflowJobNodeStage, getDataflowJobNodeStageNotifyChange, getDataflowJobNodeStageParents, getDataflowJobNodeStageParentsNotifyChange, getDataflowJobNodeStages, getDataflowJobNodes, getDataflowJobNotifyChange, getDataflowJobs, getDataflows, getDataset, getDatasetNotifyChange, getDatasetVersion, getDatasetVersionNotifyChange, getDatasetVersions, getDatasets, getDependencies, getLatestPlatformAudit, getPlatformAudit, getPlatformAuditCheck, getPlatformAuditHistory, getPlatformAuditNotifyChange, getPlatformAuditReport, getRecipe, getRecipeNotification, getRecipeNotificationNotifyChange, getRecipeNotifyChange, getRecipes, getRecycleBin, getRecycleBinAsset, getRecycleBinAssetNotifyChange, getReplicatedDataset, getReplicatedDatasetNotifyChange, getReplicatedDatasets, getReplicatedFields, getReplicatedFieldsNotifyChange, getReplicatedFieldsWithAdvancedProps, getReplicatedFieldsWithAdvancedPropsNotifyChange, getSchedule, getScheduleNotifyChange, getSecurityCoverageDatasetVersion, getWaveFolder, getWaveFolderNotifyChange, getWaveFolders, getWaveTemplate, getWaveTemplateConfig, getWaveTemplateConfigNotifyChange, getWaveTemplateNotifyChange, getWaveTemplateReleaseNotes, getWaveTemplateReleaseNotesNotifyChange, getWaveTemplates, getWaveUnsupportedFeatures, getXmd, ingestDataConnector, permanentlyDeleteAsset, restoreAsset, softDeleteAsset, triggerPlatformAudit, updateDataConnector, updateDataflowJob, updateDataset, updateDatasetVersion, updatePartialWaveFolder, updateRecipe, updateRecipeNotification, updateReplicatedDataset, updateReplicatedFields, updateSchedule, updateWaveFolder, updateXmd, validateWaveTemplate, executeQuery_imperative, getActions_imperative, getAnalyticsLimits_imperative, getAsset_imperative, getDataConnector_imperative, getDataConnectorSourceFields_imperative, getDataConnectorSourceFieldsWithAdvProps_imperative, getDataConnectorSourceObject_imperative, getDataConnectorSourceObjectDataPreviewWithFields_imperative, getDataConnectorSourceObjects_imperative, getDataConnectorStatus_imperative, getDataConnectorTypes_imperative, getDataConnectors_imperative, getDataflowJob_imperative, getDataflowJobNode_imperative, getDataflowJobNodeStage_imperative, getDataflowJobNodeStageParents_imperative, getDataflowJobNodeStages_imperative, getDataflowJobNodes_imperative, getDataflowJobs_imperative, getDataflows_imperative, getDataset_imperative, getDatasetVersion_imperative, getDatasetVersions_imperative, getDatasets_imperative, getDependencies_imperative, getLatestPlatformAudit_imperative, getPlatformAudit_imperative, getPlatformAuditCheck_imperative, getPlatformAuditHistory_imperative, getPlatformAuditReport_imperative, getRecipe_imperative, getRecipeNotification_imperative, getRecipes_imperative, getRecycleBin_imperative, getRecycleBinAsset_imperative, getReplicatedDataset_imperative, getReplicatedDatasets_imperative, getReplicatedFields_imperative, getReplicatedFieldsWithAdvancedProps_imperative, getSchedule_imperative, getSecurityCoverageDatasetVersion_imperative, getWaveFolder_imperative, getWaveFolders_imperative, getWaveTemplate_imperative, getWaveTemplateConfig_imperative, getWaveTemplateReleaseNotes_imperative, getWaveTemplates_imperative, getWaveUnsupportedFeatures_imperative, getXmd_imperative, };
|
|
155
|
+
export { cancelPlatformAudit, createDataConnector, createDataflowJob, createDataset, createDatasetVersion, createReplicatedDataset, createWaveFolder, deleteDataConnector, deleteDataset, deleteRecipe, deleteReplicatedDataset, deleteWaveFolder, executeQuery, generatePlatformAuditReport, getActions, getAnalyticsLimits, getAsset, getAssetNotifyChange, getDataConnector, getDataConnectorNotifyChange, getDataConnectorSourceFields, getDataConnectorSourceFieldsNotifyChange, getDataConnectorSourceFieldsWithAdvProps, getDataConnectorSourceFieldsWithAdvPropsNotifyChange, getDataConnectorSourceObject, getDataConnectorSourceObjectDataPreviewWithFields, getDataConnectorSourceObjectNotifyChange, getDataConnectorSourceObjects, getDataConnectorStatus, getDataConnectorTypes, getDataConnectors, getDataflowJob, getDataflowJobNode, getDataflowJobNodeNotifyChange, getDataflowJobNodeStage, getDataflowJobNodeStageNotifyChange, getDataflowJobNodeStageParents, getDataflowJobNodeStageParentsNotifyChange, getDataflowJobNodeStages, getDataflowJobNodes, getDataflowJobNotifyChange, getDataflowJobs, getDataflows, getDataset, getDatasetNotifyChange, getDatasetVersion, getDatasetVersionNotifyChange, getDatasetVersions, getDatasets, getDependencies, getLatestPlatformAudit, getPlatformAudit, getPlatformAuditCheck, getPlatformAuditHistory, getPlatformAuditNotifyChange, getPlatformAuditReport, getRecipe, getRecipeNotification, getRecipeNotificationNotifyChange, getRecipeNotifyChange, getRecipes, getRecycleBin, getRecycleBinAsset, getRecycleBinAssetNotifyChange, getReplicatedDataset, getReplicatedDatasetNotifyChange, getReplicatedDatasets, getReplicatedFields, getReplicatedFieldsNotifyChange, getReplicatedFieldsWithAdvancedProps, getReplicatedFieldsWithAdvancedPropsNotifyChange, getSchedule, getScheduleNotifyChange, getSecurityCoverageDatasetVersion, getWaveFolder, getWaveFolderNotifyChange, getWaveFolders, getWaveTemplate, getWaveTemplateConfig, getWaveTemplateConfigNotifyChange, getWaveTemplateNotifyChange, getWaveTemplateReleaseNotes, getWaveTemplateReleaseNotesNotifyChange, getWaveTemplates, getWaveUnsupportedFeatures, getXmd, ingestDataConnector, permanentlyDeleteAsset, restoreAsset, softDeleteAsset, triggerPlatformAudit, updateDataConnector, updateDataflowJob, updateDataset, updateDatasetVersion, updatePartialWaveFolder, updateRecipe, updateRecipeNotification, updateReplicatedDataset, updateReplicatedFields, updateSchedule, updateWaveFolder, updateXmd, validateWaveTemplate, executeQuery_imperative, getActions_imperative, getAnalyticsLimits_imperative, getAsset_imperative, getDataConnector_imperative, getDataConnectorSourceFields_imperative, getDataConnectorSourceFieldsWithAdvProps_imperative, getDataConnectorSourceObject_imperative, getDataConnectorSourceObjectDataPreviewWithFields_imperative, getDataConnectorSourceObjects_imperative, getDataConnectorStatus_imperative, getDataConnectorTypes_imperative, getDataConnectors_imperative, getDataflowJob_imperative, getDataflowJobNode_imperative, getDataflowJobNodeStage_imperative, getDataflowJobNodeStageParents_imperative, getDataflowJobNodeStages_imperative, getDataflowJobNodes_imperative, getDataflowJobs_imperative, getDataflows_imperative, getDataset_imperative, getDatasetVersion_imperative, getDatasetVersions_imperative, getDatasets_imperative, getDependencies_imperative, getLatestPlatformAudit_imperative, getPlatformAudit_imperative, getPlatformAuditCheck_imperative, getPlatformAuditHistory_imperative, getPlatformAuditReport_imperative, getRecipe_imperative, getRecipeNotification_imperative, getRecipes_imperative, getRecycleBin_imperative, getRecycleBinAsset_imperative, getReplicatedDataset_imperative, getReplicatedDatasets_imperative, getReplicatedFields_imperative, getReplicatedFieldsWithAdvancedProps_imperative, getSchedule_imperative, getSecurityCoverageDatasetVersion_imperative, getWaveFolder_imperative, getWaveFolders_imperative, getWaveTemplate_imperative, getWaveTemplateConfig_imperative, getWaveTemplateReleaseNotes_imperative, getWaveTemplates_imperative, getWaveUnsupportedFeatures_imperative, getXmd_imperative, };
|
package/dist/es/es2018/types/src/generated/resources/getWavePlatformAuditReportByAuditId.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { Luvio as $64$luvio_engine_Luvio, Fragment as $64$luvio_engine_Fragment, NormalizedKeyMetadata as $64$luvio_engine_NormalizedKeyMetadata, FetchResponse as $64$luvio_engine_FetchResponse, SnapshotRefresh as $64$luvio_engine_SnapshotRefresh, FulfilledSnapshot as $64$luvio_engine_FulfilledSnapshot, StaleSnapshot as $64$luvio_engine_StaleSnapshot, PendingSnapshot as $64$luvio_engine_PendingSnapshot, ErrorResponse as $64$luvio_engine_ErrorResponse, ErrorSnapshot as $64$luvio_engine_ErrorSnapshot, ResourceRequest as $64$luvio_engine_ResourceRequest } from '@luvio/engine';
|
|
2
|
-
import {
|
|
2
|
+
import { PlatformAuditReportReferenceRepresentation as types_PlatformAuditReportReferenceRepresentation_PlatformAuditReportReferenceRepresentation } from '../types/PlatformAuditReportReferenceRepresentation';
|
|
3
3
|
export interface ResourceRequestConfig {
|
|
4
4
|
urlParams: {
|
|
5
5
|
auditId: string;
|
|
@@ -8,8 +8,8 @@ export interface ResourceRequestConfig {
|
|
|
8
8
|
export declare function select(luvio: $64$luvio_engine_Luvio, params: ResourceRequestConfig): $64$luvio_engine_Fragment;
|
|
9
9
|
export declare function keyBuilder(luvio: $64$luvio_engine_Luvio, params: ResourceRequestConfig): string;
|
|
10
10
|
export declare function keyBuilder_StructuredKey(luvio: $64$luvio_engine_Luvio, params: ResourceRequestConfig): $64$luvio_engine_NormalizedKeyMetadata;
|
|
11
|
-
export declare function getResponseCacheKeys(storeKeyMap: any, luvio: $64$luvio_engine_Luvio, resourceParams: ResourceRequestConfig, response:
|
|
12
|
-
export declare function ingestSuccess(luvio: $64$luvio_engine_Luvio, resourceParams: ResourceRequestConfig, response: $64$luvio_engine_FetchResponse<
|
|
13
|
-
export declare function ingestError(luvio: $64$luvio_engine_Luvio, params: ResourceRequestConfig, error: $64$luvio_engine_ErrorResponse, snapshotRefresh?: $64$luvio_engine_SnapshotRefresh<
|
|
11
|
+
export declare function getResponseCacheKeys(storeKeyMap: any, luvio: $64$luvio_engine_Luvio, resourceParams: ResourceRequestConfig, response: types_PlatformAuditReportReferenceRepresentation_PlatformAuditReportReferenceRepresentation): void;
|
|
12
|
+
export declare function ingestSuccess(luvio: $64$luvio_engine_Luvio, resourceParams: ResourceRequestConfig, response: $64$luvio_engine_FetchResponse<types_PlatformAuditReportReferenceRepresentation_PlatformAuditReportReferenceRepresentation>, snapshotRefresh?: $64$luvio_engine_SnapshotRefresh<types_PlatformAuditReportReferenceRepresentation_PlatformAuditReportReferenceRepresentation>): $64$luvio_engine_FulfilledSnapshot<types_PlatformAuditReportReferenceRepresentation_PlatformAuditReportReferenceRepresentation, {}> | $64$luvio_engine_StaleSnapshot<types_PlatformAuditReportReferenceRepresentation_PlatformAuditReportReferenceRepresentation, {}> | $64$luvio_engine_PendingSnapshot<types_PlatformAuditReportReferenceRepresentation_PlatformAuditReportReferenceRepresentation, any>;
|
|
13
|
+
export declare function ingestError(luvio: $64$luvio_engine_Luvio, params: ResourceRequestConfig, error: $64$luvio_engine_ErrorResponse, snapshotRefresh?: $64$luvio_engine_SnapshotRefresh<types_PlatformAuditReportReferenceRepresentation_PlatformAuditReportReferenceRepresentation>): $64$luvio_engine_ErrorSnapshot;
|
|
14
14
|
export declare function createResourceRequest(config: ResourceRequestConfig): $64$luvio_engine_ResourceRequest;
|
|
15
15
|
export default createResourceRequest;
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { Luvio as $64$luvio_engine_Luvio, Fragment as $64$luvio_engine_Fragment, FetchResponse as $64$luvio_engine_FetchResponse, FulfilledSnapshot as $64$luvio_engine_FulfilledSnapshot, StaleSnapshot as $64$luvio_engine_StaleSnapshot, PendingSnapshot as $64$luvio_engine_PendingSnapshot, ResourceRequest as $64$luvio_engine_ResourceRequest } from '@luvio/engine';
|
|
2
|
+
import { PlatformAuditRepresentation as types_PlatformAuditRepresentation_PlatformAuditRepresentation } from '../types/PlatformAuditRepresentation';
|
|
3
|
+
export interface ResourceRequestConfig {
|
|
4
|
+
urlParams: {
|
|
5
|
+
auditId: string;
|
|
6
|
+
};
|
|
7
|
+
}
|
|
8
|
+
export declare function select(luvio: $64$luvio_engine_Luvio, params: ResourceRequestConfig): $64$luvio_engine_Fragment;
|
|
9
|
+
export declare function getResponseCacheKeys(storeKeyMap: any, luvio: $64$luvio_engine_Luvio, resourceParams: ResourceRequestConfig, response: types_PlatformAuditRepresentation_PlatformAuditRepresentation): void;
|
|
10
|
+
export declare function ingestSuccess(luvio: $64$luvio_engine_Luvio, resourceParams: ResourceRequestConfig, response: $64$luvio_engine_FetchResponse<types_PlatformAuditRepresentation_PlatformAuditRepresentation>): $64$luvio_engine_FulfilledSnapshot<types_PlatformAuditRepresentation_PlatformAuditRepresentation, {}> | $64$luvio_engine_StaleSnapshot<types_PlatformAuditRepresentation_PlatformAuditRepresentation, {}> | $64$luvio_engine_PendingSnapshot<types_PlatformAuditRepresentation_PlatformAuditRepresentation, any>;
|
|
11
|
+
export declare function createResourceRequest(config: ResourceRequestConfig): $64$luvio_engine_ResourceRequest;
|
|
12
|
+
export default createResourceRequest;
|
package/dist/es/es2018/types/src/generated/types/PlatformAuditCheckCollectionRepresentation.d.ts
CHANGED
|
@@ -16,9 +16,9 @@ export declare function getTypeCacheKeys(rootKeySet: $64$luvio_engine_DurableSto
|
|
|
16
16
|
* (none)
|
|
17
17
|
*/
|
|
18
18
|
export interface PlatformAuditCheckCollectionRepresentationNormalized {
|
|
19
|
-
/**
|
|
19
|
+
/** Every check of the audit run, ordered by check name. Finished checks carry their results; checks that have not finished carry only their status. If the server cannot determine which checks have not finished, only the finished checks are listed. */
|
|
20
20
|
checks: Array<PlatformAuditCheckRepresentation_PlatformAuditCheckRepresentation>;
|
|
21
|
-
/** The
|
|
21
|
+
/** The number of checks listed - every check of the audit run, or only the finished checks when the server cannot determine which have not finished. */
|
|
22
22
|
totalSize: number;
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { IngestPath as $64$luvio_engine_IngestPath, Luvio as $64$luvio_engine_Luvio, Store as $64$luvio_engine_Store, FragmentSelection as $64$luvio_engine_FragmentSelection, ResourceIngest as $64$luvio_engine_ResourceIngest, DurableStoreKeyMetadataMap as $64$luvio_engine_DurableStoreKeyMetadataMap, NormalizedKeyMetadata as $64$luvio_engine_NormalizedKeyMetadata } from '@luvio/engine';
|
|
2
2
|
export declare const TTL = 300;
|
|
3
|
-
export declare const VERSION = "
|
|
3
|
+
export declare const VERSION = "c0feda50a4a8fc2e5637843b6c1b8eed";
|
|
4
4
|
export declare function validate(obj: any, path?: string): TypeError | null;
|
|
5
5
|
export declare const RepresentationType: string;
|
|
6
6
|
export declare function normalize(input: PlatformAuditCheckRepresentation, existing: PlatformAuditCheckRepresentationNormalized, path: $64$luvio_engine_IngestPath, luvio: $64$luvio_engine_Luvio, store: $64$luvio_engine_Store, timestamp: number): PlatformAuditCheckRepresentationNormalized;
|
|
@@ -9,31 +9,31 @@ export declare function equals(existing: PlatformAuditCheckRepresentationNormali
|
|
|
9
9
|
export declare const ingest: $64$luvio_engine_ResourceIngest;
|
|
10
10
|
export declare function getTypeCacheKeys(rootKeySet: $64$luvio_engine_DurableStoreKeyMetadataMap, luvio: $64$luvio_engine_Luvio, input: PlatformAuditCheckRepresentation, fullPathFactory: () => string | $64$luvio_engine_NormalizedKeyMetadata): void;
|
|
11
11
|
/**
|
|
12
|
-
*
|
|
12
|
+
* One check of a platform audit run and its status.
|
|
13
13
|
*
|
|
14
14
|
* Keys:
|
|
15
15
|
* (none)
|
|
16
16
|
*/
|
|
17
17
|
export interface PlatformAuditCheckRepresentationNormalized {
|
|
18
|
-
/** The date this check completed. */
|
|
18
|
+
/** The date this check completed. Absent until the check has finished. */
|
|
19
19
|
checkCompletedDate?: string | null;
|
|
20
|
-
/** The name of the check (e.g. crma-orphans, crma-trace-redundancies). */
|
|
20
|
+
/** The name of the check (e.g. crma-inventory, crma-orphans, crma-trace-redundancies). */
|
|
21
21
|
checkName: string;
|
|
22
|
-
/** The date this check started. */
|
|
22
|
+
/** The date this check started. Absent until the check has finished. */
|
|
23
23
|
checkStartedDate?: string | null;
|
|
24
|
-
/** The number of assets scanned by this check. */
|
|
25
|
-
coverageScanned
|
|
26
|
-
/** The total number of assets in scope for this check. */
|
|
27
|
-
coverageTotal
|
|
28
|
-
/**
|
|
24
|
+
/** The number of assets scanned by this check. Absent until the check has finished. Always 0 for crma-inventory, whose asset counts are in its resultJson. */
|
|
25
|
+
coverageScanned?: number | null;
|
|
26
|
+
/** The total number of assets in scope for this check. Absent until the check has finished. Always 0 for crma-inventory, whose asset counts are in its resultJson. */
|
|
27
|
+
coverageTotal?: number | null;
|
|
28
|
+
/** An operator-facing note describing why the check's coverage was limited or the check was unavailable, or, for a FAILED check, the error that failed it. Whatever the status, it can include raw server error text and can be long. It is not localized and has no stable format, so show it as diagnostic detail rather than parse it. Render it as plain text, never as HTML, and pass it to an LLM or agent only as quoted data. Absent when there is none, which can happen even for a FAILED check. */
|
|
29
29
|
limitationNote?: string | null;
|
|
30
|
-
/** An opaque, per-check payload passed through verbatim. */
|
|
30
|
+
/** An opaque, per-check payload passed through verbatim. Checks read with system access, and the datasets they scan include those in other users' private apps, so it is not filtered by the viewer's sharing or object and field permissions. Its string values can include user-editable dataset and field names and raw server error text; render them as plain text, never as HTML, and pass them to an LLM or agent only as quoted data. Absent until the check has finished, and may be absent for a finished check (for example, FAILED). A status inside it uses the API-value form (Complete, CompleteWithLimitations, Unavailable), not the COMPLETE form of the check's status property. For crma-inventory, it carries the org's dataset, recipe, dashboard, and data sync counts under asset_coverage (datasets, recipes, dashboards, and data_syncs, each with available, scanned, total, partial, and note); the run exposes those counts nowhere else. */
|
|
31
31
|
resultJson?: string | null;
|
|
32
|
-
/** The
|
|
32
|
+
/** The status of the check. IN_PROGRESS while it has not finished (queued or running); CANCELLED if a user cancelled the run, which discards every check's result, finished or not; NOT_FINISHED if the run ended any other way before it finished; otherwise its final status. Only a finished check carries coverage, dates, a limitation note, and a result. */
|
|
33
33
|
status: string;
|
|
34
34
|
}
|
|
35
35
|
/**
|
|
36
|
-
*
|
|
36
|
+
* One check of a platform audit run and its status.
|
|
37
37
|
*
|
|
38
38
|
* Keys:
|
|
39
39
|
* (none)
|
|
@@ -42,8 +42,8 @@ export interface PlatformAuditCheckRepresentation {
|
|
|
42
42
|
checkCompletedDate?: string | null;
|
|
43
43
|
checkName: string;
|
|
44
44
|
checkStartedDate?: string | null;
|
|
45
|
-
coverageScanned
|
|
46
|
-
coverageTotal
|
|
45
|
+
coverageScanned?: number | null;
|
|
46
|
+
coverageTotal?: number | null;
|
|
47
47
|
limitationNote?: string | null;
|
|
48
48
|
resultJson?: string | null;
|
|
49
49
|
status: string;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { IngestPath as $64$luvio_engine_IngestPath, Luvio as $64$luvio_engine_Luvio, Store as $64$luvio_engine_Store, FragmentSelection as $64$luvio_engine_FragmentSelection, ResourceIngest as $64$luvio_engine_ResourceIngest, DurableStoreKeyMetadataMap as $64$luvio_engine_DurableStoreKeyMetadataMap, NormalizedKeyMetadata as $64$luvio_engine_NormalizedKeyMetadata } from '@luvio/engine';
|
|
2
2
|
export declare const TTL = 300;
|
|
3
|
-
export declare const VERSION = "
|
|
3
|
+
export declare const VERSION = "9a2c2926bd5c97af09b7fc0bbaf2066f";
|
|
4
4
|
export declare function validate(obj: any, path?: string): TypeError | null;
|
|
5
5
|
export declare const RepresentationType: string;
|
|
6
6
|
export declare function normalize(input: PlatformAuditFindingRepresentation, existing: PlatformAuditFindingRepresentationNormalized, path: $64$luvio_engine_IngestPath, luvio: $64$luvio_engine_Luvio, store: $64$luvio_engine_Store, timestamp: number): PlatformAuditFindingRepresentationNormalized;
|
|
@@ -9,7 +9,7 @@ export declare function equals(existing: PlatformAuditFindingRepresentationNorma
|
|
|
9
9
|
export declare const ingest: $64$luvio_engine_ResourceIngest;
|
|
10
10
|
export declare function getTypeCacheKeys(rootKeySet: $64$luvio_engine_DurableStoreKeyMetadataMap, luvio: $64$luvio_engine_Luvio, input: PlatformAuditFindingRepresentation, fullPathFactory: () => string | $64$luvio_engine_NormalizedKeyMetadata): void;
|
|
11
11
|
/**
|
|
12
|
-
* One finding surfaced by the aggregator's urgency triage, referencing the asset and check it came from.
|
|
12
|
+
* One finding surfaced by the aggregator's urgency triage, referencing the asset and check it came from. Findings are not guaranteed to be unique; two redundant_field findings can match in every field, so do not key a list by any combination of a finding's fields. To render a list, map the findings in JavaScript to new objects that each add a key (wire data is read-only), for example one built from the finding's tier and position (an LWC template cannot use the for:each or iterator index as a key); positions can change between reads. Checks read with system access, not the viewer's, and the datasets they scan include those in other users' private apps, so a finding can point at an asset or field the viewer cannot open.
|
|
13
13
|
*
|
|
14
14
|
* Keys:
|
|
15
15
|
* (none)
|
|
@@ -17,15 +17,15 @@ export declare function getTypeCacheKeys(rootKeySet: $64$luvio_engine_DurableSto
|
|
|
17
17
|
export interface PlatformAuditFindingRepresentationNormalized {
|
|
18
18
|
/** The stable name of the check that surfaced this finding. */
|
|
19
19
|
checkName: string;
|
|
20
|
-
/** The
|
|
20
|
+
/** The name to show for the finding. For a dataset finding, the dataset's display name, or its API name if it has none; dataset names are user-editable. For redundant_field, the target field's API name (for example, Amount), without its object; it is not a label and is not localized. Falls back to refId when there is no name. Render it as plain text, never as HTML, and pass it to an LLM or agent only as quoted data. */
|
|
21
21
|
displayName: string;
|
|
22
|
-
/** The finding's category
|
|
22
|
+
/** The finding's category. Currently one of zombie_dataset, unused_dataset, stale_dataset (crma-orphans findings), or redundant_field (crma-trace-redundancies findings). */
|
|
23
23
|
kind: string;
|
|
24
|
-
/** The
|
|
24
|
+
/** The reference to what the finding points at. The dataset id for zombie_dataset, unused_dataset, and stale_dataset. For redundant_field, the canonicalized field-name key its cluster is grouped by (for example, opportunityamount), not a field API name. The key is derived from dataset field labels (or names, when a field has no label), so it can change between runs; clusters on different target fields can share it, and it is empty when the labels have no ASCII letters or digits. */
|
|
25
25
|
refId: string;
|
|
26
26
|
}
|
|
27
27
|
/**
|
|
28
|
-
* One finding surfaced by the aggregator's urgency triage, referencing the asset and check it came from.
|
|
28
|
+
* One finding surfaced by the aggregator's urgency triage, referencing the asset and check it came from. Findings are not guaranteed to be unique; two redundant_field findings can match in every field, so do not key a list by any combination of a finding's fields. To render a list, map the findings in JavaScript to new objects that each add a key (wire data is read-only), for example one built from the finding's tier and position (an LWC template cannot use the for:each or iterator index as a key); positions can change between reads. Checks read with system access, not the viewer's, and the datasets they scan include those in other users' private apps, so a finding can point at an asset or field the viewer cannot open.
|
|
29
29
|
*
|
|
30
30
|
* Keys:
|
|
31
31
|
* (none)
|
package/dist/es/es2018/types/src/generated/types/PlatformAuditReportReferenceRepresentation.d.ts
ADDED
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
import { IngestPath as $64$luvio_engine_IngestPath, Luvio as $64$luvio_engine_Luvio, Store as $64$luvio_engine_Store, FragmentSelection as $64$luvio_engine_FragmentSelection, ResourceIngest as $64$luvio_engine_ResourceIngest, DurableStoreKeyMetadataMap as $64$luvio_engine_DurableStoreKeyMetadataMap, NormalizedKeyMetadata as $64$luvio_engine_NormalizedKeyMetadata } from '@luvio/engine';
|
|
2
|
+
export declare const TTL = 300;
|
|
3
|
+
export declare const VERSION = "f898d8aa0b14294028d4411603d44f1f";
|
|
4
|
+
export declare function validate(obj: any, path?: string): TypeError | null;
|
|
5
|
+
export declare const RepresentationType: string;
|
|
6
|
+
export declare function normalize(input: PlatformAuditReportReferenceRepresentation, existing: PlatformAuditReportReferenceRepresentationNormalized, path: $64$luvio_engine_IngestPath, luvio: $64$luvio_engine_Luvio, store: $64$luvio_engine_Store, timestamp: number): PlatformAuditReportReferenceRepresentationNormalized;
|
|
7
|
+
export declare const select: () => $64$luvio_engine_FragmentSelection;
|
|
8
|
+
export declare function equals(existing: PlatformAuditReportReferenceRepresentationNormalized, incoming: PlatformAuditReportReferenceRepresentationNormalized): boolean;
|
|
9
|
+
export declare const ingest: $64$luvio_engine_ResourceIngest;
|
|
10
|
+
export declare function getTypeCacheKeys(rootKeySet: $64$luvio_engine_DurableStoreKeyMetadataMap, luvio: $64$luvio_engine_Luvio, input: PlatformAuditReportReferenceRepresentation, fullPathFactory: () => string | $64$luvio_engine_NormalizedKeyMetadata): void;
|
|
11
|
+
/**
|
|
12
|
+
* Same shape as AssetReferenceRepresentation, returned by the PDF-report GET endpoint. Kept as a separate, unkeyed type so it can carry its own (luvio.ttl), which Luvio forbids on an inherited shape such as AssetReferenceRepresentation. Without that TTL, the GET's 404 (no report yet) would be cached with no expiry. The GET cannot use the keyed PlatformAuditReportRepresentation, because its key is the response id, which a 404 does not have.
|
|
13
|
+
*
|
|
14
|
+
* Keys:
|
|
15
|
+
* (none)
|
|
16
|
+
*/
|
|
17
|
+
export interface PlatformAuditReportReferenceRepresentationNormalized {
|
|
18
|
+
/** The 18 character ID of the asset. */
|
|
19
|
+
id: string;
|
|
20
|
+
/** The asset label. */
|
|
21
|
+
label?: string;
|
|
22
|
+
/** The asset developer name. */
|
|
23
|
+
name?: string;
|
|
24
|
+
/** The namespace that qualifies the asset name */
|
|
25
|
+
namespace?: string;
|
|
26
|
+
/** The asset URL. */
|
|
27
|
+
url?: string;
|
|
28
|
+
}
|
|
29
|
+
/**
|
|
30
|
+
* Same shape as AssetReferenceRepresentation, returned by the PDF-report GET endpoint. Kept as a separate, unkeyed type so it can carry its own (luvio.ttl), which Luvio forbids on an inherited shape such as AssetReferenceRepresentation. Without that TTL, the GET's 404 (no report yet) would be cached with no expiry. The GET cannot use the keyed PlatformAuditReportRepresentation, because its key is the response id, which a 404 does not have.
|
|
31
|
+
*
|
|
32
|
+
* Keys:
|
|
33
|
+
* (none)
|
|
34
|
+
*/
|
|
35
|
+
export interface PlatformAuditReportReferenceRepresentation {
|
|
36
|
+
id: string;
|
|
37
|
+
label?: string;
|
|
38
|
+
name?: string;
|
|
39
|
+
namespace?: string;
|
|
40
|
+
url?: string;
|
|
41
|
+
}
|
|
@@ -29,25 +29,25 @@ export interface PlatformAuditRepresentationNormalized {
|
|
|
29
29
|
/** The ID of the platform audit run. */
|
|
30
30
|
auditId: string;
|
|
31
31
|
checks: PlatformAuditCheckCollectionRepresentation_PlatformAuditCheckCollectionRepresentation;
|
|
32
|
-
/** The number of checks that have
|
|
32
|
+
/** The number of checks that have finished. It stays below checksTotal for a run that ended early, and is 0 for a CANCELLED run, so use runStatus, not this count, to tell whether the run is still going. */
|
|
33
33
|
checksTerminal: number;
|
|
34
34
|
/** The total number of checks fanned out for this audit run. */
|
|
35
35
|
checksTotal: number;
|
|
36
|
-
/** The date the platform audit run completed.
|
|
36
|
+
/** The date the platform audit run completed, or for a CANCELLED run, the date it was cancelled. Absent while the run is RUNNING. */
|
|
37
37
|
completedDate?: string | null;
|
|
38
38
|
/** The date the platform audit run was created. */
|
|
39
39
|
createdDate: string;
|
|
40
|
-
/** The aggregated health score for the run
|
|
40
|
+
/** The aggregated health score for the run, computed from its finished checks on every read, including while RUNNING. crma-inventory is not scored. Absent when the score is suppressed (the scored checks scanned less than half of their candidates, or had no candidates, as when no finished check could be scored) or could not be computed, and always absent for a CANCELLED run, which is not scored. */
|
|
41
41
|
healthScore?: number | null;
|
|
42
|
-
/** The runtime status of the platform audit run. */
|
|
42
|
+
/** The runtime status of the platform audit run. RUNNING until every check has finished, the run ends early, or a user cancels it. A run cancelled while RUNNING is CANCELLED - its check results are discarded, every check it lists is CANCELLED, and it is not scored. A run that ended before every check finished in any other way, for example because it ran too long, is FAILED. Otherwise the terminal status depends on every check except crma-inventory (or on every check, if crma-inventory is the only one) - READY if each is COMPLETE, FAILED if none is COMPLETE or COMPLETE_WITH_LIMITATIONS, and COMPLETE_WITH_LIMITATIONS otherwise. crma-inventory only counts the org's assets and its status does not affect the run's, so a READY run can have a crma-inventory check that is COMPLETE_WITH_LIMITATIONS, UNAVAILABLE, or FAILED; the run still waits for it to finish. A FAILED run can still carry finished checks, findings, and a health score; any unfinished check it lists is NOT_FINISHED. */
|
|
43
43
|
runStatus: string;
|
|
44
44
|
/** The scope of assets covered by the platform audit run. */
|
|
45
45
|
scope: string;
|
|
46
|
-
/** Whether the health score is suppressed for this run. */
|
|
46
|
+
/** Whether the health score is suppressed for this run, so consumers show a dash rather than a number. Always true for a CANCELLED run. crma-inventory does not count toward the coverage that decides suppression. Absent only when scoring could not be computed. */
|
|
47
47
|
scoreSuppressed?: boolean | null;
|
|
48
|
-
/** The aggregated health urgency triage, split into critical-now and needs-attention tiers.
|
|
48
|
+
/** The aggregated health urgency triage, split into critical-now and needs-attention tiers, computed from the finished checks on every read. Lists the scored checks' findings even when the score is suppressed. Both tiers are empty for a CANCELLED run. Absent only when scoring could not be computed. */
|
|
49
49
|
urgency?: PlatformAuditUrgencyRepresentation_PlatformAuditUrgencyRepresentation | null;
|
|
50
|
-
/** The aggregated health verdict for the run
|
|
50
|
+
/** The aggregated health verdict for the run (Healthy, NeedsAttention, Critical, or Indeterminate when the score is suppressed), computed from its finished checks on every read, including while RUNNING; crma-inventory does not affect it. NotApplicable for a CANCELLED run, which is not scored. Absent only when scoring could not be computed. */
|
|
51
51
|
verdict?: string | null;
|
|
52
52
|
}
|
|
53
53
|
/**
|
|
@@ -20,25 +20,25 @@ export interface PlatformAuditSnapshotRepresentationNormalized {
|
|
|
20
20
|
/** The ID of the platform audit run. */
|
|
21
21
|
auditId: string;
|
|
22
22
|
checks: PlatformAuditCheckCollectionRepresentation_PlatformAuditCheckCollectionRepresentation;
|
|
23
|
-
/** The number of checks that have
|
|
23
|
+
/** The number of checks that have finished. It stays below checksTotal for a run that ended early, and is 0 for a CANCELLED run, so use runStatus, not this count, to tell whether the run is still going. */
|
|
24
24
|
checksTerminal: number;
|
|
25
25
|
/** The total number of checks fanned out for this audit run. */
|
|
26
26
|
checksTotal: number;
|
|
27
|
-
/** The date the platform audit run completed.
|
|
27
|
+
/** The date the platform audit run completed, or for a CANCELLED run, the date it was cancelled. Absent while the run is RUNNING. */
|
|
28
28
|
completedDate?: string | null;
|
|
29
29
|
/** The date the platform audit run was created. */
|
|
30
30
|
createdDate: string;
|
|
31
|
-
/** The aggregated health score for the run
|
|
31
|
+
/** The aggregated health score for the run, computed from its finished checks on every read, including while RUNNING. crma-inventory is not scored. Absent when the score is suppressed (the scored checks scanned less than half of their candidates, or had no candidates, as when no finished check could be scored) or could not be computed, and always absent for a CANCELLED run, which is not scored. */
|
|
32
32
|
healthScore?: number | null;
|
|
33
|
-
/** The runtime status of the platform audit run. */
|
|
33
|
+
/** The runtime status of the platform audit run. RUNNING until every check has finished, the run ends early, or a user cancels it. A run cancelled while RUNNING is CANCELLED - its check results are discarded, every check it lists is CANCELLED, and it is not scored. A run that ended before every check finished in any other way, for example because it ran too long, is FAILED. Otherwise the terminal status depends on every check except crma-inventory (or on every check, if crma-inventory is the only one) - READY if each is COMPLETE, FAILED if none is COMPLETE or COMPLETE_WITH_LIMITATIONS, and COMPLETE_WITH_LIMITATIONS otherwise. crma-inventory only counts the org's assets and its status does not affect the run's, so a READY run can have a crma-inventory check that is COMPLETE_WITH_LIMITATIONS, UNAVAILABLE, or FAILED; the run still waits for it to finish. A FAILED run can still carry finished checks, findings, and a health score; any unfinished check it lists is NOT_FINISHED. */
|
|
34
34
|
runStatus: string;
|
|
35
35
|
/** The scope of assets covered by the platform audit run. */
|
|
36
36
|
scope: string;
|
|
37
|
-
/** Whether the health score is suppressed for this run. */
|
|
37
|
+
/** Whether the health score is suppressed for this run, so consumers show a dash rather than a number. Always true for a CANCELLED run. crma-inventory does not count toward the coverage that decides suppression. Absent only when scoring could not be computed. */
|
|
38
38
|
scoreSuppressed?: boolean | null;
|
|
39
|
-
/** The aggregated health urgency triage, split into critical-now and needs-attention tiers.
|
|
39
|
+
/** The aggregated health urgency triage, split into critical-now and needs-attention tiers, computed from the finished checks on every read. Lists the scored checks' findings even when the score is suppressed. Both tiers are empty for a CANCELLED run. Absent only when scoring could not be computed. */
|
|
40
40
|
urgency?: PlatformAuditUrgencyRepresentation_PlatformAuditUrgencyRepresentation | null;
|
|
41
|
-
/** The aggregated health verdict for the run
|
|
41
|
+
/** The aggregated health verdict for the run (Healthy, NeedsAttention, Critical, or Indeterminate when the score is suppressed), computed from its finished checks on every read, including while RUNNING; crma-inventory does not affect it. NotApplicable for a CANCELLED run, which is not scored. Absent only when scoring could not be computed. */
|
|
42
42
|
verdict?: string | null;
|
|
43
43
|
}
|
|
44
44
|
/**
|
|
@@ -17,23 +17,23 @@ export declare function getTypeCacheKeys(rootKeySet: $64$luvio_engine_DurableSto
|
|
|
17
17
|
export interface PlatformAuditSummaryRepresentationNormalized {
|
|
18
18
|
/** The ID of the platform audit run. */
|
|
19
19
|
auditId: string;
|
|
20
|
-
/** The number of checks that have
|
|
20
|
+
/** The number of checks that have finished. It stays below checksTotal for a run that ended early, and is 0 for a CANCELLED run, so use runStatus, not this count, to tell whether the run is still going. */
|
|
21
21
|
checksTerminal: number;
|
|
22
22
|
/** The total number of checks fanned out for this audit run. */
|
|
23
23
|
checksTotal: number;
|
|
24
|
-
/** The date the platform audit run completed.
|
|
24
|
+
/** The date the platform audit run completed, or for a CANCELLED run, the date it was cancelled. Absent while the run is RUNNING. */
|
|
25
25
|
completedDate?: string | null;
|
|
26
26
|
/** The date the platform audit run was created. */
|
|
27
27
|
createdDate: string;
|
|
28
|
-
/** The aggregated health score for the run
|
|
28
|
+
/** The aggregated health score for the run, computed from its finished checks on every read, including while RUNNING. crma-inventory is not scored. Absent when the score is suppressed (the scored checks scanned less than half of their candidates, or had no candidates, as when no finished check could be scored) or could not be computed, and always absent for a CANCELLED run, which is not scored. */
|
|
29
29
|
healthScore?: number | null;
|
|
30
|
-
/** The runtime status of the platform audit run. */
|
|
30
|
+
/** The runtime status of the platform audit run. RUNNING until every check has finished, the run ends early, or a user cancels it. A run cancelled while RUNNING is CANCELLED - its check results are discarded and it is not scored. A run that ended before every check finished in any other way, for example because it ran too long, is FAILED. Otherwise the terminal status depends on every check except crma-inventory (or on every check, if crma-inventory is the only one) - READY if each is COMPLETE, FAILED if none is COMPLETE or COMPLETE_WITH_LIMITATIONS, and COMPLETE_WITH_LIMITATIONS otherwise. crma-inventory only counts the org's assets and its status does not affect the run's, so a READY run can have a crma-inventory check that is COMPLETE_WITH_LIMITATIONS, UNAVAILABLE, or FAILED; the run still waits for it to finish. A FAILED run can still have a health score. */
|
|
31
31
|
runStatus: string;
|
|
32
32
|
/** The scope of assets covered by the platform audit run. */
|
|
33
33
|
scope: string;
|
|
34
|
-
/** Whether the health score is suppressed for this run. */
|
|
34
|
+
/** Whether the health score is suppressed for this run, so consumers show a dash rather than a number. Always true for a CANCELLED run. crma-inventory does not count toward the coverage that decides suppression. Absent only when scoring could not be computed. */
|
|
35
35
|
scoreSuppressed?: boolean | null;
|
|
36
|
-
/** The aggregated health verdict for the run
|
|
36
|
+
/** The aggregated health verdict for the run (Healthy, NeedsAttention, Critical, or Indeterminate when the score is suppressed), computed from its finished checks on every read, including while RUNNING; crma-inventory does not affect it. NotApplicable for a CANCELLED run, which is not scored. Absent only when scoring could not be computed. */
|
|
37
37
|
verdict?: string | null;
|
|
38
38
|
}
|
|
39
39
|
/**
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { PlatformAuditFindingRepresentation as PlatformAuditFindingRepresentation_PlatformAuditFindingRepresentation } from './PlatformAuditFindingRepresentation';
|
|
2
2
|
import { IngestPath as $64$luvio_engine_IngestPath, Luvio as $64$luvio_engine_Luvio, Store as $64$luvio_engine_Store, FragmentSelection as $64$luvio_engine_FragmentSelection, ResourceIngest as $64$luvio_engine_ResourceIngest, DurableStoreKeyMetadataMap as $64$luvio_engine_DurableStoreKeyMetadataMap, NormalizedKeyMetadata as $64$luvio_engine_NormalizedKeyMetadata } from '@luvio/engine';
|
|
3
3
|
export declare const TTL = 300;
|
|
4
|
-
export declare const VERSION = "
|
|
4
|
+
export declare const VERSION = "51c6525f2259b5219e90d75c591ddf7d";
|
|
5
5
|
export declare function validate(obj: any, path?: string): TypeError | null;
|
|
6
6
|
export declare const RepresentationType: string;
|
|
7
7
|
export declare function normalize(input: PlatformAuditUrgencyRepresentation, existing: PlatformAuditUrgencyRepresentationNormalized, path: $64$luvio_engine_IngestPath, luvio: $64$luvio_engine_Luvio, store: $64$luvio_engine_Store, timestamp: number): PlatformAuditUrgencyRepresentationNormalized;
|
|
@@ -10,19 +10,19 @@ export declare function equals(existing: PlatformAuditUrgencyRepresentationNorma
|
|
|
10
10
|
export declare const ingest: $64$luvio_engine_ResourceIngest;
|
|
11
11
|
export declare function getTypeCacheKeys(rootKeySet: $64$luvio_engine_DurableStoreKeyMetadataMap, luvio: $64$luvio_engine_Luvio, input: PlatformAuditUrgencyRepresentation, fullPathFactory: () => string | $64$luvio_engine_NormalizedKeyMetadata): void;
|
|
12
12
|
/**
|
|
13
|
-
* The aggregator's two-tier urgency triage over the run's findings.
|
|
13
|
+
* The aggregator's two-tier urgency triage over the run's findings. Each check contributes only the findings it surfaces, and the number it surfaces is capped (currently at most 25 datasets per label for crma-orphans and 10 clusters for crma-trace-redundancies; the caps can change), so list lengths are not org-wide counts.
|
|
14
14
|
*
|
|
15
15
|
* Keys:
|
|
16
16
|
* (none)
|
|
17
17
|
*/
|
|
18
18
|
export interface PlatformAuditUrgencyRepresentationNormalized {
|
|
19
|
-
/** Findings the user should act on now,
|
|
19
|
+
/** Findings the user should act on now, sorted by checkName, then refId. */
|
|
20
20
|
criticalNow: Array<PlatformAuditFindingRepresentation_PlatformAuditFindingRepresentation>;
|
|
21
|
-
/** Findings that need attention as standing hygiene,
|
|
21
|
+
/** Findings that need attention as standing hygiene, sorted by checkName, then refId. */
|
|
22
22
|
needsAttention: Array<PlatformAuditFindingRepresentation_PlatformAuditFindingRepresentation>;
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
|
-
* The aggregator's two-tier urgency triage over the run's findings.
|
|
25
|
+
* The aggregator's two-tier urgency triage over the run's findings. Each check contributes only the findings it surfaces, and the number it surfaces is capped (currently at most 25 datasets per label for crma-orphans and 10 clusters for crma-trace-redundancies; the caps can change), so list lengths are not org-wide counts.
|
|
26
26
|
*
|
|
27
27
|
* Keys:
|
|
28
28
|
* (none)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@salesforce/lds-adapters-analytics-wave",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.466.0",
|
|
4
4
|
"license": "SEE LICENSE IN LICENSE.txt",
|
|
5
5
|
"description": "The Einstein Analytics family of APIs",
|
|
6
6
|
"main": "dist/es/es2018/analytics-wave.js",
|
|
@@ -58,10 +58,10 @@
|
|
|
58
58
|
}
|
|
59
59
|
},
|
|
60
60
|
"dependencies": {
|
|
61
|
-
"@salesforce/lds-bindings": "^1.
|
|
61
|
+
"@salesforce/lds-bindings": "^1.466.0"
|
|
62
62
|
},
|
|
63
63
|
"devDependencies": {
|
|
64
|
-
"@salesforce/lds-compiler-plugins": "^1.
|
|
64
|
+
"@salesforce/lds-compiler-plugins": "^1.466.0"
|
|
65
65
|
},
|
|
66
66
|
"volta": {
|
|
67
67
|
"extends": "../../package.json"
|