{"_id":"@ashleyjacksonnet/bomweather","_rev":"4-db224e3ce89d9b96c26573485a6f0dd2","name":"@ashleyjacksonnet/bomweather","dist-tags":{"latest":"1.3.0"},"versions":{"1.2.1":{"name":"@ashleyjacksonnet/bomweather","version":"1.2.1","keywords":["weather","bom","bom-weather"],"license":"MIT","_id":"@ashleyjacksonnet/bomweather@1.2.1","maintainers":[{"name":"ashleyjacksonnet","email":"npmjs.wincing297@passmail.net"}],"homepage":"https://github.com/AshleyJackson/bom-weather#readme","bugs":{"url":"https://github.com/AshleyJackson/bom-weather/issues"},"dist":{"shasum":"a0ab80b83437481d3f4725544357810565cb5a6e","tarball":"https://registry.npmjs.org/@ashleyjacksonnet/bomweather/-/bomweather-1.2.1.tgz","fileCount":64,"integrity":"sha512-ycZ4+ROVK0mFvovsQ+29VMuxkOIvDLkZr4vyf1gkj/Fs6DZswCAUhOgXFnLXRqOPvHcDEs74T0SKXrSZSQOtbA==","signatures":[{"sig":"MEUCIFz8LCGywtLzRPE6he5po4ZLZlrSY4JKrb3ey+ts3kX2AiEAvYXL4tf1Fe/L3FOtuFQKlwagYe6uedWsJhC0csvNjN0=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":70608},"main":"dist/index.js","types":"dist/index.d.ts","module":"dist/index.mjs","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.mjs","require":"./dist/index.js"}},"gitHead":"8a39de85209b46fc11d844cb364bfb2f3a17c708","scripts":{"lint":"eslint src --ext ts --fix","test":"tsc && bun dist/tests/index.js","build":"tsc && bun build src/index.ts --outfile dist/index.mjs --format esm --target node --packages external","commit":"git-cz","prepublishOnly":"bun run build"},"_npmUser":{"name":"ashleyjacksonnet","email":"npmjs.wincing297@passmail.net"},"repository":{"url":"git+https://github.com/AshleyJackson/bom-weather.git","type":"git"},"_npmVersion":"10.9.8","description":"A simple package to receive data from the [Australian Bureau of Meteorology](http://www.bom.gov.au/) API.","directories":{},"lint-staged":{"src/**/*.ts":["eslint --fix"]},"_nodeVersion":"22.22.3","dependencies":{"axios":"^1.13.5","basic-ftp":"^5.1.0"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"^9.0.0","prettier":"^3.0.0","typescript":"^5.9.3","@types/node":"^22.0.0","lint-staged":"^15.0.0","eslint-config-prettier":"^10.0.0","eslint-plugin-prettier":"^5.0.0","@typescript-eslint/parser":"^8.0.0","@typescript-eslint/eslint-plugin":"^8.0.0"},"_npmOperationalInternal":{"tmp":"tmp/bomweather_1.2.1_1779786865139_0.7832919866433641","host":"s3://npm-registry-packages-npm-production"}},"1.3.0":{"name":"@ashleyjacksonnet/bomweather","version":"1.3.0","main":"dist/index.js","module":"dist/index.mjs","types":"dist/index.d.ts","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.mjs","require":"./dist/index.js"}},"license":"MIT","keywords":["weather","bom","bom-weather"],"repository":{"type":"git","url":"git+https://github.com/AshleyJackson/bom-weather.git"},"homepage":"https://github.com/AshleyJackson/bom-weather#readme","scripts":{"lint":"eslint src --fix","test":"tsc && bun dist/tests/index.js","build":"tsc && bun build src/index.ts --outfile dist/index.mjs --format esm --target node --packages external","prepublishOnly":"bun run build","commit":"git-cz"},"devDependencies":{"@types/node":"^22.0.0","@typescript-eslint/eslint-plugin":"^8.0.0","@typescript-eslint/parser":"^8.0.0","eslint":"^9.0.0","eslint-config-prettier":"^10.0.0","eslint-plugin-prettier":"^5.0.0","lint-staged":"^15.0.0","prettier":"^3.0.0","typescript":"^5.9.3","typescript-eslint":"^8.60.0"},"lint-staged":{"src/**/*.ts":["eslint --fix"]},"dependencies":{"axios":"^1.13.5","zod":"^4.4.3"},"_id":"@ashleyjacksonnet/bomweather@1.3.0","gitHead":"3254fe02617bd7aa5eefaa03f304e94e18759b08","description":"A simple package to receive data from the [Australian Bureau of Meteorology](http://www.bom.gov.au/) API.","bugs":{"url":"https://github.com/AshleyJackson/bom-weather/issues"},"_nodeVersion":"22.22.3","_npmVersion":"10.9.8","dist":{"integrity":"sha512-GkJCWBlBr4Zzajrg3OX15jmVL0Ns2ERJTu387xF42OTYmmDnuufRqtg9COjs5DkVijOo4gu9OshjqP1XqInlwA==","shasum":"8b4b6cc861b2222f367a9b6ddb507f276fd807b0","tarball":"https://registry.npmjs.org/@ashleyjacksonnet/bomweather/-/bomweather-1.3.0.tgz","fileCount":65,"unpackedSize":103254,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIBgL+aUbeAre0EJRZmmwYd3MNJVQJ7ASxt/hPpsRliW4AiBqrnTdigrb/tuQBX/xVrrHC9CRXNljHDfLSIH1BTHhNA=="}]},"_npmUser":{"name":"ashleyjacksonnet","email":"npmjs.wincing297@passmail.net"},"directories":{},"maintainers":[{"name":"ashleyjacksonnet","email":"npmjs.wincing297@passmail.net"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/bomweather_1.3.0_1779851014929_0.6455579733354313"},"_hasShrinkwrap":false}},"time":{"created":"2026-05-26T09:14:24.916Z","modified":"2026-05-27T03:03:35.188Z","1.2.0":"2026-02-14T03:18:33.458Z","1.2.1":"2026-05-26T09:14:25.277Z","1.3.0":"2026-05-27T03:03:35.059Z"},"bugs":{"url":"https://github.com/AshleyJackson/bom-weather/issues"},"license":"MIT","homepage":"https://github.com/AshleyJackson/bom-weather#readme","keywords":["weather","bom","bom-weather"],"repository":{"type":"git","url":"git+https://github.com/AshleyJackson/bom-weather.git"},"description":"A simple package to receive data from the [Australian Bureau of Meteorology](http://www.bom.gov.au/) API.","maintainers":[{"name":"ashleyjacksonnet","email":"npmjs.wincing297@passmail.net"}],"readme":"# bomweather\n\nA simple package to receive data from the [Australian Bureau of Meteorology](http://www.bom.gov.au/) API.\n\n## Installation\n\n```bash\nbun add @ashleyjacksonnet/bomweather\n```\n\n## How to Use\n\nAll access to the API endpoints is done off the `BOM` class\n\n```ts\nimport { BOM } from \"@ashleyjacksonnet/bomweather\";\n```\n\nAll methods are static, and can be accessed without constructing the class. To access an endpoint, all methods require a 6-digit [Geohash](https://en.wikipedia.org/wiki/Geohash) for the city to receive data for. Enums have been included for Geohashes of all the major cities of Australia.\n\nThe current available endpoints are as follows\n\n```ts\n// Search for locations by name (returns geohashes)\nBOM.searchLocations(\"Sydney\");\n\n// Get location information (timezone, coordinates, etc.)\nBOM.getLocationInfo(\"GEOHASH\");\n\n// Current Weather Observations\nBOM.getObservations(\"GEOHASH\");\n\n// Current Weather Warnings (if available)\nBOM.getWarnings(\"GEOHASH\");\n\n// Detailed Warning Information\nBOM.getWarningDetails(\"WARNING_ID\");\n\n// Array of Current and Upcoming Daily Forecasts\nBOM.getDailyForecast(\"GEOHASH\");\n\n// Array of Current and Upcoming Hourly Forecasts\nBOM.getHourlyForecast(\"GEOHASH\");\n\n// Array of Current and Upcoming Three-Hour Forecasts\nBOM.getThreeHourForecast(\"GEOHASH\");\n\n// Current Rain Forecast (if available)\nBOM.getRainForecast(\"GEOHASH\");\n```\n\n### Examples\n\nFind the current weather observations for Sydney\n\n```ts\nimport { BOM, Cities } from \"@ashleyjacksonnet/bomweather\";\n\nawait BOM.getObservations(Cities.SYDNEY);\n```\n\n## Publishing\n\nThis package is automatically published to npm when changes are pushed to the `main` branch. The CI/CD workflow:\n\n1. Runs linting checks\n2. Runs tests\n3. Builds the package and validates the output\n4. Tests package installation\n5. Reads the version from `package.json`\n6. Creates a Git tag (e.g., `v1.1.9`) and GitHub release\n7. Publishes to npmjs with provenance using OIDC authentication\n\nTo publish a new version:\n\n1. Update the version in `package.json` (e.g., `1.1.9` → `1.2.0`)\n2. Commit and push to `main` branch\n3. The workflow will automatically lint, test, build, tag, release, and publish\n\n**Note**: The workflow uses OpenID Connect (OIDC) for authentication with npm, which is more secure than using long-lived tokens. No npm token secret is required - authentication is handled automatically through GitHub's OIDC provider.\n\n## Disclaimer\n\n_Please Note: This package is meant for test purposes only. Under no circumstances is this API to be used for commercial or monetary purposes. Please contact [BOM](http://www.bom.gov.au/) directly to get access to a commercial license. All contributors on this package are in no way liable for any legal action taken against those misusing this API. By using this package you are acknowledging this disclaimer and agree to take personal responsibility to any misuse of this API_\n","readmeFilename":"README.md"}