@neonwilderness/ecjsonstorage 1.0.1 → 1.0.3

package/CHANGELOG.md

@@ -10,3 +10,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [1.0.1] - 2026-09-30
 - Fix package.json main,exports,types
 - Enhance readme
+
+## [1.0.2] - 2026-09-30
+- Also generate types for ESM version
+- Fix exports import|require in package.json
+
+## [1.0.3] - 2026-09-30
+- Change package name to @neonwilderness/ecjsonstorage
+- Adapt installation 

package/README.md

@@ -10,7 +10,7 @@
 
 # Installation
 
-- `npm i ecjsonstorage -S` to install the module, which is then both available as CommonJs and ESM version.
+- `npm i @neonwilderness/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:
 
@@ -27,7 +27,7 @@
  ## Constructor
 
  ```
- import { ECJsonStorage } from 'ecjsonstorage';
+ import { ECJsonStorage } from '@neonwilderness/ecjsonstorage';
  import { config } from 'dotenv-safe';
  config();
 
@@ -35,7 +35,7 @@
  ...
  ```
 
- ## Create a bin
+ ## Create a new bin
 
   `createBin(payload: object, keepPrivate: boolean)`
 
@@ -46,4 +46,4 @@
   console.log(res);
  ```
 
-Further Documentation/Usage details will follow swiftly; for now you may wanna consult the [TS types file](dist/index.d.cts).
+Further Documentation/Usage details will follow swiftly; for now you may wanna consult the [TS types file](dist/index.d.ts).

package/dist/index.d.ts

@@ -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/package.json

@@ -1,15 +1,25 @@
 {
   "name": "@neonwilderness/ecjsonstorage",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "",
   "main": "./dist/index.cjs",
-  "exports": "./dist/index.js",
+  "module": "./dist/index.js",
   "types": "./dist/index.d.cts",
+  "exports":  {
+    "import": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "require": {
+      "types": "./dist/index.d.cts",
+      "require": "./dist/index.cjs"
+    }
+  },
   "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",
+    "build:dts": "tsup src/index.ts --format esm,cjs --dts-only",
     "deleteAllBins": "node dist/deleteAllBins.cjs",
     "test": "vitest"
   },