update

Author: karpatic

buildDocs.sh

@@ -0,0 +1,26 @@
+#!/bin/bash
+
+docs_dir="./docs"
+docs_temp_dir="./documentation"
+swap_dir="./temp_swap_dir"
+
+# Function to build and replace 'docs'
+build_and_replace_docs() {
+  # Create the documenation using chatGPT
+  node mkdocs.js
+  mkdocs build
+  rm -r "$docs_dir"
+  mv "site" "$docs_dir"
+}
+
+# Check if '/docs' directory exists and has '.md' files
+if [ -d "$docs_dir" ] && [ "$(find "$docs_dir" -name '*.md' | wc -l)" -gt 0 ]; then
+  # Swap 'docs' and 'docs_temp' directories
+  mv "$docs_dir" "$swap_dir"
+  mv "$docs_temp_dir" "$docs_dir"
+  mv "$swap_dir" "$docs_temp_dir"
+  echo "Swapped '$docs_dir' and '$docs_temp_dir' directories."
+fi
+
+# Build and replace 'docs' regardless of whether a swap happened or not
+build_and_replace_docs

docs_temp/api/chatbot.md renamed to docs/api/chatbot.md

@@ -0,0 +1,67 @@
+# EmailRetriever Documentation
+
+**Description**: The `EmailRetriever` class is designed to fetch emails from specific folders within an email account. It supports multiple email clients and allows for easy email retrieval with support for IMAP search commands. It leverages proprietary Addy AI technology to interact with email servers and facilitates the extraction of email data for use in applications.
+
+### Constructor: `EmailRetriever()`
+
+**Returns**: An instance of the `EmailRetriever` class.
+
+**Description**:
+
+  - Initializes an `EmailRetriever` instance with the provided details for email access and retrieval.
+  - Throws an error if the specified email client is not supported.
+
+**Example**: Instantiate the `EmailRetriever` for a Gmail account with verbose error logging.
+
+```javascript
+const retriever = new EmailRetriever(
+  'your-email@gmail.com',
+  'your-password',
+  'gmail',
+  true
+);
+```
+
+**Parameters**:
+
+  | Parameter Name | Description | Accepted Values/Data Types |
+  | -------------- | ----------- | --------------------------- |
+  | emailAddress   | The email address of the account to initialize | String |
+  | emailPassword  | The password of the email account | String |
+  | emailClient    | The email client hosting the email address | "gmail" \| "outlook" |
+  | verbose        | Indicates if errors should be printed out | Boolean |
+
+
+### Method: `getEmailsInFolder()`
+
+**Returns**: A promise that resolves to an array of emails upon successful retrieval or undefined if unsuccessful.
+
+**Description**:
+
+  - Fetches emails from a specified folder within the user's email account up to a specified limit.
+  - If `verbose` is `true`, any errors encountered will be printed to the console.
+
+**Example**: Retrieve the last 10 unseen emails in the Inbox folder.
+
+```javascript
+retriever.getEmailsInFolder('Inbox', '10', 'UNSEEN')
+  .then(emails => {
+    if (emails) {
+      console.log('Retrieved Emails:', emails);
+    } else {
+      console.log('No emails fetched or an error occurred');
+    }
+  })
+  .catch(error => console.error(error));
+```
+
+**Parameters**:
+
+  | Parameter Name     | Description | Accepted Values/Data Types |
+  | ------------------ | ----------- | --------------------------- |
+  | folderName         | The name of the folder to scan for emails | String |
+  | limit              | The maximum number of emails to retrieve | String |
+  | IMAPSearchCommand  | The IMAP command to determine which emails to fetch | "ALL" \| "UNSEEN" \| "SEEN" |
+
+
+---

docs_temp/api/dataOverview.md renamed to docs/api/dataOverview.md

