@ouroboros/body 0.1.3 → 1.0.1

package/package.json

@@ -1,12 +1,14 @@
 {
 	"name": "@ouroboros/body",
-	"version": "0.1.3",
+	"version": "1.0.1",
 	"description": "Classes to communicate with Ouroboros Coding Inc. body services",
-	"main": "index.js",
-	"types": "index.d.ts",
+	"main": "src/index.js",
+	"types": "src/index.d.ts",
 	"scripts": {
-		"test": "echo \"Error: no test specified.\" && exit 1"
-	},
+			"build": "tslint -p tsconfig.json && tsc",
+			"clean": "rm src/*.js src/*.d.ts",
+			"test": "echo \"Error: no test specified.\" && exit 1"
+		},
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/ouroboroscoding/body-js.git"
@@ -20,10 +22,11 @@
 	"bugs": {
 		"url": "https://github.com/ouroboroscoding/body-js/issues"
 	},
-	"devDependencies": {},
-	"dependencies": {
-		"@ouroboros/browser": "^0.1.3",
-		"@ouroboros/events": "^0.1.0",
-		"@ouroboros/tools": "^0.3.2"
-	}
-}
+	"devDependencies": {
+		"tslint": "^6.1.3",
+		"tslint-config-prettier": "^1.18.0",
+		"typescript": "^4.8.3"
+	},
+	"dependencies": {},
+	"peerDependencies": {}
+}

package/src/Service.d.ts

@@ -0,0 +1,126 @@
+/**
+ * Service
+ *
+ * Used to extend by modules that want to give direct access to a single service
+ *
+ * @author Chris Nasr <chris@ouroboroscoding.com>
+ * @copyright Ouroboros Coding Inc.
+ * @created 2023-03-05
+ */
+import { onError, onErrorCode, onRequested, onRequesting } from './';
+/**
+ * Service
+ *
+ * Provides calls to create, read, update, and delete on one specific service
+ *
+ * @name Service
+ */
+export default class Service {
+    service: string;
+    /**
+     * Constructor
+     *
+     * Creates a new instance
+     *
+     * @name Service
+     * @access public
+     * @param service The name of the service to make all requests to
+     * @returns a new instance
+     */
+    constructor(service: string);
+    /**
+     * Create
+     *
+     * Calls a create (POST) request on the service associated with this
+     * instance
+     *
+     * @name create
+     * @access public
+     * @param noun The noun to call on the service
+     * @param data The data associated with the request
+     */
+    create(noun: string, data?: any): Promise<any>;
+    /**
+     * Delete
+     *
+     * Calls a delete (DELETE) request on the service associated with this
+     * instance
+     *
+     * @name delete
+     * @access public
+     * @param noun The noun to call on the service
+     * @param data The data associated with the request
+     */
+    delete(noun: string, data?: any): Promise<any>;
+    /**
+     * On Error
+     *
+     * Sets callback for whenever body has an error
+     *
+     * @name onError
+     * @access public
+     */
+    onError(callback: onError): void;
+    /**
+     * On Error Code
+     *
+     * Sets callback for whenever an error code isn't handled internally
+     *
+     * @name onErrorCode
+     * @access public
+     */
+    onErrorCode(callback: onErrorCode): void;
+    /**
+     * On Requested
+     *
+     * Sets the callback called after any request is sent out
+     *
+     * @name onRequesting
+     * @access public
+     * @param callback The function to call after making requests
+     */
+    onRequested(callback: onRequested): void;
+    /**
+     * On Requesting
+     *
+     * Sets the callback called before any request is send out
+     *
+     * @name onRequesting
+     * @access public
+     * @param callback The function to call before making requests
+     */
+    onRequesting(callback: onRequesting): void;
+    /**
+     * Read
+     *
+     * Calls a read (GET) request on the service associated with this instance
+     *
+     * @name read
+     * @access public
+     * @param noun The noun to call on the service
+     * @param data The data associated with the request
+     */
+    read(noun: string, data?: any): Promise<any>;
+    /**
+     * Session
+     *
+     * Set/Gets the current session token
+     *
+     * @name session
+     * @access public
+     * @param token The session to set
+     * @returns the session set
+     */
+    session(token?: string | null): string | null | void;
+    /**
+     * Update
+     *
+     * Calls a update (PUT) request on the service associated with this instance
+     *
+     * @name update
+     * @access public
+     * @param noun The noun to call on the service
+     * @param data The data associated with the request
+     */
+    update(noun: string, data?: any): Promise<any>;
+}

