@abyss-project/probe 2.0.0 → 2.0.1

package/src/index.ts

@@ -1,205 +1,205 @@
-import axios from 'axios';
-import axiosRetry, { IAxiosRetryConfig, isNetworkOrIdempotentRequestError } from 'axios-retry';
-import * as probeScanApi from './api/probe-scan.api';
-import * as probeWebhookApi from './api/probe-webhook.api';
-import * as probeScanApplicationApi from './api/probe-scan.application.api';
-import * as probeWebhookApplicationApi from './api/probe-webhook.application.api';
-import * as probeUsageApi from './api/probe-usage.api';
-import * as probeUsageApplicationApi from './api/probe-usage.application.api';
-
-export * from './api';
-export * from './types';
-export * from './utils';
-export * from './constants';
-
-const DEFAULT_BASE_URL = 'https://probe-api.abyss-project.fr/api/';
-
-export const API_KEY_HEADER = 'abyss-api-key';
-/**
- * Application-level API key header (AbyssProbe application/API-key
- * authentication). Same literal value every other Abyss service's own core
- * package independently declares for its `ApplicationMiddleware`.
- */
-export const API_KEY_APPLICATION_HEADER = 'abyss-api-key-application';
-export const ADMIN_TOKEN_HEADER = 'abyss-admin-token';
-
-/**
- * Header carrying the HMAC-SHA256 signature of a probe webhook delivery's
- * raw JSON body. Verify it with {@link verifyProbeWebhookSignature}
- * (re-exported from './utils').
- */
-export const PROBE_WEBHOOK_SIGNATURE_HEADER = 'x-probe-signature';
-export const PROBE_WEBHOOK_SIGNATURE_ALGORITHM = 'sha256';
-
-const NUMBER_RETRY_API = 10;
-const BASE_DELAY_BETWEEN_RETRY = 5000;
-const RETRY_CODES = [
-  502, // Bad Gateway
-  503, // Service Unavailable
-];
-
-type CoreConfig = {
-  token?: string;
-  apiKey?: string;
-  adminToken?: string;
-  baseURL?: string;
-};
-
-type AbyssProbeCoreSDK = {
-  probe: {
-    /** `POST /scan` — sync (default) or async depending on `options.mode`. */
-    scan: typeof probeScanApi.scan;
-    /** `POST /scan` forced to `mode: sync` — precisely-typed 200 response. */
-    scanSync: typeof probeScanApi.scanSync;
-    /** `POST /scan?mode=async` — precisely-typed 202 response. */
-    scanAsync: typeof probeScanApi.scanAsync;
-    /** `GET /scan/:scanId` — poll a scan's status/verdict. */
-    getScan: typeof probeScanApi.getScan;
-    /** `GET /scan` — paginated history/search. */
-    listScans: typeof probeScanApi.listScans;
-    /** `GET /usage` — current ACCOUNT_AV_SCAN_UNITS used/limit/remaining for the caller's scope. */
-    usage: {
-      get: typeof probeUsageApi.getProbeUsage;
-    };
-    webhook: {
-      create: typeof probeWebhookApi.createProbeWebhook;
-      list: typeof probeWebhookApi.listProbeWebhook;
-      delete: typeof probeWebhookApi.deleteProbeWebhook;
-      /** `PATCH /webhook/:webhookId` — edit callbackUrl and/or active. */
-      update: typeof probeWebhookApi.updateProbeWebhook;
-      /** `GET /webhook/:webhookId/deliveries` — paginated delivery-attempt history. */
-      listDeliveries: typeof probeWebhookApi.listProbeWebhookDeliveries;
-    };
-    /**
-     * Application/API-key-auth counterpart (Phase 3a) — for inter-service
-     * callers (abyss-storage, external integrations) instead of a
-     * personal/org session. Same request/response contracts as the methods
-     * above, hitting `/application/:applicationId/...` and authenticated
-     * with the `abyss-api-key-application` header ({@link
-     * API_KEY_APPLICATION_HEADER}) instead of the personal `abyss-api-key`.
-     */
-    application: {
-      /** `POST /application/:applicationId/scan` — sync (default) or async depending on `options.mode`. */
-      scan: typeof probeScanApplicationApi.scanApplication;
-      /** `POST /application/:applicationId/scan` forced to `mode: sync` — precisely-typed 200 response. */
-      scanSync: typeof probeScanApplicationApi.scanSyncApplication;
-      /** `POST /application/:applicationId/scan?mode=async` — precisely-typed 202 response. */
-      scanAsync: typeof probeScanApplicationApi.scanAsyncApplication;
-      /** `GET /application/:applicationId/scan/:scanId` — poll a scan's status/verdict. */
-      getScan: typeof probeScanApplicationApi.getScanApplication;
-      /** `GET /application/:applicationId/scan` — paginated history/search. */
-      listScans: typeof probeScanApplicationApi.listScansApplication;
-      /** `GET /application/:applicationId/usage` — current ACCOUNT_AV_SCAN_UNITS used/limit/remaining for the calling application. */
-      usage: {
-        get: typeof probeUsageApplicationApi.getProbeUsageApplication;
-      };
-      webhook: {
-        create: typeof probeWebhookApplicationApi.createProbeWebhookApplication;
-        list: typeof probeWebhookApplicationApi.listProbeWebhookApplication;
-        delete: typeof probeWebhookApplicationApi.deleteProbeWebhookApplication;
-        /** `PATCH /application/:applicationId/webhook/:webhookId` — edit callbackUrl and/or active. */
-        update: typeof probeWebhookApplicationApi.updateProbeWebhookApplication;
-        /** `GET /application/:applicationId/webhook/:webhookId/deliveries` — paginated delivery-attempt history. */
-        listDeliveries: typeof probeWebhookApplicationApi.listProbeWebhookDeliveriesApplication;
-      };
-    };
-  };
-};
-
-export class AbyssProbeCore {
-  private static config = {
-    token: '',
-    apiKey: '',
-    adminToken: '',
-    baseURL: DEFAULT_BASE_URL,
-  };
-  static axios = axios.create({
-    baseURL: this.config.baseURL,
-    withCredentials: true,
-  });
-
-  private static _sdk: AbyssProbeCoreSDK | null = null;
-
-  public static get sdk(): AbyssProbeCoreSDK {
-    if (!AbyssProbeCore._sdk) {
-      AbyssProbeCore._sdk = AbyssProbeCore.buildSDK();
-    }
-    return AbyssProbeCore._sdk;
-  }
-
-  private static buildSDK(): AbyssProbeCoreSDK {
-    return {
-      probe: {
-        scan: probeScanApi.scan,
-        scanSync: probeScanApi.scanSync,
-        scanAsync: probeScanApi.scanAsync,
-        getScan: probeScanApi.getScan,
-        listScans: probeScanApi.listScans,
-        usage: {
-          get: probeUsageApi.getProbeUsage,
-        },
-        webhook: {
-          create: probeWebhookApi.createProbeWebhook,
-          list: probeWebhookApi.listProbeWebhook,
-          delete: probeWebhookApi.deleteProbeWebhook,
-          update: probeWebhookApi.updateProbeWebhook,
-          listDeliveries: probeWebhookApi.listProbeWebhookDeliveries,
-        },
-        application: {
-          scan: probeScanApplicationApi.scanApplication,
-          scanSync: probeScanApplicationApi.scanSyncApplication,
-          scanAsync: probeScanApplicationApi.scanAsyncApplication,
-          getScan: probeScanApplicationApi.getScanApplication,
-          listScans: probeScanApplicationApi.listScansApplication,
-          usage: {
-            get: probeUsageApplicationApi.getProbeUsageApplication,
-          },
-          webhook: {
-            create: probeWebhookApplicationApi.createProbeWebhookApplication,
-            list: probeWebhookApplicationApi.listProbeWebhookApplication,
-            delete: probeWebhookApplicationApi.deleteProbeWebhookApplication,
-            update: probeWebhookApplicationApi.updateProbeWebhookApplication,
-            listDeliveries: probeWebhookApplicationApi.listProbeWebhookDeliveriesApplication,
-          },
-        },
-      },
-    };
-  }
-
-  public static enableAxiosRetry(axiosRetryConfig?: IAxiosRetryConfig): void {
-    axiosRetry(AbyssProbeCore.axios, {
-      retries: NUMBER_RETRY_API,
-      retryDelay: (retryCount) => retryCount * BASE_DELAY_BETWEEN_RETRY,
-      retryCondition: (error) =>
-        isNetworkOrIdempotentRequestError(error) ||
-        RETRY_CODES.includes(error.response?.status || 502),
-      ...axiosRetryConfig,
-    });
-  }
-
-  public static setConfig(config: CoreConfig): void {
-    AbyssProbeCore._sdk = null;
-
-    AbyssProbeCore.config = { ...AbyssProbeCore.config, ...config };
-
-    if (config.baseURL) {
-      AbyssProbeCore.axios.defaults.baseURL = config.baseURL;
-    }
-
-    if (config.token) {
-      AbyssProbeCore.axios.defaults.headers.common.Authorization = `Bearer ${config.token}`;
-    }
-
-    if (config.apiKey) {
-      AbyssProbeCore.axios.defaults.headers.common[API_KEY_HEADER] = `${config.apiKey}`;
-    }
-
-    if (config.adminToken) {
-      AbyssProbeCore.axios.defaults.headers.common[ADMIN_TOKEN_HEADER] = `${config.adminToken}`;
-    }
-  }
-
-  public static getConfig(): CoreConfig {
-    return AbyssProbeCore.config;
-  }
-}
+import axios from 'axios';
+import axiosRetry, { IAxiosRetryConfig, isNetworkOrIdempotentRequestError } from 'axios-retry';
+import * as probeScanApi from './api/probe-scan.api';
+import * as probeWebhookApi from './api/probe-webhook.api';
+import * as probeScanApplicationApi from './api/probe-scan.application.api';
+import * as probeWebhookApplicationApi from './api/probe-webhook.application.api';
+import * as probeUsageApi from './api/probe-usage.api';
+import * as probeUsageApplicationApi from './api/probe-usage.application.api';
+
+export * from './api';
+export * from './types';
+export * from './utils';
+export * from './constants';
+
+const DEFAULT_BASE_URL = 'https://probe-api.abyss-project.fr/api/';
+
+export const API_KEY_HEADER = 'abyss-api-key';
+/**
+ * Application-level API key header (AbyssProbe application/API-key
+ * authentication). Same literal value every other Abyss service's own core
+ * package independently declares for its `ApplicationMiddleware`.
+ */
+export const API_KEY_APPLICATION_HEADER = 'abyss-api-key-application';
+export const ADMIN_TOKEN_HEADER = 'abyss-admin-token';
+
+/**
+ * Header carrying the HMAC-SHA256 signature of a probe webhook delivery's
+ * raw JSON body. Verify it with {@link verifyProbeWebhookSignature}
+ * (re-exported from './utils').
+ */
+export const PROBE_WEBHOOK_SIGNATURE_HEADER = 'x-probe-signature';
+export const PROBE_WEBHOOK_SIGNATURE_ALGORITHM = 'sha256';
+
+const NUMBER_RETRY_API = 10;
+const BASE_DELAY_BETWEEN_RETRY = 5000;
+const RETRY_CODES = [
+  502, // Bad Gateway
+  503, // Service Unavailable
+];
+
+type CoreConfig = {
+  token?: string;
+  apiKey?: string;
+  adminToken?: string;
+  baseURL?: string;
+};
+
+type AbyssProbeCoreSDK = {
+  probe: {
+    /** `POST /scan` — sync (default) or async depending on `options.mode`. */
+    scan: typeof probeScanApi.scan;
+    /** `POST /scan` forced to `mode: sync` — precisely-typed 200 response. */
+    scanSync: typeof probeScanApi.scanSync;
+    /** `POST /scan?mode=async` — precisely-typed 202 response. */
+    scanAsync: typeof probeScanApi.scanAsync;
+    /** `GET /scan/:scanId` — poll a scan's status/verdict. */
+    getScan: typeof probeScanApi.getScan;
+    /** `GET /scan` — paginated history/search. */
+    listScans: typeof probeScanApi.listScans;
+    /** `GET /usage` — current ACCOUNT_AV_SCAN_UNITS used/limit/remaining for the caller's scope. */
+    usage: {
+      get: typeof probeUsageApi.getProbeUsage;
+    };
+    webhook: {
+      create: typeof probeWebhookApi.createProbeWebhook;
+      list: typeof probeWebhookApi.listProbeWebhook;
+      delete: typeof probeWebhookApi.deleteProbeWebhook;
+      /** `PATCH /webhook/:webhookId` — edit callbackUrl and/or active. */
+      update: typeof probeWebhookApi.updateProbeWebhook;
+      /** `GET /webhook/:webhookId/deliveries` — paginated delivery-attempt history. */
+      listDeliveries: typeof probeWebhookApi.listProbeWebhookDeliveries;
+    };
+    /**
+     * Application/API-key-auth counterpart (Phase 3a) — for inter-service
+     * callers (abyss-storage, external integrations) instead of a
+     * personal/org session. Same request/response contracts as the methods
+     * above, hitting `/application/:applicationId/...` and authenticated
+     * with the `abyss-api-key-application` header ({@link
+     * API_KEY_APPLICATION_HEADER}) instead of the personal `abyss-api-key`.
+     */
+    application: {
+      /** `POST /application/:applicationId/scan` — sync (default) or async depending on `options.mode`. */
+      scan: typeof probeScanApplicationApi.scanApplication;
+      /** `POST /application/:applicationId/scan` forced to `mode: sync` — precisely-typed 200 response. */
+      scanSync: typeof probeScanApplicationApi.scanSyncApplication;
+      /** `POST /application/:applicationId/scan?mode=async` — precisely-typed 202 response. */
+      scanAsync: typeof probeScanApplicationApi.scanAsyncApplication;
+      /** `GET /application/:applicationId/scan/:scanId` — poll a scan's status/verdict. */
+      getScan: typeof probeScanApplicationApi.getScanApplication;
+      /** `GET /application/:applicationId/scan` — paginated history/search. */
+      listScans: typeof probeScanApplicationApi.listScansApplication;
+      /** `GET /application/:applicationId/usage` — current ACCOUNT_AV_SCAN_UNITS used/limit/remaining for the calling application. */
+      usage: {
+        get: typeof probeUsageApplicationApi.getProbeUsageApplication;
+      };
+      webhook: {
+        create: typeof probeWebhookApplicationApi.createProbeWebhookApplication;
+        list: typeof probeWebhookApplicationApi.listProbeWebhookApplication;
+        delete: typeof probeWebhookApplicationApi.deleteProbeWebhookApplication;
+        /** `PATCH /application/:applicationId/webhook/:webhookId` — edit callbackUrl and/or active. */
+        update: typeof probeWebhookApplicationApi.updateProbeWebhookApplication;
+        /** `GET /application/:applicationId/webhook/:webhookId/deliveries` — paginated delivery-attempt history. */
+        listDeliveries: typeof probeWebhookApplicationApi.listProbeWebhookDeliveriesApplication;
+      };
+    };
+  };
+};
+
+export class AbyssProbeCore {
+  private static config = {
+    token: '',
+    apiKey: '',
+    adminToken: '',
+    baseURL: DEFAULT_BASE_URL,
+  };
+  static axios = axios.create({
+    baseURL: this.config.baseURL,
+    withCredentials: true,
+  });
+
+  private static _sdk: AbyssProbeCoreSDK | null = null;
+
+  public static get sdk(): AbyssProbeCoreSDK {
+    if (!AbyssProbeCore._sdk) {
+      AbyssProbeCore._sdk = AbyssProbeCore.buildSDK();
+    }
+    return AbyssProbeCore._sdk;
+  }
+
+  private static buildSDK(): AbyssProbeCoreSDK {
+    return {
+      probe: {
+        scan: probeScanApi.scan,
+        scanSync: probeScanApi.scanSync,
+        scanAsync: probeScanApi.scanAsync,
+        getScan: probeScanApi.getScan,
+        listScans: probeScanApi.listScans,
+        usage: {
+          get: probeUsageApi.getProbeUsage,
+        },
+        webhook: {
+          create: probeWebhookApi.createProbeWebhook,
+          list: probeWebhookApi.listProbeWebhook,
+          delete: probeWebhookApi.deleteProbeWebhook,
+          update: probeWebhookApi.updateProbeWebhook,
+          listDeliveries: probeWebhookApi.listProbeWebhookDeliveries,
+        },
+        application: {
+          scan: probeScanApplicationApi.scanApplication,
+          scanSync: probeScanApplicationApi.scanSyncApplication,
+          scanAsync: probeScanApplicationApi.scanAsyncApplication,
+          getScan: probeScanApplicationApi.getScanApplication,
+          listScans: probeScanApplicationApi.listScansApplication,
+          usage: {
+            get: probeUsageApplicationApi.getProbeUsageApplication,
+          },
+          webhook: {
+            create: probeWebhookApplicationApi.createProbeWebhookApplication,
+            list: probeWebhookApplicationApi.listProbeWebhookApplication,
+            delete: probeWebhookApplicationApi.deleteProbeWebhookApplication,
+            update: probeWebhookApplicationApi.updateProbeWebhookApplication,
+            listDeliveries: probeWebhookApplicationApi.listProbeWebhookDeliveriesApplication,
+          },
+        },
+      },
+    };
+  }
+
+  public static enableAxiosRetry(axiosRetryConfig?: IAxiosRetryConfig): void {
+    axiosRetry(AbyssProbeCore.axios, {
+      retries: NUMBER_RETRY_API,
+      retryDelay: (retryCount) => retryCount * BASE_DELAY_BETWEEN_RETRY,
+      retryCondition: (error) =>
+        isNetworkOrIdempotentRequestError(error) ||
+        RETRY_CODES.includes(error.response?.status || 502),
+      ...axiosRetryConfig,
+    });
+  }
+
+  public static setConfig(config: CoreConfig): void {
+    AbyssProbeCore._sdk = null;
+
+    AbyssProbeCore.config = { ...AbyssProbeCore.config, ...config };
+
+    if (config.baseURL) {
+      AbyssProbeCore.axios.defaults.baseURL = config.baseURL;
+    }
+
+    if (config.token) {
+      AbyssProbeCore.axios.defaults.headers.common.Authorization = `Bearer ${config.token}`;
+    }
+
+    if (config.apiKey) {
+      AbyssProbeCore.axios.defaults.headers.common[API_KEY_HEADER] = `${config.apiKey}`;
+    }
+
+    if (config.adminToken) {
+      AbyssProbeCore.axios.defaults.headers.common[ADMIN_TOKEN_HEADER] = `${config.adminToken}`;
+    }
+  }
+
+  public static getConfig(): CoreConfig {
+    return AbyssProbeCore.config;
+  }
+}

