@clickview/library-editor 0.0.0-rc.0 → 0.0.1-rc.1

package/dist/src/shared/utils/search/TypeaheadHelper.d.ts

@@ -0,0 +1,76 @@
+/// <reference types="typeahead" />
+/// <reference types="jquery" />
+import { ObjectHash } from 'backbone';
+import * as Bloodhound from 'bloodhound';
+import { TypeaheadDataSource, LocalSearch, RemoteSearch, TypeaheadConfig } from "./";
+import { TypeaheadSourceItem } from "./SearchTypes";
+export declare const TypeaheadHelper: {
+    /**
+    * This function will only allow our typeahead to fetch results when we
+    * have exceeded our min length. The reason for doing this is that we want to the typeahead
+    * to load our recent searches immediately when we click the input, but before we perform any searches. - Mike
+    */
+    handleQuery<T>(dataSource?: TypeaheadDataSource<T>, options?: ObjectHash): TypeaheadDataSource<T>;
+    /**
+     * This function complements HandleQuery allowing us to override when and how typeahead templates are
+     * rendered. When the query doesn't meet our min length we will render a fallback template, which is
+     * essentially just an empty div. This is necessary to ensure we can display recent searchs when the
+     * typeahead is active (but less than the require length to trigger the search functionality). As we are
+     * dynamically generating the results for videos, folders and series we are deliberately using a closure
+     * to ensure we don't lose our template.
+     *
+     * It must also return <any> as the typeahead typings are shit.
+     * - Mike
+     */
+    getTemplate(template: Function, options?: ObjectHash): any;
+    /**
+     * Provides mechanism to map a single search query against multiple bloodhound sources.
+     * Sources may be remote endpoints or local in-memory collections.
+     * @param sources
+     * @param options
+     */
+    getSearchSources<T_1>(sources: TypeaheadSourceItem<T_1>[]): TypeaheadConfig<T_1>[];
+    /**
+     * Bloodhound helper
+     */
+    buildBloodhound<T_2>(options: RemoteSearch<T_2> | LocalSearch<T_2>): Bloodhound<T_2>;
+    /**
+     * This is attached as a callback to the typeahead's render event.
+     * Where there is a real suggestion from the server, we will automatically
+     * set the cursor to that item, to make it simply to add. This is to encourage the
+     * re-use of existing entities.
+     *
+     * Note: With multiple suggestion sets, the render event will also be called multiple times
+     * along with this callback.
+     */
+    selectFirstResult(e: JQueryEventObject, suggestions: any[], async: boolean, dataset: string): void;
+    /**
+    * Callback is designed to be attached to the stickit bindings for the typeahead form
+    * and emit events when a change is detected on the bound model. We do this to be
+    * able to detect whether an input has cleared from a previous selection,
+    *
+    * @param channelName
+    * @param event
+    */
+    emitEventOnInput(channelName: string, eventName: string, type: string, wrapperOptions?: ObjectHash): Function;
+    /**
+    * I hate this.
+    *
+    * Basically what this function does is curry a callback with the original association's
+    * data. Then, depending on the user's interaction with the typeahead input, it will restore that
+    * data when a blur event is triggered.
+    *
+    * @param data raw clone of original assoc model
+    *
+    * Curried callback
+    * @param channelName
+    * @param propertyName
+    */
+    resetAssociationOnBlur(data: ObjectHash): Function;
+    /**
+     * Create and render ConfirmSelection component for use as a
+     * @param options
+     */
+    getConfirmSelectionTemplate(options?: ObjectHash): Function;
+    clearInputOnBlur(channelName: string): void;
+};

package/dist/src/shared/utils/search/index.d.ts

@@ -0,0 +1,5 @@
+export * from './InstantSearchHelper';
+export * from './RecentSearchHelper';
+export * from './TypeaheadHelper';
+export * from './SearchTypes';
+export * from './RawSearchHelper';

package/dist/src/shared/utils/search/raw-search-components/add-new/AddNewSuggestion.d.ts

@@ -0,0 +1,12 @@
+import { ObjectHash } from 'backbone';
+/**
+ * Stateless component function
+ *
+ * Allows us to pass some simple data to a template along with
+ * optionally imported styling and/or svgs.
+ *
+ * The data and options are merged prior to being passed to the template.
+ *
+ * @param data
+ */
+export declare function AddNewSuggestion(data: ObjectHash): Function;

