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.
Files changed (67) hide show
  1. package/CHANGELOG.md +17 -0
  2. package/README.md +39 -0
  3. package/docs/data/search.json +1 -0
  4. package/docs/fonts/Inconsolata-Regular.ttf +0 -0
  5. package/docs/fonts/OpenSans-Bold-webfont.eot +0 -0
  6. package/docs/fonts/OpenSans-Bold-webfont.svg +1830 -0
  7. package/docs/fonts/OpenSans-Bold-webfont.woff +0 -0
  8. package/docs/fonts/OpenSans-BoldItalic-webfont.eot +0 -0
  9. package/docs/fonts/OpenSans-BoldItalic-webfont.svg +1830 -0
  10. package/docs/fonts/OpenSans-BoldItalic-webfont.woff +0 -0
  11. package/docs/fonts/OpenSans-Italic-webfont.eot +0 -0
  12. package/docs/fonts/OpenSans-Italic-webfont.svg +1830 -0
  13. package/docs/fonts/OpenSans-Italic-webfont.woff +0 -0
  14. package/docs/fonts/OpenSans-Light-webfont.eot +0 -0
  15. package/docs/fonts/OpenSans-Light-webfont.svg +1831 -0
  16. package/docs/fonts/OpenSans-Light-webfont.woff +0 -0
  17. package/docs/fonts/OpenSans-LightItalic-webfont.eot +0 -0
  18. package/docs/fonts/OpenSans-LightItalic-webfont.svg +1835 -0
  19. package/docs/fonts/OpenSans-LightItalic-webfont.woff +0 -0
  20. package/docs/fonts/OpenSans-Regular-webfont.eot +0 -0
  21. package/docs/fonts/OpenSans-Regular-webfont.svg +1831 -0
  22. package/docs/fonts/OpenSans-Regular-webfont.woff +0 -0
  23. package/docs/fonts/OpenSans-Regular.ttf +0 -0
  24. package/docs/fonts/OpenSans-Semibold-webfont.eot +0 -0
  25. package/docs/fonts/OpenSans-Semibold-webfont.svg +1830 -0
  26. package/docs/fonts/OpenSans-Semibold-webfont.ttf +0 -0
  27. package/docs/fonts/OpenSans-Semibold-webfont.woff +0 -0
  28. package/docs/fonts/OpenSans-SemiboldItalic-webfont.eot +0 -0
  29. package/docs/fonts/OpenSans-SemiboldItalic-webfont.svg +1830 -0
  30. package/docs/fonts/OpenSans-SemiboldItalic-webfont.ttf +0 -0
  31. package/docs/fonts/OpenSans-SemiboldItalic-webfont.woff +0 -0
  32. package/docs/fonts/WorkSans-Bold.ttf +0 -0
  33. package/docs/global.html +4773 -0
  34. package/docs/index.html +93 -0
  35. package/docs/index.js.html +766 -0
  36. package/docs/scripts/core.js +726 -0
  37. package/docs/scripts/core.min.js +23 -0
  38. package/docs/scripts/linenumber.js +25 -0
  39. package/docs/scripts/prettify/Apache-License-2.0.txt +202 -0
  40. package/docs/scripts/prettify/lang-css.js +2 -0
  41. package/docs/scripts/prettify/prettify.js +28 -0
  42. package/docs/scripts/resize.js +90 -0
  43. package/docs/scripts/search.js +265 -0
  44. package/docs/scripts/search.min.js +6 -0
  45. package/docs/scripts/third-party/Apache-License-2.0.txt +202 -0
  46. package/docs/scripts/third-party/fuse.js +9 -0
  47. package/docs/scripts/third-party/hljs-line-num-original.js +369 -0
  48. package/docs/scripts/third-party/hljs-line-num.js +1 -0
  49. package/docs/scripts/third-party/hljs-original.js +5171 -0
  50. package/docs/scripts/third-party/hljs.js +1 -0
  51. package/docs/scripts/third-party/popper.js +5 -0
  52. package/docs/scripts/third-party/tippy.js +1 -0
  53. package/docs/scripts/third-party/tocbot.js +672 -0
  54. package/docs/scripts/third-party/tocbot.min.js +1 -0
  55. package/docs/styles/clean-jsdoc-theme-base.css +1159 -0
  56. package/docs/styles/clean-jsdoc-theme-dark.css +412 -0
  57. package/docs/styles/clean-jsdoc-theme-light.css +482 -0
  58. package/docs/styles/clean-jsdoc-theme-scrollbar.css +30 -0
  59. package/docs/styles/clean-jsdoc-theme-without-scrollbar.min.css +1 -0
  60. package/docs/styles/clean-jsdoc-theme.min.css +1 -0
  61. package/docs/styles/jsdoc-default.css +692 -0
  62. package/docs/styles/prettify-jsdoc.css +111 -0
  63. package/docs/styles/prettify-tomorrow.css +132 -0
  64. package/jsdoc.json +13 -0
  65. package/package.json +27 -0
  66. package/publish.sh +21 -0
  67. package/src/index.js +758 -0
