musora-content-services 1.0.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +17 -0
- package/README.md +39 -0
- package/docs/data/search.json +1 -0
- package/docs/fonts/Inconsolata-Regular.ttf +0 -0
- package/docs/fonts/OpenSans-Bold-webfont.eot +0 -0
- package/docs/fonts/OpenSans-Bold-webfont.svg +1830 -0
- package/docs/fonts/OpenSans-Bold-webfont.woff +0 -0
- package/docs/fonts/OpenSans-BoldItalic-webfont.eot +0 -0
- package/docs/fonts/OpenSans-BoldItalic-webfont.svg +1830 -0
- package/docs/fonts/OpenSans-BoldItalic-webfont.woff +0 -0
- package/docs/fonts/OpenSans-Italic-webfont.eot +0 -0
- package/docs/fonts/OpenSans-Italic-webfont.svg +1830 -0
- package/docs/fonts/OpenSans-Italic-webfont.woff +0 -0
- package/docs/fonts/OpenSans-Light-webfont.eot +0 -0
- package/docs/fonts/OpenSans-Light-webfont.svg +1831 -0
- package/docs/fonts/OpenSans-Light-webfont.woff +0 -0
- package/docs/fonts/OpenSans-LightItalic-webfont.eot +0 -0
- package/docs/fonts/OpenSans-LightItalic-webfont.svg +1835 -0
- package/docs/fonts/OpenSans-LightItalic-webfont.woff +0 -0
- package/docs/fonts/OpenSans-Regular-webfont.eot +0 -0
- package/docs/fonts/OpenSans-Regular-webfont.svg +1831 -0
- package/docs/fonts/OpenSans-Regular-webfont.woff +0 -0
- package/docs/fonts/OpenSans-Regular.ttf +0 -0
- package/docs/fonts/OpenSans-Semibold-webfont.eot +0 -0
- package/docs/fonts/OpenSans-Semibold-webfont.svg +1830 -0
- package/docs/fonts/OpenSans-Semibold-webfont.ttf +0 -0
- package/docs/fonts/OpenSans-Semibold-webfont.woff +0 -0
- package/docs/fonts/OpenSans-SemiboldItalic-webfont.eot +0 -0
- package/docs/fonts/OpenSans-SemiboldItalic-webfont.svg +1830 -0
- package/docs/fonts/OpenSans-SemiboldItalic-webfont.ttf +0 -0
- package/docs/fonts/OpenSans-SemiboldItalic-webfont.woff +0 -0
- package/docs/fonts/WorkSans-Bold.ttf +0 -0
- package/docs/global.html +4773 -0
- package/docs/index.html +93 -0
- package/docs/index.js.html +766 -0
- package/docs/scripts/core.js +726 -0
- package/docs/scripts/core.min.js +23 -0
- package/docs/scripts/linenumber.js +25 -0
- package/docs/scripts/prettify/Apache-License-2.0.txt +202 -0
- package/docs/scripts/prettify/lang-css.js +2 -0
- package/docs/scripts/prettify/prettify.js +28 -0
- package/docs/scripts/resize.js +90 -0
- package/docs/scripts/search.js +265 -0
- package/docs/scripts/search.min.js +6 -0
- package/docs/scripts/third-party/Apache-License-2.0.txt +202 -0
- package/docs/scripts/third-party/fuse.js +9 -0
- package/docs/scripts/third-party/hljs-line-num-original.js +369 -0
- package/docs/scripts/third-party/hljs-line-num.js +1 -0
- package/docs/scripts/third-party/hljs-original.js +5171 -0
- package/docs/scripts/third-party/hljs.js +1 -0
- package/docs/scripts/third-party/popper.js +5 -0
- package/docs/scripts/third-party/tippy.js +1 -0
- package/docs/scripts/third-party/tocbot.js +672 -0
- package/docs/scripts/third-party/tocbot.min.js +1 -0
- package/docs/styles/clean-jsdoc-theme-base.css +1159 -0
- package/docs/styles/clean-jsdoc-theme-dark.css +412 -0
- package/docs/styles/clean-jsdoc-theme-light.css +482 -0
- package/docs/styles/clean-jsdoc-theme-scrollbar.css +30 -0
- package/docs/styles/clean-jsdoc-theme-without-scrollbar.min.css +1 -0
- package/docs/styles/clean-jsdoc-theme.min.css +1 -0
- package/docs/styles/jsdoc-default.css +692 -0
- package/docs/styles/prettify-jsdoc.css +111 -0
- package/docs/styles/prettify-tomorrow.css +132 -0
- package/jsdoc.json +13 -0
- package/package.json +27 -0
- package/publish.sh +21 -0
- package/src/index.js +758 -0
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
|
|
4
|
+
|
|
5
|
+
### [1.0.7](https://github.com/railroadmedia/musora-content-services/compare/v1.0.6...v1.0.7) (2024-08-10)
|
|
6
|
+
|
|
7
|
+
### [1.0.6](https://github.com/railroadmedia/musora-content-services/compare/v1.0.5...v1.0.6) (2024-08-09)
|
|
8
|
+
|
|
9
|
+
### [1.0.5](https://github.com/railroadmedia/musora-content-services/compare/v1.0.4...v1.0.5) (2024-08-09)
|
|
10
|
+
|
|
11
|
+
### [1.0.4](https://github.com/railroadmedia/musora-content-services/compare/v1.0.3...v1.0.4) (2024-08-09)
|
|
12
|
+
|
|
13
|
+
### [1.0.3](https://github.com/railroadmedia/musora-content-services/compare/v1.0.2...v1.0.3) (2024-08-09)
|
|
14
|
+
|
|
15
|
+
### [1.0.2](https://github.com/railroadmedia/musora-content-services/compare/v1.0.1...v1.0.2) (2024-08-08)
|
|
16
|
+
|
|
17
|
+
### 1.0.1 (2024-08-08)
|
package/README.md
ADDED
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# Musora Content Services
|
|
2
|
+
|
|
3
|
+
Welcome to the **musora-content-services** repository. This package provides a collection of utility functions designed to fetch and manage content from our Sanity Studio. These functions are tailored to interact with our Sanity backend, allowing you to easily retrieve, filter, and manipulate content for use in various applications.
|
|
4
|
+
|
|
5
|
+
## Features
|
|
6
|
+
|
|
7
|
+
- **Fetch Content by ID**: Retrieve specific content items using their unique Railcontent ID.
|
|
8
|
+
- **Fetch All Songs**: Get a list of all songs for a brand with pagination and search capabilities.
|
|
9
|
+
- **Filter Options**: Generate filtering options based on difficulty, genre, and more.
|
|
10
|
+
- **Fetch Related Content**: Easily fetch related lessons, songs, and content items.
|
|
11
|
+
- **Sanity Integration**: Simplified interaction with the Sanity API using customizable configurations.
|
|
12
|
+
|
|
13
|
+
## Installation
|
|
14
|
+
|
|
15
|
+
To install the package, use npm:
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
npm install musora-content-services
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## Publishing Package Updates
|
|
22
|
+
|
|
23
|
+
To publish a new version to NPM run,
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
./publish.sh
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
## Publish Documentation
|
|
30
|
+
|
|
31
|
+
This repo uses JSDoc to generate API documention. To update the docs, run:
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
npm run doc
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
## Github Page Documentation
|
|
38
|
+
|
|
39
|
+
https://railroadmedia.github.io/musora-content-services/
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"list":[{"title":"fetchAll","link":"<a href=\"global.html#fetchAll\">fetchAll</a>","description":"Fetch all content for a specific brand and type with pagination, search, and grouping options."},{"title":"fetchAllSongs","link":"<a href=\"global.html#fetchAllSongs\">fetchAllSongs</a>","description":"Fetch all songs for a specific brand with pagination and search options."},{"title":"fetchArtists","link":"<a href=\"global.html#fetchArtists\">fetchArtists</a>","description":"Fetch all artists with lessons available for a specific brand."},{"title":"fetchByRailContentId","link":"<a href=\"global.html#fetchByRailContentId\">fetchByRailContentId</a>","description":"Fetch content by a specific Railcontent ID."},{"title":"fetchByRailContentIds","link":"<a href=\"global.html#fetchByRailContentIds\">fetchByRailContentIds</a>","description":"Fetch content by an array of Railcontent IDs."},{"title":"fetchChildren","link":"<a href=\"global.html#fetchChildren\">fetchChildren</a>","description":"Fetch children content by Railcontent ID."},{"title":"fetchFilterOptions","link":"<a href=\"global.html#fetchFilterOptions\">fetchFilterOptions</a>","description":"Fetch filter options for a specific brand."},{"title":"fetchMethodChildren","link":"<a href=\"global.html#fetchMethodChildren\">fetchMethodChildren</a>","description":"Fetch all children of a specific method by Railcontent ID."},{"title":"fetchMethodNextLesson","link":"<a href=\"global.html#fetchMethodNextLesson\">fetchMethodNextLesson</a>","description":"Fetch the next lesson for a specific method by Railcontent ID."},{"title":"fetchNewReleases","link":"<a href=\"global.html#fetchNewReleases\">fetchNewReleases</a>","description":"Fetch the latest new releases for a specific brand."},{"title":"fetchNextPreviousLesson","link":"<a href=\"global.html#fetchNextPreviousLesson\">fetchNextPreviousLesson</a>","description":"Fetch the next and previous lessons for a specific lesson by Railcontent ID."},{"title":"fetchPackAll","link":"<a href=\"global.html#fetchPackAll\">fetchPackAll</a>","description":"Fetch all content for a specific pack by Railcontent ID."},{"title":"fetchPackChildren","link":"<a href=\"global.html#fetchPackChildren\">fetchPackChildren</a>","description":"Fetch all children of a specific pack by Railcontent ID."},{"title":"fetchRelatedLessons","link":"<a href=\"global.html#fetchRelatedLessons\">fetchRelatedLessons</a>","description":"Fetch related lessons for a specific lesson by Railcontent ID and type."},{"title":"fetchRelatedSongs","link":"<a href=\"global.html#fetchRelatedSongs\">fetchRelatedSongs</a>","description":"Fetch related songs for a specific brand and song ID."},{"title":"fetchSanity","link":"<a href=\"global.html#fetchSanity\">fetchSanity</a>","description":"Fetch data from the Sanity API based on a provided query."},{"title":"fetchSongById","link":"<a href=\"global.html#fetchSongById\">fetchSongById</a>","description":"Fetch a song by its document ID from Sanity."},{"title":"fetchSongCount","link":"<a href=\"global.html#fetchSongCount\">fetchSongCount</a>","description":"Fetch the total count of songs for a specific brand."},{"title":"fetchUpcomingEvents","link":"<a href=\"global.html#fetchUpcomingEvents\">fetchUpcomingEvents</a>","description":"Fetch upcoming events for a specific brand."},{"title":"fetchWorkouts","link":"<a href=\"global.html#fetchWorkouts\">fetchWorkouts</a>","description":"Fetch the latest workouts for the home page of a specific brand."}]}
|
|
Binary file
|
|
Binary file
|