@cdot65/prisma-airs-sdk 0.6.2 → 0.6.4

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.2";
+var SDK_VERSION = "0.6.4";
 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";
@@ -437,6 +437,11 @@ var Content = class _Content {
   _codePrompt;
   _codeResponse;
   _toolEvent;
+  /**
+   * Create a new Content instance.
+   * @param opts - Content fields; at least one of prompt, response, codePrompt, codeResponse, or toolEvent is required.
+   * @throws {AISecSDKException} If no content field is provided or a field exceeds its byte-length limit.
+   */
   constructor(opts) {
     if (!opts.prompt && !opts.response && !opts.codePrompt && !opts.codeResponse && !opts.toolEvent) {
       throw new AISecSDKException(
@@ -604,7 +609,7 @@ import { z } from "zod";
 var AiProfileSchema = z.object({
   profile_id: z.string().uuid().optional(),
   profile_name: z.string().max(MAX_AI_PROFILE_NAME_LENGTH).optional()
-}).refine((d) => d.profile_id || d.profile_name, {
+}).passthrough().refine((d) => d.profile_id || d.profile_name, {
   message: "Either profile_id or profile_name must be provided"
 });
 
@@ -614,14 +619,14 @@ var AgentMetaSchema = z2.object({
   agent_id: z2.string().optional(),
   agent_version: z2.string().optional(),
   agent_arn: z2.string().optional()
-});
+}).passthrough();
 var MetadataSchema = z2.object({
   app_name: z2.string().optional(),
   app_user: z2.string().optional(),
   ai_model: z2.string().optional(),
   user_ip: z2.string().optional(),
   agent_meta: AgentMetaSchema.optional()
-});
+}).passthrough();
 
 // src/models/tool-event.ts
 import { z as z3 } from "zod";
@@ -630,12 +635,12 @@ var ToolEventMetadataSchema = z3.object({
   method: z3.string(),
   server_name: z3.string(),
   tool_invoked: z3.string().optional()
-});
+}).passthrough();
 var ToolEventSchema = z3.object({
   metadata: ToolEventMetadataSchema.optional(),
   input: z3.string().optional(),
   output: z3.string().optional()
-});
+}).passthrough();
 
 // src/models/scan-request.ts
 import { z as z4 } from "zod";
@@ -646,14 +651,14 @@ var ScanRequestContentsInnerSchema = z4.object({
   code_response: z4.string().optional(),
   context: z4.string().optional(),
   tool_event: ToolEventSchema.optional()
-});
+}).passthrough();
 var ScanRequestSchema = z4.object({
   tr_id: z4.string().max(MAX_TRANSACTION_ID_STR_LENGTH).optional(),
   session_id: z4.string().max(MAX_SESSION_ID_STR_LENGTH).optional(),
   ai_profile: AiProfileSchema,
   metadata: MetadataSchema.optional(),
   contents: z4.array(ScanRequestContentsInnerSchema).min(1)
-});
+}).passthrough();
 
 // src/models/scan-response.ts
 import { z as z8 } from "zod";
@@ -662,7 +667,7 @@ import { z as z8 } from "zod";
 import { z as z5 } from "zod";
 var PromptDetectionDetailsSchema = z5.object({
   topic_guardrails_details: z5.record(z5.unknown()).optional()
-});
+}).passthrough();
 var PromptDetectedSchema = z5.object({
   url_cats: z5.boolean().optional(),
   dlp: z5.boolean().optional(),
@@ -671,13 +676,13 @@ var PromptDetectedSchema = z5.object({
   malicious_code: z5.boolean().optional(),
   agent: z5.boolean().optional(),
   topic_violation: z5.boolean().optional()
-});
+}).passthrough();
 
 // src/models/response-detected.ts
 import { z as z6 } from "zod";
 var ResponseDetectionDetailsSchema = z6.object({
   topic_guardrails_details: z6.record(z6.unknown()).optional()
-});
+}).passthrough();
 var ResponseDetectedSchema = z6.object({
   url_cats: z6.boolean().optional(),
   dlp: z6.boolean().optional(),
@@ -687,7 +692,7 @@ var ResponseDetectedSchema = z6.object({
   agent: z6.boolean().optional(),
   ungrounded: z6.boolean().optional(),
   topic_violation: z6.boolean().optional()
-});
+}).passthrough();
 
 // src/models/detection-reports.ts
 import { z as z7 } from "zod";
