@galaxy-tool-util/gxwf-client 0.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 John Chilton
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.d.ts

@@ -0,0 +1,31 @@
+/**
+ * @module @galaxy-tool-util/gxwf-client
+ *
+ * Typed HTTP client for the gxwf-web Galaxy workflow server.
+ *
+ * @example
+ * ```ts
+ * import { createGxwfClient } from "@galaxy-tool-util/gxwf-client";
+ *
+ * const client = createGxwfClient("http://localhost:8000");
+ *
+ * const { data, error } = await client.GET("/workflows", {});
+ * const { data: report } = await client.GET("/workflows/{workflow_path}/validate", {
+ *   params: { path: { workflow_path: "my_workflow.ga" } },
+ * });
+ * ```
+ */
+import type { Client, ClientOptions } from "openapi-fetch";
+import type { paths, components, operations } from "@galaxy-tool-util/gxwf-web";
+export type { paths, components, operations };
+export type { Client, ClientOptions };
+/** A fully-typed gxwf-web HTTP client. */
+export type GxwfClient = Client<paths>;
+/**
+ * Create a typed HTTP client pointed at a gxwf-web server.
+ *
+ * @param baseUrl - Base URL of the gxwf-web server (e.g. "http://localhost:8000")
+ * @param options - Additional openapi-fetch ClientOptions (headers, custom fetch, etc.)
+ */
+export declare function createGxwfClient(baseUrl: string, options?: Omit<ClientOptions, "baseUrl">): GxwfClient;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAGH,OAAO,KAAK,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAC3D,OAAO,KAAK,EAAE,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AAEhF,YAAY,EAAE,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,CAAC;AAC9C,YAAY,EAAE,MAAM,EAAE,aAAa,EAAE,CAAC;AAEtC,0CAA0C;AAC1C,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;AAEvC;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAC9B,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,IAAI,CAAC,aAAa,EAAE,SAAS,CAAC,GACvC,UAAU,CAEZ"}

package/dist/index.js

@@ -0,0 +1,28 @@
+/**
+ * @module @galaxy-tool-util/gxwf-client
+ *
+ * Typed HTTP client for the gxwf-web Galaxy workflow server.
+ *
+ * @example
+ * ```ts
+ * import { createGxwfClient } from "@galaxy-tool-util/gxwf-client";
+ *
+ * const client = createGxwfClient("http://localhost:8000");
+ *
+ * const { data, error } = await client.GET("/workflows", {});
+ * const { data: report } = await client.GET("/workflows/{workflow_path}/validate", {
+ *   params: { path: { workflow_path: "my_workflow.ga" } },
+ * });
+ * ```
+ */
+import createClient from "openapi-fetch";
+/**
+ * Create a typed HTTP client pointed at a gxwf-web server.
+ *
+ * @param baseUrl - Base URL of the gxwf-web server (e.g. "http://localhost:8000")
+ * @param options - Additional openapi-fetch ClientOptions (headers, custom fetch, etc.)
+ */
+export function createGxwfClient(baseUrl, options) {
+    return createClient({ baseUrl, ...options });
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAEH,OAAO,YAAY,MAAM,eAAe,CAAC;AAUzC;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAC9B,OAAe,EACf,OAAwC;IAExC,OAAO,YAAY,CAAQ,EAAE,OAAO,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;AACtD,CAAC"}

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@galaxy-tool-util/gxwf-client",
+  "version": "0.0.0",
+  "description": "Typed HTTP client for the gxwf-web Galaxy workflow server",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/jmchilton/galaxy-tool-util-ts",
+    "directory": "packages/gxwf-client"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "license": "MIT",
+  "dependencies": {
+    "openapi-fetch": "^0.13.8",
+    "@galaxy-tool-util/gxwf-web": "0.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^25.5.0"
+  },
+  "scripts": {
+    "build": "tsc",
+    "typecheck": "tsc --noEmit",
+    "test": "tsc --noEmit && vitest run",
+    "test:watch": "vitest",
+    "lint": "eslint src/ test/",
+    "format": "prettier --check 'src/**/*.ts' 'test/**/*.ts'",
+    "format-fix": "prettier --write 'src/**/*.ts' 'test/**/*.ts'"
+  }
+}