package/src/Service.js

@@ -0,0 +1,148 @@
+/**
+ * Service
+ *
+ * Used to extend by modules that want to give direct access to a single service
+ *
+ * @author Chris Nasr <chris@ouroboroscoding.com>
+ * @copyright Ouroboros Coding Inc.
+ * @created 2023-03-05
+ */
+// Local modules
+import body from './';
+/**
+ * Service
+ *
+ * Provides calls to create, read, update, and delete on one specific service
+ *
+ * @name Service
+ */
+export default class Service {
+    // The service associated with this instance
+    service;
+    /**
+     * Constructor
+     *
+     * Creates a new instance
+     *
+     * @name Service
+     * @access public
+     * @param service The name of the service to make all requests to
+     * @returns a new instance
+     */
+    constructor(service) {
+        this.service = service;
+    }
+    /**
+     * Create
+     *
+     * Calls a create (POST) request on the service associated with this
+     * instance
+     *
+     * @name create
+     * @access public
+     * @param noun The noun to call on the service
+     * @param data The data associated with the request
+     */
+    create(noun, data = null) {
+        return body.request('create', this.service, noun, data);
+    }
+    /**
+     * Delete
+     *
+     * Calls a delete (DELETE) request on the service associated with this
+     * instance
+     *
+     * @name delete
+     * @access public
+     * @param noun The noun to call on the service
+     * @param data The data associated with the request
+     */
+    delete(noun, data = null) {
+        return body.request('delete', this.service, noun, data);
+    }
+    /**
+     * On Error
+     *
+     * Sets callback for whenever body has an error
+     *
+     * @name onError
+     * @access public
+     */
+    onError(callback) {
+        body.onError(callback);
+    }
+    /**
+     * On Error Code
+     *
+     * Sets callback for whenever an error code isn't handled internally
+     *
+     * @name onErrorCode
+     * @access public
+     */
+    onErrorCode(callback) {
+        body.onErrorCode(callback);
+    }
+    /**
+     * On Requested
+     *
+     * Sets the callback called after any request is sent out
+     *
+     * @name onRequesting
+     * @access public
+     * @param callback The function to call after making requests
+     */
+    onRequested(callback) {
+        return body.onRequested(callback);
+    }
+    /**
+     * On Requesting
+     *
+     * Sets the callback called before any request is send out
+     *
+     * @name onRequesting
+     * @access public
+     * @param callback The function to call before making requests
+     */
+    onRequesting(callback) {
+        return body.onRequesting(callback);
+    }
+    /**
+     * Read
+     *
+     * Calls a read (GET) request on the service associated with this instance
+     *
+     * @name read
+     * @access public
+     * @param noun The noun to call on the service
+     * @param data The data associated with the request
+     */
+    read(noun, data = null) {
+        return body.request('read', this.service, noun, data);
+    }
+    /**
+     * Session
+     *
+     * Set/Gets the current session token
+     *
+     * @name session
+     * @access public
+     * @param token The session to set
+     * @returns the session set
+     */
+    session(token) {
+        return body.session(token);
+    }
+    /**
+     * Update
+     *
+     * Calls a update (PUT) request on the service associated with this instance
+     *
+     * @name update
+     * @access public
+     * @param noun The noun to call on the service
+     * @param data The data associated with the request
+     */
+    update(noun, data = null) {
+        return body.request('update', this.service, noun, data);
+    }
+}

package/src/Service.ts

