collected-notes - npm Package Compare versions

Comparing version 2.0.3 to 2.1.0

dist/collected-notes.cjs.development.js

@@ -226,6 +226,5 @@ 'use strict';
  * @param {number} [page=1] - The page of the results, by default is `1`
- * @param {("public" | "public_site")} [visibility="public"] - The visibility of the notes you are trying to fetch.
  * @returns {Promise<{ site: Site; notes: Note[] }>} - An object with the site and the list of notes
  */
-var site = function site(sitePath, page, visibility) {
+var site = function site(sitePath, page) {
   if (page === void 0) {
@@ -236,4 +235,3 @@ page = 1;
   try {
-    var url = visibility ? "https://collectednotes.com/" + sitePath + ".json?page=" + page + "&visibility=" + visibility : "https://collectednotes.com/" + sitePath + ".json?page=" + page;
-    console.log(url);
+    var url = "https://collectednotes.com/" + sitePath + ".json?page=" + page;
     return Promise.resolve(fetch(url)).then(function (response) {
@@ -260,2 +258,32 @@ return Promise.resolve(response.json());
 function collectedNotes(email, token) {
+  /**
+   * Get the data of a site and their public notes.
+   * This method is public and doesn't require authentication.
+   * _This API is paginated._
+   *
+   * @function
+   * @async
+   * @param {string} sitePath - The path of the site (e.g. `blog`)
+   * @param {number} [page=1] - The page of the results, by default is `1`
+   * @param {NoteVisibility} [visibility] - The visibility of the notes you are trying to fetch.
+   * @returns {Promise<{ site: Site; notes: Note[] }>} - An object with the site and the list of notes
+   */
+  var site = function site(sitePath, page, visibility) {
+    if (page === void 0) {
+      page = 1;
+    }
+
+    try {
+      var url = visibility ? "https://collectednotes.com/" + sitePath + ".json?page=" + page + "&visibility=" + visibility : "https://collectednotes.com/" + sitePath + ".json?page=" + page;
+      return Promise.resolve(fetch(url, {
+        method: 'GET',
+        headers: headers
+      })).then(function (response) {
+        return Promise.resolve(response.json());
+      });
+    } catch (e) {
+      return Promise.reject(e);
+    }
+  };
+
   var links = function links(sitePath, notePath, format) {
@@ -262,0 +290,0 @@ if (format === void 0) {

dist/collected-notes.cjs.production.min.js

@@ -1,2 +0,2 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0});const e=function(){function e(){}return e.prototype.then=function(o,r){const n=new e,s=this.s;if(s){const e=1&s?o:r;if(e){try{t(n,1,e(this.v))}catch(e){t(n,2,e)}return n}return this}return this.o=function(e){try{const s=e.v;1&e.s?t(n,1,o?o(s):s):r?t(n,1,r(s)):t(n,2,s)}catch(e){t(n,2,e)}},n},e}();function t(o,r,n){if(!o.s){if(n instanceof e){if(!n.s)return void(n.o=t.bind(null,o,r));1&r&&(r=n.s),n=n.v}if(n&&n.then)return void n.then(t.bind(null,o,r),t.bind(null,o,2));o.s=r,o.v=n;const s=o.o;s&&s(o)}}"undefined"!=typeof Symbol&&(Symbol.iterator||(Symbol.iterator=Symbol("Symbol.iterator"))),"undefined"!=typeof Symbol&&(Symbol.asyncIterator||(Symbol.asyncIterator=Symbol("Symbol.asyncIterator")));var o=function(o,r,n){void 0===n&&(n="json");try{return Promise.resolve(function(o,r){var n,s=-1;e:{for(var i=0;i<r.length;i++){var c=r[i][0];if(c){var u=c();if(u&&u.then)break e;if(u===o){s=i;break}}else s=i}if(-1!==s){do{for(var h=r[s][1];!h;)s++,h=r[s][1];var l=h();if(l&&l.then){n=!0;break e}var f=r[s][2];s++}while(f&&!f());return l}}const d=new e,m=t.bind(null,d,2);return(n?l.then(a):u.then((function e(n){for(;;){if(n===o){s=i;break}if(++i===r.length){if(-1!==s)break;return void t(d,1,h)}if(c=r[i][0]){if((n=c())&&n.then)return void n.then(e).then(void 0,m)}else s=i}do{for(var u=r[s][1];!u;)s++,u=r[s][1];var h=u();if(h&&h.then)return void h.then(a).then(void 0,m);var l=r[s][2];s++}while(l&&!l());t(d,1,h)}))).then(void 0,m),d;function a(e){for(;;){var o=r[s][2];if(!o||o())break;s++;for(var n=r[s][1];!n;)s++,n=r[s][1];if((e=n())&&e.then)return void e.then(a).then(void 0,m)}t(d,1,e)}}(n,[[function(){return"json"},function(){return Promise.resolve(fetch("https://collectednotes.com/"+o+"/"+r+".json")).then((function(e){return Promise.resolve(e.json())}))}],[function(){return"md"},function(){return Promise.resolve(fetch("https://collectednotes.com/"+o+"/"+r+".md")).then((function(e){return Promise.resolve(e.text())}))}],[function(){return"txt"},function(){return Promise.resolve(fetch("https://collectednotes.com/"+o+"/"+r+".text")).then((function(e){return Promise.resolve(e.text())}))}]]))}catch(e){return Promise.reject(e)}},r=function(e,t,o){void 0===t&&(t=1);try{var r=o?"https://collectednotes.com/"+e+".json?page="+t+"&visibility="+o:"https://collectednotes.com/"+e+".json?page="+t;return console.log(r),Promise.resolve(fetch(r)).then((function(e){return Promise.resolve(e.json())}))}catch(e){return Promise.reject(e)}};exports.collectedNotes=function(e,t){var n={Authorization:e+" "+t,Accept:"application/json","Content-Type":"application/json"};return{latestNotes:function(e,t,o){void 0===t&&(t=1);try{return Promise.resolve(fetch(o?"https://collectednotes.com/sites/"+e+"/notes?page="+t+"&visibility="+o:"https://collectednotes.com/sites/"+e+"/notes?page="+t,{headers:n})).then((function(e){return Promise.resolve(e.json())}))}catch(e){return Promise.reject(e)}},sites:function(){try{return Promise.resolve(fetch("https://collectednotes.com/sites",{headers:n})).then((function(e){return Promise.resolve(e.json())}))}catch(e){return Promise.reject(e)}},site:r,create:function(e,t){try{return Promise.resolve(fetch(t?"https://collectednotes.com/sites/"+t+"/notes":"https://collectednotes.com/notes/add",{method:"POST",headers:n,body:JSON.stringify({note:{body:e.body,visibility:e.visibility}})})).then((function(e){return Promise.resolve(e.json())}))}catch(e){return Promise.reject(e)}},read:o,update:function(e,t,o){try{return Promise.resolve(fetch("https://collectednotes.com/sites/"+e+"/notes/"+t,{method:"POST",headers:n,body:JSON.stringify({note:{body:o.body,visibility:o.visibility}})})).then((function(e){return Promise.resolve(e.json())}))}catch(e){return Promise.reject(e)}},destroy:function(e,t){try{return Promise.resolve(fetch("https://collectednotes.com/sites/"+e+"/notes/"+t,{headers:n,method:"DELETE"})).then((function(){}))}catch(e){return Promise.reject(e)}},me:function(){try{return Promise.resolve(fetch("https://collectednotes.com/accounts/me",{headers:n})).then((function(e){return Promise.resolve(e.json())}))}catch(e){return Promise.reject(e)}},reorder:function(e,t){try{return Promise.resolve(fetch("https://collectednotes.com/sites/"+e+"/notes/reorder",{method:"POST",headers:n,body:JSON.stringify({ids:t})})).then((function(e){return Promise.resolve(e.json())}))}catch(e){return Promise.reject(e)}},search:function(e,t,o,r){void 0===o&&(o=1);try{var s=encodeURI(t);return Promise.resolve(fetch(r?"https://collectednotes.com/sites/"+e+"/notes/search?term="+s+"&page="+o+"&visibility="+r:"https://collectednotes.com/sites/"+e+"/notes/search?term="+s+"&page="+o,{method:"GET",headers:n})).then((function(e){return Promise.resolve(e.json())}))}catch(e){return Promise.reject(e)}},body:function(e,t){try{return Promise.resolve(fetch("https://collectednotes.com/"+e+"/"+t+"/body",{method:"GET",headers:n})).then((function(e){return Promise.resolve(e.json())}))}catch(e){return Promise.reject(e)}},links:function(e,t,o){void 0===o&&(o="json");try{return Promise.resolve(fetch("https://collectednotes.com/sites/"+e+"/notes/"+t+"/links"+("json"===o?".json":""),{method:"GET",headers:n})).then((function(e){return Promise.resolve(e.json())}))}catch(e){return Promise.reject(e)}}}},exports.read=o,exports.site=r;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0});const e=function(){function e(){}return e.prototype.then=function(o,r){const n=new e,s=this.s;if(s){const e=1&s?o:r;if(e){try{t(n,1,e(this.v))}catch(e){t(n,2,e)}return n}return this}return this.o=function(e){try{const s=e.v;1&e.s?t(n,1,o?o(s):s):r?t(n,1,r(s)):t(n,2,s)}catch(e){t(n,2,e)}},n},e}();function t(o,r,n){if(!o.s){if(n instanceof e){if(!n.s)return void(n.o=t.bind(null,o,r));1&r&&(r=n.s),n=n.v}if(n&&n.then)return void n.then(t.bind(null,o,r),t.bind(null,o,2));o.s=r,o.v=n;const s=o.o;s&&s(o)}}"undefined"!=typeof Symbol&&(Symbol.iterator||(Symbol.iterator=Symbol("Symbol.iterator"))),"undefined"!=typeof Symbol&&(Symbol.asyncIterator||(Symbol.asyncIterator=Symbol("Symbol.asyncIterator")));var o=function(o,r,n){void 0===n&&(n="json");try{return Promise.resolve(function(o,r){var n,s=-1;e:{for(var i=0;i<r.length;i++){var c=r[i][0];if(c){var u=c();if(u&&u.then)break e;if(u===o){s=i;break}}else s=i}if(-1!==s){do{for(var h=r[s][1];!h;)s++,h=r[s][1];var l=h();if(l&&l.then){n=!0;break e}var f=r[s][2];s++}while(f&&!f());return l}}const d=new e,m=t.bind(null,d,2);return(n?l.then(a):u.then((function e(n){for(;;){if(n===o){s=i;break}if(++i===r.length){if(-1!==s)break;return void t(d,1,h)}if(c=r[i][0]){if((n=c())&&n.then)return void n.then(e).then(void 0,m)}else s=i}do{for(var u=r[s][1];!u;)s++,u=r[s][1];var h=u();if(h&&h.then)return void h.then(a).then(void 0,m);var l=r[s][2];s++}while(l&&!l());t(d,1,h)}))).then(void 0,m),d;function a(e){for(;;){var o=r[s][2];if(!o||o())break;s++;for(var n=r[s][1];!n;)s++,n=r[s][1];if((e=n())&&e.then)return void e.then(a).then(void 0,m)}t(d,1,e)}}(n,[[function(){return"json"},function(){return Promise.resolve(fetch("https://collectednotes.com/"+o+"/"+r+".json")).then((function(e){return Promise.resolve(e.json())}))}],[function(){return"md"},function(){return Promise.resolve(fetch("https://collectednotes.com/"+o+"/"+r+".md")).then((function(e){return Promise.resolve(e.text())}))}],[function(){return"txt"},function(){return Promise.resolve(fetch("https://collectednotes.com/"+o+"/"+r+".text")).then((function(e){return Promise.resolve(e.text())}))}]]))}catch(e){return Promise.reject(e)}};exports.collectedNotes=function(e,t){var r={Authorization:e+" "+t,Accept:"application/json","Content-Type":"application/json"};return{latestNotes:function(e,t,o){void 0===t&&(t=1);try{return Promise.resolve(fetch(o?"https://collectednotes.com/sites/"+e+"/notes?page="+t+"&visibility="+o:"https://collectednotes.com/sites/"+e+"/notes?page="+t,{headers:r})).then((function(e){return Promise.resolve(e.json())}))}catch(e){return Promise.reject(e)}},sites:function(){try{return Promise.resolve(fetch("https://collectednotes.com/sites",{headers:r})).then((function(e){return Promise.resolve(e.json())}))}catch(e){return Promise.reject(e)}},site:function(e,t,o){void 0===t&&(t=1);try{return Promise.resolve(fetch(o?"https://collectednotes.com/"+e+".json?page="+t+"&visibility="+o:"https://collectednotes.com/"+e+".json?page="+t,{method:"GET",headers:r})).then((function(e){return Promise.resolve(e.json())}))}catch(e){return Promise.reject(e)}},create:function(e,t){try{return Promise.resolve(fetch(t?"https://collectednotes.com/sites/"+t+"/notes":"https://collectednotes.com/notes/add",{method:"POST",headers:r,body:JSON.stringify({note:{body:e.body,visibility:e.visibility}})})).then((function(e){return Promise.resolve(e.json())}))}catch(e){return Promise.reject(e)}},read:o,update:function(e,t,o){try{return Promise.resolve(fetch("https://collectednotes.com/sites/"+e+"/notes/"+t,{method:"POST",headers:r,body:JSON.stringify({note:{body:o.body,visibility:o.visibility}})})).then((function(e){return Promise.resolve(e.json())}))}catch(e){return Promise.reject(e)}},destroy:function(e,t){try{return Promise.resolve(fetch("https://collectednotes.com/sites/"+e+"/notes/"+t,{headers:r,method:"DELETE"})).then((function(){}))}catch(e){return Promise.reject(e)}},me:function(){try{return Promise.resolve(fetch("https://collectednotes.com/accounts/me",{headers:r})).then((function(e){return Promise.resolve(e.json())}))}catch(e){return Promise.reject(e)}},reorder:function(e,t){try{return Promise.resolve(fetch("https://collectednotes.com/sites/"+e+"/notes/reorder",{method:"POST",headers:r,body:JSON.stringify({ids:t})})).then((function(e){return Promise.resolve(e.json())}))}catch(e){return Promise.reject(e)}},search:function(e,t,o,n){void 0===o&&(o=1);try{var s=encodeURI(t);return Promise.resolve(fetch(n?"https://collectednotes.com/sites/"+e+"/notes/search?term="+s+"&page="+o+"&visibility="+n:"https://collectednotes.com/sites/"+e+"/notes/search?term="+s+"&page="+o,{method:"GET",headers:r})).then((function(e){return Promise.resolve(e.json())}))}catch(e){return Promise.reject(e)}},body:function(e,t){try{return Promise.resolve(fetch("https://collectednotes.com/"+e+"/"+t+"/body",{method:"GET",headers:r})).then((function(e){return Promise.resolve(e.json())}))}catch(e){return Promise.reject(e)}},links:function(e,t,o){void 0===o&&(o="json");try{return Promise.resolve(fetch("https://collectednotes.com/sites/"+e+"/notes/"+t+"/links"+("json"===o?".json":""),{method:"GET",headers:r})).then((function(e){return Promise.resolve(e.json())}))}catch(e){return Promise.reject(e)}}}},exports.read=o,exports.site=function(e,t){void 0===t&&(t=1);try{return Promise.resolve(fetch("https://collectednotes.com/"+e+".json?page="+t)).then((function(e){return Promise.resolve(e.json())}))}catch(e){return Promise.reject(e)}};
 //# sourceMappingURL=collected-notes.cjs.production.min.js.map

dist/collected-notes.esm.js

@@ -222,6 +222,5 @@ // A type of promise-like that resolves synchronously and supports only one observer
  * @param {number} [page=1] - The page of the results, by default is `1`
- * @param {("public" | "public_site")} [visibility="public"] - The visibility of the notes you are trying to fetch.
  * @returns {Promise<{ site: Site; notes: Note[] }>} - An object with the site and the list of notes
  */
-var site = function site(sitePath, page, visibility) {
+var site = function site(sitePath, page) {
   if (page === void 0) {
@@ -232,4 +231,3 @@ page = 1;
   try {
-    var url = visibility ? "https://collectednotes.com/" + sitePath + ".json?page=" + page + "&visibility=" + visibility : "https://collectednotes.com/" + sitePath + ".json?page=" + page;
-    console.log(url);
+    var url = "https://collectednotes.com/" + sitePath + ".json?page=" + page;
     return Promise.resolve(fetch(url)).then(function (response) {
@@ -256,2 +254,32 @@ return Promise.resolve(response.json());
 function collectedNotes(email, token) {
+  /**
+   * Get the data of a site and their public notes.
+   * This method is public and doesn't require authentication.
+   * _This API is paginated._
+   *
+   * @function
+   * @async
+   * @param {string} sitePath - The path of the site (e.g. `blog`)
+   * @param {number} [page=1] - The page of the results, by default is `1`
+   * @param {NoteVisibility} [visibility] - The visibility of the notes you are trying to fetch.
+   * @returns {Promise<{ site: Site; notes: Note[] }>} - An object with the site and the list of notes
+   */
+  var site = function site(sitePath, page, visibility) {
+    if (page === void 0) {
+      page = 1;
+    }
+
+    try {
+      var url = visibility ? "https://collectednotes.com/" + sitePath + ".json?page=" + page + "&visibility=" + visibility : "https://collectednotes.com/" + sitePath + ".json?page=" + page;
+      return Promise.resolve(fetch(url, {
+        method: 'GET',
+        headers: headers
+      })).then(function (response) {
+        return Promise.resolve(response.json());
+      });
+    } catch (e) {
+      return Promise.reject(e);
+    }
+  };
+
   var links = function links(sitePath, notePath, format) {
@@ -258,0 +286,0 @@ if (format === void 0) {

dist/index.d.ts

@@ -360,3 +360,6 @@ /**
     readonly sites: () => Promise<Site[]>;
-    readonly site: typeof site;
+    readonly site: (sitePath: string, page?: number, visibility?: "private" | "public" | "public_unlisted" | "public_site" | undefined) => Promise<{
+        site: Site;
+        notes: Note[];
+    }>;
     readonly create: (note: {
@@ -394,6 +397,5 @@ body: string;
  * @param {number} [page=1] - The page of the results, by default is `1`
- * @param {("public" | "public_site")} [visibility="public"] - The visibility of the notes you are trying to fetch.
  * @returns {Promise<{ site: Site; notes: Note[] }>} - An object with the site and the list of notes
  */
-export declare function site(sitePath: string, page?: number, visibility?: Extract<NoteVisibility, 'public' | 'public_site'>): Promise<{
+export declare function site(sitePath: string, page?: number): Promise<{
     site: Site;
@@ -400,0 +402,0 @@ notes: Note[];

package.json

 {
   "name": "collected-notes",
   "description": "API wrapper for Collected Notes",
-  "version": "2.0.3",
+  "version": "2.1.0",
   "license": "MIT",
@@ -6,0 +6,0 @@ "author": "Sergio Xalambrí",

No alert changes

Improved metrics

Total package byte prevSize

229972

increased by2.2%

Lines of code

2207

increased by3.42%

Worsened metrics

Number of medium supply chain risk alerts

45

increased by7.14%

No dependency changes