package/dist/src/shared/utils/search/raw-search-components/confirm-selection/ConfirmSelectionComponent.d.ts

@@ -0,0 +1,12 @@
+import { ObjectHash } from 'backbone';
+import { Core } from '@clickview/common';
+interface ConfirmSelectionComponentOptions extends Core.ComponentOptions {
+}
+export declare class ConfirmSelectionComponent extends Core.Component {
+    constructor(options: ConfirmSelectionComponentOptions);
+    get name(): string;
+    get template(): string;
+    get className(): string;
+    viewOptions(): ObjectHash;
+}
+export {};

package/dist/src/shared/utils/search/raw-search-components/index.d.ts

@@ -0,0 +1,2 @@
+export * from './confirm-selection/ConfirmSelectionComponent';
+export * from './add-new/AddNewSuggestion';

package/dist/src/shared/utils/search/raw-search-templates/index.d.ts

@@ -0,0 +1,5 @@
+import ResultSuggestion from './ResultSuggestion.hbs';
+import Loading from './Loading.hbs';
+import NotFound from './NotFound.hbs';
+import Empty from './Empty.hbs';
+export { ResultSuggestion, Loading, NotFound, Empty, };

package/dist/src/shared/views/download-to-local-cache/DownloadToLocalCacheView.d.ts

@@ -0,0 +1,28 @@
+import { ObjectHash } from 'backbone';
+import { Core } from '@clickview/common';
+import { LocalCacheDevice } from "../../models";
+interface DownloadToLocalCacheViewOptions extends Core.ViewOptions<LocalCacheDevice> {
+    videoId: string;
+}
+export declare class DownloadToLocalCacheView extends Core.View<LocalCacheDevice> {
+    options: DownloadToLocalCacheViewOptions;
+    private localCacheDataService;
+    private currentUser;
+    private localCacheDownloads;
+    private spinnerModel;
+    constructor(options: DownloadToLocalCacheViewOptions);
+    initialize(): void;
+    get name(): string;
+    get title(): string;
+    get lang(): string;
+    get template(): string;
+    get channelName(): string;
+    get behaviors(): any[];
+    private bindListeners;
+    private getSpinnerButtonOptions;
+    private onClickAddToLocalCache;
+    get requiredResources(): Core.RequiredResourceHash;
+    onBeforeRender(): boolean;
+    viewOptions(): ObjectHash;
+}
+export {};

package/dist/src/shared/views/download-video/DownloadVideoView.d.ts

@@ -0,0 +1,19 @@
+import { Core } from '@clickview/common';
+interface DownloadVideoViewOptions extends Core.ViewOptions {
+    videoId: string;
+}
+export declare class DownloadVideoView extends Core.View {
+    options: DownloadVideoViewOptions;
+    private downloadProxyDataService;
+    private config;
+    constructor(options: DownloadVideoViewOptions);
+    initialize(): void;
+    get name(): string;
+    get title(): boolean;
+    get tagName(): string;
+    get template(): string;
+    private cancelScrollTop;
+    get requiredResources(): Core.RequiredResourceHash;
+    onBeforeRender(): void;
+}
+export {};

package/dist/src/shared/views/index.d.ts

@@ -0,0 +1,9 @@
+export * from './download-video/DownloadVideoView';
+export * from './restrict-access/RestrictAccessView';
+export * from './share/ShareView';
+export * from './user-options/UserOptionsView';
+export * from './top-navigation/TopNavigationView';
+export * from './download-to-local-cache/DownloadToLocalCacheView';
+export * from './restrict-access/RestrictAccessComponent';
+export * from './restrict-access/RestrictAccessGroupComponent';
+export * from './restrict-access/RestrictAccessView';

package/dist/src/shared/views/restrict-access/RestrictAccessComponent.d.ts

@@ -0,0 +1,7 @@
+import { Core } from '@clickview/common';
+export declare class RestrictAccessComponent extends Core.Component {
+    get name(): string;
+    get template(): any;
+    get lang(): string;
+    private getTemplateText;
+}

package/dist/src/shared/views/restrict-access/RestrictAccessGroupComponent.d.ts

