6.3.0-alpha.0

.eslintrc.js

@@ -22,38 +22,43 @@ module.exports = {
 		'@typescript-eslint/naming-convention': [
 			'warn',
 			{
-				selector: ['class'],
+				selector: ['class', 'enum'],
 				format: ['PascalCase'],
 			},
 			{
-				selector: 'interface',
+				selector: ['interface'],
 				format: ['PascalCase'],
 				prefix: ['I'],
 			},
 			{
-				selector: 'enum',
+				selector: ['typeAlias'],
 				format: ['PascalCase'],
-				prefix: ['E'],
 			},
 			{
-				selector: ['variableLike', 'memberLike'],
+				selector: ['memberLike', 'variableLike'],
 				format: ['camelCase'],
+				leadingUnderscore: 'allow',
 			},
 			{
-				selector: ['variableLike', 'property'],
+				selector: ['memberLike'],
 				modifiers: ['private'],
 				format: ['camelCase'],
 				leadingUnderscore: 'require',
 			},
 			{
-				selector: ['variableLike', 'memberLike'],
+				selector: ['memberLike'],
 				modifiers: ['static', 'readonly'],
 				format: ['UPPER_CASE'],
 			},
 			{
-				selector: 'enumMember',
+				selector: ['enumMember'],
 				format: ['UPPER_CASE'],
 			},
+			{
+				selector: ['variable'],
+				modifiers: ['global'],
+				format: ['PascalCase'],
+			},
 		],
 		'@typescript-eslint/explicit-function-return-type': 'error',
 		'@typescript-eslint/explicit-module-boundary-types': 'error',

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -0,0 +1,57 @@
+name: '🐛 Bug report'
+description: Report a bug to help us improve Rettiwt-API.
+labels: ['triage', 'bug']
+body:
+    - type: markdown
+      attributes:
+          value: |
+              Before reporting a bug, please make sure you have read through our [documentation](https://rishikant181.github.io/Rettiwt-API/) and checked existing [issues](https://github.com/Rishikant181/Rettiwt-API/issues?q=is%3Aissue%20is%3Aopen%20sort%3Aupdated-desc).
+    - type: textarea
+      id: env
+      attributes:
+          label: Environment
+          description: Please provide your environment details. You can use `node -v` and `npm list rettiwt-api` to fill this section.
+          placeholder: |
+              - Operating System: `Windows/Linux/macOS`
+              - Node Version:     `v22.x.x` (Rettiwt-API requires NodeJS 20+)
+              - Rettiwt-API Version: `x.x.x`
+              - Package Manager:  `npm/yarn/pnpm`
+              - CLI or Dependency: `CLI` or `Dependency`
+      validations:
+          required: true
+    - type: textarea
+      id: reproduction
+      attributes:
+          label: Reproduction
+          description: Please provide a minimal code snippet or CLI command that reproduces the issue. If possible, include the API_KEY usage and any relevant configuration. If the report is vague and has no reproduction, it may be closed automatically.
+          placeholder: |
+              ```ts
+              import { Rettiwt } from 'rettiwt-api';
+              const rettiwt = new Rettiwt({ apiKey: '<API_KEY>' });
+              // ...
+              ```
+              or
+              ```sh
+              rettiwt <command> -k <API_KEY>
+              ```
+      validations:
+          required: true
+    - type: textarea
+      id: description
+      attributes:
+          label: Description
+          description: A clear and concise description of what the bug is. If you intend to submit a PR for this issue, mention it here.
+      validations:
+          required: true
+    - type: textarea
+      id: additional
+      attributes:
+          label: Additional context
+          description: If applicable, add any other context, configuration, or screenshots here.
+    - type: textarea
+      id: logs
+      attributes:
+          label: Logs
+          description: |
+              Please copy-paste any error logs or stack traces here. Avoid screenshots if possible.
+          render: shell-script

.github/ISSUE_TEMPLATE/feature-request.yml

@@ -0,0 +1,20 @@
+name: '🚀 Feature request (Rettiwt-API)'
+description: Suggest an idea or enhancement for Rettiwt-API.
+labels: ['triage', 'enhancement', 'feature-request']
+body:
+    - type: markdown
+      attributes:
+          value: |
+              Before requesting a feature, please make sure you have read through our [documentation](https://rishikant181.github.io/Rettiwt-API/) and checked existing [issues](https://github.com/Rishikant181/Rettiwt-API/issues?q=is%3Aissue%20is%3Aopen%20sort%3Aupdated-desc).
+    - type: textarea
+      id: description
+      attributes:
+          label: Description
+          description: A clear and concise description of the feature or enhancement. Include possible use cases, alternatives, and links to any prototype or related module.
+      validations:
+          required: true
+    - type: textarea
+      id: additional
+      attributes:
+          label: Additional context
+          description: If applicable, add any other context, configuration, or screenshots here.

.github/ISSUE_TEMPLATE/question.yml

@@ -0,0 +1,15 @@
+name: '💬 Question (Rettiwt-API)'
+description: Ask a question about Rettiwt-API.
+labels: ['question']
+body:
+    - type: markdown
+      attributes:
+          value: |
+              Before asking a question, please make sure you have read through our [documentation](https://rishikant181.github.io/Rettiwt-API/) and checked existing [issues](https://github.com/Rishikant181/Rettiwt-API/issues?q=is%3Aissue%20is%3Aopen%20sort%3Aupdated-desc).
+    - type: textarea
+      id: description
+      attributes:
+          label: Description
+          description: Please provide a clear and concise question. Include any relevant context, code snippets, or links to documentation.
+      validations:
+          required: true

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,32 @@
+## 🔗 Related Issue
+
+<!-- Reference any related issue or discussion, e.g. "Closes #123" -->
+
+## ❓ Type of Change
+
+<!-- Select all that apply -->
+
+- [ ] 📖 Documentation (docs, README, or comments)
+- [ ] 🐞 Bug fix (non-breaking fix for an issue)
+- [ ] 👌 Enhancement (improvement to existing functionality)
+- [ ] ✨ New feature (adds new functionality)
+- [ ] 🧹 Chore (build, tooling, dependencies)
+- [ ] ⚠️ Breaking change (affects existing usage)
+
+## 📚 Description
+
+<!--
+Describe your changes and their motivation.
+What problem does this solve? Any relevant context for Rettiwt-API?
+-->
+
+## 📝 Checklist
+
+- [ ] Issue/discussion linked above.
+- [ ] Documentation updated (if needed).
+- [ ] Code follows project conventions and ESLint rules.
+- [ ] No sensitive data or credentials are included.
+
+<!--
+If you need help, mention @Rishikant181 or ask in the discussions.
+-->

.github/workflows/ci.yml

@@ -0,0 +1,33 @@
+name: ci
+
+on:
+    push:
+        branches:
+            - dev
+    pull_request:
+        branches:
+            - dev
+jobs:
+    ci:
+        runs-on: ${{ matrix.os }}
+
+        strategy:
+            matrix:
+                os: [ubuntu-latest]
+                node: [22]
+
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+
+            - name: Install node
+              uses: actions/setup-node@v4
+
+            - name: Install dependencies
+              run: npm install
+
+            - name: Run Format check
+              run: npm run format:check
+
+            - name: Run Lint check
+              run: npm run lint:check

.gitignore

@@ -121,6 +121,7 @@ dist
 
 # VSCode configs
 .vscode
+.devcontainer
 
 # Stores VSCode versions used for testing VSCode extensions
 .vscode-test
@@ -138,4 +139,7 @@ test
 # Documentation
 docs
 
-.idea
+.idea
+
+# Debugging
+src/debug.ts

.nvmrc

@@ -0,0 +1 @@
+22.21.0