{"_id":"@al-madhrasathul-arabiyyathul-islamiyya/ts-dhiraagu-bulk-sms","_rev":"1-be728df9723a6dd3fe04038f4d43976c","name":"@al-madhrasathul-arabiyyathul-islamiyya/ts-dhiraagu-bulk-sms","dist-tags":{"latest":"1.0.2"},"versions":{"1.0.0":{"name":"@al-madhrasathul-arabiyyathul-islamiyya/ts-dhiraagu-bulk-sms","version":"1.0.0","keywords":["sms","dhiraagu","typescript","sdk"],"author":{"name":"Ahmed Misbah","email":"ahmed.misbah@arabiyya.edu.mv"},"license":"MIT","_id":"@al-madhrasathul-arabiyyathul-islamiyya/ts-dhiraagu-bulk-sms@1.0.0","maintainers":[{"name":"arabiyya-school","email":"it@arabiyya.edu.mv"}],"dist":{"shasum":"0d659a93f2ca05eb4e13c4a54be4a684cfd0ad04","tarball":"https://registry.npmjs.org/@al-madhrasathul-arabiyyathul-islamiyya/ts-dhiraagu-bulk-sms/-/ts-dhiraagu-bulk-sms-1.0.0.tgz","fileCount":43,"integrity":"sha512-8CFgpkw2iU85IvZP4UpWPmxIMJdF9Xl2eT0EV7yHCg7o+weBSlJdsuXCNMlEE9YCLjce2Tx+TiJ1ezHzH0BjJQ==","signatures":[{"sig":"MEUCIQDlGXvg+LGaOM3Lb5233gwiy57gZkRrTZCASZjzERDr0wIgHI4Tl8X4v5X0iZoRWxtbwVOTrQPKrI4QiHVe8sVNlMY=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":31043},"main":"dist/index.js","types":"dist/index.d.ts","gitHead":"0fd24b3dc58bdc6f46980e63eecac68daded99f8","scripts":{"lint":"eslint 'src/**/*.ts'","test":"jest --coverage","build":"tsc","prepublishOnly":"npm run build"},"_npmUser":{"name":"arabiyya-school","email":"it@arabiyya.edu.mv"},"_npmVersion":"10.9.0","description":"TypeScript SDK for Dhiraagu Bulk SMS Gateway","directories":{},"_nodeVersion":"23.1.0","dependencies":{"xml2js":"^0.5.0","typescript":"^5.7.2"},"_hasShrinkwrap":false,"devDependencies":{"jest":"^29.7.0","nock":"^13.5.6","eslint":"^8.0.0","expect":"^29.7.0","ts-jest":"^29.2.5","typescript":"^5.0.0","@types/jest":"^29.5.14","@types/node":"^22.10.2","@types/xml2js":"^0.4.14"},"_npmOperationalInternal":{"tmp":"tmp/ts-dhiraagu-bulk-sms_1.0.0_1734296528825_0.30606090338803016","host":"s3://npm-registry-packages-npm-production"}},"1.0.2":{"name":"@al-madhrasathul-arabiyyathul-islamiyya/ts-dhiraagu-bulk-sms","version":"1.0.2","description":"TypeScript SDK for Dhiraagu Bulk SMS Gateway","author":{"name":"Ahmed Misbah","email":"ahmed.misbah@arabiyya.edu.mv"},"license":"MIT","main":"dist/index.js","types":"dist/index.d.ts","scripts":{"build":"tsc","lint":"eslint 'src/**/*.ts'","test":"jest --coverage","prepublishOnly":"npm run build"},"dependencies":{"typescript":"^5.7.2","xml2js":"^0.5.0"},"devDependencies":{"@types/jest":"^29.5.14","@types/node":"^22.10.2","@types/xml2js":"^0.4.14","eslint":"^8.0.0","expect":"^29.7.0","jest":"^29.7.0","nock":"^13.5.6","ts-jest":"^29.2.5","typescript":"^5.0.0"},"keywords":["sms","dhiraagu","typescript","sdk"],"_id":"@al-madhrasathul-arabiyyathul-islamiyya/ts-dhiraagu-bulk-sms@1.0.2","gitHead":"421fe214c515cbd967d693402205a10a6c53d4d1","_nodeVersion":"23.1.0","_npmVersion":"10.9.0","dist":{"integrity":"sha512-YAc8LOxhNvXbjRxJXpk0pcLG5ksh7W6hZooz1fIbsIEuxubFgqlPJgLiwqbGQS98HiIjo+mK0b3Gb3Y+wQFbNA==","shasum":"207792dfbf2a6da76d5aa63e59f35652d1cbdefa","tarball":"https://registry.npmjs.org/@al-madhrasathul-arabiyyathul-islamiyya/ts-dhiraagu-bulk-sms/-/ts-dhiraagu-bulk-sms-1.0.2.tgz","fileCount":46,"unpackedSize":32440,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIHTQA/CP5ZCT0YePpjxKMG+3d6ole7VfHMZvWYBkvsPsAiEAtg6m4YgZ5hnti+6fozRYiEsGozfEr/UaV/+UwQqwVns="}]},"_npmUser":{"name":"arabiyya-school","email":"it@arabiyya.edu.mv"},"directories":{},"maintainers":[{"name":"arabiyya-school","email":"it@arabiyya.edu.mv"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/ts-dhiraagu-bulk-sms_1.0.2_1734339735609_0.07384400499403254"},"_hasShrinkwrap":false}},"time":{"created":"2024-12-15T21:02:08.736Z","modified":"2024-12-16T09:02:15.971Z","1.0.0":"2024-12-15T21:02:09.005Z","1.0.2":"2024-12-16T09:02:15.784Z"},"author":{"name":"Ahmed Misbah","email":"ahmed.misbah@arabiyya.edu.mv"},"license":"MIT","keywords":["sms","dhiraagu","typescript","sdk"],"description":"TypeScript SDK for Dhiraagu Bulk SMS Gateway","maintainers":[{"name":"arabiyya-school","email":"it@arabiyya.edu.mv"}],"readme":"# Dhiraagu Builk SMS (TypeScript)\n\n[![License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](LICENSE)\n\nTypeScript SDK for [Dhiraagu Bulk SMS Gateway](https://bulkmessage.dhiraagu.com.mv), inspired by the [PHP SDK](https://github.com/dash8x/dhiraagu-sms) developed by [Arushad Ahmed (@dash8x)](http://arushad.org).\n\n## Installation\n\nInstall the library using npm or yarn:\n\n```bash\nnpm install dhiraagu-sms\n# or\nyarn add dhiraagu-sms\n```\n\n## Quickstart\n\nSending an SMS\n\n```ts\n// Import the library\nimport { DhiraaguSms } from \"dhiraagu-sms\";\n\nconst username = \"XXXXXXX\"; // Your SMS username from Dhiraagu\nconst password = \"YYYYYY\"; // Your SMS password\nconst url = \"https://bulksms.dhiraagu.com.mv/partners/xmlMessage.jsp\"; // Optional, leave blank to use the default API endpoint\n\nconst client = new DhiraaguSms(username, password, url);\n\n(async () => {\n  try {\n    const message = await client.send(\n      \"+9607777777\", // Recipient's number; use an array for multiple recipients\n      \"Hello World!\" // Your message\n    );\n\n    console.log(\"Message ID:\", message.messageId);\n  } catch (error) {\n    console.error(\"Error sending SMS:\", error);\n  }\n})();\n```\n\n## Checking SMS Delivery Status\n\n```ts\nimport { DhiraaguSms } from \"dhiraagu-sms\";\n\nconst username = \"XXXXXXX\"; // Your SMS username\nconst password = \"YYYYYY\"; // Your SMS password\n\nconst client = new DhiraaguSms(username, password);\n\n(async () => {\n  try {\n    const message = await client.send(\n      \"+9607777777\", // Recipient's number\n      \"Hello World!\" // Your message\n    );\n\n    const delivery = await client.delivery(\n      message.messageId, // Message ID\n      message.messageKey // Message key\n    );\n\n    console.log(\"Delivery Status:\", delivery.messageStatusDesc);\n\n    // Check the status for a particular recipient\n    const device = delivery.getDevice(\"9607777777\"); // Omit the \"+\" in the country code\n    console.log(\"Recipient Status:\", device?.statusDesc);\n  } catch (error) {\n    console.error(\"Error checking delivery status:\", error);\n  }\n})();\n```\n\n## Features\n\n- Send SMS messages to one or multiple recipients.\n- Check delivery statuses for sent messages.\n- Retrieve detailed recipient statuses.\n\n## XML Templates\n\nThe library uses XML templates similar to the PHP version. These templates are located in the src/xml folder.\n\n## Credits\n\nThis library was adapted from the PHP SDK by Arushad Ahmed (@dash8x). Special thanks for the original implementation and inspiration.\n\n## Disclaimer\n\nThis package is not officially affiliated with Dhiraagu. The \"Dhiraagu\" name is used under fair use.\n\n## License\n\nThis SDK is open-source software licensed under the MIT license.\n","readmeFilename":"README.md"}