package/src/types/enum/api-error.enum.ts

@@ -1,33 +1,33 @@
-export enum ErrorType {
-  apiError = 'api_error',
-  authError = 'authentication_error',
-  resourceError = 'resource_error',
-}
-
-export enum Code {
-  // HTTP Error
-  tokenFailure = 'token_authentication_failure',
-  authenticationFailure = 'authentication_credentials_failure',
-  accessNotAllowed = 'access_not_allowed',
-  notFound = 'not_found',
-  validationError = 'resource_validation_error',
-  constraintError = 'resource_constraint_error',
-  internalServerError = 'internal_server_error',
-  serviceUnavailable = 'service_unavailable',
-  invalidData = 'invalid_data',
-  notImplemented = 'not_implemented',
-  retrospectiveCannotBeModifiedWhenCompleted = 'retrospective_cannot_be_modified_when_completed',
-  retrospectiveActionNotAllowedInPhase = 'retrospective_action_not_allowed_in_phase',
-  retrospectiveVoteBudgetExhausted = 'retrospective_vote_budget_exhausted',
-  retrospectiveActionLimitReached = 'retrospective_action_limit_reached',
-  atlasDocumentLimitReached = 'atlas_document_limit_reached',
-  boardCardDocumentLimitReached = 'board_card_document_limit_reached',
-  boardCardMoveInvalidDestination = 'board_card_move_invalid_destination',
-  boardCardLinkLimitReached = 'board_card_link_limit_reached',
-  boardCardLinkAlreadyExists = 'board_card_link_already_exists',
-  boardCardLinkToSelf = 'board_card_link_to_self',
-  shortLinkProtected = 'short_link_protected',
-  drawImageLimitReached = 'draw_image_limit_reached',
-  drawImageOwnerRequired = 'draw_image_owner_required',
-  drawImageNotInDraw = 'draw_image_not_in_draw',
-}
+export enum ErrorType {
+  apiError = 'api_error',
+  authError = 'authentication_error',
+  resourceError = 'resource_error',
+}
+
+export enum Code {
+  // HTTP Error
+  tokenFailure = 'token_authentication_failure',
+  authenticationFailure = 'authentication_credentials_failure',
+  accessNotAllowed = 'access_not_allowed',
+  notFound = 'not_found',
+  validationError = 'resource_validation_error',
+  constraintError = 'resource_constraint_error',
+  internalServerError = 'internal_server_error',
+  serviceUnavailable = 'service_unavailable',
+  invalidData = 'invalid_data',
+  notImplemented = 'not_implemented',
+  retrospectiveCannotBeModifiedWhenCompleted = 'retrospective_cannot_be_modified_when_completed',
+  retrospectiveActionNotAllowedInPhase = 'retrospective_action_not_allowed_in_phase',
+  retrospectiveVoteBudgetExhausted = 'retrospective_vote_budget_exhausted',
+  retrospectiveActionLimitReached = 'retrospective_action_limit_reached',
+  atlasDocumentLimitReached = 'atlas_document_limit_reached',
+  boardCardDocumentLimitReached = 'board_card_document_limit_reached',
+  boardCardMoveInvalidDestination = 'board_card_move_invalid_destination',
+  boardCardLinkLimitReached = 'board_card_link_limit_reached',
+  boardCardLinkAlreadyExists = 'board_card_link_already_exists',
+  boardCardLinkToSelf = 'board_card_link_to_self',
+  shortLinkProtected = 'short_link_protected',
+  drawImageLimitReached = 'draw_image_limit_reached',
+  drawImageOwnerRequired = 'draw_image_owner_required',
+  drawImageNotInDraw = 'draw_image_not_in_draw',
+}

