cyberdesk 0.1.3 → 0.2.0

package/README.md

@@ -16,74 +16,88 @@ pnpm add cyberdesk
 
 ## Usage
 
-First, configure the client, for example, by setting default headers for authentication. You only need to do this once.
+First, create a Cyberdesk client instance with your API key:
 
 ```typescript
-import { client, setConfig } from 'cyberdesk/client'; // Import client and setConfig
+import { createCyberdeskClient } from 'cyberdesk';
 
-// Configure the client (e.g., with an API Key)
-// Adjust based on your actual authentication method
-setConfig({
-  headers: {
-    'Authorization': `Bearer YOUR_API_KEY`
+const cyberdesk = createCyberdeskClient({
+  apiKey: 'YOUR_API_KEY',
+  // Optionally, you can override the baseUrl or provide a custom fetch implementation
+});
+```
+
+### Launch a Desktop
+
+```typescript
+const launchResult = await cyberdesk.launchDesktop({
+  body: { timeout_ms: 10000 } // Optional: set a timeout for the desktop session
+});
+
+if (launchResult.error) {
+  throw new Error('Failed to launch desktop: ' + launchResult.error.error);
+}
+
+const desktopId = launchResult.id;
+console.log('Launched desktop with ID:', desktopId);
+```
+
+### Get Desktop Info
+
+```typescript
+const info = await cyberdesk.getDesktop({
+  path: { id: desktopId }
+});
+
+if ('error' in info) {
+  throw new Error('Failed to get desktop info: ' + info.error);
+}
+
+console.log('Desktop info:', info);
+```
+
+### Perform a Computer Action (e.g., Mouse Click)
+
+```typescript
+const actionResult = await cyberdesk.executeComputerAction({
+  path: { id: desktopId },
+  body: {
+    type: 'click_mouse',
+    x: 100,
+    y: 150
   }
 });
+
+if (actionResult.error) {
+  throw new Error('Action failed: ' + actionResult.error);
+}
+
+console.log('Action result:', actionResult);
 ```
 
-Then, import and call the specific API functions you need:
+### Run a Bash Command
 
 ```typescript
-import {
-  postV1Desktop,
-  postV1DesktopIdComputerAction,
-  type PostV1DesktopData,
-  type PostV1DesktopIdComputerActionData
-} from 'cyberdesk';
-
-async function createAndInteract() {
-  try {
-    // 1. Create a new desktop
-    console.log('Creating desktop...');
-    const createResponse = await postV1Desktop({
-      // Pass request body parameters inside the 'data' object
-      data: {
-         timeoutMs: 10000 
-      }
-      // Headers like Authorization should be set globally via setConfig (see above)
-    });
-
-    if (!createResponse.data) {
-       throw new Error('Failed to create desktop: ' + (createResponse.error?.message || 'Unknown error'));
-    }
-
-    const desktopId = createResponse.data.id; // Assuming the response has an ID
-    console.log(`Desktop created with ID: ${desktopId}`);
-
-    // 2. Perform an action (e.g., a mouse click)
-    console.log(`Performing action on desktop ${desktopId}...`);
-    const actionData: PostV1DesktopIdComputerActionData['data'] = {
-        type: 'click_mouse', // Example action type
-        x: 100,
-        y: 150
-    };
-    
-    const actionResponse = await postV1DesktopIdComputerAction({
-      path: { id: desktopId }, // Provide path parameters
-      data: actionData // Provide request body data
-    });
-
-    if (actionResponse.error) {
-      throw new Error(`Action failed: ${actionResponse.error.message}`);
-    }
-
-    console.log('Action successful:', actionResponse.data);
-
-  } catch (error) {
-    console.error('Error using Cyberdesk SDK:', error);
+const bashResult = await cyberdesk.executeBashAction({
+  path: { id: desktopId },
+  body: {
+    command: 'echo Hello, world!'
   }
+});
+
+if (bashResult.error) {
+  throw new Error('Bash command failed: ' + bashResult.error);
 }
 
-createAndInteract();
+console.log('Bash output:', bashResult.output);
+```
+
+## TypeScript Support
+
+All request parameter types and the `CyberdeskSDK` type are exported for convenience:
+
+```typescript
+import type { LaunchDesktopParams, CyberdeskSDK } from 'cyberdesk';
 ```
 
 ## License

