@clickview/player 0.0.26-dev.0 → 0.0.26-rc.0

package/dist/libs/common/src/backbone/interfaces/DataServiceRequests.d.ts

@@ -1,218 +1,218 @@
-import { Events } from 'backbone';
-export interface BaseDataServiceRequest {
-    /**
-     * This will be a url, an event or a cache key
-     * depending on the DataProviderType
-     */
-    resource: string;
-    /**
-     * This is used to generate the events that can be listened to
-     * on the backbone radio channel.
-     *
-     * (e.g. if your eventPrefix was 'library' events would be:
-     * library:request, library:sync, library:success and library:error)
-     */
-    eventPrefix: string;
-    /**
-     * This is the instance that is listening to the events.
-     * We pass this in so we can use the IoC of
-     * listenTo rather than using an on binding.
-     * (https://en.wikipedia.org/wiki/Inversion_of_control)
-     *
-     * This means that there won't be stale event listeners once
-     * the listener is disposed of.
-     */
-    listener?: Events;
-    /**
-     * How long in seconds before the data
-     * is stale and we need to retreive it again
-     */
-    expiryTime?: number;
-    /**
-     * Set of eventPrefix keys that will be evicted from the cache
-     * once the data request has completed.
-     *
-     * Accepts full and partial keys, where partial keys will be used to generate
-     * a regex for matching. Allows for multiple keys to be evicted in bulk.
-     */
-    invalidationKeys?: string[];
-    /**
-     * This is used by a view to gain reference to the model or collection
-     * and store it somewhere. If the data is already cached, the callback will
-     * be called syncronously. Otherwise it will be called when the data becomes
-     * available.
-     */
-    callback?: (data?: any) => any;
-    /**
-     * Callback to be passed from a view to be fired on an error.
-     */
-    errorCallback?: () => void;
-    /**
-     * Success handler is attached as a callback to the successEvent fired on the dataProvider's dataChannel.
-     * Should NOT be used for data manipulation or management by views - use a callback or eventPrefix instead.
-     * Context is not bound at execution time, so ensure that any context is already bound to
-     * the handler when it is passed.
-     */
-    successHandler?: (...args: any[]) => any;
-    /**
-     * Error handler is attached as a callback to the errorEvent fired on the dataProvider's dataChannel.
-     * Context is not bound at execution time, so ensure that any context is already bound to
-     * the handler when it is passed.
-     * A default errorHandler will be bound unless another error handler is passed in.
-     * Alternatively, passing in false will mean that no errorHandler is bound.
-     */
-    errorHandler?: ((...args: any[]) => any) | boolean;
-}
-export interface DataServiceGetRequest<T> extends BaseDataServiceRequest {
-    /**
-     * This should be used to put the data returned from the DataProvider
-     * into an instance of a Model or Collection.
-     *
-     * This should be defined by the children inheriting from BaseDataService
-     * and should not be exposed to views or services consuming BaseDataService.
-     */
-    formatData?: (data: any) => T;
-    /**
-     * Redefine callback with stronger types.
-     */
-    callback?: (data: T) => any;
-    /**
-     * The name of the property on the bootstrap object
-     * that this request will use.
-     */
-    bootstrapName?: string;
-}
-export interface DataServiceClearAndGetRequest<T> extends BaseDataServiceRequest {
-    /**
-     * This should be used to put the data returned from the DataProvider
-     * into an instance of a Model or Collection.
-     *
-     * This should be defined by the children inheriting from BaseDataService
-     * and should not be exposed to views or services consuming BaseDataService.
-     */
-    formatData?: (data: any) => T;
-    /**
-     * Redfine callback as a required option
-     * because this is the only way to retreive the data
-     * in a clearCacheAndGet call
-     */
-    callback: (data: T) => void;
-}
-export interface DataServiceCreateRequest<T> extends BaseDataServiceRequest {
-    /**
-     * This is the data we'll be creating.
-     */
-    data: any;
-    /**
-     * This is how the data should be stored in the cache.
-     */
-    formatData?: (data: any) => T;
-    /**
-     * Redefine callback with stronger types.
-     */
-    callback?: (data: T) => any;
-}
-export interface DataServiceUpdateRequest<T> extends BaseDataServiceRequest {
-    /**
-     * This is the data we'll be sending
-     * to the server.
-     */
-    data: any;
-    /**
-     * This is how the data should be stored in the cache.
-     */
-    formatData?: (data: any) => T;
-    /**
-     * Redefine callback with stronger types.
-     */
-    callback?: (data: T) => any;
-}
-/**
- * The delete request is the simplest one.
- * We have this here just incase we need to add to it
- * in the future.
- */
-export interface DataServiceDeleteRequest extends BaseDataServiceRequest {
-}
-export interface DataServiceRequestOptions {
-    /**
-     * This is used to generate the events that can be listened to
-     * on the backbone radio channel.
-     *
-     * (e.g. if your eventPrefix was library
-     * our events would be  library:request and library:sync)
-     */
-    eventPrefix: string;
-    /**
-     * Different requests will need to manage/change the cache
-     * in different ways.
-     */
-    cacheOptions?: DataServiceCacheOptions;
-    /**
-     * This should be used to put the data returned from the DataProvider
-     * into an instance of a Model or Collection.
-     *
-     * This should be defined by the children inheriting from BaseDataService
-     * and should not be exposed to views or services consuming BaseDataService.
-     */
-    formatData?: (data: any) => any;
-    /**
-     * After certain requests it may be necessary to refresh
-     * some data in the cache that has become stale.
-     * I.e. Deleting or moving a video
-     * Set of eventPrefix keys that will be evicted from the cache
-     * once the data request has completed.
-     *
-     * Accepts full and partial keys, where partial keys will be used to generate
-     * a regex for matching. Allows for multiple keys to be evicted in bulk.
-     */
-    invalidationKeys?: string[];
-    /**
-     * Redefine callback with stronger types. It is called after a successful request
-     */
-    callback?: (data: any) => any;
-    /**
-     * Callback to be passed from a view to be fired on an error.
-     */
-    errorCallback?: () => void;
-    /**
-     * Success handler is attached as a callback to the successEvent fired on the dataProvider's dataChannel.
-     * Should NOT be used for data manipulation or management by views - use a callback or eventPrefix instead.
-     * Context is not bound at execution time, so ensure that any context is already bound to
-     * the handler when it is passed.
-     */
-    successHandler?: (...args: any[]) => any;
-    /**
-     * Error handler is attached as a callback to the errorEvent fired on the dataProvider's dataChannel.
-     * Context is not bound at execution time, so ensure that any context is already bound to
-     * the handler when it is passed.
-     * A default errorHandler will be bound unless another error handler is passed in.
-     * Alternatively, passing in false will mean that no errorHandler is bound.
-     */
-    errorHandler?: ((...args: any[]) => any) | boolean;
-}
-export interface DataServiceCacheOptions {
-    /**
-     * All requests will be cached by default. In circumstances where the return value
-     * is not required (i.e. after a delete call), set the flag to true.
-     */
-    noCache?: boolean;
-    /**
-     * Certain requets (ie. deletes) may require the current cacheKey to be cleared.
-     * Set to true to clear.
-     */
-    clearCacheKey?: boolean;
-    /**
-     * Where muliple views may require access to the same reource/data, set openRequest to
-     * ensure that any subsequent view can bind it's own callbacks to the existing
-     * network call.
-     */
-    openRequest?: boolean;
-    /**
-     * Cached data will utilise a timestamp to determine it's own expiry time within the cache.
-     */
-    timestamp?: number;
-}
-export interface RequestSignatures {
-    [signature: string]: string;
-}
+import { Events } from 'backbone';
+export interface BaseDataServiceRequest {
+    /**
+     * This will be a url, an event or a cache key
+     * depending on the DataProviderType
+     */
+    resource: string;
+    /**
+     * This is used to generate the events that can be listened to
+     * on the backbone radio channel.
+     *
+     * (e.g. if your eventPrefix was 'library' events would be:
+     * library:request, library:sync, library:success and library:error)
+     */
+    eventPrefix: string;
+    /**
+     * This is the instance that is listening to the events.
+     * We pass this in so we can use the IoC of
+     * listenTo rather than using an on binding.
+     * (https://en.wikipedia.org/wiki/Inversion_of_control)
+     *
+     * This means that there won't be stale event listeners once
+     * the listener is disposed of.
+     */
+    listener?: Events;
+    /**
+     * How long in seconds before the data
+     * is stale and we need to retreive it again
+     */
+    expiryTime?: number;
+    /**
+     * Set of eventPrefix keys that will be evicted from the cache
+     * once the data request has completed.
+     *
+     * Accepts full and partial keys, where partial keys will be used to generate
+     * a regex for matching. Allows for multiple keys to be evicted in bulk.
+     */
+    invalidationKeys?: string[];
+    /**
+     * This is used by a view to gain reference to the model or collection
+     * and store it somewhere. If the data is already cached, the callback will
+     * be called syncronously. Otherwise it will be called when the data becomes
+     * available.
+     */
+    callback?: (data?: any) => any;
+    /**
+     * Callback to be passed from a view to be fired on an error.
+     */
+    errorCallback?: () => void;
+    /**
+     * Success handler is attached as a callback to the successEvent fired on the dataProvider's dataChannel.
+     * Should NOT be used for data manipulation or management by views - use a callback or eventPrefix instead.
+     * Context is not bound at execution time, so ensure that any context is already bound to
+     * the handler when it is passed.
+     */
+    successHandler?: (...args: any[]) => any;
+    /**
+     * Error handler is attached as a callback to the errorEvent fired on the dataProvider's dataChannel.
+     * Context is not bound at execution time, so ensure that any context is already bound to
+     * the handler when it is passed.
+     * A default errorHandler will be bound unless another error handler is passed in.
+     * Alternatively, passing in false will mean that no errorHandler is bound.
+     */
+    errorHandler?: ((...args: any[]) => any) | boolean;
+}
+export interface DataServiceGetRequest<T> extends BaseDataServiceRequest {
+    /**
+     * This should be used to put the data returned from the DataProvider
+     * into an instance of a Model or Collection.
+     *
+     * This should be defined by the children inheriting from BaseDataService
+     * and should not be exposed to views or services consuming BaseDataService.
+     */
+    formatData?: (data: any) => T;
+    /**
+     * Redefine callback with stronger types.
+     */
+    callback?: (data: T) => any;
+    /**
+     * The name of the property on the bootstrap object
+     * that this request will use.
+     */
+    bootstrapName?: string;
+}
+export interface DataServiceClearAndGetRequest<T> extends BaseDataServiceRequest {
+    /**
+     * This should be used to put the data returned from the DataProvider
+     * into an instance of a Model or Collection.
+     *
+     * This should be defined by the children inheriting from BaseDataService
+     * and should not be exposed to views or services consuming BaseDataService.
+     */
+    formatData?: (data: any) => T;
+    /**
+     * Redfine callback as a required option
+     * because this is the only way to retreive the data
+     * in a clearCacheAndGet call
+     */
+    callback: (data: T) => void;
+}
+export interface DataServiceCreateRequest<T> extends BaseDataServiceRequest {
+    /**
+     * This is the data we'll be creating.
+     */
+    data: any;
+    /**
+     * This is how the data should be stored in the cache.
+     */
+    formatData?: (data: any) => T;
+    /**
+     * Redefine callback with stronger types.
+     */
+    callback?: (data: T) => any;
+}
+export interface DataServiceUpdateRequest<T> extends BaseDataServiceRequest {
+    /**
+     * This is the data we'll be sending
+     * to the server.
+     */
+    data: any;
+    /**
+     * This is how the data should be stored in the cache.
+     */
+    formatData?: (data: any) => T;
+    /**
+     * Redefine callback with stronger types.
+     */
+    callback?: (data: T) => any;
+}
+/**
+ * The delete request is the simplest one.
+ * We have this here just incase we need to add to it
+ * in the future.
+ */
+export interface DataServiceDeleteRequest extends BaseDataServiceRequest {
+}
+export interface DataServiceRequestOptions {
+    /**
+     * This is used to generate the events that can be listened to
+     * on the backbone radio channel.
+     *
+     * (e.g. if your eventPrefix was library
+     * our events would be  library:request and library:sync)
+     */
+    eventPrefix: string;
+    /**
+     * Different requests will need to manage/change the cache
+     * in different ways.
+     */
+    cacheOptions?: DataServiceCacheOptions;
+    /**
+     * This should be used to put the data returned from the DataProvider
+     * into an instance of a Model or Collection.
+     *
+     * This should be defined by the children inheriting from BaseDataService
+     * and should not be exposed to views or services consuming BaseDataService.
+     */
+    formatData?: (data: any) => any;
+    /**
+     * After certain requests it may be necessary to refresh
+     * some data in the cache that has become stale.
+     * I.e. Deleting or moving a video
+     * Set of eventPrefix keys that will be evicted from the cache
+     * once the data request has completed.
+     *
+     * Accepts full and partial keys, where partial keys will be used to generate
+     * a regex for matching. Allows for multiple keys to be evicted in bulk.
+     */
+    invalidationKeys?: string[];
+    /**
+     * Redefine callback with stronger types. It is called after a successful request
+     */
+    callback?: (data: any) => any;
+    /**
+     * Callback to be passed from a view to be fired on an error.
+     */
+    errorCallback?: () => void;
+    /**
+     * Success handler is attached as a callback to the successEvent fired on the dataProvider's dataChannel.
+     * Should NOT be used for data manipulation or management by views - use a callback or eventPrefix instead.
+     * Context is not bound at execution time, so ensure that any context is already bound to
+     * the handler when it is passed.
+     */
+    successHandler?: (...args: any[]) => any;
+    /**
+     * Error handler is attached as a callback to the errorEvent fired on the dataProvider's dataChannel.
+     * Context is not bound at execution time, so ensure that any context is already bound to
+     * the handler when it is passed.
+     * A default errorHandler will be bound unless another error handler is passed in.
+     * Alternatively, passing in false will mean that no errorHandler is bound.
+     */
+    errorHandler?: ((...args: any[]) => any) | boolean;
+}
+export interface DataServiceCacheOptions {
+    /**
+     * All requests will be cached by default. In circumstances where the return value
+     * is not required (i.e. after a delete call), set the flag to true.
+     */
+    noCache?: boolean;
+    /**
+     * Certain requets (ie. deletes) may require the current cacheKey to be cleared.
+     * Set to true to clear.
+     */
+    clearCacheKey?: boolean;
+    /**
+     * Where muliple views may require access to the same reource/data, set openRequest to
+     * ensure that any subsequent view can bind it's own callbacks to the existing
+     * network call.
+     */
+    openRequest?: boolean;
+    /**
+     * Cached data will utilise a timestamp to determine it's own expiry time within the cache.
+     */
+    timestamp?: number;
+}
+export interface RequestSignatures {
+    [signature: string]: string;
+}

