@gwigz/slua-types 0.3.0 → 1.0.1

package/index.d.ts

@@ -291,6 +291,35 @@ declare type OsDateTime = {
   yday?: number
   isdst?: boolean
 }
+/** Configuration options for lljson encoding */
+declare type LLJsonEncodeOptions = {
+  tight?: boolean
+  skip_tojson?: boolean
+  allow_sparse?: boolean
+  replacer: ((this: void, key: any, value: any, parent: any[] | undefined) => any) | undefined
+}
+declare type LLJsonDecodeReviverWithoutPath = (
+  this: void,
+  key: string | number,
+  value: any,
+  parent: any[] | undefined,
+  ctx: any[],
+) => any
+declare type LLJsonDecodeOptionsWithoutPath =
+  | { track_path?: false; reviver?: LLJsonDecodeReviverWithoutPath }
+  | LLJsonDecodeReviverWithoutPath
+declare type LLJsonDecodeOptionsWithPath = {
+  track_path: true
+  reviver: (
+    this: void,
+    key: string | number,
+    value: any,
+    parent: any[] | undefined,
+    ctx: { path: (string | number)[] },
+  ) => any
+}
+/** Configuration options for lljson decoding */
+declare type LLJsonDecodeOptions = LLJsonDecodeOptionsWithoutPath | LLJsonDecodeOptionsWithPath
 
 /** Event registration and management class for Second Life events */
 declare interface LLEvents {
@@ -300,9 +329,9 @@ declare interface LLEvents {
   off<E extends keyof LLEventMap>(event: E, callback: LLEventMap[E]): boolean
   /** Registers a one-time callback. Returns the wrapper function. */
   once<E extends keyof LLEventMap>(event: E, callback: LLEventMap[E]): LLEventMap[E]
-  /** Returns a list of all listeners for a specific event. */
-  listeners<E extends keyof LLEventMap>(event: E): LLEventMap[E][]
-  /** Returns a list of all event names that have listeners. */
+  /** Returns a list of all handlers for a specific event. */
+  handlers<E extends keyof LLEventMap>(event: E): LLEventMap[E][]
+  /** Returns a list of all event names that have handlers. */
   eventNames(): (keyof LLEventMap)[]
 }
 
@@ -704,29 +733,29 @@ declare namespace llbase64 {
 /** @noSelf */
 declare namespace lljson {
   /** Encodes a Lua value as JSON. Raises an error if value contains unsupported types. */
-  export function encode(value: any): string
+  export function encode(value: any, options?: LLJsonEncodeOptions): string
 
   /** Decodes a JSON string to a Lua value. Raises an error if JSON is invalid. */
-  export function decode(json: string): any
+  export function decode(json: string, options?: LLJsonDecodeOptions): any
 
   /** Encodes a Lua value as JSON, preserving SL types. Use tight to encode more compactly. Raises an error if value contains unsupported types. */
-  export function slencode(value: any, tight?: boolean): string
+  export function slencode(value: any, options?: LLJsonEncodeOptions): string
 
   /** Decodes a JSON string to a Lua value, preserving SL types. Raises an error if JSON is invalid. */
-  export function sldecode(json: string): any
+  export function sldecode(json: string, options?: LLJsonDecodeOptions): any
 
-  /** A constant to pass for null to json encode */
+  /** A constant to pass for null to json encode. */
   export const null_: any
-  /** Metatable for declaring table as an empty array for json encode */
-  export const empty_array_mt: Record<any, any>
-  /** Metatable for declaring table as an array for json encode */
-  export const array_mt: Record<any, any>
-  /** A constant to pass for an empty array to json encode */
-  export const empty_array: any
-  /** Name of the lljson library */
-  export const _NAME: string
-  /** Version of the lljson library */
-  export const _VERSION: string
+  /** A constant to return from a reviver/replacer replacer function to omit this item. */
+  export const remove: any
+  /** Metatable for declaring table as an array for json encode. */
+  export const array_mt: { __jsonhint: string }
+  /** Metatable for declaring table as an object for json encode. */
+  export const object_mt: { __jsonhint: string }
+  /** A constant to pass for an empty array to json encode. */
+  export const empty_array: any[]
+  /** A constant to pass for an empty object to json encode. */
+  export const empty_object: any[]
 }
 
 /** Mathematical functions library. */
@@ -4314,7 +4343,7 @@ declare const COMBAT_CHANNEL: number
  * Messages from the region to the COMBAT_CHANNEL will all be from this ID.
  *  Scripts may filter llListen calls on this ID to receive only system generated combat log messages.
  */
-declare const COMBAT_LOG_ID: string
+declare const COMBAT_LOG_ID: uuid
 /** "application/atom+xml" */
 declare const CONTENT_TYPE_ATOM: number
 /** "application/x-www-form-urlencoded" */
@@ -4513,17 +4542,17 @@ declare const HTTP_PRAGMA_NO_CACHE: number
 declare const HTTP_USER_AGENT: number
 declare const HTTP_VERBOSE_THROTTLE: number
 declare const HTTP_VERIFY_CERT: number
-declare const IMG_USE_BAKED_AUX1: string
-declare const IMG_USE_BAKED_AUX2: string
-declare const IMG_USE_BAKED_AUX3: string
-declare const IMG_USE_BAKED_EYES: string
-declare const IMG_USE_BAKED_HAIR: string
-declare const IMG_USE_BAKED_HEAD: string
-declare const IMG_USE_BAKED_LEFTARM: string
-declare const IMG_USE_BAKED_LEFTLEG: string
-declare const IMG_USE_BAKED_LOWER: string
-declare const IMG_USE_BAKED_SKIRT: string
-declare const IMG_USE_BAKED_UPPER: string
+declare const IMG_USE_BAKED_AUX1: uuid
+declare const IMG_USE_BAKED_AUX2: uuid
+declare const IMG_USE_BAKED_AUX3: uuid
+declare const IMG_USE_BAKED_EYES: uuid
+declare const IMG_USE_BAKED_HAIR: uuid
+declare const IMG_USE_BAKED_HEAD: uuid
+declare const IMG_USE_BAKED_LEFTARM: uuid
+declare const IMG_USE_BAKED_LEFTLEG: uuid
+declare const IMG_USE_BAKED_LOWER: uuid
+declare const IMG_USE_BAKED_SKIRT: uuid
+declare const IMG_USE_BAKED_UPPER: uuid
 declare const INVENTORY_ALL: number
 declare const INVENTORY_ANIMATION: number
 declare const INVENTORY_BODYPART: number
@@ -4656,7 +4685,7 @@ declare const MASK_OWNER: number
 /** Indicates a notecard read was attempted and the notecard was not yet cached on the server. */
 declare const NAK: string
 declare const NAVIGATE_TO_GOAL_REACHED_DIST: number
-declare const NULL_KEY: string
+declare const NULL_KEY: uuid
 /**
  * Retrieves the account level of an avatar.
  * Returns 0 when the avatar has a basic account,
@@ -5623,11 +5652,11 @@ declare const TERRAIN_PBR_SCALE_1: number
 declare const TERRAIN_PBR_SCALE_2: number
 declare const TERRAIN_PBR_SCALE_3: number
 declare const TERRAIN_PBR_SCALE_4: number
-declare const TEXTURE_BLANK: string
-declare const TEXTURE_DEFAULT: string
-declare const TEXTURE_MEDIA: string
-declare const TEXTURE_PLYWOOD: string
-declare const TEXTURE_TRANSPARENT: string
+declare const TEXTURE_BLANK: uuid
+declare const TEXTURE_DEFAULT: uuid
+declare const TEXTURE_MEDIA: uuid
+declare const TEXTURE_PLYWOOD: uuid
+declare const TEXTURE_TRANSPARENT: uuid
 declare const TOUCH_INVALID_FACE: number
 declare const TOUCH_INVALID_TEXCOORD: vector
 declare const TOUCH_INVALID_VECTOR: vector

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gwigz/slua-types",
-  "version": "0.3.0",
+  "version": "1.0.1",
   "description": "TypeScript type definitions for Second Life's SLua runtime",
   "license": "MIT",
   "repository": {
@@ -13,6 +13,9 @@
     "modules"
   ],
   "types": "index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
   "peerDependencies": {
     "@typescript-to-lua/language-extensions": "^1.0.0"
   }