@defold-typescript/library-types 0.24.0 → 0.25.0

package/NOTICE

@@ -28,13 +28,12 @@ Attributed upstream libraries (by their directory in ts-defold/library):
     - defold-lang         — Insality, https://github.com/Insality/defold-lang
     - defold-saver        — Insality, https://github.com/Insality/defold-saver
     - defsave             — subsoap, https://github.com/subsoap/defsave
-    - library-defold-persist — klaytonkowalski, https://github.com/klaytonkowalski/library-defold-persist
+    - library-defold-persist — whiteboxdev, https://github.com/whiteboxdev/library-defold-persist
     - defold-proto        — Insality, https://github.com/Insality/defold-proto
     - defmath             — subsoap, https://github.com/subsoap/defmath
     - dicebag             — 8bitskull, https://github.com/8bitskull/dicebag
     - defold-tweener      — Insality, https://github.com/Insality/defold-tweener
     - squid               — paweljarosz, https://github.com/paweljarosz/squid
-    - starly              — VowSoftware, https://github.com/VowSoftware/starly
     - defold-log          — Insality, https://github.com/Insality/defold-log
     - defold-metrics      — Britzl, https://github.com/britzl/defold-metrics
     - deftest             — Britzl, https://github.com/britzl/deftest
@@ -45,7 +44,7 @@ Attributed upstream libraries (by their directory in ts-defold/library):
     - defold-zzfx         — thejustinwalsh, https://github.com/thejustinwalsh/defold-zzfx
     - boom                — Britzl, https://github.com/britzl/boom
     - bzAnim              — jbp4444, https://github.com/jbp4444/bzAnim
-    - library-defold-rendy — klaytonkowalski, https://github.com/klaytonkowalski/library-defold-rendy
+    - library-defold-rendy — whiteboxdev, https://github.com/whiteboxdev/library-defold-rendy
 
 Each upstream library is distributed under its own license by its original
 author. The ts-defold/library MIT license covers the TypeScript definition

package/api-doc/boom.json

@@ -27,6 +27,7 @@
       "name": "add",
       "brief": "Add a game object with a set of components.",
       "description": "Add a game object with a set of components.",
