feat(ORBIT-CODESPACE): ✨ FIRING UP THE ENGINE

All the Modules Are Done and tested

.gitignore

@@ -1 +1,3 @@
 .vscode
+node_modules
+lib

.npmignore

@@ -0,0 +1,4 @@
+core
+tsconfig.json
+tslint.json
+.prettierrc

.prettierrc

@@ -0,0 +1,5 @@
+{
+  "printWidth": 120,
+  "trailingComma": "all",
+  "singleQuote": true
+}

README.md

@@ -5,7 +5,7 @@
 [![Issues Status](https://img.shields.io/github/issues/orbitturner/ORBIT-ENCODER)](https://github.com/orbitturner/ORBIT-ENCODER)
 [![npm version](https://img.shields.io/npm/v/ORBIT-ENCODER.svg)](https://github.com/orbitturner/ORBIT-ENCODER) [![license](https://img.shields.io/npm/l/ORBIT-ENCODER.svg)](https://github.com/orbitturner/ORBIT-ENCODER)
 
-**ORBIT-ENCODER** is an utility library for Data Compression and Encoding. It can take whatever object you gave him as argument and returns a compressed encoded string. It provides a decoding method too. It uses a modified version of  for UTF16 Compression [*LZString*](https://www.npmjs.com/package/lz-string).
+**ORBIT-ENCODER** is an utility library for Data Compression and Encoding. It can take whatever object you give him as argument and returns a compressed encoded string. It provides a decoding method too. It uses a modified version of [*LZString*](https://www.npmjs.com/package/lz-string) for UTF16 Compression.
 
 <p align="center">
   <a href="http://orbitturner.com/"><img src="./.repo-assets/images/GITHUB REPOS COVER.gif" width="auto" alt="ORBIT-ENCODER COVER"/></a>

core/OrbitEncoder.ts

@@ -0,0 +1,56 @@
+import { LZString } from './workers/lz-string';
+
+// 🟢💻 WELCOME TO ANOTHER SPACESHIP - DEVELOPED BY 💻🟢
+//  ██████╗ ██████╗ ██████╗ ██╗████████╗    ████████╗██╗   ██╗██████╗ ███╗   ██╗███████╗██████╗
+// ██╔═══██╗██╔══██╗██╔══██╗██║╚══██╔══╝    ╚══██╔══╝██║   ██║██╔══██╗████╗  ██║██╔════╝██╔══██╗
+// ██║   ██║██████╔╝██████╔╝██║   ██║          ██║   ██║   ██║██████╔╝██╔██╗ ██║█████╗  ██████╔╝
+// ██║   ██║██╔══██╗██╔══██╗██║   ██║          ██║   ██║   ██║██╔══██╗██║╚██╗██║██╔══╝  ██╔══██╗
+// ╚██████╔╝██║  ██║██████╔╝██║   ██║          ██║   ╚██████╔╝██║  ██║██║ ╚████║███████╗██║  ██║
+//  ╚═════╝ ╚═╝  ╚═╝╚═════╝ ╚═╝   ╚═╝          ╚═╝    ╚═════╝ ╚═╝  ╚═╝╚═╝  ╚═══╝╚══════╝╚═╝  ╚═╝
+// 💚🔰 KEEP GOING FURTHER 🔰💚
+/**
+ * 💨 Project Name : Orbit-Encoder
+ * 💨 Project Repo : https://github.com/orbitturner/orbit-encoder
+ * 💨 My GitHub    : https://github.com/orbitturner
+ * 💨 My LinkedIn  : https://linkedin.com/in/orbitturner
+ * 💨 My Twitter   : https://twitter.com/orbitturner
+ */
+
+export class OrbitEncoder {
+  /**
+   * ENCODING OBJECT TO BASE64.
+   *
+   * Since everything is an object in Javascript this will
+   * encode whatever you give it in Base64 then Compress it to an UTF16 String.
+   *
+   * btoa(): creates a Base64-encoded ASCII string from a "string" of binary data ("btoa" should be read as "binary to ASCII").
+   * @see: https://developer.mozilla.org/en-US/docs/Glossary/Base64
+   */
+  public static encode(obj: any): any {
+    if (typeof obj !== 'object' && !Array.isArray(obj)) {
+      // OLD DEPRECATED : return LZString.compressToUTF16(btoa(unescape(encodeURIComponent(obj))));
+      return LZString.compressToUTF16(Buffer.from(obj, 'binary').toString('base64'));
+
+
+    }
+    return LZString.compressToUTF16(Buffer.from(JSON.stringify(obj), 'binary').toString('base64'));
+  }
+
+  /**
+   * DECODING BASE64.
+   *
+   * Since everything is an object in Javascript this will
+   * decode whatever in Base64 you give it.
+   *
+   * @see: https://developer.mozilla.org/en-US/docs/Glossary/Base64
+   */
+  public static decode(obj: any): any {
+    try {
+      return JSON.parse(Buffer.from(LZString.decompressFromUTF16(obj), 'base64').toString('binary'));
+      // * atob(): decodes a Base64-encoded string("atob" should be read as "ASCII to binary").
+      // DEPRECATED : return JSON.parse(decodeURIComponent(escape(atob(LZString.decompressFromUTF16(obj)))));
+    } catch {
+      return Buffer.from(LZString.decompressFromUTF16(obj), 'base64').toString('binary');
+    }
+  }
+}

core/__test__/OrbitEncoder.test.ts

@@ -0,0 +1,21 @@
+import { OrbitEncoder } from '../OrbitEncoder';
+
+const User = {
+    "name": "Orbit",
+    "age": 21,
+    "planet": {
+        "id": 4,
+        "codename" : "Shadow-Coders",
+        "galaxyName" : "Turner"
+    }   
+};
+
+test('Trying to Encode Some Data with Encode Method', () => {
+    const result = OrbitEncoder.encode(User);
+    expect(typeof OrbitEncoder.encode(User)).toBe('string');
+});
+
+test('Decoding Some Data', () => {
+    const result = OrbitEncoder.encode(User);
+    expect(OrbitEncoder.decode(result)).toEqual(User);
+});