{"_id":"@ayoasuransi/cfmzmanager","name":"@ayoasuransi/cfmzmanager","dist-tags":{"latest":"0.1.0"},"versions":{"0.1.0":{"name":"@ayoasuransi/cfmzmanager","version":"0.1.0","module":"commonjs","description":"Cloudflare Manager is a Node.js package for managing DNS records and subdomains in Cloudflare.","main":"index.js","scripts":{"test":"jest"},"repository":{"type":"git","url":"git+https://github.com/mzcoder-hub/cfmzmanager.git"},"keywords":["Cloudflare Manager","Configuration","API","License","Cloudflare","DNS","subdomains"],"author":{"name":"MzCoder"},"license":"MIT","bugs":{"url":"https://github.com/mzcoder-hub/cfmzmanager/issues"},"homepage":"https://github.com/mzcoder-hub/cfmzmanager#readme","dependencies":{"cfmzmanager":"^0.1.0","dformater":"^1.2.1","fs":"^0.0.1-security","responseformatjson":"^0.1.2"},"directories":{"test":"tests"},"devDependencies":{},"_id":"@ayoasuransi/cfmzmanager@0.1.0","gitHead":"06cb52304fdd295e165cf174ba1ef1ce1c145c82","_nodeVersion":"21.5.0","_npmVersion":"10.2.4","dist":{"integrity":"sha512-9DDfm4LwT6nQd1/AY/0d0CZkRv/bU3Z/9ZqVEOhXqvi5UODHeNyeVGC7KXmyc5VtDoImlixIWdwb/fsVoSrmJw==","shasum":"b03360b3ed1a9a6cb3ebd8cc1d16996554317a86","tarball":"https://registry.npmjs.org/@ayoasuransi/cfmzmanager/-/cfmzmanager-0.1.0.tgz","fileCount":4,"unpackedSize":4807,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDZ9vN7P3ujwla3S9T48uSbK2cypYlTX77fxIGk93DwhAIhAMxnfL6U8ylgj1jVC26m3oy4227AlLT9+gCxZEMPVE8p"}]},"_npmUser":{"name":"ayoasuransi","email":"galangypr@gmail.com"},"maintainers":[{"name":"ayoasuransi","email":"galangypr@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/cfmzmanager_0.1.0_1710701256049_0.07495764479473954"},"_hasShrinkwrap":false}},"time":{"created":"2024-03-17T18:47:35.936Z","0.1.0":"2024-03-17T18:47:36.178Z","modified":"2024-03-17T18:47:36.995Z"},"maintainers":[{"name":"ayoasuransi","email":"galangypr@gmail.com"}],"description":"Cloudflare Manager is a Node.js package for managing DNS records and subdomains in Cloudflare.","homepage":"https://github.com/mzcoder-hub/cfmzmanager#readme","keywords":["Cloudflare Manager","Configuration","API","License","Cloudflare","DNS","subdomains"],"repository":{"type":"git","url":"git+https://github.com/mzcoder-hub/cfmzmanager.git"},"author":{"name":"MzCoder"},"bugs":{"url":"https://github.com/mzcoder-hub/cfmzmanager/issues"},"license":"MIT","readme":"# Cloudflare Manager\r\n\r\nCloudflare Manager is a Node.js package for managing DNS records and subdomains in Cloudflare.\r\n\r\n## Installation\r\n\r\nTo install Cloudflare Manager, use npm:\r\n\r\n```bash\r\nnpm install cfmzmanager\r\n```\r\n\r\n## Usage\r\n\r\n```javascript\r\nconst CloudflareManager = require(\"cfmzmananger\");\r\n\r\nconst manager = new CloudflareManager();\r\n\r\n// Add subdomain example.com\r\nconst payload = { domain: \"example.com\" };\r\nmanager\r\n  .addSubdomain(payload)\r\n  .then((responseData) => {\r\n    console.log(responseData); // Response data from Cloudflare API\r\n  })\r\n  .catch((error) => {\r\n    console.error(error); // Error if DNS record creation failed\r\n  });\r\n```\r\n\r\n## Configuration\r\n\r\nBefore using Cloudflare Manager, make sure to set up a config.json file with your Cloudflare credentials:\r\n\r\n```json\r\n{\r\n  \"Cloudflare\": {\r\n    \"email\": \"your_email@example.com\",\r\n    \"apiKey\": \"your_api_key\",\r\n    \"zoneId\": \"your_zone_id\",\r\n    \"ipAddress\": \"your_server_ip_address\"\r\n  }\r\n}\r\n```\r\n\r\n## API\r\n\r\n`new CloudflareManager()`\r\n\r\nCreates a new instance of CloudflareManager.\r\n\r\n`addSubdomain(payload)`\r\n\r\nAdds a subdomain to Cloudflare DNS records.\r\n\r\n- `payload` (Object): An object containing the domain name.\r\n  - `domain` (String): The domain name to add.\r\n\r\nReturns a Promise that resolves with the response data from the Cloudflare API.\r\n\r\n## License\r\n\r\nThis project is licensed under the GPL LICENSE - see the LICENSE file for details.\r\n","readmeFilename":"readme.md"}