@@ -0,0 +1,166 @@
+/**
+ * Service
+ *
+ * Used to extend by modules that want to give direct access to a single service
+ *
+ * @author Chris Nasr <chris@ouroboroscoding.com>
+ * @copyright Ouroboros Coding Inc.
+ * @created 2023-03-05
+ */
+
+// Local modules
+import body from './';
+
+// Types
+import {
+	onError, onErrorCode, onRequested, onRequesting, responseStruct
+} from './';
+
+/**
+ * Service
+ *
+ * Provides calls to create, read, update, and delete on one specific service
+ *
+ * @name Service
+ */
+export default class Service {
+
+	// The service associated with this instance
+	service: string;
+
+	/**
+	 * Constructor
+	 *
+	 * Creates a new instance
+	 *
+	 * @name Service
+	 * @access public
+	 * @param service The name of the service to make all requests to
+	 * @returns a new instance
+	 */
+	constructor(service: string) {
+		this.service = service;
+	}
+
+	/**
+	 * Create
+	 *
+	 * Calls a create (POST) request on the service associated with this
+	 * instance
+	 *
+	 * @name create
+	 * @access public
+	 * @param noun The noun to call on the service
+	 * @param data The data associated with the request
+	 */
+	create(noun: string, data: any = null): Promise<any> {
+		return body.request('create', this.service, noun, data);
+	}
+
+	/**
+	 * Delete
+	 *
+	 * Calls a delete (DELETE) request on the service associated with this
+	 * instance
+	 *
+	 * @name delete
+	 * @access public
+	 * @param noun The noun to call on the service
+	 * @param data The data associated with the request
+	 */
+	delete(noun: string, data: any = null): Promise<any> {
+		return body.request('delete', this.service, noun, data);
+	}
+
+	/**
+	 * On Error
+	 *
+	 * Sets callback for whenever body has an error
+	 *
+	 * @name onError
+	 * @access public
+	 */
+	onError(callback: onError): void {
+		body.onError(callback);
+	}
+
+	/**
+	 * On Error Code
+	 *
+	 * Sets callback for whenever an error code isn't handled internally
+	 *
+	 * @name onErrorCode
+	 * @access public
+	 */
+	onErrorCode(callback: onErrorCode): void {
+		body.onErrorCode(callback);
+	}
+
+	/**
+	 * On Requested
+	 *
+	 * Sets the callback called after any request is sent out
+	 *
+	 * @name onRequesting
+	 * @access public
+	 * @param callback The function to call after making requests
+	 */
+	onRequested(callback: onRequested): void {
+		return body.onRequested(callback);
+	}
+
+	/**
+	 * On Requesting
+	 *
+	 * Sets the callback called before any request is send out
+	 *
+	 * @name onRequesting
+	 * @access public
+	 * @param callback The function to call before making requests
+	 */
+	onRequesting(callback: onRequesting): void {
+		return body.onRequesting(callback);
+	}
+
+	/**
+	 * Read
+	 *
+	 * Calls a read (GET) request on the service associated with this instance
+	 *
+	 * @name read
+	 * @access public
+	 * @param noun The noun to call on the service
+	 * @param data The data associated with the request
+	 */
+	read(noun: string, data: any = null): Promise<any> {
+		return body.request('read', this.service, noun, data);
+	}
+
+	/**
+	 * Session
+	 *
+	 * Set/Gets the current session token
+	 *
+	 * @name session
+	 * @access public
+	 * @param token The session to set
+	 * @returns the session set
+	 */
+	session(token?: string | null): string | null | void {
+		return body.session(token);
+	}
+
+	/**
+	 * Update
+	 *
+	 * Calls a update (PUT) request on the service associated with this instance
+	 *
+	 * @name update
+	 * @access public
+	 * @param noun The noun to call on the service
+	 * @param data The data associated with the request
+	 */
+	update(noun: string, data: any = null): Promise<any> {
+		return body.request('update', this.service, noun, data);
+	}
+}

package/src/constants.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Constants
+ *
+ * Holds constants
+ *
+ * @author Chris Nasr <chris@ouroboroscoding.com>
+ * @copyright Ouroboros Coding Inc.
+ * @created 2023-03-05
+ */
+export declare const EMPTY_UUID = "00000000-0000-4000-8000-000000000000";
+export declare const SECONDS_HOUR = 3600;
+export declare const SECONDS_DAY = 86400;
+export declare const SECONDS_WEEK = 604800;

package/src/constants.js

@@ -0,0 +1,15 @@
+/**
+ * Constants
+ *
+ * Holds constants
+ *
+ * @author Chris Nasr <chris@ouroboroscoding.com>
+ * @copyright Ouroboros Coding Inc.
+ * @created 2023-03-05
+ */
+// Empty UUID
+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;

package/src/constants.ts

@@ -0,0 +1,17 @@
+/**
+ * Constants
+ *
+ * Holds constants
+ *
+ * @author Chris Nasr <chris@ouroboroscoding.com>
+ * @copyright Ouroboros Coding Inc.
+ * @created 2023-03-05
+ */
+
+// Empty UUID
+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

