@greensecurity/javascript-sdk 0.46.0 → 0.47.0-beta.0

package/src/react-query/appsPublishAppManifest.ts

@@ -0,0 +1,146 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { appsPublishAppManifest } from "../funcs/appsPublishAppManifest.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 AppsPublishAppManifestMutationVariables = {
+  request: components.AppManifest;
+  options?: RequestOptions;
+};
+
+export type AppsPublishAppManifestMutationData =
+  operations.PublishAppManifestPublishAppManifestOk;
+
+export type AppsPublishAppManifestMutationError =
+  | errors.ApiErrorResponse
+  | errors.UnprocessableEntityOrValidationError
+  | GreenSecurityError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Publish an app manifest
+ *
+ * @remarks
+ * Publishes a new version of your marketplace app's manifest: its listing, the permissions
+ * it requests, its UI bundle and views, and the extra origins its sandbox may reach.
+ * `apps-cli upload` calls it after checking that the hosted bundle matches your local
+ * build.
+ *
+ * Every submission is reviewed against the app's last accepted version, and the response's
+ * `status` says what became of it: `accepted`, `screening` (the network sources it adds are
+ * being checked), `pending_review` (it adds a sensitive permission and waits for a Green
+ * Security admin) or `rejected`, with `review_reasons`. A rejection still answers `200`, with
+ * `success` false. Only an accepted version replaces the permissions granted to the app, and
+ * new installations get it. An installation it adds nothing for uses it from the next time
+ * its views are opened; one it adds permissions or network sources for keeps its version
+ * until one of its admins approves the new ones. So publish only once the bundle at
+ * `ui_extensions.bundle.url` is live and matches `integrity`, and keep earlier bundles
+ * hosted. An upload that repeats the last accepted manifest exactly changes nothing.
+ *
+ * Leave out `ui_extensions` to publish a back-end-only app, one with no views that works
+ * only through its service account (see the second example). With a `version`, the
+ * manifest may only send installers to a view it has: `post_install_action.type`
+ * `app_settings_view` needs a `settings` view, and `app_main_view` needs a view for a
+ * viewport other than `settings`, or the manifest is refused with `422`. So an app whose
+ * only view is `settings` uses `app_settings_view`, and a back-end-only app uses `url` or
+ * leaves `post_install_action` out. Left out, the action follows the app's views:
+ * `app_main_view`, `app_settings_view` for a settings-only app, or no post-install step for
+ * a back-end-only app.
+ *
+ * Each permission must be an existing Green Security permission or a platform permission
+ * such as `app_secrets.write` (see `AppManifestPermission`). A manifest that names any
+ * other permission is refused with `400` "Permission '<name>' not found." and writes
+ * nothing: the app, its role and its role's permissions are left as they were.
+ *
+ * **Permissions.** Accepts the app service account's permanent token, or a developer CLI
+ * token (`gsd_`) of a user who is an `owner` or `developer` of the app, as
+ * `Authorization: Bearer`. App user and installation tokens are refused.
+ */
+export function useAppsPublishAppManifestMutation(
+  options?: MutationHookOptions<
+    AppsPublishAppManifestMutationData,
+    AppsPublishAppManifestMutationError,
+    AppsPublishAppManifestMutationVariables
+  >,
+): UseMutationResult<
+  AppsPublishAppManifestMutationData,
+  AppsPublishAppManifestMutationError,
+  AppsPublishAppManifestMutationVariables
+> {
+  const client = useGreenSecurityContext();
+  return useMutation({
+    ...buildAppsPublishAppManifestMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyAppsPublishAppManifest(): MutationKey {
+  return ["@greensecurity/javascript-sdk", "apps", "publishAppManifest"];
+}
+
+export function buildAppsPublishAppManifestMutation(
+  client$: GreenSecurityCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: AppsPublishAppManifestMutationVariables,
+  ) => Promise<AppsPublishAppManifestMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyAppsPublishAppManifest(),
+    mutationFn: function appsPublishAppManifestMutationFn({
+      request,
+      options,
+    }): Promise<AppsPublishAppManifestMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(appsPublishAppManifest(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/appsRemoveAppDeveloper.ts

@@ -0,0 +1,117 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { appsRemoveAppDeveloper } from "../funcs/appsRemoveAppDeveloper.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 AppsRemoveAppDeveloperMutationVariables = {
+  request: operations.RemoveAppDeveloperRequest;
+  options?: RequestOptions;
+};
+
+export type AppsRemoveAppDeveloperMutationData = components.DeleteApiResponse;
+
+export type AppsRemoveAppDeveloperMutationError =
+  | errors.ApiErrorResponse
+  | errors.UnprocessableEntityOrValidationError
+  | GreenSecurityError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Remove an app developer
+ *
+ * @remarks
+ * Removes a user from the app's developers and closes their dev sessions for it. The app's
+ * last `owner` cannot be removed (`409`).
+ *
+ * **Permissions.** Accepts the app service account's permanent token, or a developer CLI
+ * token (`gsd_`) of an `owner` of the app, as `Authorization: Bearer`. Anyone else is told
+ * the app does not exist (`404`).
+ */
+export function useAppsRemoveAppDeveloperMutation(
+  options?: MutationHookOptions<
+    AppsRemoveAppDeveloperMutationData,
+    AppsRemoveAppDeveloperMutationError,
+    AppsRemoveAppDeveloperMutationVariables
+  >,
+): UseMutationResult<
+  AppsRemoveAppDeveloperMutationData,
+  AppsRemoveAppDeveloperMutationError,
+  AppsRemoveAppDeveloperMutationVariables
+> {
+  const client = useGreenSecurityContext();
+  return useMutation({
+    ...buildAppsRemoveAppDeveloperMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyAppsRemoveAppDeveloper(): MutationKey {
+  return ["@greensecurity/javascript-sdk", "apps", "removeAppDeveloper"];
+}
+
+export function buildAppsRemoveAppDeveloperMutation(
+  client$: GreenSecurityCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: AppsRemoveAppDeveloperMutationVariables,
+  ) => Promise<AppsRemoveAppDeveloperMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyAppsRemoveAppDeveloper(),
+    mutationFn: function appsRemoveAppDeveloperMutationFn({
+      request,
+      options,
+    }): Promise<AppsRemoveAppDeveloperMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(appsRemoveAppDeveloper(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/appsRotateAppWebhookEndpointSecret.ts

@@ -0,0 +1,137 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { appsRotateAppWebhookEndpointSecret } from "../funcs/appsRotateAppWebhookEndpointSecret.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 AppsRotateAppWebhookEndpointSecretMutationVariables = {
+  request:
+    operations.RotateAppWebhookEndpointSecretRotateAppWebhookEndpointSecretRequest;
+  options?: RequestOptions;
+};
+
+export type AppsRotateAppWebhookEndpointSecretMutationData =
+  components.AppWebhookEndpointSecret;
+
+export type AppsRotateAppWebhookEndpointSecretMutationError =
+  | errors.ApiErrorResponse
+  | errors.UnprocessableEntityOrValidationError
+  | GreenSecurityError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Rotate your app's webhook signing secret
+ *
+ * @remarks
+ * Issues a new signing secret for your app's own webhook endpoint (the one its manifest's
+ * `webhooks` declares) and returns it. This is the only way to obtain the secret, and the only
+ * response that ever carries it.
+ *
+ * Call it once after the first publish that adds `webhooks`: the endpoint is created with a
+ * secret nobody has seen, so deliveries fail your signature check until you rotate. Each retry
+ * is signed again when it is sent, so a delivery still being retried (for about 50 minutes after
+ * it was first sent) verifies once you have the new secret; reconcile anything older with
+ * `GET /marketplace/activations`. Call it again whenever you want to replace the secret or have lost it. After the
+ * first rotation, the secret being replaced keeps signing for 24 hours, next to the new one, so
+ * you can deploy the new secret without rejecting deliveries already on their way.
+ *
+ * Changing `webhooks.url` or `webhooks.events` in a later publish keeps the secret.
+ *
+ * **Permissions.** Accepts only the app service account's own unscoped token, as
+ * `Authorization: Bearer`: its permanent token, or an access token from `client_credentials`
+ * issued without `activation_id` or `scope`. App tokens (`gsu_`, `gsi_`, `gsd_`, and the
+ * `gsdr_` refresh token) and a token narrowed with `scope` are refused with `403`. A `token`
+ * query parameter is refused with `401`, even alongside the header. An app the caller is not the
+ * service account of reads as `404`, the same as one that does not exist.
+ */
+export function useAppsRotateAppWebhookEndpointSecretMutation(
+  options?: MutationHookOptions<
+    AppsRotateAppWebhookEndpointSecretMutationData,
+    AppsRotateAppWebhookEndpointSecretMutationError,
+    AppsRotateAppWebhookEndpointSecretMutationVariables
+  >,
+): UseMutationResult<
+  AppsRotateAppWebhookEndpointSecretMutationData,
+  AppsRotateAppWebhookEndpointSecretMutationError,
+  AppsRotateAppWebhookEndpointSecretMutationVariables
+> {
+  const client = useGreenSecurityContext();
+  return useMutation({
+    ...buildAppsRotateAppWebhookEndpointSecretMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyAppsRotateAppWebhookEndpointSecret(): MutationKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "apps",
+    "rotateAppWebhookEndpointSecret",
+  ];
+}
+
+export function buildAppsRotateAppWebhookEndpointSecretMutation(
+  client$: GreenSecurityCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: AppsRotateAppWebhookEndpointSecretMutationVariables,
+  ) => Promise<AppsRotateAppWebhookEndpointSecretMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyAppsRotateAppWebhookEndpointSecret(),
+    mutationFn: function appsRotateAppWebhookEndpointSecretMutationFn({
+      request,
+      options,
+    }): Promise<AppsRotateAppWebhookEndpointSecretMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(appsRotateAppWebhookEndpointSecret(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/appsSetAppSecret.ts

@@ -0,0 +1,152 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { appsSetAppSecret } from "../funcs/appsSetAppSecret.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 AppsSetAppSecretMutationVariables = {
+  request: components.AppSecretSetRequest;
+  options?: RequestOptions;
+};
+
+export type AppsSetAppSecretMutationData = components.AppSecret;
+
+export type AppsSetAppSecretMutationError =
+  | errors.ApiErrorResponse
+  | errors.AppSecretsUnprocessable
+  | GreenSecurityError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Set an app secret
+ *
+ * @remarks
+ * Creates a secret, or replaces the payload and expiry of the secret with the same `name`
+ * in the same scope. Secrets are encrypted at rest and belong to one activation of your
+ * app: the app token's own activation, or the `activation_id` the service account sends.
+ * Removing that activation, or changing what it covers (its app, or the site, system,
+ * facility, company or user it is installed for), deletes all of its secrets.
+ *
+ * Each scope holds at most 25 secrets, and a payload is at most 8192 bytes once UTF-8
+ * encoded (fewer characters than that if it has multi-byte ones). `expires_at`, when
+ * given, must be in the future and less than 100 years away.
+ *
+ * **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 write to 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 useAppsSetAppSecretMutation(
+  options?: MutationHookOptions<
+    AppsSetAppSecretMutationData,
+    AppsSetAppSecretMutationError,
+    AppsSetAppSecretMutationVariables
+  >,
+): UseMutationResult<
+  AppsSetAppSecretMutationData,
+  AppsSetAppSecretMutationError,
+  AppsSetAppSecretMutationVariables
+> {
+  const client = useGreenSecurityContext();
+  return useMutation({
+    ...buildAppsSetAppSecretMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyAppsSetAppSecret(): MutationKey {
+  return ["@greensecurity/javascript-sdk", "apps", "setAppSecret"];
+}
+
+export function buildAppsSetAppSecretMutation(
+  client$: GreenSecurityCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: AppsSetAppSecretMutationVariables,
+  ) => Promise<AppsSetAppSecretMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyAppsSetAppSecret(),
+    mutationFn: function appsSetAppSecretMutationFn({
+      request,
+      options,
+    }): Promise<AppsSetAppSecretMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(appsSetAppSecret(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/companiesLookupCompanies.ts

@@ -77,6 +77,9 @@ export type CompaniesLookupCompaniesQueryError =
  * @remarks
  * Lists companies available to the caller as minimal lookup summaries for list and typeahead UIs.
  *
+ * For a vendor, the list holds the active companies on the vendor's site: the companies the
+ * vendor can add as managing companies. Other callers see the companies they can view.
+ *
  * **Permissions.** Requires the `companies.view` permission.
  */
 export function useCompaniesLookupCompanies(
@@ -106,6 +109,9 @@ export function useCompaniesLookupCompanies(
  * @remarks
  * Lists companies available to the caller as minimal lookup summaries for list and typeahead UIs.
  *
+ * For a vendor, the list holds the active companies on the vendor's site: the companies the
+ * vendor can add as managing companies. Other callers see the companies they can view.
+ *
  * **Permissions.** Requires the `companies.view` permission.
  */
 export function useCompaniesLookupCompaniesSuspense(
@@ -135,6 +141,9 @@ export function useCompaniesLookupCompaniesSuspense(
  * @remarks
  * Lists companies available to the caller as minimal lookup summaries for list and typeahead UIs.
  *
+ * For a vendor, the list holds the active companies on the vendor's site: the companies the
+ * vendor can add as managing companies. Other callers see the companies they can view.
+ *
  * **Permissions.** Requires the `companies.view` permission.
  */
 export function useCompaniesLookupCompaniesInfinite(
@@ -178,6 +187,9 @@ export function useCompaniesLookupCompaniesInfinite(
  * @remarks
  * Lists companies available to the caller as minimal lookup summaries for list and typeahead UIs.
  *
+ * For a vendor, the list holds the active companies on the vendor's site: the companies the
+ * vendor can add as managing companies. Other callers see the companies they can view.
+ *
  * **Permissions.** Requires the `companies.view` permission.
  */
 export function useCompaniesLookupCompaniesInfiniteSuspense(