@vercel/sdk/src/models/getmicrofrontendsconfigop.ts

<p align="center"> <a href="https://vercel.com"> <img src="https://assets.vercel.com/image/upload/v1588805858/repositories/vercel/logo.png" height="96"> <h3 align="center">Vercel</h3> </a> <p align="center">Develop. Preview. Ship.</p> </p>

/*
 * 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 { ClosedEnum } from "../types/enums.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 "./sdkvalidationerror.js";

export type GetMicrofrontendsConfigRequest = {
  /**
   * The unique deployment identifier
   */
  deploymentId: string;
  /**
   * The Team identifier to perform the request on behalf of.
   */
  teamId?: string | undefined;
  /**
   * The Team slug to perform the request on behalf of.
   */
  slug?: string | undefined;
};

/**
 * The version of the microfrontends config schema.
 */
export const GetMicrofrontendsConfigVersion = {
  One: "1",
} as const;
/**
 * The version of the microfrontends config schema.
 */
export type GetMicrofrontendsConfigVersion = ClosedEnum<
  typeof GetMicrofrontendsConfigVersion
>;

export type ApplicationsLocal = string | number;

/**
 * Development configuration for the child application.
 */
export type ApplicationsDevelopment = {
  /**
   * Fallback for local development, could point to any environment. If not provided for child apps, the fallback of the default app will be used. If passing a string, include the protocol (optional), host (required) and port (optional). For example: `https://this.ismyhost:8080`. If omitted, the protocol defaults to HTTPS. If omitted, the port defaults to `80` for HTTP and `443` for HTTPS. See https://vercel.com/docs/microfrontends/local-development.
   */
  fallback?: string | undefined;
  local?: string | number | undefined;
  /**
   * The task to run when starting the development server. Should reference a script in the package.json of the application. The default value is "dev". See https://vercel.com/docs/microfrontends/local-development.
   */
  task?: string | undefined;
};

/**
 * Groups of path expressions that are routed to this application. See https://vercel.com/docs/microfrontends/path-routing.
 */
export type Routing = {
  /**
   * Group name for the paths.
   */
  group?: string | undefined;
  /**
   * The name of the feature flag that controls routing for this group of paths. See https://vercel.com/docs/microfrontends/path-routing#routing-changes-safely-with-flags.
   */
  flag?: string | undefined;
  /**
   * A list of path expressions that are routed to this application. See https://vercel.com/docs/microfrontends/path-routing#supported-path-expressions.
   */
  paths: Array<string>;
};

export type Applications2 = {
  /**
   * Development configuration for the child application.
   */
  development?: ApplicationsDevelopment | undefined;
  /**
   * Groups of path expressions that are routed to this application. See https://vercel.com/docs/microfrontends/path-routing.
   */
  routing: Array<Routing>;
  /**
   * The name of the asset prefix to use instead of the auto-generated name. The asset prefix is used to prefix all paths to static assets, such as JS, CSS, or images that are served by a specific application. It is necessary to ensure there are no conflicts with other applications on the same domain. An auto-generated asset prefix of the form `vc-ap-<hash>` is used when this field is not provided. When this field is provided, `/${assetPrefix}/:path*` must also be added to the list of paths in the `routing` field. Changing the asset prefix after a microfrontend application has already been deployed is not a forwards and backwards compatible change, and the asset prefix should be added to the `routing` field and deployed before setting the `assetPrefix` field. The default value is the auto-generated asset prefix of the form `vc-ap-<hash>`. See https://vercel.com/docs/microfrontends/path-routing#asset-prefix.
   */
  assetPrefix?: string | undefined;
  /**
   * The name used to run the application, e.g. the `name` field in the `package.json`. This is used by the local proxy to map the application config to the locally running app. This is only necessary when the application name does not match the `name` used in `package.json`. See https://vercel.com/docs/microfrontends/configuration#application-naming.
   */
  packageName?: string | undefined;
  projectId: string;
};

export type Local = string | number;

/**
 * Development configuration for the default application.
 */
export type Development = {
  /**
   * Fallback for local development, could point to any environment. This is required for the default app. This value is used as the fallback for child apps as well if they do not have a fallback. If passing a string, include the protocol (optional), host (required) and port (optional). For example: `https://this.ismyhost:8080`. If omitted, the protocol defaults to HTTPS. If omitted, the port defaults to `80` for HTTP and `443` for HTTPS. See https://vercel.com/docs/microfrontends/local-development.
   */
  fallback: string;
  local?: string | number | undefined;
  /**
   * The task to run when starting the development server. Should reference a script in the package.json of the application. The default value is "dev". See https://vercel.com/docs/microfrontends/local-development.
   */
  task?: string | undefined;
};