@@ -0,0 +1,23 @@
+import { ObjectHash } from 'backbone';
+import { Core } from '@clickview/common';
+export declare class RestrictAccessGroupComponent extends Core.Component {
+    private configDataService;
+    private currentUser;
+    private yearGroups;
+    initialize(): void;
+    get name(): string;
+    get lang(): string;
+    get props(): string[];
+    get template(): any;
+    /**
+     * Setup a binding for when the value of the year group changes
+     */
+    get bindings(): ObjectHash;
+    regions(): ObjectHash;
+    viewOptions(): ObjectHash;
+    onBeforeRender(): void;
+    onRender(): void;
+    onBeforeDestroy(): void;
+    private getYearGroups;
+    private buildGroupMessage;
+}

package/dist/src/shared/views/restrict-access/RestrictAccessView.d.ts

@@ -0,0 +1,67 @@
+import { ObjectHash } from 'backbone';
+import { Core } from '@clickview/common';
+import { Video } from "../../models";
+interface RestrictAccessViewOptions extends Core.ViewOptions {
+    videoId: string;
+}
+export declare class RestrictAccessView extends Core.View {
+    protected options: RestrictAccessViewOptions;
+    model: Video;
+    private config;
+    private selected;
+    private restriction;
+    private currentUser;
+    private videoDataService;
+    private restrictedVideoDataService;
+    private videoMixinService;
+    private restrictedObjectCollection;
+    private spinnerModel;
+    constructor(options: RestrictAccessViewOptions);
+    initialize(): void;
+    private bindListeners;
+    get name(): string;
+    get title(): string;
+    get lang(): string;
+    get tagName(): string;
+    get className(): string;
+    get channelName(): string;
+    get template(): any;
+    get behaviors(): any[];
+    get elements(): ObjectHash;
+    events(): ObjectHash;
+    regions(): ObjectHash;
+    private getAllowFullAccessBtnClassName;
+    private getSubmitBtnTooltipOptions;
+    /**
+     * Called when a dropdown access option is selected
+     */
+    private onOptionSelected;
+    /**
+     * Make sure a year group is selected in the year group button group
+     */
+    private onGroupChanged;
+    /**
+     * Returns corresponding view to render based on selected option
+     * and sets group if Students or All selected
+     */
+    private getAccessView;
+    /**
+     * Returns the dropdown item corresponding to the given restriction groupId
+     */
+    private getSelection;
+    /**
+     * Re-sets the server side restriction on the model, essentially refreshing the model with its
+     * actual restrictions. Also sets the dropdown selection to the dropdown corresponding to the restriction
+     */
+    private refreshRestriction;
+    private onSubmit;
+    private onAllowFullAccess;
+    private logAction;
+    private dataFetched;
+    private renderDropdown;
+    get requiredResources(): Core.RequiredResourceHash;
+    onBeforeRender(): void;
+    viewOptions(): ObjectHash;
+    onRender(): void;
+}
+export {};

package/dist/src/shared/views/share/ShareView.d.ts

@@ -0,0 +1,48 @@
+import { ObjectHash } from 'backbone';
+import { Core } from '@clickview/common';
+import { SharedResource } from "../../models";
+interface VideoSizes {
+    width: string;
+    height: string;
+    name: string;
+}
+export interface ShareViewOptions extends Core.ViewOptions {
+    videoSizes?: Array<VideoSizes>;
+    videoId: string;
+}
+export declare class ShareView extends Core.View<SharedResource> {
+    private videoId;
+    private videoDataService;
+    private config;
+    private clipboards;
+    protected options: ShareViewOptions;
+    constructor(options?: ShareViewOptions);
+    initialize(): void;
+    get name(): string;
+    get title(): boolean;
+    get template(): any;
+    get lang(): string;
+    get props(): string[];
+    get elements(): ObjectHash;
+    events(): ObjectHash;
+    regions(): ObjectHash;
+    get defaults(): ObjectHash;
+    get behaviors(): any[];
+    private bindListeners;
+    get bindings(): ObjectHash;
+    private setUpViewModel;
+    private fetchData;
+    private buildEmbedString;
+    private onClickEmbed;
+    private onClickCopy;
+    private getPrivacyDescription;
+    private initClipboards;
+    private destroyClipboards;
+    get requiredResources(): Core.RequiredResourceHash;
+    onBeforeDestroy(): void;
+    private renderFooter;
+    viewOptions(): ObjectHash;
+    onBeforeRender(): void;
+    onRender(): void;
+}
+export {};

