@neonwilderness/ecjsonstorage 1.0.1

package/.env.example

@@ -0,0 +1,3 @@
+JSONAPI=apikey
+JSONSEC=securitykey
+JSONBIN=binkey

package/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0] - 2026-09-29
+- Initial release
+
+## [1.0.1] - 2026-09-30
+- Fix package.json main,exports,types
+- Enhance readme

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 NeonWilderness
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,49 @@
+# About ECJsonStorage
+ ECJsonStorage is a TS/JS wrapper to the [ExtendsClass JSON Storage API](https://extendsclass.com/json-storage.html) offering of Cyril Bois.
+
+ For API usage, you need a (free) API-Key for which you can apply [here](https://extendsclass.com/create-account-form).
+
+ ECJsonStorage enables you to create, update, patch and delete Bins, which store JSON data. There is a usage limit of
+ - 10.000 calls per month
+ - Bin size limit of 100kb
+ - total account limit of 10mb.
+
+# Installation
+
+- `npm i ecjsonstorage -S` to install the module, which is then both available as CommonJs and ESM version.
+
+- Create an .env file in your project directory root and add the following keys:
+
+  `JSONAPI=your ExtendsClass Api-key`
+
+  `JSONSEC=your self defined Security-key (recommended)`
+
+  The Security-key is used to protect access, modification and deletion of a bin. If a Security-key is passed during create, it will also be required to update, patch and delete this bin.
+
+  The Security-key is also required to request private bins (i.e. bins that were created with `keepPrivate=true`), but not required for public bins.
+
+# Usage
+
+ ## Constructor
+
+ ```
+ import { ECJsonStorage } from 'ecjsonstorage';
+ import { config } from 'dotenv-safe';
+ config();
+
+ const json = new ECJsonStorage(process.env.JSONAPI, process.env.JSONSEC);
+ ...
+ ```
+
+ ## Create a bin
+
+  `createBin(payload: object, keepPrivate: boolean)`
+
+ ```
+  const json = new ECJsonStorage(process.env.JSONAPI, process.env.JSONSEC);
+  const payload = { name: 'Neon', profession: 'IT-Consultant' };
+  const res = await json.createBin(payload, true);
+  console.log(res);
+ ```
+
+Further Documentation/Usage details will follow swiftly; for now you may wanna consult the [TS types file](dist/index.d.cts).

package/dist/index.cjs

@@ -0,0 +1,2 @@
+"use strict";var a=Object.defineProperty;var p=Object.getOwnPropertyDescriptor;var u=Object.getOwnPropertyNames;var h=Object.prototype.hasOwnProperty;var y=(i,t)=>{for(var e in t)a(i,e,{get:t[e],enumerable:!0})},l=(i,t,e,r)=>{if(t&&typeof t=="object"||typeof t=="function")for(let s of u(t))!h.call(i,s)&&s!==e&&a(i,s,{get:()=>t[s],enumerable:!(r=p(t,s))||r.enumerable});return i};var d=i=>l(a({},"__esModule",{value:!0}),i);var g={};y(g,{ECJsonStorage:()=>o});module.exports=d(g);var o=class{url;apiKey;securityKey;monthlyLimit=1e4;constructor(t,e,r){if(this.url=r||"https://json.extendsclass.com/bin",this.apiKey=t||"",this.securityKey=e||"",!this.url||!this.apiKey)throw new Error("Invalid constructor params!");for(;this.url.endsWith("/");)this.url=this.url.slice(0,-1)}validateResponse=async t=>{if(!t.ok)throw new Error(`HTTP error! Status: ${t.status}`);if((t.headers.get("content-type")||"").startsWith("text/html"))throw new Error(`Expected JSON but server returned HTML: "${(await t.text()).slice(0,100)}..."`)};getBins=async()=>{try{let t=await fetch(`${this.url}s`,{method:"GET",headers:{"Api-key":this.apiKey,Accept:"application/json"}});await this.validateResponse(t);let e=Number(t.headers.get("x-counter")),r=await t.json();return{status:"ok",callsDone:e,callsRemaining:this.monthlyLimit-e,bins:r}}catch(t){return console.error("getBins error:",t),{status:"error",statusText:t}}};getStats=async()=>{try{let t=await this.getBins();if(t.status==="error")throw new Error(`HTTP error! Status: ${t.statusText}`);return delete t.bins,t}catch(t){return console.error("getStats error:",t),{status:"error",statusText:t}}};getBin=async t=>{try{if(!t)throw new Error("Bin ID missing!");let e=await fetch(`${this.url}/${t}`,{method:"GET",headers:{"Security-key":this.securityKey,Accept:"application/json"}});return await this.validateResponse(e),{status:"ok",data:await e.json()}}catch(e){return console.error("getBin error:",e),{status:"error",statusText:e}}};createBin=async(t,e)=>{let r=new Headers({"Api-key":this.apiKey,"Security-key":this.securityKey,"Content-Type":"application/json",Accept:"application/json"});r.append("Private",e.toString());try{let s=await fetch(this.url,{method:"POST",headers:r,body:JSON.stringify(t)});await this.validateResponse(s);let{uri:c,bin:n}=await s.json();return n||(n=c.split("/").pop()),{status:"ok",uri:c,bin:n}}catch(s){return console.error("createBin error:",s),{status:"error",statusText:s}}};updateBin=async(t,e)=>{try{let r=await fetch(`${this.url}/${e}`,{method:"PUT",headers:{"Security-key":this.securityKey,"Content-Type":"application/json",Accept:"application/json"},body:JSON.stringify(t)});await this.validateResponse(r);let{data:s}=await r.json();return{status:"ok",data:s}}catch(r){return console.error("updateBin error:",r),{status:"error",statusText:r}}};patchBin=async(t,e)=>{try{let r=await fetch(`${this.url}/${e}`,{method:"PATCH",headers:{"Security-key":this.securityKey,"Content-Type":"application/merge-patch+json",Accept:"application/json"},body:JSON.stringify(t)});await this.validateResponse(r);let{data:s}=await r.json();return{status:"ok",data:s}}catch(r){return console.error("patchBin error:",r),{status:"error",statusText:r}}};deleteBin=async t=>{try{let e=await fetch(`${this.url}/${t}`,{method:"DELETE",headers:{"Security-key":this.securityKey,"Content-Type":"application/json",Accept:"application/json"}});await this.validateResponse(e);let{status:r}=await e.json();if(r!==0)throw new Error(`Bin delete failed with error: ${r.message}`);return{status:"ok"}}catch(e){return console.error("deleteBin error:",e),{status:"error",statusText:e}}}};0&&(module.exports={ECJsonStorage});
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["/**\r\n * ESJsonStorage class is a wrapper to the ExtendsClass JSON-Storage API\r\n */\r\nexport type resGetBins = {\r\n  status: 'ok';\r\n  callsDone: number;\r\n  callsRemaining: number;\r\n  bins?: string[];\r\n};\r\nexport type resGetStats = Omit<resGetBins, 'bins'>;\r\n\r\nexport type resGetBin = {\r\n  status: 'ok';\r\n  data: object;\r\n};\r\n\r\nexport type resUpdateBin = {\r\n  status: 'ok';\r\n  data: string;\r\n};\r\nexport type resPatchBin = resUpdateBin;\r\n\r\nexport type resCreateBin = {\r\n  status: 'ok';\r\n  uri: string;\r\n  bin: string;\r\n};\r\n\r\nexport type resDeleteBin = Omit<resGetBin, 'data'>;\r\n\r\nexport type resError = {\r\n  status: 'error';\r\n  statusText: string;\r\n};\r\n\r\nexport class ECJsonStorage {\r\n  url: string;\r\n  apiKey: string;\r\n  securityKey: string;\r\n  monthlyLimit: number = 10000;\r\n\r\n  constructor(apiKey: string, securityKey?: string, url?: string) {\r\n    this.url = url || 'https://json.extendsclass.com/bin';\r\n    this.apiKey = apiKey || '';\r\n    this.securityKey = securityKey || '';\r\n\r\n    if (!this.url || !this.apiKey) throw new Error('Invalid constructor params!');\r\n    while (this.url.endsWith('/')) {\r\n      this.url = this.url.slice(0, -1);\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Utility function to validate the response after the class function call\r\n   * @param response\r\n   */\r\n  validateResponse = async (response: Response) => {\r\n    if (!response.ok) {\r\n      throw new Error(`HTTP error! Status: ${response.status}`);\r\n    }\r\n\r\n    const contentType = response.headers.get('content-type') || '';\r\n    if (contentType.startsWith('text/html')) {\r\n      throw new Error(`Expected JSON but server returned HTML: \"${(await response.text()).slice(0, 100)}...\"`);\r\n    }\r\n  };\r\n\r\n  /**\r\n   * Get all bin IDs for a certain Api-key\r\n   * @returns {object} <resGetBins | resError>\r\n   */\r\n  getBins = async (): Promise<resGetBins | resError> => {\r\n    try {\r\n      const response = await fetch(`${this.url}s`, {\r\n        method: 'GET',\r\n        headers: {\r\n          'Api-key': this.apiKey,\r\n          Accept: 'application/json'\r\n        }\r\n      });\r\n\r\n      await this.validateResponse(response);\r\n\r\n      const counter = Number(response.headers.get('x-counter'));\r\n      const data = await response.json();\r\n      return {\r\n        status: 'ok',\r\n        callsDone: counter,\r\n        callsRemaining: this.monthlyLimit - counter,\r\n        bins: data\r\n      };\r\n    } catch (error) {\r\n      console.error('getBins error:', error);\r\n      return {\r\n        status: 'error',\r\n        statusText: <string>error\r\n      };\r\n    }\r\n  };\r\n\r\n  /**\r\n   * Syntactic sugar function for getBins to only return limit counter\r\n   * @returns {object} <resGetStats | resError>\r\n   */\r\n  getStats = async (): Promise<resGetStats | resError> => {\r\n    try {\r\n      const res = await this.getBins();\r\n      if (res.status === 'error') {\r\n        throw new Error(`HTTP error! Status: ${(<resError>res).statusText}`);\r\n      }\r\n\r\n      delete (<resGetBins>res).bins;\r\n      return <resGetStats>res;\r\n    } catch (error) {\r\n      console.error('getStats error:', error);\r\n      return {\r\n        status: 'error',\r\n        statusText: <string>error\r\n      };\r\n    }\r\n  };\r\n\r\n  /**\r\n   * Reads the content of a certain bin ID\r\n   * @param bin string Bin ID to read\r\n   * @returns {object} <resGetBin | resError>\r\n   */\r\n  getBin = async (bin: string): Promise<resGetBin | resError> => {\r\n    try {\r\n      if (!bin) throw new Error('Bin ID missing!');\r\n      const response = await fetch(`${this.url}/${bin}`, {\r\n        method: 'GET',\r\n        headers: {\r\n          'Security-key': this.securityKey,\r\n          Accept: 'application/json'\r\n        }\r\n      });\r\n\r\n      await this.validateResponse(response);\r\n\r\n      const data = await response.json();\r\n      return {\r\n        status: 'ok',\r\n        data\r\n      };\r\n    } catch (error) {\r\n      console.error('getBin error:', error);\r\n      return {\r\n        status: 'error',\r\n        statusText: <string>error\r\n      };\r\n    }\r\n  };\r\n\r\n  /**\r\n   * Creates a new bin and saves the given JSON payload to it\r\n   * @param payload {object} JSON object to create the bin with\r\n   * @param keepPrivate {boolean} TRUE=bin shall be kept private\r\n   * @returns {object} <resCreateBin | resError>\r\n   */\r\n  createBin = async (payload: object, keepPrivate: boolean): Promise<resCreateBin | resError> => {\r\n    const headers = new Headers({\r\n      'Api-key': this.apiKey,\r\n      'Security-key': this.securityKey,\r\n      'Content-Type': 'application/json',\r\n      Accept: 'application/json'\r\n    });\r\n    headers.append('Private', keepPrivate.toString());\r\n    try {\r\n      const response = await fetch(this.url, {\r\n        method: 'POST',\r\n        headers,\r\n        body: JSON.stringify(payload)\r\n      });\r\n\r\n      await this.validateResponse(response);\r\n\r\n      let { uri, bin } = await response.json();\r\n      if (!bin) bin = uri.split('/').pop();\r\n\r\n      return {\r\n        status: 'ok',\r\n        uri,\r\n        bin\r\n      };\r\n    } catch (error) {\r\n      console.error('createBin error:', error);\r\n      return {\r\n        status: 'error',\r\n        statusText: <string>error\r\n      };\r\n    }\r\n  };\r\n\r\n  /**\r\n   * Updates a certain bin with the given JSON object\r\n   * @param payload {object} JSON object to update the bin with\r\n   * @param bin string Bin ID to be updated\r\n   * @returns {object} <resUpdateBin | resError>\r\n   */\r\n  updateBin = async (payload: object, bin: string): Promise<resUpdateBin | resError> => {\r\n    try {\r\n      const response = await fetch(`${this.url}/${bin}`, {\r\n        method: 'PUT',\r\n        headers: {\r\n          'Security-key': this.securityKey,\r\n          'Content-Type': 'application/json',\r\n          Accept: 'application/json'\r\n        },\r\n        body: JSON.stringify(payload)\r\n      });\r\n\r\n      await this.validateResponse(response);\r\n\r\n      const { data } = await response.json();\r\n      return {\r\n        status: 'ok',\r\n        data\r\n      };\r\n    } catch (error) {\r\n      console.error('updateBin error:', error);\r\n      return {\r\n        status: 'error',\r\n        statusText: <string>error\r\n      };\r\n    }\r\n  };\r\n\r\n  /**\r\n   * Patches/inserts/changes a certain bin with the given JSON payload\r\n   * ref: \"Partially update JSON\" at https://extendsclass.com/json-storage.html#apiDocumentation\r\n   * @param payload {object} JSON object to patch the bin with\r\n   * @param bin string Bin ID to be patched\r\n   * @returns {object} <resPatchBin | resError>\r\n   */\r\n  patchBin = async (payload: object, bin: string): Promise<resPatchBin | resError> => {\r\n    try {\r\n      const response = await fetch(`${this.url}/${bin}`, {\r\n        method: 'PATCH',\r\n        headers: {\r\n          'Security-key': this.securityKey,\r\n          'Content-Type': 'application/merge-patch+json',\r\n          Accept: 'application/json'\r\n        },\r\n        body: JSON.stringify(payload)\r\n      });\r\n\r\n      await this.validateResponse(response);\r\n\r\n      const { data } = await response.json();\r\n      return {\r\n        status: 'ok',\r\n        data\r\n      };\r\n    } catch (error) {\r\n      console.error('patchBin error:', error);\r\n      return {\r\n        status: 'error',\r\n        statusText: <string>error\r\n      };\r\n    }\r\n  };\r\n\r\n  /**\r\n   * Deletes a certain bin\r\n   * @param bin string Bin ID to be deleted\r\n   * @returns {object} <resDeleteBin | resError>\r\n   */\r\n  deleteBin = async (bin: string): Promise<resDeleteBin | resError> => {\r\n    try {\r\n      const response = await fetch(`${this.url}/${bin}`, {\r\n        method: 'DELETE',\r\n        headers: {\r\n          'Security-key': this.securityKey,\r\n          'Content-Type': 'application/json',\r\n          Accept: 'application/json'\r\n        }\r\n      });\r\n\r\n      await this.validateResponse(response);\r\n\r\n      const { status } = await response.json();\r\n      if (status !== 0) throw new Error(`Bin delete failed with error: ${status.message}`);\r\n\r\n      return {\r\n        status: 'ok'\r\n      };\r\n    } catch (error) {\r\n      console.error('deleteBin error:', error);\r\n      return {\r\n        status: 'error',\r\n        statusText: <string>error\r\n      };\r\n    }\r\n  };\r\n}\r\n"],"mappings":"yaAAA,IAAAA,EAAA,GAAAC,EAAAD,EAAA,mBAAAE,IAAA,eAAAC,EAAAH,GAmCO,IAAME,EAAN,KAAoB,CACzB,IACA,OACA,YACA,aAAuB,IAEvB,YAAYE,EAAgBC,EAAsBC,EAAc,CAK9D,GAJA,KAAK,IAAMA,GAAO,oCAClB,KAAK,OAASF,GAAU,GACxB,KAAK,YAAcC,GAAe,GAE9B,CAAC,KAAK,KAAO,CAAC,KAAK,OAAQ,MAAM,IAAI,MAAM,6BAA6B,EAC5E,KAAO,KAAK,IAAI,SAAS,GAAG,GAC1B,KAAK,IAAM,KAAK,IAAI,MAAM,EAAG,EAAE,CAEnC,CAMA,iBAAmB,MAAOE,GAAuB,CAC/C,GAAI,CAACA,EAAS,GACZ,MAAM,IAAI,MAAM,uBAAuBA,EAAS,MAAM,EAAE,EAI1D,IADoBA,EAAS,QAAQ,IAAI,cAAc,GAAK,IAC5C,WAAW,WAAW,EACpC,MAAM,IAAI,MAAM,6CAA6C,MAAMA,EAAS,KAAK,GAAG,MAAM,EAAG,GAAG,CAAC,MAAM,CAE3G,EAMA,QAAU,SAA4C,CACpD,GAAI,CACF,IAAMA,EAAW,MAAM,MAAM,GAAG,KAAK,GAAG,IAAK,CAC3C,OAAQ,MACR,QAAS,CACP,UAAW,KAAK,OAChB,OAAQ,kBACV,CACF,CAAC,EAED,MAAM,KAAK,iBAAiBA,CAAQ,EAEpC,IAAMC,EAAU,OAAOD,EAAS,QAAQ,IAAI,WAAW,CAAC,EAClDE,EAAO,MAAMF,EAAS,KAAK,EACjC,MAAO,CACL,OAAQ,KACR,UAAWC,EACX,eAAgB,KAAK,aAAeA,EACpC,KAAMC,CACR,CACF,OAASC,EAAO,CACd,eAAQ,MAAM,iBAAkBA,CAAK,EAC9B,CACL,OAAQ,QACR,WAAoBA,CACtB,CACF,CACF,EAMA,SAAW,SAA6C,CACtD,GAAI,CACF,IAAMC,EAAM,MAAM,KAAK,QAAQ,EAC/B,GAAIA,EAAI,SAAW,QACjB,MAAM,IAAI,MAAM,uBAAkCA,EAAK,UAAU,EAAE,EAGrE,cAAoBA,EAAK,KACLA,CACtB,OAASD,EAAO,CACd,eAAQ,MAAM,kBAAmBA,CAAK,EAC/B,CACL,OAAQ,QACR,WAAoBA,CACtB,CACF,CACF,EAOA,OAAS,MAAOE,GAA+C,CAC7D,GAAI,CACF,GAAI,CAACA,EAAK,MAAM,IAAI,MAAM,iBAAiB,EAC3C,IAAML,EAAW,MAAM,MAAM,GAAG,KAAK,GAAG,IAAIK,CAAG,GAAI,CACjD,OAAQ,MACR,QAAS,CACP,eAAgB,KAAK,YACrB,OAAQ,kBACV,CACF,CAAC,EAED,aAAM,KAAK,iBAAiBL,CAAQ,EAG7B,CACL,OAAQ,KACR,KAHW,MAAMA,EAAS,KAAK,CAIjC,CACF,OAASG,EAAO,CACd,eAAQ,MAAM,gBAAiBA,CAAK,EAC7B,CACL,OAAQ,QACR,WAAoBA,CACtB,CACF,CACF,EAQA,UAAY,MAAOG,EAAiBC,IAA2D,CAC7F,IAAMC,EAAU,IAAI,QAAQ,CAC1B,UAAW,KAAK,OAChB,eAAgB,KAAK,YACrB,eAAgB,mBAChB,OAAQ,kBACV,CAAC,EACDA,EAAQ,OAAO,UAAWD,EAAY,SAAS,CAAC,EAChD,GAAI,CACF,IAAMP,EAAW,MAAM,MAAM,KAAK,IAAK,CACrC,OAAQ,OACR,QAAAQ,EACA,KAAM,KAAK,UAAUF,CAAO,CAC9B,CAAC,EAED,MAAM,KAAK,iBAAiBN,CAAQ,EAEpC,GAAI,CAAE,IAAAS,EAAK,IAAAJ,CAAI,EAAI,MAAML,EAAS,KAAK,EACvC,OAAKK,IAAKA,EAAMI,EAAI,MAAM,GAAG,EAAE,IAAI,GAE5B,CACL,OAAQ,KACR,IAAAA,EACA,IAAAJ,CACF,CACF,OAASF,EAAO,CACd,eAAQ,MAAM,mBAAoBA,CAAK,EAChC,CACL,OAAQ,QACR,WAAoBA,CACtB,CACF,CACF,EAQA,UAAY,MAAOG,EAAiBD,IAAkD,CACpF,GAAI,CACF,IAAML,EAAW,MAAM,MAAM,GAAG,KAAK,GAAG,IAAIK,CAAG,GAAI,CACjD,OAAQ,MACR,QAAS,CACP,eAAgB,KAAK,YACrB,eAAgB,mBAChB,OAAQ,kBACV,EACA,KAAM,KAAK,UAAUC,CAAO,CAC9B,CAAC,EAED,MAAM,KAAK,iBAAiBN,CAAQ,EAEpC,GAAM,CAAE,KAAAE,CAAK,EAAI,MAAMF,EAAS,KAAK,EACrC,MAAO,CACL,OAAQ,KACR,KAAAE,CACF,CACF,OAASC,EAAO,CACd,eAAQ,MAAM,mBAAoBA,CAAK,EAChC,CACL,OAAQ,QACR,WAAoBA,CACtB,CACF,CACF,EASA,SAAW,MAAOG,EAAiBD,IAAiD,CAClF,GAAI,CACF,IAAML,EAAW,MAAM,MAAM,GAAG,KAAK,GAAG,IAAIK,CAAG,GAAI,CACjD,OAAQ,QACR,QAAS,CACP,eAAgB,KAAK,YACrB,eAAgB,+BAChB,OAAQ,kBACV,EACA,KAAM,KAAK,UAAUC,CAAO,CAC9B,CAAC,EAED,MAAM,KAAK,iBAAiBN,CAAQ,EAEpC,GAAM,CAAE,KAAAE,CAAK,EAAI,MAAMF,EAAS,KAAK,EACrC,MAAO,CACL,OAAQ,KACR,KAAAE,CACF,CACF,OAASC,EAAO,CACd,eAAQ,MAAM,kBAAmBA,CAAK,EAC/B,CACL,OAAQ,QACR,WAAoBA,CACtB,CACF,CACF,EAOA,UAAY,MAAOE,GAAkD,CACnE,GAAI,CACF,IAAML,EAAW,MAAM,MAAM,GAAG,KAAK,GAAG,IAAIK,CAAG,GAAI,CACjD,OAAQ,SACR,QAAS,CACP,eAAgB,KAAK,YACrB,eAAgB,mBAChB,OAAQ,kBACV,CACF,CAAC,EAED,MAAM,KAAK,iBAAiBL,CAAQ,EAEpC,GAAM,CAAE,OAAAU,CAAO,EAAI,MAAMV,EAAS,KAAK,EACvC,GAAIU,IAAW,EAAG,MAAM,IAAI,MAAM,iCAAiCA,EAAO,OAAO,EAAE,EAEnF,MAAO,CACL,OAAQ,IACV,CACF,OAASP,EAAO,CACd,eAAQ,MAAM,mBAAoBA,CAAK,EAChC,CACL,OAAQ,QACR,WAAoBA,CACtB,CACF,CACF,CACF","names":["index_exports","__export","ECJsonStorage","__toCommonJS","apiKey","securityKey","url","response","counter","data","error","res","bin","payload","keepPrivate","headers","uri","status"]}

package/dist/index.d.cts

@@ -0,0 +1,87 @@
+/**
+ * ESJsonStorage class is a wrapper to the ExtendsClass JSON-Storage API
+ */
+type resGetBins = {
+    status: 'ok';
+    callsDone: number;
+    callsRemaining: number;
+    bins?: string[];
+};
+type resGetStats = Omit<resGetBins, 'bins'>;
+type resGetBin = {
+    status: 'ok';
+    data: object;
+};
+type resUpdateBin = {
+    status: 'ok';
+    data: string;
+};
+type resPatchBin = resUpdateBin;
+type resCreateBin = {
+    status: 'ok';
+    uri: string;
+    bin: string;
+};
+type resDeleteBin = Omit<resGetBin, 'data'>;
+type resError = {
+    status: 'error';
+    statusText: string;
+};
+declare class ECJsonStorage {
+    url: string;
+    apiKey: string;
+    securityKey: string;
+    monthlyLimit: number;
+    constructor(apiKey: string, securityKey?: string, url?: string);
+    /**
+     * Utility function to validate the response after the class function call
+     * @param response
+     */
+    validateResponse: (response: Response) => Promise<void>;
+    /**
+     * Get all bin IDs for a certain Api-key
+     * @returns {object} <resGetBins | resError>
+     */
+    getBins: () => Promise<resGetBins | resError>;
+    /**
+     * Syntactic sugar function for getBins to only return limit counter
+     * @returns {object} <resGetStats | resError>
+     */
+    getStats: () => Promise<resGetStats | resError>;
+    /**
+     * Reads the content of a certain bin ID
+     * @param bin string Bin ID to read
+     * @returns {object} <resGetBin | resError>
+     */
+    getBin: (bin: string) => Promise<resGetBin | resError>;
+    /**
+     * Creates a new bin and saves the given JSON payload to it
+     * @param payload {object} JSON object to create the bin with
+     * @param keepPrivate {boolean} TRUE=bin shall be kept private
+     * @returns {object} <resCreateBin | resError>
+     */
+    createBin: (payload: object, keepPrivate: boolean) => Promise<resCreateBin | resError>;
+    /**
+     * Updates a certain bin with the given JSON object
+     * @param payload {object} JSON object to update the bin with
+     * @param bin string Bin ID to be updated
+     * @returns {object} <resUpdateBin | resError>
+     */
+    updateBin: (payload: object, bin: string) => Promise<resUpdateBin | resError>;
+    /**
+     * Patches/inserts/changes a certain bin with the given JSON payload
+     * ref: "Partially update JSON" at https://extendsclass.com/json-storage.html#apiDocumentation
+     * @param payload {object} JSON object to patch the bin with
+     * @param bin string Bin ID to be patched
+     * @returns {object} <resPatchBin | resError>
+     */
+    patchBin: (payload: object, bin: string) => Promise<resPatchBin | resError>;
+    /**
+     * Deletes a certain bin
+     * @param bin string Bin ID to be deleted
+     * @returns {object} <resDeleteBin | resError>
+     */
+    deleteBin: (bin: string) => Promise<resDeleteBin | resError>;
+}
+
+export { ECJsonStorage, type resCreateBin, type resDeleteBin, type resError, type resGetBin, type resGetBins, type resGetStats, type resPatchBin, type resUpdateBin };

package/dist/index.js

@@ -0,0 +1,2 @@
+var a=class{url;apiKey;securityKey;monthlyLimit=1e4;constructor(t,e,r){if(this.url=r||"https://json.extendsclass.com/bin",this.apiKey=t||"",this.securityKey=e||"",!this.url||!this.apiKey)throw new Error("Invalid constructor params!");for(;this.url.endsWith("/");)this.url=this.url.slice(0,-1)}validateResponse=async t=>{if(!t.ok)throw new Error(`HTTP error! Status: ${t.status}`);if((t.headers.get("content-type")||"").startsWith("text/html"))throw new Error(`Expected JSON but server returned HTML: "${(await t.text()).slice(0,100)}..."`)};getBins=async()=>{try{let t=await fetch(`${this.url}s`,{method:"GET",headers:{"Api-key":this.apiKey,Accept:"application/json"}});await this.validateResponse(t);let e=Number(t.headers.get("x-counter")),r=await t.json();return{status:"ok",callsDone:e,callsRemaining:this.monthlyLimit-e,bins:r}}catch(t){return console.error("getBins error:",t),{status:"error",statusText:t}}};getStats=async()=>{try{let t=await this.getBins();if(t.status==="error")throw new Error(`HTTP error! Status: ${t.statusText}`);return delete t.bins,t}catch(t){return console.error("getStats error:",t),{status:"error",statusText:t}}};getBin=async t=>{try{if(!t)throw new Error("Bin ID missing!");let e=await fetch(`${this.url}/${t}`,{method:"GET",headers:{"Security-key":this.securityKey,Accept:"application/json"}});return await this.validateResponse(e),{status:"ok",data:await e.json()}}catch(e){return console.error("getBin error:",e),{status:"error",statusText:e}}};createBin=async(t,e)=>{let r=new Headers({"Api-key":this.apiKey,"Security-key":this.securityKey,"Content-Type":"application/json",Accept:"application/json"});r.append("Private",e.toString());try{let s=await fetch(this.url,{method:"POST",headers:r,body:JSON.stringify(t)});await this.validateResponse(s);let{uri:n,bin:i}=await s.json();return i||(i=n.split("/").pop()),{status:"ok",uri:n,bin:i}}catch(s){return console.error("createBin error:",s),{status:"error",statusText:s}}};updateBin=async(t,e)=>{try{let r=await fetch(`${this.url}/${e}`,{method:"PUT",headers:{"Security-key":this.securityKey,"Content-Type":"application/json",Accept:"application/json"},body:JSON.stringify(t)});await this.validateResponse(r);let{data:s}=await r.json();return{status:"ok",data:s}}catch(r){return console.error("updateBin error:",r),{status:"error",statusText:r}}};patchBin=async(t,e)=>{try{let r=await fetch(`${this.url}/${e}`,{method:"PATCH",headers:{"Security-key":this.securityKey,"Content-Type":"application/merge-patch+json",Accept:"application/json"},body:JSON.stringify(t)});await this.validateResponse(r);let{data:s}=await r.json();return{status:"ok",data:s}}catch(r){return console.error("patchBin error:",r),{status:"error",statusText:r}}};deleteBin=async t=>{try{let e=await fetch(`${this.url}/${t}`,{method:"DELETE",headers:{"Security-key":this.securityKey,"Content-Type":"application/json",Accept:"application/json"}});await this.validateResponse(e);let{status:r}=await e.json();if(r!==0)throw new Error(`Bin delete failed with error: ${r.message}`);return{status:"ok"}}catch(e){return console.error("deleteBin error:",e),{status:"error",statusText:e}}}};export{a as ECJsonStorage};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["/**\r\n * ESJsonStorage class is a wrapper to the ExtendsClass JSON-Storage API\r\n */\r\nexport type resGetBins = {\r\n  status: 'ok';\r\n  callsDone: number;\r\n  callsRemaining: number;\r\n  bins?: string[];\r\n};\r\nexport type resGetStats = Omit<resGetBins, 'bins'>;\r\n\r\nexport type resGetBin = {\r\n  status: 'ok';\r\n  data: object;\r\n};\r\n\r\nexport type resUpdateBin = {\r\n  status: 'ok';\r\n  data: string;\r\n};\r\nexport type resPatchBin = resUpdateBin;\r\n\r\nexport type resCreateBin = {\r\n  status: 'ok';\r\n  uri: string;\r\n  bin: string;\r\n};\r\n\r\nexport type resDeleteBin = Omit<resGetBin, 'data'>;\r\n\r\nexport type resError = {\r\n  status: 'error';\r\n  statusText: string;\r\n};\r\n\r\nexport class ECJsonStorage {\r\n  url: string;\r\n  apiKey: string;\r\n  securityKey: string;\r\n  monthlyLimit: number = 10000;\r\n\r\n  constructor(apiKey: string, securityKey?: string, url?: string) {\r\n    this.url = url || 'https://json.extendsclass.com/bin';\r\n    this.apiKey = apiKey || '';\r\n    this.securityKey = securityKey || '';\r\n\r\n    if (!this.url || !this.apiKey) throw new Error('Invalid constructor params!');\r\n    while (this.url.endsWith('/')) {\r\n      this.url = this.url.slice(0, -1);\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Utility function to validate the response after the class function call\r\n   * @param response\r\n   */\r\n  validateResponse = async (response: Response) => {\r\n    if (!response.ok) {\r\n      throw new Error(`HTTP error! Status: ${response.status}`);\r\n    }\r\n\r\n    const contentType = response.headers.get('content-type') || '';\r\n    if (contentType.startsWith('text/html')) {\r\n      throw new Error(`Expected JSON but server returned HTML: \"${(await response.text()).slice(0, 100)}...\"`);\r\n    }\r\n  };\r\n\r\n  /**\r\n   * Get all bin IDs for a certain Api-key\r\n   * @returns {object} <resGetBins | resError>\r\n   */\r\n  getBins = async (): Promise<resGetBins | resError> => {\r\n    try {\r\n      const response = await fetch(`${this.url}s`, {\r\n        method: 'GET',\r\n        headers: {\r\n          'Api-key': this.apiKey,\r\n          Accept: 'application/json'\r\n        }\r\n      });\r\n\r\n      await this.validateResponse(response);\r\n\r\n      const counter = Number(response.headers.get('x-counter'));\r\n      const data = await response.json();\r\n      return {\r\n        status: 'ok',\r\n        callsDone: counter,\r\n        callsRemaining: this.monthlyLimit - counter,\r\n        bins: data\r\n      };\r\n    } catch (error) {\r\n      console.error('getBins error:', error);\r\n      return {\r\n        status: 'error',\r\n        statusText: <string>error\r\n      };\r\n    }\r\n  };\r\n\r\n  /**\r\n   * Syntactic sugar function for getBins to only return limit counter\r\n   * @returns {object} <resGetStats | resError>\r\n   */\r\n  getStats = async (): Promise<resGetStats | resError> => {\r\n    try {\r\n      const res = await this.getBins();\r\n      if (res.status === 'error') {\r\n        throw new Error(`HTTP error! Status: ${(<resError>res).statusText}`);\r\n      }\r\n\r\n      delete (<resGetBins>res).bins;\r\n      return <resGetStats>res;\r\n    } catch (error) {\r\n      console.error('getStats error:', error);\r\n      return {\r\n        status: 'error',\r\n        statusText: <string>error\r\n      };\r\n    }\r\n  };\r\n\r\n  /**\r\n   * Reads the content of a certain bin ID\r\n   * @param bin string Bin ID to read\r\n   * @returns {object} <resGetBin | resError>\r\n   */\r\n  getBin = async (bin: string): Promise<resGetBin | resError> => {\r\n    try {\r\n      if (!bin) throw new Error('Bin ID missing!');\r\n      const response = await fetch(`${this.url}/${bin}`, {\r\n        method: 'GET',\r\n        headers: {\r\n          'Security-key': this.securityKey,\r\n          Accept: 'application/json'\r\n        }\r\n      });\r\n\r\n      await this.validateResponse(response);\r\n\r\n      const data = await response.json();\r\n      return {\r\n        status: 'ok',\r\n        data\r\n      };\r\n    } catch (error) {\r\n      console.error('getBin error:', error);\r\n      return {\r\n        status: 'error',\r\n        statusText: <string>error\r\n      };\r\n    }\r\n  };\r\n\r\n  /**\r\n   * Creates a new bin and saves the given JSON payload to it\r\n   * @param payload {object} JSON object to create the bin with\r\n   * @param keepPrivate {boolean} TRUE=bin shall be kept private\r\n   * @returns {object} <resCreateBin | resError>\r\n   */\r\n  createBin = async (payload: object, keepPrivate: boolean): Promise<resCreateBin | resError> => {\r\n    const headers = new Headers({\r\n      'Api-key': this.apiKey,\r\n      'Security-key': this.securityKey,\r\n      'Content-Type': 'application/json',\r\n      Accept: 'application/json'\r\n    });\r\n    headers.append('Private', keepPrivate.toString());\r\n    try {\r\n      const response = await fetch(this.url, {\r\n        method: 'POST',\r\n        headers,\r\n        body: JSON.stringify(payload)\r\n      });\r\n\r\n      await this.validateResponse(response);\r\n\r\n      let { uri, bin } = await response.json();\r\n      if (!bin) bin = uri.split('/').pop();\r\n\r\n      return {\r\n        status: 'ok',\r\n        uri,\r\n        bin\r\n      };\r\n    } catch (error) {\r\n      console.error('createBin error:', error);\r\n      return {\r\n        status: 'error',\r\n        statusText: <string>error\r\n      };\r\n    }\r\n  };\r\n\r\n  /**\r\n   * Updates a certain bin with the given JSON object\r\n   * @param payload {object} JSON object to update the bin with\r\n   * @param bin string Bin ID to be updated\r\n   * @returns {object} <resUpdateBin | resError>\r\n   */\r\n  updateBin = async (payload: object, bin: string): Promise<resUpdateBin | resError> => {\r\n    try {\r\n      const response = await fetch(`${this.url}/${bin}`, {\r\n        method: 'PUT',\r\n        headers: {\r\n          'Security-key': this.securityKey,\r\n          'Content-Type': 'application/json',\r\n          Accept: 'application/json'\r\n        },\r\n        body: JSON.stringify(payload)\r\n      });\r\n\r\n      await this.validateResponse(response);\r\n\r\n      const { data } = await response.json();\r\n      return {\r\n        status: 'ok',\r\n        data\r\n      };\r\n    } catch (error) {\r\n      console.error('updateBin error:', error);\r\n      return {\r\n        status: 'error',\r\n        statusText: <string>error\r\n      };\r\n    }\r\n  };\r\n\r\n  /**\r\n   * Patches/inserts/changes a certain bin with the given JSON payload\r\n   * ref: \"Partially update JSON\" at https://extendsclass.com/json-storage.html#apiDocumentation\r\n   * @param payload {object} JSON object to patch the bin with\r\n   * @param bin string Bin ID to be patched\r\n   * @returns {object} <resPatchBin | resError>\r\n   */\r\n  patchBin = async (payload: object, bin: string): Promise<resPatchBin | resError> => {\r\n    try {\r\n      const response = await fetch(`${this.url}/${bin}`, {\r\n        method: 'PATCH',\r\n        headers: {\r\n          'Security-key': this.securityKey,\r\n          'Content-Type': 'application/merge-patch+json',\r\n          Accept: 'application/json'\r\n        },\r\n        body: JSON.stringify(payload)\r\n      });\r\n\r\n      await this.validateResponse(response);\r\n\r\n      const { data } = await response.json();\r\n      return {\r\n        status: 'ok',\r\n        data\r\n      };\r\n    } catch (error) {\r\n      console.error('patchBin error:', error);\r\n      return {\r\n        status: 'error',\r\n        statusText: <string>error\r\n      };\r\n    }\r\n  };\r\n\r\n  /**\r\n   * Deletes a certain bin\r\n   * @param bin string Bin ID to be deleted\r\n   * @returns {object} <resDeleteBin | resError>\r\n   */\r\n  deleteBin = async (bin: string): Promise<resDeleteBin | resError> => {\r\n    try {\r\n      const response = await fetch(`${this.url}/${bin}`, {\r\n        method: 'DELETE',\r\n        headers: {\r\n          'Security-key': this.securityKey,\r\n          'Content-Type': 'application/json',\r\n          Accept: 'application/json'\r\n        }\r\n      });\r\n\r\n      await this.validateResponse(response);\r\n\r\n      const { status } = await response.json();\r\n      if (status !== 0) throw new Error(`Bin delete failed with error: ${status.message}`);\r\n\r\n      return {\r\n        status: 'ok'\r\n      };\r\n    } catch (error) {\r\n      console.error('deleteBin error:', error);\r\n      return {\r\n        status: 'error',\r\n        statusText: <string>error\r\n      };\r\n    }\r\n  };\r\n}\r\n"],"mappings":"AAmCO,IAAMA,EAAN,KAAoB,CACzB,IACA,OACA,YACA,aAAuB,IAEvB,YAAYC,EAAgBC,EAAsBC,EAAc,CAK9D,GAJA,KAAK,IAAMA,GAAO,oCAClB,KAAK,OAASF,GAAU,GACxB,KAAK,YAAcC,GAAe,GAE9B,CAAC,KAAK,KAAO,CAAC,KAAK,OAAQ,MAAM,IAAI,MAAM,6BAA6B,EAC5E,KAAO,KAAK,IAAI,SAAS,GAAG,GAC1B,KAAK,IAAM,KAAK,IAAI,MAAM,EAAG,EAAE,CAEnC,CAMA,iBAAmB,MAAOE,GAAuB,CAC/C,GAAI,CAACA,EAAS,GACZ,MAAM,IAAI,MAAM,uBAAuBA,EAAS,MAAM,EAAE,EAI1D,IADoBA,EAAS,QAAQ,IAAI,cAAc,GAAK,IAC5C,WAAW,WAAW,EACpC,MAAM,IAAI,MAAM,6CAA6C,MAAMA,EAAS,KAAK,GAAG,MAAM,EAAG,GAAG,CAAC,MAAM,CAE3G,EAMA,QAAU,SAA4C,CACpD,GAAI,CACF,IAAMA,EAAW,MAAM,MAAM,GAAG,KAAK,GAAG,IAAK,CAC3C,OAAQ,MACR,QAAS,CACP,UAAW,KAAK,OAChB,OAAQ,kBACV,CACF,CAAC,EAED,MAAM,KAAK,iBAAiBA,CAAQ,EAEpC,IAAMC,EAAU,OAAOD,EAAS,QAAQ,IAAI,WAAW,CAAC,EAClDE,EAAO,MAAMF,EAAS,KAAK,EACjC,MAAO,CACL,OAAQ,KACR,UAAWC,EACX,eAAgB,KAAK,aAAeA,EACpC,KAAMC,CACR,CACF,OAASC,EAAO,CACd,eAAQ,MAAM,iBAAkBA,CAAK,EAC9B,CACL,OAAQ,QACR,WAAoBA,CACtB,CACF,CACF,EAMA,SAAW,SAA6C,CACtD,GAAI,CACF,IAAMC,EAAM,MAAM,KAAK,QAAQ,EAC/B,GAAIA,EAAI,SAAW,QACjB,MAAM,IAAI,MAAM,uBAAkCA,EAAK,UAAU,EAAE,EAGrE,cAAoBA,EAAK,KACLA,CACtB,OAASD,EAAO,CACd,eAAQ,MAAM,kBAAmBA,CAAK,EAC/B,CACL,OAAQ,QACR,WAAoBA,CACtB,CACF,CACF,EAOA,OAAS,MAAOE,GAA+C,CAC7D,GAAI,CACF,GAAI,CAACA,EAAK,MAAM,IAAI,MAAM,iBAAiB,EAC3C,IAAML,EAAW,MAAM,MAAM,GAAG,KAAK,GAAG,IAAIK,CAAG,GAAI,CACjD,OAAQ,MACR,QAAS,CACP,eAAgB,KAAK,YACrB,OAAQ,kBACV,CACF,CAAC,EAED,aAAM,KAAK,iBAAiBL,CAAQ,EAG7B,CACL,OAAQ,KACR,KAHW,MAAMA,EAAS,KAAK,CAIjC,CACF,OAASG,EAAO,CACd,eAAQ,MAAM,gBAAiBA,CAAK,EAC7B,CACL,OAAQ,QACR,WAAoBA,CACtB,CACF,CACF,EAQA,UAAY,MAAOG,EAAiBC,IAA2D,CAC7F,IAAMC,EAAU,IAAI,QAAQ,CAC1B,UAAW,KAAK,OAChB,eAAgB,KAAK,YACrB,eAAgB,mBAChB,OAAQ,kBACV,CAAC,EACDA,EAAQ,OAAO,UAAWD,EAAY,SAAS,CAAC,EAChD,GAAI,CACF,IAAMP,EAAW,MAAM,MAAM,KAAK,IAAK,CACrC,OAAQ,OACR,QAAAQ,EACA,KAAM,KAAK,UAAUF,CAAO,CAC9B,CAAC,EAED,MAAM,KAAK,iBAAiBN,CAAQ,EAEpC,GAAI,CAAE,IAAAS,EAAK,IAAAJ,CAAI,EAAI,MAAML,EAAS,KAAK,EACvC,OAAKK,IAAKA,EAAMI,EAAI,MAAM,GAAG,EAAE,IAAI,GAE5B,CACL,OAAQ,KACR,IAAAA,EACA,IAAAJ,CACF,CACF,OAASF,EAAO,CACd,eAAQ,MAAM,mBAAoBA,CAAK,EAChC,CACL,OAAQ,QACR,WAAoBA,CACtB,CACF,CACF,EAQA,UAAY,MAAOG,EAAiBD,IAAkD,CACpF,GAAI,CACF,IAAML,EAAW,MAAM,MAAM,GAAG,KAAK,GAAG,IAAIK,CAAG,GAAI,CACjD,OAAQ,MACR,QAAS,CACP,eAAgB,KAAK,YACrB,eAAgB,mBAChB,OAAQ,kBACV,EACA,KAAM,KAAK,UAAUC,CAAO,CAC9B,CAAC,EAED,MAAM,KAAK,iBAAiBN,CAAQ,EAEpC,GAAM,CAAE,KAAAE,CAAK,EAAI,MAAMF,EAAS,KAAK,EACrC,MAAO,CACL,OAAQ,KACR,KAAAE,CACF,CACF,OAASC,EAAO,CACd,eAAQ,MAAM,mBAAoBA,CAAK,EAChC,CACL,OAAQ,QACR,WAAoBA,CACtB,CACF,CACF,EASA,SAAW,MAAOG,EAAiBD,IAAiD,CAClF,GAAI,CACF,IAAML,EAAW,MAAM,MAAM,GAAG,KAAK,GAAG,IAAIK,CAAG,GAAI,CACjD,OAAQ,QACR,QAAS,CACP,eAAgB,KAAK,YACrB,eAAgB,+BAChB,OAAQ,kBACV,EACA,KAAM,KAAK,UAAUC,CAAO,CAC9B,CAAC,EAED,MAAM,KAAK,iBAAiBN,CAAQ,EAEpC,GAAM,CAAE,KAAAE,CAAK,EAAI,MAAMF,EAAS,KAAK,EACrC,MAAO,CACL,OAAQ,KACR,KAAAE,CACF,CACF,OAASC,EAAO,CACd,eAAQ,MAAM,kBAAmBA,CAAK,EAC/B,CACL,OAAQ,QACR,WAAoBA,CACtB,CACF,CACF,EAOA,UAAY,MAAOE,GAAkD,CACnE,GAAI,CACF,IAAML,EAAW,MAAM,MAAM,GAAG,KAAK,GAAG,IAAIK,CAAG,GAAI,CACjD,OAAQ,SACR,QAAS,CACP,eAAgB,KAAK,YACrB,eAAgB,mBAChB,OAAQ,kBACV,CACF,CAAC,EAED,MAAM,KAAK,iBAAiBL,CAAQ,EAEpC,GAAM,CAAE,OAAAU,CAAO,EAAI,MAAMV,EAAS,KAAK,EACvC,GAAIU,IAAW,EAAG,MAAM,IAAI,MAAM,iCAAiCA,EAAO,OAAO,EAAE,EAEnF,MAAO,CACL,OAAQ,IACV,CACF,OAASP,EAAO,CACd,eAAQ,MAAM,mBAAoBA,CAAK,EAChC,CACL,OAAQ,QACR,WAAoBA,CACtB,CACF,CACF,CACF","names":["ECJsonStorage","apiKey","securityKey","url","response","counter","data","error","res","bin","payload","keepPrivate","headers","uri","status"]}

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@neonwilderness/ecjsonstorage",
+  "version": "1.0.1",
+  "description": "",
+  "main": "./dist/index.cjs",
+  "exports": "./dist/index.js",
+  "types": "./dist/index.d.cts",
+  "scripts": {
+    "update": "ncu -u -x typescript && npm i",
+    "build": "npm run build:js && npm run build:dts",
+    "build:js": "tsup src/*.ts --format esm,cjs --minify",
+    "build:dts": "tsup src/index.ts --dts-only",
+    "deleteAllBins": "node dist/deleteAllBins.cjs",
+    "test": "vitest"
+  },
+  "keywords": [
+    "ExtendsClass JSON-Storage API wrapper"
+  ],
+  "files": [
+    "dist/index.*",
+    "src/index.ts",
+    "test/*",
+    ".env.example",
+    "CHANGELOG.md",
+    "LICENSE",
+    "pack*.json",
+    "README.md"
+  ],
+  "type": "module",
+  "devDependencies": {
+    "@types/dotenv-safe": "^9.1.0",
+    "@types/node": "^26.6.3",
+    "dotenv": "^18.0.4",
+    "dotenv-safe": "^9.1.0",
+    "tsup": "^8.5.1",
+    "typescript": "^6.0.3",
+    "vitest": "^5.0.3"
+  },
+  "allowScripts": {
+    "esbuild@0.28.2": true
+  }
+}

