@salesforce/lds-adapters-platform-learning-content 1.132.0 → 1.133.0

package/dist/es/es2018/types/src/generated/adapters/getFeedbackResult.d.ts

@@ -0,0 +1,27 @@
+import { AdapterValidationConfig as adapter$45$utils_AdapterValidationConfig, Untrusted as adapter$45$utils_Untrusted, UncoercedConfiguration as adapter$45$utils_UncoercedConfiguration } from './adapter-utils';
+import { ResourceRequestConfig as resources_getLearningContentPlatformLearningFeedbackresultByLearningItemId_ResourceRequestConfig } from '../resources/getLearningContentPlatformLearningFeedbackresultByLearningItemId';
+import { 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';
+import { FeedbackResultRepresentation as types_FeedbackResultRepresentation_FeedbackResultRepresentation, KeyParams as types_FeedbackResultRepresentation_KeyParams } from '../types/FeedbackResultRepresentation';
+export declare const adapterName = "getFeedbackResult";
+export declare const getFeedbackResult_ConfigPropertyNames: adapter$45$utils_AdapterValidationConfig;
+export interface GetFeedbackResultConfig {
+    learningItemId: string;
+}
+export declare function createResourceParams(config: GetFeedbackResultConfig): resources_getLearningContentPlatformLearningFeedbackresultByLearningItemId_ResourceRequestConfig;
+export declare function keyBuilder(luvio: $64$luvio_engine_Luvio, config: GetFeedbackResultConfig): string;
+export declare function keyBuilder_StructuredKey(luvio: $64$luvio_engine_Luvio, config: GetFeedbackResultConfig): $64$luvio_engine_NormalizedKeyMetadata;
+export declare function typeCheckConfig(untrustedConfig: adapter$45$utils_Untrusted<GetFeedbackResultConfig>): adapter$45$utils_Untrusted<GetFeedbackResultConfig>;
+export declare function validateAdapterConfig(untrustedConfig: unknown, configPropertyNames: adapter$45$utils_AdapterValidationConfig): GetFeedbackResultConfig | null;
+export declare function adapterFragment(luvio: $64$luvio_engine_Luvio, config: GetFeedbackResultConfig): $64$luvio_engine_Fragment;
+export declare function buildCachedSnapshot(luvio: $64$luvio_engine_Luvio, config: GetFeedbackResultConfig): $64$luvio_engine_Snapshot<types_FeedbackResultRepresentation_FeedbackResultRepresentation, any>;
+export declare function onFetchResponseSuccess(luvio: $64$luvio_engine_Luvio, config: GetFeedbackResultConfig, resourceParams: resources_getLearningContentPlatformLearningFeedbackresultByLearningItemId_ResourceRequestConfig, response: $64$luvio_engine_FetchResponse<types_FeedbackResultRepresentation_FeedbackResultRepresentation>): Promise<import("@luvio/engine").FulfilledSnapshot<types_FeedbackResultRepresentation_FeedbackResultRepresentation, {}> | import("@luvio/engine").StaleSnapshot<types_FeedbackResultRepresentation_FeedbackResultRepresentation, {}> | import("@luvio/engine").PendingSnapshot<types_FeedbackResultRepresentation_FeedbackResultRepresentation, any>>;
+export declare function onFetchResponseError(luvio: $64$luvio_engine_Luvio, config: GetFeedbackResultConfig, resourceParams: resources_getLearningContentPlatformLearningFeedbackresultByLearningItemId_ResourceRequestConfig, response: $64$luvio_engine_ErrorResponse): Promise<import("@luvio/engine").ErrorSnapshot>;
+export declare function buildNetworkSnapshot(luvio: $64$luvio_engine_Luvio, config: GetFeedbackResultConfig, options?: $64$luvio_engine_DispatchResourceRequestContext): Promise<$64$luvio_engine_Snapshot<types_FeedbackResultRepresentation_FeedbackResultRepresentation, any>>;
+export type BuildSnapshotContext = {
+    luvio: $64$luvio_engine_Luvio;
+    config: GetFeedbackResultConfig;
+};
+export declare function buildNetworkSnapshotCachePolicy(context: BuildSnapshotContext, coercedAdapterRequestContext: $64$luvio_engine_CoercedAdapterRequestContext): Promise<$64$luvio_engine_Snapshot<types_FeedbackResultRepresentation_FeedbackResultRepresentation, any>>;
+export declare function buildCachedSnapshotCachePolicy(context: BuildSnapshotContext, storeLookup: $64$luvio_engine_StoreLookup<types_FeedbackResultRepresentation_FeedbackResultRepresentation>): $64$luvio_engine_Snapshot<types_FeedbackResultRepresentation_FeedbackResultRepresentation, any>;
+export declare const getFeedbackResultAdapterFactory: $64$luvio_engine_AdapterFactory<GetFeedbackResultConfig, types_FeedbackResultRepresentation_FeedbackResultRepresentation>;
+export declare const notifyChangeFactory: (luvio: $64$luvio_engine_Luvio, options?: $64$luvio_engine_DispatchResourceRequestContext) => (configs: adapter$45$utils_UncoercedConfiguration<types_FeedbackResultRepresentation_KeyParams, any>[]) => void;

package/dist/es/es2018/types/src/generated/artifacts/main.d.ts

@@ -1,5 +1,6 @@
 export { getFeaturedItemsRecommendedListAdapterFactory } from '../adapters/getFeaturedItemsRecommendedList';
 export { getFeaturedItemsRelatedListAdapterFactory } from '../adapters/getFeaturedItemsRelatedList';
+export { getFeedbackResultAdapterFactory } from '../adapters/getFeedbackResult';
 export { getLearningSearchDescribeAdapterFactory } from '../adapters/getLearningSearchDescribe';
 export { getLearningSearchResultsAdapterFactory } from '../adapters/getLearningSearchResults';
 export { getLearningConfigAdapterFactory } from '../adapters/getLearningConfig';

package/dist/es/es2018/types/src/generated/artifacts/sfdc.d.ts

@@ -1,6 +1,8 @@
 declare let evaluateLearningItem: any;
 declare let getFeaturedItemsRecommendedList: any;
 declare let getFeaturedItemsRelatedList: any;
+declare let getFeedbackResult: any;
+declare let getFeedbackResultNotifyChange: any;
 declare let getLearningConfig: any;
 declare let getLearningItemProgress: any;
 declare let getLearningItemsList: any;
@@ -16,6 +18,7 @@ declare let getTextLesson: any;
 declare let getTextLessonNotifyChange: any;
 declare let getFeaturedItemsRecommendedList_imperative: any;
 declare let getFeaturedItemsRelatedList_imperative: any;
+declare let getFeedbackResult_imperative: any;
 declare let getLearningConfig_imperative: any;
 declare let getLearningItemProgress_imperative: any;
 declare let getLearningItemsList_imperative: any;
@@ -25,4 +28,4 @@ declare let getLearningSearchDescribe_imperative: any;
 declare let getLearningSearchResults_imperative: any;
 declare let getModule_imperative: any;
 declare let getTextLesson_imperative: any;
-export { evaluateLearningItem, getFeaturedItemsRecommendedList, getFeaturedItemsRelatedList, getLearningConfig, getLearningItemProgress, getLearningItemsList, getLearningModel, getLearningPractice, getLearningPracticeNotifyChange, getLearningSearchDescribe, getLearningSearchResults, getLearningSearchResultsNotifyChange, getModule, getModuleNotifyChange, getTextLesson, getTextLessonNotifyChange, getFeaturedItemsRecommendedList_imperative, getFeaturedItemsRelatedList_imperative, getLearningConfig_imperative, getLearningItemProgress_imperative, getLearningItemsList_imperative, getLearningModel_imperative, getLearningPractice_imperative, getLearningSearchDescribe_imperative, getLearningSearchResults_imperative, getModule_imperative, getTextLesson_imperative };
+export { evaluateLearningItem, getFeaturedItemsRecommendedList, getFeaturedItemsRelatedList, getFeedbackResult, getFeedbackResultNotifyChange, getLearningConfig, getLearningItemProgress, getLearningItemsList, getLearningModel, getLearningPractice, getLearningPracticeNotifyChange, getLearningSearchDescribe, getLearningSearchResults, getLearningSearchResultsNotifyChange, getModule, getModuleNotifyChange, getTextLesson, getTextLessonNotifyChange, getFeaturedItemsRecommendedList_imperative, getFeaturedItemsRelatedList_imperative, getFeedbackResult_imperative, getLearningConfig_imperative, getLearningItemProgress_imperative, getLearningItemsList_imperative, getLearningModel_imperative, getLearningPractice_imperative, getLearningSearchDescribe_imperative, getLearningSearchResults_imperative, getModule_imperative, getTextLesson_imperative };

package/dist/es/es2018/types/src/generated/resources/getLearningContentPlatformLearningFeedbackresultByLearningItemId.d.ts

@@ -0,0 +1,16 @@
+import { Luvio as $64$luvio_engine_Luvio, Fragment as $64$luvio_engine_Fragment, NormalizedKeyMetadata as $64$luvio_engine_NormalizedKeyMetadata, DurableStoreKeyMetadataMap as $64$luvio_engine_DurableStoreKeyMetadataMap, 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';
+import { FeedbackResultRepresentation as types_FeedbackResultRepresentation_FeedbackResultRepresentation } from '../types/FeedbackResultRepresentation';
+export interface ResourceRequestConfig {
+    urlParams: {
+        learningItemId: string;
+    };
+}
+export declare function select(luvio: $64$luvio_engine_Luvio, params: ResourceRequestConfig): $64$luvio_engine_Fragment;
+export declare function keyBuilder(luvio: $64$luvio_engine_Luvio, params: ResourceRequestConfig): string;
+export declare function keyBuilder_StructuredKey(luvio: $64$luvio_engine_Luvio, params: ResourceRequestConfig): $64$luvio_engine_NormalizedKeyMetadata;
+export declare function getResponseCacheKeys(luvio: $64$luvio_engine_Luvio, resourceParams: ResourceRequestConfig, response: types_FeedbackResultRepresentation_FeedbackResultRepresentation): $64$luvio_engine_DurableStoreKeyMetadataMap;
+export declare function ingestSuccess(luvio: $64$luvio_engine_Luvio, resourceParams: ResourceRequestConfig, response: $64$luvio_engine_FetchResponse<types_FeedbackResultRepresentation_FeedbackResultRepresentation>, snapshotRefresh?: $64$luvio_engine_SnapshotRefresh<types_FeedbackResultRepresentation_FeedbackResultRepresentation>): $64$luvio_engine_FulfilledSnapshot<types_FeedbackResultRepresentation_FeedbackResultRepresentation, {}> | $64$luvio_engine_StaleSnapshot<types_FeedbackResultRepresentation_FeedbackResultRepresentation, {}> | $64$luvio_engine_PendingSnapshot<types_FeedbackResultRepresentation_FeedbackResultRepresentation, any>;
+export declare function ingestError(luvio: $64$luvio_engine_Luvio, params: ResourceRequestConfig, error: $64$luvio_engine_ErrorResponse, snapshotRefresh?: $64$luvio_engine_SnapshotRefresh<types_FeedbackResultRepresentation_FeedbackResultRepresentation>): $64$luvio_engine_ErrorSnapshot;
+export declare function createResourceRequest(config: ResourceRequestConfig): $64$luvio_engine_ResourceRequest;
+export default createResourceRequest;
+export declare function createResourceRequestFromRepresentation(representation: types_FeedbackResultRepresentation_FeedbackResultRepresentation): $64$luvio_engine_ResourceRequest;

package/dist/es/es2018/types/src/generated/types/FeedbackResultRepresentation.d.ts

@@ -0,0 +1,52 @@
+import { SurveyQuestionResponseRepresetation as SurveyQuestionResponseRepresetation_SurveyQuestionResponseRepresetation } from './SurveyQuestionResponseRepresetation';
+import { KeyMetadata as $64$luvio_engine_KeyMetadata, NormalizedKeyMetadata as $64$luvio_engine_NormalizedKeyMetadata, Luvio as $64$luvio_engine_Luvio, IngestPath as $64$luvio_engine_IngestPath, Store as $64$luvio_engine_Store, FragmentSelection as $64$luvio_engine_FragmentSelection, ResourceIngest as $64$luvio_engine_ResourceIngest, DurableStoreKeyMetadataMap as $64$luvio_engine_DurableStoreKeyMetadataMap } from '@luvio/engine';
+export declare const TTL = 15000;
+export declare const VERSION = "49558b95e59b76b07748b6f259ebe54d";
+export declare function validate(obj: any, path?: string): TypeError | null;
+export declare const RepresentationType: string;
+export interface KeyParams extends $64$luvio_engine_KeyMetadata {
+    learning_item_id: string;
+}
+export type FeedbackResultRepresentationNormalizedKeyMetadata = KeyParams & $64$luvio_engine_NormalizedKeyMetadata;
+export type PartialFeedbackResultRepresentationNormalizedKeyMetadata = Partial<KeyParams> & $64$luvio_engine_NormalizedKeyMetadata;
+export declare function keyBuilder(luvio: $64$luvio_engine_Luvio, config: KeyParams): string;
+export declare function keyBuilder_StructuredKey(luvio: $64$luvio_engine_Luvio, config: KeyParams): FeedbackResultRepresentationNormalizedKeyMetadata;
+export declare function keyBuilderFromType(luvio: $64$luvio_engine_Luvio, object: FeedbackResultRepresentation): string;
+export declare function keyBuilderFromType_StructuredKey(luvio: $64$luvio_engine_Luvio, object: FeedbackResultRepresentation): $64$luvio_engine_NormalizedKeyMetadata;
+export declare function normalize(input: FeedbackResultRepresentation, existing: FeedbackResultRepresentationNormalized, path: $64$luvio_engine_IngestPath, luvio: $64$luvio_engine_Luvio, store: $64$luvio_engine_Store, timestamp: number): FeedbackResultRepresentationNormalized;
+export declare const select: () => $64$luvio_engine_FragmentSelection;
+export declare function equals(existing: FeedbackResultRepresentationNormalized, incoming: FeedbackResultRepresentationNormalized): boolean;
+export declare function deepFreeze(input: FeedbackResultRepresentation): void;
+export declare const ingest: $64$luvio_engine_ResourceIngest;
+export declare function getTypeCacheKeys(luvio: $64$luvio_engine_Luvio, input: FeedbackResultRepresentation, fullPathFactory: () => string | $64$luvio_engine_NormalizedKeyMetadata): $64$luvio_engine_DurableStoreKeyMetadataMap;
+/**
+ * This representation returns coaching feedback result if any feedback exists
+ *
+ * Keys:
+ *    learning_item_id (string): learningItemId
+ */
+export interface FeedbackResultRepresentationNormalized {
+    /** Returns if a feedback request submitted */
+    isFeedbackRequestSubmitted: boolean;
+    /** Returns if there is feedback result exists */
+    isFeedbackResultReturned: boolean;
+    /** Learning Item ID of the Coaching Feedback Result */
+    learningItemId: string;
+    /** List of the SurveyQuestionResponse Representation */
+    surveyQuestionResponseRepresetationList: Array<SurveyQuestionResponseRepresetation_SurveyQuestionResponseRepresetation>;
+    /** The total average score of all rating questions */
+    totalAvgScore: number;
+}
+/**
+ * This representation returns coaching feedback result if any feedback exists
+ *
+ * Keys:
+ *    learning_item_id (string): learningItemId
+ */
+export interface FeedbackResultRepresentation {
+    isFeedbackRequestSubmitted: boolean;
+    isFeedbackResultReturned: boolean;
+    learningItemId: string;
+    surveyQuestionResponseRepresetationList: Array<SurveyQuestionResponseRepresetation_SurveyQuestionResponseRepresetation>;
+    totalAvgScore: number;
+}

package/dist/es/es2018/types/src/generated/types/SurveyQuestionResponseRepresetation.d.ts

@@ -0,0 +1,51 @@
+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, NormalizedKeyMetadata as $64$luvio_engine_NormalizedKeyMetadata, DurableStoreKeyMetadataMap as $64$luvio_engine_DurableStoreKeyMetadataMap } from '@luvio/engine';
+export declare const VERSION = "a415abdc6f1eb9f80ab2e7981189f769";
+export declare function validate(obj: any, path?: string): TypeError | null;
+export declare const RepresentationType: string;
+export declare function normalize(input: SurveyQuestionResponseRepresetation, existing: SurveyQuestionResponseRepresetationNormalized, path: $64$luvio_engine_IngestPath, luvio: $64$luvio_engine_Luvio, store: $64$luvio_engine_Store, timestamp: number): SurveyQuestionResponseRepresetationNormalized;
+export declare const select: () => $64$luvio_engine_FragmentSelection;
+export declare function equals(existing: SurveyQuestionResponseRepresetationNormalized, incoming: SurveyQuestionResponseRepresetationNormalized): boolean;
+export declare function deepFreeze(input: SurveyQuestionResponseRepresetation): void;
+export declare const ingest: $64$luvio_engine_ResourceIngest;
+export declare function getTypeCacheKeys(luvio: $64$luvio_engine_Luvio, input: SurveyQuestionResponseRepresetation, fullPathFactory: () => string | $64$luvio_engine_NormalizedKeyMetadata): $64$luvio_engine_DurableStoreKeyMetadataMap;
+/**
+ * This representation maps to the SurveyQuestionResponse class
+ *
+ * Keys:
+ *    (none)
+ */
+export interface SurveyQuestionResponseRepresetationNormalized {
+    /** Average score of the question */
+    avgScore: number;
+    /** If question response is a rating value or text value */
+    isRatingResponse: boolean;
+    /** Description of the survey question */
+    questionDescription: string;
+    /** Id of the survey question response */
+    questionId: string;
+    /** Name of the survey question name */
+    questionName: string;
+    /** Rating value list of the rating type question response */
+    ratingValues: Array<number>;
+    /** User Id, Text value map of the text type question response */
+    textValues: {
+        [key: string]: string;
+    };
+}
+/**
+ * This representation maps to the SurveyQuestionResponse class
+ *
+ * Keys:
+ *    (none)
+ */
+export interface SurveyQuestionResponseRepresetation {
+    avgScore: number;
+    isRatingResponse: boolean;
+    questionDescription: string;
+    questionId: string;
+    questionName: string;
+    ratingValues: Array<number>;
+    textValues: {
+        [key: string]: string;
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforce/lds-adapters-platform-learning-content",
-    "version": "1.132.0",
+    "version": "1.133.0",
     "license": "SEE LICENSE IN LICENSE.txt",
     "description": "Learning content platform",
     "main": "dist/es/es2018/platform-learning-content.js",