@cdot65/prisma-airs-sdk 0.5.1 → 0.6.0

package/README.md

@@ -1,5 +1,14 @@
 # prisma-airs-sdk
 
+[![CI](https://github.com/cdot65/prisma-airs-sdk/actions/workflows/ci.yml/badge.svg)](https://github.com/cdot65/prisma-airs-sdk/actions/workflows/ci.yml)
+[![Tests](https://github.com/cdot65/prisma-airs-sdk/actions/workflows/test.yml/badge.svg)](https://github.com/cdot65/prisma-airs-sdk/actions/workflows/test.yml)
+[![npm version](https://img.shields.io/npm/v/@cdot65/prisma-airs-sdk)](https://www.npmjs.com/package/@cdot65/prisma-airs-sdk)
+[![npm downloads](https://img.shields.io/npm/dm/@cdot65/prisma-airs-sdk)](https://www.npmjs.com/package/@cdot65/prisma-airs-sdk)
+[![Coverage](https://img.shields.io/badge/coverage-99%25-brightgreen)](https://github.com/cdot65/prisma-airs-sdk)
+[![TypeScript](https://img.shields.io/badge/TypeScript-5.x-3178c6)](https://www.typescriptlang.org/)
+[![Node 18+](https://img.shields.io/badge/node-%3E%3D18-brightgreen)](https://nodejs.org/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+
 TypeScript SDK for Palo Alto Networks **Prisma AIRS** — covering the full lifecycle from configuration management to operational scanning across all three service domains: **AI Runtime Security**, **AI Red Teaming**, and **Model Security**.
 
 ## Installation

package/dist/index.cjs

@@ -42,6 +42,7 @@ __export(index_exports, {
   AuthType: () => AuthType,
   BEARER: () => BEARER,
   BaseResponseSchema: () => BaseResponseSchema,
+  BedrockAccessConnectionParamsSchema: () => BedrockAccessConnectionParamsSchema,
   BrandSubCategory: () => BrandSubCategory,
   Category: () => Category,
   CategoryModelSchema: () => CategoryModelSchema,
@@ -49,6 +50,7 @@ __export(index_exports, {
   ComplianceReportSchema: () => ComplianceReportSchema,
   ComplianceSubCategory: () => ComplianceSubCategory,
   ComplianceTechniqueSchema: () => ComplianceTechniqueSchema,
+  ConnectionParamsSchema: () => ConnectionParamsSchema,
   Content: () => Content,
   CountByNameSchema: () => CountByNameSchema,
   CountedQuotaEnum: () => CountedQuotaEnum,
@@ -84,6 +86,7 @@ __export(index_exports, {
   DSDetailResultSchema: () => DSDetailResultSchema,
   DSResultMetadataSchema: () => DSResultMetadataSchema,
   DashboardOverviewResponseSchema: () => DashboardOverviewResponseSchema,
+  DatabricksConnectionParamsSchema: () => DatabricksConnectionParamsSchema,
   DateRangeFilter: () => DateRangeFilter,
   DeleteProfileConflictSchema: () => DeleteProfileConflictSchema,
   DeleteProfileResponseSchema: () => DeleteProfileResponseSchema,
@@ -117,6 +120,7 @@ __export(index_exports, {
   HEADER_AUTH_TOKEN: () => HEADER_AUTH_TOKEN,
   HTTPValidationErrorSchema: () => HTTPValidationErrorSchema,
   HTTP_FORCE_RETRY_STATUS_CODES: () => HTTP_FORCE_RETRY_STATUS_CODES,
+  HuggingfaceConnectionParamsSchema: () => HuggingfaceConnectionParamsSchema,
   IODetectedSchema: () => IODetectedSchema,
   JobAbortResponseSchema: () => JobAbortResponseSchema,
   JobCreateRequestSchema: () => JobCreateRequestSchema,
@@ -188,7 +192,10 @@ __export(index_exports, {
   ModelSecurityRuleResponseSchema: () => ModelSecurityRuleResponseSchema,
   ModelSecurityRulesClient: () => ModelSecurityRulesClient,
   ModelSecurityScansClient: () => ModelSecurityScansClient,
+  MultiTurnStatefulConfigSchema: () => MultiTurnStatefulConfigSchema,
+  MultiTurnStatelessConfigSchema: () => MultiTurnStatelessConfigSchema,
   OAuthClient: () => OAuthClient,
+  OpenAIConnectionParamsSchema: () => OpenAIConnectionParamsSchema,
   PAYLOAD_HASH: () => PAYLOAD_HASH,
   PolicySchema: () => PolicySchema,
   PolicyType: () => PolicyType,
@@ -246,6 +253,7 @@ __export(index_exports, {
   ResponseDetectedSchema: () => ResponseDetectedSchema,
   ResponseDetectionDetailsSchema: () => ResponseDetectionDetailsSchema,
   ResponseMode: () => ResponseMode,
+  RestConnectionParamsSchema: () => RestConnectionParamsSchema,
   RiskLevelSchema: () => RiskLevelSchema,
   RiskRating: () => RiskRating,
   RuleConfigurationSchema: () => RuleConfigurationSchema,
@@ -302,6 +310,7 @@ __export(index_exports, {
   StreamIterationDataSchema: () => StreamIterationDataSchema,
   StreamListResponseSchema: () => StreamListResponseSchema,
   StreamType: () => StreamType,
+  StreamingConnectionParamsSchema: () => StreamingConnectionParamsSchema,
   SubCategoryModelSchema: () => SubCategoryModelSchema,
   SubCategoryStatsSchema: () => SubCategoryStatsSchema,
   TargetAdditionalContextSchema: () => TargetAdditionalContextSchema,
@@ -362,7 +371,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.5.1";
+var SDK_VERSION = "0.6.0";
 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";
@@ -1820,33 +1829,83 @@ var ValidationErrorSchema = import_zod18.z.object({
 });
 var HTTPValidationErrorSchema = import_zod18.z.object({ detail: import_zod18.z.array(ValidationErrorSchema).optional() }).passthrough();
 var TargetBackgroundSchema = import_zod18.z.object({
-  industry: import_zod18.z.unknown().optional(),
-  use_case: import_zod18.z.unknown().optional(),
-  competitors: import_zod18.z.unknown().optional()
+  industry: import_zod18.z.string().nullable().optional(),
+  use_case: import_zod18.z.string().nullable().optional(),
+  competitors: import_zod18.z.array(import_zod18.z.string()).nullable().optional()
 }).passthrough();
 var TargetAdditionalContextSchema = import_zod18.z.object({
-  base_model: import_zod18.z.unknown().optional(),
-  core_architecture: import_zod18.z.unknown().optional(),
-  system_prompt: import_zod18.z.unknown().optional(),
-  languages_supported: import_zod18.z.unknown().optional(),
-  banned_keywords: import_zod18.z.unknown().optional(),
-  tools_accessible: import_zod18.z.unknown().optional()
+  base_model: import_zod18.z.string().nullable().optional(),
+  core_architecture: import_zod18.z.string().nullable().optional(),
+  system_prompt: import_zod18.z.string().nullable().optional(),
+  languages_supported: import_zod18.z.array(import_zod18.z.string()).nullable().optional(),
+  banned_keywords: import_zod18.z.array(import_zod18.z.string()).nullable().optional(),
+  tools_accessible: import_zod18.z.array(import_zod18.z.string()).nullable().optional()
 }).passthrough();
 var TargetMetadataSchema = import_zod18.z.object({
   multi_turn: import_zod18.z.boolean().optional(),
-  multi_turn_error_message: import_zod18.z.unknown().optional(),
-  rate_limit: import_zod18.z.unknown().optional(),
+  multi_turn_error_message: import_zod18.z.string().nullable().optional(),
+  rate_limit: import_zod18.z.number().int().nullable().optional(),
   rate_limit_enabled: import_zod18.z.boolean().optional(),
-  rate_limit_error_code: import_zod18.z.unknown().optional(),
-  rate_limit_error_json: import_zod18.z.unknown().optional(),
-  rate_limit_error_message: import_zod18.z.unknown().optional(),
+  rate_limit_error_code: import_zod18.z.number().int().nullable().optional(),
+  rate_limit_error_json: import_zod18.z.record(import_zod18.z.unknown()).nullable().optional(),
+  rate_limit_error_message: import_zod18.z.string().nullable().optional(),
   content_filter_enabled: import_zod18.z.boolean().optional(),
-  content_filter_error_code: import_zod18.z.unknown().optional(),
-  content_filter_error_json: import_zod18.z.unknown().optional(),
-  content_filter_error_message: import_zod18.z.unknown().optional(),
+  content_filter_error_code: import_zod18.z.number().int().nullable().optional(),
+  content_filter_error_json: import_zod18.z.record(import_zod18.z.unknown()).nullable().optional(),
+  content_filter_error_message: import_zod18.z.string().nullable().optional(),
   probe_message: import_zod18.z.string().optional(),
   request_timeout: import_zod18.z.number().optional()
 }).passthrough();
+var MultiTurnStatefulConfigSchema = import_zod18.z.object({
+  type: import_zod18.z.string().default("stateful"),
+  response_id_field: import_zod18.z.string(),
+  request_id_field: import_zod18.z.string()
+}).passthrough();
+var MultiTurnStatelessConfigSchema = import_zod18.z.object({
+  type: import_zod18.z.string().default("stateless"),
+  assistant_role: import_zod18.z.string().nullable().optional()
+}).passthrough();
+var OpenAIConnectionParamsSchema = import_zod18.z.object({
+  api_key: import_zod18.z.string(),
+  model_name: import_zod18.z.string()
+}).passthrough();
+var HuggingfaceConnectionParamsSchema = import_zod18.z.object({
+  api_key: import_zod18.z.string(),
+  model_name: import_zod18.z.string()
+}).passthrough();
+var DatabricksConnectionParamsSchema = import_zod18.z.object({
+  auth_type: import_zod18.z.string(),
+  workspace_url: import_zod18.z.string(),
+  model_name: import_zod18.z.string(),
+  access_token: import_zod18.z.string().nullable().optional(),
+  client_id: import_zod18.z.string().nullable().optional(),
+  secret: import_zod18.z.string().nullable().optional()
+}).passthrough();
+var BedrockAccessConnectionParamsSchema = import_zod18.z.object({
+  access_id: import_zod18.z.string(),
+  access_secret: import_zod18.z.string(),
+  region: import_zod18.z.string(),
+  model_id: import_zod18.z.string(),
+  session_token: import_zod18.z.string().nullable().optional()
+}).passthrough();
+var RestConnectionParamsSchema = import_zod18.z.object({
+  api_endpoint: import_zod18.z.string().nullable().optional(),
+  request_headers: import_zod18.z.record(import_zod18.z.unknown()).nullable().optional(),
+  request_json: import_zod18.z.record(import_zod18.z.unknown()).nullable().optional(),
+  response_json: import_zod18.z.record(import_zod18.z.unknown()).nullable().optional(),
+  response_key: import_zod18.z.string().nullable().optional(),
+  target_connection_config: import_zod18.z.unknown().nullable().optional(),
+  curl: import_zod18.z.string().nullable().optional(),
+  multi_turn_config: import_zod18.z.unknown().nullable().optional()
+}).passthrough();
+var StreamingConnectionParamsSchema = RestConnectionParamsSchema.extend({
+  response_stop_key: import_zod18.z.string(),
+  response_stop_value: import_zod18.z.string()
+}).passthrough();
+var ConnectionParamsSchema = import_zod18.z.union([
+  StreamingConnectionParamsSchema,
+  RestConnectionParamsSchema
+]);
 var TargetJobRequestSchema = import_zod18.z.object({
   uuid: import_zod18.z.string(),
   version: import_zod18.z.number().int().nullable().optional()
@@ -2572,9 +2631,9 @@ var CustomPromptSetVersionInfoSchema = import_zod18.z.object({
   uuid: import_zod18.z.string(),
   status: import_zod18.z.string(),
   is_latest: import_zod18.z.boolean(),
-  version: import_zod18.z.unknown().optional(),
-  stats: import_zod18.z.unknown().optional(),
-  snapshot_created_at: import_zod18.z.unknown().optional()
+  version: import_zod18.z.string().nullable().optional(),
+  stats: PromptSetStatsSchema.nullable().optional(),
+  snapshot_created_at: import_zod18.z.string().nullable().optional()
 }).passthrough();
 var CustomPromptCreateRequestSchema = import_zod18.z.object({
   prompt: import_zod18.z.string(),
@@ -4178,12 +4237,15 @@ var RedTeamTargetsClient = class {
     this.numRetries = opts.numRetries;
   }
   /** Create a new target. */
-  async create(request) {
+  async create(request, opts) {
+    const params = {};
+    if (opts?.validate !== void 0) params.validate = String(opts.validate);
     const res = await managementHttpRequest({
       method: "POST",
       baseUrl: this.baseUrl,
       path: RED_TEAM_TARGET_PATH,
       body: request,
+      params: Object.keys(params).length > 0 ? params : void 0,
       oauthClient: this.oauthClient,
       numRetries: this.numRetries
     });
@@ -4223,18 +4285,21 @@ var RedTeamTargetsClient = class {
     return res.data;
   }
   /** Update a target. */
-  async update(uuid, request) {
+  async update(uuid, request, opts) {
     if (!isValidUuid(uuid)) {
       throw new AISecSDKException(
         `Invalid target uuid: ${uuid}`,
         "AISEC_USER_REQUEST_PAYLOAD_ERROR" /* USER_REQUEST_PAYLOAD_ERROR */
       );
     }
+    const params = {};
+    if (opts?.validate !== void 0) params.validate = String(opts.validate);
     const res = await managementHttpRequest({
       method: "PUT",
       baseUrl: this.baseUrl,
       path: `${RED_TEAM_TARGET_PATH}/${uuid}`,
       body: request,
+      params: Object.keys(params).length > 0 ? params : void 0,
       oauthClient: this.oauthClient,
       numRetries: this.numRetries
     });
@@ -4445,6 +4510,33 @@ var RedTeamCustomAttacksClient = class {
     });
     return res.data;
   }
+  /** Upload a CSV file of custom prompts for a prompt set. */
+  async uploadPromptsCsv(promptSetUuid, file) {
+    validateUuid(promptSetUuid, "prompt set uuid");
+    const token = await this.oauthClient.getToken();
+    const url = new URL(
+      `${this.baseUrl.replace(/\/+$/, "")}${RED_TEAM_CUSTOM_ATTACK_PATH}/upload-custom-prompts-csv`
+    );
+    url.searchParams.set("prompt_set_uuid", promptSetUuid);
+    const formData = new FormData();
+    formData.append("file", file);
+    const response = await fetch(url.toString(), {
+      method: "POST",
+      headers: {
+        Authorization: `Bearer ${token}`,
+        "User-Agent": USER_AGENT
+      },
+      body: formData
+    });
+    const text = await response.text();
+    if (!response.ok) {
+      throw new AISecSDKException(
+        `Upload failed (${response.status}): ${text}`,
+        "AISEC_SERVER_SIDE_ERROR" /* SERVER_SIDE_ERROR */
+      );
+    }
+    return text ? JSON.parse(text) : { message: "ok", status: 201 };
+  }
   // -----------------------------------------------------------------------
   // Prompt operations
   // -----------------------------------------------------------------------
@@ -4794,6 +4886,7 @@ var RedTeamClient = class {
   AuthType,
   BEARER,
   BaseResponseSchema,
+  BedrockAccessConnectionParamsSchema,
   BrandSubCategory,
   Category,
   CategoryModelSchema,
@@ -4801,6 +4894,7 @@ var RedTeamClient = class {
   ComplianceReportSchema,
   ComplianceSubCategory,
   ComplianceTechniqueSchema,
+  ConnectionParamsSchema,
   Content,
   CountByNameSchema,
   CountedQuotaEnum,
@@ -4836,6 +4930,7 @@ var RedTeamClient = class {
   DSDetailResultSchema,
   DSResultMetadataSchema,
   DashboardOverviewResponseSchema,
+  DatabricksConnectionParamsSchema,
   DateRangeFilter,
   DeleteProfileConflictSchema,
   DeleteProfileResponseSchema,
@@ -4869,6 +4964,7 @@ var RedTeamClient = class {
   HEADER_AUTH_TOKEN,
   HTTPValidationErrorSchema,
   HTTP_FORCE_RETRY_STATUS_CODES,
+  HuggingfaceConnectionParamsSchema,
   IODetectedSchema,
   JobAbortResponseSchema,
   JobCreateRequestSchema,
@@ -4940,7 +5036,10 @@ var RedTeamClient = class {
   ModelSecurityRuleResponseSchema,
   ModelSecurityRulesClient,
   ModelSecurityScansClient,
+  MultiTurnStatefulConfigSchema,
+  MultiTurnStatelessConfigSchema,
   OAuthClient,
+  OpenAIConnectionParamsSchema,
   PAYLOAD_HASH,
   PolicySchema,
   PolicyType,
@@ -4998,6 +5097,7 @@ var RedTeamClient = class {
   ResponseDetectedSchema,
   ResponseDetectionDetailsSchema,
   ResponseMode,
+  RestConnectionParamsSchema,
   RiskLevelSchema,
   RiskRating,
   RuleConfigurationSchema,
@@ -5054,6 +5154,7 @@ var RedTeamClient = class {
   StreamIterationDataSchema,
   StreamListResponseSchema,
   StreamType,
+  StreamingConnectionParamsSchema,
   SubCategoryModelSchema,
   SubCategoryStatsSchema,
   TargetAdditionalContextSchema,