package/src/errors.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Errors
+ *
+ * Holds constants for error codes
+ *
+ * @author Chris Nasr <chris@ouroboroscoding.com>
+ * @copyright Ouroboros Coding Inc.
+ * @created 2023-03-05
+ */
+export declare const REST_REQUEST_DATA = 100;
+export declare const REST_CONTENT_TYPE = 101;
+export declare const REST_AUTHORIZATION = 102;
+export declare const SERVICE_ACTION = 200;
+export declare const SERVICE_STATUS = 201;
+export declare const SERVICE_CONTENT_TYPE = 202;
+export declare const SERVICE_UNREACHABLE = 203;
+export declare const SERVICE_NOT_REGISTERED = 204;
+export declare const SERVICE_NO_SUCH_NOUN = 205;
+export declare const SERVICE_INTERNAL_KEY = 206;
+export declare const SERVICE_CRASHED = 207;
+export declare const SERVICE_NO_DATA = 208;
+export declare const SERVICE_NO_SESSION = 209;
+export declare const RIGHTS = 1000;
+export declare const DATA_FIELDS = 1001;
+export declare const ALREADY_DONE = 1002;
+export declare const DB_NO_RECORD = 1100;
+export declare const DB_DUPLICATE = 1101;
+export declare const DB_CREATE_FAILED = 1102;
+export declare const DB_DELETE_FAILED = 1103;
+export declare const DB_UPDATE_FAILED = 1104;
+export declare const DB_KEY_BEING_USED = 1105;
+export declare const DB_ARCHIVED = 1106;

package/src/errors.js

@@ -0,0 +1,36 @@
+/**
+ * Errors
+ *
+ * Holds constants for error codes
+ *
+ * @author Chris Nasr <chris@ouroboroscoding.com>
+ * @copyright Ouroboros Coding Inc.
+ * @created 2023-03-05
+ */
+// Rest-OC REST related
+export const REST_REQUEST_DATA = 100;
+export const REST_CONTENT_TYPE = 101;
+export const REST_AUTHORIZATION = 102;
+// Rest-OC Service related
+export const SERVICE_ACTION = 200;
+export const SERVICE_STATUS = 201;
+export const SERVICE_CONTENT_TYPE = 202;
+export const SERVICE_UNREACHABLE = 203;
+export const SERVICE_NOT_REGISTERED = 204;
+export const SERVICE_NO_SUCH_NOUN = 205;
+export const SERVICE_INTERNAL_KEY = 206;
+export const SERVICE_CRASHED = 207;
+export const SERVICE_NO_DATA = 208;
+export const SERVICE_NO_SESSION = 209;
+// Body related
+export const RIGHTS = 1000;
+export const DATA_FIELDS = 1001;
+export const ALREADY_DONE = 1002;
+// DB related
+export const DB_NO_RECORD = 1100;
+export const DB_DUPLICATE = 1101;
+export const DB_CREATE_FAILED = 1102;
+export const DB_DELETE_FAILED = 1103;
+export const DB_UPDATE_FAILED = 1104;
+export const DB_KEY_BEING_USED = 1105;
+export const DB_ARCHIVED = 1106;

package/src/errors.ts

@@ -0,0 +1,40 @@
+/**
+ * Errors
+ *
+ * Holds constants for error codes
+ *
+ * @author Chris Nasr <chris@ouroboroscoding.com>
+ * @copyright Ouroboros Coding Inc.
+ * @created 2023-03-05
+ */
+
+// Rest-OC REST related
+export const REST_REQUEST_DATA = 100
+export const REST_CONTENT_TYPE = 101
+export const REST_AUTHORIZATION = 102
+
+// Rest-OC Service related
+export const SERVICE_ACTION = 200
+export const SERVICE_STATUS = 201
+export const SERVICE_CONTENT_TYPE = 202
+export const SERVICE_UNREACHABLE = 203
+export const SERVICE_NOT_REGISTERED = 204
+export const SERVICE_NO_SUCH_NOUN = 205
+export const SERVICE_INTERNAL_KEY = 206
+export const SERVICE_CRASHED = 207
+export const SERVICE_NO_DATA = 208
+export const SERVICE_NO_SESSION = 209
+
+// Body related
+export const RIGHTS = 1000
+export const DATA_FIELDS = 1001
+export const ALREADY_DONE = 1002
+
+// DB related
+export const DB_NO_RECORD = 1100
+export const DB_DUPLICATE = 1101
+export const DB_CREATE_FAILED = 1102
+export const DB_DELETE_FAILED = 1103
+export const DB_UPDATE_FAILED = 1104
+export const DB_KEY_BEING_USED = 1105
+export const DB_ARCHIVED = 1106