export type Applications1 = {
  /**
   * Development configuration for the default application.
   */
  development: Development;
  /**
   * The name used to run the application, e.g. the `name` field in the `package.json`. This is used by the local proxy to map the application config to the locally running app. This is only necessary when the application name does not match the `name` used in `package.json`. See https://vercel.com/docs/microfrontends/configuration#application-naming.
   */
  packageName?: string | undefined;
  projectId: string;
};

export type Applications = Applications1 | Applications2;

/**
 * Optional configuration options for the microfrontend.
 */
export type Options = {
  /**
   * If you want to disable the overrides for the site. For example, if you are managing rewrites between applications externally, you may wish to disable the overrides on the toolbar as they will have no effect. See https://vercel.com/docs/microfrontends/managing-microfrontends/vercel-toolbar#routing-overrides.
   */
  disableOverrides?: boolean | undefined;
  /**
   * The port number used by the local proxy server. The default value is 3024. See https://vercel.com/docs/microfrontends/local-development.
   */
  localProxyPort?: number | undefined;
};

/**
 * projectIds are added when the config is uploaded to s3 deployment assets.
 */
export type GetMicrofrontendsConfigConfig = {
  /**
   * See https://openapi.vercel.sh/microfrontends.json.
   */
  dollarSchema?: string | undefined;
  /**
   * The version of the microfrontends config schema.
   */
  version?: GetMicrofrontendsConfigVersion | undefined;
  applications: { [k: string]: Applications1 | Applications2 };
  /**
   * Optional configuration options for the microfrontend.
   */
  options?: Options | undefined;
};

export type GetMicrofrontendsConfigResponseBody = {
  /**
   * projectIds are added when the config is uploaded to s3 deployment assets.
   */
  config: GetMicrofrontendsConfigConfig | null;
};

/** @internal */
export type GetMicrofrontendsConfigRequest$Outbound = {
  deploymentId: string;
  teamId?: string | undefined;
  slug?: string | undefined;
};

/** @internal */
export const GetMicrofrontendsConfigRequest$outboundSchema: z.ZodType<
  GetMicrofrontendsConfigRequest$Outbound,
  z.ZodTypeDef,
  GetMicrofrontendsConfigRequest
> = z.object({
  deploymentId: z.string(),
  teamId: z.string().optional(),
  slug: z.string().optional(),
});

export function getMicrofrontendsConfigRequestToJSON(
  getMicrofrontendsConfigRequest: GetMicrofrontendsConfigRequest,
): string {
  return JSON.stringify(
    GetMicrofrontendsConfigRequest$outboundSchema.parse(
      getMicrofrontendsConfigRequest,
    ),
  );
}

/** @internal */
export const GetMicrofrontendsConfigVersion$inboundSchema: z.ZodNativeEnum<
  typeof GetMicrofrontendsConfigVersion
> = z.nativeEnum(GetMicrofrontendsConfigVersion);

/** @internal */
export const ApplicationsLocal$inboundSchema: z.ZodType<
  ApplicationsLocal,
  z.ZodTypeDef,
  unknown
> = smartUnion([types.string(), types.number()]);

export function applicationsLocalFromJSON(
  jsonString: string,
): SafeParseResult<ApplicationsLocal, SDKValidationError> {
  return safeParse(
    jsonString,
    (x) => ApplicationsLocal$inboundSchema.parse(JSON.parse(x)),
    `Failed to parse 'ApplicationsLocal' from JSON`,
  );
}

/** @internal */
export const ApplicationsDevelopment$inboundSchema: z.ZodType<
  ApplicationsDevelopment,
  z.ZodTypeDef,
  unknown
> = z.object({
  fallback: types.optional(types.string()),
  local: types.optional(smartUnion([types.string(), types.number()])),
  task: types.optional(types.string()),
});

export function applicationsDevelopmentFromJSON(
  jsonString: string,
): SafeParseResult<ApplicationsDevelopment, SDKValidationError> {
  return safeParse(
    jsonString,
    (x) => ApplicationsDevelopment$inboundSchema.parse(JSON.parse(x)),
    `Failed to parse 'ApplicationsDevelopment' from JSON`,
  );
}

/** @internal */
export const Routing$inboundSchema: z.ZodType<Routing, z.ZodTypeDef, unknown> =
  z.object({
    group: types.optional(types.string()),
    flag: types.optional(types.string()),
    paths: z.array(types.string()),
  });

export function routingFromJSON(
  jsonString: string,
): SafeParseResult<Routing, SDKValidationError> {
  return safeParse(
    jsonString,
    (x) => Routing$inboundSchema.parse(JSON.parse(x)),
    `Failed to parse 'Routing' from JSON`,
  );
}

/** @internal */
export const Applications2$inboundSchema: z.ZodType<
  Applications2,
  z.ZodTypeDef,
  unknown
> = z.object({
  development: types.optional(
    z.lazy(() => ApplicationsDevelopment$inboundSchema),
  ),
  routing: z.array(z.lazy(() => Routing$inboundSchema)),
  assetPrefix: types.optional(types.string()),
  packageName: types.optional(types.string()),
  projectId: types.string(),
});

