@adobe/spacecat-shared-data-access 1.19.3 → 1.20.1

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-data-access-v1.20.1](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.20.0...@adobe/spacecat-shared-data-access-v1.20.1) (2024-03-09)
+
+
+### Bug Fixes
+
+* **deps:** update external fixes ([#179](https://github.com/adobe/spacecat-shared/issues/179)) ([9d0aa97](https://github.com/adobe/spacecat-shared/commit/9d0aa97df6a67bb66c5f098c74aebdebbd0d5f01))
+
+# [@adobe/spacecat-shared-data-access-v1.20.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.19.3...@adobe/spacecat-shared-data-access-v1.20.0) (2024-03-07)
+
+
+### Features
+
+* get and update configurations ([#178](https://github.com/adobe/spacecat-shared/issues/178)) ([163e27a](https://github.com/adobe/spacecat-shared/commit/163e27ad1cf704608a3fba8087d5103c8cb4226d)), closes [#183](https://github.com/adobe/spacecat-shared/issues/183) [/github.com/adobe/spacecat-api-service/issues/183#issuecomment-1973345923](https://github.com//github.com/adobe/spacecat-api-service/issues/183/issues/issuecomment-1973345923)
+
 # [@adobe/spacecat-shared-data-access-v1.19.3](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.19.2...@adobe/spacecat-shared-data-access-v1.19.3) (2024-03-02)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-data-access",
-  "version": "1.19.3",
+  "version": "1.20.1",
   "description": "Shared modules of the Spacecat Services - Data Access",
   "type": "module",
   "main": "src/index.js",
@@ -31,8 +31,8 @@
   "dependencies": {
     "@adobe/spacecat-shared-dynamo": "1.2.5",
     "@adobe/spacecat-shared-utils": "1.2.0",
-    "@aws-sdk/client-dynamodb": "3.525.0",
-    "@aws-sdk/lib-dynamodb": "3.525.0",
+    "@aws-sdk/client-dynamodb": "3.529.1",
+    "@aws-sdk/lib-dynamodb": "3.529.1",
     "@types/joi": "17.2.3",
     "joi": "17.12.2",
     "uuid": "9.0.1"

package/src/dto/configuration.js

@@ -30,4 +30,16 @@ export const ConfigurationDto = {
 
     return createConfiguration(configurationData);
   },
+
+  /**
+     * Converts a Configuration object into a DynamoDB item.
+     * @param {Readonly<Configuration>} configuration - Configuration object.
+     * @returns {object} DynamoDB item.
+     */
+  toDynamoItem: (configuration) => ({
+    PK: 'ALL_CONFIGURATIONS',
+    version: configuration.getVersion(),
+    queues: configuration.getQueues(),
+    jobs: configuration.getJobs(),
+  }),
 };

package/src/index.d.ts

@@ -443,8 +443,10 @@ export interface DataAccess {
   updateSiteCandidate: (siteCandidate: SiteCandidate) => Promise<SiteCandidate>;
 
   // configuration functions
-  getConfiguration: () => Promise<Configuration>
-  getConfigurationByVersion: (version: string) => Promise<Configuration>
+  getConfiguration: () => Promise<Readonly<Configuration>>
+  getConfigurations: () => Promise<Readonly<Configuration>[]>
+  getConfigurationByVersion: (version: string) => Promise<Readonly<Configuration>>
+  updateConfiguration: (configurationData: object) => Promise<Readonly<Configuration>>
 }
 
 interface DataAccessConfig {

package/src/service/configurations/accessPatterns.js

@@ -10,9 +10,13 @@
  * governing permissions and limitations under the License.
  */
 
-import { isObject } from '@adobe/spacecat-shared-utils';
+import {
+  hasText,
+  isObject,
+} from '@adobe/spacecat-shared-utils';
 
 import { ConfigurationDto } from '../../dto/configuration.js';
+import { createConfiguration } from '../../models/configuration.js';
 
 /**
  * Retrieves configuration with latest version.
@@ -40,6 +44,27 @@ export const getConfiguration = async (
   return ConfigurationDto.fromDynamoItem(dynamoItems[0]);
 };
 
+/**
+ * Retrieves all configurations.
+ * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
+ * @param {DataAccessConfig} config - The data access config.
+ * @return {Promise<Readonly<Configuration>[]>} A promise that resolves to the configurations.
+ */
+export const getConfigurations = async (
+  dynamoClient,
+  config,
+) => {
+  const dynamoItems = await dynamoClient.query({
+    TableName: config.tableNameConfigurations,
+    KeyConditionExpression: 'PK = :pk',
+    ExpressionAttributeValues: {
+      ':pk': config.pkAllConfigurations,
+    },
+  });
+
+  return dynamoItems.map(ConfigurationDto.fromDynamoItem);
+};
+
 /**
  * Retrieves a site by its version.
  *
@@ -61,3 +86,39 @@ export const getConfigurationByVersion = async (
 
   return isObject(dynamoItem) ? ConfigurationDto.fromDynamoItem(dynamoItem) : null;
 };
+
+function incrementVersion(version) {
+  if (!hasText(version)) return 'v1';
+
+  const versionNumber = parseInt(version.substring(1), 10);
+  return `v${versionNumber + 1}`;
+}
+
+/**
+ * Updates the configuration. Updating the configuration will create a new version of the
+ * configuration. The version is a string of the format "v<version-number>", for example "v1".
+ * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
+ * @param {DataAccessConfig} config - The data access config.
+  * @param {Configuration} configurationData - The configuration data.
+ * @return {Promise<void>} A promise that resolves when the configuration is updated.
+ */
+export const updateConfiguration = async (
+  dynamoClient,
+  config,
+  configurationData,
+) => {
+  const newConfigurationData = { ...configurationData };
+  const latestConfiguration = await getConfiguration(dynamoClient, config);
+
+  newConfigurationData.version = incrementVersion(latestConfiguration?.version);
+  newConfigurationData.PK = config.pkAllConfigurations;
+
+  const newConfiguration = createConfiguration(newConfigurationData);
+
+  await dynamoClient.putItem(
+    config.tableNameConfigurations,
+    ConfigurationDto.toDynamoItem(newConfiguration),
+  );
+
+  return newConfiguration;
+};

package/src/service/configurations/index.js

@@ -9,16 +9,30 @@
  * OF ANY KIND, either express or implied. See the License for the specific language
  * governing permissions and limitations under the License.
  */
-import { getConfiguration, getConfigurationByVersion } from './accessPatterns.js';
+import {
+  getConfiguration,
+  getConfigurationByVersion,
+  getConfigurations,
+  updateConfiguration,
+} from './accessPatterns.js';
 
 export const configurationFunctions = (dynamoClient, config) => ({
   getConfiguration: () => getConfiguration(
     dynamoClient,
     config,
   ),
+  getConfigurations: () => getConfigurations(
+    dynamoClient,
+    config,
+  ),
   getConfigurationByVersion: (version) => getConfigurationByVersion(
     dynamoClient,
     config,
     version,
   ),
+  updateConfiguration: (configurationData) => updateConfiguration(
+    dynamoClient,
+    config,
+    configurationData,
+  ),
 });