@gleanwork/api-client 0.17.3 → 0.18.0

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,
+  ];
+}

package/src/react-query/skillsListVersions.ts

@@ -0,0 +1,159 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: f270a8f770bf
+ */
+
+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 {
+  buildSkillsListVersionsQuery,
+  prefetchSkillsListVersions,
+  queryKeySkillsListVersions,
+  SkillsListVersionsQueryData,
+} from "./skillsListVersions.core.js";
+export {
+  buildSkillsListVersionsQuery,
+  prefetchSkillsListVersions,
+  queryKeySkillsListVersions,
+  type SkillsListVersionsQueryData,
+};
+
+export type SkillsListVersionsQueryError =
+  | errors.PlatformProblemDetailError
+  | GleanBaseError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * List skill versions
+ *
+ * @remarks
+ * List versions for a skill available to the authenticated user.
+ */
+export function useSkillsListVersions(
+  skillId: string,
+  pageSize?: number | undefined,
+  cursor?: string | undefined,
+  options?: QueryHookOptions<
+    SkillsListVersionsQueryData,
+    SkillsListVersionsQueryError
+  >,
+): UseQueryResult<SkillsListVersionsQueryData, SkillsListVersionsQueryError> {
+  const client = useGleanContext();
+  return useQuery({
+    ...buildSkillsListVersionsQuery(
+      client,
+      skillId,
+      pageSize,
+      cursor,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * List skill versions
+ *
+ * @remarks
+ * List versions for a skill available to the authenticated user.
+ */
+export function useSkillsListVersionsSuspense(
+  skillId: string,
+  pageSize?: number | undefined,
+  cursor?: string | undefined,
+  options?: SuspenseQueryHookOptions<
+    SkillsListVersionsQueryData,
+    SkillsListVersionsQueryError
+  >,
+): UseSuspenseQueryResult<
+  SkillsListVersionsQueryData,
+  SkillsListVersionsQueryError
+> {
+  const client = useGleanContext();
+  return useSuspenseQuery({
+    ...buildSkillsListVersionsQuery(
+      client,
+      skillId,
+      pageSize,
+      cursor,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function setSkillsListVersionsData(
+  client: QueryClient,
+  queryKeyBase: [
+    skillId: string,
+    parameters: { pageSize?: number | undefined; cursor?: string | undefined },
+  ],
+  data: SkillsListVersionsQueryData,
+): SkillsListVersionsQueryData | undefined {
+  const key = queryKeySkillsListVersions(...queryKeyBase);
+
+  return client.setQueryData<SkillsListVersionsQueryData>(key, data);
+}
+
+export function invalidateSkillsListVersions(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [
+      skillId: string,
+      parameters: {
+        pageSize?: number | undefined;
+        cursor?: string | undefined;
+      },
+    ]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@gleanwork/api-client",
+      "skills",
+      "listVersions",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllSkillsListVersions(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@gleanwork/api-client", "skills", "listVersions"],
+  });
+}

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

@@ -0,0 +1,69 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: b293a018b942
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { GleanCore } from "../core.js";
+import { skillsRetrieve } from "../funcs/skillsRetrieve.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 SkillsRetrieveQueryData = components.PlatformSkillGetResponse;
+
+export function prefetchSkillsRetrieve(
+  queryClient: QueryClient,
+  client$: GleanCore,
+  skillId: string,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildSkillsRetrieveQuery(
+      client$,
+      skillId,
+      options,
+    ),
+  });
+}
+
+export function buildSkillsRetrieveQuery(
+  client$: GleanCore,
+  skillId: string,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (context: QueryFunctionContext) => Promise<SkillsRetrieveQueryData>;
+} {
+  return {
+    queryKey: queryKeySkillsRetrieve(skillId),
+    queryFn: async function skillsRetrieveQueryFn(
+      ctx,
+    ): Promise<SkillsRetrieveQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(skillsRetrieve(
+        client$,
+        skillId,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeySkillsRetrieve(skillId: string): QueryKey {
+  return ["@gleanwork/api-client", "skills", "retrieve", skillId];
+}

package/src/react-query/skillsRetrieve.ts

@@ -0,0 +1,129 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 8bd7927c56aa
+ */
+
+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 {
+  buildSkillsRetrieveQuery,
+  prefetchSkillsRetrieve,
+  queryKeySkillsRetrieve,
+  SkillsRetrieveQueryData,
+} from "./skillsRetrieve.core.js";
+export {
+  buildSkillsRetrieveQuery,
+  prefetchSkillsRetrieve,
+  queryKeySkillsRetrieve,
+  type SkillsRetrieveQueryData,
+};
+
+export type SkillsRetrieveQueryError =
+  | errors.PlatformProblemDetailError
+  | GleanBaseError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Retrieve skill
+ *
+ * @remarks
+ * Retrieve metadata for a skill available to the authenticated user.
+ */
+export function useSkillsRetrieve(
+  skillId: string,
+  options?: QueryHookOptions<SkillsRetrieveQueryData, SkillsRetrieveQueryError>,
+): UseQueryResult<SkillsRetrieveQueryData, SkillsRetrieveQueryError> {
+  const client = useGleanContext();
+  return useQuery({
+    ...buildSkillsRetrieveQuery(
+      client,
+      skillId,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Retrieve skill
+ *
+ * @remarks
+ * Retrieve metadata for a skill available to the authenticated user.
+ */
+export function useSkillsRetrieveSuspense(
+  skillId: string,
+  options?: SuspenseQueryHookOptions<
+    SkillsRetrieveQueryData,
+    SkillsRetrieveQueryError
+  >,
+): UseSuspenseQueryResult<SkillsRetrieveQueryData, SkillsRetrieveQueryError> {
+  const client = useGleanContext();
+  return useSuspenseQuery({
+    ...buildSkillsRetrieveQuery(
+      client,
+      skillId,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function setSkillsRetrieveData(
+  client: QueryClient,
+  queryKeyBase: [skillId: string],
+  data: SkillsRetrieveQueryData,
+): SkillsRetrieveQueryData | undefined {
+  const key = queryKeySkillsRetrieve(...queryKeyBase);
+
+  return client.setQueryData<SkillsRetrieveQueryData>(key, data);
+}
+
+export function invalidateSkillsRetrieve(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<[skillId: string]>,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@gleanwork/api-client", "skills", "retrieve", ...queryKeyBase],
+  });
+}
+
+export function invalidateAllSkillsRetrieve(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@gleanwork/api-client", "skills", "retrieve"],
+  });
+}