{"_id":"@acctglobal/shipping-simulator","_rev":"2-7060c1994ed92d0977ff0fb25a4f37ce","name":"@acctglobal/shipping-simulator","dist-tags":{"latest":"0.1.1"},"versions":{"0.1.0":{"version":"0.1.0","license":"MIT","main":"dist/index.js","typings":"dist/index.d.ts","engines":{"node":">=10"},"scripts":{"start":"tsdx watch","build":"tsdx build","test":"tsdx test --passWithNoTests","test:coverage":"tsdx test --coverage","lint":"tsdx lint","prepare":"tsdx build","size":"size-limit","analyze":"size-limit --why","storybook":"start-storybook -p 6006","build-storybook":"build-storybook"},"peerDependencies":{"react":">=16"},"husky":{"hooks":{"pre-commit":"tsdx lint"}},"jest":{"verbose":true,"collectCoverageFrom":["src/components/*.{js,jsx,ts,tsx}"]},"prettier":{"printWidth":80,"semi":true,"singleQuote":true,"trailingComma":"es5"},"name":"@acctglobal/shipping-simulator","author":{"name":"jonathan.paoroso"},"module":"dist/shippingsimulator.esm.js","size-limit":[{"path":"dist/shippingsimulator.cjs.production.min.js","limit":"10 KB"},{"path":"dist/shippingsimulator.esm.js","limit":"10 KB"}],"devDependencies":{"@babel/core":"^7.18.2","@size-limit/preset-small-lib":"^7.0.8","@storybook/addon-essentials":"^6.5.8","@storybook/addon-info":"^5.3.21","@storybook/addon-links":"^6.5.8","@storybook/addons":"^6.5.8","@storybook/react":"^6.5.8","@types/react":"^18.0.12","@types/react-dom":"^18.0.5","babel-loader":"^8.2.5","husky":"^8.0.1","react":"^18.1.0","react-dom":"^18.1.0","react-is":"^18.1.0","size-limit":"^7.0.8","tsdx":"^0.14.1","tslib":"^2.4.0","typescript":"^4.7.3","@storybook/addon-docs":"^6.5.8","@testing-library/jest-dom":"^5.16.4","@testing-library/react":"^13.3.0"},"description":"<br/>","_id":"@acctglobal/shipping-simulator@0.1.0","_nodeVersion":"14.20.0","_npmVersion":"6.14.17","dist":{"integrity":"sha512-k17YnKBqOjWsHujxlt4X9qT4AI4NtYxS0DPKRhx+mspu5J7zxows/4E1p5+1qf0sFD05g5x/FHK0nUCSje26jg==","shasum":"18009693b322380661158a016d376c658020394d","tarball":"https://registry.npmjs.org/@acctglobal/shipping-simulator/-/shipping-simulator-0.1.0.tgz","fileCount":23,"unpackedSize":94193,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDb9mM4KSy9APGSzQK9zf+9A7mbMB65USEE3sage8r+/AIgbDoJlsF2KsufsIlhIni2/Vs7xDhZ0I1QibUogW77GcY="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJi1cymACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmr7nA//Un6BfzP2aY4B5hON0pLKG+CkD7xOdIzWU5OsHMRPRQjYAyUF\r\nOAey3Y76VR+3BjXqv059sjJSCIltRi5J/1XVHgVMKJD+jRtkWkdgNAejEaK3\r\nMIZ7/8sCCZWXAS2YoT4nWs02hKt94YmGo4nkNIraDKV1HiW13uRo2iHNTd81\r\naP5+/uHWESdGzupkH7xppdMxfkQFwnVVClfPVOyoEdRg9g+Y5x45bQUVMw+t\r\na8PN4ypeJNu3FyRwfU5fuX3BA8wb92AnIqo3BagFeFfWUVeqgdQIgSqYnZU8\r\nOsGTeXMNsVvxoQOxrvBdW9oWtnl9Zii2W86mPsKxsqvSg6TkOmTFdR2naUa1\r\n2iJuWeON0kFuOXxpMuRR2t4SSm+y1qu5csMfz5DXypsjNOri2BxAUgjxushA\r\nnIA8C2cGlY5trFh1qmC1ShQGi6Wek82egSO5XDpQ1Qg66eMm/NS30ZCkUeg3\r\nZGZfM6H1ko+UzGHeRWsBpNlBa9kAYKGf0HIcN0yTFNgHKVrWFm51G7aA321s\r\nfHbMotR54drmqn/J5daYzN8M/ttaBjGdg0KsDt8m3dMHJk9k1Rl5biiToNM6\r\nISBuIlNN/EWwXGoGametYzjr8ukcn8LC3IbA0yUbqqmI1zoBNB6s5btwjyno\r\nx+w+IS3ndr6PnUadXlulqsRwl5qjs1LdO4w=\r\n=03cs\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"ricardo.freitas","email":"ricardo.freitas@acct.global"},"directories":{},"maintainers":[{"name":"luiz.priolli","email":"luiz.priolli@acct.global"},{"name":"ricardo.freitas","email":"ricardo.freitas@acct.global"},{"name":"fabioacct","email":"fabio@acct.global"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/shipping-simulator_0.1.0_1658178726539_0.7059215034493382"},"_hasShrinkwrap":false},"0.1.1":{"version":"0.1.1","license":"MIT","main":"dist/index.js","typings":"dist/index.d.ts","engines":{"node":">=10"},"scripts":{"start":"tsdx watch","build":"tsdx build","test":"tsdx test --passWithNoTests","test:coverage":"tsdx test --coverage","lint":"tsdx lint","prepare":"tsdx build","size":"size-limit","analyze":"size-limit --why","storybook":"start-storybook -p 6006","build-storybook":"build-storybook"},"peerDependencies":{"react":">=16"},"husky":{"hooks":{"pre-commit":"tsdx lint"}},"jest":{"verbose":true,"collectCoverageFrom":["src/components/*.{js,jsx,ts,tsx}"]},"prettier":{"printWidth":80,"semi":true,"singleQuote":true,"trailingComma":"es5"},"name":"@acctglobal/shipping-simulator","author":{"name":"jonathan.paoroso"},"module":"dist/shippingsimulator.esm.js","size-limit":[{"path":"dist/shippingsimulator.cjs.production.min.js","limit":"10 KB"},{"path":"dist/shippingsimulator.esm.js","limit":"10 KB"}],"devDependencies":{"@babel/core":"^7.18.2","@size-limit/preset-small-lib":"^7.0.8","@storybook/addon-docs":"^6.5.8","@storybook/addon-essentials":"^6.5.8","@storybook/addon-info":"^5.3.21","@storybook/addon-links":"^6.5.8","@storybook/addons":"^6.5.8","@storybook/react":"^6.5.8","@testing-library/jest-dom":"^5.16.4","@testing-library/react":"^13.3.0","@types/react":"^18.0.12","@types/react-dom":"^18.0.5","babel-loader":"^8.2.5","husky":"^8.0.1","react":"^18.1.0","react-dom":"^18.1.0","react-is":"^18.1.0","size-limit":"^7.0.8","tsdx":"^0.14.1","tslib":"^2.4.0","typescript":"^4.7.3"},"description":"<br/>","_id":"@acctglobal/shipping-simulator@0.1.1","_nodeVersion":"14.20.0","_npmVersion":"6.14.17","dist":{"integrity":"sha512-V9kufcy49lBMzp1PFF4ujyvTEH4W47pkvTyCc0XKdznV8YEo2o+viy3hQkk84higePja21C+hlyvrUP3evnKXA==","shasum":"bbdc2be423e1c76b9b731f45f852899c7190f133","tarball":"https://registry.npmjs.org/@acctglobal/shipping-simulator/-/shipping-simulator-0.1.1.tgz","fileCount":23,"unpackedSize":96214,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIHZ8D5iwmwB5afFYmcM19boFm7khdsUuZRp8drazQwHrAiBMEMPdjQRGoW563/cMW5j6GE85tjoDZYvr2U3ZxbMOWw=="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJi4ZoEACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmqkBg/8Dcx8F2OrhgFG3TPWQ65fF5Zbk64zLD3P0rAhoF2KjFIByqXi\r\nJLGnCYU+xpLrGVBQLTF0xF3TDaiMfAYXyvS7YzgNFZrEN414REt5gP9IoX33\r\ngDddiIEtOCdjPYfG2g8A5yxqH7+n+/mwBJONJvdRTVQHK5UyBNxO4Ztrd4MG\r\nvmA6TIw+xFgxg/s86Vv+SjpyezQw7vtRnwX/XsMXDbNpTI8aR16ZaFcIUmXx\r\nBmlupkOxebalIQ6jbc9ZYSqS3Z5R0osLc0s74pmo542t+yHdOIvnR7uaCGb6\r\nULPcbGkt6h2bwIBZrcWbka/sQ+XdfeQjam7C9Ib9/ulOpLaD8Kasln4c/3dF\r\ngPtPqTIrN7j87lom/p7+Et9d3Vzge8LLwn4caSzKF154N8VAyFDotlcxg2a3\r\nioyEbpVjp+Yu5k+vd75Y4IKJvr8IVicWkJNDnZGMlBYkwhZmYP5Yjwpi7q4A\r\nO8sHTEn6lUCMEEHMBjGbrF940JH2TClKYrE2EjFYC1EUh28I1ul8Mh6ot+6c\r\n33Vrp/MoFUyK6azaKlS42mZyweXiIOQ2ckqJpZbZk5bVah5HMzQ6dmUKl5ja\r\nK/3aqoYL2AOMhD9gTCCDe4rJP6xd3u/6ufY3ee8nVTNk/KYtf5d31LXlGN4M\r\nKU72pifZ8O7I2lBCp52rqUCM0SIxeS6zp0I=\r\n=2WvK\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"ricardo.freitas","email":"ricardo.freitas@acct.global"},"directories":{},"maintainers":[{"name":"luiz.priolli","email":"luiz.priolli@acct.global"},{"name":"ricardo.freitas","email":"ricardo.freitas@acct.global"},{"name":"fabioacct","email":"fabio@acct.global"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/shipping-simulator_0.1.1_1658952196290_0.7139375553515857"},"_hasShrinkwrap":false}},"time":{"created":"2022-07-18T21:12:06.538Z","0.1.0":"2022-07-18T21:12:06.703Z","modified":"2022-07-27T20:03:16.628Z","0.1.1":"2022-07-27T20:03:16.492Z"},"maintainers":[{"name":"luiz.priolli","email":"luiz.priolli@acct.global"},{"name":"ricardo.freitas","email":"ricardo.freitas@acct.global"},{"name":"fabioacct","email":"fabio@acct.global"}],"description":"<br/>","author":{"name":"jonathan.paoroso"},"license":"MIT","readme":"# Shipping Simmulator\n\n<br/>\n\n## Getting Started\n\nThis component can be used anywhere you want in e-commerce, in a responsive and agnostic way. You just need to have React on\nyour project.\n\n<br>\nHow the component looks like:\n\n</br>\n\n![image](https://user-images.githubusercontent.com/92031730/178991861-374ccb5b-dd05-4e10-80b7-18c43881b07b.png)\n\n</br>\n\n## Installation and usage\n\nTo use Image Gallery, you need to install the package via yarn or npm and import it wherever you want to use it.\n\n```bash\nyarn add @acctglobal/shipping-simmulator\n// or npm install\n```\n\n</br>\n\nNow you just need to import and use the component.\n\n```javascript\nimport ShippingSimulator from '@acctglobal/shipping-simulator';\n```\n\n```jsx\n<ShippingSimulator\n  zipValidation={handleZipValidation}\n  shippingSimulation={handleShippingSimulation}\n  hrefLinks={{\n    firstLink: 'https://tools.usps.com/go/ZipLookupAction!input.action',\n    secondLink: '/',\n  }}\n  customTexts={{\n    title: 'Delivery',\n    buttonLabel: 'Apply',\n    dontKnowZip: \"I don't know my zip code\",\n    placeHolder: 'Zip code',\n    moreInfo: 'More informations',\n    moneyType: '$',\n    estimatedTimeMeasure: 'day/s',\n    invalidZipCode: 'Invalid zip code. Try again!',\n  }}\n  items={[\n    {\n      id,\n      quantity: '3',\n      seller: '1',\n    },\n  ]}\n/>\n```\n\n</br>\n\n### Styling\n\n#### All css selectors\n\n`shipping-simulator-container` <br>\n`request-container` <br>\n`shipping-simmulator-title` <br>\n`shipping-form-container` <br>\n`form-input` <br>\n`form-button` <br>\n`dont-know-zip-link` <br>\n`shipping-result-table` <br>\n`table-row` <br>\n`shipping-name` <br>\n`shipping-infos` <br>\n`shipping-time` <br>\n`shipping-price` <br>\n`more-info-link` <br>\n`invalid-zipcode-alert` <br>\n\n</br>\n\n### Props\n\n| Parameter            | Type                                                                       | Description                                                                                                                  |\n| :------------------- | :------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------- | --- |\n| `hrefLinks`          | `HrefLinks`                                                                | **Optional**. Object of URLs for component links.                                                                            |\n| `customTexts`        | `CustomTexts`                                                              | **Mandatory**. Object containing custom texts for each component part.                                                       |\n| `item`               | `Array`                                                                    | **Mandatory**. Array contain object with 3 elements [{ id: string, quantity: string, seller: string}].                       |     |\n| `zipValidation`      | `(zipcode: string) => boolean or Promise<boolean>`                         | **Mandatory**. Function that will validade zipcode. Need to receive `zipcode` as `string` and return a `boolean`.            |\n| `shippingSimulation` | `(zipcode: string) => ShippingMethodsType or Promise<ShippingMethodsType>` | **Mandatory**. Function that will simulate shipping. Need to receive `zipcode` as `string` and return the `ShippingMethods`. |\n\n<br>\n\n## Types\n\n<br>\n\n### HrefLinks\n\n| Property          | Type     | Description  |\n| ----------------- | -------- | ------------ |\n| `dontKnowZipLink` | `string` | **Optional** |\n| `moreInfoLink`    | `string` | **Optional** |\n\n<br>\n\n### CustomTexts\n\n| Property               | Type     | Description   |\n| ---------------------- | -------- | ------------- |\n| `placeHolder`          | `string` | **Mandatory** |\n| `title`                | `string` | **Mandatory** |\n| `buttonLabel`          | `string` | **Mandatory** |\n| `dontKnowZip`          | `string` | **Mandatory** |\n| `moreInfo`             | `string` | **Mandatory** |\n| `moneyType`            | `string` | **Mandatory** |\n| `estimatedTimeMeasure` | `string` | **Mandatory** |\n| `invalidZipCode`       | `string` | **Mandatory** |\n\n</br>\n\n### ShippingMethodsType\n\n| Property           | Type     | Description   |\n| ------------------ | -------- | ------------- |\n| `name`             | `string` | **Mandatory** |\n| `shippingEstimate` | `string` | **Mandatory** |\n| `price`            | `number` | **Mandatory** |\n\n</br> </br>\n\n<!-- CONTRIBUTING -->\n\n## Contributing\n\nIf you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag \"enhancement\".\nDon't forget to give the project a star! Thanks again!\n\n1. Fork the Project\n2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the Branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n6. And don't forget to update the changelog\n\n</br>\n\n<!-- CONTACT -->\n\n## Contact\n\nJonathan Paoroso - jonathan.paoroso@acct.global\nRaphael Marinho - raphael.marinho@acct.global\n","readmeFilename":"README.md"}