deen-api-client 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Imaniro
+
+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.

package/README.md

@@ -0,0 +1,68 @@
+# Deen API JS Client
+
+A Node.js client for the Deen API, providing easy access to Islamic resources including Hadith, Quran verses, and Duas.
+
+## Installation
+
+```bash
+npm install deen-api-client
+```
+
+# Quick Start
+
+```js
+const { ImaniroDeenAPIClient } = require('deen-api-client');
+
+// Or using ES modules
+import { ImaniroDeenAPIClient } from 'deen-api-client';
+
+// Initialize client with your API key
+const client = new ImaniroDeenAPIClient('your_api_key_here');
+
+// Get hadiths from Sahih al-Bukhari
+async function getHadiths() {
+  try {
+    const hadiths = await client.getHadiths('Sahih al-Bukhari', 5);
+
+    hadiths.forEach((hadith) => {
+      console.log(`Book: ${hadith.book}`);
+      console.log(`Chapter: ${hadith.chapter}`);
+      console.log(`Text: ${hadith.text}`);
+      console.log(`Translation: ${hadith.translation}`);
+      console.log('---');
+    });
+  } catch (error) {
+    console.error('Error:', error.message);
+  }
+}
+
+getHadiths();
+```
+
+# API Reference
+
+## Methods
+
+- getHadiths(book, maxLimits, options)
+
+- getQuranVerses(surah, verse, maxLimits, options)
+
+- getDuas(category, maxLimits, options)
+
+- searchHadith(query, book, maxLimits)
+
+- getBooks()
+
+# Error Handling
+
+```js
+try {
+  const hadiths = await client.getHadiths('Sahih al-Bukhari');
+} catch (error) {
+  if (error.name === 'AuthenticationError') {
+    console.log('Invalid API key');
+  } else if (error.name === 'RateLimitError') {
+    console.log('Rate limit exceeded');
+  }
+}
+```

package/dist/client.js

@@ -0,0 +1,76 @@
+const axios = require('axios');
+const {
+  DeenAPIError,
+  AuthenticationError,
+  RateLimitError,
+  NotFoundError,
+  ServerError
+} = require('./exceptions');
+const {
+  Hadith,
+  QuranVerse,
+  Dua,
+  APIResponse
+} = require('./models');
+class ImaniroDeenAPIClient {
+  constructor(apiKey, baseURL = 'https://deen-api.imaniro.com/api/v1') {
+    if (!apiKey) {
+      throw new Error('API key is required');
+    }
+    this.apiKey = apiKey;
+    this.baseURL = baseURL.replace(/\/$/, '');
+    this.client = axios.create({
+      baseURL: this.baseURL,
+      headers: {
+        'Content-Type': 'application/json',
+        'X-API-Key': this.apiKey
+      },
+      timeout: 30000
+    });
+    this._setupInterceptors();
+  }
+  _setupInterceptors() {
+    this.client.interceptors.response.use(response => response, error => {
+      if (error.response) {
+        const {
+          status,
+          data
+        } = error.response;
+        switch (status) {
+          case 401:
+            throw new AuthenticationError(data?.message);
+          case 404:
+            throw new NotFoundError(data?.message);
+          case 429:
+            throw new RateLimitError(data?.message);
+          case 500:
+            throw new ServerError(data?.message);
+          default:
+            throw new DeenAPIError(data?.message || `HTTP Error: ${status}`, status);
+        }
+      } else if (error.request) {
+        throw new DeenAPIError('Network error: Unable to connect to API');
+      } else {
+        throw new DeenAPIError(error.message);
+      }
+    });
+  }
+  async _makeRequest(endpoint, params = {}) {
+    try {
+      const response = await this.client.post(`/${endpoint}`, params);
+      return new APIResponse(response.data);
+    } catch (error) {
+      throw error;
+    }
+  }
+  async getHadiths(book, maxLimits = 10, options = {}) {
+    const params = {
+      book,
+      maxLimits,
+      ...options
+    };
+    const response = await this._makeRequest('hadiths', params);
+    return response.data.map(item => new Hadith(item));
+  }
+}
+module.exports = ImaniroDeenAPIClient;

