@defold-typescript/library-types 0.21.1 → 0.23.0

package/generated/squid.d.ts

@@ -0,0 +1,127 @@
+/** @noResolution */
+declare module 'squid.squid' {
+	/**
+	 * @(1) trace logging level constant
+	 */
+	export const TRACE: number;
+	/**
+	 * @(2) debug logging level constant
+	 */
+	export const DEBUG: number;
+	/**
+	 * @(3) info logging level constant
+	 */
+	export const INFO: number;
+	/**
+	 * @(4) warning logging level constant
+	 */
+	export const WARN: number;
+	/**
+	 * @(5) error logging level constant
+	 */
+	export const ERROR: number;
+	/**
+	 * @Public list of allowed tags (pairs tag[string] - is_allowed[boolean])
+	 */
+	export const ALLOWLIST: LuaTable;
+	interface SquidInstance {
+		log(message: string | number, level: number, data?: unknown): void;
+		trace(message: string | number, data?: unknown): void;
+		debug(message: string | number, data?: unknown): void;
+		info(message: string | number, data?: unknown): void;
+		warn(message: string | number, data?: unknown): void;
+		error(message: string | number, data?: unknown): void;
+		set_allowed(this_tag?: string, this_is_allowed?: boolean): void;
+		save_logs(): void;
+		init(): void;
+		final(): void;
+	}
+	interface SquidConfig {
+		app_catalog: string;
+		log_file_name: string;
+		log_file_extension: string;
+		is_enabled: boolean;
+		is_enabled_in_release: boolean;
+		is_printing: boolean;
+		is_saving: boolean;
+		is_adding_timestamp: boolean;
+		is_using_allowlist: boolean;
+		days_to_delete_logs: number;
+		min_log_level: number;
+		unsaved_logs_buffer: number;
+		max_data_length: number;
+		max_data_depth: number;
+		is_printing_crashes: boolean;
+		is_saving_crashes: boolean;
+		crash_file_name: string;
+		crash_file_extension: string;
+	}
+	interface SystemHelper {
+		is_linux: boolean;
+		is_mobile: boolean;
+		is_debug: boolean;
+	}
+	interface TableToString {
+	}
+	/**
+	 * ------
+	 * ------
+	 * ------
+	 * ------
+	 * Initialize Squid for error and crash handling and logging
+	 */
+	export function init(this: void): void;
+	/**
+	 * Set if logs should be saved to file
+	 */
+	export function set_allowed(this: void, tag: string, is_allowed: boolean): void;
+	/**
+	 * Log TRACE level message with optional data and tag
+	 */
+	export function trace(this: void, message: string | number, data_or_tag?: unknown, tag?: string): void;
+	/**
+	 * Log DEBUG level message with optional data and tag
+	 */
+	export function debug(this: void, message: string | number, data_or_tag?: unknown, tag?: string): void;
+	/**
+	 * Log INFO level message with optional data and tag
+	 */
+	export function info(this: void, message: string | number, data_or_tag?: unknown, tag?: string): void;
+	/**
+	 * Log WARNING level message with optional data and tag
+	 */
+	export function warn(this: void, message: string | number, data_or_tag?: unknown, tag?: string): void;
+	/**
+	 * Log ERROR level message with optional data and tag
+	 */
+	export function error(this: void, message: string | number, data_or_tag?: unknown, tag?: string): void;
+	/**
+	 * Log message with provided level, message, data and tag
+	 */
+	export function log(this: void, message: string | number, level?: number, data_or_tag?: unknown, tag?: string): void;
+	/**
+	 * Explicitly save buffer of unsaved logs to a file
+	 */
+	export function save_logs(this: void): boolean;
+	/**
+	 * Set error callback function that will be called on error after logging it
+	 */
+	export function set_error_callback(this: void, callback: (source: string, message: string, traceback: string) => void): void;
+	/**
+	 * Finalize Squid logging - check for crashes and saved all unsaved buffered logs
+	 */
+	export function final(this: void): void;
+	/**
+	 * Create a new instance of the Squid logger
+	 */
+	export function new_(this: void, tag?: string, is_allowed?: boolean): SquidInstance;
+	export { new_ as new };
+	/**
+	 * Get Squid configuration
+	 */
+	export function get_config(this: void): SquidConfig;
+	/**
+	 * Set and use user configuration
+	 */
+	export function set_config(this: void, config: SquidConfig): void;
+}

package/generated/tweener.d.ts