package/dist/libs/common/src/backbone/interfaces/Pagination.d.ts

@@ -1,33 +1,33 @@
-export interface Pagination {
-    cursors: Cursors;
-    limit: number;
-}
-export interface Cursors {
-    next: string;
-    previous: string;
-}
-/**
- * Do not extend or implement this interface.
- * It is only exported for use within the BaseDataService.
- *
- * By default, the BaseDataService will convert legacy pagination
- * objects to cursor-based pagination objects.
- */
-export interface LegacyPagination {
-    page: number;
-    pageSize: number;
-    totalItems: number;
-    totalPages: number;
-}
-/**
- * Do not extend or implement this interface.
- * It is only exported for use within the BaseDataService.
- *
- * By default, the BaseDataService will convert legacy pagination
- * objects to cursor-based pagination objects.
- */
-export interface OffsetPagination {
-    offset: number;
-    pageSize: number;
-    totalItems: number;
-}
+export interface Pagination {
+    cursors: Cursors;
+    limit: number;
+}
+export interface Cursors {
+    next: string;
+    previous: string;
+}
+/**
+ * Do not extend or implement this interface.
+ * It is only exported for use within the BaseDataService.
+ *
+ * By default, the BaseDataService will convert legacy pagination
+ * objects to cursor-based pagination objects.
+ */
+export interface LegacyPagination {
+    page: number;
+    pageSize: number;
+    totalItems: number;
+    totalPages: number;
+}
+/**
+ * Do not extend or implement this interface.
+ * It is only exported for use within the BaseDataService.
+ *
+ * By default, the BaseDataService will convert legacy pagination
+ * objects to cursor-based pagination objects.
+ */
+export interface OffsetPagination {
+    offset: number;
+    pageSize: number;
+    totalItems: number;
+}

