Merge pull request #70 from ExWeiv/dev

Docs Updated
ExWeiv · May 22, 2024 · be803a7 · be803a7
2 parents 02be9ef + a63764b
commit be803a7
Show file tree

Hide file tree

Showing 108 changed files with 322 additions and 313 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,9 +4,9 @@ In this file you can find what's changed in each version. (Versions with -dev, -
 
 ---
 
-### 4.1.1
+### 4.1.2
 
-- Documentation updated for custom connection options.
+- Documentation updated/fixed for custom connection options.
 
 ### 4.1.0
 

diff --git a/app/package-lock.json b/app/package-lock.json
diff --git a/app/package.json b/app/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@exweiv/weiv-data",
-  "version": "4.1.1",
+  "version": "4.1.2",
   "description": "Custom API Library for Wix sites to connect MongoDB. Designed to easily switch from wix-data APIs.",
   "main": "./lib/index.js",
   "files": [

diff --git a/app/weivdata.d.ts b/app/weivdata.d.ts
@@ -1841,32 +1841,38 @@ declare module '@exweiv/weiv-data' {
     namespace ConnectionOptionsJS {
         /**
          * @description
-         * Inside the `backend/WeivData/connection-options.js` file you can define three different variable and export them.
-         * These variables can be used to customize each role's MongoClient connection options like connection pool settings etc.
+         * Inside the `backend/WeivData/connection-options.js` file you can define three different factory function and export them.
+         * These factory functions can be used to customize each role's MongoClient connection options like connection pool settings etc.
          * 
          * @example
          * ```js
-         * export const adminClientOptions = {
+         * export const adminClientOptions = () => {
          *      // ... custom admin options here
+         *      return;
          * }
          * 
-         * export const memberClientOptions = {
+         * export const memberClientOptions = () => {
          *      // ... custom member options here
+         *      return;
          * }
          * 
-         * export const visitorClientOptions = {
+         * export const visitorClientOptions = () => {
          *      // ... custom visitor options here
+         *      return;
          * }
          * ```
          * 
          * You can also define custom cache options for all clients. These cache options define how to cache these clients. In most cases you don't need to play with this.
          * 
          * @example
          * ```js
-         * export const clientCacheRules = {
+         * export const clientCacheRules = () => {
          *      // ... custom client cache rules
+         *      return;
          * }
          * ```
+         * 
+         * > You can create async functions too (in case you need to fetch something before setting up things).
          */
         interface Options {
             /**
@@ -1875,31 +1881,31 @@ declare module '@exweiv/weiv-data' {
              * 
              * [Read more about MongoClientOptions](https://mongodb.github.io/node-mongodb-native/6.5/interfaces/MongoClientOptions.html)
              */
-            adminClientOptions: import('mongodb').MongoClientOptions;
+            adminClientOptions: () => import('mongodb').MongoClientOptions | Promise<import('mongodb').MongoClientOptions>;
 
             /**
              * @description
              * This is the same MongoClientOptions just like in MongoDB NodeJS driver, you can customize the member MongoClient options.
              * 
              * [Read more about MongoClientOptions](https://mongodb.github.io/node-mongodb-native/6.5/interfaces/MongoClientOptions.html)
              */
-            memberClientOptions: import('mongodb').MongoClientOptions;
+            memberClientOptions: () => import('mongodb').MongoClientOptions | Promise<import('mongodb').MongoClientOptions>;
 
             /**
              * @description
              * This is the same MongoClientOptions just like in MongoDB NodeJS driver, you can customize the visitor MongoClient options.
              * 
              * [Read more about MongoClientOptions](https://mongodb.github.io/node-mongodb-native/6.5/interfaces/MongoClientOptions.html)
              */
-            visitorClientOptions: import('mongodb').MongoClientOptions;
+            visitorClientOptions: () => import('mongodb').MongoClientOptions | Promise<import('mongodb').MongoClientOptions>;
 
             /**
              * @description
              * This is general cache rules for all MongoClients you can define `node-cache` options here. These options will apply to all roles clients.
              * 
              * [Read more about NodeCache.Options](https://github.com/node-cache/node-cache/blob/master/index.d.ts#L149)
              */
-            clientCacheRules: import('node-cache').Options;
+            clientCacheRules: () => import('node-cache').Options | Promise<import('node-cache').Options>;
         }
     }
 }
diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css
@@ -9,12 +9,12 @@
     --dark-hl-3: #C586C0;
     --light-hl-4: #0000FF;
     --dark-hl-4: #569CD6;
-    --light-hl-5: #0070C1;
-    --dark-hl-5: #4FC1FF;
+    --light-hl-5: #795E26;
+    --dark-hl-5: #DCDCAA;
     --light-hl-6: #008000;
     --dark-hl-6: #6A9955;
-    --light-hl-7: #795E26;
-    --dark-hl-7: #DCDCAA;
+    --light-hl-7: #0070C1;
+    --dark-hl-7: #4FC1FF;
     --light-hl-8: #098658;
     --dark-hl-8: #B5CEA8;
     --light-code-background: #FFFFFF;

diff --git a/docs/assets/search.js b/docs/assets/search.js
diff --git a/docs/functions/Hooks.afterCount.html b/docs/functions/Hooks.afterCount.html
@@ -3,10 +3,10 @@
 </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">context</span>: <a href="../types/Hooks.HookContext.html" class="tsd-signature-type tsd-kind-type-alias">HookContext</a></span><div class="tsd-comment tsd-typography"><p>Contextual information about the hook.</p>
 </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h4><p>The count to return to <code>count()</code> instead of the original count. Returning a rejected promise will not block the operation, but will return a rejected promise to the caller as well as trigger the <code>onFailure()</code> hook.</p>
 <div class="tsd-comment tsd-typography"><h4>Description</h4><p>A hook that is triggered after a <code>count()</code> operation.</p>
-</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ExWeiv/weiv-data/blob/ef0398fffe7e25ee09e9cf750301fe0f515c9754/app/weivdata.d.ts#L1533">weivdata.d.ts:1533</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>WeivData API Reference | ExWeiv Apps</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a><br>
+</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ExWeiv/weiv-data/blob/899bf4995523a40270d303dd79131bb4e3830102/app/weivdata.d.ts#L1533">weivdata.d.ts:1533</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>WeivData API Reference | ExWeiv Apps</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a><br>
             <span id="generation-date"></span>
             <script>
-                window.GENERATION_DATE = 1716415825183;
+                window.GENERATION_DATE = 1716416831113;
 
                 (() => {
 

diff --git a/docs/functions/Hooks.afterFindOne.html b/docs/functions/Hooks.afterFindOne.html
@@ -2,10 +2,10 @@
 </head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">WeivData API Reference | ExWeiv Apps</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">WeivData API Reference | ExWeiv Apps</a></li><li><a href="../modules/Hooks.html">Hooks</a></li><li><a href="Hooks.afterFindOne.html">afterFindOne</a></li></ul><h1>Function afterFindOne</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="afterFindOne" class="tsd-anchor"></a><span class="tsd-kind-call-signature">after<wbr/>Find<wbr/>One</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">item</span>, <span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Object</span><a href="#afterFindOne" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">item</span>: <a href="../types/Item.html" class="tsd-signature-type tsd-kind-type-alias">Item</a></span><div class="tsd-comment tsd-typography"><p>The found item.</p>
 </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">context</span>: <a href="../types/Hooks.HookContext.html" class="tsd-signature-type tsd-kind-type-alias">HookContext</a></span><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Object</span></h4><p>The item to return to <code>findOne()</code> instead of the found item. Returning a rejected promise will not block the operation, but will return a rejected promise to the caller as well as trigger the <code>onFailure()</code> hook.</p>
 <div class="tsd-comment tsd-typography"><h4>Description</h4><p>A hook that is triggered after a <code>findOne()</code> operation.</p>
-</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ExWeiv/weiv-data/blob/ef0398fffe7e25ee09e9cf750301fe0f515c9754/app/weivdata.d.ts#L1693">weivdata.d.ts:1693</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>WeivData API Reference | ExWeiv Apps</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a><br>
+</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ExWeiv/weiv-data/blob/899bf4995523a40270d303dd79131bb4e3830102/app/weivdata.d.ts#L1693">weivdata.d.ts:1693</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>WeivData API Reference | ExWeiv Apps</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a><br>
             <span id="generation-date"></span>
             <script>
-                window.GENERATION_DATE = 1716415825185;
+                window.GENERATION_DATE = 1716416831115;
 
                 (() => {