@ouroboros/body 1.1.2 → 1.2.0

package/{build → lib}/index.js

@@ -7,8 +7,6 @@
  * @copyright Ouroboros Coding Inc.
  * @created 2023-03-03
  */
-// NPM modules
-import XMLHttpRequest from 'xhr2';
 // Import const files
 import * as constants from './constants';
 import * as errors from './errors';
@@ -17,7 +15,7 @@ import * as regex from './regex';
 export { constants, errors, regex };
 export { default as Service } from './Service';
 // Actions to methods
-const ACTIONS_TO_METHODS = {
+const METHODS = {
     create: 'POST',
     delete: 'DELETE',
     read: 'GET',
@@ -33,13 +31,13 @@ const ACTIONS_TO_METHODS = {
  */
 class Body {
     // The domain used to make requests to
-    _domain = '';
+    _domain = 'localhost';
     // The function to call for http and related errors that need to be reported
     error = null;
     // The function to call if we get body errors
     errorCode = null;
     // The function to call when we get a status 401, or error code
-    //	REST_AUTHORIZATION
+    //  REST_AUTHORIZATION
     noSession = null;
     // The function to call after any request is sent
     requested = null;
@@ -47,21 +45,27 @@ class Body {
     requesting = null;
     // The token associated with the current session
     token = null;
-    // Flag for being verbose
-    verbose = false;
     // The function to call if we get body warnings
     warning = null;
     /**
      * Domain
      *
-     * Set the domain
+     * Sets/Gets the domain
      *
      * @name domain
      * @access public
-     * @param domain The name of the domain to connect to
+     * @param @param domain The domain to set
+     * @returns the domain set
      */
     domain(domain) {
-        this._domain = domain;
+        // If we are getting the token
+        if (domain === undefined) {
+            return this._domain;
+        }
+        // Else, we are setting the token
+        else {
+            this._domain = domain;
+        }
     }
     /**
      * Request
@@ -70,6 +74,7 @@ class Body {
      *
      * @name request
      * @access public
+     * @param action The action to take in the call
      * @param service The service to call
      * @param noun The noun to call on the service
      * @param data The data associated with the request
@@ -77,124 +82,107 @@ class Body {
     request(action, service, noun, data) {
         // Generate the URL for the request
         let url = `https://${this._domain}/${service}/${noun}`;
-        // Init the response object
+        // Init the response and json variables
         let res;
+        let json;
+        // If we got data
+        if (data !== null) {
+            // If we're in GET mode, append the data as a param "d" after
+            //  turning it into JSON
+            if (action === 'read') {
+                url += '?d=' + encodeURIComponent(JSON.stringify(data));
+            }
+            else {
+                json = JSON.stringify(data);
+            }
+        }
         // Set this
-        const $this = this;
+        const _ = this;
+        // Handles an error based on whether an error handler is set
+        function handleError(message) {
+            if (_.error) {
+                _.error(message, { action, data, url });
+            }
+            else {
+                throw new Error(message);
+            }
+        }
         // Create a new Promise and return it
         return new Promise((resolve, reject) => {
-            // Create a new XMLHttpRequest
-            const xhr = new XMLHttpRequest();
-            // Handles an error based on whether an error handler is set
-            function handleError(message) {
-                if ($this.error) {
-                    $this.error(message, { action, data, res, url, xhr });
-                }
-                else {
-                    throw new Error(message);
+            // Init the fetch init
+            const fetchInit = {
+                method: METHODS[action],
+                headers: {
+                    'Content-Type': 'application/json; charset=utf-8'
                 }
+            };
+            // If we have a session token, add it as the Authorization header
+            if (_.token) {
+                fetchInit.headers.Authorization = _.token;
             }
-            // Track abort
-            xhr.addEventListener('abort', event => {
-                if (this.verbose) {
-                    console.log(`xhr.abort:\n\t${ACTIONS_TO_METHODS[action]} ${url}\n\t`, event);
-                }
-                handleError(`${ACTIONS_TO_METHODS[action]} ${url} was aborted`);
-            });
-            // Track errors
-            xhr.addEventListener('error', event => {
-                if (this.verbose) {
-                    console.log(`xhr.error:\n\t${ACTIONS_TO_METHODS[action]} ${url}\n\t`, event);
-                }
-                handleError(`${ACTIONS_TO_METHODS[action]} ${url} failed to connect`);
-            });
-            // Handle successful request
-            xhr.addEventListener('load', event => {
-                if (this.verbose) {
-                    console.log(`xhr.load:\n\t${ACTIONS_TO_METHODS[action]} ${url}\n\t`, event);
+            // If we have JSON
+            if (json) {
+                fetchInit.body = json;
+            }
+            // If we have a requesting callback, call it
+            if (this.requesting) {
+                this.requesting({ action, data, url });
+            }
+            // Make the call
+            fetch(url, fetchInit).then(response => {
+                // If 2xx
+                if (response.ok) {
+                    // If the Content-Type is missing or invalid
+                    const ct = response.headers.get('Content-Type');
+                    if (!ct || ct !== 'application/json; charset=utf-8') {
+                        handleError(`${METHODS[action]} ${url} returned invalid Content-Type: ${ct}`);
+                    }
+                    // Return the JSON
+                    return response.json();
                 }
-                // If we got anything other than 200
-                if (xhr.status !== 200) {
-                    // If it's 401
-                    if (xhr.status === 401) {
-                        // If we have a no session callback
-                        if (this.noSession) {
-                            return this.noSession();
-                        }
-                        else {
-                            throw new Error(`${ACTIONS_TO_METHODS[action]} ${url} return 401 NOT AUTHORIZED`);
-                        }
+                // If it's 401
+                if (response.status === 401) {
+                    // If we have a no session callback
+                    if (_.noSession) {
+                        return _.noSession();
                     }
-                    // Else, invalid status
                     else {
-                        handleError(`${ACTIONS_TO_METHODS[action]} ${url} returned invalid status: ${xhr.status}`);
+                        throw new Error(`${METHODS[action]} ${url} return 401 NOT AUTHORIZED`);
                     }
                 }
-                // If the Content-Type is missing or invalid
-                const contentType = xhr.getResponseHeader('Content-Type');
-                if (!contentType || contentType !== 'application/json; charset=utf-8') {
-                    handleError(`${ACTIONS_TO_METHODS[action]} ${url} returned invalid Content-Type: ${contentType}`);
-                }
-                // Convert the text from JSON
-                res = JSON.parse(xhr.responseText);
-                // If the JSON failed to parse
-                if (!res) {
-                    handleError(`${ACTIONS_TO_METHODS[action]} ${url} returned invalid JSON: ${xhr.responseText}`);
+                // Else, invalid status
+                else {
+                    handleError(`${METHODS[action]} ${url} returned invalid status: ${response.status}`);
                 }
+            }).then(result => {
+                // Set res
+                res = result;
                 // If we got an error
-                if ('error' in res && res.error) {
-                    // Add the handle error function to it
-                    res.error.handle = handleError;
-                    // If we don't have an onErrorCode callback, or it we do and
-                    //	calling it returns false
-                    if (!this.errorCode || this.errorCode(res.error, { action, data, res, url, xhr }) === false) {
-                        return reject(res.error);
+                if ('error' in result && result.error) {
+                    // If we don't have an onErrorCode callback, or we do and
+                    //  calling it returns false
+                    if (!_.errorCode ||
+                        _.errorCode(result.error, { action, data, res, url }) === false) {
+                        return reject(result.error);
                     }
                 }
+                // If we got a warning and we have an onWarning callback
+                if ('warning' in result && result.warning && _.warning) {
+                    _.warning(result.warning, { action, data, res, url });
+                }
                 // If we got data
-                if ('data' in res) {
+                if ('data' in result) {
                     // Resolve it
-                    return resolve(res.data);
-                }
-            });
-            // Handle the request being finished
-            xhr.addEventListener('loadend', event => {
-                if (this.verbose) {
-                    console.log(`xhr.loadend:\n\t${ACTIONS_TO_METHODS[action]} ${url}\n\t`, event);
+                    return resolve(result.data);
                 }
+            }).catch(reason => {
+                handleError(`${METHODS[action]} ${url} failed because of "${reason}"`);
+            }).finally(() => {
                 // If we have a requested callback
                 if (this.requested) {
-                    this.requested({ action, data, res, url, xhr });
+                    this.requested({ action, data, res, url });
                 }
             });
-            // Init the request body
-            let xml = '';
-            // If we got data
-            if (data !== null) {
-                // If we're in GET mode
-                if (action === 'read') {
-                    // Append the data as a param
-                    url += '?d=' + encodeURIComponent(JSON.stringify(data));
-                }
-                // Else, DELETE, POST, PUT, just encode the data
-                else {
-                    xml = JSON.stringify(data);
-                }
-            }
-            // Open the request
-            xhr.open(ACTIONS_TO_METHODS[action], url);
-            // If we have a session token, add it as the Authorization header
-            if (this.token) {
-                xhr.setRequestHeader('Authorization', this.token);
-            }
-            // Set the Content-Type header
-            xhr.setRequestHeader('Content-Type', 'application/json; charset=utf-8');
-            // If we have a requesting callback, call it
-            if (this.requesting) {
-                this.requesting({ action, data, url, xhr });
-            }
-            // Send the request
-            xhr.send(xml);
         });
     }
     /**
@@ -243,6 +231,9 @@ class Body {
                 case 'errorCode':
                     this.errorCode = callbacks.errorCode;
                     continue;
+                case 'noSession':
+                    this.noSession = callbacks.noSession;
+                    continue;
                 case 'requested':
                     this.requested = callbacks.requested;
                     continue;
@@ -277,7 +268,7 @@ class Body {
      *
      * Sets callback for whenever a request gets an error back
      *
-     * @name onNoSession
+     * @name onErrorCode
      * @access public
      * @param callback The function to call if there's an error
      */
@@ -340,6 +331,23 @@ class Body {
         // Set the callback
         this.requesting = callback;
     }
+    /**
+     * On Warning
+     *
+     * Sets callback for whenever a request gets a warning back
+     *
+     * @name onWarning
+     * @access public
+     * @param callback The function to call if there's a warning
+     */
+    onWarning(callback) {
+        // Make sure the callback is function
+        if (typeof callback !== 'function') {
+            throw new Error('onWarning() called with an invalid callback');
+        }
+        // Set the callback
+        this.warning = callback;
+    }
     /**
      * Read
      *
@@ -388,28 +396,6 @@ class Body {
     update(service, noun, data = null) {
         return this.request('update', service, noun, data);
     }
-    /**
-     * Verbose Off
-     *
-     * Called to turn verbose mode off
-     *
-     * @name verbose_off
-     * @access
-     */
-    verbose_off() {
-        this.verbose = false;
-    }
-    /**
-     * Verbose On
-     *
-     * Called to turn verbose mode on
-     *
-     * @name verbose_on
-     * @access
-     */
-    verbose_on() {
-        this.verbose = true;
-    }
 }
 // Create an instance of Body
 const body = new Body();

package/{build → lib}/regex.js

@@ -8,6 +8,6 @@
  * @created 2023-03-05
  */
 // E-Mail address
-export const EMAIL_ADDRESS = /[^@\s]+@[^@\s]+\.[a-zA-Z0-9]{2,}$/;
+export const EMAIL_ADDRESS = /^[^@\s]+@[^@\s]+\.[a-zA-Z0-9]{2,}$/;
 // North American Phone Number
-export const PHONE_NUMBER_NA = /\+?1?[ -]?\(?(\d{3})\)?[ -]?(\d{3})[ -]?(\d{4})/;
+export const PHONE_NUMBER_NA = /^\+?1?[ -]?\(?(\d{3})\)?[ -]?(\d{3})[ -]?(\d{4})$/;

package/package.json

@@ -1,12 +1,12 @@
 {
 	"name": "@ouroboros/body",
-	"version": "1.1.2",
+	"version": "1.2.0",
 	"description": "Classes to communicate with Ouroboros Coding Inc. body services",
-	"main": "build/index.js",
-	"types": "build/index.d.ts",
+	"main": "lib/index.js",
+	"types": "lib/index.d.ts",
 	"scripts": {
 		"build": "tslint -p tsconfig.json && tsc",
-		"clean": "rm build/*",
+		"clean": "rm lib/*",
 		"for_local": "npm install; tslint -p tsconfig.json && tsc; rm -Rf node_modules",
 		"test": "echo \"Error: no test specified.\" && exit 1"
 	},
@@ -26,9 +26,6 @@
 	"devDependencies": {
 		"tslint": "^6.1.3",
 		"tslint-config-prettier": "^1.18.0",
-		"typescript": "^4.8.3"
-	},
-	"dependencies": {
-		"xhr2": "^0.2.1"
+		"typescript": "^4.9.5"
 	}
 }

package/releases.md

@@ -0,0 +1,12 @@
+# @ouroboros/body releases
+
+## 1.2.0
+- Moved generated .js and .d.ts files into lib/ instead of build/, this changes the "main" from "build/index.js" to "lib/index.js".
+- Removed `xhr2` from the project and replaced `XMLHttpRequest` with `fetch`.
+- Removed `xhr` from `onRequestedStruct` and `onRequestingStruct`.
+- Removed `Body.verbose_on()` and `Body.verbose_off()` functions as well as all `console.log` calls.
+- Added missing `Body.onWarning` function.
+- Added "noSession" as a valid key to the `on` function's argument.
+- Added check in `Body.request` to trigger `this.warning` if a warning is returned.
+- Added `domain`, `on`, and `onWarning` functions to `Service` class, each passes their arguments to, and returns from, the `body` function of the same name.
+- Changed `body.domain` to getter/setter instead of just setter.

package/src/Service.ts

@@ -12,7 +12,9 @@
 import body from './';
 
 // Types
-import { onError, onErrorCode, onRequested, onRequesting } from './';
+import {
+	onCallbacks, onError, onErrorCode, onRequested, onRequesting, onWarning
+} from './';
 
 /**
  * Service
@@ -70,6 +72,33 @@ export default class Service {
 		return body.request('delete', this.service, noun, data);
 	}
 
+	/**
+	 * Domain
+	 *
+	 * Set/Gets the current domain
+	 *
+	 * @name domain
+	 * @access public
+	 * @param domain The domain to make all calls to
+	 * @returns void
+	 */
+	domain(domain?: string): void | string {
+		return body.domain(domain);
+	}
+
+	/**
+	 * On
+	 *
+	 * Called to set multiple events at once
+	 *
+	 * @name on
+	 * @access public
+	 * @param callbacks A name to callback object to set multiple events
+	 */
+	on(callbacks: onCallbacks): void {
+		return body.on(callbacks);
+	}
+
 	/**
 	 * On Error
 	 *
@@ -120,6 +149,19 @@ export default class Service {
 		return body.onRequesting(callback);
 	}
 
+	/**
+	 * On Warning
+	 *
+	 * Sets callback for whenever a request gets a warning back
+	 *
+	 * @name onWarning
+	 * @access public
+	 * @param callback The function to call if there's a warning
+	 */
+	onWarning(callback: onWarning): void {
+		return body.onWarning(callback);
+	}
+
 	/**
 	 * Read
 	 *

package/src/constants.ts

@@ -9,9 +9,10 @@
  */
 
 // Empty UUID
-export const EMPTY_UUID = '00000000-0000-4000-8000-000000000000'
+export const EMPTY_TUUID = '00000000000040008000000000000000';
+export const EMPTY_UUID = '00000000-0000-4000-8000-000000000000';
 
 // Seconds
-export const SECONDS_HOUR = 3600
-export const SECONDS_DAY = 86400
-export const SECONDS_WEEK = 604800
+export const SECONDS_HOUR = 3600;
+export const SECONDS_DAY = 86400;
+export const SECONDS_WEEK = 604800;