@clickview/lite 0.0.10-rc.0 → 0.0.11-dev.0

package/dist/apps/default/LiteDefaultApplication.d.ts

@@ -20,6 +20,7 @@ export declare class DefaultApplication extends ReactApplication {
     editUpload(uploadId: string): void;
     series(id: string, params: HashObject): void;
     favoriteVideos(params: HashObject): void;
+    mock(): void;
     catchAllRoutes(): void;
     notFound(): void;
     error(): void;

package/dist/apps/default/views/mock-testing/MockRequests.d.ts

@@ -0,0 +1,12 @@
+import { Flight, Xhr } from '@clickview/common';
+export interface Todo {
+    id: string;
+    text: string;
+    done: boolean;
+}
+export declare const MockRequests: {
+    getTodos(): Flight.SimulatedRequest;
+    addTodo(text: string, success: () => void, error: (xhr: Xhr) => void): Flight.SimulatedRequest;
+    updateTodo(todo: Todo): Flight.SimulatedRequest;
+    deleteTodo(id: string): Flight.SimulatedRequest;
+};

package/dist/apps/default/views/mock-testing/MockView.d.ts

@@ -0,0 +1,2 @@
+import * as React from 'react';
+export declare function MockView(): React.ReactElement;

package/dist/apps/search/components/filter-actions/FilterActions.d.ts

@@ -1,11 +1,13 @@
 /// <reference types="react" />
 import { FilterPayloadType } from 'apps/search/reducers';
 interface FilterActionsProps extends FilterPayloadType {
+    className?: string;
 }
 export declare function FilterActions(props: FilterActionsProps): JSX.Element;
 export declare namespace FilterActions {
     var defaultProps: {
         active: boolean;
+        className: string;
     };
 }
 export {};

package/dist/apps/search/components/filter-types/checkbox-filter/CheckboxFilter.d.ts

@@ -1,5 +1,7 @@
 /// <reference types="react" />
+import { SearchFilter } from 'apps/search/interfaces';
 interface CheckboxFilterProps {
+    filter: SearchFilter;
 }
 export declare function CheckboxFilter(props: CheckboxFilterProps): JSX.Element;
 export {};

package/dist/apps/search/components/filter-types/dropdown-filter/DropdownFilter.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+import { SearchFilter } from 'apps/search/interfaces';
+interface DropdownFilterProps {
+    filter: SearchFilter;
+}
+export declare function DropdownFilter(props: DropdownFilterProps): JSX.Element;
+export {};

package/dist/apps/search/components/filter-types/index.d.ts

@@ -1,4 +1,6 @@
 export * from './checkbox-filter/CheckboxFilter';
 export * from './more-filters/MoreFilters';
-export * from './radio-filter/RadioFilter';
 export * from './switch-filter/SwitchFilter';
+export * from './dropdown-filter/DropdownFilter';
+export * from './radio-filter/RadioFilter';
+export * from './radio-filter/year-level/YearLevelRadioFilter';

package/dist/apps/search/components/filter-types/radio-filter/year-level/YearLevelRadioFilter.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+import { SearchFilter } from 'apps/search/interfaces';
+interface YearLevelRadioFilterProps {
+    filter: SearchFilter;
+}
+export declare function YearLevelRadioFilter(props: YearLevelRadioFilterProps): JSX.Element;
+export {};

package/dist/apps/search/components/scoped-search-bar/ScopedSearchBar.d.ts

@@ -0,0 +1,18 @@
+/// <reference types="react" />
+interface ScopedSearchBarProps {
+    id: string;
+    onSubmit?: (query: string) => void;
+    name?: string;
+    placeholder?: string;
+    className?: string;
+    queryParamName?: string;
+    debounceTime?: number;
+}
+export declare function ScopedSearchBar(props: ScopedSearchBarProps): JSX.Element;
+export declare namespace ScopedSearchBar {
+    var defaultProps: {
+        debounceTime: number;
+        queryParamName: string;
+    };
+}
+export {};

package/dist/apps/search/components/scoped-search-bar/partial-loading/PartialScopedSearchBar.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="react" />
+export declare function PartialScopedSearchBar(): JSX.Element;

package/dist/apps/search/components/search-filters/PartialSearchFilters.d.ts

@@ -1,2 +1,7 @@
 /// <reference types="react" />
-export declare function PartialSearchFilters(): JSX.Element;
+interface PartialSearchFiltersProps {
+    count?: number;
+    hideHeading?: boolean;
+}
+export declare function PartialSearchFilters({ count, hideHeading }: PartialSearchFiltersProps): JSX.Element;
+export {};

package/dist/apps/search/components/search-filters/SearchFilters.d.ts

@@ -1,7 +1,11 @@
 /// <reference types="react" />
 import { HashObject } from '@clickview/common';
+import { SearchFilter, MoreFilters } from 'apps/search/interfaces';
 interface SearchFiltersProps {
     queryParams: HashObject;
+    mainFilters: SearchFilter[];
+    moreFilters?: MoreFilters;
+    hideHeading?: boolean;
 }
-export declare function SearchFilters({ queryParams }: SearchFiltersProps): JSX.Element;
+export declare function SearchFilters(props: SearchFiltersProps): JSX.Element;
 export {};

package/dist/apps/search/flight-requests/SearchRequests.d.ts

@@ -1,4 +1,4 @@
 import { Flight } from '@clickview/common';
 export declare const SearchRequests: {
-    search(query: string): Flight.Request;
+    search(query: string): Flight.SimulatedRequest;
 };

package/dist/apps/search/interfaces/SearchFilter.d.ts

@@ -1,17 +1,19 @@
-export declare type FilterNames = 'yearLevels' | 'type' | 'ratings' | 'interactives' | 'clips' | 'moreFilters';
-export declare type FilterType = 'radio' | 'checkbox' | 'switch' | 'more-filters' | 'rating';
+/// <reference types="react" />
+export declare type FilterIds = 'sortName' | 'yearLevel' | 'objectType' | 'ratings' | 'interactives' | 'clips' | 'classroom' | 'moreFilters';
+export declare type FilterType = 'radio' | 'checkbox' | 'switch' | 'more-filters' | 'rating' | 'dropdown';
 export interface SearchFilter {
-    name: FilterNames;
-    label: string;
+    id: FilterIds;
+    name: string;
     type: FilterType;
     description?: string;
     options?: FilterOption[];
+    customComponent?: (props?: any) => JSX.Element;
 }
 export interface MoreFilters extends SearchFilter {
     filters: SearchFilter[];
 }
 export interface FilterOption {
+    id: string;
     name: string;
-    label: string;
     default?: boolean;
 }

package/dist/apps/search/reducers/FilterReducer.d.ts

@@ -1,28 +1,32 @@
 /// <reference types="react" />
 import { ReducerActions } from '@clickview/common';
-import { SearchFilter, FilterNames, FilterOption } from 'apps/search/interfaces';
+import { SearchFilter, FilterIds, FilterOption } from 'apps/search/interfaces';
 export declare type FilterState = {
-    [key in FilterNames]: {
-        active: boolean;
-        selection?: FilterOption;
-    };
+    active: boolean;
+    selection?: FilterOption[];
+};
+declare type FilterStateHashFilters = {
+    [key in FilterIds]: FilterState;
+};
+export declare type FilterStateHash = FilterStateHashFilters & {
+    bulkReset?: boolean;
 };
-export declare type FilterActionType = 'apply' | 'reset' | 'bulk-reset';
+export declare type FilterActionType = 'apply' | 'reset' | 'bulk-reset' | 'trigger-reset';
 export interface FilterPayloadType {
     filter: SearchFilter;
     active: boolean;
-    selection?: FilterOption;
+    selection?: FilterOption[];
 }
 /**
  * Context
  */
 interface FilterContextType {
-    state: FilterState;
+    state: FilterStateHash;
     dispatch: React.Dispatch<ReducerActions<FilterActionType>>;
 }
 export declare const FilterContext: import("react").Context<FilterContextType>;
 /**
- * Reducer - root level keys should match the filter object's corresponding "name" field
+ * Reducer - root level keys should match the filter object's corresponding "id" field
  */
-export declare function FilterReducer(state: FilterState, action: ReducerActions<FilterActionType, FilterPayloadType>): FilterState;
+export declare function FilterReducer(state: FilterStateHash, action: ReducerActions<FilterActionType, FilterPayloadType>): FilterStateHash;
 export {};

package/dist/apps/search/utils/FilterHelper.d.ts

@@ -1,14 +1,46 @@
 /// <reference types="react" />
 import { HashObject } from '@clickview/common';
 import { SearchFilter, MoreFilters, FilterType, FilterProps, FilterOption } from 'apps/search/interfaces';
-import { FilterState, FilterPayloadType } from 'apps/search/reducers';
+import { FilterStateHash, FilterPayloadType, FilterState } from 'apps/search/reducers';
+import { MockYearLevel, MockClassroom } from 'apps/user-manager/interfaces';
+interface WithStatementObject {
+    sortKey?: string;
+    sortValue?: string;
+    assocs?: string[];
+}
+declare type FiltersDictionary = {
+    [key: string]: (options?: any) => SearchFilter;
+};
+export declare const Filters: FiltersDictionary;
 export declare const FilterHelper: {
-    getMainFilters(): SearchFilter[];
     getMoreFilters(): MoreFilters;
     mapTypeToComponent(type: FilterType): (props: FilterProps) => JSX.Element;
-    deriveInitialStateFromQuery(queryParams?: HashObject<any>, mainFilters?: SearchFilter[], moreFilters?: MoreFilters): FilterState;
-    buildQueryParams(queryParams: HashObject<any>, state: FilterPayloadType): HashObject<any>;
+    deriveInitialStateFromQuery(queryParams?: HashObject<any>, mainFilters?: SearchFilter[], moreFilters?: MoreFilters): FilterStateHash;
     hasActiveFilters(queryParams: HashObject<any>): boolean;
-    getTypeOptions(): FilterOption[];
-    getRadioParamValue(selection: FilterOption): string;
+    getLabel(filter: SearchFilter, filterState: FilterState): string;
+    buildQueryParams(queryParams: HashObject<any>, state: FilterPayloadType): HashObject<any>;
+    /**
+     * This returns an object of all of the query params our search requests will pass to the backend endpoint.
+     * This usually consists of:
+     * q      = the query string       e.g. 'shakespeare'
+     * filter = the filter string      e.g. '{interactives:true,classroom:classroom-2-a,classroom:classroom-2-b}'
+     * query  = the with statement     e.g. '{orderbydesc:name}series,season,interactives,resources,subtitles'
+     */
+    getBackendQueryParams(queryParams: HashObject<any>): HashObject<any>;
+    /**
+     * This functions purpose is to convert a with statement string into an object that is easy to use
+     * in mock backends for sorting/filtering mock data. It doesn't need to be efficient, as it should
+     * never ever be used in production
+     */
+    convertWithStatementToObject(withStatement: string): WithStatementObject;
+    revertFilterString(filterString: string): HashObject<any>;
+    /**
+     * Helpers below this comment return hard coded filter options for a particular filter.
+     * If you are adding a new filter with hard coded options, add a new function here.
+     */
+    getObjectTypeOptions(): FilterOption[];
+    getNameSortOptions(): FilterOption[];
+    getYearLevelOptions(yearLevels: MockYearLevel[]): FilterOption[];
+    getClassroomOptions(classrooms: MockClassroom[]): FilterOption[];
 };
+export {};

package/dist/apps/user-manager/LiteUserManagerApplication.d.ts

@@ -0,0 +1,16 @@
+import { Core, ReactApplication, HashObject } from '@clickview/common';
+import { TeacherLayoutViewOptions, TeacherLayoutView } from 'shared/layouts';
+export declare class UserManagerApplication extends ReactApplication {
+    protected layout: TeacherLayoutView;
+    get name(): string;
+    static get router(): any;
+    get channelName(): string;
+    protected get layoutOptions(): Core.LayoutOptions<TeacherLayoutViewOptions>;
+    studentManager(queryParams?: HashObject): void;
+    teacherManager(queryParams?: HashObject): void;
+    newStudent(): void;
+    editStudent(params: HashObject): void;
+    newTeacher(): void;
+    editTeacher(params: HashObject): void;
+    removeUsers(params: HashObject): void;
+}

package/dist/apps/user-manager/components/edit-student-details/EditStudentDetails.d.ts

@@ -0,0 +1,10 @@
+import React from 'react';
+import { EditUserRequest, MockYearLevel, MockStudent } from 'apps/user-manager/interfaces';
+interface EditStudentDetailsProps {
+    user?: MockStudent;
+    saveUser: (data: EditUserRequest) => void;
+    onClickCancel: () => void;
+    yearLevels: MockYearLevel[];
+}
+export declare function EditStudentDetails(props: EditStudentDetailsProps): React.ReactElement;
+export {};

package/dist/apps/user-manager/components/edit-teacher-details/EditTeacherDetails.d.ts

@@ -0,0 +1,10 @@
+import React from 'react';
+import { EditUserRequest, MockUserRole, MockTeacher } from 'apps/user-manager/interfaces';
+interface EditUserDetailsProps {
+    user?: MockTeacher;
+    saveUser: (data: EditUserRequest) => void;
+    onClickCancel: () => void;
+    userRoles: MockUserRole[];
+}
+export declare function EditTeacherDetails(props: EditUserDetailsProps): React.ReactElement;
+export {};

package/dist/apps/user-manager/components/index.d.ts

@@ -0,0 +1,4 @@
+export * from './user-details-form/UserDetailsForm';
+export * from './year-level-select/YearLevelSelect';
+export * from './edit-student-details/EditStudentDetails';
+export * from './edit-teacher-details/EditTeacherDetails';

package/dist/apps/user-manager/components/manage-users-list/ManageUsersList.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="react" />
+declare type UserType = 'student' | 'teacher';
+interface ManageUsersListProps {
+    users: any[];
+    userType: UserType;
+}
+export declare function ManageUsersList(props: ManageUsersListProps): JSX.Element;
+export {};

package/dist/apps/user-manager/components/manage-users-list/partial-loading/PartialManageUsersList.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="react" />
+export declare function PartialManageUsersList(): JSX.Element;

package/dist/apps/user-manager/components/manage-users-list/students/ManageStudentItem.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="react" />
+import { MockStudent } from 'apps/user-manager/interfaces';
+interface ManageStudentItemProps {
+    user: MockStudent;
+    isChecked: boolean;
+    onToggleCheckbox: () => void;
+}
+export declare function ManageStudentItem(props: ManageStudentItemProps): JSX.Element;
+export {};

package/dist/apps/user-manager/components/manage-users-list/teachers/ManageTeacherItem.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="react" />
+import { MockTeacher } from 'apps/user-manager/views/school-teacher-manager/SchoolTeacherManagerView';
+interface ManageTeacherItemProps {
+    user: MockTeacher;
+    isChecked: boolean;
+    onToggleCheckbox: () => void;
+}
+export declare function ManageTeacherItem(props: ManageTeacherItemProps): JSX.Element;
+export {};

package/dist/apps/user-manager/components/user-details-form/UserDetailsForm.d.ts

@@ -0,0 +1,11 @@
+import * as React from 'react';
+import { MockYearLevel, MockUserRole } from 'apps/user-manager/interfaces';
+import { MockUserType } from 'apps/user-manager/enums';
+interface UserDetailsFormProps {
+    onClickCancel: () => void;
+    yearLevels?: MockYearLevel[];
+    userRoles?: MockUserRole[];
+    userType: MockUserType;
+}
+export declare function UserDetailsForm(props: UserDetailsFormProps): React.ReactElement;
+export {};

package/dist/apps/user-manager/components/year-level-select/YearLevelSelect.d.ts

@@ -0,0 +1,9 @@
+import * as React from 'react';
+import { MockYearLevel } from 'apps/user-manager/interfaces';
+interface YearLevelSelectProps {
+    yearLevels: MockYearLevel[];
+    onSelect: (id: string) => void;
+    selected?: string;
+}
+export declare function YearLevelSelect(props: YearLevelSelectProps): React.ReactElement;
+export {};

package/dist/apps/user-manager/enums/index.d.ts

@@ -0,0 +1 @@
+export * from './mocks/MockUserType';

package/dist/apps/user-manager/enums/mocks/MockUserType.d.ts

@@ -0,0 +1,4 @@
+export declare enum MockUserType {
+    Student = 0,
+    Teacher = 1
+}

package/dist/apps/user-manager/flight-requests/ClassroomRequests.d.ts

@@ -0,0 +1,4 @@
+import { Flight } from '@clickview/common';
+export declare const ClassroomRequests: {
+    getAll(): Flight.SimulatedRequest;
+};

package/dist/apps/user-manager/flight-requests/SchoolUserRequests.d.ts

@@ -0,0 +1,21 @@
+import { Flight, HashObject } from '@clickview/common';
+import { EditUserRequest } from 'apps/user-manager/interfaces';
+export declare const SchoolUserRequests: {
+    /**
+    * School student management
+    */
+    getSchoolStudents(queryObject?: HashObject<any>): Flight.SimulatedRequest;
+    removeStudentsFromSchool(ids: string[], onDone: () => void): Flight.SimulatedRequest;
+    getStudent(id: string): Flight.SimulatedRequest;
+    createStudent(user: EditUserRequest, success?: () => void, error?: () => void): Flight.SimulatedRequest;
+    updateStudent(user: EditUserRequest, success?: () => void, error?: () => void): Flight.SimulatedRequest;
+    /**
+     * School teacher management
+     */
+    getSchoolTeachers(queryObject?: HashObject<any>): Flight.SimulatedRequest;
+    removeTeachersFromSchool(ids: string[], onDone: () => void): Flight.SimulatedRequest;
+    getTeacher(id: string): Flight.SimulatedRequest;
+    createTeacher(user: EditUserRequest, success?: () => void, error?: () => void): Flight.SimulatedRequest;
+    updateTeacher(user: EditUserRequest, success?: () => void, error?: () => void): Flight.SimulatedRequest;
+    getUserRoles(): Flight.SimulatedRequest;
+};

package/dist/apps/user-manager/flight-requests/YearLevelRequests.d.ts

@@ -0,0 +1,4 @@
+import { Flight } from '@clickview/common';
+export declare const YearLevelRequests: {
+    getAll(): Flight.SimulatedRequest;
+};

package/dist/apps/user-manager/interfaces/EditUserRequest.d.ts

@@ -0,0 +1,8 @@
+export interface EditUserRequest {
+    id?: string;
+    name: string;
+    surname: string;
+    email: string;
+    yearLevel?: string;
+    userRole?: string;
+}

package/dist/apps/user-manager/interfaces/index.d.ts

@@ -0,0 +1,6 @@
+export * from './mocks/MockUserRole';
+export * from './mocks/MockYearLevel';
+export * from './mocks/MockClassroom';
+export * from './mocks/MockStudent';
+export * from './mocks/MockTeacher';
+export * from './EditUserRequest';

package/dist/apps/user-manager/interfaces/mocks/MockClassroom.d.ts

@@ -0,0 +1,3 @@
+import { BaseObject } from '@clickview/shared';
+export interface MockClassroom extends BaseObject {
+}

package/dist/apps/user-manager/interfaces/mocks/MockStudent.d.ts

@@ -0,0 +1,7 @@
+import { MockYearLevel } from './MockYearLevel';
+import { User } from '@clickview/shared';
+import { MockClassroom } from './MockClassroom';
+export interface MockStudent extends User {
+    yearLevel: MockYearLevel;
+    classroom: MockClassroom;
+}

package/dist/apps/user-manager/interfaces/mocks/MockTeacher.d.ts

@@ -0,0 +1,5 @@
+import { MockUserRole } from './MockUserRole';
+import { User } from '@clickview/shared';
+export interface MockTeacher extends User {
+    userRole: MockUserRole;
+}

package/dist/apps/user-manager/interfaces/mocks/MockUserRole.d.ts

@@ -0,0 +1,3 @@
+import { BaseObject } from '@clickview/shared';
+export interface MockUserRole extends BaseObject {
+}

package/dist/apps/user-manager/interfaces/mocks/MockYearLevel.d.ts

@@ -0,0 +1,3 @@
+import { BaseObject } from '@clickview/shared';
+export interface MockYearLevel extends BaseObject {
+}

package/dist/apps/user-manager/validation/index.d.ts

@@ -0,0 +1 @@
+export * from './user-validation/UserValidationSchema';

package/dist/apps/user-manager/validation/user-validation/UserValidationSchema.d.ts

@@ -0,0 +1,14 @@
+export declare const TeacherValidationSchema: import("yup").ObjectSchema<import("yup").Shape<import("yup").Shape<object, {
+    name: string;
+    surname: string;
+    email: string;
+}>, {
+    userRole: string;
+}>>;
+export declare const StudentValidationSchema: import("yup").ObjectSchema<import("yup").Shape<import("yup").Shape<object, {
+    name: string;
+    surname: string;
+    email: string;
+}>, {
+    yearLevel: string;
+}>>;

package/dist/apps/user-manager/views/create-student/CreateStudentView.d.ts

@@ -0,0 +1,6 @@
+import * as React from 'react';
+import { PopupViewProps } from '@clickview/shared';
+interface CreateStudentViewProps {
+}
+export declare function CreateStudentView(props: CreateStudentViewProps & PopupViewProps): React.ReactElement;
+export {};

package/dist/apps/user-manager/views/create-teacher/CreateTeacherView.d.ts

@@ -0,0 +1,6 @@
+import * as React from 'react';
+import { PopupViewProps } from '@clickview/shared';
+interface CreateTeacherViewProps {
+}
+export declare function CreateTeacherView(props: CreateTeacherViewProps & PopupViewProps): React.ReactElement;
+export {};

package/dist/apps/user-manager/views/edit-student/EditStudentView.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+import { PopupViewProps } from '@clickview/shared';
+interface EditStudentViewProps {
+    id: string;
+}
+export declare function EditStudentView(props: EditStudentViewProps & PopupViewProps): React.ReactElement;
+export {};

package/dist/apps/user-manager/views/edit-teacher/EditTeacherView.d.ts

@@ -0,0 +1,7 @@
+import * as React from 'react';
+import { PopupViewProps } from '@clickview/shared';
+interface EditTeacherViewProps {
+    id: string;
+}
+export declare function EditTeacherView(props: EditTeacherViewProps & PopupViewProps): React.ReactElement;
+export {};

package/dist/apps/user-manager/views/remove-user/RemoveUserView.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="react" />
+import { PopupViewProps } from '@clickview/shared';
+interface RemoveUserViewProps {
+    userIds: string[];
+    userType: 'student' | 'teacher';
+}
+export declare function RemoveUserView(props: RemoveUserViewProps & PopupViewProps): JSX.Element;
+export {};

package/dist/apps/user-manager/views/school-student-manager/SchoolStudentManagerView.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+import { HashObject } from '@clickview/common';
+interface SchoolStudentManagerViewProps {
+    queryParams: HashObject;
+}
+export declare function SchoolStudentManagerView(props: SchoolStudentManagerViewProps): JSX.Element;
+export {};

package/dist/apps/user-manager/views/school-student-manager/empty-state/SchoolStudentManagerEmptyState.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="react" />
+export declare function SchoolStudentManagerEmptyState(): JSX.Element;

package/dist/apps/user-manager/views/school-teacher-manager/SchoolTeacherManagerView.d.ts

@@ -0,0 +1,11 @@
+/// <reference types="react" />
+import { HashObject } from '@clickview/common';
+import { User, BaseObject } from '@clickview/shared';
+export declare type MockTeacher = User & {
+    userRole: BaseObject;
+};
+interface SchoolTeacherManagerViewProps {
+    queryParams: HashObject;
+}
+export declare function SchoolTeacherManagerView(props: SchoolTeacherManagerViewProps): JSX.Element;
+export {};

package/dist/apps/user-manager/views/school-teacher-manager/empty-state/SchoolTeacherManagerEmptyState.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="react" />
+export declare function SchoolTeacherManagerEmptyState(): JSX.Element;