{"_id":"metal-pay-connect-js","_rev":"42-abd7690b4b926f7ae6b79aa6f91c1cbf","name":"metal-pay-connect-js","dist-tags":{"latest":"0.1.25"},"versions":{"0.1.19":{"name":"metal-pay-connect-js","version":"0.1.19","keywords":[],"author":"","license":"ISC","_id":"metal-pay-connect-js@0.1.19","maintainers":[{"name":"frontend-admins","email":"frontend-admins@metalpay.co"}],"dist":{"shasum":"b53ed1e7ccb9156eec114847434e5572d4bd8c85","tarball":"https://registry.npmjs.org/metal-pay-connect-js/-/metal-pay-connect-js-0.1.19.tgz","fileCount":11,"integrity":"sha512-yJ/T7UGbX6yGuhyD05tauUKnt5oXih81wpvpuqDQqwcZq3cce6ds8KVKfkjdk2ycvGHWCQEL9YmDqzuVz37ivQ==","signatures":[{"sig":"MEQCIH6dm72yT+oD7JyR+oq8GlKcuGW7zW5Vc0RKdPzu2LcZAiBgmRvcQJkx+CjNllPoqa869k96FMQPCFaNAyhCMGwYRg==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":88364},"main":"dist/metal-pay-connect.umd.js","types":"./types/index.d.ts","module":"dist/metal-pay-connect.es.js","gitHead":"e31d1dcf2e741387e68096e76d08a2e8396c794d","scripts":{"build":"vite build","prepublishOnly":"npm run build"},"_npmUser":{"name":"frontend-admins","email":"frontend-admins@metalpay.co"},"_npmVersion":"9.8.1","description":"``` npm install metal-pay-connect-js ```","directories":{},"_nodeVersion":"16.13.0","dependencies":{"vue":"^3.4.38","react":"^18.3.1","react-dom":"^18.3.1","prop-types":"^15.8.1"},"_hasShrinkwrap":false,"devDependencies":{"vite":"^5.4.2","@babel/core":"^7.25.2","@babel/preset-env":"^7.25.4","@vitejs/plugin-vue":"^5.1.2","@babel/preset-react":"^7.24.7","@vitejs/plugin-react":"^4.3.1"},"_npmOperationalInternal":{"tmp":"tmp/metal-pay-connect-js_0.1.19_1725870309130_0.4380872745718347","host":"s3://npm-registry-packages"}},"0.1.20":{"name":"metal-pay-connect-js","version":"0.1.20","_id":"metal-pay-connect-js@0.1.20","maintainers":[{"name":"frontend-admins","email":"frontend-admins@metalpay.co"}],"dist":{"shasum":"db003376d72437388675c6f2c3b92f4b472f0171","tarball":"https://registry.npmjs.org/metal-pay-connect-js/-/metal-pay-connect-js-0.1.20.tgz","fileCount":8,"integrity":"sha512-DLgJCl6MfQrF2vgAZk+EDmS11Sjp9+QAFpeQEAIiqi+A6EAeW1pRHrYGsAy37vZZQ+6vKCuZU3syETwKOs1w4w==","signatures":[{"sig":"MEUCICC375Oa0R9fpkUeuDbA704kYRGqTGKJhpGxlbegQqCWAiEA1b9Z5dimAP+rIwjS2CoS9ua2l/pv6Uq/Xghw8RMIm0Q=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":14529},"type":"module","exports":{"main":"./dist/index.cjs","types":"./dist/index.d.ts","module":"./dist/index.js"},"gitHead":"e76ce97d076503ffe90573e989533cb6156ff43d","scripts":{"dev":"tsup src/index.ts --format cjs,esm --dts-resolve --watch --onSuccess 'tsup src/index.ts --format cjs,esm --dts-resolve --dts-only'","lint":"eslint . --max-warnings 0","build":"tsup src/index.ts --format cjs,esm --dts-resolve --minify"},"_npmUser":{"name":"frontend-admins","email":"frontend-admins@metalpay.co"},"_npmVersion":"10.8.2","description":"## Overview","directories":{},"_nodeVersion":"18.18.2","dependencies":{"qs":"^6.13.0","lodash-es":"^4.17.21"},"_hasShrinkwrap":false,"devDependencies":{"tsup":"^8.2.4","eslint":"^8.57.0","prettier":"^3.3.3","@types/qs":"^6.9.15","type-fest":"^4.26.1","typescript":"^5.5.4","@types/eslint":"^8.56.12","@types/lodash":"^4.17.7","@types/lodash-es":"^4.17.12"},"_npmOperationalInternal":{"tmp":"tmp/metal-pay-connect-js_0.1.20_1726268088629_0.09741779205865098","host":"s3://npm-registry-packages"}},"0.1.21":{"name":"metal-pay-connect-js","version":"0.1.21","_id":"metal-pay-connect-js@0.1.21","maintainers":[{"name":"frontend-admins","email":"frontend-admins@metalpay.co"}],"dist":{"shasum":"d508c9740a732240f21683be064ed15d165657e0","tarball":"https://registry.npmjs.org/metal-pay-connect-js/-/metal-pay-connect-js-0.1.21.tgz","fileCount":6,"integrity":"sha512-r6L0lfMbNgkN6EF8XICFi/UibYhyouELqmiCrGcwPalwQ790dQUY76X7ieAujzAL9LJMtnbNAEzEYafAKMMAsQ==","signatures":[{"sig":"MEUCIQDFvdVWs8PGtbA9pqgNHiZPEcJGk+5tq6R5GIE1sAM4bQIgZ1poahPphBmXIOYwv2IG9u8oNk2zlgt35TqzNlv7Qaw=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":42394},"type":"module","exports":{"main":"./dist/index.cjs","types":"./dist/index.d.ts","module":"./dist/index.js"},"gitHead":"cbb020f6cedd9a81e5a0d4646fbc8b52fa82aa3d","scripts":{"dev":"tsup src/index.ts --format cjs,esm --dts-resolve --watch --onSuccess 'tsup src/index.ts --format cjs,esm --dts-resolve --dts-only'","lint":"eslint . --max-warnings 0","build":"tsup src/index.ts --format cjs,esm --dts-resolve --minify"},"_npmUser":{"name":"frontend-admins","email":"frontend-admins@metalpay.co"},"_npmVersion":"10.8.2","description":"## Overview","directories":{},"_nodeVersion":"18.18.2","dependencies":{"qs":"^6.13.0","lodash-es":"^4.17.21"},"_hasShrinkwrap":false,"devDependencies":{"tsup":"^8.2.4","eslint":"^8.57.0","prettier":"^3.3.3","@types/qs":"^6.9.15","type-fest":"^4.26.1","typescript":"^5.5.4","@types/eslint":"^8.56.12","@types/lodash":"^4.17.7","@types/lodash-es":"^4.17.12"},"_npmOperationalInternal":{"tmp":"tmp/metal-pay-connect-js_0.1.21_1726508446644_0.13422844028625813","host":"s3://npm-registry-packages"}},"0.1.22":{"name":"metal-pay-connect-js","version":"0.1.22","_id":"metal-pay-connect-js@0.1.22","maintainers":[{"name":"frontend-admins","email":"frontend-admins@metalpay.co"}],"dist":{"shasum":"3ac40f18a24f11993871e9fa94709a3166243990","tarball":"https://registry.npmjs.org/metal-pay-connect-js/-/metal-pay-connect-js-0.1.22.tgz","fileCount":6,"integrity":"sha512-uKoOf8HzEO1ASVMN09Y+NiJN6UslpVSb18CuK984i675ekolae6+EkMy8pfYUE94uZbD+PMvQChCswy4z4Z5ug==","signatures":[{"sig":"MEYCIQChSfRWJ4+oSwyWa6WS+aovcMd2KPUTD//7N7rUijFFqgIhAKstnzmuU4kEZNzTfPxK46LKcOe377OxAsEOIw8Q7eAI","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":42397},"type":"module","exports":{"main":"./dist/index.cjs","types":"./dist/index.d.ts","module":"./dist/index.js"},"gitHead":"7800958251f6dfd7c0eca231d8e1719f0c65887d","scripts":{"dev":"tsup src/index.ts --format cjs,esm --dts-resolve --watch --onSuccess 'tsup src/index.ts --format cjs,esm --dts-resolve --dts-only'","lint":"eslint . --max-warnings 0","build":"tsup src/index.ts --format cjs,esm --dts-resolve --minify"},"_npmUser":{"name":"frontend-admins","email":"frontend-admins@metalpay.co"},"_npmVersion":"10.8.2","description":"## Overview","directories":{},"_nodeVersion":"18.18.2","dependencies":{"qs":"^6.13.0","lodash-es":"^4.17.21"},"_hasShrinkwrap":false,"devDependencies":{"tsup":"^8.2.4","eslint":"^8.57.0","prettier":"^3.3.3","@types/qs":"^6.9.15","type-fest":"^4.26.1","typescript":"^5.5.4","@types/eslint":"^8.56.12","@types/lodash":"^4.17.7","@types/lodash-es":"^4.17.12"},"_npmOperationalInternal":{"tmp":"tmp/metal-pay-connect-js_0.1.22_1726530767871_0.8572761959472446","host":"s3://npm-registry-packages"}},"0.1.23":{"name":"metal-pay-connect-js","version":"0.1.23","_id":"metal-pay-connect-js@0.1.23","maintainers":[{"name":"frontend-admins","email":"frontend-admins@metalpay.co"}],"dist":{"shasum":"8aaa3a4af0a4626f55369b3d5fc6c29876617c5f","tarball":"https://registry.npmjs.org/metal-pay-connect-js/-/metal-pay-connect-js-0.1.23.tgz","fileCount":6,"integrity":"sha512-wr/9paercYx7ZeOrXvRNr8y4+L7guV6mRAalc0pj7RVNhWzRSxy57b6Y7BXg7LnW+Z5W3YrG7sqbRIrdZmu0KQ==","signatures":[{"sig":"MEUCICVRUtPqa52irtDPVL4/6ARRjKG/SAXqUYeNNXu+L6MWAiEA3L5e6Axq5KlAk79pUtWLuLcETpu/IKgO2Pzivq1PQzk=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":42644},"main":"./dist/index.cjs","type":"module","types":"./dist/index.d.ts","module":"./dist/index.js","exports":{"main":"./dist/index.cjs","types":"./dist/index.d.ts","module":"./dist/index.js"},"gitHead":"93f7f5c06d84ac0350be61049450cc183d0b1035","scripts":{"dev":"tsup src/index.ts --format cjs,esm --dts-resolve --watch --onSuccess 'tsup src/index.ts --format cjs,esm --dts-resolve --dts-only'","lint":"eslint . --max-warnings 0","build":"tsup src/index.ts --format cjs,esm --dts-resolve --minify","release":"np --no-tests"},"_npmUser":{"name":"frontend-admins","email":"frontend-admins@metalpay.co"},"_npmVersion":"10.8.2","description":"## Overview","directories":{},"_nodeVersion":"18.18.2","dependencies":{"qs":"^6.13.0","lodash-es":"^4.17.21"},"_hasShrinkwrap":false,"devDependencies":{"np":"^10.0.7","tsup":"^8.2.4","eslint":"^8.57.0","prettier":"^3.3.3","@types/qs":"^6.9.15","type-fest":"^4.26.1","typescript":"^5.5.4","@types/eslint":"^8.56.12","@types/lodash":"^4.17.7","@types/lodash-es":"^4.17.12"},"_npmOperationalInternal":{"tmp":"tmp/metal-pay-connect-js_0.1.23_1726695889862_0.21941307537016552","host":"s3://npm-registry-packages"}},"0.1.24":{"name":"metal-pay-connect-js","version":"0.1.24","_id":"metal-pay-connect-js@0.1.24","maintainers":[{"name":"frontend-admins","email":"frontend-admins@metalpay.co"}],"dist":{"shasum":"4ca0e6f4304a591f032746330c83bb5044ac604e","tarball":"https://registry.npmjs.org/metal-pay-connect-js/-/metal-pay-connect-js-0.1.24.tgz","fileCount":6,"integrity":"sha512-ERdW7D9dkuBll3uL4qPKUA9tQgcoj2PTxzwI75SrLPPc86egn2MANy5UqiCwgyz3G7j2CAe4Fo/h7Aii/olhYg==","signatures":[{"sig":"MEUCIF6w4xuA0a1UA6BwNECeQqbDDUZgvxUpRTK2MOkV3xkpAiEA4GDzLduv4CY+GJIJoSVgT1wPQrYpsFRA86Ob9gnfCaw=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":42654},"main":"./dist/index.cjs","type":"module","types":"./dist/index.d.ts","module":"./dist/index.js","exports":{"main":"./dist/index.cjs","types":"./dist/index.d.ts","module":"./dist/index.js"},"gitHead":"3ddcfeb8d131c705c0c5a8698f69b85da9420a24","scripts":{"dev":"tsup src/index.ts --format cjs,esm --dts-resolve --watch --onSuccess 'tsup src/index.ts --format cjs,esm --dts-resolve --dts-only'","lint":"eslint . --max-warnings 0","build":"tsup src/index.ts --format cjs,esm --dts-resolve --minify","release":"np --no-tests"},"_npmUser":{"name":"frontend-admins","email":"frontend-admins@metalpay.co"},"_npmVersion":"10.8.2","description":"## Overview","directories":{},"_nodeVersion":"18.18.2","dependencies":{"qs":"^6.13.0","lodash-es":"^4.17.21"},"_hasShrinkwrap":false,"devDependencies":{"np":"^10.0.7","tsup":"^8.2.4","eslint":"^8.57.0","prettier":"^3.3.3","@types/qs":"^6.9.15","type-fest":"^4.26.1","typescript":"^5.5.4","@types/eslint":"^8.56.12","@types/lodash":"^4.17.7","@types/lodash-es":"^4.17.12"},"_npmOperationalInternal":{"tmp":"tmp/metal-pay-connect-js_0.1.24_1726764114142_0.12401583374299996","host":"s3://npm-registry-packages"}},"0.1.25":{"name":"metal-pay-connect-js","version":"0.1.25","type":"module","main":"./dist/index.cjs","module":"./dist/index.js","types":"./dist/index.d.ts","exports":{"main":"./dist/index.cjs","module":"./dist/index.js","types":"./dist/index.d.ts"},"scripts":{"dev":"tsup src/index.ts --format cjs,esm --dts-resolve --watch --onSuccess 'tsup src/index.ts --format cjs,esm --dts-resolve --dts-only'","build":"tsup src/index.ts --format cjs,esm --dts-resolve --minify","lint":"eslint . --max-warnings 0","release":"np --no-tests"},"devDependencies":{"@types/eslint":"^8.56.12","@types/lodash":"^4.17.7","@types/lodash-es":"^4.17.12","@types/qs":"^6.9.15","eslint":"^8.57.0","np":"^10.0.7","prettier":"^3.3.3","tsup":"^8.2.4","type-fest":"^4.26.1","typescript":"^5.5.4"},"dependencies":{"lodash-es":"^4.17.21","qs":"^6.13.0"},"_id":"metal-pay-connect-js@0.1.25","gitHead":"32194023c4e1bade247a7b0f46327dcb4189f318","description":"## Overview","_nodeVersion":"23.6.1","_npmVersion":"11.0.0","dist":{"integrity":"sha512-AnJBSkrcnb3BbKACLI2JbVSaUd1ZUeX6dYTk1D8A2ljYZS1m2nQpNr/yCGqu+Ue5CXJr9friP6gqj4j10V6KFw==","shasum":"a7efc4331fc0cd564b739ea97c49c620ee4d8467","tarball":"https://registry.npmjs.org/metal-pay-connect-js/-/metal-pay-connect-js-0.1.25.tgz","fileCount":6,"unpackedSize":42730,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIBnsSOC3KdwjJumpz1LrT78mfRdhFIFb/VXFQxvM3M5CAiEAqV3JceF0Pxtekl3xEIAqY4duAAnyw6zV6Xo3bDgjPEA="}]},"_npmUser":{"name":"frontend-admins","email":"frontend-admins@metalpay.co"},"directories":{},"maintainers":[{"name":"frontend-admins","email":"frontend-admins@metalpay.co"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/metal-pay-connect-js_0.1.25_1740443464275_0.4924753422942443"},"_hasShrinkwrap":false}},"time":{"created":"2024-08-28T06:38:45.814Z","modified":"2025-02-25T00:31:04.632Z","0.1.0":"2024-08-28T06:38:45.949Z","0.1.1":"2024-08-28T06:56:23.169Z","0.1.2":"2024-08-28T07:04:57.960Z","0.1.3":"2024-08-28T07:07:44.071Z","0.1.4":"2024-08-28T07:12:57.244Z","0.1.5":"2024-08-28T07:20:02.530Z","0.1.6":"2024-08-28T07:31:57.727Z","0.1.7":"2024-08-28T07:36:14.215Z","0.1.8":"2024-08-28T07:47:08.218Z","0.1.9":"2024-09-04T06:11:30.204Z","0.1.10":"2024-09-04T06:20:22.913Z","0.1.11":"2024-09-09T07:14:10.020Z","0.1.13":"2024-09-09T07:23:41.674Z","0.1.14":"2024-09-09T07:35:36.037Z","0.1.15":"2024-09-09T07:38:38.781Z","0.1.16":"2024-09-09T07:42:40.665Z","0.1.17":"2024-09-09T08:05:05.466Z","0.1.18":"2024-09-09T08:20:58.831Z","0.1.19":"2024-09-09T08:25:09.260Z","0.1.20":"2024-09-13T22:54:48.844Z","0.1.21":"2024-09-16T17:40:46.859Z","0.1.22":"2024-09-16T23:52:48.038Z","0.1.23":"2024-09-18T21:44:50.062Z","0.1.24":"2024-09-19T16:41:54.324Z","0.1.25":"2025-02-25T00:31:04.459Z"},"description":"## Overview","maintainers":[{"name":"frontend-admins","email":"frontend-admins@metalpay.co"}],"readme":"# metal-pay-connect-js\n\n## Overview\n\n**metal-pay-connect-js** is a web SDK designed to help ease the integration of the Metal Pay Connect widget. It provides everything you need to help get you started buying cryptocurrency.\n\n## Features\n\n- Easy integration of the Metal Pay Connect widget\n- Bundles type declarations to provide TypeScript support\n\n## Installation\n\nTo integrate **metal-pay-connect-js** into your project, follow these steps:\n\n### Using npm\n\n```bash\nnpm install --save metal-pay-connect-js\n```\n\n### Using yarn\n\n```bash\nyarn add metal-pay-connect-js\n```\n\n### Using pnpm\n\n```bash\npnpm add metal-pay-connect-js\n```\n\n## Prerequisites\n\n- An active Metal Pay Connect account\n- Your Metal Pay Connect API key\n\n## Usage\n\nHere’s how you can start using **metal-pay-connect-js** in your project:\n\n### JavaScript and TypeScript\n\n```ts\nimport { MetalPayConnect } from 'metal-pay-connect-js'\n\n// Your code ...\n\nconst metalPayConnectEl = document.getElementById('metal-pay-connect')\n\n// Initialize the SDK with configuration options\nconst metalPayConnect = new MetalPayConnect({\n  el: metalPayConnectEl,\n  environment: 'dev',\n  params: {\n    apiKey: 'YOUR_API_KEY',\n    signature: 'YOUR_SIGNATURE',\n    nonce: 'YOUR_NONCE'\n  }\n})\n\n// Cleanup the SDK\nmetalPayConnect.destroy()\n```\n\n### React\n\n```ts\nimport { MetalPayConnect } from 'metal-pay-connect-js'\n\n// Your code ...\n\nconst metalPayConnectEl = useRef()\n\nuseEffect(() => {\n  // Initialize the SDK with configuration options\n  const metalPayConnect = new MetalPayConnect({\n    el: metalPayConnectEl.current,\n    environment: 'dev',\n    params: {\n      apiKey: 'YOUR_API_KEY',\n      signature: 'YOUR_SIGNATURE',\n      nonce: 'YOUR_NONCE'\n    }\n  })\n\n  return () => {\n    // Cleanup the SDK\n    metalPayConnect.destroy()\n  }\n}, [])\n```\n\n### Vue.js\n\n```js\nimport { MetalPayConnect } from 'metal-pay-connect-js'\n\n// Your code ...\n\nconst metalPayConnectEl = useTemplateRef('metal-pay-connect')\n\n// Initialize the SDK with configuration options\nconst metalPayConnect = ref(\n  new MetalPayConnect({\n    el: metalPayConnectEl.value,\n    environment: 'dev',\n    params: {\n      apiKey: 'YOUR_API_KEY',\n      signature: 'YOUR_SIGNATURE',\n      nonce: 'YOUR_NONCE'\n    }\n  })\n)\n\nonUnmounted(() => {\n  // Cleanup the SDK\n  metalPayConnect.value.destroy()\n})\n```\n\n## API Reference\n\n### `MetalPayConnect`\n\n- **Constructor**: `new MetalPayConnect(config: Config)`\n  - `config`: configuration object\n- **Method**: `update(params: PartialDeep<Params>): void`\n  - `action`: updates the config params\n  - `params`: partial config params\n- **Method**: `destroy(): void`\n- **Accessor**: `config: InnerConfig`\n\n### Config interface\n\n```ts\ntype Environment = 'preview' | 'dev' | 'prod'\n\ninterface Params {\n  apiKey: string\n  signature: string\n  nonce: string\n  networks?: string[]\n  address?: Record<string, string>\n}\n\ninterface SignatureRequestResponseData {\n  signature: string\n  nonce: string\n}\n\ninterface Handlers {\n  onSignatureRequest?: () => Promisable<SignatureRequestResponseData>\n  onTransactionResponse?: () => Promisable<void>\n}\n\ninterface Config {\n  el?: HTMLElement\n  environment?: Environment\n  params: Params\n  handlers?: Handlers\n}\n```\n\n### InnerConfig interface\n\n```ts\ninterface InnerConfig extends Config {\n  environment: Environment\n  version: string\n}\n```\n","readmeFilename":"README.md"}