@defold-typescript/types 0.52.0 → 0.53.0

package/src/engine-type-name.ts

@@ -0,0 +1,33 @@
+// Reference names the rule cannot split into words: the reference writes these
+// as one run of capitals, or runs a number into a word (Bullet spells the joint
+// `btGeneric6DofConstraint`).
+export const ENGINE_TYPE_NAME_OVERRIDES: ReadonlyMap<string, string> = new Map([
+  ["LIVEUPDATE", "LiveUpdate"],
+  ["PIEBOUNDS", "PieBounds"],
+  ["SYSFIELD", "SysField"],
+  ["USERFIELD", "UserField"],
+  ["generic_6dof_params", "Generic6DofParams"],
+  ["generic_6dof_spring_params", "Generic6DofSpringParams"],
+]);
+
+/**
+ * The PascalCase TypeScript name of a reference type leaf (`EASING` ->
+ * `Easing`, `sys_info` -> `SysInfo`, `b2Body` -> `B2Body`). A word written in
+ * one case is capitalized; a mixed-case word keeps its inner capitals.
+ */
+export function engineTypeName(
+  referenceLeaf: string,
+  overrides: ReadonlyMap<string, string> = ENGINE_TYPE_NAME_OVERRIDES,
+): string {
+  const override = overrides.get(referenceLeaf);
+  if (override !== undefined) return override;
+  return referenceLeaf
+    .split("_")
+    .filter((part) => part.length > 0)
+    .map((part) =>
+      part === part.toUpperCase() || part === part.toLowerCase()
+        ? part.charAt(0).toUpperCase() + part.slice(1).toLowerCase()
+        : part.charAt(0).toUpperCase() + part.slice(1),
+    )
+    .join("");
+}

package/src/go-overloads.d.ts

