{"_id":"y-dynamodb-for-sdkv3","_rev":"3-e9e9fd50c2d40956e213aea4fea36d39","name":"y-dynamodb-for-sdkv3","dist-tags":{"latest":"1.0.0"},"versions":{"0.1.0":{"name":"y-dynamodb-for-sdkv3","version":"0.1.0","description":"DynamoDB database adapter for Yjs","main":"./dist/index.cjs","module":"./dist/index.mjs","types":"./dist/index.d.ts","author":{"name":"Tatsuya Yamamoto","email":"the.kinnikuman@gmail.com","url":"https://github.com/yamatatsu"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/yamatatsu/yjs-lab.git"},"bugs":{"url":"https://github.com/yamatatsu/yjs-lab/issues"},"homepage":"https://github.com/yamatatsu/yjs-lab/tree/main/packages/y-dynamodb-for-sdkv3#readme","keywords":["Yjs","CRDT","offline","shared editing","collaboration","concurrency","aws","dynamodb","amazon","database"],"exports":{".":{"types":"./dist/index.d.ts","require":"./dist/index.cjs","import":"./dist/index.mjs"}},"dependencies":{"lib0":"^0.2.62"},"peerDependencies":{"@aws-sdk/client-dynamodb":"^3.272.0","yjs":"^13.5.45"},"devDependencies":{"@aws-sdk/client-dynamodb":"^3.272.0","@types/jest":"^29.4.0","@types/node":"18.13.0","jest":"^29.4.2","jest-dynalite":"^3.6.1","ts-jest":"^29.0.5","typescript":"~4.9.5","unbuild":"^1.1.2","yjs":"^13.5.45"},"scripts":{"build":"unbuild","test":"jest --runInBand"},"_id":"y-dynamodb-for-sdkv3@0.1.0","_integrity":"sha512-xb5O00kP41nPQZqAJqaUm+pHys8VkZqGiSL9DLTWyGZnWNMaZ0Wfb89HQJugb9obSkXxJFMEndOzmIpU0d/aQA==","_resolved":"/private/var/folders/z_/113mvlrd2yx9s1fb4bt3rrf80000gn/T/8d0353f32974e98574acba013edaa7ab/y-dynamodb-for-sdkv3-0.1.0.tgz","_from":"file:y-dynamodb-for-sdkv3-0.1.0.tgz","_nodeVersion":"18.13.0","_npmVersion":"8.19.3","dist":{"integrity":"sha512-xb5O00kP41nPQZqAJqaUm+pHys8VkZqGiSL9DLTWyGZnWNMaZ0Wfb89HQJugb9obSkXxJFMEndOzmIpU0d/aQA==","shasum":"8d61c43759fbece512f4c21301e22c4e9eca93f1","tarball":"https://registry.npmjs.org/y-dynamodb-for-sdkv3/-/y-dynamodb-for-sdkv3-0.1.0.tgz","fileCount":7,"unpackedSize":39337,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDAVLhwq/4XIZIuG/t+iM+1s2/No/bs3JwkhJZa1S/jiQIhAMoIOO5HLabTVnkAp0EXgZji+Tti4O8HUWG6BqLdxH6g"}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJkAuquACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmoKXA/9GUjOqmbRB7WitWf1YUMRf9NTvwxqnKRMQ7nOa+SRFrpUyzG8\r\nTlCGKUoEF1ODmew9W1sgaLKByU6GtJzpLr9FqWGKpXNAaAw1kCWT7Ax73HJH\r\nlq43Aa8U6sEN6AE+5hAPCMG2jlxoAIiB2wqyV/ZQEEOYv+qF10tXG1OCWMPq\r\nsjZtwTsLS4QxSz1EWjD0pIvv1xPq8HvJmjFQhMaZfCv3m0jk69EtUFhR4OdY\r\nco9v8mvRaOZxENhLzKJeWSmvdiW0z8mZGS/jAgXJU8i3HoOCZsJj9JDZzI2g\r\nA0GO12V0XSCESmDVCo5JRi+GxPPCo+4/tgAc6/nt0rA5+Fplwgqj0u1K5eEt\r\nsWNMYbwEPDddKzP6+cwNAd7OOzHIlqrPUczwfozhDtW5kPpHlEHzhe/bB6YQ\r\nRpcc1Bz3W4Le2+ccmXfay5/TY/X6gXp7ZETTe1AY3pVNETyN26XNZmFEQo63\r\nni8svq0cn5mvXNtSmZteMFqVTcLgAO7uVF1p+O/Ln2JUPxLtB5ZbesrqCOAE\r\nBYUlAhRawaKXY5pSKRJoG+IGKvTvoQfe32EgCRHW6XD1Ub1EQqUbggk13WR6\r\n/55sacVP8YFRrxDbdrvbGRLGV3Ialq1YFgI/j4/9+MEYLbMCwx9cx+okc8+c\r\nPwogyURPpA5KRl8OOYwtbVUhqYJ0vN9W3J4=\r\n=3Rwn\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"yamatatsu","email":"the.kinnikuman@gmail.com"},"directories":{},"maintainers":[{"name":"yamatatsu","email":"the.kinnikuman@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/y-dynamodb-for-sdkv3_0.1.0_1677912749939_0.29884543718962675"},"_hasShrinkwrap":false},"0.2.0":{"name":"y-dynamodb-for-sdkv3","version":"0.2.0","description":"DynamoDB database adapter for Yjs","main":"./dist/index.cjs","module":"./dist/index.mjs","types":"./dist/index.d.ts","author":{"name":"Tatsuya Yamamoto","email":"the.kinnikuman@gmail.com","url":"https://github.com/yamatatsu"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/yamatatsu/yjs-lab.git"},"bugs":{"url":"https://github.com/yamatatsu/yjs-lab/issues"},"homepage":"https://github.com/yamatatsu/yjs-lab/tree/main/packages/y-dynamodb-for-sdkv3#readme","keywords":["Yjs","CRDT","offline","shared editing","collaboration","concurrency","aws","dynamodb","amazon","database"],"exports":{".":{"types":"./dist/index.d.ts","require":"./dist/index.cjs","import":"./dist/index.mjs"}},"dependencies":{"lib0":"^0.2.62"},"peerDependencies":{"@aws-sdk/client-dynamodb":"^3.272.0","yjs":"^13.5.45"},"devDependencies":{"@aws-sdk/client-dynamodb":"^3.272.0","@types/jest":"^29.4.0","@types/node":"18.13.0","jest":"^29.4.2","jest-dynalite":"^3.6.1","ts-jest":"^29.0.5","typescript":"~4.9.5","unbuild":"^1.1.2","yjs":"^13.5.45"},"scripts":{"build":"unbuild","test":"jest --runInBand"},"_id":"y-dynamodb-for-sdkv3@0.2.0","_integrity":"sha512-JsplB4fZPDpxajFPY/qTJSPo5JUXTAFe/UyoW3RlaTINPM0RDsrCJNn4r8NzGDtnlFLPrpjLHWoGd4+JVwty+g==","_resolved":"/tmp/f517f282da50f02304995a670eb2a8ee/y-dynamodb-for-sdkv3-0.2.0.tgz","_from":"file:y-dynamodb-for-sdkv3-0.2.0.tgz","_nodeVersion":"18.14.2","_npmVersion":"9.5.0","dist":{"integrity":"sha512-JsplB4fZPDpxajFPY/qTJSPo5JUXTAFe/UyoW3RlaTINPM0RDsrCJNn4r8NzGDtnlFLPrpjLHWoGd4+JVwty+g==","shasum":"65d95b4adf2c864e36f3993c29ea6b5da4ec7402","tarball":"https://registry.npmjs.org/y-dynamodb-for-sdkv3/-/y-dynamodb-for-sdkv3-0.2.0.tgz","fileCount":7,"unpackedSize":39337,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCICryGblYvBjxWY0qIfW1UndFpx91dH95mR5PEt8dJEa9AiEA4TTTxqVG06b1i7wFc6BJxrE7wB0mtkWVQLdj26InO5o="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJkAzHlACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmrm9A//RU3dVa9OgY6n+/MtUjufzg0IvAuPAVHzyF0rcQH0CftHsnxw\r\nu2PZdDFmVKIWsKRCUcwGTqENVk/igzhEdcf9no2fHzWFkzYBMCY/rPI+8+BO\r\nkvPn4axXwh4LCkxGR/W9KUk9fi7S6lnOwDfjmwxmT+HsEA0ClVXOFxOHMs1I\r\nudODYkc66ZgAUVycFf4Ai9M1vfZjMdbZdm3clwMkxJ1U0N3zaOk79IqOofrR\r\noTUbI/ZHrc9Bg9uNeq5z1F9jCzoV0GWDbnFgsZ47CIwPrfExHKmP8JucUcNR\r\ncD3CmDkjfR8b9mZD/bQxyBHOo/6SB5n40x7saMKbByVPRoqtAITGBsFYfrWQ\r\nRJ0VOOefqhVSBLAHEfnnp5jOvA5HITsRSXTu0BaiLh3nVJ3ZPpPZhMaiHfxH\r\n6T7FDdJHBQZhOUOTN8mDeIazXZDIToOdiv8oF9LogaNaIwYHGVGf9DcZ0x+1\r\nxFNWjGpGa8k208OMxnCuZpYat3QRbRdxCXdmWuUMWoFv9dY2GcEWi4vcSNq/\r\nh/vLIwF27pKsUl5kkKz0OoTD1hmrv6DFfLZAB2N9WhOWJDA5aIRZrSGQQMW0\r\npd1Fe6egqf9zo+PFf4bOfTXzyIEmmGRyoLa9ct7qz5aMxNJCZX9rKZf0OdIY\r\n0mkt8xHJSgXVw+D1tMwyfuxf2SDmdJH7GFw=\r\n=zty1\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"yamatatsu","email":"the.kinnikuman@gmail.com"},"directories":{},"maintainers":[{"name":"yamatatsu","email":"the.kinnikuman@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/y-dynamodb-for-sdkv3_0.2.0_1677930981229_0.7911514842313268"},"_hasShrinkwrap":false},"0.3.0":{"name":"y-dynamodb-for-sdkv3","version":"0.3.0","description":"DynamoDB database adapter for Yjs","main":"./dist/index.cjs","module":"./dist/index.mjs","types":"./dist/index.d.ts","author":{"name":"Tatsuya Yamamoto","email":"the.kinnikuman@gmail.com","url":"https://github.com/yamatatsu"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/yamatatsu/yjs-lab.git"},"bugs":{"url":"https://github.com/yamatatsu/yjs-lab/issues"},"homepage":"https://github.com/yamatatsu/yjs-lab/tree/main/packages/y-dynamodb-for-sdkv3#readme","keywords":["Yjs","CRDT","offline","shared editing","collaboration","concurrency","aws","dynamodb","amazon","database"],"exports":{".":{"types":"./dist/index.d.ts","require":"./dist/index.cjs","import":"./dist/index.mjs"}},"dependencies":{"lib0":"^0.2.62"},"peerDependencies":{"@aws-sdk/client-dynamodb":"^3.272.0","yjs":"^13.5.45"},"devDependencies":{"@aws-sdk/client-dynamodb":"^3.272.0","@types/jest":"^29.4.0","@types/node":"18.13.0","jest":"^29.4.2","jest-dynalite":"^3.6.1","ts-jest":"^29.0.5","typescript":"~4.9.5","unbuild":"^1.1.2","yjs":"^13.5.45"},"scripts":{"build":"unbuild","test":"jest --runInBand"},"_id":"y-dynamodb-for-sdkv3@0.3.0","_integrity":"sha512-MlJ6Ck/oniVPNRxpSQjG5bvkgqyX27gM1+9UEzWrtfwhApFCQpyr1eF1o1M6fmwKErjSSeRwFAnPepZEUmNKNQ==","_resolved":"/tmp/edb5efcf8c4266ebee3f28a7e469866e/y-dynamodb-for-sdkv3-0.3.0.tgz","_from":"file:y-dynamodb-for-sdkv3-0.3.0.tgz","_nodeVersion":"18.14.2","_npmVersion":"9.5.0","dist":{"integrity":"sha512-MlJ6Ck/oniVPNRxpSQjG5bvkgqyX27gM1+9UEzWrtfwhApFCQpyr1eF1o1M6fmwKErjSSeRwFAnPepZEUmNKNQ==","shasum":"f196b0a69ae6369b22c58eb85d1e4162c8f1f8aa","tarball":"https://registry.npmjs.org/y-dynamodb-for-sdkv3/-/y-dynamodb-for-sdkv3-0.3.0.tgz","fileCount":7,"unpackedSize":39337,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDJkuUS0bQAjglFu944wrAJRil3NO4QFYcICxFIXmX1GwIgBfV2Rxr/GhnBxJeAUFXX0zVFMh4swww5chR1xXEqe0s="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJkAzYtACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmpcsg/8CEMLbx2qT+fdMHYBHk74UZ31hERjhgE+vE1wSnHbX0gNDzwR\r\nat229knnolZXs+jYTML6cVlk0vlk+4WJvoYWXUE7CnuRifSYQBlGcdAG5VsN\r\noJjhBW/VUtpNkXY6JXuphLFwPWFAu4Y4+BlIwxpZ8zU1W5kxUZB7mJ6z+6k9\r\nSf4ky3ya/R5wnT773diZEYaSXxqN1orIyeeXfEhmzOw40d/guIygDT6Ompe3\r\nztZITil3COOXHTAp8QF6GmMEu+rGrE7KkqDiyjrmxQBHp4/nNEm4vVsW7zuE\r\n+YvcsECkfa8ox9rPfyrEEjNU281iwXR7fq0mFiF3SmtMrCGAM98EDJKi1uK+\r\n4ySSkt3gAonQvV4q8oGxJ0eZGAIb4bQ/wyTKVc5IDZkM1cDnortz0pSOupLU\r\nfgbxFnZI4fIMPG5BLnD65OxMvXkSH1cpY3ida3Z7HTfVzc6GAnSx46ft4cSA\r\nzB6cQzgoKg/PTH7MnwBhkWPrSKLN5kG8lwKYAm0r1YamFc2a2QC5XkvU64m7\r\nxg84eq4tweD8m8TMqEaaUyWxMtANF0uy9MdNg7r9XiWlXKpPSw6hab/y5Yj5\r\nRNEhp6PeraPyJ/aqOXUu8OWjhqPrGfklqR5kLM9gB1/vVBGvX8MnQXtf87Sr\r\nyqkn/AmG79KsBdpihh+38hFZl7wFkAiiChM=\r\n=B9Kq\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"yamatatsu","email":"the.kinnikuman@gmail.com"},"directories":{},"maintainers":[{"name":"yamatatsu","email":"the.kinnikuman@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/y-dynamodb-for-sdkv3_0.3.0_1677932076812_0.6851976778085882"},"_hasShrinkwrap":false},"1.0.0":{"name":"y-dynamodb-for-sdkv3","version":"1.0.0","description":"DynamoDB database adapter for Yjs","main":"./dist/index.cjs","module":"./dist/index.mjs","types":"./dist/index.d.ts","author":{"name":"Tatsuya Yamamoto","email":"the.kinnikuman@gmail.com","url":"https://github.com/yamatatsu"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/yamatatsu/yjs-lab.git"},"bugs":{"url":"https://github.com/yamatatsu/yjs-lab/issues"},"homepage":"https://github.com/yamatatsu/yjs-lab/tree/main/packages/y-dynamodb-for-sdkv3#readme","keywords":["Yjs","CRDT","offline","shared editing","collaboration","concurrency","aws","dynamodb","amazon","database"],"exports":{".":{"types":"./dist/index.d.ts","require":"./dist/index.cjs","import":"./dist/index.mjs"}},"dependencies":{"lib0":"^0.2.62"},"peerDependencies":{"@aws-sdk/client-dynamodb":"^3.272.0","yjs":"^13.5.48"},"devDependencies":{"@aws-sdk/client-dynamodb":"^3.287.0","@types/node":"18.14.6","typescript":"~4.9.5","unbuild":"^1.1.2","vitest":"^0.29.2","vitest-environment-dynalite":"^0.1.3","yjs":"^13.5.48"},"scripts":{"build":"unbuild","test":"vitest run"},"_id":"y-dynamodb-for-sdkv3@1.0.0","_integrity":"sha512-gVkq5vzmCPX1PL25MUZFxrE555cO+oixYOrXjChFQkmyolW4ADge3CDF7wplqDLRmPM+QiNk6lcr5u52iYPAXQ==","_resolved":"/tmp/0aa9c1850f098944fdb27639bd4d6223/y-dynamodb-for-sdkv3-1.0.0.tgz","_from":"file:y-dynamodb-for-sdkv3-1.0.0.tgz","_nodeVersion":"18.14.2","_npmVersion":"9.5.0","dist":{"integrity":"sha512-gVkq5vzmCPX1PL25MUZFxrE555cO+oixYOrXjChFQkmyolW4ADge3CDF7wplqDLRmPM+QiNk6lcr5u52iYPAXQ==","shasum":"dea86a1dc0ea6fe893ce720412706ddb420b91ff","tarball":"https://registry.npmjs.org/y-dynamodb-for-sdkv3/-/y-dynamodb-for-sdkv3-1.0.0.tgz","fileCount":7,"unpackedSize":26501,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIF0oyIjhsaNjcAcfhlO6yTT3rE8az8t8dEEyUOtCA9SsAiEArERbpzr50UEWzzsVMyHlX239+trBzmktC9JTquYrgXU="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJkCoF4ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmryFQ/+I1dvgrXEjh4/nKHCa2STRJihxfoPWIP2/VJ9sKEMLZR3dgG1\r\na5VJ/u7oyiDC3birkzW7kGOPQsu0ME5R+bmkKeiZKuBceOJ7fDikhexPTrSE\r\nB682quKvY+zh0dbab9nFxhqVkjtu9qokAKnT64jMks7xd2dA0xrA/mWz1oZU\r\nEebbqrc3kxcblBSpso6493jDoS82yj9Ibc9SsMRA9vcrvvpJr9Hm9NuBp0zr\r\nEG1xkJAGpmky78frPOB+3W4ULIcTw4TpzMLNODw2Qfs2oi9mEIeQFJDEfUUs\r\nA1wwRO8GiU2zbfaq6snjLdt9JfvV4YOL/Kyduuo+7fpByp/yVgjNChVNzfXJ\r\ncxiOGi29z/v6jo/X9lBtxEtgwardlhSGS8PUm+irz8m1bV079bTLBjbjLKod\r\nOMF+O8dfKwYFXZf5yI05tNwTWfOl8HUac/vi81J88nfWTRFdir3ZquNOGeK0\r\nWxGF32GXvVxcCoejZHuRCff/ovA2RmCo3kXlhKe1W2OPvGgQjdP0naWJ5CKh\r\nY2IT0ViCpqgRcxBRwFY4XmrKXBhJnQRODsjx7vNVMojR9dAAw01j+17+kkTn\r\nyu2udEGKmEQYnpDvaQcsXyJKy2TPpE0eM2FTG3bL9Y6OHp6C7/Yii4AwfLd2\r\nhvj4ryk04kCZGEcNxzpvvOAOicnZXq2YWjg=\r\n=yFhp\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"yamatatsu","email":"the.kinnikuman@gmail.com"},"directories":{},"maintainers":[{"name":"yamatatsu","email":"the.kinnikuman@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/y-dynamodb-for-sdkv3_1.0.0_1678410104720_0.9982684651076965"},"_hasShrinkwrap":false}},"time":{"created":"2023-03-04T06:52:29.938Z","0.1.0":"2023-03-04T06:52:30.145Z","modified":"2023-03-10T01:01:45.004Z","0.2.0":"2023-03-04T11:56:21.384Z","0.3.0":"2023-03-04T12:14:37.006Z","1.0.0":"2023-03-10T01:01:44.878Z"},"maintainers":[{"name":"yamatatsu","email":"the.kinnikuman@gmail.com"}],"description":"DynamoDB database adapter for Yjs","homepage":"https://github.com/yamatatsu/yjs-lab/tree/main/packages/y-dynamodb-for-sdkv3#readme","keywords":["Yjs","CRDT","offline","shared editing","collaboration","concurrency","aws","dynamodb","amazon","database"],"repository":{"type":"git","url":"git+https://github.com/yamatatsu/yjs-lab.git"},"author":{"name":"Tatsuya Yamamoto","email":"the.kinnikuman@gmail.com","url":"https://github.com/yamatatsu"},"bugs":{"url":"https://github.com/yamatatsu/yjs-lab/issues"},"license":"MIT","readme":"# y-dynamodb-for-sdkv3\n\nDynamoDB database adapter for [Yjs](https://github.com/yjs/yjs) for AWS SDK v3\n\nRewritten from [y-dynamodb](https://github.com/hesselbom/y-dynamodb/) to use AWS DynamoDB with AWS SDK v3.\n\n## Installation\n\n```sh\nnpm install y-dynamodb-for-sdkv3 yjs @aws-sdk/client-dynamodb\n```\n\n```sh\nyarn add y-dynamodb-for-sdkv3 yjs @aws-sdk/client-dynamodb\n```\n\n```sh\npnpm add y-dynamodb-for-sdkv3 yjs @aws-sdk/client-dynamodb\n```\n\n## Prerequisite\n\nCreating a DynamoDB table is required before using `y-dynamodb-for-sdkv3`.\n\n##### AWS CLI\n\n```bash\naws dynamodb create-table \\\n  --table-name=y-dynamodb \\\n  --attribute-definitions \\\n    AttributeName=docName,AttributeType=S \\\n    AttributeName=sortKey,AttributeType=S \\\n  --key-schema \\\n    AttributeName=docName,KeyType=HASH \\\n    AttributeName=sortKey,KeyType=RANGE \\\n  --billing-mode=PAY_PER_REQUEST\n```\n\n##### AWS CloudFormation\n\n```yaml\nResources:\n  myDynamoDBTable:\n    Type: AWS::DynamoDB::Table\n    Properties:\n      TableName: y-dynamodb\n      AttributeDefinitions:\n        - AttributeName: docName\n          AttributeType: S\n        - AttributeName: sortKey\n          AttributeType: S\n      KeySchema:\n        - AttributeName: docName\n          KeyType: HASH\n        - AttributeName: sortKey\n          KeyType: RANGE\n      BillingMode: PAY_PER_REQUEST\n```\n\n##### AWS CDK\n\n```ts\nnew dynamodb.Table(this, \"YDynamodbTable\", {\n  tableName: \"y-dynamodb\",\n  removalPolicy: cdk.RemovalPolicy.DESTROY,\n  partitionKey: { name: \"docName\", type: dynamodb.AttributeType.STRING },\n  sortKey: { name: \"sortKey\", type: dynamodb.AttributeType.STRING },\n  billingMode: dynamodb.BillingMode.PAY_PER_REQUEST,\n});\n```\n\n## Usage\n\n### Basic Usage\n\nYou can create an instance of `y-dynamodb-for-sdkv3` as following:\n\n```ts\nimport DynamoDBPersistence from \"y-dynamodb-for-sdkv3\";\nimport { DynamoDBClient } from \"@aws-sdk/client-dynamodb\";\n\nconst client = new DynamoDBClient();\nconst persistence = new DynamoDBPersistence(client, {\n  tableName: \"y-dynamodb\", // optional, default is 'y-dynamodb'.\n});\n```\n\nYou can store document updates to DynamoDB as following:\n\n```ts\nimport * as Y from \"yjs\";\n\nconst ydoc = new Y.Doc();\nydoc.getArray(\"arr\").insert(0, [1, 2, 3]);\nconst update = Y.encodeStateAsUpdate(ydoc);\n\nawait persistence.storeUpdate(\"my-doc\", update);\n```\n\nYou can get the document from DynamoDB as following:\n\n```ts\nconst ydocPersisted = await persistence.getYDoc(\"my-doc\");\nydocPersisted.getArray(\"arr\").toArray(); // [1, 2, 3]\n```\n\n`y-dynamodb-for-sdkv3` is implemented for use in distributed systems such as aws Lambda.\nEven when multiple processes save updates to the same document, they do so without conflict.\n\n## Other APIs\n\n##### getStateVector()\n\n```ts\ngetStateVector(docName: string): Promise<Uint8Array>\n```\n\nThe state vector (describing the state of the persisted document - see\n[Yjs docs](https://github.com/yjs/yjs#Document-Updates)) is maintained in a separate\nfield and constantly updated.\n\nThis allows you to sync changes without actually creating a Yjs document.\n\n##### getDiff()\n\n```ts\ngetDiff(docName: string, stateVector: Uint8Array): Promise<Uint8Array>\n```\n\nGet the differences directly from the database. The same as\n`Y.encodeStateAsUpdate(ydoc, stateVector)`.\n\n##### clearDocument()\n\n```ts\nclearDocument(docName: string): Promise<void>\n```\n\nDelete a document, and all associated data from the database.\n\n##### flushDocument()\n\n```ts\nflushDocument(docName: string): Promise<void>\n```\n\nInternally y-dynamodb-for-sdkv3 stores incremental updates. You can merge all document\nupdates to a single entry. You probably never have to use this.\n\n## Improvements\n\n`y-dynamodb-for-sdkv3` has some improvements from `y-dynamodb`:\n\n- generate unique id without querying to database for conflict-free and improving performance\n- use string sort key for readable DynamoDB Table items\n- improve the `flushDocument()` procedure for conflict-free\n\n## License\n\ny-dynamodb-for-sdkv3 is licensed under the [MIT License](./LICENSE).\n","readmeFilename":"README.md"}