@salesforce/lds-adapters-platform-learning-content 1.136.8 → 1.138.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/src/raml/api.raml CHANGED
@@ -25,29 +25,6 @@ annotationTypes:
25
25
  type: string
26
26
  allowedTargets: TypeDeclaration
27
27
  types:
28
- FeedbackResultRepresentation:
29
- description: This representation returns coaching feedback result if any feedback
30
- exists
31
- type: object
32
- properties:
33
- isFeedbackRequestSubmitted:
34
- description: Returns if a feedback request submitted
35
- type: boolean
36
- isFeedbackResultReturned:
37
- description: Returns if there is feedback result exists
38
- type: boolean
39
- learningItemId:
40
- description: Learning Item ID of the Coaching Feedback Result
41
- type: string
42
- surveyQuestionResponseRepresetationList:
43
- description: List of the SurveyQuestionResponse Representation
44
- type: array
45
- items:
46
- type: SurveyQuestionResponseRepresetation
47
- totalAvgScore:
48
- description: The total average score of all rating questions
49
- format: double
50
- type: number
51
28
  EvaluateLearningItemInputWrapperRepresentation: # TODO Hand-rolled W-8334626
52
29
  description: Wrapper for evaluate learning item input representation
53
30
  type: object
@@ -609,37 +586,6 @@ types:
609
586
  type:
610
587
  description: Represents the module type
611
588
  type: string
612
- SurveyQuestionResponseRepresetation:
613
- description: This representation maps to the SurveyQuestionResponse class
614
- type: object
615
- properties:
616
- avgScore:
617
- description: Average score of the question
618
- format: double
619
- type: number
620
- isRatingResponse:
621
- description: If question response is a rating value or text value
622
- type: boolean
623
- questionDescription:
624
- description: Description of the survey question
625
- type: string
626
- questionId:
627
- description: Id of the survey question response
628
- type: string
629
- questionName:
630
- description: Name of the survey question name
631
- type: string
632
- ratingValues:
633
- description: Rating value list of the rating type question response
634
- type: array
635
- items:
636
- type: integer
637
- textValues:
638
- description: User Id, Text value map of the text type question response
639
- type: object
640
- properties:
641
- //:
642
- type: string
643
589
  TrailheadModuleUnitRepresentation:
644
590
  description: This representation will be used to represent a single user's view
645
591
  of a Trailhead module's unit.
@@ -705,21 +651,6 @@ types:
705
651
  type: string
706
652
  required: true
707
653
  /learning:
708
- /feedbackresult/{learningItemId}:
709
- get:
710
- displayName: getFeedbackResult
711
- description: Returns a Feedback Result to the user based on the LearningItemId
712
- passed
713
- responses:
714
- '200':
715
- description: Success
716
- body:
717
- application/json:
718
- type: FeedbackResultRepresentation
719
- uriParameters:
720
- learningItemId:
721
- type: string
722
- required: true
723
654
  /search:
724
655
  /describe:
725
656
  get:
@@ -39,10 +39,6 @@ types:
39
39
  (luvio.ttl): 60000 # 60 seconds
40
40
  (luvio.key):
41
41
  learning_item_id: learningItemId
42
- FeedbackResultRepresentation:
43
- (luvio.ttl): 15000 # 15 seconds
44
- (luvio.key):
45
- learning_item_id: learningItemId
46
42
  LearningTextLessonRepresentation:
47
43
  (luvio.ttl): 60000 # 60 seconds
48
44
  (luvio.key):
@@ -104,12 +100,6 @@ types:
104
100
  name: getLearningPractice
105
101
  (luvio.key):
106
102
  learning_item_id: urlParams.learningItemId
107
- /feedbackresult/{learningItemId}:
108
- get:
109
- (luvio.adapter):
110
- name: getFeedbackResult
111
- (luvio.key):
112
- learning_item_id: urlParams.learningItemId
113
103
  /evaluate:
114
104
  post:
115
105
  (luvio.adapter):