@@ -0,0 +1,42 @@
+/** @noResolution */
+declare module 'tweener.tweener' {
+	type easing_function = ((current: number, from: number, to: number, time: number) => number) | string | Opaque<"constant"> | number[];
+	/**
+	 * Describe a struct of tween object returned by the `tweener.tween` function
+	 */
+	interface tween {
+		timer_id: number;
+		is_paused: boolean;
+	}
+	/**
+	 * A tweener module to manage tweening operations. Tween functions are based on the Defold timer.delay function.
+	 * Use `tweener.tween` to create a tween, and `tweener.ease` to get the result of an easing function.
+	 * You can track the final call of tween by last parameter of the callback function.
+	 */
+	interface tweener {
+	}
+	/**
+	 * Starts a tweening operation. Return a tween object to manage the tween.
+	 */
+	export function tween(this: void, easing_function: easing_function, from: number, to: number, time: number | undefined, callback: (value: number, is_end: boolean, time_elapsed: number, time_total: number) => void, update_delta_time?: number | undefined): tween;
+	/**
+	 * Returns the result of an easing function.
+	 */
+	export function ease(this: void, easing_function: easing_function, from: number, to: number, time: number | undefined, time_elapsed: number): number;
+	/**
+	 * Check if a tween exists
+	 */
+	export function is_active(this: void, tween: tween): boolean;
+	/**
+	 * Cancel a previous running tween.
+	 */
+	export function cancel(this: void, tween?: tween | undefined): boolean;
+	/**
+	 * Check if a tween is paused
+	 */
+	export function is_paused(this: void, tween: tween): boolean;
+	/**
+	 * Sets the pause on a running tween.
+	 */
+	export function set_pause(this: void, tween: tween, is_paused: boolean): void;
+}

package/library-classification.json

@@ -90,13 +90,6 @@
         "astar"
       ]
     },
-    {
-      "dir": "defold-bridge",
-      "classification": "already-vendored",
-      "modules": [
-        "bridge.bridge"
-      ]
-    },
     {
       "dir": "defold-clipboard",
       "classification": "native",
@@ -111,13 +104,6 @@
         "coolmath_games"
       ]
     },
-    {
-      "dir": "defold-event",
-      "classification": "already-vendored",
-      "modules": [
-        "event.event"
-      ]
-    },
     {
       "dir": "defold-extension-unity-ads",
       "classification": "native",
@@ -148,13 +134,6 @@
         "in.triggers"
       ]
     },
-    {
-      "dir": "defold-lang",
-      "classification": "already-vendored",
-      "modules": [
-        "lang.lang"
-      ]
-    },
     {
       "dir": "defold-lfs",
       "classification": "native",
@@ -169,13 +148,6 @@
         "lldebugger.debug"
       ]
     },
-    {
-      "dir": "defold-log",
-      "classification": "already-vendored",
-      "modules": [
-        "log.log"
-      ]
-    },
     {
       "dir": "defold-metrics",
       "classification": "already-vendored",
@@ -212,13 +184,6 @@
         "prng"
       ]
     },
-    {
-      "dir": "defold-proto",
-      "classification": "already-vendored",
-      "modules": [
-        "proto.proto"
-      ]
-    },
     {
       "dir": "defold-random",
       "classification": "native",
@@ -235,14 +200,6 @@
         "richtext.tags"
       ]
     },
-    {
-      "dir": "defold-saver",
-      "classification": "already-vendored",
-      "modules": [
-        "saver.saver",
-        "saver.storage"
-      ]
-    },
     {
       "dir": "defold-scene3d",
       "classification": "native",
@@ -299,13 +256,6 @@
         "tile_raycast"
       ]
     },
-    {
-      "dir": "defold-tweener",
-      "classification": "already-vendored",
-      "modules": [
-        "tweener.tweener"
-      ]
-    },
     {
       "dir": "defold-uuid4",
       "classification": "native",
@@ -669,13 +619,6 @@
         "rendy.rendy"
       ]
     },
-    {
-      "dir": "lua-immutable",
-      "classification": "already-vendored",
-      "modules": [
-        "immutable.immutable"
-      ]
-    },
     {
       "dir": "monarch",
       "classification": "already-vendored",
@@ -694,13 +637,6 @@
         "nakama.util.log"
       ]
     },
-    {
-      "dir": "narrator",
-      "classification": "already-vendored",
-      "modules": [
-        "narrator.narrator"
-      ]
-    },
     {
       "dir": "platypus",
       "classification": "already-vendored",
@@ -708,13 +644,6 @@
         "platypus.platypus"
       ]
     },