@@ -51,7 +51,7 @@ declare global {
      * const position = go.get("#sprite", "position");
      * // Name the target component to read its catalogued property type. The
      * // empty call applies the type argument, then the inner call infers the key:
-     * const animation = go.get<sprite.properties>()("#sprite", "animation"); // Hash
+     * const animation = go.get<sprite.Properties>()("#sprite", "animation"); // Hash
      * ```
      */
     function get<P>(): <K extends keyof P>(
@@ -59,15 +59,15 @@ declare global {
       property: K,
       ...options: [] | [GoPropertyOptions]
     ) => P[K];
-    function get<K extends keyof go.properties>(
+    function get<K extends keyof go.Properties>(
       url: SceneAddress | Hash | Url,
       property: K,
-    ): go.properties[K];
-    function get<K extends keyof go.properties>(
+    ): go.Properties[K];
+    function get<K extends keyof go.Properties>(
       url: SceneAddress | Hash | Url,
       property: K,
       options: GoPropertyOptions,
-    ): go.properties[K];
+    ): go.Properties[K];
     function get(
       url: SceneAddress | Hash | Url,
       property: string | Hash,
@@ -114,7 +114,7 @@ declare global {
      * // Name the target component to gate the value to its property type. The
      * // empty call applies the type argument, then the inner call infers the key.
      * // A read-only property such as "animation" is not a key it accepts:
-     * go.set<sprite.properties>()("#sprite", "playback_rate", 2);
+     * go.set<sprite.Properties>()("#sprite", "playback_rate", 2);
      * ```
      */
     function set<P>(): <K extends WritableKey<P>>(
@@ -123,15 +123,15 @@ declare global {
       value: P[K],
       ...options: [] | [GoPropertyOptions]
     ) => void;
-    function set<K extends keyof go.properties>(
+    function set<K extends keyof go.Properties>(
       url: SceneAddress | Hash | Url,
       property: K,
-      value: go.properties[K],
+      value: go.Properties[K],
     ): void;
-    function set<K extends keyof go.properties>(
+    function set<K extends keyof go.Properties>(
       url: SceneAddress | Hash | Url,
       property: K,
-      value: go.properties[K],
+      value: go.Properties[K],
       options: GoPropertyOptions,
     ): void;
     function set(

package/src/gui-overloads.d.ts

@@ -17,17 +17,17 @@ type PropName<P> = P extends { readonly __brand: `gui.PROP_${infer S}` } ? Lower
 // gui.cpp g_Properties: these four have no `.x`..`.w` sub-keys.
 type ScalarName = "inner_radius" | "fill_angle" | "leading" | "tracking";
 
-type VectorName = Exclude<PropName<gui.Property>, ScalarName>;
+type VectorName = Exclude<PropName<gui.Prop>, ScalarName>;
 
-type NodePropertyName<K> = K extends keyof gui.node_properties
+type NodePropertyName<K> = K extends keyof gui.NodeProperties
   ? K
-  : Extract<PropName<K>, keyof gui.node_properties>;
+  : Extract<PropName<K>, keyof gui.NodeProperties>;
 
 // gui_script.cpp:LuaSet: `rotation` takes only a quat, every other vector a
 // vector4 or a vector3, and a sub-key or scalar a number.
-type NodePropertyWrite<N extends keyof gui.node_properties> = N extends "rotation"
+type NodePropertyWrite<N extends keyof gui.NodeProperties> = N extends "rotation"
   ? Quaternion
-  : gui.node_properties[N] extends number
+  : gui.NodeProperties[N] extends number
     ? number
     : Vector4 | Vector3;
 
@@ -38,7 +38,7 @@ declare global {
      * property reads as a vmath.vector4 and `rotation` as a vmath.quat; their
      * `.x`..`.w` sub-keys and the four scalar properties read as a number.
      */
-    type node_properties = {
+    type NodeProperties = {
       [K in
         | VectorName
         | `${VectorName}.${"x" | "y" | "z" | "w"}`
@@ -87,10 +87,10 @@ declare global {
      * const node_position = gui.get(node, "position");
      * ```
      */
-    function get<K extends keyof gui.node_properties | gui.Property>(
+    function get<K extends keyof gui.NodeProperties | gui.Prop>(
       node: Opaque<"node">,
       property: K,
-    ): gui.node_properties[NodePropertyName<K>];
+    ): gui.NodeProperties[NodePropertyName<K>];
     /**
      * Gets a material constant of a node, or any property named by a hash. Pass
      * the constant's name as a hash, such as `hash("tint")`. Reading an array
@@ -173,7 +173,7 @@ declare global {
      * gui.set_rotation(node, vmath.vector3(0, 0, 45));
      * ```
      */
-    function set<K extends keyof gui.node_properties | gui.Property>(
+    function set<K extends keyof gui.NodeProperties | gui.Prop>(
       node: Opaque<"node">,
       property: K,
       value: NodePropertyWrite<NodePropertyName<K>>,
@@ -393,7 +393,7 @@ declare global {
      */
     function animate(
       node: Opaque<"node">,
-      property: keyof gui.node_properties | gui.Property | Hash,
+      property: keyof gui.NodeProperties | gui.Prop | Hash,
       to: number | Vector3 | Vector4 | Quaternion,
       easing: gui.Easing | Vector,
       duration: number,
@@ -477,7 +477,7 @@ declare global {
      */
     function animate(
       node: Opaque<"node">,
-      property: keyof gui.node_properties | gui.Property | Hash,
+      property: keyof gui.NodeProperties | gui.Prop | Hash,
       to: number | Vector3 | Vector4 | Quaternion,
       easing: gui.Easing | Vector,
       duration: number,

package/src/index.ts

@@ -67,6 +67,7 @@ export {
   TS_IDENTIFIER,
   TS_RESERVED_NAMES,
 } from "./emit-dts";
+export { ENGINE_TYPE_NAME_OVERRIDES, engineTypeName } from "./engine-type-name";
 export {
   hashExampleSource,
   lookupExampleSegments,

package/src/lifecycle.ts

@@ -1,6 +1,6 @@
 import type { Hash, Url } from "./core-types";
 
-// Fields and docs follow the go ref-doc's `on_input.touch` STRUCT, whose keys are
+// Fields and docs follow the go ref-doc's `on_input.touch` STRUCT (`go.on_input.Touch`), whose keys are
 // the ones comp_script.cpp pushes; lifecycle-member-docs drift-guards the docs
 // against it, and a ref-doc re-pin is reconciled by hand.
 export interface InputTouch {
@@ -54,7 +54,7 @@ export interface InputTouch {
   screen_dy: number;
 }
 
-// Fields and docs follow the go ref-doc's `on_input.action` STRUCT, whose keys are
+// Fields and docs follow the go ref-doc's `on_input.action` STRUCT (`go.on_input.Action`), whose keys are
 // the ones comp_script.cpp pushes; lifecycle-member-docs drift-guards the docs
 // against it, and a ref-doc re-pin is reconciled by hand.
 export interface InputAction {

package/src/socket-types.d.ts

@@ -9,7 +9,7 @@
 //
 //   const opt: socket.TCPOptions = 'keepalive';
 //   // TCP/UDP are convenience intersections for consumer annotations;
-//   // no socket.* function returns them (tcp() yields a `master` handle).
+//   // no socket.* function returns them (tcp() yields a `SocketMaster` handle).
 //
 // The literal unions are LuaSocket-domain, not engine-ref-doc, so they live
 // here rather than in the regen pipeline.
@@ -17,7 +17,7 @@
 declare global {
   namespace socket {
     /** A TCP handle in any of its three lifecycle roles. */
-    type TCP = client & master & server;
+    type TCP = SocketClient & SocketMaster & SocketServer;
     /** Option names accepted by a TCP handle's `setoption`. */
     type TCPOptions = "ipv6-v6only" | "keepalive" | "linger" | "reuseaddr" | "tcp-nodelay";
     /** Error string a TCP `receive` may return. */
@@ -29,7 +29,7 @@ declare global {
     /** Blocking mode passed to a TCP handle's `settimeout`. */
     type TCPTimeoutMode = "b" | "t";
     /** A UDP handle in either of its two lifecycle roles. */
-    type UDP = connected & unconnected;
+    type UDP = SocketConnected & SocketUnconnected;
     /** Option names accepted by a UDP handle's `setoption`. */
     type UDPOptions =
       | "broadcast"