@adobe/spacecat-shared-data-access 2.30.1 → 2.31.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [@adobe/spacecat-shared-data-access-v2.31.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v2.30.1...@adobe/spacecat-shared-data-access-v2.31.0) (2025-06-27)
+
+
+### Features
+
+* introduce authoring type ([#826](https://github.com/adobe/spacecat-shared/issues/826)) ([36202ec](https://github.com/adobe/spacecat-shared/commit/36202ec19be415043ae333b2a3428d69595d920b))
+
 # [@adobe/spacecat-shared-data-access-v2.30.1](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v2.30.0...@adobe/spacecat-shared-data-access-v2.30.1) (2025-06-26)
 
 

package/package.json

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

package/src/models/site/index.d.ts

@@ -126,6 +126,7 @@ export interface Site extends BaseModel {
   getName(): string;
   getConfig(): SiteConfig;
   getDeliveryType(): string;
+  getAuthoringType(): string;
   getExperiments(): Promise<Experiment[]>;
   getExperimentsByExpId(expId: string): Promise<Experiment[]>;
   getExperimentsByExpIdAndUrl(expId: string, url: string): Promise<Experiment[]>;
@@ -158,6 +159,7 @@ export interface Site extends BaseModel {
   setName(name: string): Site;
   setConfig(config: object): Site;
   setDeliveryType(deliveryType: string): Site;
+  setAuthoringType(authoringType: string): Site;
   setGitHubURL(gitHubURL: string): Site;
   setHlxConfig(hlxConfig: HlxConfig): Site;
   setDeliveryConfig(deliveryConfig: object): Site;

package/src/models/site/site.collection.js

@@ -15,7 +15,7 @@ import { hasText, isValidHelixPreviewUrl, isValidUrl } from '@adobe/spacecat-sha
 import DataAccessError from '../../errors/data-access.error.js';
 import BaseCollection from '../base/base.collection.js';
 
-import Site, { AEM_CS_HOST, getPreviewType } from './site.model.js';
+import Site, { AEM_CS_HOST, getAuthoringType } from './site.model.js';
 
 /**
  * SiteCollection - A collection class responsible for managing Site entities.
@@ -78,10 +78,12 @@ class SiteCollection extends BaseCollection {
     }
 
     const { hostname } = new URL(previewURL);
-    const previewType = getPreviewType(hostname, Site.DELIVERY_TYPES);
+    const previewType = getAuthoringType(hostname, Site.AUTHORING_TYPES);
 
     switch (previewType) {
-      case Site.DELIVERY_TYPES.AEM_EDGE: {
+      case Site.AUTHORING_TYPES.SP:
+      case Site.AUTHORING_TYPES.GD:
+      case Site.AUTHORING_TYPES.DA: {
         if (!isValidHelixPreviewUrl(previewURL)) {
           throw new DataAccessError(`Invalid Helix preview URL: ${previewURL}`, this);
         }
@@ -90,7 +92,8 @@ class SiteCollection extends BaseCollection {
         const externalOwnerId = `${ref}#${owner}`;
         return this.findByExternalOwnerIdAndExternalSiteId(externalOwnerId, site);
       }
-      case Site.DELIVERY_TYPES.AEM_CS: {
+      case Site.AUTHORING_TYPES.CS_CW:
+      case Site.AUTHORING_TYPES.CS: {
         const [, programId, envId] = AEM_CS_HOST.exec(hostname);
         const externalOwnerId = `p${programId}`;
         const externalSiteId = `e${envId}`;

package/src/models/site/site.model.js

@@ -19,10 +19,10 @@ export const AEM_CS_HOST = /^author-p(\d+)-e(\d+)/i;
 /**
  * Computes external IDs based on delivery type and configuration
  */
-export const computeExternalIds = (attrs) => {
-  const { hlxConfig, deliveryConfig } = attrs;
+export const computeExternalIds = (attrs, authoringTypes) => {
+  const { authoringType, hlxConfig, deliveryConfig } = attrs;
 
-  if (hlxConfig) {
+  if (hlxConfig && (authoringType === authoringTypes.DA)) {
     const rso = hlxConfig.rso ?? {};
     const { ref, owner, site } = rso;
 
@@ -32,7 +32,8 @@ export const computeExternalIds = (attrs) => {
     };
   }
 
-  if (deliveryConfig) {
+  if (deliveryConfig
+    && (authoringType === authoringTypes.CS || authoringType === authoringTypes.CW)) {
     const { programId, environmentId } = deliveryConfig;
 
     return {
@@ -45,14 +46,14 @@ export const computeExternalIds = (attrs) => {
 };
 
 /**
- * Determines the preview type based on hostname
+ * Determines the authoring type based on hostname
  */
-export const getPreviewType = (hostname, deliveryTypes) => {
+export const getAuthoringType = (hostname, authoringTypes) => {
   if (HLX_HOST.test(hostname)) {
-    return deliveryTypes.AEM_EDGE;
+    return authoringTypes.DA;
   }
   if (AEM_CS_HOST.test(hostname)) {
-    return deliveryTypes.AEM_CS;
+    return authoringTypes.CS;
   }
   return null;
 };
@@ -72,6 +73,14 @@ class Site extends BaseModel {
 
   static DEFAULT_DELIVERY_TYPE = Site.DELIVERY_TYPES.AEM_EDGE;
 
+  static AUTHORING_TYPES = {
+    CS_CW: 'cs/crosswalk',
+    CS: 'cs',
+    SP: 'sharepoint',
+    GD: 'googledocs',
+    DA: 'documentauthoring',
+  };
+
   async toggleLive() {
     const newIsLive = !this.getIsLive();
     this.setIsLive(newIsLive);

package/src/models/site/site.schema.js

@@ -63,6 +63,10 @@ const schema = new SchemaBuilder(Site, SiteCollection)
     default: Site.DEFAULT_DELIVERY_TYPE,
     required: true,
   })
+  .addAttribute('authoringType', {
+    type: Object.values(Site.AUTHORING_TYPES),
+    required: false,
+  })
   .addAttribute('gitHubURL', {
     type: 'string',
     validate: (value) => !value || isValidUrl(value),
@@ -98,15 +102,15 @@ const schema = new SchemaBuilder(Site, SiteCollection)
     type: 'string',
     hidden: true,
     readOnly: true,
-    watch: ['hlxConfig', 'deliveryConfig'],
-    set: (_, attrs) => computeExternalIds(attrs).externalOwnerId,
+    watch: ['authoringType', 'hlxConfig', 'deliveryConfig'],
+    set: (_, attrs) => computeExternalIds(attrs, Site.AUTHORING_TYPES).externalOwnerId,
   })
   .addAttribute('externalSiteId', {
     type: 'string',
     hidden: true,
     readOnly: true,
-    watch: ['hlxConfig', 'deliveryConfig'],
-    set: (_, attrs) => computeExternalIds(attrs).externalSiteId,
+    watch: ['authoringType', 'hlxConfig', 'deliveryConfig'],
+    set: (_, attrs) => computeExternalIds(attrs, Site.AUTHORING_TYPES).externalSiteId,
   })
   .addAllIndex(['baseURL'])
   .addIndex(