@salesforce/lds-adapters-platform-learning-content 0.1.0-dev1

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

@@ -0,0 +1,52 @@
+import { LearningTextLessonSectionRepresentation as LearningTextLessonSectionRepresentation_LearningTextLessonSectionRepresentation } from './LearningTextLessonSectionRepresentation';
+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 = 60000;
+export declare const VERSION = "66ac3fbc8b5a61745a45ebd7944654e4";
+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 LearningTextLessonRepresentationNormalizedKeyMetadata = KeyParams & $64$luvio_engine_NormalizedKeyMetadata;
+export type PartialLearningTextLessonRepresentationNormalizedKeyMetadata = 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): LearningTextLessonRepresentationNormalizedKeyMetadata;
+export declare function keyBuilderFromType(luvio: $64$luvio_engine_Luvio, object: LearningTextLessonRepresentation): string;
+export declare function keyBuilderFromType_StructuredKey(luvio: $64$luvio_engine_Luvio, object: LearningTextLessonRepresentation): $64$luvio_engine_NormalizedKeyMetadata;
+export declare function normalize(input: LearningTextLessonRepresentation, existing: LearningTextLessonRepresentationNormalized, path: $64$luvio_engine_IngestPath, luvio: $64$luvio_engine_Luvio, store: $64$luvio_engine_Store, timestamp: number): LearningTextLessonRepresentationNormalized;
+export declare const select: () => $64$luvio_engine_FragmentSelection;
+export declare function equals(existing: LearningTextLessonRepresentationNormalized, incoming: LearningTextLessonRepresentationNormalized): boolean;
+export declare const ingest: $64$luvio_engine_ResourceIngest;
+export declare function getTypeCacheKeys(rootKeySet: $64$luvio_engine_DurableStoreKeyMetadataMap, luvio: $64$luvio_engine_Luvio, input: LearningTextLessonRepresentation, fullPathFactory: () => string | $64$luvio_engine_NormalizedKeyMetadata): void;
+/**
+ * This representation maps to the LearningTextView class and is used to represent Text Lessons
+ *
+ * Keys:
+ *    learning_item_id (string): learningItemId
+ */
+export interface LearningTextLessonRepresentationNormalized {
+    /** Description of what the text lesson is for */
+    description: string;
+    /** Learning Item ID of the text lesson */
+    learningItemId: string;
+    /** Ordered list of all the LearningTextLessonSection sections that are part of the text lesson */
+    sections: Array<LearningTextLessonSectionRepresentation_LearningTextLessonSectionRepresentation>;
+    /** Title of the text lesson */
+    title: string;
+    /** Estimated time in minutes to read the entire text lesson */
+    totalTime: number;
+}
+/**
+ * This representation maps to the LearningTextView class and is used to represent Text Lessons
+ *
+ * Keys:
+ *    learning_item_id (string): learningItemId
+ */
+export interface LearningTextLessonRepresentation {
+    description: string;
+    learningItemId: string;
+    sections: Array<LearningTextLessonSectionRepresentation_LearningTextLessonSectionRepresentation>;
+    title: string;
+    totalTime: number;
+}
+export declare const notifyUpdateAvailableFactory: (luvio: $64$luvio_engine_Luvio) => (configs: Partial<KeyParams>[]) => Promise<void>;

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

@@ -0,0 +1,34 @@
+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';
+export declare const VERSION = "1027d7eb6300967ad6dd208f73cbf68e";
+export declare function validate(obj: any, path?: string): TypeError | null;
+export declare const RepresentationType: string;
+export declare function normalize(input: LearningTextLessonSectionRepresentation, existing: LearningTextLessonSectionRepresentationNormalized, path: $64$luvio_engine_IngestPath, luvio: $64$luvio_engine_Luvio, store: $64$luvio_engine_Store, timestamp: number): LearningTextLessonSectionRepresentationNormalized;
+export declare const select: () => $64$luvio_engine_FragmentSelection;
+export declare function equals(existing: LearningTextLessonSectionRepresentationNormalized, incoming: LearningTextLessonSectionRepresentationNormalized): boolean;
+export declare const ingest: $64$luvio_engine_ResourceIngest;
+export declare function getTypeCacheKeys(rootKeySet: $64$luvio_engine_DurableStoreKeyMetadataMap, luvio: $64$luvio_engine_Luvio, input: LearningTextLessonSectionRepresentation, fullPathFactory: () => string | $64$luvio_engine_NormalizedKeyMetadata): void;
+/**
+ * This representation maps to the LearningTextSectionView class and is used to represent Text Lesson Sections
+ *
+ * Keys:
+ *    (none)
+ */
+export interface LearningTextLessonSectionRepresentationNormalized {
+    /** Rich text content for the text lesson section */
+    content: string;
+    /** Description of what this section of the text lesson is trying to teach */
+    keyConcept: string | null;
+    /** Estimated time to read the section in minutes */
+    sectionTime: number;
+}
+/**
+ * This representation maps to the LearningTextSectionView class and is used to represent Text Lesson Sections
+ *
+ * Keys:
+ *    (none)
+ */
+export interface LearningTextLessonSectionRepresentation {
+    content: string;
+    keyConcept: string | null;
+    sectionTime: number;
+}

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