package/dist/client/sdk.gen.js

@@ -9,7 +9,7 @@ const client_gen_1 = require("./client.gen");
  */
 const getV1DesktopId = (options) => {
     var _a;
-    return ((_a = options.client) !== null && _a !== void 0 ? _a : client_gen_1.client).get(Object.assign({ url: '/v1/desktop/:id' }, options));
+    return ((_a = options.client) !== null && _a !== void 0 ? _a : client_gen_1.client).get(Object.assign({ url: '/v1/desktop/{id}' }, options));
 };
 exports.getV1DesktopId = getV1DesktopId;
 /**
@@ -27,7 +27,7 @@ exports.postV1Desktop = postV1Desktop;
  */
 const postV1DesktopIdStop = (options) => {
     var _a;
-    return ((_a = options.client) !== null && _a !== void 0 ? _a : client_gen_1.client).post(Object.assign({ url: '/v1/desktop/:id/stop' }, options));
+    return ((_a = options.client) !== null && _a !== void 0 ? _a : client_gen_1.client).post(Object.assign({ url: '/v1/desktop/{id}/stop' }, options));
 };
 exports.postV1DesktopIdStop = postV1DesktopIdStop;
 /**
@@ -36,7 +36,7 @@ exports.postV1DesktopIdStop = postV1DesktopIdStop;
  */
 const postV1DesktopIdComputerAction = (options) => {
     var _a;
-    return ((_a = options.client) !== null && _a !== void 0 ? _a : client_gen_1.client).post(Object.assign(Object.assign({ url: '/v1/desktop/:id/computer-action' }, options), { headers: Object.assign({ 'Content-Type': 'application/json' }, options === null || options === void 0 ? void 0 : options.headers) }));
+    return ((_a = options.client) !== null && _a !== void 0 ? _a : client_gen_1.client).post(Object.assign(Object.assign({ url: '/v1/desktop/{id}/computer-action' }, options), { headers: Object.assign({ 'Content-Type': 'application/json' }, options === null || options === void 0 ? void 0 : options.headers) }));
 };
 exports.postV1DesktopIdComputerAction = postV1DesktopIdComputerAction;
 /**
@@ -45,6 +45,6 @@ exports.postV1DesktopIdComputerAction = postV1DesktopIdComputerAction;
  */
 const postV1DesktopIdBashAction = (options) => {
     var _a;
-    return ((_a = options.client) !== null && _a !== void 0 ? _a : client_gen_1.client).post(Object.assign(Object.assign({ url: '/v1/desktop/:id/bash-action' }, options), { headers: Object.assign({ 'Content-Type': 'application/json' }, options === null || options === void 0 ? void 0 : options.headers) }));
+    return ((_a = options.client) !== null && _a !== void 0 ? _a : client_gen_1.client).post(Object.assign(Object.assign({ url: '/v1/desktop/{id}/bash-action' }, options), { headers: Object.assign({ 'Content-Type': 'application/json' }, options === null || options === void 0 ? void 0 : options.headers) }));
 };
 exports.postV1DesktopIdBashAction = postV1DesktopIdBashAction;

package/dist/index.d.ts

@@ -1,6 +1,5 @@
-import { createClient, type Options as ClientOptions } from '@hey-api/client-fetch';
+import { type Options as ClientOptions } from '@hey-api/client-fetch';
 import * as apiMethods from './client/sdk.gen';
-export * from './client/types.gen';
 import { type GetV1DesktopIdData, type PostV1DesktopData, type PostV1DesktopIdStopData, type PostV1DesktopIdComputerActionData, type PostV1DesktopIdBashActionData } from './client/types.gen';
 type FetchFn = (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>;
 /**
@@ -16,12 +15,17 @@ export interface CyberdeskClientOptions {
     /** Optional: Provide additional default options for the underlying client (e.g., timeout, keepalive). */
     clientOptions?: Partial<ClientOptions>;
 }
