@adobe/spacecat-shared-content-client 1.1.6 → 1.1.8

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-content-client-v1.1.8](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-content-client-v1.1.7...@adobe/spacecat-shared-content-client-v1.1.8) (2024-10-02)
+
+
+### Bug Fixes
+
+* docs for content client ([0978c2d](https://github.com/adobe/spacecat-shared/commit/0978c2d84636f03b7ebdf22e9888740d9518b989))
+
+# [@adobe/spacecat-shared-content-client-v1.1.7](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-content-client-v1.1.6...@adobe/spacecat-shared-content-client-v1.1.7) (2024-10-02)
+
+
+### Bug Fixes
+
+* content client should use the hlxConfig ([8e74827](https://github.com/adobe/spacecat-shared/commit/8e74827613421828eaef29cf1372d329433526cc))
+
 # [@adobe/spacecat-shared-content-client-v1.1.6](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-content-client-v1.1.5...@adobe/spacecat-shared-content-client-v1.1.6) (2024-10-01)
 
 

package/README.md

@@ -20,7 +20,30 @@ To remove `node_modules` and `package-lock.json`:
 ```bash
 npm run clean
 ```
+## Usage
 
+### Google Drive
+
+```js
+import { ContentClient } from '../src/index.js';
+
+const context = {}; // Your AWS Lambda context object
+const gdriveclient = await ContentClient.createFrom(context, { url: 'GOOGLE_DRIVE_URL', type: 'drive.google' });
+const results = await client.getPageMetadata('/path1');
+console.log(results);
+```
+
+### Microsoft Sharepoint Drive
+
+```js
+import { ContentClient } from '../src/index.js';
+
+const context = {}; // Your AWS Lambda context object
+const onedriveclient = await ContentClient.createFrom(context, { url: 'ONEDRIVE_URL', type: 'onedrive' });
+
+const results = await client.getPageMetadata('/path1');
+console.log(results);
+```
 ## Additional Information
 
 - **Repository**: [GitHub](https://github.com/adobe/spacecat-shared.git)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-content-client",
-  "version": "1.1.6",
+  "version": "1.1.8",
   "description": "Shared modules of the Spacecat Services - Content Client",
   "type": "module",
   "engines": {
@@ -40,6 +40,7 @@
     "graph-data-structure": "4.0.0"
   },
   "devDependencies": {
+    "@adobe/spacecat-shared-data-access": "1.45.5",
     "chai": "5.1.1",
     "chai-as-promised": "8.0.0",
     "esmock": "2.6.7",

package/src/clients/content-client.js

@@ -58,7 +58,7 @@ const validateSite = (site) => {
     throw new Error('Site is required');
   }
 
-  const contentSource = site.getConfig()?.getHlxContentConfig()?.source;
+  const contentSource = site.getHlxConfig()?.content?.source;
   if (!isObject(contentSource)) {
     throw new Error('Site must have a valid content source');
   }
@@ -181,7 +181,7 @@ export default class ContentClient {
     const { log = console, env } = context;
 
     const config = {};
-    const contentSourceType = site.getConfig()?.getHlxContentConfig()?.source?.type;
+    const contentSourceType = site.getHlxConfig()?.content?.source?.type;
     const envMapping = SUPPORTED_CONTENT_SOURCES.get(contentSourceType);
 
     if (envMapping) {
@@ -195,11 +195,11 @@ export default class ContentClient {
 
   constructor(config, site, log) {
     validateSite(site);
-    validateConfiguration(config, site.getConfig()?.getHlxContentConfig()?.source?.type);
+    validateConfiguration(config, site.getHlxConfig()?.content.source?.type);
 
     this.log = log;
     this.config = config;
-    this.contentSource = site.getConfig()?.getHlxContentConfig()?.source;
+    this.contentSource = site.getHlxConfig()?.content?.source;
     this.site = site;
     this.rawClient = null;
   }

package/src/clients/index.d.ts

@@ -36,10 +36,11 @@ export class ContentClient {
    * Example: "/path/to/page" (from the full URL: "https://www.example.com/path/to/page").
    *
    * @param {string} path The path to the page.
-   * @returns {Map<string, string>} The page's metadata.
+   * @returns {Promise<Map<string, { value: string, type: string }>>} A promise that
+   * resolves to the page's metadata.
    * @throws {Error} If the path is not a string, empty or does not start with a "/"
    */
-  getPageMetadata(path: string): Map<string, string>;
+  getPageMetadata(path: string): Promise<Map<string, { value: string, type: string }>>;
 
   /**
    * Updates the metadata for the given page path. The document backing the path
@@ -53,17 +54,41 @@ export class ContentClient {
    * overwrites the existing metadata.
    *
    * @param {string} path The path to the page.
-   * @param {Map<string, string>} metadata The metadata to update.
+   * @param {Map<string, { value: string, type: string }>} metadata The metadata to update.
    * @param {Object} [options] The options to use for updating the metadata.
    * @param {Object} [options.overwrite] Whether to overwrite the existing metadata.
-   * @returns {Map<string, string>} The page's merged metadata.
+   * @returns {Promise<Map<string, { value: string, type: string }>>}  A promise that resolves to
+   * the page's merged metadata.
    * @throws {Error} If the metadata is not a Map or empty
    * @throws {Error} If any of the metadata keys or values are not a string
    * @throws {Error} If the path is not a string, empty or does not start with a "/"
    */
   updatePageMetadata(
     path: string,
-    metadata: Map<string, string>,
+    metadata: Map<string, { value: string, type: string }>,
     options: object,
-  ): Map<string, string>;
+  ): Promise<Map<string, { value: string, type: string }>>;
+
+  /**
+   * Retrieves the current redirects for the site from the redirects.xlsx file.
+   *
+   * @returns {Promise<Array<{ from: string, to: string }>>} A promise that resolves to
+   * an array of redirect objects.
+   * @throws {Error} If there is an issue retrieving the redirects.
+   */
+  getRedirects(): Promise<Array<{ from: string, to: string }>>
+
+  /**
+   * Updates the redirects for the site with the valid array of redirects.
+   * The redirects are validated before updating the redirects.
+   * The duplicate redirects are removed.
+   * The redundant redirects are removed.
+   * The valid redirects are appended at the end of the redirects.xlsx file.
+   *
+   * @param {Array<{ from: string, to: string }>} redirects The array of redirect objects to update.
+   * @returns {Promise<void>} A promise that resolves when the redirects have been updated.
+   * @throws {Error} If the redirects array is not valid or if there
+   * is an issue updating the redirects.
+   */
+  updateRedirects(redirects: Array<{ from: string, to: string }>): Promise<void>
 }