-    {
-      "dir": "squid",
-      "classification": "already-vendored",
-      "modules": [
-        "squid.squid"
-      ]
-    },
     {
       "dir": "starly",
       "classification": "already-vendored",

package/library-targets.json

@@ -101,12 +101,6 @@
       "fixture": "fixtures/ts-defold/platypus.platypus.d.ts",
       "generated": "generated/platypus.platypus.d.ts"
     },
-    {
-      "module": "event.event",
-      "path": "packages/defold-event/event.event.d.ts",
-      "fixture": "fixtures/ts-defold/event.event.d.ts",
-      "generated": "generated/event.event.d.ts"
-    },
     {
       "module": "richtext.color",
       "path": "packages/defold-richtext/richtext.color.d.ts",
@@ -125,36 +119,12 @@
       "fixture": "fixtures/ts-defold/richtext.tags.d.ts",
       "generated": "generated/richtext.tags.d.ts"
     },
-    {
-      "module": "narrator.narrator",
-      "path": "packages/narrator/narrator.narrator.d.ts",
-      "fixture": "fixtures/ts-defold/narrator.narrator.d.ts",
-      "generated": "generated/narrator.narrator.d.ts"
-    },
     {
       "module": "defcon.console",
       "path": "packages/defcon/defcon.console.d.ts",
       "fixture": "fixtures/ts-defold/defcon.console.d.ts",
       "generated": "generated/defcon.console.d.ts"
     },
-    {
-      "module": "lang.lang",
-      "path": "packages/defold-lang/lang.lang.d.ts",
-      "fixture": "fixtures/ts-defold/lang.lang.d.ts",
-      "generated": "generated/lang.lang.d.ts"
-    },
-    {
-      "module": "saver.saver",
-      "path": "packages/defold-saver/saver.saver.d.ts",
-      "fixture": "fixtures/ts-defold/saver.saver.d.ts",
-      "generated": "generated/saver.saver.d.ts"
-    },
-    {
-      "module": "saver.storage",
-      "path": "packages/defold-saver/saver.storage.d.ts",
-      "fixture": "fixtures/ts-defold/saver.storage.d.ts",
-      "generated": "generated/saver.storage.d.ts"
-    },
     {
       "module": "defsave.defsave",
       "path": "packages/defsave/defsave.defsave.d.ts",
@@ -167,12 +137,6 @@
       "fixture": "fixtures/ts-defold/persist.persist.d.ts",
       "generated": "generated/persist.persist.d.ts"
     },
-    {
-      "module": "proto.proto",
-      "path": "packages/defold-proto/proto.proto.d.ts",
-      "fixture": "fixtures/ts-defold/proto.proto.d.ts",
-      "generated": "generated/proto.proto.d.ts"
-    },
     {
       "module": "defmath.defmath",
       "path": "packages/defmath/defmath.defmath.d.ts",
@@ -185,30 +149,12 @@
       "fixture": "fixtures/ts-defold/dicebag.dicebag.d.ts",
       "generated": "generated/dicebag.dicebag.d.ts"
     },
-    {
-      "module": "tweener.tweener",
-      "path": "packages/defold-tweener/tweener.tweener.d.ts",
-      "fixture": "fixtures/ts-defold/tweener.tweener.d.ts",
-      "generated": "generated/tweener.tweener.d.ts"
-    },
-    {
-      "module": "squid.squid",
-      "path": "packages/squid/squid.squid.d.ts",
-      "fixture": "fixtures/ts-defold/squid.squid.d.ts",
-      "generated": "generated/squid.squid.d.ts"
-    },
     {
       "module": "starly.starly",
       "path": "packages/starly/starly.starly.d.ts",
       "fixture": "fixtures/ts-defold/starly.starly.d.ts",
       "generated": "generated/starly.starly.d.ts"
     },
-    {
-      "module": "log.log",
-      "path": "packages/defold-log/log.log.d.ts",
-      "fixture": "fixtures/ts-defold/log.log.d.ts",
-      "generated": "generated/log.log.d.ts"
-    },
     {
       "module": "metrics.fps",
       "path": "packages/defold-metrics/metrics.fps.d.ts",
@@ -227,12 +173,6 @@
       "fixture": "fixtures/ts-defold/deftest.deftest.d.ts",
       "generated": "generated/deftest.deftest.d.ts"
     },
-    {
-      "module": "immutable.immutable",
-      "path": "packages/lua-immutable/immutable.immutable.d.ts",
-      "fixture": "fixtures/ts-defold/immutable.immutable.d.ts",
-      "generated": "generated/immutable.immutable.d.ts"
-    },
     {
       "module": "nakama.engine.defold",
       "path": "packages/nakama-defold/nakama.engine.defold.d.ts",
@@ -257,12 +197,6 @@
       "fixture": "fixtures/ts-defold/yagames.yagames.d.ts",
       "generated": "generated/yagames.yagames.d.ts"
     },
