feat(core): migrate to typescript

.eslintignore

@@ -0,0 +1,11 @@
+# Build files
+dist
+
+#prettier config
+prettier.config.cjs
+
+# lint-staged config
+lint-staged.config.cjs
+
+# commitlint config
+commitlint.config.cjs

.eslintrc.json

@@ -0,0 +1,36 @@
+{
+  "env": {
+    "browser": true,
+    "es6": true
+  },
+  "extends": ["eslint:recommended", "plugin:@typescript-eslint/recommended"],
+  // Specifying Parser
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": "latest",
+    "sourceType": "module",
+    "tsconfigRootDir": ".",
+    "project": ["./tsconfig.json"]
+  },
+  // Configuring third-party plugins
+  "plugins": ["@typescript-eslint"],
+  // Resolve imports
+  "rules": {
+    "linebreak-style": "off",
+    // Disallow the `any` type.
+    "@typescript-eslint/no-explicit-any": "warn",
+    "@typescript-eslint/ban-types": [
+      "error",
+      {
+        "extendDefaults": true,
+        "types": {
+          "{}": false
+        }
+      }
+    ],
+    "react-hooks/exhaustive-deps": "off",
+    // Enforce the use of the shorthand syntax.
+    "object-shorthand": "error",
+    "no-console": "warn"
+  }
+}

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,42 @@
+<!--
+Thank you for contributing by opening an issue! Please take a moment to review our Code of Conduct (found in the CODE_OF_CONDUCT.md file) to keep the community approachable and respectful.
+
+For bug reports, please fill out the information below to help us understand the issue and address it in a timely manner. We value your feedback and contributions.
+-->
+
+# Brief Description
+<!-- A brief description of the issue.-->
+
+## Environment
+
+- `@smakss/convert-numbers` version:
+- Framework version (`react`, `react-native`, `Next.js`, `Remix` etc.`):
+- `node.js` version:
+- `npm` (or `yarn`) version:
+
+## Code Snippet
+<!-- Please provide any relevant code snippets or examples here -->
+
+```javascript
+// Your code here
+```
+
+## Steps to Reproduce
+<!-- What steps did we need to take to encounter the problem? -->
+
+## Expected Behavior
+<!-- What you expected to happen -->
+
+## Actual Behavior
+<!-- What actually happened. Include the full error message/screenshots/anything that might help understanding the issue -->
+
+## Reproduction Repository
+<!--
+If possible, please provide a repository link where the issue can be reproduced. A minimal test case would be greatly appreciated and can significantly speed up the resolution process.
+-->
+
+## Problem Description
+<!-- A clear and concise description of what the problem is. Include any additional context that might help us understand the issue. -->
+
+## Suggested Solution
+<!-- If you have any suggestion on how to fix the issue please provide it here. If not, just leave this section blank. -->

.github/workflows/ci.yml

@@ -0,0 +1,63 @@
+name: PR Checks
+
+on:
+  pull_request:
+    branches: [main]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        fetch-depth: 1
+
+    - name: Print head and base refs
+      run: |
+        echo "Head ref: ${{ github.head_ref }}"
+        echo "Base ref: ${{ github.base_ref }}"
+
+    - name: Setup Node.js
+      uses: actions/setup-node@v3
+      with:
+        node-version: "18"
+
+    - name: Cache dependencies
+      uses: actions/cache@v3
+      with:
+        path: |
+          **/node_modules
+        key: ${{ runner.os }}-node-18-yarn-${{ hashFiles('**/yarn.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-node-18-yarn-
+
+    - name: Install dependencies
+      run: yarn install
+
+    - name: Type check
+      run: yarn typecheck
+
+    - name: Check code quality
+      run: |
+        yarn lint
+        yarn format:check
+        yarn run --if-present generate
+
+    - name: Security Audit
+      run: yarn audit --level moderate || true
+      continue-on-error: true
+
+    - name: Security Audit Summary
+      if: success() || failure()
+      run: yarn audit --summary
+
+    - name: Archive production artifacts
+      uses: actions/upload-artifact@v3
+      with:
+        name: build-artifacts
+        path: ./build/
+
+    - name: Error handling
+      if: failure()
+      run: echo "CI failed. Please check the logs."

.github/workflows/npm-publish.yml

@@ -1,4 +1,4 @@
-name: "@smakss/convert-numbers"
+name: "@smakss/react-scroll-direction"
 
 on:
   release:
@@ -11,32 +11,64 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: 16
+          node-version: 18
+      - run: yarn
+      - run: yarn generate
+      - uses: actions/upload-artifact@v3
+        with:
+          name: built-package
+          path: |
+            ./path-to-your-build-folder
+            package.json
 
   publish-npm:
     needs: build
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
+      - uses: actions/download-artifact@v3
+        with:
+          name: built-package
       - uses: actions/setup-node@v3
         with:
-          node-version: 16
+          node-version: 18
           registry-url: https://registry.npmjs.org/
           scope: "@smakss"
-      - run: npm publish
+      - run: yarn install
+      - run: yarn generate
+      - run: |
+          if grep -q "beta" package.json; then
+            echo "Publishing Beta to npm"
+            npm publish --tag beta
+          else
+            echo "Publishing Release to npm"
+            npm publish
+          fi
         env:
-          NODE_AUTH_TOKEN: ${{secrets.npm_token}}
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
 
   publish-gpr:
     needs: build
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
+      - uses: actions/download-artifact@v3
+        with:
+          name: built-package
       - uses: actions/setup-node@v3
         with:
-          node-version: 16
+          node-version: 18
           registry-url: https://npm.pkg.github.com/
           scope: "@smakss"
-      - run: npm publish
+      - run: yarn install
+      - run: yarn generate
+      - run: |
+          if grep -q "beta" package.json; then
+            echo "Publishing Beta to GitHub Package Registry"
+            npm publish --tag beta
+          else
+            echo "Publishing Release to GitHub Package Registry"
+            npm publish
+          fi
         env:
           NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}

.gitignore

@@ -0,0 +1,20 @@
+# Logs
+logs
+*.log
+yarn-debug.log*
+yarn-error.log*
+
+# Dependency directories
+node_modules
+
+# Generate output
+dist
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz

.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+yarn commitlint --edit ${1}

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+yarn lint-staged

.prettierignore

@@ -0,0 +1,11 @@
+package.json
+.cache
+.shadowenv.d
+.vscode
+build
+dist
+node_modules
+public
+.github
+tmp
+*.yml

Readme.md

@@ -1,64 +1,64 @@
-# Convert numbers
+# Convert Numbers
 
-![npm](https://img.shields.io/npm/v/@smakss/convert-numbers) ![Snyk Vulnerabilities for npm package](https://img.shields.io/snyk/vulnerabilities/npm/@smakss/convert-numbers) ![NPM](https://img.shields.io/npm/l/@smakss/convert-numbers) ![npm](https://img.shields.io/npm/dt/@smakss/convert-numbers) ![npm bundle size (scoped)](https://img.shields.io/bundlephobia/min/@smakss/convert-numbers)
+![npm](https://img.shields.io/npm/v/@smakss/convert-numbers) ![NPM](https://img.shields.io/npm/l/@smakss/convert-numbers) ![npm](https://img.shields.io/npm/dt/@smakss/convert-numbers) ![npm bundle size (scoped)](https://img.shields.io/bundlephobia/min/@smakss/convert-numbers)
 
-Due to keeping consistency in our data transfer with API's we need to make sure digits or numbers entered by user inputs have always transferred by English. Since users could always fill data with different keyboard settings we need to make sure that we don't send Arabic or Persian numbers to our database. So to avoid such an inconsistency we should always translate our numbers or prevent a user from entering unwanted data. Convert numbers created for this cause to make sure every digit input is in standard format of it.
+Convert Numbers is a utility package that helps ensure consistency in data transfer by converting Arabic and Persian numerals to English numerals. This is particularly useful when user inputs can come from different keyboard settings, and there's a need to standardize all digits to English format before sending data to a database or processing it further.
 
 ## Demo
 
-You can check the [working demo](https://runkit.com/smakss/convert-numbers) in runkit.
+You can check the [working demo](https://runkit.com/smakss/convert-numbers) on RunKit.
 
-or
+Or
 
 [![View @smakss/convert-numbers](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/smakss-convert-numbers-bstmfj?fontsize=14&hidenavigation=1&theme=dark)
 
-## How it works?
+## Installation
 
-To install it you can simply do the following command:
+To install the package, you can use npm or yarn with the following commands:
 
 ```bash
 npm i @smakss/convert-numbers
-or
+# or
 yarn add @smakss/convert-numbers
 ```
 
-to include it with common js module you should do this:
+## Usage
 
-```js
-var ConvertNumbers = require("@smakss/convert-numbers");
-```
+Import the `convertNumbers` function into your project using CommonJS or ECMAScript modules:
 
-and to include it with ECMAscript module you can simply do this one:
+CommonJS:
 
 ```js
-import ConvertNumbers from "@smakss/convert-numbers";
+const ConvertNumbers = require('@smakss/convert-numbers');
 ```
 
-then to use it within your application you can do it just like this:
+ECMAScript Modules:
 
 ```js
-ConvertNumbers();
-
-// Result: undefined
-// If you don't provide any input it will return undefined.
+import ConvertNumbers from '@smakss/convert-numbers';
 ```
 
+Then, use the function as follows:
+
 ```js
-ConvertNumbers("۱۲۳۴۵۶۷۸۹۰");
+// Returns '1234567890' for Persian numbers
+console.log(ConvertNumbers('۱۲۳۴۵۶۷۸۹۰'));
 
-// Result: '1234567890'
+// Returns '1234567890' for Arabic numbers
+console.log(ConvertNumbers('١٢٣٤٥٦٧٨٩٠'));
+
+// Returns "" for no input
+console.log(ConvertNumbers());
 ```
 
-```js
-ConvertNumbers("١٢٣٤٥٦٧٨٩٠");
+## Documentation
 
-// Result: '1234567890'
-```
+For more detailed examples and function usage, please refer to the JSDoc comments within the code.
 
 ## Contributing
 
-Interested in making contributions to this project? Please see [CONTRIBUTING.md](https://github.com/SMAKSS/convert-numbers/blob/master/.github/CONTRIBUTING.md) for guidelines and details.
+Contributions to the project are welcome! Please refer to [CONTRIBUTING.md](./CONTRIBUTING.md) for contribution guidelines.
 
 ## Code of Conduct
 
-We value and prioritize the well-being of all our contributors and users. To ensure that this project remains a welcoming space for everyone, please refer to our [Code of Conduct](https://github.com/SMAKSS/convert-numbers/blob/master/.github/CODE_OF_CONDUCT.md).
+To maintain a welcoming and positive community, please see our [Code of Conduct](./CODE_OF_CONDUCT.md).

commitlint.config.cjs

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ["@commitlint/config-conventional"],
+};

lint-staged.config.cjs

@@ -0,0 +1,4 @@
+module.exports = {
+  "*.+(js|ts)": ["yarn lint", () => "yarn typecheck"],
+  "*.+(js|json|yml|yaml|ts|md)": ["yarn format"],
+};