Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add request package (CommonMediaRequest and CommonMediaResponse) #18

Merged
merged 47 commits into from
Nov 13, 2023

Conversation

bbert
Copy link
Contributor

@bbert bbert commented May 23, 2023

Description

Add common API for player requests and responses, following discussion on dash.js: Dash-Industry-Forum/dash.js#4152
This API provides also a plugin request and response callback prototype that can be used as input in every player in order to enable applications to manipulate requests and responses.

A sample test application based on dash.js and using this API will be provided withing dash.js repo.

Requirements Checklist

  • Unit Tests updated or fixed (N/A)
  • [ x] Docs/guides updated

@bbert bbert requested review from a team and littlespex as code owners May 23, 2023 08:50
lib/src/request/CommonMediaRequest.ts Show resolved Hide resolved
lib/src/request/CommonMediaRequest.ts Outdated Show resolved Hide resolved
lib/src/request/CommonMediaRequest.ts Outdated Show resolved Hide resolved
lib/src/request/CommonMediaResponse.ts Show resolved Hide resolved
lib/src/request/ResourceTiming.ts Outdated Show resolved Hide resolved
lib/src/request/CommonMediaRequest.ts Outdated Show resolved Hide resolved
lib/src/request/CommonMediaRequest.ts Outdated Show resolved Hide resolved
lib/src/request/ResourceTiming.ts Outdated Show resolved Hide resolved
lib/src/request/CommonMediaResponse.ts Outdated Show resolved Hide resolved
@littlespex littlespex requested a review from Sergears May 23, 2023 20:42
@bbert
Copy link
Contributor Author

bbert commented May 26, 2023

BTW, I suggest not inserting semicolons in source code and add no-unexpected-multiline rule in linter

lib/src/request/RequestPlugin.ts Outdated Show resolved Hide resolved
lib/src/request/CommonMediaResponse.ts Show resolved Hide resolved
lib/src/request.ts Outdated Show resolved Hide resolved
Copy link
Collaborator

@littlespex littlespex left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Everything looks good but there are a few book keeping items to address:

lib/src/index.ts Outdated Show resolved Hide resolved
@littlespex littlespex changed the base branch from main to release/0.5.0 October 27, 2023 16:23
@littlespex littlespex added this to the 0.5.0 milestone Oct 27, 2023
bbert and others added 17 commits November 10, 2023 09:43
Signed-off-by: Bertrand Berthelot <[email protected]>
Signed-off-by: Bertrand Berthelot <[email protected]>
- startTime property as required
- add encodedBodySize property

Signed-off-by: Bertrand Berthelot <[email protected]>
…ing.encodedBodySize)

Signed-off-by: Bertrand Berthelot <[email protected]>
* chore: change npm scope to svta

Signed-off-by: Bertrand Berthelot <[email protected]>
Signed-off-by: Bertrand Berthelot <[email protected]>
* chore: add notice attribution file

* chore: add notice attribution file

* fix: export cjs version of the library

* chore: switch to inline source maps

* chore: update version to 0.4.3

Signed-off-by: Bertrand Berthelot <[email protected]>
Signed-off-by: Bertrand Berthelot <[email protected]>
Signed-off-by: Bertrand Berthelot <[email protected]>
* fix: list default as last export in package json

Signed-off-by: Bertrand Berthelot <[email protected]>
littlespex and others added 15 commits November 10, 2023 09:44
Signed-off-by: Casey Occhialini <[email protected]>
Signed-off-by: Bertrand Berthelot <[email protected]>
Signed-off-by: Casey Occhialini <[email protected]>
Signed-off-by: Bertrand Berthelot <[email protected]>
Signed-off-by: Casey Occhialini <[email protected]>
Signed-off-by: Bertrand Berthelot <[email protected]>
Signed-off-by: Casey Occhialini <[email protected]>
Signed-off-by: Bertrand Berthelot <[email protected]>
Signed-off-by: Bertrand Berthelot <[email protected]>
Signed-off-by: Casey Occhialini <[email protected]>
Signed-off-by: Bertrand Berthelot <[email protected]>
* fix: rename CmcdParam file to match exported const

Signed-off-by: Casey Occhialini <[email protected]>
Signed-off-by: Bertrand Berthelot <[email protected]>
Signed-off-by: Casey Occhialini <[email protected]>
Signed-off-by: Bertrand Berthelot <[email protected]>
Signed-off-by: Casey Occhialini <[email protected]>
Signed-off-by: Bertrand Berthelot <[email protected]>
Signed-off-by: Casey Occhialini <[email protected]>
Signed-off-by: Bertrand Berthelot <[email protected]>
Signed-off-by: Casey Occhialini <[email protected]>
Signed-off-by: Bertrand Berthelot <[email protected]>
Signed-off-by: Casey Occhialini <[email protected]>
Signed-off-by: Bertrand Berthelot <[email protected]>
Signed-off-by: Casey Occhialini <[email protected]>
Signed-off-by: Bertrand Berthelot <[email protected]>
Signed-off-by: Casey Occhialini <[email protected]>
Signed-off-by: Bertrand Berthelot <[email protected]>
@bbert bbert force-pushed the common-media-request branch from aff8d44 to e56e77c Compare November 10, 2023 08:51
@bbert bbert force-pushed the common-media-request branch from cf3c80b to a105404 Compare November 10, 2023 09:30
Signed-off-by: Bertrand Berthelot <[email protected]>
@bbert bbert force-pushed the common-media-request branch from 2d54b18 to 986f776 Compare November 13, 2023 13:52
Signed-off-by: Bertrand Berthelot <[email protected]>
@littlespex littlespex merged commit c5df0ee into release/0.5.0 Nov 13, 2023
2 checks passed
@littlespex littlespex deleted the common-media-request branch November 13, 2023 16:24
littlespex added a commit that referenced this pull request Nov 14, 2023
* chore: update version to 0.5.0

Signed-off-by: Casey Occhialini <[email protected]>

* Issue/35-cmsd (#36)

* add: structured field implementation
* add: CMSD utiles
* add CMSD encode tests
* doc: add api docs for CMSD items
* chore: update version to 0.5.0
* chore: update changelog
* chore: reorganize source files
* chore: update github actions to checkout submodules
* add cmcd key filtering
* add: option to not use Symbol in encodings
* add: api extractor support

---------

Signed-off-by: Casey Occhialini <[email protected]>

* Add request package (CommonMediaRequest and CommonMediaResponse) (#18)
* CommonMediaRequest.headers as optional property
* Add request property in CommonMediaResponse
* Update ResourceTiming:
    - startTime property as required
    - add encodedBodySize property
* CommobMediaResponse: remove length prroperty (replaced by resourceTiming.encodedBodySize)
* Remove application based request execution functionnality
* Rename Request/ResponsePlugin to Request/ResponseInterceptor
* Add CHANGELOG for request/response API
* package.json: add keywords for Common Media Request/Response
* request package: add tsdoc release tag
* Reorder export in alphabetical order

---------

Signed-off-by: Bertrand Berthelot <[email protected]>

---------

Signed-off-by: Casey Occhialini <[email protected]>
Signed-off-by: Bertrand Berthelot <[email protected]>
Co-authored-by: Bertrand Berthelot <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants