@rbxts/zyntex-sdk 1.0.0

package/src/api.luau

@@ -0,0 +1,160 @@
+--!strict
+local HttpService: HttpService = game:GetService("HttpService")
+
+local jobId = if game:GetService("RunService"):IsStudio() then `DEV-SERVER-{HttpService:GenerateGUID(false)}` else game.JobId
+
+local Session = {}
+Session.__index = Session
+
+--[[
+	The Zyntex Session type. Used for API requests.
+]]--
+export type SessionType = {
+	--[[
+		Represents the root API url. i.e.: https://api.zyntex.dev
+	]]--
+	rootUrl: string;
+	--[[
+		The game-token. Used whenever linking.
+	]]--
+	gameToken: string;
+	--[[
+		The server's Job ID
+	]]
+	jobID: string;
+}
+
+local Response = {}
+Response.__index = Response
+
+--[[
+	The Zyntex Response type. Used for the response of a API request.
+]]--
+export type ResponseType = {
+	--[[
+		Wether or not the status code of the response was 200-299 AND data.success == true.
+	]]--
+	success: boolean;
+	--[[
+		The user message returned by the API
+	]]--
+	user_message: string;
+	--[[
+		The data that the API responded with.
+	]]--
+	data: any;
+	--[[
+		The status code of the HTTP request
+	]]
+	statusCode: number;
+}
+
+export type Session  = typeof(setmetatable({} :: SessionType, Session))
+export type Response = typeof(setmetatable({} :: ResponseType, Response))
+
+--[[
+	Construct a new Response using decoded data
+]]
+function Response.new(success: boolean, user_message: string, statusCode: number, data: any?): Response
+	local self = {}
+	self.success = success
+	self.user_message = user_message
+	self.data = data
+	self.statusCode = statusCode
+	
+	return setmetatable(self, Response)
+end
+
+--[[
+	Construct a new Response using raw JSON data
+]]
+function Response.fromRaw(res: {["Body"]: string, [string]: any}, statusCode: number): Response
+	local self = {}
+
+	local JSONDecoded = HttpService:JSONDecode(res["Body"])
+	self.success = JSONDecoded.success :: boolean
+	self.user_message = JSONDecoded.user_message :: string
+
+	local data = JSONDecoded.data
+	if data then
+		self.data = data
+	end
+	
+	self.statusCode = statusCode
+
+	return setmetatable(self, Response)
+end
+
+	
+--[[
+	Send an HTTP Request to the Zyntex API
+]]
+function Session.request(self: Session, endpoint: string, method: string, body: {[string]: any}?, autoError: boolean?): Response
+	local success, data: Response = pcall(function()
+		local res = HttpService:RequestAsync(
+			{
+				["Url"]     = `{self.rootUrl}{endpoint}`;
+				["Method"]  = string.upper(method);
+				["Body"]    = if body then HttpService:JSONEncode(body) else nil;
+				["Headers"] = {
+					["Authorization"] = `Game-Token {self.gameToken}`,
+					["Job-ID"] = jobId,
+					["Content-Type"] = "application/json"
+				} 
+			}
+		)
+				
+		return Response.fromRaw(res, res.StatusCode)
+	end)
+	
+	if autoError == nil then
+		autoError = true
+	end
+	
+	if success then
+		return data
+	end
+	
+	if autoError then
+		error(`HTTP Request to {endpoint} failed, "{data}"`)
+		return data
+	end
+	
+	return data
+end
+
+--[[
+	Shorthand for Session:request(endpoint, 'GET')
+]]
+function Session.get(self: Session, endpoint: string, autoError: boolean?): Response
+	return self:request(endpoint, "GET", nil, autoError)
+end
+
+--[[
+	Shorthand for Session:request(endpoint, 'POST', body)
+]]
+function Session.post(self: Session, endpoint: string, body: {string: any}?, autoError: boolean?): Response
+	return self:request(endpoint, "POST", body, autoError)
+end
+
+--[[
+	Shorthand for Session:request(endpoint, 'DELETE', body)
+]]
+function Session.delete(self: Session, endpoint: string, body: {string: any}?, autoError: boolean?): Response
+	return self:request(endpoint, "DELETE", body, autoError)
+end
+	
+--[[
+	Construct a new Session
+]]
+function Session.new(gameToken: string, rootUrl: string?, link: boolean?)
+	local self = {}
+	self.gameToken = gameToken
+	self.rootUrl = if rootUrl then rootUrl else "https://api.zyntex.dev"
+	self.jobID = HttpService:GenerateGUID(false)
+	
+	return setmetatable(self, Session)
+end
+
+	
+return Session

