@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>
42 lines • 1.88 kB
TypeScript
import * as z from "zod/v3";
import { ClosedEnum } from "../types/enums.js";
import { Result as SafeParseResult } from "../types/fp.js";
import { SDKValidationError } from "./sdkvalidationerror.js";
export declare const FlagsSDKKeyWithSecretsType: {
readonly Client: "client";
readonly Mobile: "mobile";
readonly Server: "server";
};
export type FlagsSDKKeyWithSecretsType = ClosedEnum<typeof FlagsSDKKeyWithSecretsType>;
/**
* Representation of a Flags SDK key returned by CREATE. Includes cleartext secrets (`keyValue`, `tokenValue`, `connectionString`) which are only ever disclosed once, on creation.
*/
export type FlagsSDKKeyWithSecrets = {
hashKey: string;
projectId: string;
type: FlagsSDKKeyWithSecretsType;
environment: string;
createdBy: string;
createdAt: number;
updatedAt: number;
label?: string | undefined;
deletedAt?: number | undefined;
/**
* Partially-masked representation of the SDK key value, safe to display in UIs. The value is the `vf_<type>_` prefix followed by the first 3 characters of the secret portion and a fixed 8-character `*` mask (e.g. `vf_server_abc********`).
*/
partialKeyValue: string;
/**
* Cleartext value of the SDK key.
*/
keyValue: string;
/**
* Cleartext value of the Edge Config token, when the project has an Edge Config connection.
*/
tokenValue?: string | undefined;
};
/** @internal */
export declare const FlagsSDKKeyWithSecretsType$inboundSchema: z.ZodNativeEnum<typeof FlagsSDKKeyWithSecretsType>;
/** @internal */
export declare const FlagsSDKKeyWithSecrets$inboundSchema: z.ZodType<FlagsSDKKeyWithSecrets, z.ZodTypeDef, unknown>;
export declare function flagsSDKKeyWithSecretsFromJSON(jsonString: string): SafeParseResult<FlagsSDKKeyWithSecrets, SDKValidationError>;
//# sourceMappingURL=flagssdkkeywithsecrets.d.ts.map