@@ -0,0 +1,81 @@
+import { TrailheadModuleUnitRepresentation as TrailheadModuleUnitRepresentation_TrailheadModuleUnitRepresentation } from './TrailheadModuleUnitRepresentation';
+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 = 21600000;
+export declare const VERSION = "9bed4edb4c9f077a2f7ce902f94afa38";
+export declare function validate(obj: any, path?: string): TypeError | null;
+export declare const RepresentationType: string;
+export interface KeyParams extends $64$luvio_engine_KeyMetadata {
+    relatedId: string;
+}
+export type TrailheadModuleRepresentationNormalizedKeyMetadata = KeyParams & $64$luvio_engine_NormalizedKeyMetadata;
+export type PartialTrailheadModuleRepresentationNormalizedKeyMetadata = 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): TrailheadModuleRepresentationNormalizedKeyMetadata;
+export declare function keyBuilderFromType(luvio: $64$luvio_engine_Luvio, object: TrailheadModuleRepresentation): string;
+export declare function keyBuilderFromType_StructuredKey(luvio: $64$luvio_engine_Luvio, object: TrailheadModuleRepresentation): $64$luvio_engine_NormalizedKeyMetadata;
+export declare function normalize(input: TrailheadModuleRepresentation, existing: TrailheadModuleRepresentationNormalized, path: $64$luvio_engine_IngestPath, luvio: $64$luvio_engine_Luvio, store: $64$luvio_engine_Store, timestamp: number): TrailheadModuleRepresentationNormalized;
+export declare const select: () => $64$luvio_engine_FragmentSelection;
+export declare function equals(existing: TrailheadModuleRepresentationNormalized, incoming: TrailheadModuleRepresentationNormalized): boolean;
+export declare const ingest: $64$luvio_engine_ResourceIngest;
+export declare function getTypeCacheKeys(rootKeySet: $64$luvio_engine_DurableStoreKeyMetadataMap, luvio: $64$luvio_engine_Luvio, input: TrailheadModuleRepresentation, fullPathFactory: () => string | $64$luvio_engine_NormalizedKeyMetadata): void;
+/**
+ * This representation will be used to represent a single user's view of a Trailhead module.
+ *
+ * Keys:
+ *    relatedId (string): relatedId
+ */
+export interface TrailheadModuleRepresentationNormalized {
+    /** Represents the total points possible for the module */
+    availablePointCount: number;
+    /** Represents the completedDate for the module for the end user at runtime */
+    completedDate: string | null;
+    /** Represents the number of units completed by the current user */
+    completedItemCount: number | null;
+    /** Represents the completion percentage of the module as a whole integer, */
+    completedPercent: number | null;
+    /** Represents the description of a module */
+    description: string;
+    /** Represents the number of minutes remaining for the user to complete the module */
+    durationCount: number;
+    /** Represents the number of points earned by the user for this module */
+    earnedPointCount: number | null;
+    /** Represents the image url of a module */
+    imageUrl: string;
+    /** Represents if the end-user completed the module */
+    isCompleted: boolean;
+    /** Represents if this content was sfdc curated or not */
+    isCuratedContent: boolean;
+    /** Represents the number of units associated with the module */
+    itemCount: number | null;
+    /** Represents the learning content items associated with this learning content */
+    moduleUnits: Array<TrailheadModuleUnitRepresentation_TrailheadModuleUnitRepresentation>;
+    /** Represents the Id for the entity backing the learning unit, E.g. this would return the Id for a Trailhead module if this was a Trailhead unit, or the Id for a LearningLink if this was a link to outside content */
+    relatedId: string;
+    /** Represents the localized title of a module */
+    title: string;
+    /** Represents the module type */
+    type: string;
+}
+/**
+ * This representation will be used to represent a single user's view of a Trailhead module.
+ *
+ * Keys:
+ *    relatedId (string): relatedId
+ */
+export interface TrailheadModuleRepresentation {
+    availablePointCount: number;
+    completedDate: string | null;
+    completedItemCount: number | null;
+    completedPercent: number | null;
+    description: string;
+    durationCount: number;
+    earnedPointCount: number | null;
+    imageUrl: string;
+    isCompleted: boolean;
+    isCuratedContent: boolean;
+    itemCount: number | null;
+    moduleUnits: Array<TrailheadModuleUnitRepresentation_TrailheadModuleUnitRepresentation>;
+    relatedId: string;
+    title: string;
+    type: string;
+}

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

