@rbxts/zyntex-sdk 1.0.1 → 1.0.3

package/index.d.ts

@@ -1,4 +1,6 @@
 // types/zyntex.d.ts
+import {Telemetry} from "./telemetry";
+
 interface ZyntexConfig {}
 
 interface Invocation {
@@ -7,58 +9,75 @@ interface Invocation {
     data: unknown;
     to: string;
     sender: string;
-    from_server: string
-    invoked_at: number;
+    from_server: string;
+    invoked_at: number[];
     to_server: string;
     game_id: string;
     invoked_by: string;
 }
+
 interface ZyntexEvent {
-    Connect(callback: (invocation: Invocation)=>void): void
+    Connect(callback: (invocation: Invocation) => void): void;
 }
-interface Zyntex {
+export 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.
+    @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`).
-     */
+@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).
+@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.
+@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)
-     */
+@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
+    /*
+	@method Zyntex:ProcessPurchase
+	@description Logs a player's in-game purchase. This should be wired up to `MarketplaceService.ProcessReceipt`
+	to track player spending and LTV on the dashboard.
+
+	@param self Zyntex
+	@param player (Player | number) -- The Player object or UserId who made the purchase.
+	@param price number -- The price of the item in Robux.
+	@param productName string -- The name of the product purchased. Using the name is preferred over the ID for clarity on the dashboard.
+	@return boolean -- Returns `true` on success.
+     */
+    ProcessPurchase(player: Player|number,currencySpent:number, productName: string): boolean;
+    /*
+    @method Zyntex:Telemetry
+	@description Constructs a new Telemetry object used for prometheus-style metrics.
+	@param flushEvery number? -- How often to flush the buffer in seconds. Default is 10,
+	which is the minimum to not get ratelimited.
+	@param registryName string? -- The name of the registry. Default is "default"
+     */
+    Telemetry(flushEvery?: number,registryName?: string): Telemetry;
 }
 
-interface ZyntexModule {
+export 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.
      */
@@ -66,4 +85,5 @@ interface ZyntexModule {
 }
 
 declare const ZyntexModule: ZyntexModule;
-export default ZyntexModule;
+
+export default ZyntexModule;

package/package.json

@@ -1,11 +1,14 @@
 {
   "name": "@rbxts/zyntex-sdk",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "Typescript types for: The Roblox Zyntex SDK.",
   "main": "init.lua",
   "license": "MIT",
   "types": "index.d.ts",
   "publishConfig": {
     "access": "public"
+  },
+  "dependencies": {
+    "@rbxts/types": "^1.0.867"
   }
 }

package/telemetry.d.ts

@@ -0,0 +1,49 @@
+// types/telemetry.d.ts
+
+
+export type LabelSet = Record<string, string>;
+
+export interface MetricOpts {
+    /**
+     * Optional human-readable description
+     */
+    description?: string;
+
+    /**
+     * Labels, used for filtering metrics on the dashboard
+     */
+    labels?: string[];
+
+    /**
+     * Only for Histogram
+     */
+    buckets?: number[];
+}
+
+export interface CounterMetric {
+    inc(delta?: number, labels?: LabelSet): void;
+}
+
+export interface GaugeMetric {
+    set(value: number, labels?: LabelSet): void;
+    inc(delta?: number, labels?: LabelSet): void;
+    dec(delta?: number, labels?: LabelSet): void;
+}
+
+export interface HistogramMetric {
+    observe(value: number, labels?: LabelSet): void;
+}
+
+export interface SummaryMetric {
+    observe(value: number, labels?: LabelSet): void;
+}
+
+export interface Telemetry {
+    flush(): void;
+
+    Counter(name: string, opts?: MetricOpts): CounterMetric;
+    Gauge(name: string, opts?: MetricOpts): GaugeMetric;
+    Histogram(name: string, opts?: MetricOpts): HistogramMetric;
+    Summary(name: string, opts?: MetricOpts): SummaryMetric;
+}
+

package/.eslintrc

@@ -1,23 +0,0 @@
-{
-	"parser": "@typescript-eslint/parser",
-	"parserOptions": {
-		"jsx": true,
-		"useJSXTextNode": true,
-		"ecmaVersion": 2018,
-		"sourceType": "module",
-		"project": "./tsconfig.json"
-	},
-	"ignorePatterns": [
-		"/out"
-	],
-	"plugins": [
-		"@typescript-eslint",
-		"roblox-ts"
-	],
-	"extends": [
-		"eslint:recommended",
-		"plugin:@typescript-eslint/recommended",
-		"plugin:roblox-ts/recommended"
-	],
-	"rules": {}
-}

package/.idea/discord.xml

@@ -1,7 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="DiscordProjectSettings">
-    <option name="show" value="ASK" />
-    <option name="description" value="" />
-  </component>
-</project>

package/.idea/inspectionProfiles/Project_Default.xml

@@ -1,6 +0,0 @@
-<component name="InspectionProjectProfileManager">
-  <profile version="1.0">
-    <option name="myName" value="Project Default" />
-    <inspection_tool class="Eslint" enabled="true" level="WARNING" enabled_by_default="true" />
-  </profile>
-</component>

package/.idea/modules.xml

@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectModuleManager">
-    <modules>
-      <module fileurl="file://$PROJECT_DIR$/.idea/zyntex-sdk-typescript.iml" filepath="$PROJECT_DIR$/.idea/zyntex-sdk-typescript.iml" />
-    </modules>
-  </component>
-</project>

package/.idea/vcs.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="VcsDirectoryMappings">
-    <mapping directory="$PROJECT_DIR$" vcs="Git" />
-  </component>
-</project>

package/.idea/zyntex-sdk-typescript.iml

@@ -1,12 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<module type="WEB_MODULE" version="4">
-  <component name="NewModuleRootManager">
-    <content url="file://$MODULE_DIR$">
-      <excludeFolder url="file://$MODULE_DIR$/.tmp" />
-      <excludeFolder url="file://$MODULE_DIR$/temp" />
-      <excludeFolder url="file://$MODULE_DIR$/tmp" />
-    </content>
-    <orderEntry type="inheritedJdk" />
-    <orderEntry type="sourceFolder" forTests="false" />
-  </component>
-</module>

package/tsconfig.json

@@ -1,31 +0,0 @@
-{
-  "compilerOptions": {
-    // required
-    "allowSyntheticDefaultImports": true,
-    "downlevelIteration": true,
-    "jsx": "react",
-    "jsxFactory": "React.createElement",
-    "jsxFragmentFactory": "React.Fragment",
-    "module": "commonjs",
-    "moduleResolution": "Node",
-    "noLib": true,
-    "resolveJsonModule": true,
-    "forceConsistentCasingInFileNames": true,
-    "moduleDetection": "force",
-    "strict": true,
-    "target": "ESNext",
-    "typeRoots": [
-      "node_modules/@rbxts",
-    ],
-    // configurable
-    "rootDir": "",
-    "outDir": "",
-    "baseUrl": "",
-    "incremental": true,
-    "tsBuildInfoFile": "out/tsconfig.tsbuildinfo",
-    "experimentalDecorators": true,
-    "importHelpers": true,
-    "plugins": [
-    ]
-  }
-}