///
import {
ApiPayload,
ComponentPayload,
GetComponent,
GetComponentInput,
SdkError,
} from '@atlassian/forge-graphql-types';
import { CompassRequests } from '../../compass-requests';
import {
COMPONENT_RETRIEVAL_OPTIONS,
mapGqlErrors,
mapQueryErrors,
parsingResponseError,
transformGqlComponent,
} from '../../helpers';
declare module '../../compass-requests' {
interface CompassRequests {
/**
* Retrieves a single component by its internal ID.
* **Required Oauth Scopes:** `read:component:compass`
*/
getComponent(
input: GetComponentInput,
): Promise>;
}
}
CompassRequests.prototype.getComponent = async function (
this: CompassRequests,
{ options, ...getComponentInput },
) {
let component = null;
let errorsResp: SdkError[] = [];
try {
const resp = await this.api.requestGraph(
GetComponent,
{ ...getComponentInput, ...COMPONENT_RETRIEVAL_OPTIONS, ...options },
'getComponent',
);
const { data, errors: gqlErrors } = await resp.json();
errorsResp = mapGqlErrors(gqlErrors);
errorsResp = errorsResp.concat(
mapQueryErrors(data.compass, [
'component',
'component.relationships',
'component.metricSources',
]),
);
if (errorsResp.length === 0) {
component = transformGqlComponent(data.compass.component);
}
} catch (e) {
if (errorsResp.length === 0) {
errorsResp.push(parsingResponseError(e));
}
}
return {
errors: errorsResp,
success: errorsResp.length === 0,
data: { component },
};
};