Fixes .ROBLOSECURITY= requirement when binding cookies

.npmignore

@@ -1,10 +1,12 @@
 ._*
 src/
+tests/
 buildDocs/
 docs/
 docs_site/
 node_modules/
 ./assets/
 bun.lockb
 tsconfig.tsbuildinfo
-./build.ts
+./build.ts
+.env

jest.config.js

@@ -0,0 +1,8 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} **/
+module.exports = {
+  testEnvironment: "node",
+  setupFilesAfterEnv: ['dotenv/config'],
+  transform: {
+    "^.+.tsx?$": ["ts-jest", {}],
+  },
+};

package.json

@@ -93,14 +93,18 @@
     "parse-roblox-errors": "^1.1.10"
   },
   "devDependencies": {
+    "@types/jest": "^29.5.14",
     "@types/lodash": "^4.17.0",
     "@types/node": "^22.1.0",
+    "delete-cli": "^0.1.3",
+    "dotenv": "^16.4.7",
     "esbuild": "^0.21.5",
+    "jest": "^29.7.0",
     "prettier": "^3.2.5",
     "tablemark": "^3.1.0",
     "ts-arithmetic": "^0.1.1",
-    "ts-morph": "^22.0.0",
-    "delete-cli": "^0.1.3"
+    "ts-jest": "^29.2.5",
+    "ts-morph": "^22.0.0"
   },
   "peerDependencies": {
     "typescript": "^5.0.0",
@@ -109,6 +113,7 @@
   "scripts": {
     "build:code": "delete dist && bun run ./build.ts && tsc --emitDeclarationOnly",
     "build:docs": "bun run ./docs/buildDocs.ts",
-    "build": "bun run build:docs && bun run build:code"
+    "build": "bun run build:docs && bun run build:code",
+    "test": "bunx jest"
   }
 }

src/apis/apiGroup/apiGroup.ts

