@adobe/spacecat-shared-data-access 3.58.0 → 3.59.0

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+## [@adobe/spacecat-shared-data-access-v3.59.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v3.58.0...@adobe/spacecat-shared-data-access-v3.59.0) (2026-05-07)
+
+### Features
+
+* **data-access:** add Token.allBySiteId with optional tokenTypes/cycle filters ([#1572](https://github.com/adobe/spacecat-shared/issues/1572)) ([241607e](https://github.com/adobe/spacecat-shared/commit/241607e58c6b040eeaba134d51345ccd88910756))
+
 ## [@adobe/spacecat-shared-data-access-v3.58.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v3.57.0...@adobe/spacecat-shared-data-access-v3.58.0) (2026-05-05)
 
 ### Features

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-data-access",
-  "version": "3.58.0",
+  "version": "3.59.0",
   "description": "Shared modules of the Spacecat Services - Data Access",
   "type": "module",
   "engines": {

package/src/models/token/token.collection.js

@@ -10,7 +10,7 @@
  * governing permissions and limitations under the License.
  */
 
-import { hasText, getTokenGrantConfig } from '@adobe/spacecat-shared-utils';
+import { hasText, isNonEmptyArray, getTokenGrantConfig } from '@adobe/spacecat-shared-utils';
 
 import BaseCollection from '../base/base.collection.js';
 import DataAccessError from '../../errors/data-access.error.js';
@@ -66,6 +66,44 @@ class TokenCollection extends BaseCollection {
       used: 0,
     });
   }
+
+  /**
+   * Finds Tokens for the given siteId, optionally narrowed by tokenTypes and/or
+   * cycle. Issued as a single PostgREST query; all combinations are index-backed:
+   *   - siteId + cycle           → (site_id, cycle) index
+   *   - siteId + cycle + types   → (site_id, cycle) index + IN filter
+   *   - siteId + types           → (site_id, token_type, cycle) unique index prefix
+   *   - siteId only              → (site_id, …) prefix scan
+   *
+   * @param {string} siteId - Site ID (UUID).
+   * @param {Object} [options={}] - Query and filter options.
+   * @param {string[]} [options.tokenTypes] - Optional non-empty array of token
+   *   type strings. When omitted, returns rows for all token types.
+   * @param {string} [options.cycle] - Optional cycle string (e.g. '2025-03').
+   *   When omitted, returns rows for all cycles.
+   * @returns {Promise<import('./token.model.js').default[]>} Array of Token instances.
+   */
+  async allBySiteId(siteId, options = {}) {
+    if (!hasText(siteId)) {
+      throw new DataAccessError('TokenCollection.allBySiteId: siteId is required');
+    }
+    const { tokenTypes, cycle, ...queryOptions } = options;
+    const hasTypeFilter = tokenTypes != null;
+    if (hasTypeFilter && (!isNonEmptyArray(tokenTypes) || !tokenTypes.every(hasText))) {
+      throw new DataAccessError('TokenCollection.allBySiteId: tokenTypes must be a non-empty array of strings when provided');
+    }
+    if (cycle != null && !hasText(cycle)) {
+      throw new DataAccessError('TokenCollection.allBySiteId: cycle must be a non-empty string when provided');
+    }
+    const keys = { siteId };
+    if (hasText(cycle)) {
+      keys.cycle = cycle;
+    }
+    if (hasTypeFilter) {
+      queryOptions.where = (attrs, op) => op.in(attrs.tokenType, tokenTypes);
+    }
+    return this.all(keys, queryOptions);
+  }
 }
 
 export default TokenCollection;