first commit

.gitignore

@@ -0,0 +1 @@
+node_modules

README.md

@@ -0,0 +1,56 @@
+# AlphaID.js
+
+AlphaID.js is a library that let you convert any integer to a short alphanumeric version. It can be useful for generating short, unique, and obfuscated identifiers.
+
+# Installation
+
+You can install AlphaID.js using npm:
+
+```bash
+npm i alpha-id-js
+```
+
+Via CDN:
+
+```html
+<script src="https://unpkg.com/alpha-id-js"></script>
+```
+
+# Getting Started
+
+Simple usage looks like:
+
+```javascript
+const AlphaID = require('alpha-id-js');
+// or from browser ->  <script src="https://unpkg.com/alpha-id-js"></script> 
+
+const encodedString = AlphaID.convert(258456357951);
+console.log(encodedString);
+// Output: '4y7exoH'
+
+const originalNumber = AlphaID.recover('4y7exoH');
+console.log(originalNumber);
+// Output: 258456357951
+```
+
+Configuring a Global Key
+
+You can set a global key that will be used for encoding and decoding if no specific key is provided. This can be done using the `config` method:
+
+```javascript
+const AlphaID = require('alpha-id-js');
+
+AlphaID.config('my_key');
+
+const encodedString = AlphaID.convert(258456357951);
+console.log(encodedString);
+// Output: '4ymMZq9'
+
+const originalNumber = AlphaID.recover('4ymMZq9');
+console.log(originalNumber);
+// Output: 258456357951
+```
+
+## License
+
+AlphaID is open-source software licensed under the [MIT license](https://opensource.org/licenses/MIT).

dist/src/AlphaID.d.ts

@@ -0,0 +1,39 @@
+/**
+ * AlphaID class
+ */
+declare class AlphaID {
+    private static baseChars;
+    private static globalKey;
+    /**
+     * Set the global key
+     *
+     * @param  {string} key
+     */
+    static config(key: string): void;
+    /**
+     * Encode a number
+     *
+     * @param  {number, bigint} number
+     * @param  {string} key
+     * @returns {string}
+     */
+    static convertNumber(number: number | bigint, key?: string): string;
+    /**
+     * Decode a string
+     *
+     * @param  {string} convertedString
+     * @param  {string} key
+     * @returns {number, bigint}
+     */
+    static recoverNumber(convertedString: string, key?: string): number | bigint;
+    /**
+     * Short name function redirects to convertNumber
+     */
+    static convert(numberToBeConverted: number, key?: string): string;
+    /**
+     * Short name function redirects to recoverNumber
+     */
+    static recover(stringToBeRecovered: string, key?: string): number | bigint;
+    static crc32(data: string): number;
+}
+export default AlphaID;

dist/test/AlphaID.test.d.ts

@@ -0,0 +1 @@
+declare const AlphaID: any;

jest.config.js

@@ -0,0 +1,4 @@
+module.exports = {
+    preset: 'ts-jest',
+    testEnvironment: 'node',
+};