@detectant-api/sdk 0.0.3 → 0.0.5

package/README.md

@@ -1,5 +1,7 @@
+# [Detectant - Malware Scanning API for TypeScript](https://www.detectant.com)
+
 <p align="center">
-  <img src="../../app/dashboard/public/images/detectant-github-banner.png" alt="Detectant" width="100%">
+  <img src="https://www.detectant.com/images/detectant-github-banner.png" alt="Detectant" width="100%">
 </p>
 
 # Detectant TypeScript SDK
@@ -100,12 +102,11 @@ One file can fail without preventing the other files in the batch from being sca
 
 ## Configuration
 
-Use `baseUrl` for a self-hosted or local API, and increase the timeout for large files when needed:
+Increase the timeout for large files when needed:
 
 ```ts
 const detectant = new Detectant({
   apiKey: process.env.DETECTANT_API_KEY,
-  baseUrl: "https://api.example.com",
   timeoutInSeconds: 120,
 });
 ```

package/dist/cjs/BaseClient.js

@@ -43,8 +43,8 @@ function normalizeClientOptions(options) {
     const headers = (0, headers_js_1.mergeHeaders)({
         "X-Fern-Language": "JavaScript",
         "X-Fern-SDK-Name": "@detectant-api/sdk",
-        "X-Fern-SDK-Version": "0.0.3",
-        "User-Agent": "@detectant-api/sdk/0.0.3",
+        "X-Fern-SDK-Version": "0.0.5",
+        "User-Agent": "@detectant-api/sdk/0.0.5",
         "X-Fern-Runtime": core.RUNTIME.type,
         "X-Fern-Runtime-Version": core.RUNTIME.version,
     }, options === null || options === void 0 ? void 0 : options.headers);

package/dist/cjs/api/resources/index.d.ts

@@ -1,3 +1,4 @@
 export * as health from "./health/index.js";
 export * from "./scans/client/requests/index.js";
 export * as scans from "./scans/index.js";
+export * from "./scans/types/index.js";

package/dist/cjs/api/resources/index.js

@@ -40,3 +40,4 @@ exports.scans = exports.health = void 0;
 exports.health = __importStar(require("./health/index.js"));
 __exportStar(require("./scans/client/requests/index.js"), exports);
 exports.scans = __importStar(require("./scans/index.js"));
+__exportStar(require("./scans/types/index.js"), exports);

package/dist/cjs/api/resources/scans/client/Client.js

@@ -80,11 +80,15 @@ class ScansClient {
     __listScans() {
         return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j;
-            const { limit, cursor, verdict, filename, engine_signature: engineSignature, detection_rule: detectionRule, } = request;
+            const { limit, cursor, verdict, scan_id: scanId, source_type: sourceType, storage_integration_id: storageIntegrationId, failure, filename, engine_signature: engineSignature, detection_rule: detectionRule, } = request;
             const _queryParams = {
                 limit,
                 cursor,
                 verdict,
+                scan_id: scanId,
+                source_type: sourceType != null ? sourceType : undefined,
+                storage_integration_id: storageIntegrationId,
+                failure: failure != null ? failure : undefined,
                 filename,
                 engine_signature: engineSignature,
                 detection_rule: detectionRule,

package/dist/cjs/api/resources/scans/client/requests/ListScansRequest.d.ts

@@ -1,3 +1,4 @@
+import type * as DetectantApi from "../../../../index.js";
 /**
  * @example
  *     {}
@@ -9,6 +10,14 @@ export interface ListScansRequest {
     cursor?: string;
     /** Case-sensitive PostgreSQL `LIKE` fragment matched against the stored verdict; `%` and `_` act as wildcards. */
     verdict?: string;
+    /** Case-insensitive fragment matched against the scan identifier. */
+    scan_id?: string;
+    /** Return direct API scans or scans submitted by an S3 integration. */
+    source_type?: DetectantApi.ListScansRequestSourceType;
+    /** Return scans submitted by this S3 integration. */
+    storage_integration_id?: string;
+    /** Return scans by failure presence or customer-facing failure code. */
+    failure?: DetectantApi.ListScansRequestFailure;
     /** Case-sensitive PostgreSQL `LIKE` fragment matched against the stored filename; `%` and `_` act as wildcards. */
     filename?: string;
     /** Case-sensitive PostgreSQL `LIKE` fragment matched against the stored engine signature; `%` and `_` act as wildcards. */

package/dist/cjs/api/resources/scans/index.d.ts

@@ -1 +1,2 @@
 export * from "./client/index.js";
+export * from "./types/index.js";

package/dist/cjs/api/resources/scans/index.js

@@ -15,3 +15,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./client/index.js"), exports);
+__exportStar(require("./types/index.js"), exports);

package/dist/cjs/api/resources/scans/types/ListScansRequestFailure.d.ts

@@ -0,0 +1,7 @@
+export declare const ListScansRequestFailure: {
+    readonly Any: "any";
+    readonly None: "none";
+    readonly ScannerUnavailable: "SCANNER_UNAVAILABLE";
+    readonly ContentExpansionLimitExceeded: "CONTENT_EXPANSION_LIMIT_EXCEEDED";
+};
+export type ListScansRequestFailure = (typeof ListScansRequestFailure)[keyof typeof ListScansRequestFailure];

package/dist/cjs/api/resources/scans/types/ListScansRequestFailure.js

@@ -0,0 +1,10 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ListScansRequestFailure = void 0;
+exports.ListScansRequestFailure = {
+    Any: "any",
+    None: "none",
+    ScannerUnavailable: "SCANNER_UNAVAILABLE",
+    ContentExpansionLimitExceeded: "CONTENT_EXPANSION_LIMIT_EXCEEDED",
+};

package/dist/cjs/api/resources/scans/types/ListScansRequestSourceType.d.ts

@@ -0,0 +1,5 @@
+export declare const ListScansRequestSourceType: {
+    readonly Api: "api";
+    readonly S3: "s3";
+};
+export type ListScansRequestSourceType = (typeof ListScansRequestSourceType)[keyof typeof ListScansRequestSourceType];

package/dist/cjs/api/resources/scans/types/ListScansRequestSourceType.js

@@ -0,0 +1,8 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ListScansRequestSourceType = void 0;
+exports.ListScansRequestSourceType = {
+    Api: "api",
+    S3: "s3",
+};

package/dist/cjs/api/resources/scans/types/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./ListScansRequestFailure.js";
+export * from "./ListScansRequestSourceType.js";

package/dist/cjs/api/resources/scans/types/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./ListScansRequestFailure.js"), exports);
+__exportStar(require("./ListScansRequestSourceType.js"), exports);

package/dist/cjs/api/types/Scan.d.ts

@@ -10,11 +10,13 @@ export interface Scan {
     sha256: string;
     size_bytes: number;
     duration_ms: number;
+    timings: DetectantApi.ScanTimings;
     /** Failure information, or `null` when the scan completed. */
     failure: DetectantApi.ScanFailure | null;
     /** Detection names reported for the file. Empty when no threats were detected. */
     detections: string[];
     type_analysis: DetectantApi.TypeAnalysis;
+    source: DetectantApi.ScanSource;
 }
 export declare namespace Scan {
     const Status: {

package/dist/cjs/api/types/ScanSource.d.ts

@@ -0,0 +1,14 @@
+export interface ScanSource {
+    type: ScanSource.Type;
+    /** S3 integration identifier, or `null` for direct API scans. */
+    integration_id: string | null;
+    /** S3 integration name, or `null` for direct API scans. */
+    integration_name: string | null;
+}
+export declare namespace ScanSource {
+    const Type: {
+        readonly Api: "api";
+        readonly S3: "s3";
+    };
+    type Type = (typeof Type)[keyof typeof Type];
+}

package/dist/cjs/api/types/ScanSource.js

@@ -0,0 +1,11 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ScanSource = void 0;
+var ScanSource;
+(function (ScanSource) {
+    ScanSource.Type = {
+        Api: "api",
+        S3: "s3",
+    };
+})(ScanSource || (exports.ScanSource = ScanSource = {}));

package/dist/cjs/api/types/ScanTimings.d.ts

@@ -0,0 +1,4 @@
+export interface ScanTimings {
+    file_type_ms: number;
+    malware_scan_ms: number;
+}

package/dist/cjs/api/types/ScanTimings.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/TypeAnalysisReason.d.ts

@@ -7,6 +7,8 @@ export declare namespace TypeAnalysisReason {
     const Code: {
         readonly MalformedFile: "malformed_file";
         readonly EncryptedArchive: "encrypted_archive";
+        readonly UnsupportedArchive: "unsupported_archive";
+        readonly ContentExpansionLimitExceeded: "content_expansion_limit_exceeded";
         readonly FileTypeMismatch: "file_type_mismatch";
     };
     type Code = (typeof Code)[keyof typeof Code];

package/dist/cjs/api/types/TypeAnalysisReason.js

@@ -7,6 +7,8 @@ var TypeAnalysisReason;
     TypeAnalysisReason.Code = {
         MalformedFile: "malformed_file",
         EncryptedArchive: "encrypted_archive",
+        UnsupportedArchive: "unsupported_archive",
+        ContentExpansionLimitExceeded: "content_expansion_limit_exceeded",
         FileTypeMismatch: "file_type_mismatch",
     };
 })(TypeAnalysisReason || (exports.TypeAnalysisReason = TypeAnalysisReason = {}));

package/dist/cjs/api/types/index.d.ts

@@ -6,6 +6,8 @@ export * from "./ScanBatchResponse.js";
 export * from "./ScanBatchResult.js";
 export * from "./ScanFailure.js";
 export * from "./ScanList.js";
+export * from "./ScanSource.js";
+export * from "./ScanTimings.js";
 export * from "./TypeAnalysis.js";
 export * from "./TypeAnalysisReason.js";
 export * from "./TypeDeclaration.js";

package/dist/cjs/api/types/index.js

@@ -22,6 +22,8 @@ __exportStar(require("./ScanBatchResponse.js"), exports);
 __exportStar(require("./ScanBatchResult.js"), exports);
 __exportStar(require("./ScanFailure.js"), exports);
 __exportStar(require("./ScanList.js"), exports);
+__exportStar(require("./ScanSource.js"), exports);
+__exportStar(require("./ScanTimings.js"), exports);
 __exportStar(require("./TypeAnalysis.js"), exports);
 __exportStar(require("./TypeAnalysisReason.js"), exports);
 __exportStar(require("./TypeDeclaration.js"), exports);

package/dist/cjs/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.0.3";
+export declare const SDK_VERSION = "0.0.5";

package/dist/cjs/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "0.0.3";
+exports.SDK_VERSION = "0.0.5";

package/dist/esm/BaseClient.mjs

@@ -6,8 +6,8 @@ export function normalizeClientOptions(options) {
     const headers = mergeHeaders({
         "X-Fern-Language": "JavaScript",
         "X-Fern-SDK-Name": "@detectant-api/sdk",
-        "X-Fern-SDK-Version": "0.0.3",
-        "User-Agent": "@detectant-api/sdk/0.0.3",
+        "X-Fern-SDK-Version": "0.0.5",
+        "User-Agent": "@detectant-api/sdk/0.0.5",
         "X-Fern-Runtime": core.RUNTIME.type,
         "X-Fern-Runtime-Version": core.RUNTIME.version,
     }, options === null || options === void 0 ? void 0 : options.headers);

package/dist/esm/api/resources/index.d.mts

@@ -1,3 +1,4 @@
 export * as health from "./health/index.mjs";
 export * from "./scans/client/requests/index.mjs";
 export * as scans from "./scans/index.mjs";
+export * from "./scans/types/index.mjs";

package/dist/esm/api/resources/index.mjs

@@ -1,3 +1,4 @@
 export * as health from "./health/index.mjs";
 export * from "./scans/client/requests/index.mjs";
 export * as scans from "./scans/index.mjs";
+export * from "./scans/types/index.mjs";

package/dist/esm/api/resources/scans/client/Client.mjs

@@ -44,11 +44,15 @@ export class ScansClient {
     __listScans() {
         return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j;
-            const { limit, cursor, verdict, filename, engine_signature: engineSignature, detection_rule: detectionRule, } = request;
+            const { limit, cursor, verdict, scan_id: scanId, source_type: sourceType, storage_integration_id: storageIntegrationId, failure, filename, engine_signature: engineSignature, detection_rule: detectionRule, } = request;
             const _queryParams = {
                 limit,
                 cursor,
                 verdict,
+                scan_id: scanId,
+                source_type: sourceType != null ? sourceType : undefined,
+                storage_integration_id: storageIntegrationId,
+                failure: failure != null ? failure : undefined,
                 filename,
                 engine_signature: engineSignature,
                 detection_rule: detectionRule,

package/dist/esm/api/resources/scans/client/requests/ListScansRequest.d.mts

@@ -1,3 +1,4 @@
+import type * as DetectantApi from "../../../../index.mjs";
 /**
  * @example
  *     {}
@@ -9,6 +10,14 @@ export interface ListScansRequest {
     cursor?: string;
     /** Case-sensitive PostgreSQL `LIKE` fragment matched against the stored verdict; `%` and `_` act as wildcards. */
     verdict?: string;
+    /** Case-insensitive fragment matched against the scan identifier. */
+    scan_id?: string;
+    /** Return direct API scans or scans submitted by an S3 integration. */
+    source_type?: DetectantApi.ListScansRequestSourceType;
+    /** Return scans submitted by this S3 integration. */
+    storage_integration_id?: string;
+    /** Return scans by failure presence or customer-facing failure code. */
+    failure?: DetectantApi.ListScansRequestFailure;
     /** Case-sensitive PostgreSQL `LIKE` fragment matched against the stored filename; `%` and `_` act as wildcards. */
     filename?: string;
     /** Case-sensitive PostgreSQL `LIKE` fragment matched against the stored engine signature; `%` and `_` act as wildcards. */

package/dist/esm/api/resources/scans/index.d.mts

@@ -1 +1,2 @@
 export * from "./client/index.mjs";
+export * from "./types/index.mjs";

package/dist/esm/api/resources/scans/index.mjs

@@ -1 +1,2 @@
 export * from "./client/index.mjs";
+export * from "./types/index.mjs";

package/dist/esm/api/resources/scans/types/ListScansRequestFailure.d.mts

@@ -0,0 +1,7 @@
+export declare const ListScansRequestFailure: {
+    readonly Any: "any";
+    readonly None: "none";
+    readonly ScannerUnavailable: "SCANNER_UNAVAILABLE";
+    readonly ContentExpansionLimitExceeded: "CONTENT_EXPANSION_LIMIT_EXCEEDED";
+};
+export type ListScansRequestFailure = (typeof ListScansRequestFailure)[keyof typeof ListScansRequestFailure];

package/dist/esm/api/resources/scans/types/ListScansRequestFailure.mjs

@@ -0,0 +1,7 @@
+// This file was auto-generated by Fern from our API Definition.
+export const ListScansRequestFailure = {
+    Any: "any",
+    None: "none",
+    ScannerUnavailable: "SCANNER_UNAVAILABLE",
+    ContentExpansionLimitExceeded: "CONTENT_EXPANSION_LIMIT_EXCEEDED",
+};

package/dist/esm/api/resources/scans/types/ListScansRequestSourceType.d.mts

@@ -0,0 +1,5 @@
+export declare const ListScansRequestSourceType: {
+    readonly Api: "api";
+    readonly S3: "s3";
+};
+export type ListScansRequestSourceType = (typeof ListScansRequestSourceType)[keyof typeof ListScansRequestSourceType];

package/dist/esm/api/resources/scans/types/ListScansRequestSourceType.mjs

@@ -0,0 +1,5 @@
+// This file was auto-generated by Fern from our API Definition.
+export const ListScansRequestSourceType = {
+    Api: "api",
+    S3: "s3",
+};

package/dist/esm/api/resources/scans/types/index.d.mts

@@ -0,0 +1,2 @@
+export * from "./ListScansRequestFailure.mjs";
+export * from "./ListScansRequestSourceType.mjs";

package/dist/esm/api/resources/scans/types/index.mjs

@@ -0,0 +1,2 @@
+export * from "./ListScansRequestFailure.mjs";
+export * from "./ListScansRequestSourceType.mjs";

package/dist/esm/api/types/Scan.d.mts

@@ -10,11 +10,13 @@ export interface Scan {
     sha256: string;
     size_bytes: number;
     duration_ms: number;
+    timings: DetectantApi.ScanTimings;
     /** Failure information, or `null` when the scan completed. */
     failure: DetectantApi.ScanFailure | null;
     /** Detection names reported for the file. Empty when no threats were detected. */
     detections: string[];
     type_analysis: DetectantApi.TypeAnalysis;
+    source: DetectantApi.ScanSource;
 }
 export declare namespace Scan {
     const Status: {

package/dist/esm/api/types/ScanSource.d.mts

@@ -0,0 +1,14 @@
+export interface ScanSource {
+    type: ScanSource.Type;
+    /** S3 integration identifier, or `null` for direct API scans. */
+    integration_id: string | null;
+    /** S3 integration name, or `null` for direct API scans. */
+    integration_name: string | null;
+}
+export declare namespace ScanSource {
+    const Type: {
+        readonly Api: "api";
+        readonly S3: "s3";
+    };
+    type Type = (typeof Type)[keyof typeof Type];
+}

package/dist/esm/api/types/ScanSource.mjs

@@ -0,0 +1,8 @@
+// This file was auto-generated by Fern from our API Definition.
+export var ScanSource;
+(function (ScanSource) {
+    ScanSource.Type = {
+        Api: "api",
+        S3: "s3",
+    };
+})(ScanSource || (ScanSource = {}));

package/dist/esm/api/types/ScanTimings.d.mts

@@ -0,0 +1,4 @@
+export interface ScanTimings {
+    file_type_ms: number;
+    malware_scan_ms: number;
+}

package/dist/esm/api/types/ScanTimings.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/TypeAnalysisReason.d.mts

@@ -7,6 +7,8 @@ export declare namespace TypeAnalysisReason {
     const Code: {
         readonly MalformedFile: "malformed_file";
         readonly EncryptedArchive: "encrypted_archive";
+        readonly UnsupportedArchive: "unsupported_archive";
+        readonly ContentExpansionLimitExceeded: "content_expansion_limit_exceeded";
         readonly FileTypeMismatch: "file_type_mismatch";
     };
     type Code = (typeof Code)[keyof typeof Code];

package/dist/esm/api/types/TypeAnalysisReason.mjs

@@ -4,6 +4,8 @@ export var TypeAnalysisReason;
     TypeAnalysisReason.Code = {
         MalformedFile: "malformed_file",
         EncryptedArchive: "encrypted_archive",
+        UnsupportedArchive: "unsupported_archive",
+        ContentExpansionLimitExceeded: "content_expansion_limit_exceeded",
         FileTypeMismatch: "file_type_mismatch",
     };
 })(TypeAnalysisReason || (TypeAnalysisReason = {}));

package/dist/esm/api/types/index.d.mts

@@ -6,6 +6,8 @@ export * from "./ScanBatchResponse.mjs";
 export * from "./ScanBatchResult.mjs";
 export * from "./ScanFailure.mjs";
 export * from "./ScanList.mjs";
+export * from "./ScanSource.mjs";
+export * from "./ScanTimings.mjs";
 export * from "./TypeAnalysis.mjs";
 export * from "./TypeAnalysisReason.mjs";
 export * from "./TypeDeclaration.mjs";

package/dist/esm/api/types/index.mjs

@@ -6,6 +6,8 @@ export * from "./ScanBatchResponse.mjs";
 export * from "./ScanBatchResult.mjs";
 export * from "./ScanFailure.mjs";
 export * from "./ScanList.mjs";
+export * from "./ScanSource.mjs";
+export * from "./ScanTimings.mjs";
 export * from "./TypeAnalysis.mjs";
 export * from "./TypeAnalysisReason.mjs";
 export * from "./TypeDeclaration.mjs";

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.0.3";
+export declare const SDK_VERSION = "0.0.5";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "0.0.3";
+export const SDK_VERSION = "0.0.5";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@detectant-api/sdk",
-    "version": "0.0.3",
+    "version": "0.0.5",
     "private": false,
     "repository": {
         "type": "git",