package/dist/libs/common/src/backbone/interfaces/StickitBinding.d.ts

@@ -1,33 +1,33 @@
-import { BaseModel } from '../core/BaseModel';
-export interface StickitBinding {
-    observe: string;
-    onGet?: string | ((value: string, options: any) => string);
-    onSet?: string | ((value: string, options: any) => string);
-    getVal?: string | (($el: JQuery, event: Event, options: any) => string);
-    update?: string | (($el: JQuery, value: string, model: BaseModel, options: any) => void);
-    updateModel?: string | boolean | ((value: string, event: Event, options: any) => boolean);
-    updateView?: string | boolean | (() => boolean);
-    afterUpdate?: string | (($el: JQuery, value: string, options: any) => void);
-    updateMethod?: string;
-    escape?: boolean;
-    initialize?: string | (($el: JQuery, model: BaseModel, options: any) => void);
-    destroy?: string | (($el: JQuery, model: BaseModel, options: any) => void);
-    visible?: boolean | ((value: string, options: any) => boolean);
-    visibleFn?: string;
-    events?: string[];
-    name?: string;
-    selectOptions?: {
-        collection: string;
-        labelPath: string;
-        valuePath: string;
-        defaultOption?: string;
-    };
-    setOptions?: {
-        silent?: boolean;
-        validate?: boolean;
-    };
-    classes?: {
-        [className: string]: StickitBinding;
-    };
-    attributes?: StickitBinding[];
-}
+import { BaseModel } from '../core/BaseModel';
+export interface StickitBinding {
+    observe: string;
+    onGet?: string | ((value: string, options: any) => string);
+    onSet?: string | ((value: string, options: any) => string);
+    getVal?: string | (($el: JQuery, event: Event, options: any) => string);
+    update?: string | (($el: JQuery, value: string, model: BaseModel, options: any) => void);
+    updateModel?: string | boolean | ((value: string, event: Event, options: any) => boolean);
+    updateView?: string | boolean | (() => boolean);
+    afterUpdate?: string | (($el: JQuery, value: string, options: any) => void);
+    updateMethod?: string;
+    escape?: boolean;
+    initialize?: string | (($el: JQuery, model: BaseModel, options: any) => void);
+    destroy?: string | (($el: JQuery, model: BaseModel, options: any) => void);
+    visible?: boolean | ((value: string, options: any) => boolean);
+    visibleFn?: string;
+    events?: string[];
+    name?: string;
+    selectOptions?: {
+        collection: string;
+        labelPath: string;
+        valuePath: string;
+        defaultOption?: string;
+    };
+    setOptions?: {
+        silent?: boolean;
+        validate?: boolean;
+    };
+    classes?: {
+        [className: string]: StickitBinding;
+    };
+    attributes?: StickitBinding[];
+}