@@ -123,7 +123,7 @@ export const createApiGroup: CreateApiGroupFn = ({ name:groupName, baseUrl, defa
 
     const createCallApiMethod = (_baseUrl: UrlSecure = baseUrl): CallApiMethod<any, any, boolean> => async function(args) {
       const overrides = this
-      const cookie = overrides?.cookie || config?.cookie
+      const cookie = overrides?.cookie ? `.ROBLOSECURITY=${overrides.cookie}` : config?.cookie;
       const cloudKey =  overrides?.cloudKey || config?.cloudKey
       const oauthToken = overrides?.oauthToken
 

src/apis/classic/badges/index.ts

@@ -1 +1,2 @@
-export * from "./badges"
+export * from "./badges"
+export * from "./badges.types"

src/apis/classic/catalog/index.ts

@@ -1 +1,2 @@
-export * from "./catalog"
+export * from "./catalog"
+export * from "./catalog.types"

src/apis/classic/develop/index.ts

@@ -1 +1,2 @@
-export * from "./develop"
+export * from "./develop"
+export * from "./develop.types"

src/apis/classic/developerProducts/index.ts

@@ -1 +1,2 @@
-export * from "./developerProducts"
+export * from "./developerProducts"
+export * from "./developerProducts.types"

src/apis/classic/economy/index.ts

@@ -1 +1,2 @@
-export * from "./economy"
+export * from "./economy"
+export * from "./economy.types"

src/apis/classic/friends/index.ts

@@ -1 +1,2 @@
-export * from "./friends"
+export * from "./friends"
+export * from "./friends.types"

src/apis/classic/gamePasses/index.ts

@@ -1 +1,2 @@
-export * from "./gamePasses"
+export * from "./gamePasses"
+export * from "./gamePasses.types"

src/apis/classic/games/index.ts

@@ -1 +1,2 @@
-export * from "./games"
+export * from "./games"
+export * from "./games.types"

src/apis/classic/groups/index.ts

@@ -1 +1,2 @@
-export * from "./groups"
+export * from "./groups"
+export * from "./groups.types"

src/apis/classic/organizations/index.ts

@@ -1 +1,2 @@
-export * from "./organizations"
+export * from "./organizations"
+export * from "./organizations.types"

src/apis/classic/premiumFeatures/index.ts

@@ -1 +1,2 @@
-export * from "./premiumFeatures"
+export * from "./premiumFeatures"
+export * from "./premiumFeatures.types"

src/apis/classic/shareLinks/index.ts

@@ -1 +1,2 @@
-export * from "./shareLinks"
+export * from "./shareLinks"
+export * from "./shareLinks.types"

src/apis/classic/subscriptions/index.ts

@@ -1 +1,2 @@
-export * from "./subscriptions"
+export * from "./subscriptions"
+export * from "./subscriptions.types"

src/apis/classic/talent/index.ts

@@ -1 +1,2 @@
-export * from "./talent"
+export * from "./talent"
+export * from "./talent.types"

src/apis/classic/thumbnails/index.ts

@@ -1 +1,2 @@
-export * from "./thumbnails"
+export * from "./thumbnails"
+export * from "./thumbnails.types"

src/apis/classic/users/index.ts

@@ -1 +1,2 @@
-export * from "./users"
+export * from "./users"
+export * from "./users.types"

src/apis/classic/virtualEvents/index.ts

@@ -1 +1,2 @@
-export * from "./virtualEvents"
+export * from "./virtualEvents"
+export * from "./virtualEvents.types"

src/apis/cloud/assets/index.ts

@@ -1 +1,2 @@
-export * from "./assets"
+export * from "./assets"
+export * from "./assets.types"

src/apis/cloud/creatorStore/index.ts

@@ -1 +1,2 @@
-export * from "./creatorStore"
+export * from "./creatorStore"
+export * from "./creatorStore.types"

src/apis/cloud/engine/index.ts

@@ -1 +1,2 @@
-export * from "./engine"
+export * from "./engine"
+export * from "./engine.types"

src/apis/cloud/experiences/index.ts

@@ -1 +1,2 @@
-export * from "./experiences"
+export * from "./experiences"
+export * from "./experiences.types"

src/apis/cloud/groups/index.ts

@@ -1 +1,2 @@
-export * from "./groups"
+export * from "./groups"
+export * from "./groups.types"

src/apis/cloud/inventory/index.ts

@@ -1 +1,2 @@
-export * from "./inventory"
+export * from "./inventory"
+export * from "./inventory.types"

src/apis/cloud/legacyFollowings/index.ts

@@ -1 +1,2 @@
-export * from "./legacyFollowings"
+export * from "./legacyFollowings"
+export * from "./legacyFollowings.types"

src/apis/cloud/luauExecution/index.ts

@@ -1 +1,2 @@
-export * from "./luauExecution"
+export * from "./luauExecution"
+export * from "./luauExecution.types"

src/apis/cloud/memoryStores/index.ts

@@ -1 +1,2 @@
-export * from "./memoryStores"
+export * from "./memoryStores"
+export * from "./memoryStores.types"

src/apis/cloud/oauth/index.ts

@@ -1 +1,2 @@
-export * from "./oauth"
+export * from "./oauth"
+export * from "./oauth.types"

src/apis/cloud/orderedDataStores_V1/index.ts

@@ -1,2 +1,2 @@
 export * from "./orderedDataStores_V1"
-
+export * from "./orderedDataStores_V1.types"

src/apis/cloud/orderedDataStores_V2/index.ts

@@ -1 +1,2 @@
-export * from "./orderedDataStores_V2"
+export * from "./orderedDataStores_V2"
+export * from "./orderedDataStores_V2.types"

src/apis/cloud/standardDataStores_V1/index.ts

@@ -1,2 +1,2 @@
 export * from "./standardDataStores_V1"
-
+export * from "./standardDataStores_V1.types"

src/apis/cloud/standardDataStores_V2/index.ts

@@ -1 +1,2 @@
-export * from "./standardDataStores_V2"
+export * from "./standardDataStores_V2"
+export * from "./standardDataStores_V2.types"

src/apis/cloud/subscriptions/index.ts

@@ -1 +1,2 @@
-export * from "./subscriptions"
+export * from "./subscriptions"
+export * from "./subscriptions.types"

src/apis/cloud/userRestrictions/index.ts

@@ -1 +1,2 @@
-export * from "./userRestrictions"
+export * from "./userRestrictions"
+export * from "./userRestrictions.types"

src/apis/cloud/users/index.ts

@@ -1 +1,2 @@
-export * from "./users"
+export * from "./users"
+export * from "./users.types"

src/http/http.utils.ts

@@ -56,11 +56,14 @@ export class HttpResponse<Body extends any = any> {
 }
 
 export class HttpError {
+  name = "OpenBlox HttpError"
+  // message: string
   type: "Csrf" | "Generic"
   errors: AnyRobloxError[]
   response: HttpResponse
 
   constructor(type: "Csrf" | "Generic", response: HttpResponse, errors: AnyRobloxError[]) {
+    // this.message = `A ${type} HttpError occurred when making a request to: ${response.url.toString()}`
     this.type = type
     this.errors = errors
     this.response = response

src/http/httpHandler/httpHandler.ts

@@ -122,7 +122,8 @@ export const HttpHandler = async <RawData extends any = any>(
 
       } else {
         // Only Changes the saved csrf token to be that of the response csrf token if the cookie used was not an override.
-        if (headerCookie == config?.cookie) savedCsrfToken = responseCsrfToken
+        // Well, we do want to allow overrides
+        /* if (headerCookie == config?.cookie)  */savedCsrfToken = responseCsrfToken
 
         // retries the request with the new csrf token.
         currentCsrfAttempt++

src/index.ts

@@ -0,0 +1,2 @@
+export * as ClassicAPI from "./apis/classic/index"
+export * as CloudAPI from "./apis/cloud/index"

tests/auth.test.ts

@@ -0,0 +1,40 @@
+import * as OpenBlox from "../src/index";
+
+// Set a ROBLOX_COOKIE environment variable to test authenticated requests.
+// Replace parameters with valid objects that your account has access to.
+
+describe('OpenBlox Cookie Auth', () => {
+  it('should use .env as default', async () => {
+    const result = await OpenBlox.ClassicAPI.ClassicUsersApi.authenticatedUserInfo();
+    expect(result.response.success).toBe(true);
+  });
+
+  it('should use context binded cookie', async () => {
+    const cookie = process.env.ROBLOX_COOKIE;
+    process.env.ROBLOX_COOKIE = undefined;
+
+    const result = await OpenBlox.ClassicAPI.ClassicUsersApi.authenticatedUserInfo.bind({ cookie })();
+    expect(result.response.success).toBe(true);
+
+    // Restores original state for other tests.
+    process.env.ROBLOX_COOKIE = cookie;
+  });
+
+  it('should use a csrf validated request', async () => {
+    const result = await OpenBlox.ClassicAPI.ClassicGroupsApi.updateGroupMemberRole({ groupId: 101010, roleId: 101010, userId: 101010 });
+    expect(result.response.success).toBe(true);
+  });
+
+  it('should use a csrf validated request using context binded cookie', async () => {
+    const cookie = process.env.ROBLOX_COOKIE;
+    process.env.ROBLOX_COOKIE = undefined;
+
+    const result = await OpenBlox.ClassicAPI.ClassicGroupsApi.updateGroupMemberRole.bind({ cookie })({ groupId: 101010, roleId: 101010, userId: 101010 });
+    expect(result.response.success).toBe(true);
+
+    // Restores original state for other tests.
+    process.env.ROBLOX_COOKIE = cookie;
+  });
+
+  test.todo("open cloud auth");
+});

tsconfig.json

@@ -24,6 +24,7 @@
     "module": "NodeNext",
     "moduleResolution": "NodeNext",
 
+    "types": ["jest", "node"],
     "typeRoots": [ "./node_modules/@types" ]
   },
   "include": [ "./src" ],