@cdot65/prisma-airs-sdk 0.17.0 → 0.18.0

package/README.md

@@ -56,6 +56,28 @@ console.log(result.action); // "allow" | "block"
 
 That's the API-key scanning path. The OAuth2 clients (`ManagementClient`, `ModelSecurityClient`, `RedTeamClient`, `AIGatewayClient`), authentication setup, error handling, and runnable examples are all covered in the documentation.
 
+## Complete list reads
+
+List endpoints still return their native page envelopes through `list()`. For workflows that need
+the complete result set, the OAuth resource clients also provide all-page helpers:
+
+```ts
+const profiles = await management.profiles.listAll({ latest: true });
+const models = await modelSecurity.models.listAllModels({ search_query: 'llama' });
+const targets = await redTeam.targets.listAll({ status: 'READY' });
+const patterns = await management.dlp.dataPatterns.listAll({ status: 'active' });
+```
+
+All-page helpers preserve resource filters and normalize the APIs' different pagination dialects
+(`offset`/`limit`, `skip`/`limit`, and Spring `page`/`size`). They collect at most 10,000 records by
+default as runaway-pagination protection. Pass `{ max: 500 }` for a smaller bound or `{ max: 0 }`
+to remove the bound. Low-level consumers can compose the exported `paginate()` async generator and
+`collectAll()` helper for endpoints without a resource-specific convenience method.
+
+Profile and topic reads are revision-aware: `profiles.list({ latest: true })` delegates revision
+selection to the service, while `topics.list({ latestOnly: true })` groups all pages by topic name
+and returns the highest revision. `getByName()` returns the highest revision for both resources.
+
 ## AI Gateway
 
 `AIGatewayClient` covers the SCM-managed Prisma AIRS **AI Gateway** — runtime telemetry and configuration across two planes behind one credential set: a data plane (`/ai_gw/v2`, telemetry + workspace-scoped config) and an admin plane (`/ai_gw/admin/v2`, organisation-level config). Twelve sub-clients: `telemetry`, `workspaces`, `configs`, `guardrails`, `providers`, `apiKeys` (data plane) and `integrations`, `mcpIntegrations`, `deployments`, `plugins`, `organisations`, `auditLogs` (admin plane).

package/dist/index.cjs

@@ -660,10 +660,15 @@ __export(index_exports, {
   WebSocketConnectionParamsSchema: () => WebSocketConnectionParamsSchema,
   WeightedRegexSchema: () => WeightedRegexSchema,
   aiGwOrganisationsAuthSettingsPath: () => aiGwOrganisationsAuthSettingsPath,
+  collectAll: () => collectAll,
+  collectSkipPages: () => collectSkipPages,
+  collectSpringPages: () => collectSpringPages,
   globalConfiguration: () => globalConfiguration,
   init: () => init,
   jsonNullable: () => jsonNullable,
-  pageSchema: () => pageSchema
+  pageSchema: () => pageSchema,
+  paginate: () => paginate,
+  serializeListing: () => serializeListing
 });
 module.exports = __toCommonJS(index_exports);
 
@@ -2030,6 +2035,60 @@ var Content = class _Content {
   }
 };
 