package/dist/libs/common/src/backbone/interfaces/Xhr.d.ts

@@ -1,9 +1,9 @@
-export interface Xhr<TResponseJSON = any> extends Pick<XMLHttpRequest, 'getResponseHeader' | 'status'> {
-    responseJSON?: TResponseJSON;
-}
-/**
- * We're making getResponseHeader optional for a slightly nicer API
- */
-export interface SimulatedXhr extends Omit<Xhr, 'getResponseHeader'> {
-    getResponseHeader?: (name: string) => string;
-}
+export interface Xhr<TResponseJSON = any> extends Pick<XMLHttpRequest, 'getResponseHeader' | 'status'> {
+    responseJSON?: TResponseJSON;
+}
+/**
+ * We're making getResponseHeader optional for a slightly nicer API
+ */
+export interface SimulatedXhr extends Omit<Xhr, 'getResponseHeader'> {
+    getResponseHeader?: (name: string) => string;
+}

package/dist/libs/common/src/backbone/interfaces/index.d.ts

@@ -1,9 +1,9 @@
-export * from './BaseCollectionIdentifier';
-export * from './ChainableDataService';
-export * from './DataCache';
-export * from './DataProvider';
-export * from './DataServiceError';
-export * from './DataServiceRequests';
-export * from './Pagination';
-export * from './StickitBinding';
-export * from './Xhr';
+export * from './BaseCollectionIdentifier';
+export * from './ChainableDataService';
+export * from './DataCache';
+export * from './DataProvider';
+export * from './DataServiceError';
+export * from './DataServiceRequests';
+export * from './Pagination';
+export * from './StickitBinding';
+export * from './Xhr';

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

@@ -1,13 +1,13 @@
-import { ObjectHash } from 'backbone';
-declare class StaticEnvironmentVariables {
-    private static instance;
-    private variables;
-    constructor();
-    static get Instance(): StaticEnvironmentVariables;
-    get name(): string;
-    get isDevelopment(): boolean;
-    get(name: string): any;
-    setUpVariables(variables: ObjectHash): void;
-}
-export declare const EnvironmentVariables: StaticEnvironmentVariables;
-export {};
+import { ObjectHash } from 'backbone';
+declare class StaticEnvironmentVariables {
+    private static instance;
+    private variables;
+    constructor();
+    static get Instance(): StaticEnvironmentVariables;
+    get name(): string;
+    get isDevelopment(): boolean;
+    get(name: string): any;
+    setUpVariables(variables: ObjectHash): void;
+}
+export declare const EnvironmentVariables: StaticEnvironmentVariables;
+export {};