@@ -0,0 +1,46 @@
+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';
+export declare const VERSION = "19c9bcb401bf39a211caeff8b3cde304";
+export declare function validate(obj: any, path?: string): TypeError | null;
+export declare const RepresentationType: string;
+export declare function normalize(input: TrailheadModuleUnitRepresentation, existing: TrailheadModuleUnitRepresentationNormalized, path: $64$luvio_engine_IngestPath, luvio: $64$luvio_engine_Luvio, store: $64$luvio_engine_Store, timestamp: number): TrailheadModuleUnitRepresentationNormalized;
+export declare const select: () => $64$luvio_engine_FragmentSelection;
+export declare function equals(existing: TrailheadModuleUnitRepresentationNormalized, incoming: TrailheadModuleUnitRepresentationNormalized): boolean;
+export declare const ingest: $64$luvio_engine_ResourceIngest;
+export declare function getTypeCacheKeys(rootKeySet: $64$luvio_engine_DurableStoreKeyMetadataMap, luvio: $64$luvio_engine_Luvio, input: TrailheadModuleUnitRepresentation, fullPathFactory: () => string | $64$luvio_engine_NormalizedKeyMetadata): void;
+/**
+ * This representation will be used to represent a single user's view of a Trailhead module's unit.
+ *
+ * Keys:
+ *    (none)
+ */
+export interface TrailheadModuleUnitRepresentationNormalized {
+    /** Represents the complete date of the item, Date if the user has completed the item else null */
+    completedDate: string | null;
+    /** Represents the URL of a page that will render the content of this item */
+    contentUrl: string;
+    /** Represents the duration to complete the item */
+    durationCount: number;
+    /** Represents the number of points earned by the user for this item */
+    earnedPointCount: number | null;
+    /** Represents the id of a learning content item */
+    id: string;
+    /** Represents the title of a learning content item */
+    title: string;
+    /** Represents the trusted frame origin used in iframe messaging. */
+    trustedFrameOrigin: string;
+}
+/**
+ * This representation will be used to represent a single user's view of a Trailhead module's unit.
+ *
+ * Keys:
+ *    (none)
+ */
+export interface TrailheadModuleUnitRepresentation {
+    completedDate: string | null;
+    contentUrl: string;
+    durationCount: number;
+    earnedPointCount: number | null;
+    id: string;
+    title: string;
+    trustedFrameOrigin: string;
+}

package/dist/es/es2018/types/src/generated/types/type-utils.d.ts

