) => void,
+): void {
+ const { body } = err as MonkHTTPError;
+ handleError(err, {
+ extras: {
+ body,
+ completeResponse: JSON.stringify(body),
+ },
+ });
+ throw err;
+}
+
function reactify, A extends MonkAction, R extends Promise>(
request: MonkApiRequest,
config: MonkApiConfig,
@@ -17,16 +31,7 @@ function reactify, A extends MonkAction, R extends Prom
): (...params: P) => R {
return useCallback(
(...params: P) =>
- request(...params, config, dispatch).catch((err) => {
- const { body } = err as MonkHTTPError;
- handleError(err, {
- extras: {
- body,
- completeResponse: JSON.stringify(body),
- },
- });
- throw err;
- }) as R,
+ request(...params, config, dispatch).catch((err) => handleAPIError(err, handleError)) as R,
[],
);
}
@@ -86,5 +91,14 @@ export function useMonkApi(config: MonkApiConfig) {
* @see updateTaskStatus
*/
startInspectionTasks: reactify(MonkApi.startInspectionTasks, config, dispatch, handleError),
+ /**
+ * Fetch a webapp live configuration from the API.
+ *
+ * @param id The ID of the live config to get.
+ */
+ getLiveConfig: useCallback(
+ (id: string) => MonkApi.getLiveConfig(id).catch((err) => handleAPIError(err, handleError)),
+ [handleError],
+ ),
};
}
diff --git a/packages/network/test/api/config.test.ts b/packages/network/test/api/config.test.ts
index bd4a0159f..749b0074f 100644
--- a/packages/network/test/api/config.test.ts
+++ b/packages/network/test/api/config.test.ts
@@ -15,6 +15,12 @@ describe('Network package API global config utils', () => {
authToken: 'Bearer testtoken',
};
+ it('should return no prefixUrl and Authorization header if no API config is provided', () => {
+ const options = getDefaultOptions();
+ expect(options.prefixUrl).toBeUndefined();
+ expect(options.headers).toEqual(expect.objectContaining({ Authorization: undefined }));
+ });
+
it('should return the proper prefixUrl', () => {
expect(getDefaultOptions(baseConfig).prefixUrl).toEqual(`https://${baseConfig.apiDomain}`);
});
diff --git a/packages/network/test/api/liveConfigs/requests.test.ts b/packages/network/test/api/liveConfigs/requests.test.ts
new file mode 100644
index 000000000..b9bad4a75
--- /dev/null
+++ b/packages/network/test/api/liveConfigs/requests.test.ts
@@ -0,0 +1,28 @@
+jest.mock('../../../src/api/config', () => ({
+ getDefaultOptions: jest.fn(() => ({ prefixUrl: 'getDefaultOptionsTest' })),
+}));
+
+import ky from 'ky';
+import { getDefaultOptions } from '../../../src/api/config';
+import { getLiveConfig } from '../../../src/api/liveConfigs';
+
+describe('Live Configs API requests', () => {
+ describe('getLiveConfig request', () => {
+ it('should fetch the live config at the proper URL and prevent caching from the browser', async () => {
+ const id = 'test-live-config-id-test';
+ const result = await getLiveConfig(id);
+
+ expect(getDefaultOptions).toHaveBeenCalledWith();
+ expect(ky.get).toHaveBeenCalledWith(expect.any(String), getDefaultOptions());
+ const url = (ky.get as jest.Mock).mock.calls[0][0];
+ expect(
+ url.startsWith(
+ `https://storage.googleapis.com/monk-front-public/live-configurations/${id}.json?nocache=`,
+ ),
+ ).toBe(true);
+ const response = await (ky.get as jest.Mock).mock.results[0].value;
+ const body = await response.json();
+ expect(result).toEqual(body);
+ });
+ });
+});
diff --git a/packages/types/src/config.ts b/packages/types/src/config.ts
index 0b6b6dca5..4b5c533a6 100644
--- a/packages/types/src/config.ts
+++ b/packages/types/src/config.ts
@@ -38,6 +38,10 @@ export type CameraConfig = Partial & {
*/
export type CaptureAppConfig = CameraConfig &
Partial & {
+ /**
+ * An optional list of additional tasks to run on every Sight of the inspection.
+ */
+ additionalTasks?: TaskName[];
/**
* Record associating each sight with a list of tasks to execute for it. If not provided, the default tasks of the
* sight will be used.
@@ -172,7 +176,7 @@ export type LiveConfig = CaptureAppConfig & {
*/
id: string;
/**
- * The name of the live config.
+ * The description of the configuration.
*/
- name?: string;
+ description: string;
};