c64bridge 0.9.3 → 1.0.1

package/generated/c64/index.js

@@ -8,6 +8,90 @@
  * ## SOURCE: https://github.com/acacode/swagger-typescript-api ##
  * ---------------------------------------------------------------
  */
+export var InputTransition;
+(function (InputTransition) {
+    InputTransition["Press"] = "press";
+    InputTransition["Release"] = "release";
+    InputTransition["Tap"] = "tap";
+})(InputTransition || (InputTransition = {}));
+export var KeyboardInput;
+(function (KeyboardInput) {
+    KeyboardInput["InstDel"] = "inst_del";
+    KeyboardInput["Return"] = "return";
+    KeyboardInput["CursorLeftRight"] = "cursor_left_right";
+    KeyboardInput["F7"] = "f7";
+    KeyboardInput["F1"] = "f1";
+    KeyboardInput["F3"] = "f3";
+    KeyboardInput["F5"] = "f5";
+    KeyboardInput["CursorUpDown"] = "cursor_up_down";
+    KeyboardInput["Value0"] = "0";
+    KeyboardInput["Value1"] = "1";
+    KeyboardInput["Value2"] = "2";
+    KeyboardInput["Value3"] = "3";
+    KeyboardInput["Value4"] = "4";
+    KeyboardInput["Value5"] = "5";
+    KeyboardInput["Value6"] = "6";
+    KeyboardInput["Value7"] = "7";
+    KeyboardInput["Value8"] = "8";
+    KeyboardInput["Value9"] = "9";
+    KeyboardInput["A"] = "a";
+    KeyboardInput["B"] = "b";
+    KeyboardInput["C"] = "c";
+    KeyboardInput["D"] = "d";
+    KeyboardInput["E"] = "e";
+    KeyboardInput["F"] = "f";
+    KeyboardInput["G"] = "g";
+    KeyboardInput["H"] = "h";
+    KeyboardInput["I"] = "i";
+    KeyboardInput["J"] = "j";
+    KeyboardInput["K"] = "k";
+    KeyboardInput["L"] = "l";
+    KeyboardInput["M"] = "m";
+    KeyboardInput["N"] = "n";
+    KeyboardInput["O"] = "o";
+    KeyboardInput["P"] = "p";
+    KeyboardInput["Q"] = "q";
+    KeyboardInput["R"] = "r";
+    KeyboardInput["S"] = "s";
+    KeyboardInput["T"] = "t";
+    KeyboardInput["U"] = "u";
+    KeyboardInput["V"] = "v";
+    KeyboardInput["W"] = "w";
+    KeyboardInput["X"] = "x";
+    KeyboardInput["Y"] = "y";
+    KeyboardInput["Z"] = "z";
+    KeyboardInput["LeftShift"] = "left_shift";
+    KeyboardInput["RightShift"] = "right_shift";
+    KeyboardInput["Plus"] = "plus";
+    KeyboardInput["Minus"] = "minus";
+    KeyboardInput["Period"] = "period";
+    KeyboardInput["Colon"] = "colon";
+    KeyboardInput["At"] = "at";
+    KeyboardInput["Comma"] = "comma";
+    KeyboardInput["Pound"] = "pound";
+    KeyboardInput["Star"] = "star";
+    KeyboardInput["Semicolon"] = "semicolon";
+    KeyboardInput["ClrHome"] = "clr_home";
+    KeyboardInput["Equals"] = "equals";
+    KeyboardInput["ArrowUp"] = "arrow_up";
+    KeyboardInput["Slash"] = "slash";
+    KeyboardInput["ArrowLeft"] = "arrow_left";
+    KeyboardInput["Ctrl"] = "ctrl";
+    KeyboardInput["Space"] = "space";
+    KeyboardInput["Commodore"] = "commodore";
+    KeyboardInput["RunStop"] = "run_stop";
+    KeyboardInput["Restore"] = "restore";
+})(KeyboardInput || (KeyboardInput = {}));
+export var JoystickInput;
+(function (JoystickInput) {
+    JoystickInput["Up"] = "up";
+    JoystickInput["Down"] = "down";
+    JoystickInput["Left"] = "left";
+    JoystickInput["Right"] = "right";
+    JoystickInput["Fire"] = "fire";
+    JoystickInput["Fire2"] = "fire2";
+    JoystickInput["Fire3"] = "fire3";
+})(JoystickInput || (JoystickInput = {}));
 import axios from "axios";
 export var ContentType;
 (function (ContentType) {
@@ -91,15 +175,18 @@ export class HttpClient {
  * @baseUrl http://c64u
  *
  * This OpenAPI document captures the public HTTP interface described in the
- * official Ultimate 64 REST API documentation. Responses always include an
- * `errors` array unless noted. When a network password is configured, clients
- * must supply the `X-Password` header on every request.
+ * official Ultimate 64 REST API documentation at
+ * https://1541u-documentation.readthedocs.io/en/latest/api/api_calls.html.
+ * Responses always include an `errors` array unless noted. When a network
+ * password is configured, clients must supply the `X-Password` header on every
+ * request. Example payloads were captured against a local Ultimate 64 Elite
+ * reachable as `http://c64u` running firmware 3.12a.
  */
 export class Api {
     constructor(http) {
         this.v1 = {
             /**
-             * No description
+             * @description Returns the firmware-defined REST API semantic version.
              *
              * @name VersionList
              * @summary Get API version
@@ -114,7 +201,7 @@ export class Api {
                 ...params,
             }),
             /**
-             * No description
+             * @description Returns hardware metadata (product, firmware version, FPGA/core versions, hostname). Available on Ultimate firmware 3.12 and newer. On earlier releases the endpoint responds with HTTP 404.
              *
              * @name InfoList
              * @summary Get device information
@@ -291,7 +378,7 @@ export class Api {
                 ...params,
             }),
             /**
-             * No description
+             * @description Enumerates top-level configuration pages as displayed in the Ultimate menu. Supports wildcard queries via URL encoding.
              *
              * @name ConfigsList
              * @summary List configuration categories
@@ -323,7 +410,7 @@ export class Api {
                 ...params,
             }),
             /**
-             * No description
+             * @description Returns all items inside the specified category. Wildcards may match multiple categories; each appears as an object property in the response.
              *
              * @name ConfigsDetail
              * @summary Inspect category
@@ -539,7 +626,7 @@ export class Api {
                 ...params,
             }),
             /**
-             * No description
+             * @description Performs a DMA read at the requested address. Firmware returns either a JSON wrapper or raw bytes. Use `length` to limit the transfer (default 256 bytes).
              *
              * @name MachineReadmemList
              * @summary Read memory
@@ -554,6 +641,52 @@ export class Api {
                 format: "json",
                 ...params,
             }),
+            /**
+             * @description Returns raw character and colour matrix bytes, or 404 when no Ultimate menu is active.
+             *
+             * @name MachineMenuScreenList
+             * @summary Read the active Ultimate menu screen matrix
+             * @request GET:/v1/machine:menu_screen
+             * @secure
+             */
+            machineMenuScreenList: (menuScreen, params = {}) => this.http.request({
+                path: `/v1/machine${menuScreen}`,
+                method: "GET",
+                secure: true,
+                ...params,
+            }),
+            /**
+             * No description
+             *
+             * @name MachineInputList
+             * @summary Read REST-injected keyboard and joystick state
+             * @request GET:/v1/machine:input
+             * @secure
+             */
+            machineInputList: (input, params = {}) => this.http.request({
+                path: `/v1/machine${input}`,
+                method: "GET",
+                secure: true,
+                format: "json",
+                ...params,
+            }),
+            /**
+             * No description
+             *
+             * @name MachineInputCreate
+             * @summary Apply keyboard and joystick input events
+             * @request POST:/v1/machine:input
+             * @secure
+             */
+            machineInputCreate: (input, data, params = {}) => this.http.request({
+                path: `/v1/machine${input}`,
+                method: "POST",
+                body: data,
+                secure: true,
+                type: ContentType.Json,
+                format: "json",
+                ...params,
+            }),
             /**
              * No description
              *
@@ -586,7 +719,7 @@ export class Api {
                 ...params,
             }),
             /**
-             * No description
+             * @description Returns current Ultimate-managed drives, images, and service devices (SoftIEC, printer emulation).
              *
              * @name DrivesList
              * @summary List internal drives