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

package/src/models/components/appdevuiextensions.ts

@@ -1,111 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import * as z from "zod/v3";
-import { safeParse } from "../../lib/schemas.js";
-import { Result as SafeParseResult } from "../../types/fp.js";
-import * as types from "../../types/primitives.js";
-import { SDKValidationError } from "../errors/sdkvalidationerror.js";
-import {
-  AppBundle,
-  AppBundle$inboundSchema,
-  AppBundle$Outbound,
-  AppBundle$outboundSchema,
-} from "./appbundle.js";
-import {
-  AppDevCsp,
-  AppDevCsp$inboundSchema,
-  AppDevCsp$Outbound,
-  AppDevCsp$outboundSchema,
-} from "./appdevcsp.js";
-import {
-  AppRoute,
-  AppRoute$inboundSchema,
-  AppRoute$Outbound,
-  AppRoute$outboundSchema,
-} from "./approute.js";
-import {
-  AppView,
-  AppView$inboundSchema,
-  AppView$Outbound,
-  AppView$outboundSchema,
-} from "./appview.js";
-
-/**
- * `AppUiExtensions` for a dev session. The CLI's dev server serves the bundle, so
- *
- * @remarks
- * `bundle.url` is never loaded, but `bundle` and `routes` must still equal the published
- * values (see `AppDevManifest`).
- */
-export type AppDevUiExtensions = {
-  /**
-   * Where the app's UI bundle is hosted. The host downloads it and checks `integrity` before
-   *
-   * @remarks
-   * any of it runs, so publish a new manifest whenever the bundle changes.
-   */
-  bundle?: AppBundle | undefined;
-  views?: Array<AppView> | undefined;
-  routes?: Array<AppRoute> | undefined;
-  /**
-   * `AppCsp` for a dev session, where sources may also be local http origins. The same
-   *
-   * @remarks
-   * limits apply.
-   * `connect_src` and `image_src` together may use at most 4096 characters, counting each
-   * source's length plus one, because every source goes into the sandbox's
-   * `Content-Security-Policy` header. JSON Schema cannot express this limit, but a manifest
-   * over it is invalid.
-   */
-  csp?: AppDevCsp | undefined;
-};
-
-/** @internal */
-export const AppDevUiExtensions$inboundSchema: z.ZodType<
-  AppDevUiExtensions,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  bundle: types.optional(AppBundle$inboundSchema),
-  views: types.optional(z.array(AppView$inboundSchema)),
-  routes: types.optional(z.array(AppRoute$inboundSchema)),
-  csp: types.optional(AppDevCsp$inboundSchema),
-});
-/** @internal */
-export type AppDevUiExtensions$Outbound = {
-  bundle?: AppBundle$Outbound | undefined;
-  views?: Array<AppView$Outbound> | undefined;
-  routes?: Array<AppRoute$Outbound> | undefined;
-  csp?: AppDevCsp$Outbound | undefined;
-};
-
-/** @internal */
-export const AppDevUiExtensions$outboundSchema: z.ZodType<
-  AppDevUiExtensions$Outbound,
-  z.ZodTypeDef,
-  AppDevUiExtensions
-> = z.object({
-  bundle: AppBundle$outboundSchema.optional(),
-  views: z.array(AppView$outboundSchema).optional(),
-  routes: z.array(AppRoute$outboundSchema).optional(),
-  csp: AppDevCsp$outboundSchema.optional(),
-});
-
-export function appDevUiExtensionsToJSON(
-  appDevUiExtensions: AppDevUiExtensions,
-): string {
-  return JSON.stringify(
-    AppDevUiExtensions$outboundSchema.parse(appDevUiExtensions),
-  );
-}
-export function appDevUiExtensionsFromJSON(
-  jsonString: string,
-): SafeParseResult<AppDevUiExtensions, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => AppDevUiExtensions$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'AppDevUiExtensions' from JSON`,
-  );
-}

package/src/models/components/appmanifest.ts

@@ -1,208 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import * as z from "zod/v3";
-import { remap as remap$ } from "../../lib/primitives.js";
-import { safeParse } from "../../lib/schemas.js";
-import { Result as SafeParseResult } from "../../types/fp.js";
-import * as types from "../../types/primitives.js";
-import { SDKValidationError } from "../errors/sdkvalidationerror.js";
-import {
-  AppConstantValue,
-  AppConstantValue$inboundSchema,
-  AppConstantValue$Outbound,
-  AppConstantValue$outboundSchema,
-} from "./appconstantvalue.js";
-import {
-  AppManifestId,
-  AppManifestId$inboundSchema,
-  AppManifestId$Outbound,
-  AppManifestId$outboundSchema,
-} from "./appmanifestid.js";
-import {
-  AppManifestPermission,
-  AppManifestPermission$inboundSchema,
-  AppManifestPermission$Outbound,
-  AppManifestPermission$outboundSchema,
-} from "./appmanifestpermission.js";
-import {
-  AppPostInstallAction,
-  AppPostInstallAction$inboundSchema,
-  AppPostInstallAction$Outbound,
-  AppPostInstallAction$outboundSchema,
-} from "./apppostinstallaction.js";
-import {
-  AppUiExtensions,
-  AppUiExtensions$inboundSchema,
-  AppUiExtensions$Outbound,
-  AppUiExtensions$outboundSchema,
-} from "./appuiextensions.js";
-import {
-  AppWebhooks,
-  AppWebhooks$inboundSchema,
-  AppWebhooks$Outbound,
-  AppWebhooks$outboundSchema,
-} from "./appwebhooks.js";
-
-/**
- * The manifest a marketplace app publishes (`green-app.json`). Besides the constraints
- *
- * @remarks
- * below, the server rejects a manifest that declares two views for one viewport, declares
- * views without a
- * `bundle`, declares a `bundle` or views without a `version`, sets
- * `post_install_action.type` to `url` without a `url`, or lists CSP sources over the
- * 4096-character budget described on `AppCsp`. `version` is optional only for
- * manifests without UI.
- *
- * `ui_extensions` is optional. Leave it out to publish a back-end-only app: one with no
- * views and no bundle, which works only through its service account (installation
- * tokens from `client_credentials` with `activation_id`, the Secret Store and webhooks).
- *
- * A manifest with a `version` may only send installers to a view it has:
- * `post_install_action.type` `app_settings_view` requires a view for the `settings`
- * viewport, and `app_main_view` requires a view for a viewport other than `settings`.
- * An app whose only view is `settings` therefore uses `app_settings_view`, and a
- * back-end-only app uses `url`, pointing at its own setup page, or leaves
- * `post_install_action` out for no post-install step. Manifests without a `version` are
- * not checked this way. A left-out action follows the app's views; see
- * `AppPostInstallAction`.
- */
-export type AppManifest = {
-  /**
-   * The marketplace app's id, as a number or a numeric string.
-   */
-  id: AppManifestId;
-  name: string;
-  /**
-   * An https URL of the app's icon.
-   */
-  icon: string;
-  shortDescription: string;
-  /**
-   * The app's semantic version.
-   */
-  version?: string | undefined;
-  permissions?: Array<AppManifestPermission> | undefined;
-  configurationInstructions: string;
-  supportInstructions: string;
-  /**
-   * Values delivered to every view as `environment.constants`. Keys are identifiers of up to 100 characters.
-   */
-  constants?: { [k: string]: AppConstantValue } | undefined;
-  /**
-   * The app's UI. Each surface takes at most one view, and `bundle` is required as soon as
-   *
-   * @remarks
-   * any view is declared. Optional: a manifest without it is a back-end-only app.
-   */
-  uiExtensions?: AppUiExtensions | undefined;
-  /**
-   * What the installer sees once the app is installed. `url` is required when `type` is
-   *
-   * @remarks
-   * `url`. In a manifest with a `version`, `app_settings_view` requires a `settings` view,
-   * and `app_main_view` requires a view for a viewport other than `settings`.
-   *
-   * Left out, the action follows the app's views, so it never names a view the app lacks:
-   * `app_main_view` when the app has a view other than `settings`, `app_settings_view`
-   * when `settings` is its only view, and no post-install step for a back-end-only app.
-   * A back-end-only app that wants to send installers somewhere uses `url`.
-   */
-  postInstallAction?: AppPostInstallAction | undefined;
-  /**
-   * The app's own webhook endpoint. It is not tied to any tenant: Green Security registers
-   *
-   * @remarks
-   * it when the manifest is published and sends it only this app's installation
-   * lifecycle events (the `events` values below), so the app hears about every install,
-   * including its first, every change and every uninstall. A back-end-only app, which no
-   * user ever opens, learns about new installations this way.
-   */
-  webhooks?: AppWebhooks | undefined;
-};
-
-/** @internal */
-export const AppManifest$inboundSchema: z.ZodType<
-  AppManifest,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  id: AppManifestId$inboundSchema,
-  name: types.string(),
-  icon: types.string(),
-  short_description: types.string(),
-  version: types.optional(types.string()),
-  permissions: types.optional(z.array(AppManifestPermission$inboundSchema)),
-  configuration_instructions: types.string(),
-  support_instructions: types.string(),
-  constants: types.optional(z.record(AppConstantValue$inboundSchema)),
-  ui_extensions: types.optional(AppUiExtensions$inboundSchema),
-  post_install_action: types.optional(AppPostInstallAction$inboundSchema),
-  webhooks: types.optional(AppWebhooks$inboundSchema),
-}).transform((v) => {
-  return remap$(v, {
-    "short_description": "shortDescription",
-    "configuration_instructions": "configurationInstructions",
-    "support_instructions": "supportInstructions",
-    "ui_extensions": "uiExtensions",
-    "post_install_action": "postInstallAction",
-  });
-});
-/** @internal */
-export type AppManifest$Outbound = {
-  id: AppManifestId$Outbound;
-  name: string;
-  icon: string;
-  short_description: string;
-  version?: string | undefined;
-  permissions?: Array<AppManifestPermission$Outbound> | undefined;
-  configuration_instructions: string;
-  support_instructions: string;
-  constants?: { [k: string]: AppConstantValue$Outbound } | undefined;
-  ui_extensions?: AppUiExtensions$Outbound | undefined;
-  post_install_action?: AppPostInstallAction$Outbound | undefined;
-  webhooks?: AppWebhooks$Outbound | undefined;
-};
-
-/** @internal */
-export const AppManifest$outboundSchema: z.ZodType<
-  AppManifest$Outbound,
-  z.ZodTypeDef,
-  AppManifest
-> = z.object({
-  id: AppManifestId$outboundSchema,
-  name: z.string(),
-  icon: z.string(),
-  shortDescription: z.string(),
-  version: z.string().optional(),
-  permissions: z.array(AppManifestPermission$outboundSchema).optional(),
-  configurationInstructions: z.string(),
-  supportInstructions: z.string(),
-  constants: z.record(AppConstantValue$outboundSchema).optional(),
-  uiExtensions: AppUiExtensions$outboundSchema.optional(),
-  postInstallAction: AppPostInstallAction$outboundSchema.optional(),
-  webhooks: AppWebhooks$outboundSchema.optional(),
-}).transform((v) => {
-  return remap$(v, {
-    shortDescription: "short_description",
-    configurationInstructions: "configuration_instructions",
-    supportInstructions: "support_instructions",
-    uiExtensions: "ui_extensions",
-    postInstallAction: "post_install_action",
-  });
-});
-
-export function appManifestToJSON(appManifest: AppManifest): string {
-  return JSON.stringify(AppManifest$outboundSchema.parse(appManifest));
-}
-export function appManifestFromJSON(
-  jsonString: string,
-): SafeParseResult<AppManifest, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => AppManifest$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'AppManifest' from JSON`,
-  );
-}

