@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>
95 lines • 4.51 kB
JavaScript
/*
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
*/
import { encodeFormQuery, encodeSimple } from "../lib/encodings.js";
import { matchStatusCode } from "../lib/http.js";
import * as M from "../lib/matchers.js";
import { compactMap } from "../lib/primitives.js";
import { safeParse } from "../lib/schemas.js";
import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
import { pathToFunc } from "../lib/url.js";
import { UploadProjectAvatarRequest$outboundSchema, } from "../models/uploadprojectavatarprojectsresponse200applicationjsonresponsebodysecurityaction.js";
import { UploadProjectAvatarResponseBody$inboundSchema, } from "../models/uploadprojectavatarresponsebody.js";
import { APIPromise } from "../types/async.js";
/**
* Upload a project avatar
*
* @remarks
* Upload an image as the avatar of the project identified by `idOrName`. The request body is the raw bytes of a JPG, PNG, or SVG image; the `Content-Type` header must declare which. SVG payloads are sanitized and optimized server-side before storage. The final SHA-1 of the stored bytes becomes the project's `avatar` value. The actual upload pipeline (validation, sanitization, S3 write, conditional `updateProject`, and event emission) lives in the shared `@api/project-avatar-upload` helper so it can be reused by background workers.
*
* If set, this operation will use {@link Security.bearerToken} from the global security.
*/
export function projectsUploadProjectAvatar(client, request, options) {
return new APIPromise($do(client, request, options));
}
async function $do(client, request, options) {
const parsed = safeParse(request, (value) => UploadProjectAvatarRequest$outboundSchema.parse(value), "Input validation failed");
if (!parsed.ok) {
return [parsed, { status: "invalid" }];
}
const payload = parsed.value;
const body = payload.RequestBody instanceof Uint8Array
? new Uint8Array(payload.RequestBody).buffer
: payload.RequestBody;
const pathParams = {
idOrName: encodeSimple("idOrName", payload.idOrName, {
explode: false,
charEncoding: "percent",
}),
};
const path = pathToFunc("/v1/projects/{idOrName}/avatar")(pathParams);
const query = encodeFormQuery({
"slug": payload.slug,
"teamId": payload.teamId,
});
const headers = new Headers(compactMap({
"Content-Type": "application/octet-stream",
Accept: "application/json",
}));
const secConfig = await extractSecurity(client._options.bearerToken);
const securityInput = secConfig == null ? {} : { bearerToken: secConfig };
const requestSecurity = resolveGlobalSecurity(securityInput, [0]);
const context = {
options: client._options,
baseURL: options?.serverURL ?? client._baseURL ?? "",
operationID: "uploadProjectAvatar",
oAuth2Scopes: null,
resolvedSecurity: requestSecurity,
securitySource: client._options.bearerToken,
retryConfig: options?.retries
|| client._options.retryConfig
|| { strategy: "none" },
retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
};
const requestRes = client._createRequest(context, {
security: requestSecurity,
method: "POST",
baseURL: options?.serverURL,
path: path,
headers: headers,
query: query,
body: body,
userAgent: client._options.userAgent,
timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
}, options);
if (!requestRes.ok) {
return [requestRes, { status: "invalid" }];
}
const req = requestRes.value;
const doResult = await client._do(req, {
context,
isErrorStatusCode: (statusCode) => matchStatusCode({ status: statusCode }, ["4XX", "5XX"]),
retryConfig: context.retryConfig,
retryCodes: context.retryCodes,
});
if (!doResult.ok) {
return [doResult, { status: "request-error", request: req }];
}
const response = doResult.value;
const [result] = await M.match(M.json(200, UploadProjectAvatarResponseBody$inboundSchema), M.fail([400, 401, 403, 413, 415, "4XX"]), M.fail("5XX"))(response, req);
if (!result.ok) {
return [result, { status: "complete", request: req, response }];
}
return [result, { status: "complete", request: req, response }];
}
//# sourceMappingURL=projectsUploadProjectAvatar.js.map