ai-ebm-assistant-v4 0.0.2 → 0.0.3

package/README.md

@@ -1 +1,141 @@
-# Feature Writer
+# emb-ai
+
+## Project Description
+This project appears to be a web application, likely built with Preact and Vite, featuring an AI Assistant component. It includes custom component generation templates using Plop.
+
+## Setup
+
+### Prerequisites
+- Node.js (v14 or higher recommended)
+- npm or yarn
+
+### Installation
+
+1. Clone the repository:
+   ```bash
+   git clone <repository_url>
+   cd emb-ai
+   ```
+2. Install dependencies:
+   ```bash
+   npm install
+   # or yarn install
+   ```
+
+## Available Scripts
+
+In the project directory, you can run:
+
+### `npm run dev`
+Runs the app in development mode.
+Open [http://localhost:5173](http://localhost:5173) to view it in the browser.
+
+The page will reload if you make edits.
+You will also see any lint errors in the console.
+
+### `npm run build`
+Builds the app for production to the `dist` folder.
+It correctly bundles Preact in production mode and optimizes the build for the best performance.
+
+The build is minified and the filenames include the hashes.
+Your app is ready to be deployed!
+
+### `npm run preview`
+Locally previews the production build.
+
+### `npm run generate`
+Runs Plop to generate new components or atoms based on templates.
+
+## Technologies Used
+
+-   **Preact**: A fast 3.5kB alternative to React with the same ES6 API.
+-   **Vite**: A next-generation frontend tooling that provides an extremely fast development experience.
+-   **Axios**: Promise-based HTTP client for the browser and Node.js.
+-   **Plop**: A micro-generator framework that makes it easy to create new components, modules, or any other repetitive code.
+-   **Node.js**: JavaScript runtime environment.
+-   **npm / Yarn**: Package managers for JavaScript.
+
+## Publishing to NPM
+
+This project's components are designed to be published as an NPM package. There are two primary ways to publish updates:
+
+### Manual Publishing
+
+Follow these steps for a manual publishing process:
+
+1.  **Build and Commit**: First, build the library and commit your changes.
+    ```bash
+    npm run build
+    git add .
+    git commit -m 'Your descriptive commit message'
+    ```
+2.  **Update Version**: Increment the package version using one of the following commands:
+    -   `npm version patch`: For bug fixes.
+    -   `npm version minor`: For a new component addition.
+    -   `npm version major`: For a completed feature.
+3.  **NPM Login**: Log in to your NPM account (if not already logged in).
+    ```bash
+    npm login
+    ```
+4.  **Publish**: Publish the package to NPM.
+    ```bash
+    npm publish --access public
+    ```
+5.  **Verify**: Check the version update on the NPM website after publishing.
+
+### Automated Publishing with `publish.sh`
+
+To automate the publishing process, you can use the provided `publish.sh` script. Follow these steps:
+
+1.  **Set NPM Credentials (Securely!)**: Before running the script, ensure your NPM username, password, and email are set as environment variables. **DO NOT hardcode them in the script or commit them to version control.**
+    ```bash
+    export NPM_USERNAME="your_username"
+    export NPM_PASSWORD="your_password"
+    export NPM_EMAIL="your_email@example.com"
+    ```
+2.  **Run the Publish Script**: Execute the `publish.sh` script. This will:
+    -   Install npm dependencies.
+    -   Stage and commit changes (with a default message).
+    -   Automatically increment the package version (patch).
+    -   Build the library.
+    -   Log in to NPM using the provided environment variables.
+    -   Publish the package to NPM with public access.
+    ```bash
+    ./publish.sh
+    ```
+3.  **Verify**: Check the version update on the NPM website after publishing.
+
+For more details on manual publishing, refer to the [NPM documentation](https://docs.npmjs.com/creating-and-publishing-scoped-public-packages).
+
+## API Structure
+
+The project primarily uses `fetch` and `axios` for making API calls. A generic `AxiosCall` utility is available in `src/components/aiAssistant/components/logger/logger.jsx` which can be used for various HTTP methods.
+
+-   **Read Operations**:
+    -   Examples like `https://arangodbservice.dev.ainqaplatform.in/api/read_qdmqueries` are used with `POST` requests to fetch data based on specific filters and `queryid`s.
+    -   Data retrieval often involves passing a `db_name` and a `filter` object in the request body.
+
+-   **Create, Update, Delete Operations**:
+    -   While a generic `AxiosCall` exists, explicit examples of dedicated `PUT`, `DELETE`, or `POST` for creation (beyond logging) were not found in the initial scan.
+    -   It is assumed that new APIs for these operations would leverage the `AxiosCall` utility with appropriate HTTP methods (`POST` for create, `PUT` for update, `DELETE` for delete).
+
+-   **Pagination**:
+    -   Current API calls do not explicitly include pagination parameters such as `offset`, `limit`, `page`, or `size`.
+    -   **Recommendation**: For any API endpoints designed to retrieve a collection of resources ("get all" APIs), it is recommended to implement pagination. A suggested default structure would include `offset` (defaulting to 0) and `limit` (defaulting to 10) parameters to control the number of results returned and the starting point of the collection. The API should also return the `overall count` of items available.
+
+## Project Structure (Initial Observations)
+- `src/`: Contains the main application source code.
+  - `app.jsx`: Serves as a playground for developing and testing components in isolation before they are packaged for NPM. It's where new components are integrated and demonstrated.
+  - `main.jsx`: Main application entry point for the development server.
+  - `components/`: Reusable UI components, intended to be part of the published NPM package.
+    - `aiAssistant/`: A significant part of the application, likely an AI-powered chat or assistant interface.
+  - `atoms/`: Potentially smaller, more granular components or state management entities.
+  - `assets/`: Static assets like images or SVGs.
+  - `store/`: Suggests state management (e.g., Zustand, Redux, Context API).
+- `plop-templates/`: Templates for generating new code using Plop.
+- `dist/`: Output directory for production builds.
+- `vite.config.js`: Vite configuration file.
+- `package.json`: Project dependencies and scripts.
+
+## Vite Library Mode
+This project leverages Vite's library mode (`vite build --watch --mode library`) to build components into a shareable NPM package. This configuration optimizes the output for library consumption, making it easy to integrate these components into other projects. The `app.jsx` serves as a development playground to test these components during their creation.

package/dist/{html2canvas-b6751efe.mjs → html2canvas-b8e5c938.mjs}

@@ -1,4 +1,4 @@
-import { g as c, r as f } from "./index-9407a038.mjs";
+import { g as c, r as f } from "./index-10c86437.mjs";
 function l(r, n) {
   for (var o = 0; o < n.length; o++) {
     const e = n[o];

package/dist/{index-9407a038.mjs → index-10c86437.mjs}

@@ -22654,11 +22654,15 @@ function require_domCreate() {
     return n ? t.createElement(Be) : {};
   }, _domCreate;
 }
-var _ie8DomDefine = !require_descriptors() && !_fails(function() {
-  return Object.defineProperty(require_domCreate()("div"), "a", { get: function() {
-    return 7;
-  } }).a != 7;
-}), isObject$3 = _isObject, _toPrimitive = function(e, t) {
+var _ie8DomDefine, hasRequired_ie8DomDefine;
+function require_ie8DomDefine() {
+  return hasRequired_ie8DomDefine || (hasRequired_ie8DomDefine = 1, _ie8DomDefine = !require_descriptors() && !_fails(function() {
+    return Object.defineProperty(require_domCreate()("div"), "a", { get: function() {
+      return 7;
+    } }).a != 7;
+  })), _ie8DomDefine;
+}
+var isObject$3 = _isObject, _toPrimitive = function(e, t) {
   if (!isObject$3(e))
     return e;
   var n, Be;
@@ -22670,7 +22674,7 @@ function require_objectDp() {
   if (hasRequired_objectDp)
     return _objectDp;
   hasRequired_objectDp = 1;
-  var e = _anObject, t = _ie8DomDefine, n = _toPrimitive, Be = Object.defineProperty;
+  var e = _anObject, t = require_ie8DomDefine(), n = _toPrimitive, Be = Object.defineProperty;
   return _objectDp.f = require_descriptors() ? Object.defineProperty : function(Ee, Oe, Re) {
     if (e(Ee), Oe = n(Oe, !0), e(Re), t)
       try {
@@ -22781,12 +22785,14 @@ var _sharedExports = _shared.exports, id$1 = 0, px = Math.random(), _uid = funct
   for (; t.length > Be; )
     has$5(n, Ee = t[Be++]) && (~arrayIndexOf(Ce, Ee) || Ce.push(Ee));
   return Ce;
-}, _enumBugKeys = "constructor,hasOwnProperty,isPrototypeOf,propertyIsEnumerable,toLocaleString,toString,valueOf".split(","), $keys$1 = _objectKeysInternal, enumBugKeys$1 = _enumBugKeys, _objectKeys = Object.keys || function(t) {
-  return $keys$1(t, enumBugKeys$1);
+}, _enumBugKeys = "constructor,hasOwnProperty,isPrototypeOf,propertyIsEnumerable,toLocaleString,toString,valueOf".split(","), $keys$2 = _objectKeysInternal, enumBugKeys$1 = _enumBugKeys, _objectKeys = Object.keys || function(t) {
+  return $keys$2(t, enumBugKeys$1);
 }, _objectGops = {};
 _objectGops.f = Object.getOwnPropertySymbols;
-var _objectPie = {};
-_objectPie.f = {}.propertyIsEnumerable;
+var _objectPie = {}, hasRequired_objectPie;
+function require_objectPie() {
+  return hasRequired_objectPie || (hasRequired_objectPie = 1, _objectPie.f = {}.propertyIsEnumerable), _objectPie;
+}
 var defined$1 = _defined, _toObject = function(e) {
   return Object(defined$1(e));
 }, _objectAssign, hasRequired_objectAssign;
@@ -22794,7 +22800,7 @@ function require_objectAssign() {
   if (hasRequired_objectAssign)
     return _objectAssign;
   hasRequired_objectAssign = 1;
-  var e = require_descriptors(), t = _objectKeys, n = _objectGops, Be = _objectPie, Ce = _toObject, Ee = require_iobject(), Oe = Object.assign;
+  var e = require_descriptors(), t = _objectKeys, n = _objectGops, Be = require_objectPie(), Ce = _toObject, Ee = require_iobject(), Oe = Object.assign;
   return _objectAssign = !Oe || _fails(function() {
     var Re = {}, Te = {}, Ue = Symbol(), Qe = "abcdefghijklmnopqrst";
     return Re[Ue] = 7, Qe.split("").forEach(function(Me) {
@@ -23002,7 +23008,7 @@ var iterator$2 = _wksExt.f("iterator"), iterator$1 = { default: iterator$2, __es
 }, _metaExports = _meta.exports, core = _coreExports, wksExt$1 = _wksExt, defineProperty = require_objectDp().f, _wksDefine = function(e) {
   var t = core.Symbol || (core.Symbol = {});
   e.charAt(0) != "_" && !(e in t) && defineProperty(t, e, { value: wksExt$1.f(e) });
-}, getKeys = _objectKeys, gOPS = _objectGops, pIE$1 = _objectPie, _enumKeys = function(e) {
+}, getKeys = _objectKeys, gOPS = _objectGops, pIE$1 = require_objectPie(), _enumKeys = function(e) {
   var t = getKeys(e), n = gOPS.f;
   if (n)
     for (var Be = n(e), Ce = pIE$1.f, Ee = 0, Oe; Be.length > Ee; )
@@ -23010,17 +23016,11 @@ var iterator$2 = _wksExt.f("iterator"), iterator$1 = { default: iterator$2, __es
   return t;
 }, cof = _cof, _isArray = Array.isArray || function(t) {
   return cof(t) == "Array";
-}, _objectGopnExt = {}, _objectGopn = {}, hasRequired_objectGopn;
-function require_objectGopn() {
-  if (hasRequired_objectGopn)
-    return _objectGopn;
-  hasRequired_objectGopn = 1;
-  var e = _objectKeysInternal, t = _enumBugKeys.concat("length", "prototype");
-  return _objectGopn.f = Object.getOwnPropertyNames || function(Be) {
-    return e(Be, t);
-  }, _objectGopn;
-}
-var toIObject$2 = _toIobject, gOPN$1 = require_objectGopn().f, toString$3 = {}.toString, windowNames = typeof window == "object" && window && Object.getOwnPropertyNames ? Object.getOwnPropertyNames(window) : [], getWindowNames = function(e) {
+}, _objectGopnExt = {}, _objectGopn = {}, $keys$1 = _objectKeysInternal, hiddenKeys = _enumBugKeys.concat("length", "prototype");
+_objectGopn.f = Object.getOwnPropertyNames || function(t) {
+  return $keys$1(t, hiddenKeys);
+};
+var toIObject$2 = _toIobject, gOPN$1 = _objectGopn.f, toString$3 = {}.toString, windowNames = typeof window == "object" && window && Object.getOwnPropertyNames ? Object.getOwnPropertyNames(window) : [], getWindowNames = function(e) {
   try {
     return gOPN$1(e);
   } catch {
@@ -23030,7 +23030,7 @@ var toIObject$2 = _toIobject, gOPN$1 = require_objectGopn().f, toString$3 = {}.t
 _objectGopnExt.f = function(t) {
   return windowNames && toString$3.call(t) == "[object Window]" ? getWindowNames(t) : gOPN$1(toIObject$2(t));
 };
-var _objectGopd = {}, pIE = _objectPie, createDesc$1 = _propertyDesc, toIObject$1 = _toIobject, toPrimitive$1 = _toPrimitive, has$1 = _has$1, IE8_DOM_DEFINE = _ie8DomDefine, gOPD$1 = Object.getOwnPropertyDescriptor;
+var _objectGopd = {}, pIE = require_objectPie(), createDesc$1 = _propertyDesc, toIObject$1 = _toIobject, toPrimitive$1 = _toPrimitive, has$1 = _has$1, IE8_DOM_DEFINE = require_ie8DomDefine(), gOPD$1 = Object.getOwnPropertyDescriptor;
 _objectGopd.f = require_descriptors() ? gOPD$1 : function(t, n) {
   if (t = toIObject$1(t), n = toPrimitive$1(n, !0), IE8_DOM_DEFINE)
     try {
@@ -23091,7 +23091,7 @@ USE_NATIVE || ($Symbol = function() {
   return DESCRIPTORS && setter && setSymbolDesc(ObjectProto, t, { configurable: !0, set: n }), wrap(t);
 }, redefine($Symbol[PROTOTYPE], "toString", function() {
   return this._k;
-}), $GOPD.f = $getOwnPropertyDescriptor, $DP.f = $defineProperty, require_objectGopn().f = gOPNExt.f = $getOwnPropertyNames, _objectPie.f = $propertyIsEnumerable, $GOPS.f = $getOwnPropertySymbols, DESCRIPTORS && !_library && redefine(ObjectProto, "propertyIsEnumerable", $propertyIsEnumerable), wksExt.f = function(e) {
+}), $GOPD.f = $getOwnPropertyDescriptor, $DP.f = $defineProperty, _objectGopn.f = gOPNExt.f = $getOwnPropertyNames, require_objectPie().f = $propertyIsEnumerable, $GOPS.f = $getOwnPropertySymbols, DESCRIPTORS && !_library && redefine(ObjectProto, "propertyIsEnumerable", $propertyIsEnumerable), wksExt.f = function(e) {
   return wrap(wks(e));
 });
 $export$2($export$2.G + $export$2.W + $export$2.F * !USE_NATIVE, { Symbol: $Symbol });
@@ -58479,7 +58479,7 @@ function(e) {
   }, e.loadImageFile = e.loadFile;
 }(E.API), function(e) {
   function t() {
-    return (i.html2canvas ? Promise.resolve(i.html2canvas) : import("./html2canvas-b6751efe.mjs").then((Re) => Re.h)).catch(function(Re) {
+    return (i.html2canvas ? Promise.resolve(i.html2canvas) : import("./html2canvas-b8e5c938.mjs").then((Re) => Re.h)).catch(function(Re) {
       return Promise.reject(new Error("Could not load html2canvas: " + Re));
     }).then(function(Re) {
       return Re.default ? Re.default : Re;
@@ -59224,7 +59224,7 @@ function(e) {
   var Ue = Te.getContext("2d");
   Ue.fillStyle = "#fff", Ue.fillRect(0, 0, Te.width, Te.height);
   var Qe = { ignoreMouse: !0, ignoreAnimation: !0, ignoreDimensions: !0 }, Me = this;
-  return (i.canvg ? Promise.resolve(i.canvg) : import("./index.es-77c72440.mjs")).catch(function(He) {
+  return (i.canvg ? Promise.resolve(i.canvg) : import("./index.es-f252c33b.mjs")).catch(function(He) {
     return Promise.reject(new Error("Could not load canvg: " + He));
   }).then(function(He) {
     return He.default ? He.default : He;

package/dist/{index.es-77c72440.mjs → index.es-f252c33b.mjs}

@@ -1,4 +1,4 @@
-import { _ as Ha, c as Qe, g as Lo } from "./index-9407a038.mjs";
+import { _ as Ha, c as Qe, g as Lo } from "./index-10c86437.mjs";
 import "react/jsx-runtime";
 import "react";
 import "react-dom";

package/dist/index.mjs

@@ -1,4 +1,4 @@
-import { E as i } from "./index-9407a038.mjs";
+import { E as i } from "./index-10c86437.mjs";
 import "react/jsx-runtime";
 import "react";
 import "react-dom";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "ai-ebm-assistant-v4",
   "private": false,
-  "version": "0.0.2",
+  "version": "0.0.3",
   "module": "./dist/index.mjs",
   "exports": {
     ".": {
@@ -39,7 +39,7 @@
     "react-icons": "^4.7.1",
     "react-lottie": "^1.2.10"
   },
-  "peerDependencies":{
+  "peerDependencies": {
     "react": "^18.2.0",
     "react-dom": "^18.2.0"
   },