@gleanwork/api-client 0.17.3 → 0.18.1

package/src/react-query/skillsCreateVersion.ts

@@ -0,0 +1,116 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 2bcd9406d548
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GleanCore } from "../core.js";
+import { skillsCreateVersion } from "../funcs/skillsCreateVersion.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import { GleanBaseError } from "../models/errors/gleanbaseerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import { unwrapAsync } from "../types/fp.js";
+import { useGleanContext } from "./_context.js";
+import { MutationHookOptions } from "./_types.js";
+
+export type SkillsCreateVersionMutationVariables = {
+  platformSkillVersionCreateRequest:
+    components.PlatformSkillVersionCreateRequest;
+  skillId: string;
+  options?: RequestOptions;
+};
+
+export type SkillsCreateVersionMutationData =
+  components.PlatformSkillVersionCreateResponse;
+
+export type SkillsCreateVersionMutationError =
+  | errors.PlatformProblemDetailError
+  | GleanBaseError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Create skill version
+ *
+ * @remarks
+ * Create a new immutable version for an existing caller-managed skill from an uploaded SKILL.md, .zip, or .skill bundle.
+ */
+export function useSkillsCreateVersionMutation(
+  options?: MutationHookOptions<
+    SkillsCreateVersionMutationData,
+    SkillsCreateVersionMutationError,
+    SkillsCreateVersionMutationVariables
+  >,
+): UseMutationResult<
+  SkillsCreateVersionMutationData,
+  SkillsCreateVersionMutationError,
+  SkillsCreateVersionMutationVariables
+> {
+  const client = useGleanContext();
+  return useMutation({
+    ...buildSkillsCreateVersionMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeySkillsCreateVersion(): MutationKey {
+  return ["@gleanwork/api-client", "skills", "createVersion"];
+}
+
+export function buildSkillsCreateVersionMutation(
+  client$: GleanCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: SkillsCreateVersionMutationVariables,
+  ) => Promise<SkillsCreateVersionMutationData>;
+} {
+  return {
+    mutationKey: mutationKeySkillsCreateVersion(),
+    mutationFn: function skillsCreateVersionMutationFn({
+      platformSkillVersionCreateRequest,
+      skillId,
+      options,
+    }): Promise<SkillsCreateVersionMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(skillsCreateVersion(
+        client$,
+        platformSkillVersionCreateRequest,
+        skillId,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/skillsDelete.ts

@@ -0,0 +1,110 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: a5642a61e935
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GleanCore } from "../core.js";
+import { skillsDelete } from "../funcs/skillsDelete.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { GleanBaseError } from "../models/errors/gleanbaseerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import { unwrapAsync } from "../types/fp.js";
+import { useGleanContext } from "./_context.js";
+import { MutationHookOptions } from "./_types.js";
+
+export type SkillsDeleteMutationVariables = {
+  skillId: string;
+  options?: RequestOptions;
+};
+
+export type SkillsDeleteMutationData = void;
+
+export type SkillsDeleteMutationError =
+  | errors.PlatformProblemDetailError
+  | GleanBaseError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Delete skill
+ *
+ * @remarks
+ * Delete a skill the authenticated caller is allowed to manage. This operation permanently removes all versions of the skill.
+ */
+export function useSkillsDeleteMutation(
+  options?: MutationHookOptions<
+    SkillsDeleteMutationData,
+    SkillsDeleteMutationError,
+    SkillsDeleteMutationVariables
+  >,
+): UseMutationResult<
+  SkillsDeleteMutationData,
+  SkillsDeleteMutationError,
+  SkillsDeleteMutationVariables
+> {
+  const client = useGleanContext();
+  return useMutation({
+    ...buildSkillsDeleteMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeySkillsDelete(): MutationKey {
+  return ["@gleanwork/api-client", "skills", "delete"];
+}
+
+export function buildSkillsDeleteMutation(
+  client$: GleanCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: SkillsDeleteMutationVariables,
+  ) => Promise<SkillsDeleteMutationData>;
+} {
+  return {
+    mutationKey: mutationKeySkillsDelete(),
+    mutationFn: function skillsDeleteMutationFn({
+      skillId,
+      options,
+    }): Promise<SkillsDeleteMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(skillsDelete(
+        client$,
+        skillId,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/skillsImport.ts

@@ -0,0 +1,111 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: b58d55335ec3
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GleanCore } from "../core.js";
+import { skillsImport } from "../funcs/skillsImport.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import { GleanBaseError } from "../models/errors/gleanbaseerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import { unwrapAsync } from "../types/fp.js";
+import { useGleanContext } from "./_context.js";
+import { MutationHookOptions } from "./_types.js";
+
+export type SkillsImportMutationVariables = {
+  request: components.PlatformSkillImportRequest;
+  options?: RequestOptions;
+};
+
+export type SkillsImportMutationData = components.PlatformSkillImportResponse;
+
+export type SkillsImportMutationError =
+  | errors.PlatformProblemDetailError
+  | GleanBaseError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Import skills from GitHub
+ *
+ * @remarks
+ * Import one or more skills selected from a GitHub source preview. Each source URL is fetched and persisted as an independent skill with source provenance. This operation does not create a durable source resource. The import is atomic: if any source cannot be fetched, validated, or persisted, no skills are created.
+ */
+export function useSkillsImportMutation(
+  options?: MutationHookOptions<
+    SkillsImportMutationData,
+    SkillsImportMutationError,
+    SkillsImportMutationVariables
+  >,
+): UseMutationResult<
+  SkillsImportMutationData,
+  SkillsImportMutationError,
+  SkillsImportMutationVariables
+> {
+  const client = useGleanContext();
+  return useMutation({
+    ...buildSkillsImportMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeySkillsImport(): MutationKey {
+  return ["@gleanwork/api-client", "skills", "import"];
+}
+
+export function buildSkillsImportMutation(
+  client$: GleanCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: SkillsImportMutationVariables,
+  ) => Promise<SkillsImportMutationData>;
+} {
+  return {
+    mutationKey: mutationKeySkillsImport(),
+    mutationFn: function skillsImportMutationFn({
+      request,
+      options,
+    }): Promise<SkillsImportMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(skillsImport(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/skillsList.core.ts

@@ -0,0 +1,75 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: e91168fc9e6b
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { GleanCore } from "../core.js";
+import { skillsList } from "../funcs/skillsList.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import { unwrapAsync } from "../types/fp.js";
+export type SkillsListQueryData = components.PlatformSkillsListResponse;
+
+export function prefetchSkillsList(
+  queryClient: QueryClient,
+  client$: GleanCore,
+  pageSize?: number | undefined,
+  cursor?: string | undefined,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildSkillsListQuery(
+      client$,
+      pageSize,
+      cursor,
+      options,
+    ),
+  });
+}
+
+export function buildSkillsListQuery(
+  client$: GleanCore,
+  pageSize?: number | undefined,
+  cursor?: string | undefined,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (context: QueryFunctionContext) => Promise<SkillsListQueryData>;
+} {
+  return {
+    queryKey: queryKeySkillsList({ pageSize, cursor }),
+    queryFn: async function skillsListQueryFn(
+      ctx,
+    ): Promise<SkillsListQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(skillsList(
+        client$,
+        pageSize,
+        cursor,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeySkillsList(
+  parameters: { pageSize?: number | undefined; cursor?: string | undefined },
+): QueryKey {
+  return ["@gleanwork/api-client", "skills", "list", parameters];
+}

package/src/react-query/skillsList.ts

@@ -0,0 +1,134 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 3377edb65dda
+ */
+
+import {
+  InvalidateQueryFilters,
+  QueryClient,
+  useQuery,
+  UseQueryResult,
+  useSuspenseQuery,
+  UseSuspenseQueryResult,
+} from "@tanstack/react-query";
+import { GleanBaseError } from "../models/errors/gleanbaseerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import { useGleanContext } from "./_context.js";
+import {
+  QueryHookOptions,
+  SuspenseQueryHookOptions,
+  TupleToPrefixes,
+} from "./_types.js";
+import {
+  buildSkillsListQuery,
+  prefetchSkillsList,
+  queryKeySkillsList,
+  SkillsListQueryData,
+} from "./skillsList.core.js";
+export {
+  buildSkillsListQuery,
+  prefetchSkillsList,
+  queryKeySkillsList,
+  type SkillsListQueryData,
+};
+
+export type SkillsListQueryError =
+  | errors.PlatformProblemDetailError
+  | GleanBaseError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * List skills
+ *
+ * @remarks
+ * List skills available to the authenticated user.
+ */
+export function useSkillsList(
+  pageSize?: number | undefined,
+  cursor?: string | undefined,
+  options?: QueryHookOptions<SkillsListQueryData, SkillsListQueryError>,
+): UseQueryResult<SkillsListQueryData, SkillsListQueryError> {
+  const client = useGleanContext();
+  return useQuery({
+    ...buildSkillsListQuery(
+      client,
+      pageSize,
+      cursor,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * List skills
+ *
+ * @remarks
+ * List skills available to the authenticated user.
+ */
+export function useSkillsListSuspense(
+  pageSize?: number | undefined,
+  cursor?: string | undefined,
+  options?: SuspenseQueryHookOptions<SkillsListQueryData, SkillsListQueryError>,
+): UseSuspenseQueryResult<SkillsListQueryData, SkillsListQueryError> {
+  const client = useGleanContext();
+  return useSuspenseQuery({
+    ...buildSkillsListQuery(
+      client,
+      pageSize,
+      cursor,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function setSkillsListData(
+  client: QueryClient,
+  queryKeyBase: [
+    parameters: { pageSize?: number | undefined; cursor?: string | undefined },
+  ],
+  data: SkillsListQueryData,
+): SkillsListQueryData | undefined {
+  const key = queryKeySkillsList(...queryKeyBase);
+
+  return client.setQueryData<SkillsListQueryData>(key, data);
+}
+
+export function invalidateSkillsList(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [parameters: { pageSize?: number | undefined; cursor?: string | undefined }]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@gleanwork/api-client", "skills", "list", ...queryKeyBase],
+  });
+}
+
+export function invalidateAllSkillsList(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@gleanwork/api-client", "skills", "list"],
+  });
+}

package/src/react-query/skillsListVersions.core.ts

@@ -0,0 +1,89 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 92446ae9c4cc
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { GleanCore } from "../core.js";
+import { skillsListVersions } from "../funcs/skillsListVersions.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import { unwrapAsync } from "../types/fp.js";
+export type SkillsListVersionsQueryData =
+  components.PlatformSkillVersionsListResponse;
+
+export function prefetchSkillsListVersions(
+  queryClient: QueryClient,
+  client$: GleanCore,
+  skillId: string,
+  pageSize?: number | undefined,
+  cursor?: string | undefined,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildSkillsListVersionsQuery(
+      client$,
+      skillId,
+      pageSize,
+      cursor,
+      options,
+    ),
+  });
+}
+
+export function buildSkillsListVersionsQuery(
+  client$: GleanCore,
+  skillId: string,
+  pageSize?: number | undefined,
+  cursor?: string | undefined,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<SkillsListVersionsQueryData>;
+} {
+  return {
+    queryKey: queryKeySkillsListVersions(skillId, { pageSize, cursor }),
+    queryFn: async function skillsListVersionsQueryFn(
+      ctx,
+    ): Promise<SkillsListVersionsQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(skillsListVersions(
+        client$,
+        skillId,
+        pageSize,
+        cursor,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeySkillsListVersions(
+  skillId: string,
+  parameters: { pageSize?: number | undefined; cursor?: string | undefined },
+): QueryKey {
+  return [
+    "@gleanwork/api-client",
+    "skills",
+    "listVersions",
+    skillId,
+    parameters,
+  ];
+}