-export type CyberdeskSdk = {
-    getDesktopInfo: (opts: Omit<GetV1DesktopIdData, 'headers' | 'url'>) => ReturnType<typeof apiMethods.getV1DesktopId>;
-    launchDesktop: (opts: Omit<PostV1DesktopData, 'headers' | 'url'>) => ReturnType<typeof apiMethods.postV1Desktop>;
-    terminateDesktop: (opts: Omit<PostV1DesktopIdStopData, 'headers' | 'url'>) => ReturnType<typeof apiMethods.postV1DesktopIdStop>;
-    executeActionOnDesktop: (opts: Omit<PostV1DesktopIdComputerActionData, 'headers' | 'url'>) => ReturnType<typeof apiMethods.postV1DesktopIdComputerAction>;
-    bashCommandOnDesktop: (opts: Omit<PostV1DesktopIdBashActionData, 'headers' | 'url'>) => ReturnType<typeof apiMethods.postV1DesktopIdBashAction>;
+export type GetDesktopParams = Omit<GetV1DesktopIdData, 'headers' | 'url'>;
+export type LaunchDesktopParams = Omit<PostV1DesktopData, 'headers' | 'url'>;
+export type TerminateDesktopParams = Omit<PostV1DesktopIdStopData, 'headers' | 'url'>;
+export type ExecuteComputerActionParams = Omit<PostV1DesktopIdComputerActionData, 'headers' | 'url'>;
+export type ExecuteBashActionParams = Omit<PostV1DesktopIdBashActionData, 'headers' | 'url'>;
+export type CyberdeskSDK = {
+    getDesktop: (opts: GetDesktopParams) => ReturnType<typeof apiMethods.getV1DesktopId>;
+    launchDesktop: (opts: LaunchDesktopParams) => ReturnType<typeof apiMethods.postV1Desktop>;
+    terminateDesktop: (opts: TerminateDesktopParams) => ReturnType<typeof apiMethods.postV1DesktopIdStop>;
+    executeComputerAction: (opts: ExecuteComputerActionParams) => ReturnType<typeof apiMethods.postV1DesktopIdComputerAction>;
+    executeBashAction: (opts: ExecuteBashActionParams) => ReturnType<typeof apiMethods.postV1DesktopIdBashAction>;
 };
 /**
  * Creates a Cyberdesk SDK instance configured with your API key.
@@ -29,6 +33,5 @@ export type CyberdeskSdk = {
  * @param options - Configuration options including the API key.
  * @returns An SDK instance with methods ready to be called.
  */
-export declare function createCyberdeskClient(options: CyberdeskClientOptions): CyberdeskSdk;
-export { createClient };
-export * as rawApiMethods from './client/sdk.gen';
+export declare function createCyberdeskClient(options: CyberdeskClientOptions): CyberdeskSDK;
+export {};

package/dist/index.js

@@ -33,18 +33,11 @@ var __importStar = (this && this.__importStar) || (function () {
         return result;
     };
 })();
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.rawApiMethods = exports.createClient = void 0;
 exports.createCyberdeskClient = createCyberdeskClient;
 const client_fetch_1 = require("@hey-api/client-fetch");