@@ -0,0 +1,58 @@
+# Firestore Documentation
+
+**Description**: The Firestore class provides a variety of methods to interact with documents and collections in Firebase Firestore. It allows you to filter, add, create, update, and delete documents in Firestore collections, including subcollections.
+
+For each method follow this structure:
+
+### Method: `filterCollectionWithWhereClause(collection, filterKey, filterData, operation)`
+
+**Returns**: An array of documents that match the provided filters.
+
+**Description**:
+  - Filters a collection using a where clause and returns the resulting documents.
+  - Throws an error if there is an issue retrieving the documents.
+
+**Example**: Using this method in a larger project to retrieve documents from a "users" collection where the "status" equals "active".
+```javascript
+const userDocs = await firestoreInstance.filterCollectionWithWhereClause(
+    "users",
+    "status",
+    "active",
+    "=="
+);
+```
+
+**Parameters**:
+
+  | Parameter Name | Description                                 | Accepted Values/Data Types      |
+  | -------------- | ------------------------------------------- | ------------------------------- |
+  | collection     | The name of the collection to be filtered.  | String                          |
+  | filterKey      | The key/field name to filter by.            | String                          |
+  | filterData     | The value to match for the given filterKey. | String                          |
+  | operation      | The Firestore query operator.               | String (Firestore query operators) |
+
+
+### Method: `addDocumentToCollection(document, collection)`
+
+**Returns**: An object containing the success status and the ID of the document added.
+
+**Description**:
+  - Adds a new document to the specified collection.
+  - If an error occurs, it throws an exception with the error details.
+
+**Example**: Adding a new user object to the "users" collection in Firestore.
+```javascript
+const addResult = await firestoreInstance.addDocumentToCollection(newUser, "users");
+if (addResult.success) {
+    console.log(`Added document with ID: ${addResult.docID}`);
+}
+```
+
+**Parameters**:
+
+  | Parameter Name | Description                      | Accepted Values/Data Types |
+  | -------------- | -------------------------------- | -------------------------- |
+  | document       | The data object of the document. | Object                     |
+  | collection     | The name of the target collection. | String                   |
+
+(Note: The documentation template above is applied to only the `filterCollectionWithWhereClause` method and `addDocumentToCollection`. Similar formatting would follow for each method defined within the `Firestore` class itself, but due to the length and number of methods, not all methods have been templated here. Each method should get its own section following the given structure.)

docs/api/email.md