package/src/models/components/appmanifestid.ts

@@ -1,44 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import * as z from "zod/v3";
-import { safeParse } from "../../lib/schemas.js";
-import { Result as SafeParseResult } from "../../types/fp.js";
-import * as types from "../../types/primitives.js";
-import { smartUnion } from "../../types/smartUnion.js";
-import { SDKValidationError } from "../errors/sdkvalidationerror.js";
-
-/**
- * The marketplace app's id, as a number or a numeric string.
- */
-export type AppManifestId = number | string;
-
-/** @internal */
-export const AppManifestId$inboundSchema: z.ZodType<
-  AppManifestId,
-  z.ZodTypeDef,
-  unknown
-> = smartUnion([types.number(), types.string()]);
-/** @internal */
-export type AppManifestId$Outbound = number | string;
-
-/** @internal */
-export const AppManifestId$outboundSchema: z.ZodType<
-  AppManifestId$Outbound,
-  z.ZodTypeDef,
-  AppManifestId
-> = smartUnion([z.number().int(), z.string()]);
-
-export function appManifestIdToJSON(appManifestId: AppManifestId): string {
-  return JSON.stringify(AppManifestId$outboundSchema.parse(appManifestId));
-}
-export function appManifestIdFromJSON(
-  jsonString: string,
-): SafeParseResult<AppManifestId, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => AppManifestId$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'AppManifestId' from JSON`,
-  );
-}

package/src/models/components/appmanifestpermission.ts

@@ -1,88 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import * as z from "zod/v3";
-import { safeParse } from "../../lib/schemas.js";
-import { Result as SafeParseResult } from "../../types/fp.js";
-import * as types from "../../types/primitives.js";
-import { SDKValidationError } from "../errors/sdkvalidationerror.js";
-
-export type AppManifestPermission = {
-  /**
-   * A `resource.action` permission. It is granted to the app's role, and an app user
-   *
-   * @remarks
-   * token only carries it when the user's own role has it too.
-   *
-   * It may also be a platform permission, which turns on a platform feature rather
-   * than access to Green Security data. A platform permission is checked against the
-   * app's role only, never the user's, and never appears in a user token's `scope`.
-   * Today there is one: `app_secrets.write`, which lets the app use the Secret Store
-   * (`/apps/secrets`) with any token.
-   */
-  permission: string;
-  /**
-   * Why the app needs the permission. Shown to the administrators who install it.
-   *
-   * @remarks
-   * Review requires at least 30 characters for a permission a submission adds, not
-   * just the permission's name, and not the same text as another entry's.
-   */
-  purpose: string;
-  /**
-   * Why the app can't work without a sensitive permission: one that writes (any
-   *
-   * @remarks
-   * action other than `view` or `search`) or that reads records about people. Review
-   * requires one, of at least 40 characters, for every sensitive permission a
-   * submission adds, and holds that submission for a Green Security admin. Shown to
-   * the reviewer and to the administrators who install the app.
-   */
-  justification?: string | undefined;
-};
-
-/** @internal */
-export const AppManifestPermission$inboundSchema: z.ZodType<
-  AppManifestPermission,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  permission: types.string(),
-  purpose: types.string(),
-  justification: types.optional(types.string()),
-});
-/** @internal */
-export type AppManifestPermission$Outbound = {
-  permission: string;
-  purpose: string;
-  justification?: string | undefined;
-};
-
-/** @internal */
-export const AppManifestPermission$outboundSchema: z.ZodType<
-  AppManifestPermission$Outbound,
-  z.ZodTypeDef,
-  AppManifestPermission
-> = z.object({
-  permission: z.string(),
-  purpose: z.string(),
-  justification: z.string().optional(),
-});
-
-export function appManifestPermissionToJSON(
-  appManifestPermission: AppManifestPermission,
-): string {
-  return JSON.stringify(
-    AppManifestPermission$outboundSchema.parse(appManifestPermission),
-  );
-}
-export function appManifestPermissionFromJSON(
-  jsonString: string,
-): SafeParseResult<AppManifestPermission, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => AppManifestPermission$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'AppManifestPermission' from JSON`,
-  );
-}

