hermes-io 2.2.5 → 2.2.6

package/README.md

@@ -4,8 +4,8 @@ A lightweight javascript library that allows communication between components by
 # Summary
 - [Installation](#installation)
 - [Get started](#get-started)
-- [Observers](#observers)
-- [Contexts](#contexts)
+- [Observer](#observer)
+- [Context](#context)
 - [useObserver](#useobserver-hook)
 - [notify](#notify)
 - Devtools (TODO)
@@ -19,7 +19,7 @@ npm i hermes-io --save
 # Get started
 `hermes-io` is a set of toolkits that combined allows communication between components let's explore every tool by following the `sneaker store example`:
 
-# Observers
+# Observer
 `hermes-io` provide an `Observer` class to create instances that can be `subscribable` that means many subscribers can listen for notifications on the instance by using the method `subscribe`, check the following example:
 
 We are exporting an `object` with two instances of the class `Observer` each key of the object has invidual propuses one for handle notifications about `add` a product and the other for `remove` a product.
@@ -34,7 +34,7 @@ export default {
 };
 ```
 
-# Contexts
+# Context
 `NOTICE` this concept has nothing to do with the `react context api`.
 
 `hermes-io` provide a `Context` class to create instances that can be used to create `notification context` that means that only notification 
@@ -89,7 +89,8 @@ productsStore.set('collection', sneakerList);
 |----------|-------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | observer | Observer instance | true     | An instance of the class Observer                                                                                                                               |
 | listener | Function          | true     | A standar javascript function                                                                                                                                   |
-| contexts | Array<Context>    | true     | An array of instances of the class Context, when a notification comes and is not signed with any of the contexts in the array the listener never will be called |
+| contexts | Context[]    | true     | An array of instances of the class Context, when a notification comes and is not signed with any of the contexts in the array the listener never will be called |
+
 
 ```javascript
  import { useObserver } from "hermes-io";
@@ -156,6 +157,7 @@ Is a method that allows sending notifications to the `subscribers` of a specific
 | value   | any     | true     | Payload with business information |
 | context | context | true     | A context instance                |
   
+
 ```javascript
 // ShoppingCar.js
 import ProductsObservers from './observers/products';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hermes-io",
-  "version": "2.2.5",
+  "version": "2.2.6",
   "description": "A lightweight javascript library that allows communication between Reactjs components by using the observer pattern and the hook api",
   "main": "index.js",
   "scripts": {

package/examples/sneaker-store/. quokka

@@ -1,25 +0,0 @@
-{
-  "babel": {
-    "presets": [
-      "react-app"
-    ]
-  },
-  "plugins": [
-    "alias-quokka-plugin",
-    "jsdom-quokka-plugin"
-  ],
-  "alias": {
-    "@core": "./src/core",
-    "@components": "./src/core/components",
-    "@contexts": "./src/core/contexts",
-    "@factory": "./src/core/factory",
-    "@hooks": "./src/core/hooks",
-    "@utils": "./src/core/utils",
-    "@libs": "./src/libs",
-    "@constants": "./src/core/constants",
-    "@translations": "./src/core/translations",
-    "@theme": "./src/core/theme",
-    "@routes": "./src/core/routes"
-  },
-  "node": "~/.nvm/versions/node/v16.18.1/bin/node"
-}

package/examples/sneaker-store/.editorconfig

@@ -1,32 +0,0 @@
-# EditorConfig is awesome: https://EditorConfig.org
-
-# top-most EditorConfig file
-root = true
-
-# Unix-style newlines with a newline ending every file
-[*]
-end_of_line = lf
-insert_final_newline = true
-
-# Matches multiple files with brace expansion notation
-# Set default charset
-[*.{js,py}]
-charset = utf-8
-
-# 4 space indentation
-[*.py]
-indent_style = space
-indent_size = 4
-
-# Tab indentation (no size specified)
-[Makefile]
-indent_style = tab
-
-# Indentation override for all JS under lib directory
-[*.js]
-indent_style = space
-indent_size = 2
-
-[{package.json,.travis.yml}]
-indent_style = space
-indent_size = 2

package/examples/sneaker-store/.eslintrc.js

@@ -1,24 +0,0 @@
-module.exports = {
-    "env": {
-        "browser": true,
-        "es2021": true
-    },
-    "extends": [
-        "eslint:recommended",
-        "plugin:react/recommended"
-    ],
-    "overrides": [
-    ],
-    "parserOptions": {
-        "ecmaVersion": "latest",
-        "sourceType": "module"
-    },
-    "plugins": [
-        "react"
-    ],
-    "rules": {
-        "react/prop-types": "off",
-        "no-unused-vars": 0,
-        "react/display-name": 0
-    }
-}

package/examples/sneaker-store/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2022 Esneyder Amin
-
-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/examples/sneaker-store/README.md

@@ -1 +0,0 @@
-# atomic-client

package/examples/sneaker-store/config-overrides.js

@@ -1,35 +0,0 @@
-const path = require("path");
-
-module.exports = {
-  webpack: function (config) {
-    config.devtool = "source-map";
-    config.resolve = {
-      extensions: [".js", ".html"],
-      alias: {
-        "@actions": path.resolve(__dirname, "src/core/actions"),
-        "@core": path.resolve(__dirname, "src/core"),
-        "@views": path.resolve(__dirname, "src/core/views"),
-        "@components": path.resolve(__dirname, "src/core/views/components"),
-        "@factory": path.resolve(__dirname, "src/core/factory"),
-        "@hooks": path.resolve(__dirname, "src/core/views/hooks"),
-        "@constants": path.resolve(__dirname, "src/core/constants"),
-        "@contexts": path.resolve(__dirname, "src/core/contexts"),
-        "@observers": path.resolve(__dirname, "src/core/observers"),
-        "@theme": path.resolve(__dirname, "src/core/theme"),
-        "@src": path.resolve(__dirname, "src"),
-        "hermes-io": path.resolve(__dirname, "../../"),
-        "react": path.resolve(__dirname, "../../node_modules/react"),
-      },
-    };
-    config.module.rules.push({
-      test: /\.js$/,
-      loader: "esbuild-loader",
-      options: {
-        loader: "jsx",
-        target: "es2020",
-      },
-    });
-    console.log(JSON.stringify(config));
-    return config;
-  },
-};

package/examples/sneaker-store/jsconfig.json

@@ -1,20 +0,0 @@
-{
-  "compilerOptions": {
-    "baseUrl": ".",
-    "paths": {
-      "actions/*": ["src/core/actions/*"],
-      "@core/*": ["src/core/*"],
-      "@views/*": ["src/core/views/*"],
-      "@components/*": ["src/core/views/components/*"],
-      "@factory/*": ["src/core/factory/*"],
-      "@hooks/*": ["src/core/views/hooks/*"],
-      "@constants": ["src/core/constants"],
-      "@observers/*": ["src/core/observers/*"],
-      "@contexts/*": ["src/core/contexts"],
-      "@src/*": ["src/*"],
-      "@hermes-io/*": ["../../*"],
-      "react": ["../../node_modules/react"]
-    }
-  },
-  "exclude": ["node_modules"]
-}