package/src/index.ts

@@ -0,0 +1,296 @@
+/**
+ * ESJsonStorage class is a wrapper to the ExtendsClass JSON-Storage API
+ */
+export type resGetBins = {
+  status: 'ok';
+  callsDone: number;
+  callsRemaining: number;
+  bins?: string[];
+};
+export type resGetStats = Omit<resGetBins, 'bins'>;
+
+export type resGetBin = {
+  status: 'ok';
+  data: object;
+};
+
+export type resUpdateBin = {
+  status: 'ok';
+  data: string;
+};
+export type resPatchBin = resUpdateBin;
+
+export type resCreateBin = {
+  status: 'ok';
+  uri: string;
+  bin: string;
+};
+
+export type resDeleteBin = Omit<resGetBin, 'data'>;
+
+export type resError = {
+  status: 'error';
+  statusText: string;
+};
+
+export class ECJsonStorage {
+  url: string;
+  apiKey: string;
+  securityKey: string;
+  monthlyLimit: number = 10000;
+
+  constructor(apiKey: string, securityKey?: string, url?: string) {
+    this.url = url || 'https://json.extendsclass.com/bin';
+    this.apiKey = apiKey || '';
+    this.securityKey = securityKey || '';
+
+    if (!this.url || !this.apiKey) throw new Error('Invalid constructor params!');
+    while (this.url.endsWith('/')) {
+      this.url = this.url.slice(0, -1);
+    }
+  }
+
+  /**
+   * Utility function to validate the response after the class function call
+   * @param response
+   */
+  validateResponse = async (response: Response) => {
+    if (!response.ok) {
+      throw new Error(`HTTP error! Status: ${response.status}`);
+    }
+
+    const contentType = response.headers.get('content-type') || '';
+    if (contentType.startsWith('text/html')) {
+      throw new Error(`Expected JSON but server returned HTML: "${(await response.text()).slice(0, 100)}..."`);
+    }
+  };
+
+  /**
+   * Get all bin IDs for a certain Api-key
+   * @returns {object} <resGetBins | resError>
+   */
+  getBins = async (): Promise<resGetBins | resError> => {
+    try {
+      const response = await fetch(`${this.url}s`, {
+        method: 'GET',
+        headers: {
+          'Api-key': this.apiKey,
+          Accept: 'application/json'
+        }
+      });
+
+      await this.validateResponse(response);
+
+      const counter = Number(response.headers.get('x-counter'));
+      const data = await response.json();
+      return {
+        status: 'ok',
+        callsDone: counter,
+        callsRemaining: this.monthlyLimit - counter,
+        bins: data
+      };
+    } catch (error) {
+      console.error('getBins error:', error);
+      return {
+        status: 'error',
+        statusText: <string>error
+      };
+    }
+  };
+
+  /**
+   * Syntactic sugar function for getBins to only return limit counter
+   * @returns {object} <resGetStats | resError>
+   */
+  getStats = async (): Promise<resGetStats | resError> => {
+    try {
+      const res = await this.getBins();
+      if (res.status === 'error') {
+        throw new Error(`HTTP error! Status: ${(<resError>res).statusText}`);
+      }
+
+      delete (<resGetBins>res).bins;
+      return <resGetStats>res;
+    } catch (error) {
+      console.error('getStats error:', error);
+      return {
+        status: 'error',
+        statusText: <string>error
+      };
+    }
+  };
+
+  /**
+   * Reads the content of a certain bin ID
+   * @param bin string Bin ID to read
+   * @returns {object} <resGetBin | resError>
+   */
+  getBin = async (bin: string): Promise<resGetBin | resError> => {
+    try {
+      if (!bin) throw new Error('Bin ID missing!');
+      const response = await fetch(`${this.url}/${bin}`, {
+        method: 'GET',
+        headers: {
+          'Security-key': this.securityKey,
+          Accept: 'application/json'
+        }
+      });
+
+      await this.validateResponse(response);
+
+      const data = await response.json();
+      return {
+        status: 'ok',
+        data
+      };
+    } catch (error) {
+      console.error('getBin error:', error);
+      return {
+        status: 'error',
+        statusText: <string>error
+      };
+    }
+  };
+
+  /**
+   * Creates a new bin and saves the given JSON payload to it
+   * @param payload {object} JSON object to create the bin with
+   * @param keepPrivate {boolean} TRUE=bin shall be kept private
+   * @returns {object} <resCreateBin | resError>
+   */
+  createBin = async (payload: object, keepPrivate: boolean): Promise<resCreateBin | resError> => {
+    const headers = new Headers({
+      'Api-key': this.apiKey,
+      'Security-key': this.securityKey,
+      'Content-Type': 'application/json',
+      Accept: 'application/json'
+    });
+    headers.append('Private', keepPrivate.toString());
+    try {
+      const response = await fetch(this.url, {
+        method: 'POST',
+        headers,
+        body: JSON.stringify(payload)
+      });
+
+      await this.validateResponse(response);
+
+      let { uri, bin } = await response.json();
+      if (!bin) bin = uri.split('/').pop();
+
+      return {
+        status: 'ok',
+        uri,
+        bin
+      };
+    } catch (error) {
+      console.error('createBin error:', error);
+      return {
+        status: 'error',
+        statusText: <string>error
+      };
+    }
+  };
+
+  /**
+   * Updates a certain bin with the given JSON object
+   * @param payload {object} JSON object to update the bin with
+   * @param bin string Bin ID to be updated
+   * @returns {object} <resUpdateBin | resError>
+   */
+  updateBin = async (payload: object, bin: string): Promise<resUpdateBin | resError> => {
+    try {
+      const response = await fetch(`${this.url}/${bin}`, {
+        method: 'PUT',
+        headers: {
+          'Security-key': this.securityKey,
+          'Content-Type': 'application/json',
+          Accept: 'application/json'
+        },
+        body: JSON.stringify(payload)
+      });
+
+      await this.validateResponse(response);
+
+      const { data } = await response.json();
+      return {
+        status: 'ok',
+        data
+      };
+    } catch (error) {
+      console.error('updateBin error:', error);
+      return {
+        status: 'error',
+        statusText: <string>error
+      };
+    }
+  };
+
+  /**
+   * Patches/inserts/changes a certain bin with the given JSON payload
+   * ref: "Partially update JSON" at https://extendsclass.com/json-storage.html#apiDocumentation
+   * @param payload {object} JSON object to patch the bin with
+   * @param bin string Bin ID to be patched
+   * @returns {object} <resPatchBin | resError>
+   */
+  patchBin = async (payload: object, bin: string): Promise<resPatchBin | resError> => {
+    try {
+      const response = await fetch(`${this.url}/${bin}`, {
+        method: 'PATCH',
+        headers: {
+          'Security-key': this.securityKey,
+          'Content-Type': 'application/merge-patch+json',
+          Accept: 'application/json'
+        },
+        body: JSON.stringify(payload)
+      });
+
+      await this.validateResponse(response);
+
+      const { data } = await response.json();
+      return {
+        status: 'ok',
+        data
+      };
+    } catch (error) {
+      console.error('patchBin error:', error);
+      return {
+        status: 'error',
+        statusText: <string>error
+      };
+    }
+  };
+
+  /**
+   * Deletes a certain bin
+   * @param bin string Bin ID to be deleted
+   * @returns {object} <resDeleteBin | resError>
+   */
+  deleteBin = async (bin: string): Promise<resDeleteBin | resError> => {
+    try {
+      const response = await fetch(`${this.url}/${bin}`, {
+        method: 'DELETE',
+        headers: {
+          'Security-key': this.securityKey,
+          'Content-Type': 'application/json',
+          Accept: 'application/json'
+        }
+      });
+
+      await this.validateResponse(response);
+
+      const { status } = await response.json();
+      if (status !== 0) throw new Error(`Bin delete failed with error: ${status.message}`);
+
+      return {
+        status: 'ok'
+      };
+    } catch (error) {
+      console.error('deleteBin error:', error);
+      return {
+        status: 'error',
+        statusText: <string>error
+      };
+    }
+  };
+}