package/dist/src/shared/views/top-navigation/TopNavigationView.d.ts

@@ -0,0 +1,35 @@
+import { ObjectHash } from 'backbone';
+import { Core } from '@clickview/common';
+interface TopNavigationViewOptions extends Core.ViewOptions {
+    selected?: Core.AppLink;
+}
+export declare class TopNavigationView extends Core.View {
+    options: TopNavigationViewOptions;
+    private contentUpdatesDataService;
+    private settingsDataService;
+    private migrationVideoDataService;
+    private staffRequestDataService;
+    private currentUser;
+    private settings;
+    private migrationMetadata;
+    private contentUpdatesCollection;
+    private staffRequestCollection;
+    private errorCount;
+    constructor(options: TopNavigationViewOptions);
+    initialize(): void;
+    get name(): string;
+    get title(): boolean;
+    get className(): string;
+    get template(): string;
+    get lang(): string;
+    regions(): ObjectHash;
+    private initializeDataServices;
+    private bindListeners;
+    private initNavCollection;
+    private getPublisherArchiveIcon;
+    private filterNavItems;
+    get requiredResources(): Core.RequiredResourceHash;
+    onBeforeRender(): boolean;
+    onRender(): void;
+}
+export {};

package/dist/src/shared/views/user-options/UserOptionsView.d.ts

@@ -0,0 +1,18 @@
+import { ObjectHash } from 'backbone';
+import { Core } from '@clickview/common';
+import { User } from "../../models";
+export declare class UserOptionsView extends Core.View {
+    currentUser: User;
+    private config;
+    get name(): string;
+    get title(): boolean;
+    get template(): string;
+    get lang(): string;
+    get className(): string;
+    get channelName(): string;
+    regions(): ObjectHash;
+    private renderOptions;
+    viewOptions(): ObjectHash;
+    get requiredResources(): Core.RequiredResourceHash;
+    onRender(): void;
+}

package/dist/src/styles/index.d.ts

@@ -0,0 +1 @@
+import './theme-overrides.scss';

package/dist/typings/libs/LazyLoad.d.ts

@@ -0,0 +1,26 @@
+interface ILazyLoadOptions {
+    threshold?: number;
+    container?: HTMLElement;
+    elements_selector?: any;
+    throttle?: number;
+    data_src?: string;
+    data_srcset?: string;
+    class_loading?: string;
+    class_loaded?: string;
+    class_error?: string;
+    skip_invisible?: boolean;
+    show_while_loading?: boolean;
+    callback_set?: (elt: HTMLImageElement) => void;
+    callback_load?: (elt: HTMLImageElement) => void;
+    callback_error?: (elt: HTMLImageElement) => void;
+    callback_processed?: (elts: HTMLImageElement[]) => void;
+    placeholder?: string;
+}
+interface ILazyLoad {
+    new (options?: ILazyLoadOptions): any;
+    update(): void;
+    destroy(): void;
+    handleScroll(): void;
+    loadAll(): void;
+}
+declare var LazyLoad: ILazyLoad;

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@clickview/library-editor",
   "description": "Library Editor",
-  "version": "0.0.0-rc.0",
+  "version": "0.0.1-rc.1",
   "main": "dist/bundle.js",