package/src/index.d.ts

@@ -0,0 +1,69 @@
+// types/zyntex.d.ts
+interface ZyntexConfig {}
+
+interface Invocation {
+    id: string;
+    event_id: string;
+    data: unknown;
+    to: string;
+    sender: string;
+    from_server: string
+    invoked_at: number;
+    to_server: string;
+    game_id: string;
+    invoked_by: string;
+}
+interface ZyntexEvent {
+    Connect(callback: (invocation: Invocation)=>void): void
+}
+interface Zyntex {
+    /*
+    	@method Zyntex:init
+	@description The main entry point to start the Zyntex client. This function initializes all core processes:
+	it registers the server with the Zyntex backend, starts the status update and polling loops,
+	sets up event listeners, and connects player tracking signals.
+
+	@param self Zyntex
+	@param config TYPES.Config -- A configuration table that controls client behavior (e.g., `debug`, `simulate`).
+     */
+    init(config: ZyntexConfig): void;
+
+    /*
+	@method Event:Connect
+	@description Establishes a listener for this specific event. The provided callback function
+	will be executed whenever an invocation for this event is received from the Zyntex backend (e.g., sent from the dashboard).
+
+	@param self Event -- The event object to listen to.
+	@param listener (({[string]: any}, Invocation) -> nil) -- The callback function to execute.
+		- The first argument passed to the listener is a simplified data table: `{["key"] = value}`.
+		- The second argument is the full, raw Invocation object.
+
+	@example
+	local broadcastEvent = Zyntex:GetEvent("BroadcastMessage")
+	broadcastEvent:Connect(function(data, invocation)
+		print(`Received broadcast from user {invocation.invokedBy}: {data.Message}`)
+	end)
+     */
+    GetEvent(name: string): ZyntexEvent;
+    // Add other Zyntex instance methods here
+}
+
+interface ZyntexModule {
+    /**
+     * Creates a new Zyntex instance using the provided game token.
+     */
+    (gameToken: string): Zyntex;
+
+    /**
+     * The current version string of the Zyntex module.
+     */
+    readonly version: string;
+
+    /**
+     * Used by the upgrader plugin to detect Zyntex.
+     */
+    readonly isZyntex: true;
+}
+
+declare const ZyntexModule: ZyntexModule;
+export default ZyntexModule;

package/src/init.luau

@@ -0,0 +1,26 @@
+local Zyntex = require(script:FindFirstChild("Zyntex"))
+local Session = require(script:FindFirstChild("api"))
+
+return {
+default = setmetatable({}, {
+          	--[[
+          		Gets the current version of this module.
+          	]]
+          	__index = function(self, index)
+          		if string.lower(index) == "version" then
+          			return Zyntex.VERSION
+          		end
+          		if string.lower(index) == "isZyntex" then --// Important for the Zyntex upgrader plugin. When it searches for the module, make sure it has this.
+          			return true
+          		end
+          	end,
+          	--[[
+          		Returns a new Zyntex object.
+          		https://docs.zyntex.dev
+          	]]
+          	__call = function(self, gameToken: string): Zyntex.Zyntex
+          		return Zyntex.new(gameToken)
+          	end,
+          })
+
+}

package/src/tsconfig.tsbuildinfo