package/test/api.test.mts

@@ -0,0 +1,136 @@
+import { expect, test } from 'vitest';
+import {
+  ECJsonStorage,
+  type resGetBins,
+  type resGetBin,
+  type resCreateBin,
+  type resUpdateBin,
+  type resPatchBin
+} from '../src/index';
+import { config } from 'dotenv-safe';
+config();
+
+test('Rejects a constructor call with a missing Api-key', () => {
+  expect(() => {
+    const json = new ECJsonStorage('');
+  }).toThrow('Invalid constructor params!');
+});
+
+test('Fixes an alternative Api URL if it has ending slash/es', () => {
+  const json = new ECJsonStorage(process.env.JSONAPI!, process.env.JSONSEC!, 'https://other.com/api////');
+  expect(json.url).toBe('https://other.com/api');
+});
+
+test.only('Can construct a valid class', () => {
+  const json = new ECJsonStorage(process.env.JSONAPI!, process.env.JSONSEC!);
+  expect(json.url).toBe('https://json.extendsclass.com/bin');
+  expect(json.apiKey).toBe(process.env.JSONAPI);
+  expect(json.securityKey).toBe(process.env.JSONSEC);
+  expect(json.monthlyLimit).toBe(10000);
+});
+
+test('Can overwrite the API url if needed', () => {
+  const json = new ECJsonStorage(process.env.JSONAPI!, process.env.JSONSEC!, 'https://someotherapiurl.de');
+  expect(json.url).toBe('https://someotherapiurl.de');
+  expect(json.apiKey).toBe(process.env.JSONAPI);
+  expect(json.securityKey).toBe(process.env.JSONSEC);
+  expect(json.monthlyLimit).toBe(10000);
+});
+
+test('Can get all bins of an API Key', async () => {
+  const json = new ECJsonStorage(process.env.JSONAPI!, process.env.JSONSEC!);
+  const res = await json.getBins();
+  console.log(res);
+  expect(res.status).toBe('ok');
+  expect((res as resGetBins).callsDone).not.toBeNaN();
+  expect((res as resGetBins).callsDone).toBeGreaterThan(0);
+  expect((res as resGetBins).callsRemaining).not.toBeNaN();
+  expect((res as resGetBins).callsRemaining).toBeGreaterThan(0);
+  expect(Array.isArray((res as resGetBins).bins)).toBe(true);
+  expect((res as resGetBins).bins!.length).toBeGreaterThanOrEqual(0);
+});
+
+test('Can get the current limit state', async () => {
+  const json = new ECJsonStorage(process.env.JSONAPI!, process.env.JSONSEC!);
+  const res = await json.getStats();
+  console.log(res);
+  expect(res.status).toBe('ok');
+  expect((res as resGetBins).callsDone).not.toBeNaN();
+  expect((res as resGetBins).callsDone).toBeGreaterThan(0);
+  expect((res as resGetBins).callsRemaining).not.toBeNaN();
+  expect((res as resGetBins).callsRemaining).toBeGreaterThan(0);
+});
+
+test('Can get the content of a bin', async () => {
+  const json = new ECJsonStorage(process.env.JSONAPI!, process.env.JSONSEC!);
+  const res = await json.getBin(process.env.JSONBIN!);
+  console.log(res);
+  expect(res.status).toBe('ok');
+  expect(typeof (res as resGetBin).data).toBe('object');
+  expect(Object.keys((res as resGetBin).data).length).toBe(2);
+  expect(Object.keys((res as resGetBin).data)).toContain('name');
+  expect(Object.keys((res as resGetBin).data)).toContain('profession');
+});
+
+test('Can create a new bin', async () => {
+  const json = new ECJsonStorage(process.env.JSONAPI!, process.env.JSONSEC!);
+  const payload = { name: 'Neon', profession: 'IT-Consultant' };
+  const res = await json.createBin(payload, true);
+  console.log(res);
+  expect(res.status).toBe('ok');
+  expect(typeof (res as resCreateBin).uri).toBeTruthy();
+  expect(typeof (res as resCreateBin).bin).toBeTruthy();
+});
+
+interface payloadData {
+  name: string;
+  profession: string;
+}
+test('Can update/change the content of a bin', async () => {
+  const json = new ECJsonStorage(process.env.JSONAPI!, process.env.JSONSEC!);
+  const payload: payloadData = { name: 'NeonWilderness', profession: 'Web Ninja' };
+  const res = await json.updateBin(payload, process.env.JSONBIN!);
+  console.log(res);
+  expect(res.status).toBe('ok');
+  const dataParsed = JSON.parse((res as resUpdateBin).data);
+  expect(Object.keys(dataParsed).length).toBe(2);
+  expect(Object.keys(dataParsed)).toContain('name');
+  expect(Object.keys(dataParsed)).toContain('profession');
+  const { name, profession } = dataParsed as payloadData;
+  expect(name).toBe(payload.name);
+  expect(profession).toBe(payload.profession);
+});
+
+interface payloadPatched extends payloadData {
+  added: string;
+  times: number;
+}
+test('Can patch the content of a bin', async () => {
+  const json = new ECJsonStorage(process.env.JSONAPI!, process.env.JSONSEC!);
+  const payloadAdd = { added: 'IT-Consulting', times: 999 };
+  const res = await json.patchBin(payloadAdd, process.env.JSONBIN!);
+  console.log(res);
+  expect(res.status).toBe('ok');
+  const data = JSON.parse((res as resPatchBin).data);
+  expect(Object.keys(data).length).toBe(4);
+  expect(Object.keys(data)).toContain('name');
+  expect(Object.keys(data)).toContain('profession');
+  expect(Object.keys(data)).toContain('added');
+  expect(Object.keys(data)).toContain('times');
+  const { name, profession, added, times } = data as payloadPatched;
+  expect(name).toBe('NeonWilderness');
+  expect(profession).toBe('Web Ninja');
+  expect(added).toBe('IT-Consulting');
+  expect(times).toBe(999);
+});
+
+test('Can delete a bin', async () => {
+  const json = new ECJsonStorage(process.env.JSONAPI!, process.env.JSONSEC!);
+  const res1 = await json.createBin({ type: 'dummy' }, true);
+  expect(res1.status).toBe('ok');
+  const bin = (res1 as resCreateBin).bin;
+  expect(bin).toBeTruthy();
+  console.log(bin);
+  const res2 = await json.deleteBin(bin);
+  expect(res2.status).toBe('ok');
+});