@@ -1,27 +0,0 @@
1
- import { AdapterValidationConfig as adapter$45$utils_AdapterValidationConfig, Untrusted as adapter$45$utils_Untrusted, UncoercedConfiguration as adapter$45$utils_UncoercedConfiguration } from './adapter-utils';
2
- import { ResourceRequestConfig as resources_getLearningContentPlatformLearningFeedbackresultByLearningItemId_ResourceRequestConfig } from '../resources/getLearningContentPlatformLearningFeedbackresultByLearningItemId';
3
- 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';
4
- import { FeedbackResultRepresentation as types_FeedbackResultRepresentation_FeedbackResultRepresentation, KeyParams as types_FeedbackResultRepresentation_KeyParams } from '../types/FeedbackResultRepresentation';
5
- export declare const adapterName = "getFeedbackResult";
6
- export declare const getFeedbackResult_ConfigPropertyNames: adapter$45$utils_AdapterValidationConfig;
7
- export interface GetFeedbackResultConfig {
8
- learningItemId: string;
9
- }
10
- export declare function createResourceParams(config: GetFeedbackResultConfig): resources_getLearningContentPlatformLearningFeedbackresultByLearningItemId_ResourceRequestConfig;
11
- export declare function keyBuilder(luvio: $64$luvio_engine_Luvio, config: GetFeedbackResultConfig): string;
12
- export declare function keyBuilder_StructuredKey(luvio: $64$luvio_engine_Luvio, config: GetFeedbackResultConfig): $64$luvio_engine_NormalizedKeyMetadata;
13
- export declare function typeCheckConfig(untrustedConfig: adapter$45$utils_Untrusted<GetFeedbackResultConfig>): adapter$45$utils_Untrusted<GetFeedbackResultConfig>;
14
- export declare function validateAdapterConfig(untrustedConfig: unknown, configPropertyNames: adapter$45$utils_AdapterValidationConfig): GetFeedbackResultConfig | null;
15
- export declare function adapterFragment(luvio: $64$luvio_engine_Luvio, config: GetFeedbackResultConfig): $64$luvio_engine_Fragment;
16
- export declare function buildCachedSnapshot(luvio: $64$luvio_engine_Luvio, config: GetFeedbackResultConfig): $64$luvio_engine_Snapshot<types_FeedbackResultRepresentation_FeedbackResultRepresentation, any>;
17
- 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>>;
18
- 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>;
19
- 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>>;
20
- export type BuildSnapshotContext = {
21
- luvio: $64$luvio_engine_Luvio;
22
- config: GetFeedbackResultConfig;
23
- };
24
- export declare function buildNetworkSnapshotCachePolicy(context: BuildSnapshotContext, coercedAdapterRequestContext: $64$luvio_engine_CoercedAdapterRequestContext): Promise<$64$luvio_engine_Snapshot<types_FeedbackResultRepresentation_FeedbackResultRepresentation, any>>;
25
- export declare function buildCachedSnapshotCachePolicy(context: BuildSnapshotContext, storeLookup: $64$luvio_engine_StoreLookup<types_FeedbackResultRepresentation_FeedbackResultRepresentation>): $64$luvio_engine_Snapshot<types_FeedbackResultRepresentation_FeedbackResultRepresentation, any>;
26
- export declare const getFeedbackResultAdapterFactory: $64$luvio_engine_AdapterFactory<GetFeedbackResultConfig, types_FeedbackResultRepresentation_FeedbackResultRepresentation>;
27
- export declare const notifyChangeFactory: (luvio: $64$luvio_engine_Luvio, options?: $64$luvio_engine_DispatchResourceRequestContext) => (configs: adapter$45$utils_UncoercedConfiguration<types_FeedbackResultRepresentation_KeyParams, any>[]) => void;
@@ -1,16 +0,0 @@
1
- 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';
2
- import { FeedbackResultRepresentation as types_FeedbackResultRepresentation_FeedbackResultRepresentation } from '../types/FeedbackResultRepresentation';
3
- export interface ResourceRequestConfig {
4
- urlParams: {
5
- learningItemId: string;
6
- };
7
- }
8
- export declare function select(luvio: $64$luvio_engine_Luvio, params: ResourceRequestConfig): $64$luvio_engine_Fragment;
9
- export declare function keyBuilder(luvio: $64$luvio_engine_Luvio, params: ResourceRequestConfig): string;
10
- export declare function keyBuilder_StructuredKey(luvio: $64$luvio_engine_Luvio, params: ResourceRequestConfig): $64$luvio_engine_NormalizedKeyMetadata;
11
- export declare function getResponseCacheKeys(luvio: $64$luvio_engine_Luvio, resourceParams: ResourceRequestConfig, response: types_FeedbackResultRepresentation_FeedbackResultRepresentation): $64$luvio_engine_DurableStoreKeyMetadataMap;
12
- 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>;
13
- 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;
14
- export declare function createResourceRequest(config: ResourceRequestConfig): $64$luvio_engine_ResourceRequest;
15
- export default createResourceRequest;
16
- export declare function createResourceRequestFromRepresentation(representation: types_FeedbackResultRepresentation_FeedbackResultRepresentation): $64$luvio_engine_ResourceRequest;
@@ -1,51 +0,0 @@
1
- import { SurveyQuestionResponseRepresetation as SurveyQuestionResponseRepresetation_SurveyQuestionResponseRepresetation } from './SurveyQuestionResponseRepresetation';
2
- 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';
3
- export declare const TTL = 15000;
4
- export declare const VERSION = "49558b95e59b76b07748b6f259ebe54d";
5
- export declare function validate(obj: any, path?: string): TypeError | null;
6
- export declare const RepresentationType: string;
7
- export interface KeyParams extends $64$luvio_engine_KeyMetadata {
8
- learning_item_id: string;
9
- }
10
- export type FeedbackResultRepresentationNormalizedKeyMetadata = KeyParams & $64$luvio_engine_NormalizedKeyMetadata;
11
- export type PartialFeedbackResultRepresentationNormalizedKeyMetadata = Partial<KeyParams> & $64$luvio_engine_NormalizedKeyMetadata;
12
- export declare function keyBuilder(luvio: $64$luvio_engine_Luvio, config: KeyParams): string;
13
- export declare function keyBuilder_StructuredKey(luvio: $64$luvio_engine_Luvio, config: KeyParams): FeedbackResultRepresentationNormalizedKeyMetadata;
14
- export declare function keyBuilderFromType(luvio: $64$luvio_engine_Luvio, object: FeedbackResultRepresentation): string;
15
- export declare function keyBuilderFromType_StructuredKey(luvio: $64$luvio_engine_Luvio, object: FeedbackResultRepresentation): $64$luvio_engine_NormalizedKeyMetadata;
16
- 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;
17
- export declare const select: () => $64$luvio_engine_FragmentSelection;
18
- export declare function equals(existing: FeedbackResultRepresentationNormalized, incoming: FeedbackResultRepresentationNormalized): boolean;
19
- export declare const ingest: $64$luvio_engine_ResourceIngest;
20
- export declare function getTypeCacheKeys(luvio: $64$luvio_engine_Luvio, input: FeedbackResultRepresentation, fullPathFactory: () => string | $64$luvio_engine_NormalizedKeyMetadata): $64$luvio_engine_DurableStoreKeyMetadataMap;
21
- /**
22
- * This representation returns coaching feedback result if any feedback exists
23
- *
24
- * Keys:
25
- * learning_item_id (string): learningItemId
26
- */
27
- export interface FeedbackResultRepresentationNormalized {
28
- /** Returns if a feedback request submitted */
29
- isFeedbackRequestSubmitted: boolean;
30
- /** Returns if there is feedback result exists */
31
- isFeedbackResultReturned: boolean;
32
- /** Learning Item ID of the Coaching Feedback Result */
33
- learningItemId: string;
34
- /** List of the SurveyQuestionResponse Representation */
35
- surveyQuestionResponseRepresetationList: Array<SurveyQuestionResponseRepresetation_SurveyQuestionResponseRepresetation>;
36
- /** The total average score of all rating questions */
37
- totalAvgScore: number;
38
- }
39
- /**
40
- * This representation returns coaching feedback result if any feedback exists
41
- *
42
- * Keys:
43
- * learning_item_id (string): learningItemId
44
- */
45
- export interface FeedbackResultRepresentation {
46
- isFeedbackRequestSubmitted: boolean;
47
- isFeedbackResultReturned: boolean;
48
- learningItemId: string;
49
- surveyQuestionResponseRepresetationList: Array<SurveyQuestionResponseRepresetation_SurveyQuestionResponseRepresetation>;
50
- totalAvgScore: number;
51
- }
@@ -1,50 +0,0 @@
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, NormalizedKeyMetadata as $64$luvio_engine_NormalizedKeyMetadata, DurableStoreKeyMetadataMap as $64$luvio_engine_DurableStoreKeyMetadataMap } from '@luvio/engine';
2
- export declare const VERSION = "a415abdc6f1eb9f80ab2e7981189f769";
3
- export declare function validate(obj: any, path?: string): TypeError | null;
4
- export declare const RepresentationType: string;
5
- 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;
6
- export declare const select: () => $64$luvio_engine_FragmentSelection;
7
- export declare function equals(existing: SurveyQuestionResponseRepresetationNormalized, incoming: SurveyQuestionResponseRepresetationNormalized): boolean;
8
- export declare const ingest: $64$luvio_engine_ResourceIngest;
9
- export declare function getTypeCacheKeys(luvio: $64$luvio_engine_Luvio, input: SurveyQuestionResponseRepresetation, fullPathFactory: () => string | $64$luvio_engine_NormalizedKeyMetadata): $64$luvio_engine_DurableStoreKeyMetadataMap;
10
- /**
11
- * This representation maps to the SurveyQuestionResponse class
12
- *
13
- * Keys:
14
- * (none)
15
- */
16
- export interface SurveyQuestionResponseRepresetationNormalized {
17
- /** Average score of the question */
18
- avgScore: number;
19
- /** If question response is a rating value or text value */
20
- isRatingResponse: boolean;
21
- /** Description of the survey question */
22
- questionDescription: string;
23
- /** Id of the survey question response */
24
- questionId: string;
25
- /** Name of the survey question name */
26
- questionName: string;
27
- /** Rating value list of the rating type question response */
28
- ratingValues: Array<number>;
29
- /** User Id, Text value map of the text type question response */
30
- textValues: {
31
- [key: string]: string;
32
- };
33
- }
34
- /**
35
- * This representation maps to the SurveyQuestionResponse class
36
- *
37
- * Keys:
38
- * (none)
39
- */
40
- export interface SurveyQuestionResponseRepresetation {
41
- avgScore: number;
42
- isRatingResponse: boolean;
43
- questionDescription: string;
44
- questionId: string;
45
- questionName: string;
46
- ratingValues: Array<number>;
47
- textValues: {
48
- [key: string]: string;
49
- };
50
- }