-    {
-      "module": "bridge.bridge",
-      "path": "packages/defold-bridge/bridge.bridge.d.ts",
-      "fixture": "fixtures/ts-defold/bridge.bridge.d.ts",
-      "generated": "generated/bridge.bridge.d.ts"
-    },
     {
       "module": "zzfx.api",
       "path": "packages/defold-zzfx/zzfx.api.d.ts",

package/luals-targets.json

@@ -23,6 +23,120 @@
       "namespace": "decore",
       "typeRenames": {},
       "ignore": ["**/test/**", "**/example/**"]
+    },
+    {
+      "repo": "https://github.com/Insality/defold-tweener",
+      "ref": "6",
+      "license": "MIT",
+      "sourceGlobs": ["tweener/**/*.lua"],
+      "moduleId": "tweener.tweener",
+      "namespace": "tweener",
+      "typeRenames": {
+        "vector": "Vector",
+        "vector3": "Vector3",
+        "vector4": "Vector4"
+      },
+      "ignore": ["**/test/**", "**/example/**", "**/example_*/**"]
+    },
+    {
+      "repo": "https://github.com/Insality/defold-event",
+      "ref": "19",
+      "license": "MIT",
+      "sourceGlobs": ["event/**/*.lua"],
+      "moduleId": "event.event",
+      "namespace": "event",
+      "typeRenames": {},
+      "ignore": ["**/test/**", "**/example/**", "**/example_*/**"]
+    },
+    {
+      "repo": "https://github.com/Insality/defold-lang",
+      "ref": "5",
+      "license": "MIT",
+      "sourceGlobs": ["lang/**/*.lua"],
+      "moduleId": "lang.lang",
+      "namespace": "lang",
+      "typeRenames": {},
+      "ignore": ["**/test/**", "**/example/**", "**/example_*/**"]
+    },
+    {
+      "repo": "https://github.com/Insality/defold-log",
+      "ref": "6",
+      "license": "MIT",
+      "sourceGlobs": ["log/**/*.lua"],
+      "moduleId": "log.log",
+      "namespace": "log",
+      "typeRenames": {},
+      "ignore": ["**/test/**", "**/example/**", "**/example_*/**"]
+    },
+    {
+      "repo": "https://github.com/Insality/defold-proto",
+      "ref": "1",
+      "license": "MIT",
+      "sourceGlobs": ["proto/**/*.lua"],
+      "moduleId": "proto.proto",
+      "namespace": "proto",
+      "typeRenames": {},
+      "ignore": ["**/test/**", "**/example/**", "**/example_*/**"]
+    },
+    {
+      "repo": "https://github.com/Insality/defold-saver",
+      "ref": "8",
+      "license": "MIT",
+      "sourceGlobs": ["saver/**/*.lua"],
+      "moduleId": "saver.saver",
+      "namespace": "saver.saver",
+      "typeRenames": {},
+      "ignore": ["**/test/**", "**/example/**", "**/example_*/**"]
+    },
+    {
+      "repo": "https://github.com/Insality/defold-saver",
+      "ref": "8",
+      "license": "MIT",
+      "sourceGlobs": ["saver/**/*.lua"],
+      "moduleId": "saver.storage",
+      "namespace": "saver.storage",
+      "typeRenames": {},
+      "ignore": ["**/test/**", "**/example/**", "**/example_*/**"]
+    },
+    {
+      "repo": "https://github.com/paweljarosz/lua-immutable",
+      "ref": "v1.1",
+      "license": "MIT",
+      "sourceGlobs": ["immutable/**/*.lua"],
+      "moduleId": "immutable.immutable",
+      "namespace": "immutable",
+      "typeRenames": {},
+      "ignore": ["**/test/**", "**/example/**", "**/example_*/**"]
+    },
+    {
+      "repo": "https://github.com/paweljarosz/squid",
+      "ref": "1.2",
+      "license": "MIT",
+      "sourceGlobs": ["squid/**/*.lua"],
+      "moduleId": "squid.squid",
+      "namespace": "squid",
+      "typeRenames": {},
+      "ignore": ["**/test/**", "**/example/**", "**/example_*/**"]
+    },
+    {
+      "repo": "https://github.com/astrochili/narrator",
+      "ref": "1.8",
+      "license": "MIT",
+      "sourceGlobs": ["narrator/annotations.lua", "narrator/narrator.lua", "narrator/story.lua"],
+      "moduleId": "narrator.narrator",
+      "namespace": "narrator",
+      "typeRenames": {},
+      "ignore": ["**/test/**", "**/example/**", "**/example_*/**"],
+      "annotationOverrides": {
+        "moduleFunctions": {
+          "parse_content": { "params": { "inclusions": { "optional": true } } }
+        },
+        "interfaces": {
+          "Narrator.Story": {
+            "methods": { "continue": { "return": "Narrator.Paragraph[]|Narrator.Paragraph" } }
+          }
+        }
+      }
     }
   ]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defold-typescript/library-types",
