@cdot65/prisma-airs-sdk 0.6.5 → 0.6.6

package/dist/index.d.cts

@@ -16503,6 +16503,7 @@ declare class Content {
     /**
      * Load content from a JSON file.
      * @param filePath - Path to JSON file containing scan request contents.
+     * @returns A new Content instance populated from the JSON file.
      */
     static fromJSONFile(filePath: string): Content;
 }
@@ -56696,8 +56697,8 @@ declare const MAX_NUMBER_OF_BATCH_SCAN_OBJECTS = 5;
 declare const MAX_CONNECTION_POOL_SIZE = 100;
 declare const MAX_NUMBER_OF_RETRIES = 5;
 declare const HTTP_FORCE_RETRY_STATUS_CODES: number[];
-declare const SDK_VERSION = "0.6.5";
-declare const USER_AGENT = "PAN-AIRS/0.6.5-typescript-sdk";
+declare const SDK_VERSION = "0.6.6";
+declare const USER_AGENT = "PAN-AIRS/0.6.6-typescript-sdk";
 declare const DEFAULT_MGMT_ENDPOINT = "https://api.sase.paloaltonetworks.com/aisec";
 declare const DEFAULT_TOKEN_ENDPOINT = "https://auth.apps.paloaltonetworks.com/oauth2/access_token";
 declare const MGMT_CLIENT_ID = "PANW_MGMT_CLIENT_ID";
@@ -56811,7 +56812,6 @@ declare class OAuthClient {
     getToken(): Promise<string>;
     /**
      * Clear the cached token, forcing a fresh fetch on next call.
-     * @returns Nothing.
      */
     clearToken(): void;
     /**
@@ -56931,7 +56931,7 @@ declare class TopicsClient {
     /**
      * Force-delete a custom topic, removing it from any referencing profiles.
      * @param topicId - UUID of the topic to force-delete.
-     * @param updatedBy - Email of the user performing the deletion.
+     * @param updatedBy - Optional. Email of the user performing the deletion.
      * @returns Deletion confirmation message.
      */
     forceDelete(topicId: string, updatedBy?: string): Promise<DeleteTopicResponse>;
@@ -57675,13 +57675,13 @@ declare class RedTeamReportsClient {
      * Download a report in the specified format.
      * @param jobId - The job UUID.
      * @param format - The file format (e.g. "pdf", "csv").
-     * @returns The downloaded report data.
+     * @returns The report data in the requested format (untyped — shape depends on `format`).
      */
     downloadReport(jobId: string, format: string): Promise<unknown>;
     /**
      * Generate a partial report for a running scan.
      * @param jobId - The job UUID.
-     * @returns The partial report data.
+     * @returns The partial report payload (untyped — schema not yet defined by the API).
      */
     generatePartialReport(jobId: string): Promise<unknown>;
 }
@@ -57907,7 +57907,7 @@ declare class RedTeamCustomAttacksClient {
     /**
      * Download CSV template for a prompt set.
      * @param uuid - The prompt set UUID.
-     * @returns The CSV template data.
+     * @returns The CSV template content (untyped — raw response from the API).
      */
     downloadTemplate(uuid: string): Promise<unknown>;
     /**

package/dist/index.d.ts

@@ -16503,6 +16503,7 @@ declare class Content {
     /**
      * Load content from a JSON file.
      * @param filePath - Path to JSON file containing scan request contents.
+     * @returns A new Content instance populated from the JSON file.
      */
     static fromJSONFile(filePath: string): Content;
 }
@@ -56696,8 +56697,8 @@ declare const MAX_NUMBER_OF_BATCH_SCAN_OBJECTS = 5;
 declare const MAX_CONNECTION_POOL_SIZE = 100;
 declare const MAX_NUMBER_OF_RETRIES = 5;
 declare const HTTP_FORCE_RETRY_STATUS_CODES: number[];
-declare const SDK_VERSION = "0.6.5";
-declare const USER_AGENT = "PAN-AIRS/0.6.5-typescript-sdk";
+declare const SDK_VERSION = "0.6.6";
+declare const USER_AGENT = "PAN-AIRS/0.6.6-typescript-sdk";
 declare const DEFAULT_MGMT_ENDPOINT = "https://api.sase.paloaltonetworks.com/aisec";
 declare const DEFAULT_TOKEN_ENDPOINT = "https://auth.apps.paloaltonetworks.com/oauth2/access_token";
 declare const MGMT_CLIENT_ID = "PANW_MGMT_CLIENT_ID";
@@ -56811,7 +56812,6 @@ declare class OAuthClient {
     getToken(): Promise<string>;
     /**
      * Clear the cached token, forcing a fresh fetch on next call.
-     * @returns Nothing.
      */
     clearToken(): void;
     /**
@@ -56931,7 +56931,7 @@ declare class TopicsClient {
     /**
      * Force-delete a custom topic, removing it from any referencing profiles.
      * @param topicId - UUID of the topic to force-delete.
-     * @param updatedBy - Email of the user performing the deletion.
+     * @param updatedBy - Optional. Email of the user performing the deletion.
      * @returns Deletion confirmation message.
      */
     forceDelete(topicId: string, updatedBy?: string): Promise<DeleteTopicResponse>;
@@ -57675,13 +57675,13 @@ declare class RedTeamReportsClient {
      * Download a report in the specified format.
      * @param jobId - The job UUID.
      * @param format - The file format (e.g. "pdf", "csv").
-     * @returns The downloaded report data.
+     * @returns The report data in the requested format (untyped — shape depends on `format`).
      */
     downloadReport(jobId: string, format: string): Promise<unknown>;
     /**
      * Generate a partial report for a running scan.
      * @param jobId - The job UUID.
-     * @returns The partial report data.
+     * @returns The partial report payload (untyped — schema not yet defined by the API).
      */
     generatePartialReport(jobId: string): Promise<unknown>;
 }
@@ -57907,7 +57907,7 @@ declare class RedTeamCustomAttacksClient {
     /**
      * Download CSV template for a prompt set.
      * @param uuid - The prompt set UUID.
-     * @returns The CSV template data.
+     * @returns The CSV template content (untyped — raw response from the API).
      */
     downloadTemplate(uuid: string): Promise<unknown>;
     /**

package/dist/index.js

@@ -29,7 +29,7 @@ var MAX_NUMBER_OF_BATCH_SCAN_OBJECTS = 5;
 var MAX_CONNECTION_POOL_SIZE = 100;
 var MAX_NUMBER_OF_RETRIES = 5;
 var HTTP_FORCE_RETRY_STATUS_CODES = [500, 502, 503, 504];
-var SDK_VERSION = "0.6.5";
+var SDK_VERSION = "0.6.6";
 var USER_AGENT = `PAN-AIRS/${SDK_VERSION}-typescript-sdk`;
 var DEFAULT_MGMT_ENDPOINT = "https://api.sase.paloaltonetworks.com/aisec";
 var DEFAULT_TOKEN_ENDPOINT = "https://auth.apps.paloaltonetworks.com/oauth2/access_token";
@@ -258,6 +258,11 @@ var UUID_RE = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i;
 function isValidUuid(value) {
   return UUID_RE.test(value);
 }
+function validateJobId(jobId) {
+  if (!isValidUuid(jobId)) {
+    throw new AISecSDKException(`Invalid job id: ${jobId}`, "AISEC_USER_REQUEST_PAYLOAD_ERROR" /* USER_REQUEST_PAYLOAD_ERROR */);
+  }
+}
 function generatePayloadHash(payload, secret) {
   return createHmac("sha256", secret).update(payload).digest("hex");
 }
