{"_id":"@cocart/cocart-rest-api","_rev":"5-cfbe7b28e29c24df9f2c553463ef1efa","name":"@cocart/cocart-rest-api","dist-tags":{"latest":"1.1.0"},"versions":{"1.0.0":{"name":"@cocart/cocart-rest-api","version":"1.0.0","description":"CoCart - JavaScript Library","author":{"name":"Sebastien Dumont"},"license":"MIT","keywords":["wordpress","woocommerce","rest","cocart","promise","node"],"homepage":"https://github.com/co-cart/cocart-js-lib","repository":{"type":"git","url":"git+https://github.com/co-cart/cocart-js-lib.git"},"bugs":{"url":"https://github.com/co-cart/cocart-js-lib/issues"},"main":"index","types":"index.d.ts","exports":{"import":"./index.mjs","require":"./index.js"},"dependencies":{"axios":"^0.21.0","create-hmac":"^1.1.7","oauth-1.0a":"^2.2.6","url-parse":"^1.4.7"},"devDependencies":{"@babel/cli":"7.12.8","@babel/core":"7.12.8","@babel/plugin-transform-modules-commonjs":"7.12.1","@babel/preset-env":"7.12.7","babel-jest":"26.6.3","del-cli":"3.0.1","eslint":"7.14.0","eslint-config-prettier":"6.15.0","eslint-config-standard":"16.0.2","eslint-plugin-import":"2.22.1","eslint-plugin-jest":"24.1.3","eslint-plugin-node":"11.1.0","eslint-plugin-prettier":"3.1.4","eslint-plugin-promise":"4.2.1","eslint-plugin-standard":"5.0.0","husky":"4.3.0","jest":"26.6.3","lint-staged":"10.5.1","nock":"13.0.5","prettier":"2.2.0"},"scripts":{"build":"del index.js && babel index.mjs --out-dir .","test":"jest","format":"prettier --write \"*.mjs\" \"test.js\"","lint":"eslint *.mjs","prepare":"npm run build","prepublishOnly":"npm test && npm run lint","preversion":"npm run lint","version":"npm run format && git add -A","postversion":"git push && git push --tags"},"husky":{"hooks":{"pre-commit":"lint-staged"}},"lint-staged":{"*.{js,mjs}":["eslint --fix","prettier --write","git add"]},"engines":{"node":">=8.0.0"},"gitHead":"7123ca88b92a1f5e358ca8fee4bcaaafadfd0162","_id":"@cocart/cocart-rest-api@1.0.0","_nodeVersion":"14.15.1","_npmVersion":"6.14.9","dist":{"integrity":"sha512-h3y80ZgC7FP03Ea8sLRgnXZHCmIkIbePvFjs3sFFORjkwJ0uPGrsDZQNOopzXPYZWrPsc2KxsOW5EYsFfOB1HA==","shasum":"bc9410a761a023305674e398860016597e82c7fe","tarball":"https://registry.npmjs.org/@cocart/cocart-rest-api/-/cocart-rest-api-1.0.0.tgz","fileCount":7,"unpackedSize":29074,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfvIdPCRA9TVsSAnZWagAANBwP/RU/vpLV6iJg7TwJ4HHU\nWLFOwEYc5yiU1j7269mCagFmOzV941zbAiM+XwoqDZok4G4sBn5sJhu/wihJ\nUwCXO8eyUvz3fZvcqvcyt8hC4pAlGf8qH59OJmCrrYarozK5+pcRYyfQ5i2n\n7TKcVs3iMw3ypUE+8YrI7xDY5DfGWoR8ZUuSCZ9zg9MdbZYCLQk6MoMBJMVX\nV3oEb07sDqG9qVyFwczlUsmX7XeM+kf+1h/hUZ80UjTOuy63faiT7oZwmiy0\nO9ywn7D10jndljt6vwovdHxrDBm4QPiicGyoTV5G99GK1R6kJk5dE2LjJbRu\nhniKqF0wz7vE7oUSOuw8one0763BFKRRTTvX2Q8Ez3Gta4ai0NHikbh8xLn0\nzOylVNdP/MpuPuVFZ9A6kA1FvgNLoRbsYqYiSXmP0igaWezKcF2ccTIqd6Ye\nhR+uZyn2cYKmL/QqLoWB/sEsHB6IF9ZTiUkzHJVEn6VKDxU/XV9hDDQXSWcR\nWpF5rcy4JPuBiwVXSh+oRN48XNs2Z63/nqhMEY3AynaRUBrb2nLvkaO202u1\nWW4mt1vpnOwoz1KBtR2p94S7+SpQ+Mxkt9AGQrC8H10X7oScT+obak9o8qlW\nOCX/iQQdqabKzzq7rq8qhDdLEZhw6EinlC9RcFTzLtons6H/opaPt1h2XH39\nGxGG\r\n=kldJ\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIFxIiX44S2LzmvhxgBjN3gwH2Mmlb+ex5+hO4QhWb+2yAiEA0eos9m0yuF0l7qfDy2ZsaUwFZJjmzBx2ukyQfCKUJ/w="}]},"_npmUser":{"name":"seb86","email":"mailme@sebastiendumont.com"},"directories":{},"maintainers":[{"name":"seb86","email":"mailme@sebastiendumont.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/cocart-rest-api_1.0.0_1606190926626_0.8646962692690903"},"_hasShrinkwrap":false},"1.0.1":{"name":"@cocart/cocart-rest-api","version":"1.0.1","description":"CoCart - JavaScript Library","author":{"name":"Sebastien Dumont"},"license":"MIT","keywords":["wordpress","woocommerce","rest","cocart","promise","node"],"homepage":"https://github.com/co-cart/cocart-js-lib","repository":{"type":"git","url":"git+https://github.com/co-cart/cocart-js-lib.git"},"bugs":{"url":"https://github.com/co-cart/cocart-js-lib/issues"},"main":"index","types":"index.d.ts","exports":{"import":"./index.mjs","require":"./index.js"},"dependencies":{"axios":"^0.21.0","create-hmac":"^1.1.7","oauth-1.0a":"^2.2.6","url-parse":"^1.4.7"},"devDependencies":{"@babel/cli":"7.13.10","@babel/core":"7.13.10","@babel/plugin-transform-modules-commonjs":"7.13.8","@babel/preset-env":"7.13.10","babel-jest":"26.6.3","del-cli":"3.0.1","eslint":"7.22.0","eslint-config-prettier":"8.1.0","eslint-config-standard":"16.0.2","eslint-plugin-import":"2.22.1","eslint-plugin-jest":"24.3.1","eslint-plugin-node":"11.1.0","eslint-plugin-prettier":"3.3.1","eslint-plugin-promise":"4.3.1","eslint-plugin-standard":"5.0.0","husky":"5.1.3","jest":"26.6.3","lint-staged":"10.5.4","nock":"13.0.11","prettier":"2.2.1"},"scripts":{"build":"del index.js && babel index.mjs --out-dir .","test":"jest","format":"prettier --write \"*.mjs\" \"test.js\"","lint":"eslint *.mjs","prepare":"npm run build","prepublishOnly":"npm test && npm run lint","preversion":"npm run lint","version":"npm run format && git add -A","postversion":"git push && git push --tags"},"husky":{"hooks":{"pre-commit":"lint-staged"}},"lint-staged":{"*.{js,mjs}":["eslint --fix","prettier --write","git add"]},"engines":{"node":">=8.0.0"},"gitHead":"24bc813f7e1059108c9a48eec3f51f5d5d1baae3","_id":"@cocart/cocart-rest-api@1.0.1","_nodeVersion":"14.15.4","_npmVersion":"6.14.10","dist":{"integrity":"sha512-KcHGiN1YgVbXqOAl+BHd4bKOz3gTtD7yApwfPSqCStS7J6dHhW7BUOysyxhjRqW3091B19Av/+H5ppDyqYocGQ==","shasum":"f5615ecf95a93b07b7d11449d09293c8307a8856","tarball":"https://registry.npmjs.org/@cocart/cocart-rest-api/-/cocart-rest-api-1.0.1.tgz","fileCount":7,"unpackedSize":29630,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgTwyhCRA9TVsSAnZWagAAiskQAJLAr/P6vAdl6ghKix1r\nZ0V2h+/jg6/TDxJ6vFOyJA+PWWRadeYVQ78lh0EiLCceTSwT4jlBAHqv59Vm\nb222bXNaWFkr0Wkfaq/rQoxUrwSnNgLdz1ut+UcIgPJFLy6swiEoMcr6901E\nq8yamNL5HvoElrLaEG7kmIYgAJdUb/BNnLbvbIu/iaIIjhKuhOdSXKOLS0+K\nwCSNExJTNL0rWLm2sVhNRbdnLHYztAABWrzKMjrqaens/wBRhTr2aZM+5+W0\nYhewSNjWuAu8gRCGlCI1g7frdXdNdW60qK7PilL0mAUboujVvYSJi2hzUKuW\nlxjPkyLOXs7T2TMYdoLWtrAc9Dq29lI/LqG7BzYoIsoPoLgzK607gD0hUyCv\nNTvufQbAgpz1iLhXKLkldizQ6aBYvOYodnXSbs7r/0jOTMfKAVwU0nMwVl5w\nn99mnQAgoCnwN0hsTB/m0QsyzkXwf7kVoob4V3y/lOgJu5uwBqdSCQqKYY25\neBuPXjN8wzXCI7KCsnMxgZctEH/LWirE/QaFE7TIJkGzNgRIRfEcblkM0nRF\nSg3mzF75n3t+G5zp5p+Fhq8c+/3Cryex7QVN3V7CNFBMh1mjm1hvtaf+y1Ik\nf9GGbrh20+bXu1y6gA08NwOzBGt65oLinEjvo2X21Z9o8AHqDQsw+xz+tY9M\nr30C\r\n=lOO2\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDKPwZnaMVIxYqAOiNBbjPGsClr2iYVsDk4iZ9fhbLAnQIhAM7/LlZI7a68hFR+Il+QssOgXq3IzF1uUMxP212oQEXJ"}]},"_npmUser":{"name":"seb86","email":"mailme@sebastiendumont.com"},"directories":{},"maintainers":[{"name":"seb86","email":"mailme@sebastiendumont.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/cocart-rest-api_1.0.1_1615793312752_0.867264434785342"},"_hasShrinkwrap":false},"1.1.0":{"name":"@cocart/cocart-rest-api","version":"1.1.0","description":"CoCart - JavaScript Library","author":{"name":"Sebastien Dumont"},"license":"MIT","keywords":["wordpress","woocommerce","rest","cocart","promise","node"],"homepage":"https://github.com/co-cart/cocart-js-lib","repository":{"type":"git","url":"git+https://github.com/co-cart/cocart-js-lib.git"},"bugs":{"url":"https://github.com/co-cart/cocart-js-lib/issues"},"main":"index","types":"index.d.ts","exports":{"import":"./index.mjs","require":"./index.js"},"dependencies":{"axios":"^0.21.0","create-hmac":"^1.1.7","oauth-1.0a":"^2.2.6","url-parse":"^1.4.7"},"devDependencies":{"@babel/cli":"7.14.3","@babel/core":"7.14.3","@babel/plugin-transform-modules-commonjs":"7.14.0","@babel/preset-env":"7.14.4","babel-jest":"27.0.2","del-cli":"3.0.1","eslint":"7.27.0","eslint-config-prettier":"8.3.0","eslint-config-standard":"16.0.3","eslint-plugin-import":"2.23.4","eslint-plugin-jest":"24.3.6","eslint-plugin-node":"11.1.0","eslint-plugin-prettier":"3.4.0","eslint-plugin-promise":"5.1.0","eslint-plugin-standard":"5.0.0","husky":"6.0.0","jest":"27.0.3","lint-staged":"11.0.0","nock":"13.1.0","prettier":"2.3.0"},"scripts":{"build":"del index.js && babel index.mjs --out-dir .","test":"jest","format":"prettier --write \"*.mjs\" \"test.js\"","lint":"eslint *.mjs","prepare":"npm run build","prepublishOnly":"npm test && npm run lint","preversion":"npm run lint","version":"npm run format && git add -A","postversion":"git push && git push --tags"},"husky":{"hooks":{"pre-commit":"lint-staged"}},"lint-staged":{"*.{js,mjs}":["eslint --fix","prettier --write","git add"]},"engines":{"node":">=8.0.0"},"gitHead":"7c0d9d05128f719edaa790e03135942334e352b1","_id":"@cocart/cocart-rest-api@1.1.0","_nodeVersion":"14.15.4","_npmVersion":"6.14.10","dist":{"integrity":"sha512-IV6cUmTcWcyRB0re9pdjxr6vwK7tl9eagZa85zB8MBfGMeIXH5HHD/CO7+fxo+IEeyz6IOVVUsVrb23frv9C9Q==","shasum":"9f2268c0acbde9fda2fc8fb31b14daa2d8449507","tarball":"https://registry.npmjs.org/@cocart/cocart-rest-api/-/cocart-rest-api-1.1.0.tgz","fileCount":7,"unpackedSize":33328,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJguKtRCRA9TVsSAnZWagAAd6wQAIsKm8ctPnyYzn0iIKQO\n/Pc2gTeyJa0SmDXpFF2jNpkXoFHxst7v8RgX9G0zldAI1uIrbwnc7GjSPZ5V\nGwq1+s6AT53tuCxauaur8P+6YY8hhPjK7zc5HCYSo/1l1ZcJmd5jD//IN7pA\ngwkRYWnnwtL2pgP+2kwOEqJOB/jKyUtuaZZFt+4UyGGcV24gJCXFn912MxqI\niCloIvHLxO/SUNL0xsy5RyY0sEtgnnaw02FvR/V6NvtPZgL1TZWPAVfDnelh\n3I5VI9abhK3zU3yOQ4guZioY13jMAI4dr6p5xgCvzmlu9ECXM6qgxnvnjq5x\naVpvu/oVb/vL8SQa7F8ZnAIWWm7aFir5+Q+bItN5Y4XUH+C3vfWYPwmHVZMx\nl11p2TUSMlu9ENBFOGcffcWUkCBV33sJiCMmeyQuaMnaHMrt2GF8HjITRPfT\nI2VBKdUZpvQ71CNwc0h7w3MR8kNFQJXsXIKEOB1WAjvLiRZv3Qwm968eY1n5\nICrulbylIJMLzraPaNReJ4hS6wH1xr39/PCRAMcltaejNUfiy2t0dV4Auhc8\naly+lItgl1GSFlajyCYYcQI/gIgwg6VXPI1W3bDclf8LmnqdJgHCSfGE59tR\n+8OYPiOgQ5HWzh19EMDtf7nYfLCmOHfv9+jAn8xZV2QUE50RxmwZ20tIKBhk\nbm8j\r\n=FVQQ\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIE2y8YjzCyxNp8sJo0aLWZ529AKEfKxoG58R3XDEbtIMAiBFF1ZhnRsAyjvTDY60Szi+nCQQ16Jl48El669eoBbViw=="}]},"_npmUser":{"name":"seb86","email":"mailme@sebastiendumont.com"},"directories":{},"maintainers":[{"name":"seb86","email":"mailme@sebastiendumont.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/cocart-rest-api_1.1.0_1622715217829_0.532024907477145"},"_hasShrinkwrap":false}},"time":{"created":"2020-11-24T04:08:46.217Z","1.0.0":"2020-11-24T04:08:46.814Z","modified":"2022-04-04T23:54:23.756Z","1.0.1":"2021-03-15T07:28:32.944Z","1.1.0":"2021-06-03T10:13:37.933Z"},"maintainers":[{"name":"seb86","email":"mailme@sebastiendumont.com"}],"description":"CoCart - JavaScript Library","homepage":"https://github.com/co-cart/cocart-js-lib","keywords":["wordpress","woocommerce","rest","cocart","promise","node"],"repository":{"type":"git","url":"git+https://github.com/co-cart/cocart-js-lib.git"},"author":{"name":"Sebastien Dumont"},"bugs":{"url":"https://github.com/co-cart/cocart-js-lib/issues"},"license":"MIT","readme":"

CoCart - JavaScript Library

\r\n\r\n

\"CoCart\"

\r\n\r\n> 🍴 Forked from WooCommerce JavaScript Library and modified to support CoCart REST API instead. Authentication is optional.\r\n\r\nJavaScript library for CoCart, supports CommonJS (CJS) and ECMAScript Modules (ESM).\r\n\r\nRequests are made with [Axios library](https://github.com/axios/axios) with [support to promises](https://github.com/axios/axios#promises).\r\n\r\n[![build status](https://travis-ci.org/co-cart/cocart-js-lib.svg?branch=master)](https://travis-ci.org/github/co-cart/cocart-js-lib)\r\n[![npm version](https://img.shields.io/npm/v/@cocart/cocart-rest-api.svg)](https://www.npmjs.com/package/@cocart/cocart-rest-api)\r\n\r\n> ⚠️This library will **NOT** support the **LEGACY API** of CoCart.\r\n\r\n## Installation\r\n\r\n```\r\nnpm install --save @cocart/cocart-rest-api\r\n```\r\n\r\n## Getting started\r\n\r\nCheck out the CoCart API endpoints and data that can be manipulated in .\r\n\r\n## Setup\r\n\r\n### ESM example\r\n\r\n```js\r\nimport CoCartAPI from \"@cocart/cocart-rest-api\";\r\n\r\nconst CoCart = new CoCartAPI({\r\n url: \"https://example.com\",\r\n});\r\n```\r\n\r\n### CJS example\r\n\r\n```js\r\nconst CoCartAPI = require(\"@cocart/cocart-rest-api\").default;\r\n\r\nconst CoCart = new CoCartAPI({\r\n url: \"https://example.com\",\r\n});\r\n```\r\n\r\n### Options\r\n\r\n| Option | Type | Required | Description |\r\n|-------------------|-----------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\r\n| `url` | `String` | yes | Your Store URL, example: https://example.com/ |\r\n| `consumerKey` | `String` | no | Your API consumer key, username or email address. |\r\n| `consumerSecret` | `String` | no | Your API consumer secret or password. |\r\n| `wpAPIPrefix` | `String` | no | Custom WP REST API URL prefix, used to support custom prefixes created with the [rest_url_prefix](https://developer.wordpress.org/reference/functions/rest_get_url_prefix/) filter. |\r\n| `version` | `String` | no | API version, default is `cocart/v2` |\r\n| `encoding` | `String` | no | Encoding, default is 'utf-8' |\r\n| `queryStringAuth` | `Bool` | no | When `true` and using under HTTPS force Basic Authentication as query string, default is `false` |\r\n| `port` | `string` | no | Provide support for URLs with ports, eg: `8080` |\r\n| `oauth` | `Bool` | no | When `true` authorize via OAuth 1.0a, default is `false` |\r\n| `timeout` | `Integer` | no | Define the request timeout |\r\n| `axiosConfig` | `Object` | no | Define the custom [Axios config](https://github.com/axios/axios#request-config), also override this library options. |\r\n\r\n## Methods\r\n\r\n### GET\r\n\r\n- `.get(endpoint)`\r\n- `.get(endpoint, params)`\r\n\r\n| Params | Type | Description |\r\n|------------|----------|------------------------------------------------------ |\r\n| `endpoint` | `String` | CoCart API endpoint, example: `cart` or `products/32` |\r\n| `params` | `Object` | Query strings params, example: `{ per_page: 20 }` |\r\n\r\n### POST\r\n\r\n- `.post(endpoint, data)`\r\n- `.post(endpoint, data, params)`\r\n\r\n| Params | Type | Description |\r\n|------------|----------|------------------------------------------------------------- |\r\n| `endpoint` | `String` | CoCart API endpoint, example: `cart/add-item` or `cart/item` |\r\n| `data` | `Object` | JS object to be converted into JSON and sent in the request |\r\n| `params` | `Object` | Query strings params |\r\n\r\n### PUT\r\n\r\n- `.put(endpoint, data)`\r\n- `.putt(endpoint, data, params)`\r\n\r\n| Params | Type | Description |\r\n|------------|----------|-------------------------------------------------------------|\r\n| `endpoint` | `String` | CoCart API endpoint, example: `cart/item/` |\r\n| `data` | `Object` | JS object to be converted into JSON and sent in the request |\r\n| `params` | `Object` | Query strings params |\r\n\r\n### DELETE\r\n\r\n- `.delete(endpoint)`\r\n- `.delete(endpoint, params)`\r\n\r\n| Params | Type | Description |\r\n|------------|----------|------------------------------------------------------ |\r\n| `endpoint` | `String` | CoCart API endpoint, example: `cart/item` or `coupon` |\r\n| `params` | `Object` | Query strings params, example: `{ force: true }` |\r\n\r\n## Bug Reporting\r\n\r\nIf you think you have found a bug in the library, please [open a new issue](https://github.com/co-cart/cocart-js-lib/issues/new/choose) and I will do my best to help you out.\r\n\r\n## CoCart Channels\r\n\r\nWe have different channels at your disposal where you can find information about the CoCart project, discuss it and get involved:\r\n\r\n[![Twitter: cart_co](https://img.shields.io/twitter/follow/cart_co?style=social)](https://twitter.com/cart_co) [![CoCart JS Lib Github Stars](https://img.shields.io/github/stars/co-cart/cocart-js-lib?style=social)](https://github.com/co-cart/cocart-js-lib)\r\n\r\n\r\n\r\n## I'm not seeing `X-COCART-API` header returning\r\n\r\nIf you want this header to return then you need to enable CORS. Simply [install CoCart CORS plugin](https://wordpress.org/plugins/cocart-cors/) for quick activation.\r\n\r\n## Changelog\r\n\r\n[See changelog for details](https://github.com/co-cart/cocart-js-lib/blob/master/CHANGELOG.md)\r\n\r\n## Credits\r\n\r\nCoCart is developed and maintained by [Sébastien Dumont](https://github.com/seb86).\r\n\r\n---\r\n\r\n[sebastiendumont.com](https://sebastiendumont.com)  · \r\nGitHub [@seb86](https://github.com/seb86)  · \r\nTwitter [@sebd86](https://twitter.com/sebd86)\r\n\r\n

\r\n \r\n

\r\n","readmeFilename":"README.md"}