@greensecurity/javascript-sdk 0.46.0-beta.8 → 0.46.0-beta.9

package/src/react-query/appsCreateAppDevSession.ts

@@ -0,0 +1,134 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { appsCreateAppDevSession } from "../funcs/appsCreateAppDevSession.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import { GreenSecurityError } from "../models/errors/greensecurityerror.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 * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+import { useGreenSecurityContext } from "./_context.js";
+import { MutationHookOptions } from "./_types.js";
+
+export type AppsCreateAppDevSessionMutationVariables = {
+  request: operations.CreateAppDevSessionRequest;
+  options?: RequestOptions;
+};
+
+export type AppsCreateAppDevSessionMutationData = components.DevSession;
+
+export type AppsCreateAppDevSessionMutationError =
+  | errors.ApiErrorResponse
+  | errors.CreateAppDevSessionResponseBody
+  | GreenSecurityError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Start a dev session
+ *
+ * @remarks
+ * Registers a dev session, which is what `gs-apps dev` does on start. While the session is
+ * active, the Green Security app loads your views from the CLI's dev server at `origin`
+ * instead of the published bundle, for you only: other users of the same tenant keep
+ * seeing the published version. Every build the dev server announces must be signed with
+ * the private half of `public_key_jwk`.
+ *
+ * Starting a session closes any earlier session of yours for the same app. A session lasts
+ * 12 hours and counts as inactive after 2 minutes without a heartbeat, so call
+ * `POST /apps/{app_id}/dev-sessions/{id}/heartbeat` every 30 seconds.
+ *
+ * A `422` means a field failed validation: `origin`, `server_token`, `public_key_jwk` or
+ * `manifest` is malformed, `manifest` changes a field a dev session may not (see
+ * `AppDevManifest`), or several installations cover you and `activation_id` was left out.
+ *
+ * The response never includes `server_token`: you generated it, so keep your own copy.
+ *
+ * Dev sessions are available on staging, and in production only for apps an administrator
+ * has enabled dev preview for; otherwise this endpoint answers `403`.
+ *
+ * **Permissions.** Requires a developer CLI token (`gsd_`, from `gs-apps login`) of an
+ * `owner` or `developer` of the app, as `Authorization: Bearer`. Any other token, including
+ * your own session token and the app's service account token, is refused with `403`. An app
+ * you are not a developer of is reported as not found.
+ */
+export function useAppsCreateAppDevSessionMutation(
+  options?: MutationHookOptions<
+    AppsCreateAppDevSessionMutationData,
+    AppsCreateAppDevSessionMutationError,
+    AppsCreateAppDevSessionMutationVariables
+  >,
+): UseMutationResult<
+  AppsCreateAppDevSessionMutationData,
+  AppsCreateAppDevSessionMutationError,
+  AppsCreateAppDevSessionMutationVariables
+> {
+  const client = useGreenSecurityContext();
+  return useMutation({
+    ...buildAppsCreateAppDevSessionMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyAppsCreateAppDevSession(): MutationKey {
+  return ["@greensecurity/javascript-sdk", "apps", "createAppDevSession"];
+}
+
+export function buildAppsCreateAppDevSessionMutation(
+  client$: GreenSecurityCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: AppsCreateAppDevSessionMutationVariables,
+  ) => Promise<AppsCreateAppDevSessionMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyAppsCreateAppDevSession(),
+    mutationFn: function appsCreateAppDevSessionMutationFn({
+      request,
+      options,
+    }): Promise<AppsCreateAppDevSessionMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(appsCreateAppDevSession(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/appsDeleteAppSecret.ts

@@ -0,0 +1,144 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { appsDeleteAppSecret } from "../funcs/appsDeleteAppSecret.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import { GreenSecurityError } from "../models/errors/greensecurityerror.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 { useGreenSecurityContext } from "./_context.js";
+import { MutationHookOptions } from "./_types.js";
+
+export type AppsDeleteAppSecretMutationVariables = {
+  request: components.AppSecretDeleteRequest;
+  options?: RequestOptions;
+};
+
+export type AppsDeleteAppSecretMutationData = components.AppSecretDeleted;
+
+export type AppsDeleteAppSecretMutationError =
+  | errors.ApiErrorResponse
+  | errors.AppSecretsUnprocessable
+  | GreenSecurityError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Delete an app secret
+ *
+ * @remarks
+ * Deletes the secret with `name` in the given scope, and returns it with `deleted: true`.
+ *
+ * **Permissions.** Send one of these as `Authorization: Bearer`; any other token is refused
+ * with `403`.
+ *
+ * - **An app token**: an app user token (`gsu_`) or an app installation token (`gsi_`). The
+ *   activation comes from the token, so leave `activation_id` out; if you send it, it must be
+ *   the token's own activation (`403` otherwise). Either token may delete from the `installation`
+ *   scope. For the `user` scope:
+ *   - an app user token reaches only its own user (`user_id` may be left out);
+ *   - an installation token the host minted for one of your views reaches only that view's
+ *     viewer (`user_id` may be left out);
+ *   - an installation token from `client_credentials` reaches any user its activation
+ *     covers, and `user_id` is required.
+ * - **Your app's service account**: its permanent token, or a short-lived OAuth access token
+ *   issued to it without `scope` (by `client_credentials` without `activation_id`, or by the
+ *   `refresh_token` grant). A token issued with `scope` is refused with `403`, and any other
+ *   kind of token, such as a one-time sign-in link token, with `403` "This kind of token may
+ *   not access app secrets". It has no activation of its own, so `activation_id` is required
+ *   (`422` without it) and must be one of your app's activations (`403` otherwise). Its `user`
+ *   scope reaches any user the activation covers, and `user_id` is required.
+ *
+ * A `user_id` that does not exist and one the token may not reach get the same `403` "This
+ * credential may not access secrets of that user", so the endpoint never reveals which user
+ * ids exist.
+ *
+ * Whatever the token, your app must hold the platform permission `app_secrets.write`: list
+ * it in the manifest's `permissions` and upload. Until then every Secret Store call is
+ * refused with `403` "This app has not been granted app_secrets.write." For the service
+ * account this is checked before `activation_id` is looked at, so an app without the
+ * permission gets that answer whether or not it sent an `activation_id`.
+ *
+ * Every response carries `Cache-Control: no-store`, errors included, so no cache keeps a
+ * secret.
+ */
+export function useAppsDeleteAppSecretMutation(
+  options?: MutationHookOptions<
+    AppsDeleteAppSecretMutationData,
+    AppsDeleteAppSecretMutationError,
+    AppsDeleteAppSecretMutationVariables
+  >,
+): UseMutationResult<
+  AppsDeleteAppSecretMutationData,
+  AppsDeleteAppSecretMutationError,
+  AppsDeleteAppSecretMutationVariables
+> {
+  const client = useGreenSecurityContext();
+  return useMutation({
+    ...buildAppsDeleteAppSecretMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyAppsDeleteAppSecret(): MutationKey {
+  return ["@greensecurity/javascript-sdk", "apps", "deleteAppSecret"];
+}
+
+export function buildAppsDeleteAppSecretMutation(
+  client$: GreenSecurityCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: AppsDeleteAppSecretMutationVariables,
+  ) => Promise<AppsDeleteAppSecretMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyAppsDeleteAppSecret(),
+    mutationFn: function appsDeleteAppSecretMutationFn({
+      request,
+      options,
+    }): Promise<AppsDeleteAppSecretMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(appsDeleteAppSecret(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}

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

@@ -0,0 +1,83 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { appsFindAppSecret } from "../funcs/appsFindAppSecret.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+export type AppsFindAppSecretQueryData = components.AppSecret;
+
+export function prefetchAppsFindAppSecret(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.FindAppSecretRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildAppsFindAppSecretQuery(
+      client$,
+      request,
+      options,
+    ),
+  });
+}
+
+export function buildAppsFindAppSecretQuery(
+  client$: GreenSecurityCore,
+  request: operations.FindAppSecretRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<AppsFindAppSecretQueryData>;
+} {
+  return {
+    queryKey: queryKeyAppsFindAppSecret({
+      name: request.name,
+      scope: request.scope,
+      activationId: request.activationId,
+      expand: request.expand,
+    }),
+    queryFn: async function appsFindAppSecretQueryFn(
+      ctx,
+    ): Promise<AppsFindAppSecretQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(appsFindAppSecret(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyAppsFindAppSecret(
+  parameters: {
+    name: string;
+    scope: components.AppSecretScope;
+    activationId?: number | undefined;
+    expand?: Array<operations.FindAppSecretQueryParamExpand> | undefined;
+  },
+): QueryKey {
+  return ["@greensecurity/javascript-sdk", "apps", "findAppSecret", parameters];
+}

package/src/react-query/appsFindAppSecret.ts

@@ -0,0 +1,226 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  InvalidateQueryFilters,
+  QueryClient,
+  useQuery,
+  UseQueryResult,
+  useSuspenseQuery,
+  UseSuspenseQueryResult,
+} from "@tanstack/react-query";
+import * as components from "../models/components/index.js";
+import { GreenSecurityError } from "../models/errors/greensecurityerror.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 * as operations from "../models/operations/index.js";
+import { useGreenSecurityContext } from "./_context.js";
+import {
+  QueryHookOptions,
+  SuspenseQueryHookOptions,
+  TupleToPrefixes,
+} from "./_types.js";
+import {
+  AppsFindAppSecretQueryData,
+  buildAppsFindAppSecretQuery,
+  prefetchAppsFindAppSecret,
+  queryKeyAppsFindAppSecret,
+} from "./appsFindAppSecret.core.js";
+export {
+  type AppsFindAppSecretQueryData,
+  buildAppsFindAppSecretQuery,
+  prefetchAppsFindAppSecret,
+  queryKeyAppsFindAppSecret,
+};
+
+export type AppsFindAppSecretQueryError =
+  | errors.ApiErrorResponse
+  | errors.AppSecretsUnprocessable
+  | GreenSecurityError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Find an app secret
+ *
+ * @remarks
+ * Returns the secret with `name` in the given scope. The payload is only included when you
+ * ask for it with `expand=payload`, so a lookup that only needs to know the secret exists
+ * never moves the value. An expired secret is reported as not found.
+ *
+ * **Permissions.** Send one of these as `Authorization: Bearer`; any other token is refused
+ * with `403`.
+ *
+ * - **An app token**: an app user token (`gsu_`) or an app installation token (`gsi_`). The
+ *   activation comes from the token, so leave `activation_id` out; if you send it, it must be
+ *   the token's own activation (`403` otherwise). Either token may read the `installation`
+ *   scope. For the `user` scope:
+ *   - an app user token reaches only its own user (`user_id` may be left out);
+ *   - an installation token the host minted for one of your views reaches only that view's
+ *     viewer (`user_id` may be left out);
+ *   - an installation token from `client_credentials` reaches any user its activation
+ *     covers, and `user_id` is required.
+ * - **Your app's service account**: its permanent token, or a short-lived OAuth access token
+ *   issued to it without `scope` (by `client_credentials` without `activation_id`, or by the
+ *   `refresh_token` grant). A token issued with `scope` is refused with `403`, and any other
+ *   kind of token, such as a one-time sign-in link token, with `403` "This kind of token may
+ *   not access app secrets". It has no activation of its own, so `activation_id` is required
+ *   (`422` without it) and must be one of your app's activations (`403` otherwise). Its `user`
+ *   scope reaches any user the activation covers, and `user_id` is required.
+ *
+ * A `user_id` that does not exist and one the token may not reach get the same `403` "This
+ * credential may not access secrets of that user", so the endpoint never reveals which user
+ * ids exist.
+ *
+ * Whatever the token, your app must hold the platform permission `app_secrets.write`: list
+ * it in the manifest's `permissions` and upload. Until then every Secret Store call is
+ * refused with `403` "This app has not been granted app_secrets.write." For the service
+ * account this is checked before `activation_id` is looked at, so an app without the
+ * permission gets that answer whether or not it sent an `activation_id`.
+ *
+ * Every response carries `Cache-Control: no-store`, errors included, so no cache keeps a
+ * secret.
+ */
+export function useAppsFindAppSecret(
+  request: operations.FindAppSecretRequest,
+  options?: QueryHookOptions<
+    AppsFindAppSecretQueryData,
+    AppsFindAppSecretQueryError
+  >,
+): UseQueryResult<AppsFindAppSecretQueryData, AppsFindAppSecretQueryError> {
+  const client = useGreenSecurityContext();
+  return useQuery({
+    ...buildAppsFindAppSecretQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Find an app secret
+ *
+ * @remarks
+ * Returns the secret with `name` in the given scope. The payload is only included when you
+ * ask for it with `expand=payload`, so a lookup that only needs to know the secret exists
+ * never moves the value. An expired secret is reported as not found.
+ *
+ * **Permissions.** Send one of these as `Authorization: Bearer`; any other token is refused
+ * with `403`.
+ *
+ * - **An app token**: an app user token (`gsu_`) or an app installation token (`gsi_`). The
+ *   activation comes from the token, so leave `activation_id` out; if you send it, it must be
+ *   the token's own activation (`403` otherwise). Either token may read the `installation`
+ *   scope. For the `user` scope:
+ *   - an app user token reaches only its own user (`user_id` may be left out);
+ *   - an installation token the host minted for one of your views reaches only that view's
+ *     viewer (`user_id` may be left out);
+ *   - an installation token from `client_credentials` reaches any user its activation
+ *     covers, and `user_id` is required.
+ * - **Your app's service account**: its permanent token, or a short-lived OAuth access token
+ *   issued to it without `scope` (by `client_credentials` without `activation_id`, or by the
+ *   `refresh_token` grant). A token issued with `scope` is refused with `403`, and any other
+ *   kind of token, such as a one-time sign-in link token, with `403` "This kind of token may
+ *   not access app secrets". It has no activation of its own, so `activation_id` is required
+ *   (`422` without it) and must be one of your app's activations (`403` otherwise). Its `user`
+ *   scope reaches any user the activation covers, and `user_id` is required.
+ *
+ * A `user_id` that does not exist and one the token may not reach get the same `403` "This
+ * credential may not access secrets of that user", so the endpoint never reveals which user
+ * ids exist.
+ *
+ * Whatever the token, your app must hold the platform permission `app_secrets.write`: list
+ * it in the manifest's `permissions` and upload. Until then every Secret Store call is
+ * refused with `403` "This app has not been granted app_secrets.write." For the service
+ * account this is checked before `activation_id` is looked at, so an app without the
+ * permission gets that answer whether or not it sent an `activation_id`.
+ *
+ * Every response carries `Cache-Control: no-store`, errors included, so no cache keeps a
+ * secret.
+ */
+export function useAppsFindAppSecretSuspense(
+  request: operations.FindAppSecretRequest,
+  options?: SuspenseQueryHookOptions<
+    AppsFindAppSecretQueryData,
+    AppsFindAppSecretQueryError
+  >,
+): UseSuspenseQueryResult<
+  AppsFindAppSecretQueryData,
+  AppsFindAppSecretQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useSuspenseQuery({
+    ...buildAppsFindAppSecretQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function setAppsFindAppSecretData(
+  client: QueryClient,
+  queryKeyBase: [
+    parameters: {
+      name: string;
+      scope: components.AppSecretScope;
+      activationId?: number | undefined;
+      expand?: Array<operations.FindAppSecretQueryParamExpand> | undefined;
+    },
+  ],
+  data: AppsFindAppSecretQueryData,
+): AppsFindAppSecretQueryData | undefined {
+  const key = queryKeyAppsFindAppSecret(...queryKeyBase);
+
+  return client.setQueryData<AppsFindAppSecretQueryData>(key, data);
+}
+
+export function invalidateAppsFindAppSecret(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [parameters: {
+      name: string;
+      scope: components.AppSecretScope;
+      activationId?: number | undefined;
+      expand?: Array<operations.FindAppSecretQueryParamExpand> | undefined;
+    }]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "apps",
+      "findAppSecret",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllAppsFindAppSecret(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@greensecurity/javascript-sdk", "apps", "findAppSecret"],
+  });
+}