package/docs/index.html ADDED
@@ -0,0 +1,93 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width,initial-scale=1">
6
+ <title>Home - Documentation</title>
7
+
8
+ <script src="scripts/prettify/prettify.js"></script>
9
+ <script src="scripts/prettify/lang-css.js"></script>
10
+ <!--[if lt IE 9]>
11
+ <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
12
+ <![endif]-->
13
+ <link type="text/css" rel="stylesheet" href="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css">
14
+ <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
15
+ <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
16
+ </head>
17
+ <body>
18
+
19
+ <input type="checkbox" id="nav-trigger" class="nav-trigger" />
20
+ <label for="nav-trigger" class="navicon-button x">
21
+ <div class="navicon"></div>
22
+ </label>
23
+
24
+ <label for="nav-trigger" class="overlay"></label>
25
+
26
+ <nav>
27
+ <li class="nav-link nav-home-link"><a href="index.html">Home</a></li><li class="nav-heading"><a href="global.html">Globals</a></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#fetchAll">fetchAll</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#fetchAllSongs">fetchAllSongs</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#fetchArtists">fetchArtists</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#fetchByRailContentId">fetchByRailContentId</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#fetchByRailContentIds">fetchByRailContentIds</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#fetchChildren">fetchChildren</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#fetchFilterOptions">fetchFilterOptions</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#fetchMethodChildren">fetchMethodChildren</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#fetchMethodNextLesson">fetchMethodNextLesson</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#fetchNewReleases">fetchNewReleases</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#fetchNextPreviousLesson">fetchNextPreviousLesson</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#fetchPackAll">fetchPackAll</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#fetchPackChildren">fetchPackChildren</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#fetchRelatedLessons">fetchRelatedLessons</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#fetchRelatedSongs">fetchRelatedSongs</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#fetchSanity">fetchSanity</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#fetchSongById">fetchSongById</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#fetchSongCount">fetchSongCount</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#fetchUpcomingEvents">fetchUpcomingEvents</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#fetchWorkouts">fetchWorkouts</a></span></li>
28
+ </nav>
29
+
30
+ <div id="main">
31
+
32
+
33
+
34
+
35
+
36
+
37
+
38
+
39
+
40
+
41
+
42
+
43
+
44
+
45
+
46
+
47
+
48
+
49
+
50
+ <section class="readme">
51
+ <article><h1>Musora Content Services</h1>
52
+ <p>Welcome to the <strong>musora-content-services</strong> 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.</p>
53
+ <h2>Features</h2>
54
+ <ul>
55
+ <li><strong>Fetch Content by ID</strong>: Retrieve specific content items using their unique Railcontent ID.</li>
56
+ <li><strong>Fetch All Songs</strong>: Get a list of all songs for a brand with pagination and search capabilities.</li>
57
+ <li><strong>Filter Options</strong>: Generate filtering options based on difficulty, genre, and more.</li>
58
+ <li><strong>Fetch Related Content</strong>: Easily fetch related lessons, songs, and content items.</li>
59
+ <li><strong>Sanity Integration</strong>: Simplified interaction with the Sanity API using customizable configurations.</li>
60
+ </ul>
61
+ <h2>Installation</h2>
62
+ <p>To install the package, use npm:</p>
63
+ <pre class="prettyprint source lang-bash"><code>npm install musora-content-services
64
+ </code></pre>
65
+ <h2>Publishing Package Updates</h2>
66
+ <p>To publish a new version to NPM run,</p>
67
+ <pre class="prettyprint source lang-bash"><code>./publish.sh
68
+ </code></pre>
69
+ <h2>Publish Documentation</h2>
70
+ <p>This repo uses JSDoc to generate API documention. To update the docs, run:</p>
71
+ <pre class="prettyprint source lang-bash"><code>npm run doc
72
+ </code></pre>
73
+ <h2>Github Page Documentation</h2>
74
+ <p>https://railroadmedia.github.io/musora-content-services/</p></article>
75
+ </section>
76
+
77
+
78
+
79
+
80
+
81
+
82
+ </div>
83
+
84
+ <br class="clear">
85
+
86
+ <footer>
87
+ Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Fri Aug 09 2024 20:57:53 GMT+0000 (Coordinated Universal Time) using the Minami theme.
88
+ </footer>
89
+
90
+ <script>prettyPrint();</script>
91
+ <script src="scripts/linenumber.js"></script>
92
+ </body>
93
+ </html>