@adobe/spacecat-shared-content-client 1.1.22 → 1.2.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [@adobe/spacecat-shared-content-client-v1.2.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-content-client-v1.1.22...@adobe/spacecat-shared-content-client-v1.2.0) (2024-11-12)
+
+
+### Features
+
+* create content client directly from domain ([17aec10](https://github.com/adobe/spacecat-shared/commit/17aec10cabb7b50d35588054587a96032b52ef73))
+
 # [@adobe/spacecat-shared-content-client-v1.1.22](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-content-client-v1.1.21...@adobe/spacecat-shared-content-client-v1.1.22) (2024-11-11)
 
 

package/README.md

@@ -29,6 +29,15 @@ 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);
+```
+```js
+import { ContentClient } from '../src/index.js';
+
+const env = {}; // Your env variables to connect to spacecat apis and google drive
+const onedriveclient = await ContentClient.createFromDomain('example.com', env, log);
+
 const results = await client.getPageMetadata('/path1');
 console.log(results);
 ```
@@ -38,9 +47,19 @@ console.log(results);
 ```js
 import { ContentClient } from '../src/index.js';
 
-const context = {}; // Your AWS Lambda context object
+const context = {}; // Your env variables to connect to spacecat apis and onedrive
 const onedriveclient = await ContentClient.createFrom(context, { url: 'ONEDRIVE_URL', type: 'onedrive' });
 
+const results = await client.getPageMetadata('/path1');
+console.log(results);
+```
+
+```js
+import { ContentClient } from '../src/index.js';
+
+const env = {}; // Your AWS Lambda context object
+const onedriveclient = await ContentClient.createFromDomain('example.com', env, log);
+
 const results = await client.getPageMetadata('/path1');
 console.log(results);
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-content-client",
-  "version": "1.1.22",
+  "version": "1.2.0",
   "description": "Shared modules of the Spacecat Services - Content Client",
   "type": "module",
   "engines": {
@@ -35,12 +35,12 @@
   },
   "dependencies": {
     "@adobe/helix-universal": "5.0.6",
+    "@adobe/spacecat-shared-data-access": "1.50.0",
     "@adobe/spacecat-helix-content-sdk": "1.2.7",
     "@adobe/spacecat-shared-utils": "1.22.4",
     "graph-data-structure": "4.1.0"
   },
   "devDependencies": {
-    "@adobe/spacecat-shared-data-access": "1.50.0",
     "chai": "5.1.2",
     "chai-as-promised": "8.0.0",
     "esmock": "2.6.9",

package/src/clients/content-client.js

@@ -11,8 +11,11 @@
  */
 
 import { createFrom as createContentSDKClient } from '@adobe/spacecat-helix-content-sdk';
-import { hasText, isObject } from '@adobe/spacecat-shared-utils';
+import {
+  composeBaseURL, hasText, isObject, tracingFetch,
+} from '@adobe/spacecat-shared-utils';
 import { Graph, hasCycle } from 'graph-data-structure';
+import { SiteDto } from '@adobe/spacecat-shared-data-access/src/dto/site.js';
 
 const CONTENT_SOURCE_TYPE_DRIVE_GOOGLE = 'drive.google';
 const CONTENT_SOURCE_TYPE_ONEDRIVE = 'onedrive';
@@ -193,6 +196,31 @@ export default class ContentClient {
     return new ContentClient(config, site, log);
   }
 
+  static async createFromDomain(domain, env, log = console) {
+    const baseUrl = composeBaseURL(domain);
+    const siteBaseUrlEncoded = Buffer.from(baseUrl).toString('base64');
+    let site;
+    const sitesApiEndpoint = `${env.SPACECAT_API_ENDPOINT}/sites/by-base-url`;
+    try {
+      const response = await tracingFetch(`${sitesApiEndpoint}/${siteBaseUrlEncoded}`, {
+        method: 'GET',
+        headers: {
+          'x-api-key': env.SPACECAT_API_KEY,
+          'Content-Type': 'application/json',
+        },
+      });
+      if (!response.ok) {
+        throw new Error(`Failed to fetch ${domain}`);
+      }
+      site = await response.json();
+      const siteDto = SiteDto.fromDynamoItem(site);
+      return ContentClient.createFrom({ log, env }, siteDto);
+    } catch (e) {
+      log.error(`Failed to fetch ${domain}: ${e.message}`);
+      throw new Error(`Failed to fetch ${domain}`);
+    }
+  }
+
   constructor(config, site, log) {
     validateSite(site);
     validateConfiguration(config, site.getHlxConfig()?.content.source?.type);

package/src/clients/index.d.ts

@@ -26,6 +26,18 @@ export class ContentClient {
    */
   static createFrom(context: UniversalContext, site: object): ContentClient;
 
+  /**
+   * Creates a new ContentClient instance from the given domain and environment.
+   *
+   * @param {string} domain The domain of the site to create the ContentClient for.
+   * @param {Object} env The environment object that contains the required configuration
+   * for the site's content source type.
+   * @returns {Promise<ContentClient>} A promise that resolves to the ContentClient instance.
+   * @throws {Error} If the domain is not a string or empty.
+   * @throws {Error} If the env is not an object or does not contain the required configuration.
+   */
+  static createFromDomain(domain: string, env: object,): Promise<ContentClient>;
+
   /**
    * Returns the metadata for the given page path. The document backing the path
    * is resolved and the metadata is extracted from it. The metadata is a Map where the entries