@clickview/player 0.0.16 → 0.0.17-dev.0

package/dist/libs/analytics/src/clients/CollectionApiClient.d.ts

@@ -13,6 +13,7 @@ interface CollectionApiClientOptions {
     getUser: () => Promise<AnalyticsUser>;
     shouldLog?: (event: IncomingEvent) => boolean;
     formatData?: (event: IncomingEvent) => HashObject | HashObject[];
+    logError?: (error: Error) => void;
 }
 /**
  * A client for logging to CollectionApi.
@@ -41,5 +42,6 @@ export declare class CollectionApiClient {
     private getEventMetadata;
     private getRegionByName;
     private normalizeYearGroup;
+    private logError;
 }
 export {};

package/dist/libs/common/src/backbone/services/LanguageService.d.ts

@@ -15,6 +15,16 @@ declare class StaticLanguageService extends BaseService {
     static get Instance(): StaticLanguageService;
     get name(): string;
     setConfig(config: LanguageConfig): void;
+    /**
+     * This function will escape any HTML in the values of `options` before interpolating the phrase.
+     * Any HTML from a .lang.json file will not be escaped.
+     *
+     * The reason that we escape `options` is that this is dynamic data that could come from user-input.
+     *
+     * If the output of this function is passed into `dangerouslySetInnerHTML` (e.g. in <Text /> or when using alerts),
+     * it should be passed through TextHelper.sanitize as an extra safeguard against XSS.
+     * TextHelper.sanitize will preserve any safe HTML, allowing custom HTML to be set in .lang.json files.
+     */
     getPhrase(namespace: string, phraseKey: string, options?: LanguageInterpolationOptions): string;
     encloseNamespace(namespace: string): (phraseKey: string, options?: LanguageInterpolationOptions) => string;
 }

package/dist/libs/common/src/react/utils/TextHelper.d.ts

@@ -0,0 +1,18 @@
+import { ObjectHash } from 'backbone';
+export declare const TextHelper: {
+    escapeExpression(text: string): string;
+    escapeRegExp(str: string): string;
+    slugify(str: string): string;
+    linkifyText(text: string, options?: ObjectHash): string;
+    isEqual(str1: string | number, str2: string | number): boolean;
+    toTitleCase(str: string): string;
+    /**
+     * DOMPurify.sanitize encodes '&' characters.
+     * At the moment, this appears to be the intended behaviour:
+     * https://github.com/cure53/DOMPurify/issues/379
+     *
+     * Note: DOMPurify.sanitize does not escape HTML. It will remove
+     * any XSS threats, leaving safe HTML.
+     */
+    sanitize(text: string): string;
+};

package/dist/libs/shared/src/hooks/UseLazyLoad.d.ts

@@ -1,6 +1,12 @@
 interface LazyUtils {
     ref: (node?: Element) => void | null;
     inView: boolean;
+    /**
+     * Use this if you want to hide something on start
+     * and then show it as something else leaves the window
+     * e.g. The student feed floating jump to button
+     */
+    initialized: boolean;
 }
 interface UseLazyLoadOptions {
     prevent?: boolean;

package/dist/libs/shared/src/interfaces/DateRange.d.ts

@@ -3,4 +3,6 @@ export interface DateRange {
     startDate?: Date;
     endDate?: Date;
     default?: boolean;
+    disabled?: boolean;
+    tooltip?: string;
 }