{"_id":"@braw/extended-intl","_rev":"3-aa1ea05415e823262dc011d32751c72a","name":"@braw/extended-intl","dist-tags":{"latest":"2.0.0"},"versions":{"1.0.0":{"name":"@braw/extended-intl","version":"1.0.0","description":"Wrapper for @formatjs/intl with additional features.","license":"MIT","sideEffects":false,"type":"module","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.mjs","require":"./dist/index.cjs"},"./forceNumberFormatPolyfill":{"types":"./dist/forceNumberFormatPolyfill.d.ts","import":"./dist/forceNumberFormatPolyfill.mjs","require":"./dist/forceNumberFormatPolyfill.cjs"},"./package.json":"./package.json"},"module":"./dist/index.mjs","main":"./dist/index.cjs","types":"./dist/index.d.ts","scripts":{"build":"unbuild","dev":"vitest dev","prepack":"pnpm run build && pnpm run test","test":"vitest run","lint":"eslint src --ext .js,.ts"},"dependencies":{"@formatjs/ecma402-abstract":"^1.14.3","@formatjs/intl-numberformat":"^8.3.3"},"devDependencies":{"@babel/core":"^7.20.7","@babel/plugin-proposal-nullish-coalescing-operator":"^7.18.6","@babel/plugin-transform-typescript":"^7.20.7","@babel/preset-env":"^7.20.2","@babel/preset-typescript":"^7.18.6","@nuxtjs/eslint-config-typescript":"^12.0.0","@rollup/plugin-babel":"^6.0.3","@types/node":"^18.11.15","eslint":"^8.29.0","prettier":"^2.8.1","prettier-plugin-jsdoc":"^0.4.2","semantic-release":"^19.0.5","typescript":"^4.9.4","unbuild":"^1.0.2","vitest":"^0.25.8"},"peerDependencies":{"@formatjs/icu-messageformat-parser":"^2.1.14","@formatjs/intl":"^2.6.3","intl-messageformat":"^10.2.5"},"publishConfig":{"access":"public"},"packageManager":"pnpm@7.18.2","gitHead":"bc5e27ad6753f46cb0c6adaa726126576a754523","_id":"@braw/extended-intl@1.0.0","_nodeVersion":"18.12.1","_npmVersion":"8.19.2","dist":{"integrity":"sha512-f/+DAr0CwkHRX8KGNUJht1pXo4apFvTFa/KipfoY+pwFaw1l4GrASiwAJLgvsTVrNh8KxUKRFepj6NHGwSrtyw==","shasum":"547d9739d46b1c2f346b1e9dfdcb60310a43c88e","tarball":"https://registry.npmjs.org/@braw/extended-intl/-/extended-intl-1.0.0.tgz","fileCount":9,"unpackedSize":39594,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCLWFla8FF9iy9OHPpjw+pNp2UwgnddouapqKDZqxQnpwIhAI3xxyJDYZtLUFl2vDttvnH2KQlrUVsroDQ3JfQEWASN"}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjsF1EACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmp5vg/8CJKPwUKJ2zWfd6r4WRhjweBdU3cqUD31kYHe1t/WOQmtFreC\r\n+MQWynN5sinftmEtPIcd7f3tmkim+UVEahGlgoz1Gt3uMiuVWXyEm/KGaKP9\r\nckDcIRTUKrNHHKZzBDhiFbPKRHdZxRJSrwwVUqDjQZ+xaIxeIbY3mD/GqrXh\r\nm9+PAJYYRhKpjdhy1PNSh/A28d6aeaRJM/odVM+M9Q8F7e0/n7IG1YaYB8YG\r\n5gPnWF3JjyejkqAfOYUx9hO//cTnP045OtyYUoWUDr3gGqAeVFCc7qzuqwGm\r\nwWtEondvo3NCOr/RLMsNaIOL8shZLPYPN91IfQ+/lt1W6EY/jjjKIVgjR3gP\r\nfl+9LHEN/WDHBRG+FLq+ly5Gz08hDx/ngaqEIBzl9zQXD55UQl8gH6A6jQHK\r\nQEzRyx6d+W/687pdIpZMKpjfhJSVHmMA4gtMb3JWDAW4vB+/ynD9u4RexicP\r\nIno5yLF39NSiWwj5t3f4/tLZNQfT2/SaYty3d1Vys0UMs4oEoIKUxjv8B4Dn\r\nYlVu3kgWzRIG1kTiXnSTYUmP+T6AJx9tfeWrrKm/SvtT1fv9Ah5IqkiNEVQO\r\nzbQdfuVTp7Bh4cjHHWcG1N11WsEnGPtpj2ujvmocZ+n0vGqSOqxZropPGOiS\r\ntP1T6ox5YP1jxBCsR+vy4Zf09LpdSxPjFsI=\r\n=OXsQ\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"brawaru","email":"dafri.nochiterov8+npm@gmail.com"},"directories":{},"maintainers":[{"name":"brawaru","email":"dafri.nochiterov8+npm@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/extended-intl_1.0.0_1672502596530_0.03246741573712297"},"_hasShrinkwrap":false,"deprecated":"Please use @braw/compact-number or @braw/how-ago instead"},"1.0.1":{"name":"@braw/extended-intl","version":"1.0.1","description":"Wrapper for @formatjs/intl with additional features.","license":"MIT","sideEffects":false,"type":"module","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.mjs","require":"./dist/index.cjs"},"./forceNumberFormatPolyfill":{"types":"./dist/forceNumberFormatPolyfill.d.ts","import":"./dist/forceNumberFormatPolyfill.mjs","require":"./dist/forceNumberFormatPolyfill.cjs"},"./package.json":"./package.json"},"module":"./dist/index.mjs","main":"./dist/index.cjs","types":"./dist/index.d.ts","scripts":{"build":"unbuild","dev":"vitest dev","prepack":"pnpm run build","test":"vitest run","lint":"eslint src --ext .js,.ts"},"dependencies":{"@formatjs/ecma402-abstract":"^1.14.3","@formatjs/intl-numberformat":"^8.3.3"},"devDependencies":{"@babel/core":"^7.20.12","@babel/plugin-proposal-nullish-coalescing-operator":"^7.18.6","@babel/plugin-transform-typescript":"^7.20.7","@babel/preset-env":"^7.20.2","@babel/preset-typescript":"^7.18.6","@nuxtjs/eslint-config-typescript":"^12.0.0","@rollup/plugin-babel":"^6.0.3","@types/node":"^18.11.18","eslint":"^8.31.0","prettier":"^2.8.3","prettier-plugin-jsdoc":"^0.4.2","semantic-release":"^20.0.2","typescript":"^4.9.4","unbuild":"^1.1.1","vitest":"^0.27.1"},"peerDependencies":{"@formatjs/icu-messageformat-parser":"^2.1.14","@formatjs/intl":"^2.6.3","intl-messageformat":"^10.2.5"},"publishConfig":{"access":"public"},"packageManager":"pnpm@7.18.2","gitHead":"910d9fbe198a677359c116c74dd149b57917a064","_id":"@braw/extended-intl@1.0.1","_nodeVersion":"18.13.0","_npmVersion":"8.19.3","dist":{"integrity":"sha512-u8eLK0mOST8WGJE6+PpMJ9YZGZjg4vw5bsczUpzPD+sNuxtbVAw+76gkbqEmLIgkadoR5bDk81kzCAUmY6RCUg==","shasum":"5d060fb739c1efb7efa94b959dcd04b2c118c47f","tarball":"https://registry.npmjs.org/@braw/extended-intl/-/extended-intl-1.0.1.tgz","fileCount":9,"unpackedSize":39594,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIAiNYotQWFPX8uzbXy63JIse/NKw1C3uZc9tFEWQrMe6AiEAuL2DbXdqeEcJ29U1p0AnTKnK/DxXpR1iR0tERysyoF4="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjwt4pACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmq5fA/+P35fCYxbdQHNq5vqZ0Bw5vDQfWvNW3JzPYqlRgO1PuusiUeE\r\ndhlaJhoFuy9VFOADRs7GJTwN6q7XeJj2y5LjYkHvSKEb5W9Jribg59dQQa8/\r\nF0Kfv1kfHSmvMkg8A4YcUjUUSsp+w16vSYih7cNmJWx6RE2D4dLCZZFy8GbM\r\nRkO4Yhid0+EoURQXdQnE8jFug4f3BHKLvVzJ6bBgo97Tx9GZUV06zr+4r1ls\r\n6WrlOxCskkU88oOrKgtLZsiIfxx9yaF666YXq2sFXujZisqL3hdF2fwrLDbp\r\nRHthuSyaN5vUS4LRnqjTKiwq5ja5CVGUYSMvTTGI/klc40xky1hWIb/ovEPa\r\n8vofPomKgMCz1RXlmWN9zHWs0mEUmAktYof8YW1+rTCG+lRuf0XtHxNIutOK\r\nNJFgu9eyZXWCYOuQ/ztuNzQ0hRNxw8axIcRGGzlr3Xq5tXqr40L5taLS6MBb\r\nH1mIX4SW3X4nkSyVOZ6aeacSzSkG9ozcz39cJIa04Eu8UFE3ZdH67SwxcUyS\r\nAnHNRsAy2p6Ki3R/zTagD/Q507KSoMQKPIobHFrvhkl2s9YUUz2kn+0q0tnV\r\ntPVhWg49OlNEe4fEuxpRoR64Ax5f8NGuapQiEZyiQCIC+ClF8NHBVpBVb6/R\r\n3p5IbnL2hGsz/DZU+xvAwUsEvjkQiDInWVE=\r\n=CwKu\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"brawaru","email":"dafri.nochiterov8+npm@gmail.com"},"directories":{},"maintainers":[{"name":"brawaru","email":"dafri.nochiterov8+npm@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/extended-intl_1.0.1_1673715240844_0.41287401679024627"},"_hasShrinkwrap":false,"deprecated":"Please use @braw/compact-number or @braw/how-ago instead"},"2.0.0":{"name":"@braw/extended-intl","version":"2.0.0","description":"Wrapper for @formatjs/intl with additional features.","license":"MIT","sideEffects":false,"type":"module","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.mjs"},"./locale-data/*":{"types":"./dist/locale-data/*.d.ts","import":"./dist/locale-data/*.mjs"},"./package.json":"./package.json"},"module":"./dist/index.mjs","types":"./dist/index.d.ts","scripts":{"build":"unbuild","dev":"vitest dev","prepack":"pnpm run build","test":"vitest run","lint":"eslint src --ext .js,.ts"},"dependencies":{"@formatjs/ecma402-abstract":"^1.14.3","@formatjs/intl-localematcher":"^0.2.32"},"devDependencies":{"@babel/core":"^7.20.12","@babel/plugin-proposal-nullish-coalescing-operator":"^7.18.6","@babel/plugin-transform-typescript":"^7.20.7","@babel/preset-env":"^7.20.2","@babel/preset-typescript":"^7.18.6","@nuxtjs/eslint-config-typescript":"^12.0.0","@rollup/plugin-babel":"^6.0.3","@types/fs-extra":"^11.0.1","@types/node":"^18.11.18","chalk":"^5.2.0","cldr-numbers-modern":"^42.0.0","eslint":"^8.31.0","fs-extra":"^11.1.0","prettier":"^2.8.3","prettier-plugin-jsdoc":"^0.4.2","semantic-release":"^20.0.2","typescript":"^4.9.4","unbuild":"^1.1.1","vitest":"^0.27.1"},"peerDependencies":{"@formatjs/icu-messageformat-parser":"^2.1.14","@formatjs/intl":"^2.6.3","intl-messageformat":"^10.2.5"},"publishConfig":{"access":"public"},"packageManager":"pnpm@7.18.2","gitHead":"84447aa92577ae0e104b6e0dae4d81f9709b20e5","_id":"@braw/extended-intl@2.0.0","_nodeVersion":"18.13.0","_npmVersion":"8.19.3","dist":{"integrity":"sha512-QyOuGyD/iLXZ7LbJYJ8BBOqb/Mv04nu+cZcNqBucgcY4hd98cpa/u9T+tV4bwoZVJPqmLOSrFT5SRDbQ5mHlbQ==","shasum":"f2502a2997c78aa2705de1802608fad5b1bb10a7","tarball":"https://registry.npmjs.org/@braw/extended-intl/-/extended-intl-2.0.0.tgz","fileCount":1581,"unpackedSize":2252731,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDnWUdBaONfUVKs7jqIH+4Jdb2GR5teTecCoj+CycRMNQIhAPYwU4eR0h+9AtCidFKR/JBIAFzEMSJpKvilSELkKswJ"}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJj0D46ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmoRkw//b7LuWzCjnSyo5MNeYIjoyqFQSLXgQo6VI4NzJTSeuTI/5YpW\r\n31SyCSu7a1goumT3HBeFaEDV9IScxf4rw9p5lniN9FDhiCrBFQ+QM8+qQGr8\r\n01ToWr7flGCSNLEcu1wfWlwEpCBHxaGsPy8n0fPlS/tv/dZa1d4hPEheo9OB\r\nqSXoPIzzdmZVB0iypqoUW2SM7/ThOHgqEQDd4hTZphQ72Z/pWsXIIlMo2CRc\r\n2y5rgrJf9YpuMUagbzMGPh97qXWKNwiTLfyivaBIUeuPyERY+M15KZDwP8XJ\r\n/oxFwYNRSYSWONH+MjAvjKEd/7ShLd9nTDv8wM+z0qHN2PUixUacN9TWUJe+\r\nL8ZmokTQwkpJl5y2yKxXOMPap0WSgUwgvf5l5/H54vTAN7TsbANei8R3ixBq\r\n5wxCBcEUUAOxaBunnFHABZwo908b9JPnk+d6OzRoQcupSCi4/jRvXLHXPmQ1\r\nGQ75TCs7TySBGglo5MZglDY6d/g+Q/tSU/gnk1y4d6mUN4KpNTXerJPzVLaO\r\noduQa4cFISUUOpUN2Ur7BO3ZItvW4i6HK21fGKvKTn76rP1k5x00YHBk6p9q\r\nt32c41LDXq8oKkwhVUmB5FWtoU4zIlwOTFQGmPwwpH2FPUKAjmUE2Q1syks2\r\niRhUH1IQ71SwtMLtt2PCB3Hgw/aGHPqtI3E=\r\n=c5+g\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"brawaru","email":"dafri.nochiterov8+npm@gmail.com"},"directories":{},"maintainers":[{"name":"brawaru","email":"dafri.nochiterov8+npm@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/extended-intl_2.0.0_1674591801898_0.4549936802334844"},"_hasShrinkwrap":false,"deprecated":"Please use @braw/compact-number or @braw/how-ago instead"}},"time":{"created":"2022-12-31T16:03:16.451Z","1.0.0":"2022-12-31T16:03:16.704Z","modified":"2023-02-18T19:37:25.123Z","1.0.1":"2023-01-14T16:54:01.008Z","2.0.0":"2023-01-24T20:23:22.129Z"},"maintainers":[{"name":"brawaru","email":"dafri.nochiterov8+npm@gmail.com"}],"description":"Wrapper for @formatjs/intl with additional features.","license":"MIT","readme":"# extended-intl\n\n> Wrapper for [`@formatjs/intl`](https://npm.im/@formatjs/intl) with additional features.\n\n## Features\n\n### `CompactNumber`\n\n**Requires CLDR data to be imported. Learn more below.**\n\nCreate a convertible instances of `CompactNumber`, an object representing a number formatted in compact notation, with ability to convert it to an actual number that you can use to select **correct** plural form — something you can't do with built-in Intl APIs. [Learn more →](https://docs.google.com/document/d/1Wx9Drhpl9p2ZqVZMGQ7KUF4pUfPtuJupv8oQ_Gf6sEE/edit)\n\nUse instance of `CompactNumber` within `formatMessage` as a value to allow for mixed use — both as a number and formatted string, but do not use `#` shorthand, since then the ‘pluralisable’ number will be used:\n\n```ts\nconst messages = defineMessages({\n  users: {\n    id: 'users-count',\n    defaultMessage: '{count, plural, one {{count} user} other {{count} users}}',\n  },\n})\n\nintl.formatMessage(messages.users, {\n  count: intl.formatCompactNumber(31_411),\n})\n// => '31.4K users'\n\nintl.formatMessage(messages.users, {\n  count: intl.formatCompactNumber(31_411),\n})\n// => '31,2 тис. користувачів'\n```\n\nJust like with any other format methods, the result of `formatCompactNumber` is bound to a specific locale.\n\n### `formatCustomMessage`\n\nFormat any messages, even those that are not included in message maps.\n\n```ts\nimport myMessage from './i18n/en-US/greeting.ast.json'\n/* => [\n  { type: 0, value: 'Hello, ' },\n  { type: 1, value: 'targetName' },\n  { type: 0, value: '!' },\n] */\n\n// ...\n\nintl.formatCustomMessage(myMessage, {\n  targetName: 'world',\n})\n// => 'Hello, world!'\n```\n\n### `formatTimeDifference`\n\n_Based on the code from [Omorphia project by Modrinth](https://github.com/modrinth/omorphia)_.\n\nGiven one-two dates, calculates time difference between them, and then formats it in most applicable unit using `Intl.RelativeTimeFormat` and with `numeric` option set to `'automatic'` by default.\n\nCan also be used through alias `$ago`.\n\n```ts\nintl.formatTimeDifference(Date.now() - day)\n// => 'yesterday'\n\nintl.formatCustomMessage('Published {ago}', {\n  ago: intl.$ago(publishedAt),\n})\n// => 'Published 3 hours ago'\n```\n\nIt can be configured to cut off after or even before a certain unit, through `minimumUnit` and `maximumUnit` options, in which case it will fallback to formatting the initial date using `dateTimeOptions`:\n\n```ts\nintl.formatCustomMessage('Updated {ago}', {\n  ago: intl.$ago(lastUpdatedAt, {\n    maximumUnit: 'months',\n  }),\n})\n// + { lastUpdatedAt: Date.now() - (2 * day) }\n// => 'Updated 2 days ago'\n\n// + { lastUpdatedAt: Date.now() - year }\n// => 'Updated December 31, 2021 at 2:44 PM'\n```\n\nBy default it uses all relative units except for quarters, however you can change it by passing `excludedUnits` option:\n\n```ts\nintl.formatCustomMessage('Updated {ago}', {\n  ago: intl.$ago(lastUpdatedAt),\n})\n// + { lastUpdatedAt: Date.now() - (8 * day) }\n// => 'Updated last week'\n\nintl.formatCustomMessage('Updated {ago}', {\n  ago: intl.$ago(lastUpdatedAt, {\n    excludedUnits: ['quarters', 'weeks'],\n  }),\n})\n// + { lastUpdatedAt: Date.now() - (8 * day) }\n// => 'Updated 8 days ago'\n```\n\n## Install\n\nThis package must be installed together with original `@formatjs/intl`.\n\n**npm**\n\n```sh\nnpm install @formatjs/intl @braw/extended-intl\n```\n\n**pnpm**\n\n```sh\npnpm install @formatjs/intl @braw/extended-intl\n```\n\n**yarn**\n\n```sh\nyarn add @formatjs/intl @braw/extended-intl\n```\n\n## Usage\n\nSince it's a wrapper on top of `IntlShape` from the original package, you can replace your existing `createIntl` call from `@formatjs/intl` to the one in `@braw/extended-intl`.\n\nAlias for `createIntlCache` is also available, and while it's identical to the original, it might be more convenient to import both functions from the same place. There should not be any breaking changes when switching the libraries.\n\nThis package is written in TypeScript and almost all methods contain documentation.\n\n## CLDR locale data\n\nSince `CompactNumber` relies on CLDR data that is not available through browser built-in APIs, additional data needs to be imported. Without it, the results of `CompactNumber` will be inaccurate and the API itself is pointless.\n\nTo import locale data import one of the files from `/locale-data`:\n\n```ts\n// The first imported locale is considered the fallback if data is missing\nimport '@braw/extended-intl/locale-data/en'\nimport '@braw/extended-intl/locale-data/uk'\n\nimport { setDefaultNumberFormatDataLocale } from '@braw/extended-intl'\n\nsetDefaultNumberFormatDataLocale('uk') // set alternative fallback data\n```\n\n## Acknowledgements\n\nThis project is fully powered by the works of [Format.JS authors](https://formatjs.io/).\n","readmeFilename":"README.md"}