@@ -0,0 +1,180 @@
+```markdown
+# Gdrive Documentation
+
+**Description**: Gdrive is a JavaScript class designed for Node.js, intended to simplify interactions with Google Drive API. It allows developers to authenticate access, list directories and files, upload, update, and download files within Google Drive using Google's API.
+
+### Method: `init(config)`
+
+**Returns**: An instance of the Gdrive class.
+
+**Description**:
+
+  - Initializes a new instance of the Gdrive class using the provided configuration object.
+  - Handles errors encountered during the initialization process.
+
+**Example**: How to initialize a Gdrive instance.
+
+```javascript
+const Gdrive = require("./Gdrive");
+const config = {
+  verbose: true,
+  appType: 'server',
+  client_id: 'your-client-id',
+  client_secret: 'your-client-secret',
+  redirect_uri: 'your-redirect-uri',
+  scopes: 'https://www.googleapis.com/auth/drive',
+  keyFilePath: 'path-to-keyfile.json'
+};
+const driveInstance = await Gdrive.init(config);
+```
+
+**Parameters**:
+
+| Parameter Name | Description                                | Accepted Values/Data Types          |
+|----------------|--------------------------------------------|-------------------------------------|
+| config         | An object containing the configuration for | Object                              |
+|                | Gdrive initialization.                     |                                     |
+
+### Method: `listFilez()`
+
+**Returns**: Nothing directly, but logs the list of files to the console.
+
+**Description**:
+
+  - Lists up to 10 files from the authenticated user's Google Drive.
+  - Outputs the file names and IDs to the console.
+  - Handles errors and logs them to the console if listing fails.
+
+**Example**: List files in Google Drive.
+
+```javascript
+await driveInstance.listFilez();
+```
+
+### Method: `listFiles(props)`
+
+**Returns**: An object with a status code, message, and data containing the list of files.
+
+**Description**:
+
+  - Retrieves a list of files from Google Drive based on various filter criteria such as directories, MIME type, and filename.
+  - Accepts a properties object to further customize the file listing.
+  - Handles exceptions and returns an error object if the operation fails.
+
+**Example**: Retrieve a specific list of files.
+
+```javascript
+const properties = {
+  directory: 'Documents',
+  mimeType: 'image/jpeg'
+};
+const fileList = await driveInstance.listFiles(properties);
+```
+
+**Parameters**:
+
+| Parameter Name | Description                                  | Accepted Values/Data Types |
+|----------------|----------------------------------------------|----------------------------|
+| props          | An object containing properties for listing  | Object                     |
+|                | the files, including directory, MIME type,   |                            |
+|                | and filename.                                |                            |
+
+### Method: `createFile(props)`
+
+**Returns**: An object containing the status, message, and response data with the details of the created file.
+
+**Description**:
+
+  - Creates a file in Google Drive with specified properties including filename, MIME type, and contents.
+  - Accepts a properties object to customize the created file.
+  - Handles errors and returns an error object if the creation fails.
+
+**Example**: Create a new file in Google Drive.
+
+```javascript
+const fileProps = {
+  filename: 'NewDocument.txt',
+  mimeType: 'text/plain',
+  message: 'Hello World'
+};
+const createdFile = await driveInstance.createFile(fileProps);
+```
+
+**Parameters**:
+
+| Parameter Name | Description                                    | Accepted Values/Data Types |
+|----------------|------------------------------------------------|----------------------------|
+| props          | An object containing properties for the file   | Object                     |
+|                | to be created, such as filename, MIME type,    |                            |
+|                | and content.                                   |                            |
+
+### Method: `createAndOrGetContent(props)`
+
+**Returns**: An object containing the status, message, and data with the details of the requested content or the content that was created.
+
+**Description**:
+
+  - Creates or retrieves the content specified by the path and MIME type from Google Drive.
+  - Recursively handles directory creation if not existing and retrieves or creates the final file or folder.
+  - Returns details of the content including metadata and file data.
+  - Handles error cases returning structured error responses.
+
+**Example**: Create or get content within a specified path.
+
+```javascript
+const contentProps = {
+  path: '/MyDocuments/Project',
+  mimeType: 'application/vnd.google-apps.folder'
+};
+const content = await driveInstance.createAndOrGetContent(contentProps);
+```
+
+**Parameters**:
+
+| Parameter Name | Description                                        | Accepted Values/Data Types |
+|----------------|----------------------------------------------------|----------------------------|
+| props          | An object containing properties for the path, MIME | Object                     |
+|                | type, and optional message content.                |                            |
+
+### Method: `updateFile(props)`
+
+**Returns**: An object containing the status, message, and response data with the details of the updated file.
+
+**Description**:
+
+  - Updates an existing file's content identified by the fileId in Google Drive.
+  - Accepts a properties object containing fileId, MIME type, and new contents for the file.
+  - Handles error cases and returns an error object if the update fails.
+
+**Example**: Update an existing file's content.
+
+```javascript
+const updateProps = {
+  fileId: 'file-id',
+  mimeType: 'text/plain',
+  message: 'Updated Content'
+};
+const updatedFile = await driveInstance.updateFile(updateProps);
+```
+
+**Parameters**:
+
+| Parameter Name | Description                                       | Accepted Values/Data Types |
+|----------------|---------------------------------------------------|----------------------------|
+| props          | An object containing the fileId, MIME type, and   | Object                     |
+|                | new content for the file to be updated.           |                            |
+
+### Additional Static Methods:
+
+- `createOAuthServer`: Creates and returns an Express server instance to facilitate OAuth authentication.
+- `getAuthUrl(config)`: Creates and returns a Google OAuth URL based on provided parameters.
+- `handleAuthCallback(config)`: Handles the OAuth callback to retrieve access tokens.
+- `checkAndRefresh(config)`: Checks if an access token has expired and attempts to refresh it.
+- `refreshToken(config)`: Refreshes the access token using the stored refresh token and returns the new access token.
+
+Static methods are invoked on the Gdrive class itself and not on instances of the class. They are commonly used for initial OAuth setup, token handling, and to check or refresh access tokens when needed.
+
+---
+
+Navigate through our sections to find comprehensive guides and insights that suit your development needs!
+```