-Object.defineProperty(exports, "createClient", { enumerable: true, get: function () { return client_fetch_1.createClient; } });
-const apiMethods = __importStar(require("./client/sdk.gen")); // Import the generated methods
-// Re-export all types from types.gen for user convenience
-__exportStar(require("./client/types.gen"), exports);
-const DEFAULT_BASE_URL = 'https://api.cyberdesk.io'; // Replace if needed
+const apiMethods = __importStar(require("./client/sdk.gen"));
+const DEFAULT_BASE_URL = 'https://api.cyberdesk.io';
 /**
  * Creates a Cyberdesk SDK instance configured with your API key.
  *
@@ -56,29 +49,16 @@ function createCyberdeskClient(options) {
     if (!apiKey) {
         throw new Error('Cyberdesk SDK requires an `apiKey` to be provided.');
     }
-    // Ensure baseUrl is string | undefined before use
     const finalBaseUrl = baseUrl;
-    // Prepare headers, merging defaults with any provided in clientOptions
     const mergedHeaders = Object.assign({ 'x-api-key': apiKey, 'Content-Type': 'application/json' }, (clientOptions.headers || {}));
-    // Construct the final options for createClient explicitly
-    const finalClientOptions = Object.assign({ 
-        // Set base URL
-        baseUrl: finalBaseUrl, 
-        // Set merged headers
-        headers: mergedHeaders }, (customFetch && { fetch: customFetch }));
-    // Pass the inferred options object directly
+    const finalClientOptions = Object.assign({ baseUrl: finalBaseUrl, headers: mergedHeaders }, (customFetch && { fetch: customFetch }));
     const configuredClient = (0, client_fetch_1.createClient)(finalClientOptions);
     // Return an object where each method is pre-configured with the client instance
     return {
-        getDesktopInfo: (opts) => apiMethods.getV1DesktopId(Object.assign(Object.assign({}, opts), { client: configuredClient, 
-            // Merge client headers with potentially provided headers from opts
-            headers: Object.assign(Object.assign({}, mergedHeaders), opts.headers) })),
+        getDesktop: (opts) => apiMethods.getV1DesktopId(Object.assign(Object.assign({}, opts), { client: configuredClient, headers: Object.assign(Object.assign({}, mergedHeaders), opts.headers) })),
         launchDesktop: (opts) => apiMethods.postV1Desktop(Object.assign(Object.assign({}, opts), { client: configuredClient, headers: Object.assign(Object.assign({}, mergedHeaders), opts.headers) })),
-        terminateDesktop: (opts) => apiMethods.postV1DesktopIdStop(Object.assign(Object.assign({}, opts), { client: configuredClient, headers: Object.assign(Object.assign({}, mergedHeaders), opts.headers) })),
-        executeActionOnDesktop: (opts) => apiMethods.postV1DesktopIdComputerAction(Object.assign(Object.assign({}, opts), { client: configuredClient, headers: Object.assign(Object.assign({}, mergedHeaders), opts.headers) })),
-        bashCommandOnDesktop: (opts) => apiMethods.postV1DesktopIdBashAction(Object.assign(Object.assign({}, opts), { client: configuredClient, headers: Object.assign(Object.assign({}, mergedHeaders), opts.headers) })),
-        // Add bindings for other generated methods here following the same pattern
+        terminateDesktop: (opts) => apiMethods.postV1DesktopIdStop(Object.assign(Object.assign({}, opts), { path: Object.assign(Object.assign({}, opts.path), { id: opts.path.id }), client: configuredClient, headers: Object.assign(Object.assign({}, mergedHeaders), opts.headers) })),
+        executeComputerAction: (opts) => apiMethods.postV1DesktopIdComputerAction(Object.assign(Object.assign({}, opts), { client: configuredClient, headers: Object.assign(Object.assign({}, mergedHeaders), opts.headers) })),
+        executeBashAction: (opts) => apiMethods.postV1DesktopIdBashAction(Object.assign(Object.assign({}, opts), { client: configuredClient, headers: Object.assign(Object.assign({}, mergedHeaders), opts.headers) })),
     };
 }
-// Optional: Export the underlying api methods if needed, though usually accessed via the sdk instance
-exports.rawApiMethods = __importStar(require("./client/sdk.gen"));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cyberdesk",
-  "version": "0.1.3",
+  "version": "0.2.0",
   "description": "The official TypeScript SDK for Cyberdesk",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -10,7 +10,7 @@
     "README.md"
   ],
   "scripts": {
-    "generate": "openapi-ts",
+    "generate": "openapi-ts && node scripts/fix-routes.js",
     "build": "npm run generate && tsc",
     "prepublishOnly": "npm run build"
   },