package/src/models/components/apppostinstallaction.ts

@@ -1,92 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import * as z from "zod/v3";
-import { safeParse } from "../../lib/schemas.js";
-import * as openEnums from "../../types/enums.js";
-import { OpenEnum } from "../../types/enums.js";
-import { Result as SafeParseResult } from "../../types/fp.js";
-import * as types from "../../types/primitives.js";
-import { SDKValidationError } from "../errors/sdkvalidationerror.js";
-
-export const AppPostInstallActionType = {
-  Url: "url",
-  AppSettingsView: "app_settings_view",
-  AppMainView: "app_main_view",
-} as const;
-export type AppPostInstallActionType = OpenEnum<
-  typeof AppPostInstallActionType
->;
-
-/**
- * What the installer sees once the app is installed. `url` is required when `type` is
- *
- * @remarks
- * `url`. In a manifest with a `version`, `app_settings_view` requires a `settings` view,
- * and `app_main_view` requires a view for a viewport other than `settings`.
- *
- * Left out, the action follows the app's views, so it never names a view the app lacks:
- * `app_main_view` when the app has a view other than `settings`, `app_settings_view`
- * when `settings` is its only view, and no post-install step for a back-end-only app.
- * A back-end-only app that wants to send installers somewhere uses `url`.
- */
-export type AppPostInstallAction = {
-  type: AppPostInstallActionType;
-  url?: string | undefined;
-};
-
-/** @internal */
-export const AppPostInstallActionType$inboundSchema: z.ZodType<
-  AppPostInstallActionType,
-  z.ZodTypeDef,
-  unknown
-> = openEnums.inboundSchema(AppPostInstallActionType);
-/** @internal */
-export const AppPostInstallActionType$outboundSchema: z.ZodType<
-  string,
-  z.ZodTypeDef,
-  AppPostInstallActionType
-> = openEnums.outboundSchema(AppPostInstallActionType);
-
-/** @internal */
-export const AppPostInstallAction$inboundSchema: z.ZodType<
-  AppPostInstallAction,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  type: AppPostInstallActionType$inboundSchema,
-  url: types.optional(types.string()),
-});
-/** @internal */
-export type AppPostInstallAction$Outbound = {
-  type: string;
-  url?: string | undefined;
-};
-
-/** @internal */
-export const AppPostInstallAction$outboundSchema: z.ZodType<
-  AppPostInstallAction$Outbound,
-  z.ZodTypeDef,
-  AppPostInstallAction
-> = z.object({
-  type: AppPostInstallActionType$outboundSchema,
-  url: z.string().optional(),
-});
-
-export function appPostInstallActionToJSON(
-  appPostInstallAction: AppPostInstallAction,
-): string {
-  return JSON.stringify(
-    AppPostInstallAction$outboundSchema.parse(appPostInstallAction),
-  );
-}
-export function appPostInstallActionFromJSON(
-  jsonString: string,
-): SafeParseResult<AppPostInstallAction, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => AppPostInstallAction$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'AppPostInstallAction' from JSON`,
-  );
-}

package/src/models/components/appreviewreason.ts

@@ -1,52 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import * as z from "zod/v3";
-import { safeParse } from "../../lib/schemas.js";
-import { Result as SafeParseResult } from "../../types/fp.js";
-import * as types from "../../types/primitives.js";
-import { SDKValidationError } from "../errors/sdkvalidationerror.js";
-
-/**
- * One finding of the review of a catalog submission.
- */
-export type AppReviewReason = {
-  /**
-   * What the review found, for example `purpose_too_short`,
-   *
-   * @remarks
-   * `justification_required`, `csp_denylisted`, `csp_ip_literal`, `csp_tls_failed`,
-   * `version_reused`, `superseded` or `rejected_by_reviewer`. New codes may be added.
-   */
-  code: string;
-  /**
-   * The finding in words. For `rejected_by_reviewer`, the reviewer's reason.
-   */
-  message: string;
-  /**
-   * The manifest field the finding is about, as a dotted path, when there is one.
-   */
-  path?: string | undefined;
-};
-
-/** @internal */
-export const AppReviewReason$inboundSchema: z.ZodType<
-  AppReviewReason,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  code: types.string(),
-  message: types.string(),
-  path: types.optional(types.string()),
-});
-
-export function appReviewReasonFromJSON(
-  jsonString: string,
-): SafeParseResult<AppReviewReason, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => AppReviewReason$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'AppReviewReason' from JSON`,
-  );
-}