export function applications2FromJSON(
  jsonString: string,
): SafeParseResult<Applications2, SDKValidationError> {
  return safeParse(
    jsonString,
    (x) => Applications2$inboundSchema.parse(JSON.parse(x)),
    `Failed to parse 'Applications2' from JSON`,
  );
}

/** @internal */
export const Local$inboundSchema: z.ZodType<Local, z.ZodTypeDef, unknown> =
  smartUnion([types.string(), types.number()]);

export function localFromJSON(
  jsonString: string,
): SafeParseResult<Local, SDKValidationError> {
  return safeParse(
    jsonString,
    (x) => Local$inboundSchema.parse(JSON.parse(x)),
    `Failed to parse 'Local' from JSON`,
  );
}

/** @internal */
export const Development$inboundSchema: z.ZodType<
  Development,
  z.ZodTypeDef,
  unknown
> = z.object({
  fallback: types.string(),
  local: types.optional(smartUnion([types.string(), types.number()])),
  task: types.optional(types.string()),
});

export function developmentFromJSON(
  jsonString: string,
): SafeParseResult<Development, SDKValidationError> {
  return safeParse(
    jsonString,
    (x) => Development$inboundSchema.parse(JSON.parse(x)),
    `Failed to parse 'Development' from JSON`,
  );
}

/** @internal */
export const Applications1$inboundSchema: z.ZodType<
  Applications1,
  z.ZodTypeDef,
  unknown
> = z.object({
  development: z.lazy(() => Development$inboundSchema),
  packageName: types.optional(types.string()),
  projectId: types.string(),
});

export function applications1FromJSON(
  jsonString: string,
): SafeParseResult<Applications1, SDKValidationError> {
  return safeParse(
    jsonString,
    (x) => Applications1$inboundSchema.parse(JSON.parse(x)),
    `Failed to parse 'Applications1' from JSON`,
  );
}

/** @internal */
export const Applications$inboundSchema: z.ZodType<
  Applications,
  z.ZodTypeDef,
  unknown
> = smartUnion([
  z.lazy(() => Applications1$inboundSchema),
  z.lazy(() => Applications2$inboundSchema),
]);

export function applicationsFromJSON(
  jsonString: string,
): SafeParseResult<Applications, SDKValidationError> {
  return safeParse(
    jsonString,
    (x) => Applications$inboundSchema.parse(JSON.parse(x)),
    `Failed to parse 'Applications' from JSON`,
  );
}

/** @internal */
export const Options$inboundSchema: z.ZodType<Options, z.ZodTypeDef, unknown> =
  z.object({
    disableOverrides: types.optional(types.boolean()),
    localProxyPort: types.optional(types.number()),
  });

export function optionsFromJSON(
  jsonString: string,
): SafeParseResult<Options, SDKValidationError> {
  return safeParse(
    jsonString,
    (x) => Options$inboundSchema.parse(JSON.parse(x)),
    `Failed to parse 'Options' from JSON`,
  );
}

/** @internal */
export const GetMicrofrontendsConfigConfig$inboundSchema: z.ZodType<
  GetMicrofrontendsConfigConfig,
  z.ZodTypeDef,
  unknown
> = z.object({
  $schema: types.optional(types.string()),
  version: types.optional(GetMicrofrontendsConfigVersion$inboundSchema),
  applications: z.record(
    smartUnion([
      z.lazy(() => Applications1$inboundSchema),
      z.lazy(() => Applications2$inboundSchema),
    ]),
  ),
  options: types.optional(z.lazy(() => Options$inboundSchema)),
}).transform((v) => {
  return remap$(v, {
    "$schema": "dollarSchema",
  });
});

export function getMicrofrontendsConfigConfigFromJSON(
  jsonString: string,
): SafeParseResult<GetMicrofrontendsConfigConfig, SDKValidationError> {
  return safeParse(
    jsonString,
    (x) => GetMicrofrontendsConfigConfig$inboundSchema.parse(JSON.parse(x)),
    `Failed to parse 'GetMicrofrontendsConfigConfig' from JSON`,
  );
}

/** @internal */
export const GetMicrofrontendsConfigResponseBody$inboundSchema: z.ZodType<
  GetMicrofrontendsConfigResponseBody,
  z.ZodTypeDef,
  unknown
> = z.object({
  config: types.nullable(
    z.lazy(() => GetMicrofrontendsConfigConfig$inboundSchema),
  ),
});

export function getMicrofrontendsConfigResponseBodyFromJSON(
  jsonString: string,
): SafeParseResult<GetMicrofrontendsConfigResponseBody, SDKValidationError> {
  return safeParse(
    jsonString,
    (x) =>
      GetMicrofrontendsConfigResponseBody$inboundSchema.parse(JSON.parse(x)),
    `Failed to parse 'GetMicrofrontendsConfigResponseBody' from JSON`,
  );
}