@@ -0,0 +1,32 @@
+import { NormalizedKeyMetadata as $64$luvio_engine_NormalizedKeyMetadata } from '@luvio/engine';
+export declare const ObjectKeys: {
+    (o: object): string[];
+    (o: {}): string[];
+}, ObjectCreate: {
+    (o: object | null): any;
+    (o: object | null, properties: PropertyDescriptorMap & ThisType<any>): any;
+}, ObjectAssign: {
+    <T extends {}, U>(target: T, source: U): T & U;
+    <T_1 extends {}, U_1, V>(target: T_1, source1: U_1, source2: V): T_1 & U_1 & V;
+    <T_2 extends {}, U_2, V_1, W>(target: T_2, source1: U_2, source2: V_1, source3: W): T_2 & U_2 & V_1 & W;
+    (target: object, ...sources: any[]): any;
+};
+export declare const ArrayIsArray: (arg: any) => arg is any[];
+export declare const JSONStringify: {
+    (value: any, replacer?: ((this: any, key: string, value: any) => any) | undefined, space?: string | number | undefined): string;
+    (value: any, replacer?: (string | number)[] | null | undefined, space?: string | number | undefined): string;
+};
+type AllowedPrimitives = boolean | string | number | Date | null;
+type Value<T> = T extends AllowedPrimitives ? T : RecursivePartial<T>;
+export type RecursivePartial<T> = null | {
+    [P in keyof T]?: T[P] extends Array<infer U> ? Array<Value<U>> | null : Value<T[P]> | null;
+};
+export declare function equalsArray<U, V extends U[]>(a: V, b: V, equalsItem: (itemA: U, itemB: U) => boolean | void): boolean;
+export declare function equalsObject<U, V extends {
+    [key: string]: U;
+}>(a: V, b: V, equalsProp: (propA: U, propB: U) => boolean | void): boolean;
+export declare function createLink(ref: string | $64$luvio_engine_NormalizedKeyMetadata): {
+    __ref: string;
+};
+export declare function assignMetadataLink(entry: any, metadataKey: string | $64$luvio_engine_NormalizedKeyMetadata): void;
+export {};

package/package.json

@@ -0,0 +1,71 @@
+{
+    "name": "@salesforce/lds-adapters-platform-learning-content",
+    "version": "0.1.0-dev1",
+    "license": "SEE LICENSE IN LICENSE.txt",
+    "description": "Learning content platform",
+    "main": "dist/es/es2018/platform-learning-content.js",
+    "module": "dist/es/es2018/platform-learning-content.js",
+    "types": "dist/es/es2018/types/src/main.d.ts",
+    "files": [
+        "dist",
+        "sfdc",
+        "src/raml/*"
+    ],
+    "exports": {
+        ".": {
+            "types": "./dist/es/es2018/types/src/main.d.ts",
+            "import": "./dist/es/es2018/platform-learning-content.js",
+            "require": "./dist/es/es2018/platform-learning-content.js"
+        },
+        "./sfdc": {
+            "types": "./sfdc/index.d.ts",
+            "import": "./sfdc/index.js",
+            "default": "./sfdc/index.js"
+        }
+    },
+    "contributors": [
+        "a.dandekar@salesforce.com"
+    ],
+    "scripts": {
+        "build": "yarn build:services",
+        "build:karma": "rollup --bundleConfigAsCjs --config rollup.config.karma.js",
+        "build:raml": "luvio generate src/raml/luvio.raml src/generated -p '../lds-compiler-plugins'",
+        "build:services": "rollup --bundleConfigAsCjs --config rollup.config.js",
+        "clean": "rm -rf dist sfdc src/generated karma/dist",
+        "release:core": "../../scripts/release/core.js --adapter=lds-adapters-platform-learning-content",
+        "release:corejar": "yarn build && packages/core-build/scripts/core.js --adapter=lds-adapters-platform-learning-content",
+        "start": "nx build:karma && karma start",
+        "test": "nx build:karma && karma start --single-run",
+        "test:unit": "jest --config=./jest.config.js"
+    },
+    "dependencies": {
+        "@salesforce/lds-bindings": "^0.1.0-dev1"
+    },
+    "devDependencies": {
+        "@salesforce/lds-compiler-plugins": "^0.1.0-dev1",
+        "@salesforce/lds-karma": "^0.1.0-dev1"
+    },
+    "nx": {
+        "targets": {
+            "build": {
+                "outputs": [
+                    "{projectRoot}/dist",
+                    "{projectRoot}/sfdc"
+                ]
+            },
+            "build:raml": {
+                "outputs": [
+                    "{projectRoot}/src/generated"
+                ]
+            },
+            "build:karma": {
+                "outputs": [
+                    "{projectRoot}/karma/dist"
+                ]
+            }
+        }
+    },
+    "volta": {
+        "extends": "../../package.json"
+    }
+}

package/sfdc/index.d.ts

@@ -0,0 +1 @@
+export * from '../dist/es/es2018/types/src/generated/artifacts/sfdc';