package/src/models/components/approute.ts

@@ -1,55 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import * as z from "zod/v3";
-import { safeParse } from "../../lib/schemas.js";
-import { Result as SafeParseResult } from "../../types/fp.js";
-import * as types from "../../types/primitives.js";
-import { SDKValidationError } from "../errors/sdkvalidationerror.js";
-
-/**
- * Reserved for a future full-page view. Stored and validated, not rendered.
- */
-export type AppRoute = {
-  path: string;
-  component: string;
-};
-
-/** @internal */
-export const AppRoute$inboundSchema: z.ZodType<
-  AppRoute,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  path: types.string(),
-  component: types.string(),
-});
-/** @internal */
-export type AppRoute$Outbound = {
-  path: string;
-  component: string;
-};
-
-/** @internal */
-export const AppRoute$outboundSchema: z.ZodType<
-  AppRoute$Outbound,
-  z.ZodTypeDef,
-  AppRoute
-> = z.object({
-  path: z.string(),
-  component: z.string(),
-});
-
-export function appRouteToJSON(appRoute: AppRoute): string {
-  return JSON.stringify(AppRoute$outboundSchema.parse(appRoute));
-}
-export function appRouteFromJSON(
-  jsonString: string,
-): SafeParseResult<AppRoute, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => AppRoute$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'AppRoute' from JSON`,
-  );
-}