Make MediaService generic

[sarayourfriend]

Description

Just some optional type enhancements to @obulat's excellent MediaService refactor.

Testing Instructions

Create a test media service in media-service.js like this and inspect the return types of the various functions. Ensure they are as expected!

const testService = new MediaService('image')
testService.getRelatedMedia({ id: 'asdf' })
    .then(({ data }) =>
        data.map(r =>
            /** `r` should be either ImageDetail or AudioDetail depending on what you passed to the MediaService constructor :o */
        )
    )

Checklist

• My pull request has a descriptive title (not a vague title like Update index.md).
• My pull request targets the default branch of the repository (main) or a parent feature branch.
• My commit messages follow best practices.
• My code follows the established code style of the repository.
• I added or updated tests for the changes I made (if applicable).
• I added or updated documentation (if applicable).
• I tried running the project locally and verified that there are no visible errors.

Developer Certificate of Origin

Developer Certificate of Origin

Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

[sarayourfriend]

This is just me being kind of silly with TS string types. We could just as easily (and probably should just) use a type directly as 'by' | 'sa' | 'nd' | 'nc' 😝

[obulat]

I tend to agree with your comment 😆 I mean it looks very interesting, but it would probably take me years to understand what it means :)

[obulat]

@sarayourfriend , can you give me a reference I can read about the type {const} declaration? I couldn't find anything searching for typescript const type.

The reason I'm asking this is the messages I see in my IDEs.
WebStorm is trying to find something in the node_modules, I guess?

VS Code just shows it as unresolved, even when I set language mode to TypeScript (I don't know what other information can I get about VS Code TS hints)

[sarayourfriend]

It's the JSDoc version of this feature: https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-4.html#const-assertions

The TypeScript JSDoc documentation for it is here: https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html#casts (the second example in that section)

I'm not sure why TS isn't picking it up. In VSCode have you tried running the "Restart TS Service" command? I have to do that anytime tsconfig.json changes.

For WebStorm it might be the same. You will probably also have to enable the TS language server using the instructions described here: https://www.jetbrains.com/help/webstorm/typescript-support.html#ws_ts_use_ts_service_checkbox

[obulat]

Thank you for this PR, @sarayourfriend ! It's fantastic, and great for learning more about types, as always!

I have taken all the changes that don't create warnings in my IDE and pushed them to the original PR. There are 2 things I don't think we should tackle here:

1. licenses - Dhruv has made significant changes to the license code in Update license explanation tooltip #850, so it would create double work load to add typing here.
2. media type constant types - they have been changed a lot in Remove mediaType from search.query state #851, so the same here.
   Also, I would really like to find out what's wrong with my setup with regards to the {const} type, but until that I would prefer not to add it.
   media-service raises errors when I run pnpm run types, probably because I have not added the mediaType-related constant types, so I didn't add it and licenses to the list of files to check types in.

[sarayourfriend]

Woohoo! 🎉 Makes sense to leave that stuff out for now 👍 We definitely need to sort out why the const cast isn't working for you though, it's a fundamental tool in good TypeScript!