package/dist/exceptions.js

@@ -0,0 +1,38 @@
+class DeenAPIError extends Error {
+  constructor(message, statusCode) {
+    super(message);
+    this.name = 'DeenAPIError';
+    this.statusCode = statusCode;
+  }
+}
+class AuthenticationError extends DeenAPIError {
+  constructor(message = 'Invalid API key') {
+    super(message, 401);
+    this.name = 'AuthenticationError';
+  }
+}
+class RateLimitError extends DeenAPIError {
+  constructor(message = 'Rate limit exceeded') {
+    super(message, 429);
+    this.name = 'RateLimitError';
+  }
+}
+class NotFoundError extends DeenAPIError {
+  constructor(message = 'Resource not found') {
+    super(message, 404);
+    this.name = 'NotFoundError';
+  }
+}
+class ServerError extends DeenAPIError {
+  constructor(message = 'Server error occurred') {
+    super(message, 500);
+    this.name = 'ServerError';
+  }
+}
+module.exports = {
+  DeenAPIError,
+  AuthenticationError,
+  RateLimitError,
+  NotFoundError,
+  ServerError
+};

package/dist/index.js

@@ -0,0 +1,25 @@
+const ImaniroDeenAPIClient = require('./client');
+const {
+  Hadith,
+  APIResponse
+} = require('./models');
+const {
+  DeenAPIError,
+  AuthenticationError,
+  RateLimitError,
+  NotFoundError,
+  ServerError
+} = require('./exceptions');
+module.exports = {
+  ImaniroDeenAPIClient,
+  Hadith,
+  APIResponse,
+  DeenAPIError,
+  AuthenticationError,
+  RateLimitError,
+  NotFoundError,
+  ServerError
+};
+
+// Default export for ES modules
+module.exports.default = ImaniroDeenAPIClient;

package/dist/models.js

@@ -0,0 +1,26 @@
+class Hadith {
+  constructor(data) {
+    this.attribution = data.attribution || '';
+    this.authenticity = data.authenticity || '';
+    this.category = data.category || '';
+    this.context = data.context | '';
+    this.book = data.book || '';
+    this.number = data.number || '';
+    this.explanation = data.explanation || '';
+    this.hadith = data.hadith || '';
+    this.narratedBy = data.narratedBy || '';
+    this.translation = data.translation || '';
+  }
+}
+class APIResponse {
+  constructor(data) {
+    this.success = data.success || false;
+    this.data = data.data || [];
+    this.message = data.message || '';
+    this.count = data.count || 0;
+  }
+}
+module.exports = {
+  Hadith,
+  APIResponse
+};

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "deen-api-client",
+  "version": "1.0.0",
+  "description": "Node.js client for Deen API - Islamic resources API (Hadith, Quran, Duas)",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "babel src --out-dir dist",
+    "prepublishOnly": "npm run build",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "example": "node examples/hadith-example.js"
+  },
+  "keywords": [
+    "islamic",
+    "api",
+    "hadith",
+    "quran",
+    "dua",
+    "muslim",
+    "deen",
+    "islam"
+  ],
+  "author": "Imaniro Pvt Ltd <info@imaniro.com>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/imaniro-tech/deen-api-js-client.git"
+  },
+  "homepage": "https://github.com/imaniro-tech/deen-api-js-client",
+  "bugs": {
+    "url": "https://github.com/imaniro-tech/deen-api-js-client/issues"
+  },
+  "dependencies": {
+    "axios": "^1.6.0"
+  },
+  "devDependencies": {
+    "@babel/cli": "^7.28.3",
+    "@babel/core": "^7.28.4",
+    "@babel/preset-env": "^7.28.3",
+    "jest": "^29.7.0",
+    "nock": "^13.5.6"
+  },
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "directories": {
+    "example": "examples",
+    "test": "tests"
+  }
+}