![\"JavaScript](\"https://img.shields.io/badge/code_style-standard-blue.svg?style=flat-square\"){kind=icon}
A Node.js wrapper for interacting with the Roblox DataStore API. \r\n\r\n## About\r\n\r\nNikita Petko and a few other friends alike created a NodeJS package that mocks the [Roblox DataStore System](https://developer.roblox.com/en-us/articles/Data-store) almost identically,\r\nintroducting calls and creations like the actual Lua DataStoreService\r\n\r\nWhat makes this especially interesting, is that everything you do is:\r\n\r\n- Strong/Inferred in typings (DataStore2 result can be a tuple of variant and DataStoreKeyInfo whereas GlobalDataStore result can be just a variant)\r\n- External usage identical to Lua with better syntax in your NodeJS applications.\r\n\r\n## An example of read world implementation\r\n\r\nSay you have a web server with [Express JS](https://www.npmjs.com/package/express), and you have a game that manages users with moderation etc.\r\n\r\nWith your web server you can query your users like you would via Roblox and get the results like you would on Roblox.\r\n\r\nThe example is as follows:\r\n\r\n### Roblox Game Server Code\r\n\r\n```lua\r\n-- Server script in ServerScriptService\r\n\r\nlocal PlayersService = game:GetService(\"Players\");\r\nlocal DataStoreService = game:GetService(\"DataStoreService\");\r\n\r\nlocal users = DataStoreService:GetDataStore(\"Users\", \"global\", nil); -- no options parameter here as AllScopes nor V2 API isn't needed.\r\nlocal usersResolutionTable = users:GetAsync(\"UsersResolution\") or {}; -- or {} in case it's nil\r\n\r\nPlayersService.PlayerAdded:Connect(function (remotePlayer)\r\n local playerDiscriminator = tostring(remotePlayer.UserId);\r\n\r\n -- dummy true here just for resolution\r\n -- create user if they do not exist already\r\n if (usersResolutionTable[playerDiscriminator] ~= true) then\r\n local data = { Name = remotePlayer.Name, ID = remotePlayer.UserId, Status = 0, Created = DateTime.now():ToISODate() };\r\n users:SetAsync(playerDiscriminator, data, nil, nil); -- no userIDs or DataStoreSetOptions because V2 API not enabled right now\r\n usersResolutionTable[playerDiscriminator] = true;\r\n users:UpdateAsync(\"UsersResolution\", function() return usersResolutionTable end); -- SetAsync would suffice here but we want to skip cache\r\n end\r\n local user = users:GetAsync(tostring(remotePlayer.UserId));\r\n\r\n if (user.Status == 1) then\r\n -- user is banned\r\n remotePlayer:Kick(\"You are banned\");\r\n return;\r\n end\r\n\r\n -- continue with further logic.\r\n\r\nend)\r\n```\r\n\r\n### Web Server Code\r\n\r\n```js\r\n// This code will query all the userIDs and try to resolve each user, the structure depends on the UsersResolution table to be a table or null of course\r\n\r\nconst app = require(\"express\")();\r\nconst {\r\nDataStoreService,\r\nInitializeAsync,\r\n} = require(\"@mfd/rbxdatastoreservice\");\r\n\r\n(async () => {\r\n await InitializeAsync(\"Security token for authentication purposes\", place id);\r\n\r\n const users = DataStoreService.GetDataStore(\"Users\", \"global\", undefined); // no options parameter here as AllScopes nor V2 API isn't needed.\r\n\r\n app.get(\"/v1/all-users\", async (request, response) => {\r\n const usersResolutionTable = (await users.GetAsync(\"UsersResolution\"])) || {}; // or {} in case it's nil\r\n\r\n let resultingUsers = [];\r\n\r\n for (const userID of Object.keys(usersResolutionTable)) {\r\n resultingUsers.push(await users.GetAsync(userID));\r\n }\r\n\r\n return response\r\n .status(200)\r\n .send({ count: resultingUsers.length, data: resultingUsers });\r\n\r\n });\r\n\r\n app.listen(8080);\r\n})();\r\n```\r\n\r\n## Installation\r\n\r\nWith node.js installed simply run:\r\n\r\n```sh\r\n# Run this to install RbxDataStoreService locally to your repository.\r\n$ npm install @mfd/rbxdatastoreservice --save\r\n$ yarn add @mfd/rbxdatastoreservice\r\n\r\n# Run this instead to install RbxDataStoreService globally so you can use it anywhere.\r\n$ npm install @mfd/rbxdatastoreservice -g\r\n$ yarn global add @mfd/rbxdatastoreservice\r\n```\r\n\r\nThat's it!\r\n\r\n## Documentation\r\n\r\nAs this framework mocks the [Roblox DataStore System](https://developer.roblox.com/en-us/articles/Data-store) identically, the documentation for this will almost be identical to the Lua documentation at:\r\n\r\n- [Roblox Developer Hub](https://developer.roblox.com/en-us/api-reference/class/DataStoreService)\r\n- [Anaminus's Documentation](https://robloxapi.github.io/ref/class/DataStoreService.html)\r\n\r\nIt is made this way to make it seem familiar to users moving, or users that use JavaScript and TypeScript\r\n\r\n### Initial setup\r\n\r\nBefore you can do anything you must initialize the global state with valid data.\r\nThe data you must give are:\r\n\r\n1. A valid .ROBLOSECURITY token that you can get from the brower or after an authentication check.\r\n2. A valid PlaceID for a place that you have edit permissions for.\r\n\r\nAt initialization these 2 arguments are validated via:\r\n\r\n1. Checking if the .ROBLOSECURITY token has a corresponding account.\r\n2. Checking if there is a place/asset with the give placeID.\r\n3. Checking if the authenticated user has sufficient permissions to access datastores for the place (edit permissions will suffice).\r\n\r\nWhen you are using the library, you will want to import the `InitializeAsync` method from the index file like this:\r\n\r\n```ts\r\nimport { InitializeAsync } from '@mfd/rbxdatastoreservice';\r\n```\r\n\r\nAnd you will use it like:\r\n\r\n```ts\r\nimport { InitializeAsync } from \"@mfd/rbxdatastoreservice\";\r\n\r\n(async () => {\r\n // This method is async, so you will want to use it in an async block, or you will want to bind to .then and .catch etc.\r\n await InitializeAsync(\"The .ROBLOSECURITY with the warning INCLUDED\", the place ID);\r\n})();\r\n```\r\n\r\nThe cookie cannot be:\r\n\r\n1. Empty\r\n2. null or undefined\r\n\r\nThe placeId cannot be:\r\n\r\n1. Null, NaN or undefined\r\n2. < 1\r\n\r\nYou will know the initialization succeeded if the method didn't throw during initialization, then you can start using the DataStoreService object you import.\r\n\r\n## Closing Words\r\n\r\nIf you want to contribute, please open a pull request via [here](https://github.com/nkpetko/RbxDataStoreService/pulls).\r\n\r\nIf you have any issues when using this library, please open an issue [here](https://github.com/nkpetko/RbxDataStoreService/issues).\r\n\r\nThank you and please enjoy!\r\n\r\n\r\n## License\r\n[](https://app.fossa.com/projects/git%2Bgithub.com%2Fnkpetko%2FRbxDataStoreService?ref=badge_large)\r\n","readmeFilename":"README.md","description":"RbxDataStoreService is a module that allows you to access roblox datastores from your Node.js applications.","author":{"name":"Nikita Petko","email":"petko@mfdlabs.com","url":"https://github.com/nkpetko"},"homepage":"https://github.com/nkpetko/RbxDataStoreService#readme","repository":{"type":"git","url":"git+https://github.com/nkpetko/RbxDataStoreService.git"},"bugs":{"url":"https://github.com/nkpetko/RbxDataStoreService/issues"}}
![\"Production](\"https://github.com/nkpetko/RbxDataStoreService/actions/workflows/security-analysis-windows.yml/badge.svg?branch=master\"){kind=icon}
![\"Production](\"https://github.com/nkpetko/RbxDataStoreService/actions/workflows/security-analysis-linux.yml/badge.svg?branch=master\"){kind=icon}
![\"Production](\"https://github.com/nkpetko/RbxDataStoreService/actions/workflows/security-analysis-mac-os.yml/badge.svg?branch=master\"){kind=icon}
![\"Production](\"https://github.com/nkpetko/RbxDataStoreService/actions/workflows/build-windows.yml/badge.svg?branch=master\"){kind=icon}
![\"Production](\"https://github.com/nkpetko/RbxDataStoreService/actions/workflows/build-linux.yml/badge.svg?branch=master\"){kind=icon}
![\"Production](\"https://github.com/nkpetko/RbxDataStoreService/actions/workflows/build-mac-os.yml/badge.svg?branch=master\"){kind=icon}
![](\"https://app.fossa.com/api/projects/git%2Bgithub.com%2Fnkpetko%2FRbxDataStoreService.svg?type=shield\"/)