@youmind-openlab/rettiwt-api 1.0.0

package/.claude/settings.local.json

@@ -0,0 +1,8 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(npm run build:*)",
+      "Bash(npm run build:browser:*)"
+    ]
+  }
+}

package/.eslintrc.js

@@ -0,0 +1,167 @@
+module.exports = {
+	parser: '@typescript-eslint/parser',
+	parserOptions: {
+		project: 'tsconfig.json',
+		tsconfigRootDir: __dirname,
+		sourceType: 'module',
+	},
+	plugins: ['@typescript-eslint/eslint-plugin', 'eslint-plugin-tsdoc', 'import'],
+	extends: [
+		'plugin:@typescript-eslint/recommended',
+		'plugin:@typescript-eslint/recommended-requiring-type-checking',
+		'plugin:import/recommended',
+		'plugin:import/typescript',
+	],
+	root: true,
+	env: {
+		node: true,
+		jest: true,
+	},
+	ignorePatterns: ['.eslintrc.js', 'eslint.config.mjs'],
+	rules: {
+		'@typescript-eslint/naming-convention': [
+			'warn',
+			{
+				selector: ['class', 'enum'],
+				format: ['PascalCase'],
+			},
+			{
+				selector: ['interface'],
+				format: ['PascalCase'],
+				prefix: ['I'],
+			},
+			{
+				selector: ['typeAlias'],
+				format: ['PascalCase'],
+			},
+			{
+				selector: ['memberLike', 'variableLike'],
+				format: ['camelCase'],
+				leadingUnderscore: 'allow',
+			},
+			{
+				selector: ['memberLike'],
+				modifiers: ['private'],
+				format: ['camelCase'],
+				leadingUnderscore: 'require',
+			},
+			{
+				selector: ['memberLike'],
+				modifiers: ['static', 'readonly'],
+				format: ['UPPER_CASE'],
+			},
+			{
+				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',
+		'@typescript-eslint/explicit-member-accessibility': 'error',
+		'@typescript-eslint/member-ordering': [
+			'warn',
+			{
+				default: {
+					memberTypes: [
+						// FIELDS
+
+						// PRIVATE
+						'private-static-readonly-field',
+						'private-static-field',
+						'private-readonly-field',
+						'private-field',
+
+						// PROTECTED
+						'protected-static-readonly-field',
+						'protected-static-field',
+						'protected-readonly-field',
+						'protected-field',
+
+						// PUBLIC
+						'public-static-readonly-field',
+						'public-static-field',
+						'public-readonly-field',
+						'public-field',
+
+						// CONSTRUCTORS
+						'private-constructor',
+						'protected-constructor',
+						'public-constructor',
+
+						// GETTERS
+
+						// PRIVATE
+						'private-static-get',
+						'private-get',
+
+						// PROTECTED
+						'protected-static-get',
+						'protected-get',
+
+						// PUBLIC
+						'public-static-get',
+						'public-get',
+
+						// SETTERS
+
+						// PRIVATE
+						'private-static-set',
+						'private-set',
+
+						// PROTECTED
+						'protected-static-set',
+						'protected-set',
+
+						// PUBLIC
+						'public-static-set',
+						'public-set',
+
+						// METHODS
+
+						// PRIVATE
+						'private-static-method',
+						'private-method',
+
+						// PROTECTED
+						'protected-static-method',
+						'protected-method',
+
+						// PUBLIC
+						'public-static-method',
+						'public-method',
+					],
+					order: 'alphabetically',
+				},
+			},
+		],
+		'@typescript-eslint/no-explicit-any': 'warn',
+		'@typescript-eslint/no-inferrable-types': 'warn',
+		'tsdoc/syntax': 'warn',
+		'sort-imports': [
+			'warn',
+			{
+				ignoreCase: true,
+				ignoreDeclarationSort: true,
+				ignoreMemberSort: false,
+				memberSyntaxSortOrder: ['none', 'all', 'multiple', 'single'],
+				allowSeparatedGroups: false,
+			},
+		],
+		'import/order': [
+			'warn',
+			{
+				groups: ['builtin', 'external', 'internal', 'parent', 'sibling', 'index', 'object', 'type'],
+				alphabetize: {
+					order: 'asc',
+					caseInsensitive: true,
+				},
+				'newlines-between': 'always-and-inside-groups',
+			},
+		],
+	},
+};

package/.gitattributes

@@ -0,0 +1,3 @@
+* text=auto eol=lf
+*.{cmd,[cC][mM][dD]} text eol=crlf
+*.{bat,[bB][aA][tT]} text eol=crlf

package/.github/FUNDING.yml

@@ -0,0 +1,4 @@
+# These are supported funding model platforms
+
+# github: [Rishikant181]
+custom: ['https://paypal.me/Rishikant181?country.x=IN&locale.x=en_GB']

package/.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

package/.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.

package/.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

package/.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.
+-->

package/.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

package/.github/workflows/documentation.yml

@@ -0,0 +1,49 @@
+name: Documentation
+run-name: Building the documentation for the release
+
+on:
+    release:
+        types: [released]
+
+jobs:
+    # Builds and packages the documentation
+    build:
+        runs-on: ubuntu-latest
+        steps:
+            # Setting up Node
+            - uses: actions/checkout@v4
+            - uses: actions/setup-node@v3
+              with:
+                  node-version: '22.x'
+
+            # Installing dependencies
+            - run: npm install
+
+            # Generating docs
+            - run: npx typedoc src/index.ts
+
+            # Packaging the static site as artifact
+            - uses: actions/upload-pages-artifact@v3
+              with:
+                  path: ./docs
+
+    # Deploys the packaged documentation
+    deploy:
+        # Building and packaging the documentation
+        needs: build
+
+        # Granting necessary permissions
+        permissions:
+            pages: write
+            id-token: write
+
+        # Setting up GH pages environment
+        environment:
+            name: github-pages
+            url: ${{ steps.deployment.outputs.page_url }}
+
+        runs-on: ubuntu-latest
+        steps:
+            # Deploying to gh pages
+            - id: deployment
+              uses: actions/deploy-pages@v4

package/.github/workflows/publish-alpha.yml

@@ -0,0 +1,26 @@
+name: Publish Alpha
+run-name: Publishing the alpha package to NPM
+
+on:
+    release:
+        types: [prereleased]
+
+jobs:
+    # Packages and publishes the package to NPM
+    publish-npm:
+        runs-on: ubuntu-latest
+        steps:
+            # Setting up Node
+            - uses: actions/checkout@v3
+            - uses: actions/setup-node@v3
+              with:
+                  node-version: '22.x'
+                  registry-url: https://registry.npmjs.org/
+
+            # Installing dependencies
+            - run: npm install
+
+            # Publishing to NPM
+            - run: npm publish --tag alpha
+              env:
+                  NODE_AUTH_TOKEN: ${{secrets.npm_token}}

package/.github/workflows/publish.yml

@@ -0,0 +1,26 @@
+name: Publish
+run-name: Publishing the package to NPM
+
+on:
+    release:
+        types: [released]
+
+jobs:
+    # Packages and publishes the package to NPM
+    publish-npm:
+        runs-on: ubuntu-latest
+        steps:
+            # Setting up Node
+            - uses: actions/checkout@v3
+            - uses: actions/setup-node@v3
+              with:
+                  node-version: '22.x'
+                  registry-url: https://registry.npmjs.org/
+
+            # Installing dependencies
+            - run: npm install
+
+            # Publishing to NPM
+            - run: npm publish
+              env:
+                  NODE_AUTH_TOKEN: ${{secrets.npm_token}}

package/.nvmrc

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

package/.prettierignore

@@ -0,0 +1,3 @@
+dist/
+node_modules/
+docs/

package/.prettierrc

@@ -0,0 +1,13 @@
+{
+	"arrowParens": "always",
+	"bracketSpacing": true,
+	"endOfLine": "auto",
+	"printWidth": 120,
+	"quoteProps": "as-needed",
+	"semi": true,
+	"singleQuote": true,
+	"tabWidth": 4,
+	"trailingComma": "all",
+	"useTabs": true,
+	"vueIndentScriptAndStyle": true
+}

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Rishikant Sahu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.