package/src/types/enum/index.ts

@@ -1,2 +1,2 @@
-export * from './api-error.enum';
-export * from './probe-scan.enum';
+export * from './api-error.enum';
+export * from './probe-scan.enum';

package/src/types/enum/probe-scan.enum.ts

@@ -1,44 +1,44 @@
-// Mirrors apps/api/src/database/probe-scan.enum.ts EXACTLY (same string
-// values — this SDK talks to that API over the wire, so the values must
-// match byte-for-byte). Kept as a single file here too, on purpose: the
-// server groups all three enums in one file for the same reason (they are
-// one cohesive scan vocabulary), see that file's header comment.
-
-/**
- * Antivirus scan verdict. `null` on the wire while the scan has not reached
- * `DONE` yet (see {@link ProbeScanStatus}) — a scan that never completes
- * (e.g. the engine throws) is left at its last real status with no
- * fabricated verdict.
- */
-export enum ProbeScanVerdict {
-  CLEAN = 'clean',
-  INFECTED = 'infected',
-}
-
-/**
- * How the scan was (or will be) run: `SYNC` blocks the request until the
- * engine returns the verdict inline; `ASYNC` queues the job and delivers the
- * verdict later via a registered webhook and/or the per-request
- * `callbackUrl`, and/or by polling `GET /scan/:scanId`.
- */
-export enum ProbeScanMode {
-  SYNC = 'sync',
-  ASYNC = 'async',
-}
-
-/**
- * Scan lifecycle. A SYNC scan skips `QUEUED` entirely (created directly at
- * `SCANNING`). An ASYNC scan is created at `QUEUED`, flipped to `SCANNING`
- * once a worker picks the job off the queue, then to `DONE` or `ERROR`.
- *
- * `ERROR` (async-only) is a TERMINAL, no-verdict state — there is no
- * automatic requeue/retry (the uploaded bytes are deleted the moment the job
- * ends, success or failure). A caller that wants to retry submits a brand
- * new `POST /scan?mode=async`.
- */
-export enum ProbeScanStatus {
-  QUEUED = 'queued',
-  SCANNING = 'scanning',
-  DONE = 'done',
-  ERROR = 'error',
-}
+// Mirrors apps/api/src/database/probe-scan.enum.ts EXACTLY (same string
+// values — this SDK talks to that API over the wire, so the values must
+// match byte-for-byte). Kept as a single file here too, on purpose: the
+// server groups all three enums in one file for the same reason (they are
+// one cohesive scan vocabulary), see that file's header comment.
+
+/**
+ * Antivirus scan verdict. `null` on the wire while the scan has not reached
+ * `DONE` yet (see {@link ProbeScanStatus}) — a scan that never completes
+ * (e.g. the engine throws) is left at its last real status with no
+ * fabricated verdict.
+ */
+export enum ProbeScanVerdict {
+  CLEAN = 'clean',
+  INFECTED = 'infected',
+}
+
+/**
+ * How the scan was (or will be) run: `SYNC` blocks the request until the
+ * engine returns the verdict inline; `ASYNC` queues the job and delivers the
+ * verdict later via a registered webhook and/or the per-request
+ * `callbackUrl`, and/or by polling `GET /scan/:scanId`.
+ */
+export enum ProbeScanMode {
+  SYNC = 'sync',
+  ASYNC = 'async',
+}
+
+/**
+ * Scan lifecycle. A SYNC scan skips `QUEUED` entirely (created directly at
+ * `SCANNING`). An ASYNC scan is created at `QUEUED`, flipped to `SCANNING`
+ * once a worker picks the job off the queue, then to `DONE` or `ERROR`.
+ *
+ * `ERROR` (async-only) is a TERMINAL, no-verdict state — there is no
+ * automatic requeue/retry (the uploaded bytes are deleted the moment the job
+ * ends, success or failure). A caller that wants to retry submits a brand
+ * new `POST /scan?mode=async`.
+ */
+export enum ProbeScanStatus {
+  QUEUED = 'queued',
+  SCANNING = 'scanning',
+  DONE = 'done',
+  ERROR = 'error',
+}

package/src/types/index.ts

@@ -1,2 +1,2 @@
-export * from './enum';
-export * from './interface';
+export * from './enum';
+export * from './interface';

package/src/types/interface/api/index.ts

@@ -1,5 +1,5 @@
-export * from './requests';
-export * from './responses';
-export * from './type-message/response';
-export * from './type-message/api-error';
-export * from './type-message/base-paginate';
+export * from './requests';
+export * from './responses';
+export * from './type-message/response';
+export * from './type-message/api-error';
+export * from './type-message/base-paginate';

package/src/types/interface/api/requests/index.ts

@@ -1,3 +1,3 @@
-export * from './probe-scan.request';
-export * from './probe-usage.request';
-export * from './probe-webhook.request';
+export * from './probe-scan.request';
+export * from './probe-usage.request';
+export * from './probe-webhook.request';