@@ -763,7 +768,7 @@ var ContentErrorSchema = z7.object({
 var MaskedDataSchema = z8.object({
   data: z8.string().optional(),
   pattern_detections: z8.array(PatternDetectionSchema).optional()
-});
+}).passthrough();
 var IODetectedSchema = z8.object({
   url_cats: z8.boolean().optional(),
   dlp: z8.boolean().optional(),
@@ -781,7 +786,7 @@ var ToolDetectedSchema = z8.object({
   summary: ScanSummarySchema.optional(),
   input_detected: IODetectedSchema.optional(),
   output_detected: IODetectedSchema.optional()
-});
+}).passthrough();
 var ScanResponseSchema = z8.object({
   source: z8.string().optional(),
   report_id: z8.string(),
@@ -804,20 +809,20 @@ var ScanResponseSchema = z8.object({
   tool_detected: ToolDetectedSchema.optional(),
   created_at: z8.string().optional(),
   completed_at: z8.string().optional()
-});
+}).passthrough();
 
 // src/models/async-scan.ts
 import { z as z9 } from "zod";
 var AsyncScanObjectSchema = z9.object({
   req_id: z9.number().int(),
   scan_req: ScanRequestSchema
-});
+}).passthrough();
 var AsyncScanResponseSchema = z9.object({
   received: z9.string(),
   scan_id: z9.string(),
   report_id: z9.string().optional(),
   source: z9.string().optional()
-});
+}).passthrough();
 
 // src/models/scan-id-result.ts
 import { z as z10 } from "zod";
@@ -827,7 +832,7 @@ var ScanIdResultSchema = z10.object({
   status: z10.string().optional(),
   scan_id: z10.string().optional(),
   result: ScanResponseSchema.optional()
-});
+}).passthrough();
 
 // src/models/threat-report.ts
 import { z as z14 } from "zod";
@@ -845,7 +850,7 @@ var DlpReportSchema = z11.object({
   data_pattern_rule1_verdict: z11.string().optional(),
   data_pattern_rule2_verdict: z11.string().optional(),
   data_pattern_detection_offsets: z11.array(DlpPatternDetectionSchema).optional()
-});
+}).passthrough();
 
 // src/models/urlf-report.ts
 import { z as z12 } from "zod";
@@ -854,7 +859,7 @@ var UrlfEntrySchema = z12.object({
   risk_level: z12.string().optional(),
   action: z12.string().optional(),
   categories: z12.array(z12.string()).optional()
-});
+}).passthrough();
 
 // src/models/detection.ts
 var DSDetailResultSchema = z13.object({
@@ -883,7 +888,7 @@ var DetectionServiceResultSchema = z13.object({
   action: z13.string().optional(),
   metadata: DSResultMetadataSchema.optional(),
   result_detail: DSDetailResultSchema.optional()
-});
+}).passthrough();
 
 // src/models/threat-report.ts
 var ThreatScanReportSchema = z14.object({
@@ -894,7 +899,7 @@ var ThreatScanReportSchema = z14.object({
   transaction_id: z14.string().optional(),
   session_id: z14.string().optional(),
   detection_results: z14.array(DetectionServiceResultSchema).optional()
-});
+}).passthrough();
 
 // src/models/error-response.ts
 import { z as z15 } from "zod";
@@ -908,7 +913,7 @@ var ErrorResponseSchema = z15.object({
     interval: z15.number().optional(),
     unit: z15.string().optional()
   }).optional()
-});
+}).passthrough();
 
 // src/models/mgmt-security-profile.ts
 import { z as z16 } from "zod";