@@ -567,6 +572,7 @@ var Content = class _Content {
   /**
    * Load content from a JSON file.
    * @param filePath - Path to JSON file containing scan request contents.
+   * @returns A new Content instance populated from the JSON file.
    */
   static fromJSONFile(filePath) {
     const raw = readFileSync(filePath, "utf-8");
@@ -2753,7 +2759,6 @@ var OAuthClient = class {
   }
   /**
    * Clear the cached token, forcing a fresh fetch on next call.
-   * @returns Nothing.
    */
   clearToken() {
     this.accessToken = null;
@@ -3100,7 +3105,7 @@ var TopicsClient = class {
   /**
    * Force-delete a custom topic, removing it from any referencing profiles.
    * @param topicId - UUID of the topic to force-delete.
-   * @param updatedBy - Email of the user performing the deletion.
+   * @param updatedBy - Optional. Email of the user performing the deletion.
    * @returns Deletion confirmation message.
    */
   async forceDelete(topicId, updatedBy) {
@@ -4312,11 +4317,6 @@ var RedTeamScansClient = class {
 };
 
 // src/red-team/reports-client.ts
-function validateJobId(jobId) {
-  if (!isValidUuid(jobId)) {
-    throw new AISecSDKException(`Invalid job id: ${jobId}`, "AISEC_USER_REQUEST_PAYLOAD_ERROR" /* USER_REQUEST_PAYLOAD_ERROR */);
-  }
-}
 var RedTeamReportsClient = class {
   baseUrl;
   oauthClient;
@@ -4574,7 +4574,7 @@ var RedTeamReportsClient = class {
    * Download a report in the specified format.
    * @param jobId - The job UUID.
    * @param format - The file format (e.g. "pdf", "csv").
-   * @returns The downloaded report data.
+   * @returns The report data in the requested format (untyped — shape depends on `format`).
    */
   async downloadReport(jobId, format) {
     validateJobId(jobId);
@@ -4592,7 +4592,7 @@ var RedTeamReportsClient = class {
   /**
    * Generate a partial report for a running scan.
    * @param jobId - The job UUID.
-   * @returns The partial report data.
+   * @returns The partial report payload (untyped — schema not yet defined by the API).
    */
   async generatePartialReport(jobId) {
     validateJobId(jobId);
@@ -4608,11 +4608,6 @@ var RedTeamReportsClient = class {
 };
 
 // src/red-team/custom-attack-reports-client.ts
-function validateJobId2(jobId) {
-  if (!isValidUuid(jobId)) {
-    throw new AISecSDKException(`Invalid job id: ${jobId}`, "AISEC_USER_REQUEST_PAYLOAD_ERROR" /* USER_REQUEST_PAYLOAD_ERROR */);
-  }
-}
 var RedTeamCustomAttackReportsClient = class {
   baseUrl;
   oauthClient;
@@ -4628,7 +4623,7 @@ var RedTeamCustomAttackReportsClient = class {
    * @returns The custom attack report response.
    */
   async getReport(jobId) {
-    validateJobId2(jobId);
+    validateJobId(jobId);
     const res = await managementHttpRequest({
       method: "GET",
       baseUrl: this.baseUrl,
@@ -4644,7 +4639,7 @@ var RedTeamCustomAttackReportsClient = class {
    * @returns The prompt sets report response.
    */
   async getPromptSets(jobId) {
-    validateJobId2(jobId);
+    validateJobId(jobId);
     const res = await managementHttpRequest({
       method: "GET",
       baseUrl: this.baseUrl,
@@ -4662,7 +4657,7 @@ var RedTeamCustomAttackReportsClient = class {
    * @returns The list of prompt detail responses.
    */
   async getPromptsBySet(jobId, promptSetId, opts) {
-    validateJobId2(jobId);
+    validateJobId(jobId);
     if (!isValidUuid(promptSetId)) {
       throw new AISecSDKException(
         `Invalid prompt set id: ${promptSetId}`,
@@ -4688,7 +4683,7 @@ var RedTeamCustomAttackReportsClient = class {
    * @returns The prompt detail response.
    */
   async getPromptDetail(jobId, promptId) {
-    validateJobId2(jobId);
+    validateJobId(jobId);
     if (!isValidUuid(promptId)) {
       throw new AISecSDKException(
         `Invalid prompt id: ${promptId}`,
@@ -4711,7 +4706,7 @@ var RedTeamCustomAttackReportsClient = class {
    * @returns The paginated list of custom attacks.
    */
   async listCustomAttacks(jobId, opts) {
-    validateJobId2(jobId);
+    validateJobId(jobId);
     const params = buildRedTeamListParams(opts);
     if (opts?.threat !== void 0) params.threat = String(opts.threat);
     if (opts?.prompt_set_id !== void 0) params.prompt_set_id = opts.prompt_set_id;
@@ -4733,7 +4728,7 @@ var RedTeamCustomAttackReportsClient = class {
    * @returns The list of attack outputs.
    */
   async getAttackOutputs(jobId, attackId) {
-    validateJobId2(jobId);
+    validateJobId(jobId);
     if (!isValidUuid(attackId)) {
       throw new AISecSDKException(
         `Invalid attack id: ${attackId}`,
@@ -4755,7 +4750,7 @@ var RedTeamCustomAttackReportsClient = class {
    * @returns The list of property statistics.
    */
   async getPropertyStats(jobId) {
-    validateJobId2(jobId);
+    validateJobId(jobId);
     const res = await managementHttpRequest({
       method: "GET",
       baseUrl: this.baseUrl,
@@ -5102,7 +5097,7 @@ var RedTeamCustomAttacksClient = class {
   /**
    * Download CSV template for a prompt set.
    * @param uuid - The prompt set UUID.
-   * @returns The CSV template data.
+   * @returns The CSV template content (untyped — raw response from the API).
    */
   async downloadTemplate(uuid) {
     validateUuid(uuid, "prompt set uuid");