+      "generics": "<T extends (BoomComponent | BoomTag)[]>",
       "parameters": [
         {
           "name": "comps",
@@ -2304,6 +2305,7 @@
           "name": "add",
           "brief": "Add a game object as a child of this game object",
           "description": "Add a game object as a child of this game object\nby composing it with components.",
+          "generics": "<T extends (BoomComponent | BoomTag)[]>",
           "parameters": [
             {
               "name": "comps",

package/api-doc/checkpoint.json

@@ -0,0 +1,127 @@
+{
+  "info": {
+    "namespace": "checkpoint",
+    "brief": "",
+    "description": ""
+  },
+  "elements": [
+    {
+      "type": "VARIABLE",
+      "name": "project_title",
+      "brief": "The `project.title` from game.project, read once when the module loads. It is",
+      "description": "The `project.title` from game.project, read once when the module loads. It is\nthe name the save directory is derived from.",
+      "types": [
+        "string"
+      ]
+    },
+    {
+      "type": "VARIABLE",
+      "name": "project_save_path",
+      "brief": "The absolute path of the project's save directory, resolved once when the",
+      "description": "The absolute path of the project's save directory, resolved once when the\nmodule loads. Every path the other members take is relative to it, and `list`\nreturns paths relative to it. Ends with a separator, e.g.\n`/home/klaleus/.local/share/defold-checkpoint/`.",
+      "types": [
+        "string"
+      ]
+    },
+    {
+      "type": "FUNCTION",
+      "name": "read",
+      "brief": "Loads a saved file. A path ending in `.json` is read as text and decoded with",
+      "description": "Loads a saved file. A path ending in `.json` is read as text and decoded with\n`json.decode`; anything else is loaded with `sys.load`. On success the loaded\nvalue is returned alone, so the error slot is absent; on any failure — the file\nmissing, unreadable, or holding invalid content — the first value is `false` and\nthe second is the error string. Name the saved shape through the type parameter\nto avoid casting at the call site.",
+      "generics": "<T = unknown>",
+      "parameters": [
+        {
+          "name": "path",
+          "doc": "Path relative to `project_save_path`.",
+          "types": [
+            "string"
+          ],
+          "is_optional": "False"
+        }
+      ],
+      "returnvalues": [
+        {
+          "name": "",
+          "doc": "The loaded value, or `false` and the error that stopped it.",
+          "types": [
+            "LuaMultiReturn<[ T | false, string | undefined ]>"
+          ]
+        }
+      ]
+    },
+    {
+      "type": "FUNCTION",
+      "name": "write",
+      "brief": "Saves a value, creating any missing directories along the path first. A path",
+      "description": "Saves a value, creating any missing directories along the path first. A path\nending in `.json` is encoded with `json.encode` and written as text and flushed\nimmediately; anything else is written with `sys.save`. Creating the directories\ngoes through `lfs`, so the project needs `britzl/defold-lfs` as a dependency;\nthis corpus does not type it.",
+      "parameters": [
+        {
+          "name": "path",
+          "doc": "Path relative to `project_save_path`.",
+          "types": [
+            "string"
+          ],
+          "is_optional": "False"
+        },
+        {
+          "name": "data",
+          "doc": "The value to save.",
+          "types": [
+            "unknown"
+          ],
+          "is_optional": "False"
+        }
+      ],
+      "returnvalues": [
+        {
+          "name": "",
+          "doc": "`true`, or `false` and the error that stopped it.",
+          "types": [
+            "LuaMultiReturn<[ boolean, string | undefined ]>"
+          ]
+        }
+      ]
+    },
+    {
+      "type": "FUNCTION",
+      "name": "exists",
+      "brief": "Whether a saved file exists. Returns a real boolean rather than the underlying",
+      "description": "Whether a saved file exists. Returns a real boolean rather than the underlying\nfile attributes, so it reads directly as a condition. Goes through `lfs`, so the\nproject needs `britzl/defold-lfs` as a dependency.",
+      "parameters": [
+        {
+          "name": "path",
+          "doc": "Path relative to `project_save_path`.",
+          "types": [
+            "string"
+          ],
+          "is_optional": "False"
+        }
+      ],
+      "returnvalues": [
+        {
+          "name": "",
+          "doc": "",
+          "types": [
+            "boolean"
+          ]
+        }
+      ]
+    },
+    {
+      "type": "FUNCTION",
+      "name": "list",
+      "brief": "Every saved file, found by walking the save directory breadth-first. Directories",
+      "description": "Every saved file, found by walking the save directory breadth-first. Directories\nare descended into rather than listed. Goes through `lfs`, so the project needs\n`britzl/defold-lfs` as a dependency.",
+      "parameters": [],
+      "returnvalues": [
+        {
+          "name": "",
+          "doc": "The file paths, relative to `project_save_path`.",
+          "types": [
+            "string[]"
+          ]
+        }
+      ]
+    }
+  ]
+}

package/api-doc/deftest.json

@@ -162,6 +162,7 @@
       "name": "assert_equal",
       "brief": "",
       "description": "",
+      "generics": "<T>",
       "parameters": [
         {
           "name": "a",
@@ -480,6 +481,7 @@
       "name": "assert_type",
       "brief": "",
       "description": "",
+      "generics": "<T>",
       "parameters": [
         {
           "name": "a",
@@ -542,6 +544,7 @@
       "name": "assert_not_equal",
       "brief": "",
       "description": "",
+      "generics": "<T>",
       "parameters": [
         {
           "name": "a",
@@ -716,6 +719,7 @@
       "name": "assert_not_type",
       "brief": "",
       "description": "",
+      "generics": "<T>",
       "parameters": [
         {
           "name": "a",

package/api-doc/nakama.session.json

@@ -0,0 +1,315 @@
+{
+  "info": {
+    "namespace": "nakama.session",
+    "brief": "",
+    "description": ""
+  },
+  "elements": [
+    {
+      "type": "FUNCTION",
+      "name": "is_token_expired_soon",
+      "brief": "Whether the session's access token expires within the next twenty-four hours.",
+      "description": "Whether the session's access token expires within the next twenty-four hours.\nRefresh the session while this is true rather than waiting for it to expire.",
+      "parameters": [
+        {
+          "name": "session",
+          "doc": "A session created with `create`.",
+          "types": [
+            "Session"
+          ],
+          "is_optional": "False"
+        }
+      ],
+      "returnvalues": [
+        {
+          "name": "",
+          "doc": "",
+          "types": [
+            "boolean"
+          ]
+        }
+      ]
+    },
+    {
+      "type": "FUNCTION",
+      "name": "is_token_expired",
+      "brief": "Whether the session's access token has already expired.",
+      "description": "Whether the session's access token has already expired.",
+      "parameters": [
+        {
+          "name": "session",
+          "doc": "A session created with `create`.",
+          "types": [
+            "Session"
+          ],
+          "is_optional": "False"
+        }
+      ],
+      "returnvalues": [
+        {
+          "name": "",
+          "doc": "",
+          "types": [
+            "boolean"
+          ]
+        }
+      ]
+    },
+    {
+      "type": "FUNCTION",
+      "name": "expired",
+      "brief": "Upstream's backwards-compatible alias of `is_token_expired`, kept because older",
+      "description": "Upstream's backwards-compatible alias of `is_token_expired`, kept because older\ncode calls it. New code should call `is_token_expired`.",
+      "parameters": [
+        {
+          "name": "session",
+          "doc": "A session created with `create`.",
+          "types": [
+            "Session"
+          ],
+          "is_optional": "False"
+        }
+      ],
+      "returnvalues": [
+        {
+          "name": "",
+          "doc": "",
+          "types": [
+            "boolean"
+          ]
+        }
+      ]
+    },
+    {
+      "type": "FUNCTION",
+      "name": "is_refresh_token_expired",
+      "brief": "Whether the session's refresh token has expired. A session created without a",
+      "description": "Whether the session's refresh token has expired. A session created without a\nrefresh token counts as expired, there being nothing left to refresh with.",
+      "parameters": [
+        {
+          "name": "session",
+          "doc": "A session created with `create`.",
+          "types": [
+            "Session"
+          ],
+          "is_optional": "False"
+        }
+      ],
+      "returnvalues": [
+        {
+          "name": "",
+          "doc": "",
+          "types": [
+            "boolean"
+          ]
+        }
+      ]
+    },
+    {
+      "type": "FUNCTION",
+      "name": "create",
+      "brief": "Builds a session from an authentication response, decoding the tokens it carries",
+      "description": "Builds a session from an authentication response, decoding the tokens it carries\nto read their expiry, username, user id and session variables.",
+      "parameters": [
+        {
+          "name": "data",
+          "doc": "The authentication response, which must carry a `token`.",
+          "types": [
+            "SessionData"
+          ],
+          "is_optional": "False"
+        }
+      ],
+      "returnvalues": [
+        {
+          "name": "",
+          "doc": "",
+          "types": [
+            "Session"
+          ]
+        }
+      ]
+    },
+    {
+      "type": "FUNCTION",
+      "name": "store",
+      "brief": "Writes a session to disk under the project title, so it survives a restart.",
+      "description": "Writes a session to disk under the project title, so it survives a restart.",
+      "parameters": [
+        {
+          "name": "session",
+          "doc": "The session to store.",
+          "types": [
+            "Session"
+          ],
+          "is_optional": "False"
+        },
+        {
+          "name": "id",
+          "doc": "Names the saved session. Defaults to `nakama`.",
+          "types": [
+            "string"
+          ],
+          "is_optional": "True"
+        }
+      ],
+      "returnvalues": [
+        {
+          "name": "",
+          "doc": "Whether the save succeeded.",
+          "types": [
+            "boolean"
+          ]
+        }
+      ]
+    },
+    {
+      "type": "FUNCTION",
+      "name": "restore",
+      "brief": "Reads back a session written by `store`.",
+      "description": "Reads back a session written by `store`.",
+      "parameters": [
+        {
+          "name": "id",
+          "doc": "The name the session was stored under. Defaults to `nakama`.",
+          "types": [
+            "string"
+          ],
+          "is_optional": "True"
+        }
+      ],
+      "returnvalues": [
+        {
+          "name": "",
+          "doc": "The stored session, or `nil` if nothing usable was stored under that name.",
+          "types": [
+            "Session | undefined"
+          ]
+        }
+      ]
+    },
+    {
+      "type": "TYPEDEF",
+      "name": "Session",
+      "properties": [
+        {
+          "name": "created",
+          "brief": "When `create` built this session, from `os.time()`.",
+          "description": "When `create` built this session, from `os.time()`.",
+          "types": [
+            "number"
+          ]
+        },
+        {
+          "name": "token",
+          "brief": "The access token the server issued, as the JWT string it arrived as.",
+          "description": "The access token the server issued, as the JWT string it arrived as.",
+          "types": [
+            "string"
+          ]
+        },
+        {
+          "name": "expires",
+          "brief": "The access token's `exp` claim, in seconds since the epoch.",
+          "description": "The access token's `exp` claim, in seconds since the epoch.",
+          "types": [
+            "number"
+          ]
+        },
+        {
+          "name": "username",
+          "brief": "The username the access token's `usn` claim carries.",
+          "description": "The username the access token's `usn` claim carries.",
+          "types": [
+            "string"
+          ]
+        },
+        {
+          "name": "user_id",
+          "brief": "The user id the access token's `uid` claim carries.",
+          "description": "The user id the access token's `uid` claim carries.",
+          "types": [
+            "string"
+          ]
+        },
+        {
+          "name": "vars",
+          "brief": "The session variables the access token's `vrs` claim carries, if any.",
+          "description": "The session variables the access token's `vrs` claim carries, if any.",
+          "types": [
+            "unknown"
+          ],
+          "is_optional": "True"
+        },
+        {
+          "name": "refresh_token",
+          "brief": "The refresh token the server issued, if the response carried one.",
+          "description": "The refresh token the server issued, if the response carried one.",
+          "types": [
+            "string"
+          ],
+          "is_optional": "True"
+        },
+        {
+          "name": "refresh_token_expires",
+          "brief": "The refresh token's `exp` claim, in seconds since the epoch.",
+          "description": "The refresh token's `exp` claim, in seconds since the epoch.",
+          "types": [
+            "number"
+          ],
+          "is_optional": "True"
+        },
+        {
+          "name": "refresh_token_username",
+          "brief": "The username the refresh token's `usn` claim carries.",
+          "description": "The username the refresh token's `usn` claim carries.",
+          "types": [
+            "string"
+          ],
+          "is_optional": "True"
+        },
+        {
+          "name": "refresh_token_user_id",
+          "brief": "The user id the refresh token's `uid` claim carries.",
+          "description": "The user id the refresh token's `uid` claim carries.",
+          "types": [
+            "string"
+          ],
+          "is_optional": "True"
+        },
+        {
+          "name": "refresh_token_vars",
+          "brief": "The session variables the refresh token's `vrs` claim carries.",
+          "description": "The session variables the refresh token's `vrs` claim carries.",
+          "types": [
+            "unknown"
+          ],
+          "is_optional": "True"
+        }
+      ]
+    },
+    {
+      "type": "TYPEDEF",
+      "name": "SessionData",
+      "properties": [
+        {
+          "name": "token",
+          "brief": "",
+          "description": "",
+          "types": [
+            "string"
+          ]
+        },
+        {
+          "name": "refresh_token",
+          "brief": "",
+          "description": "",
+          "types": [
+            "string"
+          ],
+          "is_optional": "True"
+        }
+      ]
+    }
+  ]
+}