+  "types": "dist/src/index.d.ts",
   "scripts": {
     "clean-deps": "rd /s /q \"node_modules\"",
     "dev": "run-s vendor-dev watch",
@@ -29,54 +30,54 @@
   "author": "Shale Kuzmanovski, Michael McDonnell",
   "license": "ISC",
   "devDependencies": {
-    "@clickview/tooling": "0.0.9",
-    "@fortawesome/fontawesome": "^1.1.8",
-    "@types/clipboard": "^2.0.1",
-    "@types/cropperjs": "^1.1.5",
-    "@types/dropzone": "^5.0.6",
-    "@types/jqueryui": "^1.12.7",
-    "@types/linkifyjs": "^2.1.2",
-    "@types/node-polyglot": "^0.4.33",
-    "@types/typeahead": "^0.11.32",
-    "@types/webpack-env": "^1.13.9",
-    "babel-minify-webpack-plugin": "^0.3.1",
-    "mkdirp": "^0.5.1",
-    "node-sass": "^4.12.0",
-    "npm-run-all": "^4.1.5",
-    "postcss-cli": "^6.1.3",
-    "postcss-sass": "^0.4.1",
-    "prettier": "^1.18.2",
-    "regenerator-runtime": "^0.13.3",
-    "rev-hash": "^3.0.0",
-    "stylelint-config-recommended": "^2.2.0",
-    "stylelint-scss": "^3.9.0",
-    "typedoc": "^0.14.2",
-    "webpack-bundle-analyzer": "^3.3.2",
-    "webpack-dev-middleware": "^3.7.0",
-    "webpack-env": "^0.8.0",
-    "webpack-hot-middleware": "^2.25.0",
-    "webpack-stats-plugin": "^0.2.1",
-    "write-json-file": "^4.1.1"
+    "@clickview/tooling": "0.0.10-rc.0",
+    "@fortawesome/fontawesome": "1.1.8",
+    "@types/clipboard": "2.0.1",
+    "@types/cropperjs": "1.1.5",
+    "@types/dropzone": "5.0.6",
+    "@types/jqueryui": "1.12.7",
+    "@types/linkifyjs": "2.1.2",
+    "@types/node-polyglot": "0.4.33",
+    "@types/typeahead": "0.11.32",
+    "@types/webpack-env": "1.13.9",
+    "babel-minify-webpack-plugin": "0.3.1",
+    "mkdirp": "0.5.1",
+    "node-sass": "4.12.0",
+    "npm-run-all": "4.1.5",
+    "postcss-cli": "6.1.3",
+    "postcss-sass": "0.4.1",
+    "prettier": "1.18.2",
+    "regenerator-runtime": "0.13.3",
+    "rev-hash": "3.0.0",
+    "stylelint-config-recommended": "2.2.0",
+    "stylelint-scss": "3.9.0",
+    "typedoc": "0.14.2",
+    "webpack-bundle-analyzer": "3.3.2",
+    "webpack-dev-middleware": "3.7.0",
+    "webpack-env": "0.8.0",
+    "webpack-hot-middleware": "2.25.0",
+    "webpack-stats-plugin": "0.2.1",
+    "write-json-file": "4.1.1"
   },
   "dependencies": {
-    "@babel/polyfill": "^7.4.4",
-    "@clickview/analytics": "0.0.4",
-    "@clickview/common": "0.1.9",
-    "@clickview/shared": "0.0.2",
-    "@clickview/styles": "0.0.2",
-    "autotrack": "^2.4.1",
-    "backbone-validation": "^0.11.5",
-    "bootstrap": "^4.3.1",
-    "clipboard": "^2.0.4",
-    "corejs-typeahead": "^1.2.1",
-    "cropperjs": "^1.5.3",
-    "dropzone": "^5.5.1",
-    "jquery-ui": "^1.12.1",
-    "linkifyjs": "^2.1.8",
-    "moment": "^2.24.0",
-    "node-polyglot": "^2.3.0",
-    "signalr": "^2.4.0",
-    "tempusdominus-bootstrap-4": "^5.1.2"
+    "@babel/polyfill": "7.4.4",
+    "@clickview/analytics": "1.0.0-rc.0",
+    "@clickview/common": "1.0.0-rc.0",
+    "@clickview/shared": "1.0.0-rc.0",
+    "@clickview/styles": "1.0.0-rc.0",
+    "autotrack": "2.4.1",
+    "backbone-validation": "0.11.5",
+    "bootstrap": "4.3.1",
+    "clipboard": "2.0.4",
+    "corejs-typeahead": "1.2.1",
+    "cropperjs": "1.5.3",
+    "dropzone": "5.5.1",
+    "jquery-ui": "1.12.1",
+    "linkifyjs": "2.1.8",
+    "moment": "2.24.0",
+    "node-polyglot": "2.3.0",
+    "signalr": "2.4.0",
+    "tempusdominus-bootstrap-4": "5.1.2"
   },
   "browserslist": [
     "Firefox >= 22",