@@ -0,0 +1 @@
+{"program":{"fileNames":["../src/index.ts","../node_modules/@rbxts/types/include/generated/enums.d.ts","../node_modules/@rbxts/types/include/generated/none.d.ts","../node_modules/@rbxts/types/include/lua.d.ts","../node_modules/@rbxts/types/include/macro_math.d.ts","../node_modules/@rbxts/types/include/roblox.d.ts","../node_modules/@rbxts/compiler-types/types/array.d.ts","../node_modules/@rbxts/compiler-types/types/callmacros.d.ts","../node_modules/@rbxts/compiler-types/types/iterable.d.ts","../node_modules/@rbxts/compiler-types/types/map.d.ts","../node_modules/@rbxts/compiler-types/types/promise.d.ts","../node_modules/@rbxts/compiler-types/types/set.d.ts","../node_modules/@rbxts/compiler-types/types/string.d.ts","../node_modules/@rbxts/compiler-types/types/symbol.d.ts","../node_modules/@rbxts/compiler-types/types/typeutils.d.ts","../node_modules/@rbxts/compiler-types/types/eslintignore.d.ts","../node_modules/@rbxts/compiler-types/types/core.d.ts"],"fileInfos":[{"version":"5ac0e43910a78458433e231847ed609c4bc06e852bc77fa115155dc93527b020","signature":false},{"version":"23a663baeea88646b92df0ef8d51e9f2dd9b924dcaa150a35b2599a7b28960e9","signature":false,"affectsGlobalScope":true},{"version":"4f4ac4dffb4e0c21c40f3c5df80979d3165039718f9c7df8a600fa7d37d9fc48","signature":false,"affectsGlobalScope":true},{"version":"906abfeda44b050261b28ef1202799562dbf04817e2c96604190c5e01be745c6","signature":false,"affectsGlobalScope":true},{"version":"5b085ee9c23bd80318692ccc376f8af00cd6111b7a77238c27b595e3a7c4199a","signature":false,"affectsGlobalScope":true},{"version":"27674737e13df4a29a98eb1c06ab8a07f5fbd705d20e51916b08c132ea5b7470","signature":false,"affectsGlobalScope":true},{"version":"6826347cbacd3a749bdc7aab01f6e1ac2f16d62bdb46902a0c77c742bf42c619","signature":false,"affectsGlobalScope":true},{"version":"7c76ee8d0688477186ff292b7178fbd7b123c9bc385c7f0ac43742c8cfbcda7b","signature":false,"affectsGlobalScope":true},{"version":"d912c5d11ede33cefb967dc4886ac08cae34192d1a27f12f52201ea593bdf27d","signature":false,"affectsGlobalScope":true},{"version":"22bc177f25b0bff44aaa9a3428bb208088a764d38e18623ef878cc7cc72d07ee","signature":false,"affectsGlobalScope":true},{"version":"a95f106856dbc5289da510b0e24a633f9a2a2d0cb6c60ad93947efa13fcdf566","signature":false,"affectsGlobalScope":true},{"version":"346bca4a6e2c0ec0e4cc65a2f35ec773268d74288f83830e594ca983f473677c","signature":false,"affectsGlobalScope":true},{"version":"3501c467f99e26c1998f994bf5aa9673c7f9584bed3203dc6b3cd63596db3874","signature":false,"affectsGlobalScope":true},{"version":"28010932b8959e9c72e2d049f5526b8574b607ad615bdaa12c37dcdb789030d2","signature":false,"affectsGlobalScope":true},{"version":"adec607f45293974b4b7d6beb09f18cedc138bf788808918bc20c05a3649c45b","signature":false,"affectsGlobalScope":true},{"version":"70ab04fb9d57ca14cab8efcf963f48a18d4617f029afdbfd504777819415c3c9","signature":false,"affectsGlobalScope":true},{"version":"3a3c41569b2ef6dd6bb29b55a166da966ca7147ccfc1d93660bda725e1c14e48","signature":false,"affectsGlobalScope":true}],"root":[1],"options":{"allowSyntheticDefaultImports":true,"declaration":true,"downlevelIteration":true,"experimentalDecorators":true,"jsx":2,"module":1,"outDir":"./","rootDir":"../src","strict":true,"target":99,"tsBuildInfoFile":"./tsconfig.tsbuildinfo"},"fileIdsList":[[6],[6,7,8,9,10,11,12,13,14,15,16],[2,6],[3,17],[2,3,4,5,17]],"referencedMap":[[7,1],[8,1],[17,2],[16,1],[9,1],[10,1],[11,1],[12,1],[13,1],[14,1],[15,1],[2,1],[3,3],[4,4],[6,5]],"semanticDiagnosticsPerFile":[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17]},"version":"5.5.3"}

package/src/types.luau

@@ -0,0 +1,21 @@
+--[[
+	The Zyntex configuration type.
+]]
+export type Config = {
+	--[[
+		Wether or not to list to and execute requests made by the dashboard server.
+		Admins require the servers.rce permission to remotely execute code.
+		Defaults to "true"
+	]]
+	enableRCE: boolean?;
+	--[[
+		Whether or not to display debug logging
+	]]
+	debug: boolean?;
+	--[[
+		Wether or not to simulate high-requests
+	]]
+	simulate: boolean?;
+}
+
+return true;

package/src/zyntex.client.luau

@@ -0,0 +1,6 @@
+local SystemChatEvent: RemoteEvent = game:GetService("ReplicatedStorage"):WaitForChild("zyntex.events"):WaitForChild("SystemChat") :: RemoteEvent
+local Channel = game.TextChatService:WaitForChild("TextChannels"):WaitForChild("RBXGeneral")
+
+SystemChatEvent.OnClientEvent:Connect(function(msg: string)
+	Channel:DisplaySystemMessage(msg)
+end)