+// src/listing.ts
+async function* paginate(fetchPage, initialCursor) {
+  let cursor = initialCursor;
+  const seen = /* @__PURE__ */ new Set();
+  while (true) {
+    if (seen.has(cursor)) throw new Error("Pagination returned a repeated cursor");
+    seen.add(cursor);
+    const page = await fetchPage(cursor);
+    yield* page.items;
+    if (page.next === void 0) return;
+    cursor = page.next;
+  }
+}
+async function collectAll(iterable, opts = {}) {
+  const max = opts.max ?? 1e4;
+  if (!Number.isSafeInteger(max) || max < 0)
+    throw new RangeError("max must be a non-negative integer");
+  const items = [];
+  for await (const item of iterable) {
+    if (max > 0 && items.length >= max) break;
+    items.push(item);
+  }
+  return items;
+}
+function collectSkipPages(fetchPage, opts = {}) {
+  const limit = opts.limit ?? 50;
+  return collectAll(
+    paginate(async (skip) => {
+      const page = await fetchPage(skip, limit);
+      const next = skip + page.items.length;
+      const hasMore = page.items.length > 0 && (page.total == null ? page.items.length === limit : next < page.total);
+      return { items: page.items, next: hasMore ? next : void 0 };
+    }, 0),
+    { max: opts.max }
+  );
+}
+function collectSpringPages(fetchPage, opts = {}) {
+  const size = opts.size ?? 50;
+  return collectAll(
+    paginate(async (page) => {
+      const result = await fetchPage(page, size);
+      return { items: result.items, next: result.last ? void 0 : page + 1 };
+    }, 0),
+    { max: opts.max }
+  );
+}
+function serializeListing(opts) {
+  const params = {};
+  if (opts?.skip !== void 0) params.skip = String(opts.skip);
+  if (opts?.limit !== void 0) params.limit = String(opts.limit);
+  if (opts?.search !== void 0) params.search = opts.search;
+  return params;
+}
+
 // src/models/enums.ts
 var Verdict = {
   BENIGN: "benign",
@@ -5591,6 +5650,7 @@ var ProfilesClient = class {
       offset: String(opts?.offset ?? 0),
       limit: String(opts?.limit ?? 100)
     };
+    if (opts?.latest !== void 0) params.latest = String(opts.latest);
     return request({
       method: "GET",
       baseUrl: this.baseUrl,
@@ -5601,6 +5661,23 @@ var ProfilesClient = class {
       numRetries: this.numRetries
     });
   }
+  /**
+   * List security profiles across every response page.
+   * @example
+   * ```ts
+   * const profiles = await mgmt.profiles.listAll({ latest: true });
+   * ```
+   */
+  async listAll(opts = {}) {
+    const limit = opts.limit ?? 100;
+    return collectAll(
+      paginate(async (offset) => {
+        const page = await this.list({ offset, limit, latest: opts.latest });
+        return { items: page.ai_profiles, next: page.next_offset || void 0 };
+      }, 0),
+      { max: opts.max }
+    );
+  }
   /**
    * Get a security profile by UUID.
    * Fetches all profiles and filters — no dedicated API endpoint exists.
@@ -5618,7 +5695,7 @@ var ProfilesClient = class {
    * ```
    */
   async get(profileId) {
-    const { ai_profiles } = await this.list();
+    const ai_profiles = await this.listAll();
     const profile = ai_profiles.find((p) => p.profile_id === profileId);
     if (!profile) {
       throw new AISecSDKException(
@@ -5644,7 +5721,7 @@ var ProfilesClient = class {
    * ```
    */
   async getByName(profileName) {
-    const { ai_profiles } = await this.list();
+    const ai_profiles = await this.listAll();
     const matches = ai_profiles.filter((p) => p.profile_name === profileName);
     if (matches.length === 0) {
       throw new AISecSDKException(
@@ -5799,6 +5876,22 @@ var TopicsClient = class {
    * ```
    */
   async list(opts) {
+    if (opts?.latestOnly) {
+      const all = await this.listAll({ limit: 200 });
+      const latest = /* @__PURE__ */ new Map();
+      for (const topic of all) {
+        const current = latest.get(topic.topic_name);
+        if (!current || topic.revision > current.revision) latest.set(topic.topic_name, topic);
+      }
+      const custom_topics = [...latest.values()];
+      const offset = opts.offset ?? 0;
+      const limit = opts.limit ?? 100;
+      const nextOffset = offset + limit;
+      return {
+        custom_topics: custom_topics.slice(offset, nextOffset),
+        next_offset: nextOffset < custom_topics.length ? nextOffset : void 0
+      };
+    }
     const params = {
       offset: String(opts?.offset ?? 0),
       limit: String(opts?.limit ?? 100)
@@ -5813,6 +5906,55 @@ var TopicsClient = class {
       numRetries: this.numRetries
     });
   }
+  /**
+   * List custom topics across every response page.
+   * @example
+   * ```ts
+   * const topics = await mgmt.topics.listAll({ limit: 200 });
+   * ```
+   */
+  async listAll(opts = {}) {
+    const limit = opts.limit ?? 100;
+    return collectAll(
+      paginate(async (offset) => {
+        const page = await this.list({ offset, limit });
+        return { items: page.custom_topics, next: page.next_offset || void 0 };
+      }, 0),
+      { max: opts.max }
+    );
+  }
+  /**
+   * Get an exact custom-topic revision by UUID.
+   * @example
+   * ```ts
+   * const topic = await mgmt.topics.get('550e8400-e29b-41d4-a716-446655440000');
+   * ```
+   */
+  async get(topicId) {
+    const topic = (await this.listAll()).find((item) => item.topic_id === topicId);
+    if (!topic)
+      throw new AISecSDKException(
+        `Topic not found: ${topicId}`,
+        "AISEC_USER_REQUEST_PAYLOAD_ERROR" /* USER_REQUEST_PAYLOAD_ERROR */
+      );
+    return topic;
+  }
+  /**
+   * Get the highest revision of a custom topic by name.
+   * @example
+   * ```ts
+   * const topic = await mgmt.topics.getByName('credit-cards');
+   * ```
+   */
+  async getByName(topicName) {
+    const matches = (await this.listAll()).filter((item) => item.topic_name === topicName);
+    if (matches.length === 0)
+      throw new AISecSDKException(
+        `Topic not found: ${topicName}`,
+        "AISEC_USER_REQUEST_PAYLOAD_ERROR" /* USER_REQUEST_PAYLOAD_ERROR */
+      );
+    return matches.reduce((best, topic) => topic.revision > best.revision ? topic : best);
+  }
   /**
    * Update an existing custom topic.
    * @param topicId - UUID of the topic to update.
@@ -5976,6 +6118,17 @@ var ApiKeysClient = class {
       numRetries: this.numRetries
     });
   }
+  /** List all API keys. @example `const keys = await mgmt.apiKeys.listAll();` */
+  async listAll(opts = {}) {
+    const limit = opts.limit ?? 100;
+    return collectAll(
+      paginate(async (offset) => {
+        const page = await this.list({ offset, limit });
+        return { items: page.api_keys ?? [], next: page.next_offset || void 0 };
+      }, 0),
+      { max: opts.max }
+    );
+  }
   /**
    * Delete an API key by name.
    * @param apiKeyName - Name of the API key to delete.
@@ -6100,6 +6253,17 @@ var CustomerAppsClient = class {
       numRetries: this.numRetries
     });
   }
+  /** List all customer applications. @example `const apps = await mgmt.customerApps.listAll();` */
+  async listAll(opts = {}) {
+    const limit = opts.limit ?? 100;
+    return collectAll(
+      paginate(async (offset) => {
+        const page = await this.list({ offset, limit });
+        return { items: page.customer_apps ?? [], next: page.next_offset || void 0 };
+      }, 0),
+      { max: opts.max }
+    );
+  }
   /**
    * Update a customer app.
    * @param customerAppId - UUID of the customer app to update.
@@ -6547,6 +6711,17 @@ var DataFilteringProfilesClient = class {
       numRetries: this.numRetries
     });
   }
+  /** List all filtering profiles. @example `const profiles = await mgmt.dlp.dataFilteringProfiles.listAll();` */
+  async listAll(params = {}) {
+    return collectSpringPages(
+      async (page, size) => {
+        const result = await this.list({ ...params, page, size });
+        const last = result.last ?? (result.totalPages !== void 0 ? page + 1 >= result.totalPages : result.content.length < size);
+        return { items: result.content, last };
+      },
+      { size: params.size, max: params.max }
+    );
+  }
   /**
    * Get a single data filtering profile by resource ID.
    * @example
@@ -6640,6 +6815,17 @@ var DataPatternsClient = class {
       numRetries: this.numRetries
     });
   }
+  /** List all data patterns. @example `const patterns = await mgmt.dlp.dataPatterns.listAll();` */
+  async listAll(params = {}) {
+    return collectSpringPages(
+      async (page, size) => {
+        const result = await this.list({ ...params, page, size });
+        const last = result.last ?? (result.totalPages !== void 0 ? page + 1 >= result.totalPages : result.content.length < size);
+        return { items: result.content, last };
+      },
+      { size: params.size, max: params.max }
+    );
+  }
   /**
    * Create a new custom data pattern.
    * @example
@@ -6813,6 +6999,17 @@ var DataProfilesClient = class {
       numRetries: this.numRetries
     });
   }
+  /** List all data profiles. @example `const profiles = await mgmt.dlp.dataProfiles.listAll();` */
+  async listAll(params = {}) {
+    return collectSpringPages(
+      async (page, size) => {
+        const result = await this.list({ ...params, page, size });
+        const last = result.last ?? (result.totalPages !== void 0 ? page + 1 >= result.totalPages : result.content.length < size);
+        return { items: result.content, last };
+      },
+      { size: params.size, max: params.max }
+    );
+  }
   /**
    * Create a new data profile.
    * @example
@@ -6993,6 +7190,17 @@ var DictionariesClient = class {
       numRetries: this.numRetries
     });
   }
+  /** List all dictionaries. @example `const dictionaries = await mgmt.dlp.dictionaries.listAll();` */
+  async listAll(params = {}) {
+    return collectSpringPages(
+      async (page, size) => {
+        const result = await this.list({ ...params, page, size });
+        const last = result.last ?? (result.totalPages !== void 0 ? page + 1 >= result.totalPages : result.content.length < size);
+        return { items: result.content, last };
+      },
+      { size: params.size, max: params.max }
+    );
+  }
   /**
    * Create a dictionary by uploading a keyword file. Sends a multipart body — the SDK does
    * not set Content-Type so the runtime can write the correct boundary.
@@ -7225,15 +7433,6 @@ var ManagementClient = class {
   }
 };
 
-// src/listing.ts
-function serializeListing(opts) {
-  const params = {};
-  if (opts?.skip !== void 0) params.skip = String(opts.skip);
-  if (opts?.limit !== void 0) params.limit = String(opts.limit);
-  if (opts?.search !== void 0) params.search = opts.search;
-  return params;
-}
-
 // src/model-security/scans-client.ts
 function buildScanListParams(opts) {
   const params = serializeListing(opts);
@@ -7329,6 +7528,13 @@ var ModelSecurityScansClient = class {
       numRetries: this.numRetries
     });
   }
+  /** List every model-security scan page. @example `const scans = await ms.scans.listAll();` */
+  async listAll(opts = {}) {
+    return collectSkipPages(async (skip, limit) => {
+      const page = await this.list({ ...opts, skip, limit });
+      return { items: page.scans, total: page.pagination.total_items };
+    }, opts);
+  }
   /**
    * Get a single scan by UUID.
    * @param uuid - Scan UUID.
@@ -7707,6 +7913,13 @@ var ModelSecurityGroupsClient = class {
       numRetries: this.numRetries
     });
   }
+  /** List every security-group page. @example `const groups = await ms.securityGroups.listAll();` */
+  async listAll(opts = {}) {
+    return collectSkipPages(async (skip, limit) => {
+      const page = await this.list({ ...opts, skip, limit });
+      return { items: page.security_groups, total: page.pagination.total_items };
+    }, opts);
+  }
   /**
    * Get a single security group by UUID.
    * @param uuid - Security group UUID.
@@ -7922,6 +8135,13 @@ var ModelSecurityRulesClient = class {
       numRetries: this.numRetries
     });
   }
+  /** List every security-rule page. @example `const rules = await ms.securityRules.listAll();` */
+  async listAll(opts = {}) {
+    return collectSkipPages(async (skip, limit) => {
+      const page = await this.list({ ...opts, skip, limit });
+      return { items: page.rules, total: page.pagination.total_items };
+    }, opts);
+  }
   /**
    * Get a single security rule by UUID.
    * @param uuid - Security rule UUID.
@@ -8001,6 +8221,13 @@ var ModelSecurityModelsClient = class {
       numRetries: this.numRetries
     });
   }
+  /** List every model page. @example `const models = await ms.models.listAllModels();` */
+  async listAllModels(opts = {}) {
+    return collectSkipPages(async (skip, limit) => {
+      const page = await this.listModels({ ...opts, skip, limit });
+      return { items: page.models, total: page.pagination.total_items };
+    }, opts);
+  }
   /**
    * Get a single model by UUID.
    * @param uuid - Model UUID.
@@ -8057,6 +8284,13 @@ var ModelSecurityModelsClient = class {
       numRetries: this.numRetries
     });
   }
+  /** List every version of a model. @example `const versions = await ms.models.listAllModelVersions(modelUuid);` */
+  async listAllModelVersions(modelUuid, opts = {}) {
+    return collectSkipPages(async (skip, limit) => {
+      const page = await this.listModelVersions(modelUuid, { ...opts, skip, limit });
+      return { items: page.model_versions, total: page.pagination.total_items };
+    }, opts);
+  }
   /**
    * Get a single model version by UUID.
    * @param uuid - Model version UUID.
@@ -8111,6 +8345,13 @@ var ModelSecurityModelsClient = class {
       numRetries: this.numRetries
     });
   }
+  /** List every file in a model version. @example `const files = await ms.models.listAllModelVersionFiles(versionUuid);` */
+  async listAllModelVersionFiles(modelVersionUuid, opts = {}) {
+    return collectSkipPages(async (skip, limit) => {
+      const page = await this.listModelVersionFiles(modelVersionUuid, { ...opts, skip, limit });
+      return { items: page.files, total: page.pagination.total_items };
+    }, opts);
+  }
 };
 
 // src/model-security/client.ts
@@ -8251,6 +8492,13 @@ var RedTeamScansClient = class {
       numRetries: this.numRetries
     });
   }
+  /** List every scan page. @example `const scans = await rt.scans.listAll({ status: 'COMPLETED' });` */
+  async listAll(opts = {}) {
+    return collectSkipPages(async (skip, limit) => {
+      const page = await this.list({ ...opts, skip, limit });
+      return { items: page.data, total: page.pagination.total_items };
+    }, opts);
+  }
   /**
    * Get a single scan job by ID.
    * @param jobId - The job UUID.
@@ -9028,6 +9276,29 @@ var RedTeamTargetsClient = class {
       numRetries: this.numRetries
     });
   }
+  /**
+   * List targets across every page while preserving the supplied filters.
+   * @example
+   * ```ts
+   * const targets = await rt.targets.listAll({ limit: 100, status: 'READY' });
+   * ```
+   */
+  async listAll(opts = {}) {
+    const limit = opts.limit ?? 50;
+    return collectAll(
+      paginate(async (skip) => {
+        const page = await this.list({ ...opts, skip, limit });
+        const items = page.data ?? [];
+        const next = skip + items.length;
+        const total = page.pagination.total_items;
+        return {
+          items,
+          next: items.length > 0 && (total == null ? items.length === limit : next < total) ? next : void 0
+        };
+      }, 0),
+      { max: opts.max }
+    );
+  }
   /**
    * Get a target by UUID.
    * @param uuid - The target UUID.
@@ -9344,6 +9615,13 @@ var RedTeamCustomAttacksClient = class {
       numRetries: this.numRetries
     });
   }
+  /** List every custom prompt-set page. @example `const sets = await rt.customAttacks.listAllPromptSets();` */
+  async listAllPromptSets(opts = {}) {
+    return collectSkipPages(async (skip, limit) => {
+      const page = await this.listPromptSets({ ...opts, skip, limit });
+      return { items: page.data ?? [], total: page.pagination.total_items };
+    }, opts);
+  }
   /**
    * Get a prompt set by UUID.
    * @param uuid - The prompt set UUID.
@@ -9656,6 +9934,13 @@ var RedTeamCustomAttacksClient = class {
       numRetries: this.numRetries
     });
   }
+  /** List every prompt page for a set. @example `const prompts = await rt.customAttacks.listAllPrompts(promptSetUuid);` */
+  async listAllPrompts(promptSetUuid, opts = {}) {
+    return collectSkipPages(async (skip, limit) => {
+      const page = await this.listPrompts(promptSetUuid, { ...opts, skip, limit });
+      return { items: page.data ?? [], total: page.pagination.total_items };
+    }, opts);
+  }
   /**
    * Get a prompt by UUID.
    * @param promptSetUuid - The prompt set UUID.
@@ -10402,6 +10687,13 @@ var RedTeamAdaptersClient = class {
       numRetries: this.numRetries
     });
   }
+  /** List every adapter page. @example `const adapters = await rt.adapters.listAll();` */
+  async listAll(opts = {}) {
+    return collectSkipPages(async (skip, limit) => {
+      const page = await this.list({ ...opts, skip, limit });
+      return { items: page.data ?? [], total: page.pagination.total_items };
+    }, opts);
+  }
   /**
    * Get a single adapter by UUID.
    * @param uuid - Adapter UUID.
@@ -13439,9 +13731,14 @@ var AIGatewayClient = class {
   WebSocketConnectionParamsSchema,
   WeightedRegexSchema,
   aiGwOrganisationsAuthSettingsPath,
+  collectAll,
+  collectSkipPages,
+  collectSpringPages,
   globalConfiguration,
   init,
   jsonNullable,
-  pageSchema
+  pageSchema,
+  paginate,
+  serializeListing
 });
 //# sourceMappingURL=index.cjs.map