@dcl/js-runtime 7.17.1-21217092165.commit-1c2ff72 → 7.17.1-21371118760.commit-fbf4826

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@dcl/js-runtime",
   "description": "JavaScript runtime definitions for Decentraland environments",
-  "version": "7.17.1-21217092165.commit-1c2ff72",
+  "version": "7.17.1-21371118760.commit-fbf4826",
   "author": "",
   "files": [
     "index.d.ts",
@@ -20,5 +20,5 @@
   },
   "types": "./index.d.ts",
   "typings": "./index.d.ts",
-  "commit": "1c2ff7242cd11eb981666a8318f670c0b302813b"
+  "commit": "fbf4826ef686982ca1e60d368186e8e10c02a6e6"
 }

package/sdk.d.ts

@@ -2,3 +2,90 @@
 declare module '~sdk/all-composites' {
   export const compositeFromLoader: Record<string, Uint8Array | string>
 }
+
+// @internal
+declare module '~sdk/script-utils' {
+  type Entity = number; // this will get replaced with the proper import at scene build time
+
+  /**
+   * Registry interface that maps script paths to their types.
+   * This interface is populated at build time with actual script paths.
+   * It starts empty and gets augmented during scene builds.
+   */
+  export interface ScriptRegistry {}
+
+  /**
+   * Type utility to extract the instance type from a script module.
+   * For class-based scripts, extracts the class instance type.
+   * For functional scripts, returns the module type itself.
+   */
+  export type ExtractScriptType<T> = T extends Record<string, any>
+    ? { [K in keyof T]: T[K] extends new (...args: any[]) => infer Instance ? Instance : never }[keyof T] extends never
+      ? T
+      : { [K in keyof T]: T[K] extends new (...args: any[]) => infer Instance ? Instance : never }[keyof T]
+    : never
+
+  /**
+   * A callback function that triggers an action on an entity.
+   * Use this type for script parameters that should trigger actions configured in the editor.
+   *
+   * @example
+   * ```typescript
+   * import type { ActionCallback } from '~sdk/script-utils'
+   *
+   * export class Padlock {
+   *   constructor(
+   *     public src: string,
+   *     public entity: Entity,
+   *     public onUnlock: ActionCallback
+   *   ) {}
+   *
+   *   solve() {
+   *     this.onUnlock() // Triggers the action selected in the editor
+   *   }
+   * }
+   * ```
+   */
+  export type ActionCallback = () => void
+
+  /**
+   * @deprecated
+   * @internal This function is called automatically by the SDK entry point.
+   * Users should not call this function directly.
+   */
+  export function _initializeScripts(engine: any): void
+
+  /**
+   * Get a specific script instance by entity and script path.
+   * TypeScript will automatically infer the return type based on the script path.
+   */
+  export function getScriptInstance<K extends keyof ScriptRegistry>(entity: Entity, scriptPath: K): ScriptRegistry[K] | null
+  export function getScriptInstance<T = any>(entity: Entity, scriptPath: string): T | null
+
+  /**
+   * Get all instances of a specific script (across all entities).
+   * TypeScript will automatically infer the instance type based on the script path.
+   */
+  export function getScriptInstancesByPath<K extends keyof ScriptRegistry>(scriptPath: K): Array<{ entity: Entity; instance: ScriptRegistry[K] }>
+  export function getScriptInstancesByPath<T = any>(scriptPath: string): Array<{ entity: Entity; instance: T }>
+
+  /**
+   * Get all script instances attached to a specific entity
+   */
+  export function getAllScriptInstances(entity: Entity): Array<{ path: string; instance: any }>
+
+  /**
+   * Call a method on a script instance (with safety checks).
+   * TypeScript will automatically infer method names, parameter types, and return types.
+   */
+  export function callScriptMethod<
+    K extends keyof ScriptRegistry,
+    M extends keyof ScriptRegistry[K]
+  >(
+    entity: Entity,
+    scriptPath: K,
+    methodName: M,
+    ...args: ScriptRegistry[K][M] extends (...args: infer P) => any ? P : never
+  ): ScriptRegistry[K][M] extends (...args: any[]) => infer R ? R : never
+  export function callScriptMethod(entity: Entity, scriptPath: string, methodName: string, ...args: any[]): any
+}