@clickview/ship-it 0.0.16 → 0.0.18

package/dist/Z1/clickview.md

@@ -1,316 +0,0 @@
-
-# Before release
-
-## other
-- [ ] Curriculums used in the public product need to be added to `public_presentations` table in Subject API
-- [ ] After releasing, we need to update the `curriculums.view` permission in production (this is technically an `After release` action. It **must** happen **after** pushing, otherwise we will break public play pages and send unauthenticated users to the sign in page)
-  - `PUT v1/permissions/35` the following payload (please sanity check the id before updating - the permission already existing in both staging and production):
-  - The change below is to add `public` to the `permissionSet` property. This will allow public users to be able to view curriculum links.
-```
-{
-	"id": 35,
-	"name": "curriculums.view",
-	"description": "Can view curriculum links",
-	"visibility": "Internal",
-	"type": "Static",
-	"dateCreated": "2023-02-14T03:26:39Z",
-        "permissionSets": [
-            "public"
-        ],
-	"roles": [
-		"Admin",
-		"SuperAdmin"
-	],
-	"userTypes": [
-		"Staff"
-	]
-}
-```
-- Create a `feedback.submit` permission in permission API for staff and admins only. Not students.
-
-# Dependencies
-https://gitlab.cvinternal.net/clickview/back-end/discover.api/-/merge_requests/103
-- https://gitlab.cvinternal.net/clickview/front-end/lite/-/merge_requests/348
-- https://gitlab.cvinternal.net/clickview/back-end/clickview.subjects.api/-/merge_requests/189
-- https://gitlab.cvinternal.net/clickview/back-end/discover.api/-/merge_requests/102
-- https://gitlab.cvinternal.net/clickview/front-end/lite/-/merge_requests/346
-- https://gitlab.cvinternal.net/clickview/front-end/lite/-/merge_requests/345
-- https://gitlab.cvinternal.net/clickview/front-end/lite/-/merge_requests/343
-- https://gitlab.cvinternal.net/clickview/front-end/ClickView.Curator/-/merge_requests/1056
-- https://gitlab.cvinternal.net/clickview/front-end/ClickView.Online/-/merge_requests/3194
-
-# Analytics
-
-## Code changes
-- Fix the missing scroll button in the results table. Fix INBOX-4407.
-
-# Common
-
-## Code changes
-- Importing cloneDeep using `lodash.clonedeep` to ensure the rest of lodash isn't coming with it.
-- Updated the recursive denormalizer test to cater for a use case that wasn't covered.
-- Updated `ObjectHelper.deepClone()` to use `cloneDeep` from lodash. Addresses INBOX-4054.
-
-# Curator
-
-## Code changes
-- Update playlist request key to correctly fetch playlist with `subjectPresentationAudience`. Fix INBOX-4414 
-- Update playlist request key to correctly fetch playlist with `subjectPresentationAudience`. Fix INBOX-4426
-
-## Customer changes
-- Fixed an issue in curation studio where if you were managing a dashboard or topic in a presentation that isn't associated with your account, the audiences would always display as "Missing Audience" even if it had one. Fixes CC-471
-- In curation studio, published dashboards can no longer be edited. Curators now have to create a copy of the published dashboard, then make changes to the copy, then publish that. Implements CC-464
-- Curators can now create a copy of discover and topic dashboards. Implements CC-465
-- Fixed an issue in user manager where the bulk upload template file couldn't be downloaded in Safari. Fixes INBOX-4434
-- In the user manager page, users can now bulk-select by uploading a spreadsheet containing the student/staff they want to select. Implements LTE-1726
-- When curating a topic page, curators can now search within the entire presentation rather than just within the topic. Implements CC-466
-
-# Library Editor
-
-## Customer changes
-- Fixed an issue where video results in the search dropdown displayed very small thumbnails. Fixes INBOX-4457
-
-# Lite
-
-## Customer changes
-- On mobile, the search bar will now automatically focus when opened up.
-- Curriculum links are now accessible in the public version of NP
-  - Implements LTE-1759 
-- Fixed an error where changing presentations as a public user could send them to the login page
-  - Fixes INBOX-4490  
-- Switching presentation will now be a little faster than usual
-- During the sign up workflow, students are now prompted to enter their date of birth before we collect their email address. We do not collect and PII from students who are under the age of 13, instead they are sent to our free videos on the marketing website. Once a student has filled out our date of birth form, they cannot get back to the sign up form, it will always show them the link to the free videos page. This is done in order to protect young students who cannot consent to their data being collection, in compliance with COPPA in the United States of America. 
-- Fixed an issue in user manager where the bulk upload template file couldn't be downloaded in Safari. Fixes INBOX-4434
-- The "explore all subjects" page should now always display the subjects in alphabetical order. Fixes INBOX-4048
-- In Lite user manager page, users can now bulk-select by uploading a spreadsheet containing the student/staff they want to select. Implements LTE-1726
-- When loading into a specific table of contents section on a topic page, you should land a bit closer than before. Implements LTE-1775 and fixes INBOX-4453
-- Fixed an issue on mobile where the left nav would initially be expanded then immediately collapsed, resulting in a harsh first landing experience. Implements LTE-1775
-- Fixed the partial loading for the breadcrumbs, audience filter, and banner on the topic page not matching up with the actual UI accurately Implements LTE-1775
-- Adjusted the partial loading for 4 video widgets (Implements LTE-1775):
-  - "Enhanced large slider"
-  - "Featured video"
-  - "Hero video"
-  - "2 side by side thumbnails"
-- Fixed the alignment of the thumbnail and video title text on the featured media widget on smaller screens Implements LTE-1775
-- Fixed an issue where students could provide feedback via the footer on the discover page.
-- Fixed an issue where all pages had smooth scrolling. Fixes LTE-1762
-- In the lite discover dashboard, for three types of widget templates (1. Enhanced large slider 2. Large slider 3. Small slider), their title can be clicked and navigate to a video list view of that widget. Implements LTE-1727.
-- If a prospects school is not supported they now can request a trial like in marketing. Implements LTE-1733.
-- Fixed an issue on topics where if you apply a filter that reveals an empty state, then you click "Clear", the page doesn't revert back to the filterless view and the audience filters disappear. Fixes INBOX-4412
-- Fixed a bug where if a teacher is direct sharing to another teacher, the search dropdown would display the teacher's display name. Fixes INBOX-4362
-- Fixed a but where if a teacher is adding another teacher to a classroom, the search dropdown would display the teacher's display name. Fixes INBOX-4362
-- Styling of the sign up form has been slightly updated to be more in line with our Auth forms.
-- The email, location and school inputs in the sign up for now have clear buttons to clear their content.
-- The location and school input typeaheads now have keyboard support: Down, up arrows as well as enter will now work as expected.
-- As a user in a multi-presentation school, if you search for a topic and get a result with the same name from >1 presentation, they will be ordered by the learning level of the presentation.
-- In search results of small screen, the interactive will show 3 question. Implements INBOX-4344.
-- Customer will get an alert message after update video details. Implements INBOX-4116.
-- When student has no contents, the empty state copy has been updated. Implements INBOX-4291.
-
-## Code changes
-- Refactored `useTopicPresentation` to become `usePresentation` that now supports use of both topic and curriculum presentations
-- Cleaned up `useCurriculums` to utilize `usePresentation`
-- Updated play page components to consistently use curriculums 
-- Update curriculum handling in search results
-- Re-worked our completion step to take a `CompletionStepId`. We now have 3 completion step types, trial status, added to braze, and young student.
-- Add bootstrap keys for `permissions` and `products`
-- Add a new CuratedDashbaordWidgetView based on the domain option. 
-- Add new appLinks type to the dashboard. 
-- Add event listener to video guidance tag to set the active status of popout. Fix LTE-1728.
-- Shrink the activity status badge size. Fix LTE-1744
-- Added a new sign up step named `add-to-braze`. Implements LTE-1752.
-- Added a form that add a prospect with all their details to braze. Implements LTE-1763.
-- Updated terms and condition link to point to global marketing website. Fixes LTE-1735.
-- Fixed a bug that was causing us to drop events when logging our playlists.
-- Fixed a but that was causing the edit video details to break after favouriting the video. Fixes INBOX-4292.
-- Fixed the sign in button on the public play pages not being an anchor. Fixes INBOX-4372
-- Updated usage of hardcoded country codes to use `LocalityHelper`.
-- 'Use my current location' is selectable when navigating by keyboard.
-- 'Can't find your school?' is selectable when navigating by keyboard.
-- Fixed a bug where clearing SearchLocalityInput in Cant find school step clearing the school name.
-- Fixed style imports to be relative.
-- Fixed banner height in topic classification board at web-mobile screen size. Fix INBOX-4410
-- Hide the text of follow/unfollow button at the web-mobile screen size. Fix INBOX-4410
-- Cleaning up markup and utility classes across all steps of the sign up app.
-- Only show the level above for breadcrumb in web-mobile. Fix INBOX-4382;
-- Increase the padding of the audience filter when wrapped in web-mobile. Fix INBOX-4398
-- Fix content updates banner bg image position Fix INBOX-4381
-- For the `hasCurriculumLinks` request, make the array of objectId unique and sort them in key so it can be cached more accurately. Fixes INBOX-4316.
-- Show 3 question of interactives in search result in mobile.
-- Add alerts on callbacks after saving video details.
-- Update copy of empty state in student feed.
-- Reorder the `Share` button after the `Add to playlist` button in the lite interactive page. Fix INBOX-4334
-
-# Monorepo
-
-## Code changes
-- Add `ship-it.config` file for latest changes in ship it https://gitlab.cvinternal.net/clickview/front-end/ship-it/-/merge_requests/42
-- Adding a type for cloneDeep to all projects.
-- Cleanup commands for cross platform builds. Closes INBOX-4286
-  - Remove all docker build scripts
-  - Replace `export` and `set` environment variable calls with `cross-env` package to enable cross platform building without needing separate linux only commands
-
-# Online
-
-## Customer changes
-- Fixed an issue in user manager where the bulk upload template file couldn't be downloaded in Safari. Fixes INBOX-4434
-- In the user manager page, users can now bulk-select by uploading a spreadsheet containing the student/staff they want to select. Implements LTE-1726
-
-# Player
-
-## Customer changes
-- Enable spellcheck for annotation editor when editing interactives. Fixes INBOX-4357.
-
-## Code changes
-- Added `spellCheck` for DraftJs editor since it render a `div` with `contentEditable=true`
-
-# Shared
-
-## Code changes
-- Now fetching the parent video for clips and interactives using the `_parentVideo` virtual assoc.
-- Now fetching the parent clip for interactives using `_parentClip`.
-- Updated our types for clips and interactives to no longer have `video` or `clip` properties, instead they have `_parentVideo` or `_parentClip` properties, whose type is a subset of the video and clip types.
-- Update public support for curriculum requests
-- Clean up `publicUrl` for presentation requests
-- Gracefully handle missing curriculum in `CurriculumDropdown`
-- Update invalidation keys when updating presentation
-- Fix "What's included" doesn't include link resources. Fix LTE-1754
-- Removed the `forcedMediaQuery` prop that's unused and littered throughout the codebase.
-- Shrink the width of alert in mobile. Fixes INBOX-3963.
-- Add SelectWithSpreadSheet component
-- Add a helper function to build & split query params to fetch user
-- Fixed an error during parsing an empty CSV file
-- Cleaned up code in `EditVideoDetails` to only pass the relevant form data as initial values.
-- Cleaned up the `<FormWrapper />`, it will no longer recursively use `ObjectHelper.deepClone()`
-- Updated the `ReorderHelper` to pass only the object ids back into flight. Fixes STG-271
-- Shrink the padding of the overlay title of the video thumbnail on the web-mobile screen. Fix INBOX-4385
-- Update the layout of the editing status for `EditableCoverFixedPillListSmallWidgetTemplate`. Implements INBOX-4384 
-- `updateVideo` request accepts `always` callback.
-
-## Customer changes
-- Alert in mobile will display 'x' icon at the first line.
-
-# Styles
-
-## Customer changes
-- Fix the styling of our tooltip, it no longer will show the border bottom across the arrow.
-
-# Tooling
-
-## Code changes
-- The `I18nPlugin` will now watch all the `*.lang.json` files for file changes, and output the updated language file.
-
-# Testing
-- In the curation studio, adding a playlist widget, when adding playlists, the audience information should be displayed correctly.
-- Ship it runs
-- In NP on mobile, the search bar should now automatically focus when opened up. On desktop, it should not automatically focus ever.
-- The way clips and interactives fetch their parent video has been reworked in order to accommodate a share change, which means clips and interactives will need a regression test. Testing that the video item in lists or widgets, as well as their pages behave properly.
-  - Playlists
-  - Watch History
-  - My Videos
-  - Favourite videos
-  - Student feed
-  - Student feed in a playlist
-  - Beneath the video on the page page
-  - Search results
-  - Share links, both full page and embed
-  - Creating clips
-  - Creating interactives on clips
-- In analytics, test that viewing interactive results, and the top videos feature work.
-- In NP:
-  - As an authenticated user:
-    - Accessing curriculum links on the play page as a staff/admin should continue to load as expected (regression)
-      - Curriculum links should load (for accounts with one or many available curriculums)
-      - Switching curriculums should work as expected and correctly load the links for the nominated curriculum
-      - It should be possible to access the curriculum link applink from both V@G and video details page
-    - Accessing curriculum links on a video list view as a staff/admin should continue to load as expected (regression)
-      - Curriculum links should load (for accounts with one or many available curriculums)
-      - Switching curriculums should work as expected and correctly load the links for the nominated curriculum
-    - Accessing curriculum links in search results as a staff/admin should continue to load as expected (regression)
-    - Curriculum links shouldn't be accessible to students
-    - Page loading should loading the user's last nominated presentation (when switching between many)
-    - Videos access via share link should load as expected and the curriculums should be viewable
-  - As a public/unauthenticated user:
-    - It should be possible to view curriculum links on the play page
-      - Curriculum links should load (AU and US will have many curriculums available. GB and GB-SCT will only have access to one curriculum each).
-      - Switching curriculums should work as expected and correctly load the links for the nominated curriculum
-      - It should be possible to access the curriculum link applink from both V@G and video details page 
-    - We currently don't show any actions on public video list views. For the time being this will remain.
-      - Search results, video lists in both series and playlists should continue to load as expected (regression)
-    - Nominated curriculums should be persisted in local storage in the same way that we do for topic presentations
-    - Switching presentations should no longer show an error in the console
-    - Switching presentations should no longer send the user to the login page if they reload after switching
-- Hover over a video you do not have access to, take a deep breath of relaxation because that god forsaken border styling issue is gone.
-- In the classifìcation dashboard (Lite and Curator), the 'what's included' tag of a video, the resources section should also contain the link resources of the current video.
-- In curation studio, you should no longer be allowed to edit a published dashboard.
-- In curation studio, you should still be able to edit draft dashboards.
-- Every frontend project needs a regression test, clicking around to a few pages (Online, Curator, Lite, Reports)
-- In Curator, you should now be able to copy discover and topic dashboards using the "Copy dashboard" action on the dashboards list page. Editing a copy should not affect the original dashboard.
-- Sign up for a trial as a student, enter date of birth that is younger than 13 years of age. Ensure you are linked to the marketing free videos page. Ensure that if you go back to the sign up form you are always sent to the free videos page.
-- On the initial page load, permissions and products should not be fetched
-- After the flight cache expires, permissions and products should be fetched correctly
-- In NP, in small size(320px - 575px), the close icon in alert will be at the first line. Can test with 'favourited' any video.
-- Open user manager in safari in either NP, Curator, or Online. Go to bulk upload, and click to download the template. The file should download.
-- When uploading a video in NP, the "Upload video" text in the button shouldn't wrap at any screen size. Fixes INBOX-4436
-- In library editor's search bar dropdown, video result thumbnails should look normal. They shouldn't look like how they do in the screenshot on this ticket: https://clickview.atlassian.net/browse/INBOX-4457
-- Subjects on the "Explore all subjects" page should be in alphabetical order
-- In Lite/Curator/Online, the user manager page for students and staff, the 'Select with spreadsheet' action was added to the actions dropdown. It should find and select all the valid users from the spreadsheet in the current schools. 
-  - It should find both verified and unverified users.
-  - It should not find users from other schools.
-  - Uploading an empty CSV file should trigger the error popup.
-  - CSV doesn't contain any of the Email and Username columns will trigger the error popup.
-  - It should find users with the correct user type, e.g., in the student manager page, it will only find all the students in the spreadsheet.
-  - Notes to Jav: Online requires more attention if you are able to do a deep test.
-- Regression test: in Lite/Curator/Online, the user manager page for students and staff, click on the 'Add new student/staff', and choose to upload a CSV that only contains headings but no content should trigger the correct warning popup.
-- The partial loading on the topics page should look really really accurate on:
-  - Mobile
-  - IPad
-  - Desktop
-- Curated topics pages on mobile should not have any UI issues.
-- As a student, you should no longer see an option to provide feedback via the form at the bottom of the discover page.
-- When navigating between 2 pages, it should not "smooth scroll" between them.
-- On a curated topics page with a able of contents, the TOC should still have smooth scrolling behavior.
-- In Curation Studio when editing a topic page, you should now see an option to search within the whole presentation when creating a widget.
-- In the lite discover dashboard, for three types of widget templates (1. Enhanced large slider 2. Large slider 3. Small slider), their title can be clicked and navigate to a video list view of that widget containing all the videos within that widget.
-- In lite, view the classification dashboard on a mobile web screen. The video guidance of the `Hero video` widget and `2 side by side` widget can be opened and closed by tapping the badge.
-- In Lite, start the sign up process and select a school which has a trial status of 'unavailable'
-- Click get started and we should be taken to 'add-to-braze' step which asks more information about the user
-- The form is validated client side and should not allow for
-  - strings larger than 255 characters
-  - strings starting with `$` (braze thing)
-  - phone number can only be digits between 4 and 255 characters long
-- Clicking submit button should send the user data to braze and we should be able to look up the user with that email in it.
-- The user should also have a custom event named `marketing_free_trial_signup`
-- Playlist re-ordering needs to be tested in Lite and NP. In Lite, it needs to be tested on a video that has clips and interactives, after loading to the play page and then going back to the playlist to re-order. Previously this threw an error https://clickview.atlassian.net/browse/STG-271
-- Favourite a video in my videos and then make sure the edit details page loads.
-- Because one of our core utilities were replaced, there are quite a few places that need a very brief regression test. We're just looking for the UI behaving normally
-  - Direct sharing to classrooms in the NP share popup
-  - The playlist play page in online
-  - The audience filter in reports
-  - Editing a workspace video in Online and NP
-  - Bulk uploading users to user manager (Just NP is enough)
-  - Approving and rejecting library requests in library editor
-  - Editing a clip's details in NP, make sure changing the name of the clip doesn't modify the start and end time
-- In analytics, checking the results of an interactive, when there are more than 13 questions, the scroll to right button should be displayed.
-- In chrome settings, make sure to enable spellcheck. visit `chrome://settings/?search=spell+check`
-- In Lite, create a new interactive and add an annotation.
-- If we start typing in the editor and misspell any words we should trigger the spellcheck.
-- On a topics page, apply a filter so that all content disappears. This should reveal an empty state. Then, click "Clear" to clear the filters. The page should revert back to the original filterless view.
-- In NP, when sharing to another teacher, they should not appear with their `displayName` but rather their full name.
-- In NP, when adding another teacher to a classroom, they should not appear in the search dropdown with their `displayName` but rather their full name.
-- In Signup App, Go through the steps until you reach searching school step.
-- Search for a locality and we should be able to navigate to 'Use my location' then press enter
-- Seach for a school and we should be able to navigate to 'Cant find your school?' then press enter
-- We should be able to submit the form as normal and get a free trial.
-- Regression test signing up.
-- View the classification dashboard in the small browser window (mobile) in Lite. There should be a gap between the wrapped audience filter. 
-Also, the breadcrumb should only show one item, the parent level of the current topic.
-
-![image__21_](/uploads/c91532841489df4bd6473bc3437a627f/image__21_.png)
-- Login to an account with both "AU Primary" and "AU Secondary" presentations. Search for "English". In the results, the english topic from the primary presentation should be shown before the english topic from the secondary presentation.
-- In NP, the curriculum links should show when a video have it and work as usual.
-- In NP, find an interactive by using search, in mobile, there should have 3 question showing.
-- In NP, edit a video in 'My Videos', after save the changes, an alert should show and say whether it is successfully of failed to update video details.
-- In NP, login as a student without content and go to student feed, the copy should be updated.
-- In lite, preview an interactive, the button `Share` should be after `Add to playlist` button.
-- All projects build on windows and linux