@@ -1392,10 +1397,10 @@ var ModelSecurityPaginationSchema = z24.object({
 var LabelSchema = z24.object({
   key: z24.string(),
   value: z24.string()
-});
+}).passthrough();
 var LabelsCreateRequestSchema = z24.object({
   labels: z24.array(LabelSchema)
-});
+}).passthrough();
 var LabelsResponseSchema = z24.object({}).passthrough();
 var LabelKeyListSchema = z24.object({
   pagination: ModelSecurityPaginationSchema,
@@ -1436,7 +1441,7 @@ var ScanDetailsSchema = z24.object({
   scan_duration_ms: z24.number().int(),
   error_code: z24.string().nullable().optional(),
   error_message: z24.string().nullable().optional()
-});
+}).passthrough();
 var ScanCreateRequestSchema = z24.object({
   model_uri: z24.string(),
   security_group_uuid: z24.string(),
@@ -1448,7 +1453,7 @@ var ScanCreateRequestSchema = z24.object({
   model_name: z24.string().nullable().optional(),
   model_version: z24.string().nullable().optional(),
   scan_details: ScanDetailsSchema.nullable().optional()
-});
+}).passthrough();
 var ScanBaseResponseSchema = z24.object({
   uuid: z24.string(),
   tsg_id: z24.string(),
@@ -1586,7 +1591,7 @@ var ModelSecurityRuleInstanceUpdateRequestSchema = z24.object({
   security_group_uuid: z24.string(),
   state: z24.string().nullable().optional(),
   field_values: z24.record(z24.unknown()).nullable().optional()
-});
+}).passthrough();
 var ListModelSecurityRuleInstancesResponseSchema = z24.object({
   pagination: ModelSecurityPaginationSchema,
   rule_instances: z24.array(ModelSecurityRuleInstanceResponseSchema)
@@ -1596,7 +1601,7 @@ var ModelSecurityGroupCreateRequestSchema = z24.object({
   source_type: z24.string(),
   description: z24.string().optional().default(""),
   rule_configurations: z24.record(RuleConfigurationSchema).optional()
-});
+}).passthrough();
 var ModelSecurityGroupResponseSchema = z24.object({
   uuid: z24.string(),
   tsg_id: z24.string(),
@@ -1611,7 +1616,7 @@ var ModelSecurityGroupResponseSchema = z24.object({
 var ModelSecurityGroupUpdateRequestSchema = z24.object({
   name: z24.string().nullable().optional(),
   description: z24.string().nullable().optional()
-});
+}).passthrough();
 var ListModelSecurityGroupsResponseSchema = z24.object({
   pagination: ModelSecurityPaginationSchema,
   security_groups: z24.array(ModelSecurityGroupResponseSchema)
@@ -1818,12 +1823,12 @@ var TargetType = {
 // src/models/red-team.ts
 import { z as z25 } from "zod";
 var RedTeamPaginationSchema = z25.object({ total_items: z25.number().int().nullable().optional() }).passthrough();
-var CountByNameSchema = z25.object({ name: z25.string(), count: z25.number().int() });
+var CountByNameSchema = z25.object({ name: z25.string(), count: z25.number().int() }).passthrough();
 var ValidationErrorSchema = z25.object({
   loc: z25.array(z25.union([z25.string(), z25.number()])),
   msg: z25.string(),
   type: z25.string()
-});
+}).passthrough();
 var HTTPValidationErrorSchema = z25.object({ detail: z25.array(ValidationErrorSchema).optional() }).passthrough();
 var TargetBackgroundSchema = z25.object({
   industry: z25.string().nullable().optional(),
@@ -1906,7 +1911,7 @@ var ConnectionParamsSchema = z25.union([
 var TargetJobRequestSchema = z25.object({
   uuid: z25.string(),
   version: z25.number().int().nullable().optional()
-});
+}).passthrough();
 var JobTimeRecordSchema = z25.object({
   queued_at: z25.string().nullable().optional(),
   started_at: z25.string().nullable().optional(),
@@ -1967,7 +1972,7 @@ var JobCreateRequestSchema = z25.object({
   ]),
   version: z25.number().int().nullable().optional(),
   extra_info: z25.record(z25.unknown()).nullable().optional()
-});
+}).passthrough();
 var StaticJobReportStatsSchema = z25.object({
   output_completion_percentage: z25.number(),
   partial_report_unlocked: z25.boolean().optional(),
@@ -2038,12 +2043,12 @@ var JobListResponseSchema = z25.object({
 var JobAbortResponseSchema = z25.object({
   job_id: z25.string(),
   message: z25.string()
-});
+}).passthrough();
 var PrerequisiteModelSchema = z25.object({
   id: z25.string(),
   display_name: z25.string(),
   description: z25.string()
-});
+}).passthrough();
 var SubCategoryModelSchema = z25.object({
   id: z25.string(),
   display_name: z25.string(),
@@ -2337,17 +2342,17 @@ var CustomAttackOutputSchema = z25.object({
 var PropertyAssignmentSchema = z25.object({
   name: z25.string(),
   value: z25.string()
-});
+}).passthrough();
 var PropertyValueStatisticSchema = z25.object({
   value: z25.string(),
   successful_attack_count: z25.number().int(),
   total_attack_count: z25.number().int(),
   success_rate: z25.number()
-});
+}).passthrough();
 var PropertyStatisticSchema = z25.object({
   property_name: z25.string(),
   values: z25.array(PropertyValueStatisticSchema)
-});
+}).passthrough();
 var PromptSetSummarySchema = z25.object({
   prompt_set_id: z25.string(),
   prompt_set_name: z25.string(),
@@ -2408,16 +2413,16 @@ var ScanStatisticsResponseSchema = z25.object({
 var ScoreTrendSeriesSchema = z25.object({
   label: z25.string(),
   data: z25.array(z25.number().nullable())
-});
+}).passthrough();
 var ScoreTrendResponseSchema = z25.object({
   labels: z25.array(z25.string()),
   series: z25.array(ScoreTrendSeriesSchema)
-});
+}).passthrough();
 var SentimentRequestSchema = z25.object({
   job_id: z25.string(),
   up_vote: z25.boolean().optional(),
   down_vote: z25.boolean().optional()
-});
+}).passthrough();
 var SentimentResponseSchema = z25.object({
   job_id: z25.string(),
   up_vote: z25.boolean().optional(),
@@ -2427,12 +2432,12 @@ var QuotaDetailsSchema = z25.object({
   allocated: z25.number().int(),
   unlimited: z25.boolean(),
   consumed: z25.number().int()
-});
+}).passthrough();
 var QuotaSummarySchema = z25.object({
   static: QuotaDetailsSchema,
   dynamic: QuotaDetailsSchema,
   custom: QuotaDetailsSchema
-});
+}).passthrough();
 var ErrorLogSchema = z25.object({
   created_at: z25.string(),
   updated_at: z25.string(),
@@ -2559,7 +2564,7 @@ var TargetProfileResponseSchema = z25.object({
 var BaseResponseSchema = z25.object({
   message: z25.string(),
   status: z25.number().int()
-});
+}).passthrough();
 var PromptSetStatsSchema = z25.object({
   total_prompts: z25.number().int(),
   active_prompts: z25.number().int(),
@@ -2571,14 +2576,14 @@ var CustomPromptSetCreateRequestSchema = z25.object({
   name: z25.string(),
   description: z25.unknown().optional(),
   property_names: z25.array(z25.string()).optional()
-});
+}).passthrough();
 var CustomPromptSetUpdateRequestSchema = z25.object({
   name: z25.unknown().optional(),
   description: z25.unknown().optional(),
   archive: z25.unknown().optional(),
   property_names: z25.unknown().optional()
 }).passthrough();
-var CustomPromptSetArchiveRequestSchema = z25.object({ archive: z25.boolean() });
+var CustomPromptSetArchiveRequestSchema = z25.object({ archive: z25.boolean() }).passthrough();
 var CustomPromptSetResponseSchema = z25.object({
   uuid: z25.string(),
   name: z25.string(),
@@ -2637,7 +2642,7 @@ var CustomPromptCreateRequestSchema = z25.object({
   prompt_set_id: z25.string(),
   goal: z25.unknown().optional(),
   properties: z25.unknown().optional()
-});
+}).passthrough();
 var CustomPromptUpdateRequestSchema = z25.object({
   prompt: z25.unknown().optional(),
   goal: z25.unknown().optional(),
@@ -2674,15 +2679,15 @@ var CustomPromptListSchema = z25.object({
   pagination: RedTeamPaginationSchema,
   data: z25.array(CustomPromptListItemSchema).optional()
 }).passthrough();
-var PropertyNameCreateRequestSchema = z25.object({ name: z25.string() });
+var PropertyNameCreateRequestSchema = z25.object({ name: z25.string() }).passthrough();
 var PropertyValueCreateRequestSchema = z25.object({
   property_name: z25.string(),
   property_value: z25.string()
-});
+}).passthrough();
 var PropertyDefinitionSchema = z25.object({
   property_name: z25.string(),
   created_at: z25.string()
-});
+}).passthrough();
 var PropertyNamesListResponseSchema = z25.object({ data: z25.array(PropertyDefinitionSchema).optional() }).passthrough();
 var PropertyValuesResponseSchema = z25.object({
   name: z25.string(),
@@ -2701,7 +2706,7 @@ var OAuthTokenResponseSchema = z26.object({
   token_type: z26.string().optional(),
   expires_in: z26.number(),
   scope: z26.string().optional()
-});
+}).passthrough();
 
 // src/management/oauth-client.ts
 var DEFAULT_TOKEN_BUFFER_MS = 3e4;
