@adobe/spacecat-shared-data-access 1.2.1 → 1.2.3

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-data-access-v1.2.3](https://github.com/adobe-rnd/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.2.2...@adobe/spacecat-shared-data-access-v1.2.3) (2023-12-10)
+
+
+### Bug Fixes
+
+* allow sorting for get audits for site ([#41](https://github.com/adobe-rnd/spacecat-shared/issues/41)) ([3664c97](https://github.com/adobe-rnd/spacecat-shared/commit/3664c97bd63d4f10e260582455e3763da60399dd))
+
+# [@adobe/spacecat-shared-data-access-v1.2.2](https://github.com/adobe-rnd/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.2.1...@adobe/spacecat-shared-data-access-v1.2.2) (2023-12-08)
+
+
+### Bug Fixes
+
+* allow update of github URL ([#40](https://github.com/adobe-rnd/spacecat-shared/issues/40)) ([21da989](https://github.com/adobe-rnd/spacecat-shared/commit/21da9893fcb9c971c1c6a4e1271133188351c155))
+
 # [@adobe/spacecat-shared-data-access-v1.2.1](https://github.com/adobe-rnd/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.2.0...@adobe/spacecat-shared-data-access-v1.2.1) (2023-12-07)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-data-access",
-  "version": "1.2.1",
+  "version": "1.2.3",
   "description": "Shared modules of the Spacecat Services - Data Access",
   "type": "module",
   "main": "src/index.js",

package/src/index.d.ts

@@ -34,13 +34,15 @@ export interface Site {
   isLive: () => boolean;
   setAudits: (audits: Audit[]) => Site;
   toggleLive: () => Site;
+  updateGitHubURL: (gitHubURL: string) => Site;
   updateImsOrgId: (imsOrgId: string) => Site;
 }
 
 export interface DataAccess {
   getAuditsForSite: (
     siteId: string,
-    auditType?: string
+    auditType?: string,
+    ascending?: boolean,
   ) => Promise<Audit[]>;
   getLatestAuditForSite: (
     siteId: string,

package/src/models/site.js

@@ -65,6 +65,27 @@ const Site = (data = {}) => {
     return self;
   }; */
 
+  /**
+   * Updates the GitHub URL belonging to the site.
+   * @param {string} gitHubURL - The GitHub URL.
+   * @return {Base} The updated site.
+   */
+  self.updateGitHubURL = (gitHubURL) => {
+    if (!isValidUrl(gitHubURL)) {
+      throw new Error('GitHub URL must be a valid URL');
+    }
+
+    self.state.gitHubURL = gitHubURL;
+    self.touch();
+
+    return self;
+  };
+
+  /**
+   * Updates the IMS Org ID belonging to the site.
+   * @param {string} imsOrgId - The IMS Org ID.
+   * @return {Base} The updated site.
+   */
   self.updateImsOrgId = (imsOrgId) => {
     if (!hasText(imsOrgId)) {
       throw new Error('IMS Org ID must be provided');
@@ -81,6 +102,10 @@ const Site = (data = {}) => {
     return self;
   };
 
+  /**
+   * Sets whether the site is live.
+   * @return {Base} The updated site.
+   */
   self.toggleLive = () => {
     self.state.isLive = !self.state.isLive;
     return self;

package/src/service/audits/accessPatterns.js

@@ -10,7 +10,7 @@
  * governing permissions and limitations under the License.
  */
 
-import { isObject } from '@adobe/spacecat-shared-utils';
+import { hasText, isObject } from '@adobe/spacecat-shared-utils';
 
 import { AuditDto } from '../../dto/audit.js';
 import { createAudit } from '../../models/audit.js';
@@ -24,19 +24,29 @@ import { createAudit } from '../../models/audit.js';
  * @param {Logger} log - The logger.
  * @param {string} siteId - The ID of the site for which audits are being retrieved.
  * @param {string} [auditType] - Optional. The type of audits to retrieve.
+ * @param {boolean} [ascending] - Optional. Determines if the audits should be sorted
+ * ascending. Default is true.
  * @returns {Promise<Readonly<Audit>[]>} A promise that resolves to an array of audits
  * for the specified site.
  */
-export const getAuditsForSite = async (dynamoClient, config, log, siteId, auditType) => {
+export const getAuditsForSite = async (
+  dynamoClient,
+  config,
+  log,
+  siteId,
+  auditType,
+  ascending = true,
+) => {
   const queryParams = {
     TableName: config.tableNameAudits,
     KeyConditionExpression: 'siteId = :siteId',
     ExpressionAttributeValues: {
       ':siteId': siteId,
     },
+    ScanIndexForward: ascending, // Sorts ascending if true, descending if false
   };
 
-  if (auditType !== undefined) {
+  if (hasText(auditType)) {
     queryParams.KeyConditionExpression += ' AND begins_with(SK, :auditType)';
     queryParams.ExpressionAttributeValues[':auditType'] = `${auditType}#`;
   }