UNPKG

@vercel/sdk

Version:

<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>

151 lines 5.75 kB
import * as z from "zod/v3"; import { Result as SafeParseResult } from "../types/fp.js"; import { SDKValidationError } from "./sdkvalidationerror.js"; export type SignKmsMessageRequestBody = { /** * Base64-encoded message to be signed. */ message: string; }; export type SignKmsMessageRequest = { /** * The ID of the issuer. */ issuerId: string; requestBody?: SignKmsMessageRequestBody | undefined; }; /** * "jwk" (JSON Web Key) Header Parameter */ export type Jwk = { /** * RSA JWK "n" (Modulus) Parameter */ n?: string | undefined; /** * RSA JWK "e" (Exponent) Parameter */ e?: string | undefined; /** * JWK "kty" (Key Type) Parameter */ kty?: string | undefined; /** * - EC JWK "crv" (Curve) Parameter - OKP JWK "crv" (The Subtype of Key Pair) Parameter */ crv?: string | undefined; /** * - EC JWK "x" (X Coordinate) Parameter - OKP JWK "x" (The public key) Parameter */ x?: string | undefined; /** * EC JWK "y" (Y Coordinate) Parameter */ y?: string | undefined; /** * JWK "alg" (Algorithm) Parameter */ alg?: string | undefined; /** * AKP JWK "pub" (Public Key) Parameter */ pub?: string | undefined; }; /** * The "header" member MUST be present and contain the value JWS Unprotected Header when the JWS Unprotected Header value is non- empty; otherwise, it MUST be absent. This value is represented as an unencoded JSON object, rather than as a string. These Header Parameter values are not integrity protected. */ export type Header = { /** * JWS "alg" (Algorithm) Header Parameter */ alg?: string | undefined; /** * This JWS Extension Header Parameter modifies the JWS Payload representation and the JWS Signing Input computation as per {@link https://www.rfc-editor.org/rfc/rfc7797 RFC7797}. */ b64?: boolean | undefined; /** * JWS "crit" (Critical) Header Parameter */ crit?: Array<string> | undefined; /** * "kid" (Key ID) Header Parameter */ kid?: string | undefined; /** * "x5t" (X.509 Certificate SHA-1 Thumbprint) Header Parameter */ x5t?: string | undefined; /** * "x5c" (X.509 Certificate Chain) Header Parameter */ x5c?: Array<string> | undefined; /** * "x5u" (X.509 URL) Header Parameter */ x5u?: string | undefined; /** * "jku" (JWK Set URL) Header Parameter */ jku?: string | undefined; /** * "jwk" (JSON Web Key) Header Parameter */ jwk?: Jwk | undefined; /** * "typ" (Type) Header Parameter */ typ?: string | undefined; /** * "cty" (Content Type) Header Parameter */ cty?: string | undefined; }; /** * Flattened JWS JSON Serialization Syntax token. Payload is returned as an empty string when JWS Unencoded Payload ({@link https://www.rfc-editor.org/rfc/rfc7797 RFC7797}) is used. */ export type Signature = { payload: string; signature: string; /** * The "header" member MUST be present and contain the value JWS Unprotected Header when the JWS Unprotected Header value is non- empty; otherwise, it MUST be absent. This value is represented as an unencoded JSON object, rather than as a string. These Header Parameter values are not integrity protected. */ header?: Header | undefined; /** * The "protected" member MUST be present and contain the value BASE64URL(UTF8(JWS Protected Header)) when the JWS Protected Header value is non-empty; otherwise, it MUST be absent. These Header Parameter values are integrity protected. */ protected?: string | undefined; }; export type SignKmsMessageResponseBody = { /** * Flattened JWS JSON Serialization Syntax token. Payload is returned as an empty string when JWS Unencoded Payload ({@link https://www.rfc-editor.org/rfc/rfc7797 RFC7797}) is used. */ signature: Signature; }; /** @internal */ export type SignKmsMessageRequestBody$Outbound = { message: string; }; /** @internal */ export declare const SignKmsMessageRequestBody$outboundSchema: z.ZodType<SignKmsMessageRequestBody$Outbound, z.ZodTypeDef, SignKmsMessageRequestBody>; export declare function signKmsMessageRequestBodyToJSON(signKmsMessageRequestBody: SignKmsMessageRequestBody): string; /** @internal */ export type SignKmsMessageRequest$Outbound = { issuerId: string; RequestBody?: SignKmsMessageRequestBody$Outbound | undefined; }; /** @internal */ export declare const SignKmsMessageRequest$outboundSchema: z.ZodType<SignKmsMessageRequest$Outbound, z.ZodTypeDef, SignKmsMessageRequest>; export declare function signKmsMessageRequestToJSON(signKmsMessageRequest: SignKmsMessageRequest): string; /** @internal */ export declare const Jwk$inboundSchema: z.ZodType<Jwk, z.ZodTypeDef, unknown>; export declare function jwkFromJSON(jsonString: string): SafeParseResult<Jwk, SDKValidationError>; /** @internal */ export declare const Header$inboundSchema: z.ZodType<Header, z.ZodTypeDef, unknown>; export declare function headerFromJSON(jsonString: string): SafeParseResult<Header, SDKValidationError>; /** @internal */ export declare const Signature$inboundSchema: z.ZodType<Signature, z.ZodTypeDef, unknown>; export declare function signatureFromJSON(jsonString: string): SafeParseResult<Signature, SDKValidationError>; /** @internal */ export declare const SignKmsMessageResponseBody$inboundSchema: z.ZodType<SignKmsMessageResponseBody, z.ZodTypeDef, unknown>; export declare function signKmsMessageResponseBodyFromJSON(jsonString: string): SafeParseResult<SignKmsMessageResponseBody, SDKValidationError>; //# sourceMappingURL=signkmsmessageop.d.ts.map