@gleanwork/api-client 0.4.2 → 0.4.4

package/docs/sdks/tools/README.md

@@ -0,0 +1,214 @@
+# Tools
+(*client.tools*)
+
+## Overview
+
+### Available Operations
+
+* [list](#list) - List available tools
+* [run](#run) - Execute the specified tool
+
+## list
+
+Returns a filtered set of available tools based on optional tool name parameters. If no filters are provided, all available tools are returned.
+
+### Example Usage
+
+```typescript
+import { Glean } from "@gleanwork/api-client";
+
+const glean = new Glean({
+  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+});
+
+async function run() {
+  const result = await glean.client.tools.list();
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { GleanCore } from "@gleanwork/api-client/core.js";
+import { clientToolsList } from "@gleanwork/api-client/funcs/clientToolsList.js";
+
+// Use `GleanCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const glean = new GleanCore({
+  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+});
+
+async function run() {
+  const res = await clientToolsList(glean);
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### React hooks and utilities
+
+This method can be used in React components through the following hooks and
+associated utilities.
+
+> Check out [this guide][hook-guide] for information about each of the utilities
+> below and how to get started using React hooks.
+
+[hook-guide]: ../../../REACT_QUERY.md
+
+```tsx
+import {
+  // Query hooks for fetching data.
+  useClientToolsList,
+  useClientToolsListSuspense,
+
+  // Utility for prefetching data during server-side rendering and in React
+  // Server Components that will be immediately available to client components
+  // using the hooks.
+  prefetchClientToolsList,
+  
+  // Utilities to invalidate the query cache for this query in response to
+  // mutations and other user actions.
+  invalidateClientToolsList,
+  invalidateAllClientToolsList,
+} from "@gleanwork/api-client/react-query/clientToolsList.js";
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `toolNames`                                                                                                                                                                    | *string*[]                                                                                                                                                                     | :heavy_minus_sign:                                                                                                                                                             | Optional array of tool names to filter by                                                                                                                                      |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[components.ToolsListResponse](../../models/components/toolslistresponse.md)\>**
+
+### Errors
+
+| Error Type        | Status Code       | Content Type      |
+| ----------------- | ----------------- | ----------------- |
+| errors.GleanError | 4XX, 5XX          | \*/\*             |
+
+## run
+
+Execute the specified tool with provided parameters
+
+### Example Usage
+
+```typescript
+import { Glean } from "@gleanwork/api-client";
+
+const glean = new Glean({
+  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+});
+
+async function run() {
+  const result = await glean.client.tools.run({
+    name: "<value>",
+    parameters: {
+      "key": {
+        name: "<value>",
+        value: "<value>",
+      },
+    },
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { GleanCore } from "@gleanwork/api-client/core.js";
+import { clientToolsRun } from "@gleanwork/api-client/funcs/clientToolsRun.js";
+
+// Use `GleanCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const glean = new GleanCore({
+  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+});
+
+async function run() {
+  const res = await clientToolsRun(glean, {
+    name: "<value>",
+    parameters: {
+      "key": {
+        name: "<value>",
+        value: "<value>",
+      },
+    },
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### React hooks and utilities
+
+This method can be used in React components through the following hooks and
+associated utilities.
+
+> Check out [this guide][hook-guide] for information about each of the utilities
+> below and how to get started using React hooks.
+
+[hook-guide]: ../../../REACT_QUERY.md
+
+```tsx
+import {
+  // Mutation hook for triggering the API call.
+  useClientToolsRunMutation
+} from "@gleanwork/api-client/react-query/clientToolsRun.js";
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.ToolsCallRequest](../../models/components/toolscallrequest.md)                                                                                                     | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[components.ToolsCallResponse](../../models/components/toolscallresponse.md)\>**
+
+### Errors
+
+| Error Type        | Status Code       | Content Type      |
+| ----------------- | ----------------- | ----------------- |
+| errors.GleanError | 4XX, 5XX          | \*/\*             |

package/jsr.json

@@ -2,7 +2,7 @@
 
 {
   "name": "@gleanwork/api-client",
-  "version": "0.4.2",
+  "version": "0.4.4",
   "exports": {
     ".": "./src/index.ts",    
     "./models/errors": "./src/models/errors/index.ts",    

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gleanwork/api-client",
-  "version": "0.4.2",
+  "version": "0.4.4",
   "author": "Speakeasy",
   "type": "module",
   "tshy": {
@@ -59,7 +59,7 @@
     "typescript": "^5.4.5",
     "typescript-eslint": "^8.22.0",
     "vitest": "^3.0.2",
-    "zod": "^3.23.4"
+    "zod": "^3.25.17"
   },
   "dependencies": {},
   "exports": {

package/src/__tests__/indexing.test-d.ts

@@ -0,0 +1,40 @@
+import { expectTypeOf, test } from "vitest";
+import { Glean } from "../index.js";
+
+test("type test for `Glean` constructor", () => {
+  // @ts-expect-error - Function is defined but never used (only for type checking)
+  async function run() {
+    const glean = new Glean({
+      apiToken: process.env["GLEAN_API_TOKEN"],
+      instance: process.env["GLEAN_INSTANCE"],
+    });
+
+    const response = await glean.indexing.documents.index({
+      datasource: "my-datasource",
+      documents: [
+        {
+          datasource: "my-datasource",
+          id: "doc-123",
+          title: "Sample Document",
+          body: {
+            mimeType: "text/plain",
+            textContent: "This is a sample document to index in Glean.",
+          },
+          viewURL: "https://example.com/documents/123",
+          permissions: {
+            allowedUsers: [{ email: "user@example.com" }],
+            allowedGroups: ["everyone@example.com"],
+          },
+        },
+      ],
+    });
+
+    return response;
+  }
+  
+  const correctClient = new Glean({
+    apiToken: "token",
+    instance: "example-instance",
+  });
+  expectTypeOf(correctClient).toEqualTypeOf<Glean>();
+});

package/src/__tests__/policies.test.ts

@@ -19,8 +19,20 @@ test("Policies Getpolicy", async () => {
   expect(result).toBeDefined();
 });
 
-test("Policies Getpolicies", async () => {
-  const testHttpClient = createTestHTTPClient("getpolicies");
+it.skip("Policies Getpolicies", async () => {
+  assert.fail(
+    "incomplete test found please make sure to address the following errors: [`workflow step getpolicies.test referencing operation getpolicies not found in document`]",
+  );
+});
+
+it.skip("Policies Downloadpolicycsv", async () => {
+  assert.fail(
+    "incomplete test found please make sure to address the following errors: [`workflow step downloadpolicycsv.test contains criterion simple with invalid condition`, `workflow step downloadpolicycsv.test does not contain $contentType successCriteria and required for response body assertion`]",
+  );
+});
+
+test("Policies Listpolicies", async () => {
+  const testHttpClient = createTestHTTPClient("listpolicies");
 
   const glean = new Glean({
     serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
@@ -31,9 +43,3 @@ test("Policies Getpolicies", async () => {
   const result = await glean.client.governance.data.policies.list();
   expect(result).toBeDefined();
 });
-
-it.skip("Policies Downloadpolicycsv", async () => {
-  assert.fail(
-    "incomplete test found please make sure to address the following errors: [`workflow step downloadpolicycsv.test contains criterion simple with invalid condition`, `workflow step downloadpolicycsv.test does not contain $contentType successCriteria and required for response body assertion`]",
-  );
-});

package/src/__tests__/tools.test.ts

@@ -0,0 +1,41 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { expect, test } from "vitest";
+import { Glean } from "../index.js";
+import { createTestHTTPClient } from "./testclient.js";
+
+test("Tools Get /Rest/api/v1 /Tools/list", async () => {
+  const testHttpClient = createTestHTTPClient("get_/rest/api/v1/tools/list");
+
+  const glean = new Glean({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
+    httpClient: testHttpClient,
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
+  });
+
+  const result = await glean.client.tools.list();
+  expect(result).toBeDefined();
+});
+
+test("Tools Post /Rest/api/v1 /Tools/call", async () => {
+  const testHttpClient = createTestHTTPClient("post_/rest/api/v1/tools/call");
+
+  const glean = new Glean({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
+    httpClient: testHttpClient,
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
+  });
+
+  const result = await glean.client.tools.run({
+    name: "<value>",
+    parameters: {
+      "key": {
+        name: "<value>",
+        value: "<value>",
+      },
+    },
+  });
+  expect(result).toBeDefined();
+});

package/src/funcs/clientGovernanceDataPoliciesList.ts

@@ -75,14 +75,14 @@ async function $do(
     APICall,
   ]
 > {
-  const input: operations.GetpoliciesRequest = {
+  const input: operations.ListpoliciesRequest = {
     autoHide: autoHide,
     frequency: frequency,
   };
 
   const parsed = safeParse(
     input,
-    (value) => operations.GetpoliciesRequest$outboundSchema.parse(value),
+    (value) => operations.ListpoliciesRequest$outboundSchema.parse(value),
     "Input validation failed",
   );
   if (!parsed.ok) {
@@ -108,7 +108,7 @@ async function $do(
 
   const context = {
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "getpolicies",
+    operationID: "listpolicies",
     oAuth2Scopes: [],
 
     resolvedSecurity: requestSecurity,

package/src/funcs/clientSearchQuery.ts

@@ -32,7 +32,7 @@ import { Result } from "../types/fp.js";
  */
 export function clientSearchQuery(
   client: GleanCore,
-  request?: components.SearchRequest | undefined,
+  request: components.SearchRequest,
   options?: RequestOptions,
 ): APIPromise<
   Result<
@@ -56,7 +56,7 @@ export function clientSearchQuery(
 
 async function $do(
   client: GleanCore,
-  request?: components.SearchRequest | undefined,
+  request: components.SearchRequest,
   options?: RequestOptions,
 ): Promise<
   [
@@ -76,16 +76,14 @@ async function $do(
 > {
   const parsed = safeParse(
     request,
-    (value) => components.SearchRequest$outboundSchema.optional().parse(value),
+    (value) => components.SearchRequest$outboundSchema.parse(value),
     "Input validation failed",
   );
   if (!parsed.ok) {
     return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
-  const body = payload === undefined
-    ? null
-    : encodeJSON("body", payload, { explode: true });
+  const body = encodeJSON("body", payload, { explode: true });
 
   const path = pathToFunc("/rest/api/v1/search")();
 

package/src/funcs/clientSearchQueryAsAdmin.ts

@@ -32,7 +32,7 @@ import { Result } from "../types/fp.js";
  */
 export function clientSearchQueryAsAdmin(
   client: GleanCore,
-  request?: components.SearchRequest | undefined,
+  request: components.SearchRequest,
   options?: RequestOptions,
 ): APIPromise<
   Result<
@@ -56,7 +56,7 @@ export function clientSearchQueryAsAdmin(
 
 async function $do(
   client: GleanCore,
-  request?: components.SearchRequest | undefined,
+  request: components.SearchRequest,
   options?: RequestOptions,
 ): Promise<
   [
@@ -76,16 +76,14 @@ async function $do(
 > {
   const parsed = safeParse(
     request,
-    (value) => components.SearchRequest$outboundSchema.optional().parse(value),
+    (value) => components.SearchRequest$outboundSchema.parse(value),
     "Input validation failed",
   );
   if (!parsed.ok) {
     return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
-  const body = payload === undefined
-    ? null
-    : encodeJSON("body", payload, { explode: true });
+  const body = encodeJSON("body", payload, { explode: true });
 
   const path = pathToFunc("/rest/api/v1/adminsearch")();
 

package/src/funcs/clientSearchRecommendations.ts

@@ -31,7 +31,7 @@ import { Result } from "../types/fp.js";
  */
 export function clientSearchRecommendations(
   client: GleanCore,
-  request?: components.RecommendationsRequest | undefined,
+  request: components.RecommendationsRequest,
   options?: RequestOptions,
 ): APIPromise<
   Result<
@@ -54,7 +54,7 @@ export function clientSearchRecommendations(
 
 async function $do(
   client: GleanCore,
-  request?: components.RecommendationsRequest | undefined,
+  request: components.RecommendationsRequest,
   options?: RequestOptions,
 ): Promise<
   [
@@ -73,17 +73,14 @@ async function $do(
 > {
   const parsed = safeParse(
     request,
-    (value) =>
-      components.RecommendationsRequest$outboundSchema.optional().parse(value),
+    (value) => components.RecommendationsRequest$outboundSchema.parse(value),
     "Input validation failed",
   );
   if (!parsed.ok) {
     return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
-  const body = payload === undefined
-    ? null
-    : encodeJSON("body", payload, { explode: true });
+  const body = encodeJSON("body", payload, { explode: true });
 
   const path = pathToFunc("/rest/api/v1/recommendations")();
 

package/src/funcs/clientToolsList.ts

@@ -0,0 +1,164 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { GleanCore } from "../core.js";
+import { encodeFormQuery } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import * as components from "../models/components/index.js";
+import { GleanError } from "../models/errors/gleanerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * List available tools
+ *
+ * @remarks
+ * Returns a filtered set of available tools based on optional tool name parameters. If no filters are provided, all available tools are returned.
+ */
+export function clientToolsList(
+  client: GleanCore,
+  toolNames?: Array<string> | undefined,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.ToolsListResponse,
+    | GleanError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    toolNames,
+    options,
+  ));
+}
+
+async function $do(
+  client: GleanCore,
+  toolNames?: Array<string> | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.ToolsListResponse,
+      | GleanError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
+> {
+  const input: operations.GetRestApiV1ToolsListRequest = {
+    toolNames: toolNames,
+  };
+
+  const parsed = safeParse(
+    input,
+    (value) =>
+      operations.GetRestApiV1ToolsListRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const path = pathToFunc("/rest/api/v1/tools/list")();
+
+  const query = encodeFormQuery({
+    "toolNames": payload.toolNames,
+  }, { explode: false });
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiToken);
+  const securityInput = secConfig == null ? {} : { apiToken: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "get_/rest/api/v1/tools/list",
+    oAuth2Scopes: [],
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiToken,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    query: query,
+    body: body,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["400", "401", "404", "429", "4XX", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const [result] = await M.match<
+    components.ToolsListResponse,
+    | GleanError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.json(200, components.ToolsListResponse$inboundSchema),
+    M.fail([400, 401, 404, 429, "4XX"]),
+    M.fail("5XX"),
+  )(response);
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}