@@ -3717,6 +3722,7 @@ var ModelSecurityScansClient = class {
    * Delete labels from a scan by key.
    * @param scanUuid - Scan UUID.
    * @param keys - Label keys to delete.
+   * @returns Resolves when the labels are deleted.
    */
   async deleteLabels(scanUuid, keys) {
     if (!isValidUuid(scanUuid)) {
@@ -4200,7 +4206,11 @@ var RedTeamScansClient = class {
     this.oauthClient = opts.oauthClient;
     this.numRetries = opts.numRetries;
   }
-  /** Create a new red team scan job. */
+  /**
+   * Create a new red team scan job.
+   * @param request - Job creation request body.
+   * @returns The created job response.
+   */
   async create(request) {
     const res = await managementHttpRequest({
       method: "POST",
@@ -4660,7 +4670,12 @@ var RedTeamTargetsClient = class {
     this.oauthClient = opts.oauthClient;
     this.numRetries = opts.numRetries;
   }
-  /** Create a new target. */
+  /**
+   * Create a new target.
+   * @param request - Target creation request body.
+   * @param opts - Optional operation options (e.g. validate connection).
+   * @returns The created target response.
+   */
   async create(request, opts) {
     const params = {};
     if (opts?.validate !== void 0) params.validate = String(opts.validate);