-  "version": "0.21.1",
+  "version": "0.23.0",
   "description": "Vendored TypeScript types for popular Defold Lua libraries, core-type-renamed against @defold-typescript/types.",
   "license": "MIT",
   "repository": {
@@ -57,12 +57,6 @@
     "./in.triggers": {
       "types": "./generated/in.triggers.d.ts"
     },
-    "./immutable.immutable": {
-      "types": "./generated/immutable.immutable.d.ts"
-    },
-    "./log.log": {
-      "types": "./generated/log.log.d.ts"
-    },
     "./metrics.fps": {
       "types": "./generated/metrics.fps.d.ts"
     },
@@ -72,9 +66,6 @@
     "./platypus.platypus": {
       "types": "./generated/platypus.platypus.d.ts"
     },
-    "./event.event": {
-      "types": "./generated/event.event.d.ts"
-    },
     "./richtext.color": {
       "types": "./generated/richtext.color.d.ts"
     },
@@ -84,31 +75,16 @@
     "./richtext.tags": {
       "types": "./generated/richtext.tags.d.ts"
     },
-    "./narrator.narrator": {
-      "types": "./generated/narrator.narrator.d.ts"
-    },
     "./defcon.console": {
       "types": "./generated/defcon.console.d.ts"
     },
-    "./lang.lang": {
-      "types": "./generated/lang.lang.d.ts"
-    },
     "./package.json": "./package.json",
-    "./saver.saver": {
-      "types": "./generated/saver.saver.d.ts"
-    },
-    "./saver.storage": {
-      "types": "./generated/saver.storage.d.ts"
-    },
     "./defsave.defsave": {
       "types": "./generated/defsave.defsave.d.ts"
     },
     "./persist.persist": {
       "types": "./generated/persist.persist.d.ts"
     },
-    "./proto.proto": {
-      "types": "./generated/proto.proto.d.ts"
-    },
     "./defmath.defmath": {
       "types": "./generated/defmath.defmath.d.ts"
     },
@@ -118,12 +94,6 @@
     "./dicebag.dicebag": {
       "types": "./generated/dicebag.dicebag.d.ts"
     },
-    "./tweener.tweener": {
-      "types": "./generated/tweener.tweener.d.ts"
-    },
-    "./squid.squid": {
-      "types": "./generated/squid.squid.d.ts"
-    },
     "./starly.starly": {
       "types": "./generated/starly.starly.d.ts"
     },
@@ -140,7 +110,7 @@
       "types": "./generated/yagames.yagames.d.ts"
     },
     "./bridge.bridge": {
-      "types": "./generated/bridge.bridge.d.ts"
+      "types": "./generated/bridge.d.ts"
     },
     "./zzfx.api": {
       "types": "./generated/zzfx.api.d.ts"
@@ -162,6 +132,7 @@
     "library-targets.json",
     "library-classification.json",
     "luals-targets.json",
+    "script-api-targets.json",
     "NOTICE",
     "!scripts/**/*.test.ts"
   ],
@@ -176,7 +147,7 @@
     "luals:api-doc": "bun scripts/sync-luals-types.ts --api-doc"
   },
   "dependencies": {
-    "@defold-typescript/types": "0.21.1"
+    "@defold-typescript/types": "0.23.0"
   },
   "devDependencies": {
     "@typescript-to-lua/language-extensions": "1.19.0",

package/script-api-targets.json

@@ -0,0 +1,15 @@
+{
+  "targets": [
+    {
+      "repo": "https://github.com/Playgama/bridge-defold",
+      "ref": "v2.0.0",
+      "license": "MIT",
+      "scriptApi": "bridge/api/bridge.script_api",
+      "moduleId": "bridge.bridge",
+      "namespace": "bridge",
+      "generated": "generated/bridge.d.ts",
+      "apiDoc": "api-doc/bridge.json",
+      "fidelity": "fidelity/bridge.json"
+    }
+  ]
+}