fixed issues with cloud group api and csrf tokens

Author: cameronpcampbell

.gitignore

@@ -176,4 +176,6 @@ dist
 # Finder (MacOS) folder config
 .DS_Store
 
-docs_site/
+docs_site/
+
+/graph.png

build.ts

@@ -1,7 +1,10 @@
 import * as esbuild from 'esbuild';
+import { globby } from 'globby';
+
+const entryPoints = await globby(['src/**/*.{js,ts}']);
 
 const settings = {
-  entryPoints: ["src/**/*"],
+  entryPoints,
   outdir: "dist",
   //minify: true,
   //keepNames: true,

bun.lockb

@@ -2,7 +2,7 @@
   "name": "openblox",
   "description": "Roblox API Wrapper For Both Classic And OpenCloud APIs.",
   "type": "commonjs",
-  "version": "1.0.59",
+  "version": "1.0.60",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/MightyPart/openblox/issues"
@@ -95,12 +95,13 @@
   "devDependencies": {
     "@types/lodash": "^4.17.0",
     "@types/node": "^22.1.0",
-    "esbuild": "^0.21.5",
+    "delete-cli": "^0.1.3",
+    "esbuild": "^0.25.3",
+    "globby": "^14.1.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-morph": "^22.0.0"
   },
   "peerDependencies": {
     "typescript": "^5.0.0",
@@ -109,6 +110,10 @@
   "scripts": {
     "build:code": "delete dist && bun run ./build.ts && tsc --emitDeclarationOnly",
     "build:docs": "bun run ./docs/buildDocs.ts",
+    "graph": "madge --image graph.png ./src/**/*",
+    "graph:circular": "madge --image graph.png --circular ./src/**/*",
+    "graph:dist": "madge --image graph.png ./dist/**/*",
+    "graph:dist:circular": "madge --image graph.png --circular ./dist/**/*",
     "build": "bun run build:docs && bun run build:code"
   }
 }

package.json

@@ -1,5 +1,5 @@
 // [ Modules ] ///////////////////////////////////////////////////////////////////
-import { config } from "../../config";
+import { defaultOpenbloxConfig, OpenbloxConfig } from "../../config";
 import { HttpHandler, isOpenCloudUrl } from "../../http/httpHandler";
 import { isObject, objectToFieldMask } from "../../utils/utils";
 import { HttpResponse } from "../../http/http.utils";
@@ -68,7 +68,7 @@ const isCursorEmpty = (cursor: Cursor) => (!cursor || (typeof cursor == "string"
 const paginate = (
   initialResponse: ApiMethodResponse,
   callApiMethod: CallApiMethod<any, any, true>,
-  args: Record<any, any>, overrides: any,
+  args: Record<any, any>, config: any,
   handlerFnCursorArg: "cursor" | "startRowIndex" | "pageNumber"
 ) => (
   async function* () {
@@ -79,7 +79,7 @@ const paginate = (
     if (isCursorEmpty(nextCursor)) return
 
     while (true) {
-      const newValue = await callApiMethod.call(overrides, { ...args, [handlerFnCursorArg]: nextCursor })
+      const newValue = await callApiMethod.call(config, { ...args, [handlerFnCursorArg]: nextCursor })
       if (isNoMoreData(newValue.data)) return
       yield newValue
 
@@ -89,7 +89,7 @@ const paginate = (
   }
 )
 
-const pollForResponse = async (url: string, operationPath: string, cloudKey: string) => {
+const pollForResponse = async (config: OpenbloxConfig, url: string, operationPath: string, cloudKey: string) => {
   const operationPrefix = operationPath.match(/^(\/?)cloud\/v[1-9]+(\/?)/)
     ? operationPrefixRegexWithoutVersion.exec(url)?.[1] as UrlSecure
     : operationPrefixRegexWithVersion.exec(url)?.[1] as UrlSecure
@@ -121,11 +121,11 @@ export const createApiGroup: CreateApiGroupFn = ({ name:groupName, baseUrl, defa
 
     const thisDefaultGetCursors = groupDefaultGetCursors ?? defaultGetCursors
 
-    const createCallApiMethod = (_baseUrl: UrlSecure = baseUrl): CallApiMethod<any, any, boolean> => async function(args) {
-      const overrides = this
-      const cookie = overrides?.cookie || config?.cookie
-      const cloudKey =  overrides?.cloudKey || config?.cloudKey
-      const oauthToken = overrides?.oauthToken
+    const createCallApiMethod = (_baseUrl: UrlSecure = baseUrl): CallApiMethod<any, any, boolean> => async function (args) {
+      const config = this || defaultOpenbloxConfig
+      const cookie = config?.cookie
+      const cloudKey = config?.cloudKey
+      const oauthToken = config?.oauthToken
 
       const handlerFnData = await handlerFn(args as any)
       let { path, method, searchParams, applyFieldMask, body, formData, headers, getCursorsFn, pathToPoll, name } = handlerFnData
@@ -147,29 +147,37 @@ export const createApiGroup: CreateApiGroupFn = ({ name:groupName, baseUrl, defa
 
       let main: () => Promise<any>
       main = async () => {
-        let response: HttpResponse = await HttpHandler({ method, url, body, formData, headers }) as any // TODO
+        let response: HttpResponse = await HttpHandler(config, { method, url, body, formData, headers }) as any // TODO
         if (!(response instanceof HttpResponse)) throw response
         let rawData = response.body
 
         // Uncompleted long running operation.
         let opPath = rawData?.path
         if (opPath && rawData?.done === false && isOpenCloudUrl(url)) {
           console.warn(`Polling '${groupName}.${name}' (Please be patient)...`)
-          response = await pollForResponse(url, pathToPoll ? pathToPoll(rawData) : opPath, cloudKey)
+          response = await pollForResponse(config, url, pathToPoll ? pathToPoll(rawData) : opPath, cloudKey)
           rawData = response.body
         }
 
+        let cachedData: any
+
         let apiMethodResult: ApiMethodResponse<any, any> = formatRawDataFn
-          ? { response, again: main, get data() { return formatRawDataFn(rawData, response) } }
-          : { response, again: main, data: rawData }
+          ? { response, again: main, get data() {
+            if (cachedData) return cachedData
+            else {
+              cachedData = formatRawDataFn(rawData, response)
+              return cachedData
+            }
+          }, configUsed: config }
+          : { response, again: main, data: rawData, configUsed: config }
 
         // Applies async iterator if method is paginated.
         if (handlerFnCursorArg) {
           let [ previousCursor, nextCursor ] = (getCursorsFn ?? thisDefaultGetCursors)(rawData);
           apiMethodResult.cursors = { previous: previousCursor, next: nextCursor }
           if (args && !("__notRoot" in args)) {
             (apiMethodResult as any as ApiMethodResponse<any, any, true>)[Symbol.asyncIterator] = paginate(
-              apiMethodResult, callApiMethod as CallApiMethod<any, any, true>, args as Record<any, any>, overrides, handlerFnCursorArg
+              apiMethodResult, callApiMethod as CallApiMethod<any, any, true>, args as Record<any, any>, config, handlerFnCursorArg
             ) as any
           }
         }
@@ -180,7 +188,7 @@ export const createApiGroup: CreateApiGroupFn = ({ name:groupName, baseUrl, defa
       return await main()
     }
 
-    const callApiMethod = createCallApiMethod();
+    const callApiMethod = createCallApiMethod().bind(undefined);
 
     // To handle legacy open cloud endpoints which use classic endpoints but with different base urls.
     (callApiMethod as any)._deriveWithDifferentBaseUrl = (baseUrl: UrlSecure) => createCallApiMethod(baseUrl)

src/apis/apiGroup/apiGroup.ts

@@ -1,6 +1,7 @@
 import type { ObjectPrettify, Prettify, StringIsLiteral } from "typeforge"
 import type { RestMethod } from "../../utils/utils.types"
 import type { HttpResponse, RobloxCookie } from "../../http/http.utils"
+import { OpenbloxConfig } from "../../config"
 
 
 // Create Api Group Types ---------------------------------------------------------------------------------------------
@@ -113,7 +114,8 @@ export type ApiMethodResponse<
 type ApiMethodResponse_WithoutPagination<RawData = any, PrettifiedData = any> = ObjectPrettify<
   {
     data: PrettifiedData,
-    response: ObjectPrettify<HttpResponse<RawData>>
+    response: ObjectPrettify<HttpResponse<RawData>>,
+    configUsed: OpenbloxConfig,
   }
 >
 

src/apis/apiGroup/apiGroup.types.ts

@@ -185,7 +185,7 @@ export const userInfo = createApiMethod(async  <UserId extends Identifier>(
  * @exampleData { id: 45348281, name: "MightyPart", displayName: "MightyPart" }
  * @exampleRawBody { id: 45348281, name: "MightyPart", displayName: "MightyPart" }
  */
-export const authenticatedUserInfo = createApiMethod(async  (
+export const authenticatedUserInfo = createApiMethod(async (
 ): ApiMethod<AuthenticatedUserInfoData> => ({
   path: `/v1/users/authenticated`,
   method: "GET",

src/apis/classic/users/users.ts

@@ -30,7 +30,7 @@ const formatGroupMembersFilters = (groupId: Identifier | "-", filter: GroupMembe
 
     else {
       const roleIdFilter = (filter as unknown as GroupMembers_Filter)?.roleId
-      if (roleIdFilter) formattedFilter = `group == 'groups/${groupId}/roles/${roleIdFilter}'`
+      if (roleIdFilter) formattedFilter = `role == 'groups/${groupId}/roles/${roleIdFilter}'`
     }
   }
 
@@ -88,11 +88,17 @@ export const groupMembers = createApiMethod(async <
       : "userId" extends keyof Filter
         ? Filter["userId"] extends Identifier ? Filter["userId"] : Identifier
         : Identifier
+  ),
+
+  const RoleId extends Identifier = (
+      "roleId" extends keyof Filter
+        ? Filter["roleId"] extends Identifier ? Filter["roleId"] : Identifier
+        : Identifier
   )
 >(
   { groupId, limit, filter, cursor }
   : { groupId: GroupId, limit?: UserId, filter?: Filter, cursor?: string }
-): ApiMethod<RawGroupMembersData<GroupId, UserId>, PrettifiedGroupMembersData<GroupId, UserId>> => ({
+): ApiMethod<RawGroupMembersData<GroupId, UserId>, PrettifiedGroupMembersData<GroupId, UserId, RoleId>> => ({
   path: `/v2/groups/${groupId}/memberships`,
   method: "GET",
   searchParams: {

src/apis/cloud/groups/groups.ts

@@ -47,20 +47,29 @@ export type GroupMembers_Filter = ObjectEither<
 
 export type GroupMembers_WildcardFilter = ObjectPrettify<{ userIds: Identifier[] }>
 
-type GroupMember<GroupId extends Identifier | "-", TemporalType, UserId extends Identifier = Identifier> = ObjectPrettify<{
+type GroupMember<
+  GroupId extends Identifier | "-",
+  TemporalType,
+  UserId extends Identifier = Identifier,
+  RoleId extends Identifier = Identifier,
+> = ObjectPrettify<{
   path: `groups/${GroupId extends "-" ? Identifier : GroupId}/memberships/${string}`,
   createTime: TemporalType,
   updateTime: TemporalType,
   user: `users/${UserId}`,
-  role: `groups/${GroupId extends "-" ? Identifier : GroupId}/roles/${string}`
+  role: `groups/${GroupId extends "-" ? Identifier : GroupId}/roles/${RoleId}`
 }>
 
 export type RawGroupMembersData<GroupId extends Identifier | "-", UserId extends Identifier = Identifier> = ObjectPrettify<{
   groupMemberships: GroupMember<GroupId, ISODateTime, UserId>[],
   nextPageToken: string
 }>
 
-export type PrettifiedGroupMembersData<GroupId extends Identifier | "-", UserId extends Identifier = Identifier> = GroupMember<GroupId, Date, UserId>[]
+export type PrettifiedGroupMembersData<
+  GroupId extends Identifier | "-",
+  UserId extends Identifier = Identifier,
+  RoleId extends Identifier = Identifier,
+> = GroupMember<GroupId, Date, UserId, RoleId>[]
 // -------------------------------------------------------------------------------------------------------------------
 
 

src/apis/cloud/groups/groups.types.ts

@@ -1,91 +1,67 @@
 // [ Modules ] ///////////////////////////////////////////////////////////////////
-import { isObject } from "lodash"
-
-import { mergeDeep } from "../utils/utils"
 import { TtlCacheAdapter } from "../cache/cacheAdapters"
+import { RobloxCookie } from "../http/http.utils"
 //////////////////////////////////////////////////////////////////////////////////
 
 
 // [ Types ] /////////////////////////////////////////////////////////////////////
 import type { HttpAdapter } from "../http/httpAdapters"
 import type { CacheAdapter } from "../cache/cacheAdapters/cacheAdapters"
-import type { RobloxCookie } from "../http/http.utils"
-
-export type OpenbloxConfig = {
-  cookie?: RobloxCookie,
-  cloudKey?: string,
-
-  http?: {
-    adapter?: HttpAdapter,
-    csrfMaxAttempts?: number,
-
-    polling?: {
-      disabled?: boolean,
-      iterations?: number,
-      multiplyer?: number,
-      retryOffset?: number,
-      debugMessages?: boolean
+import type { ObjectPrettify } from "typeforge"
+
+export type OpenbloxConfig<Cookie = FormattedRobloxCookie> = ObjectPrettify<{
+    cookie?: Cookie,
+    cloudKey?: string,
+
+    http?: {
+        adapter?: HttpAdapter,
+        csrfMaxAttempts?: number,
+        csrfToken?: string,
+
+        polling?: {
+            disabled?: boolean,
+            iterations?: number,
+            multiplyer?: number,
+            retryOffset?: number,
+            debugMessages?: boolean
+        }
     },
-  },
 
-  cache?: ReturnType<CacheAdapter<any, any>>[]
-}
+    cache?: ReturnType<CacheAdapter<any, any>>[]
+}>
 //////////////////////////////////////////////////////////////////////////////////
 
 
+const formatRobloxCookie = (cookie: string) => `.ROBLOSECURITY=${cookie}; RBXEventTrackerV2=CreateDate=1/1/1 1:1:1 PM&rbxid=1&browserid=1;` as FormattedRobloxCookie & { _phantom_isValid: true }
+
 // [ Variables ] /////////////////////////////////////////////////////////////////
 const initialCookie = process.env.ROBLOX_COOKIE
 
-export const config: OpenbloxConfig = {
-  cookie: (initialCookie && `.ROBLOSECURITY=${initialCookie}; RBXEventTrackerV2=CreateDate=1/1/1 1:1:1 PM&rbxid=1&browserid=1;`) as any as RobloxCookie | undefined,
-  cloudKey: process.env.ROBLOX_CLOUD_KEY,
+export const defaultOpenbloxConfig: OpenbloxConfig = {
+    cookie: initialCookie ? formatRobloxCookie(initialCookie) : undefined,
+    cloudKey: process.env.ROBLOX_CLOUD_KEY,
 
-  cache: [ TtlCacheAdapter({ included: { lifetime: 300 } }) ]
+    cache: [ TtlCacheAdapter({ included: { lifetime: 300 } }) ],
+    
+    http: {}
 };
 //////////////////////////////////////////////////////////////////////////////////
 
 
-// [ Private Functions ] /////////////////////////////////////////////////////////
-/**
- * Deep merge two configs.
- * @param target
- * @param ...sources
- */
-function mergeDeepConfigs(target: Record<any, any>, ...sources: Record<any, any>[]) {
-  if (!sources.length) return target;
-  const source = sources.shift();
-
-  if (isObject(target) && isObject(source)) {
-    for (const key in source) {
-      if (isObject(source[key])) {
-        if (!target[key]) Object.assign(target, { [key]: {} });
-        if (key == "cache") {
-          Object.assign(target[key], source[key])
-        } else {
-          mergeDeep(target[key], source[key]);
-        }
-      } else {
-        Object.assign(target, { [key]: source[key] });
-      }
-    }
-  }
+export type FormattedRobloxCookie = `.ROBLOSECURITY=${RobloxCookie}; RBXEventTrackerV2=CreateDate=1/1/1 1:1:1 PM&rbxid=1&browserid=1;`
 
-  return mergeDeep(target, ...sources);
+export const setDefaultOpenbloxConfig = (newConfig: OpenbloxConfig & { _phantom_isValid: true }) => {
+    for (var key in defaultOpenbloxConfig) { delete defaultOpenbloxConfig[key as keyof OpenbloxConfig] }
+    Object.assign(defaultOpenbloxConfig, newConfig)
 }
-//////////////////////////////////////////////////////////////////////////////////
 
+export const createOpenbloxConfig = (newConfig: OpenbloxConfig<RobloxCookie>) => {
+    if (!newConfig?.http) newConfig.http = {} 
 
-export const setConfig = (newConfig: OpenbloxConfig) => {
-  const newConfigCookie = newConfig?.cookie
-  if (newConfigCookie) newConfig.cookie = `.ROBLOSECURITY=${newConfigCookie}; RBXEventTrackerV2=CreateDate=1/1/1 1:1:1 PM&rbxid=1&browserid=1;` as any
-
-  Object.keys(config).forEach(key => delete config[key as keyof OpenbloxConfig])
-  Object.assign(config, newConfig)
-}
+    const newConfigCookie = newConfig?.cookie
+    if (newConfigCookie) newConfig.cookie = formatRobloxCookie(newConfigCookie) as any
 
-export const updateConfig = (updateConfigWith: OpenbloxConfig) => {
-  const updateConfigWithCookie = updateConfigWith?.cookie
-  if (updateConfigWithCookie) updateConfigWith.cookie = `.ROBLOSECURITY=${updateConfigWithCookie}; RBXEventTrackerV2=CreateDate=1/1/1 1:1:1 PM&rbxid=1&browserid=1;` as any
+    console.log("-->", newConfig)
 
-  mergeDeepConfigs(config, updateConfigWith)
+    return newConfig as OpenbloxConfig & { _phantom_isValid: true }
 }