@adobe/spacecat-shared-data-access 3.45.2 → 3.47.0

package/src/models/sentiment-guideline/sentiment-guideline.schema.js

@@ -19,10 +19,6 @@ import SentimentGuideline from './sentiment-guideline.model.js';
 import SentimentGuidelineCollection from './sentiment-guideline.collection.js';
 
 /*
-Schema Doc: https://electrodb.dev/en/modeling/schema/
-Attribute Doc: https://electrodb.dev/en/modeling/attributes/
-Indexes Doc: https://electrodb.dev/en/modeling/indexes/
-
 Data Access Patterns:
 1. Get all guidelines for a site: allBySiteId(siteId)
 2. Get a specific guideline: findById(siteId, guidelineId)

package/src/models/sentiment-topic/sentiment-topic.schema.js

@@ -19,10 +19,6 @@ import SentimentTopic from './sentiment-topic.model.js';
 import SentimentTopicCollection from './sentiment-topic.collection.js';
 
 /*
-Schema Doc: https://electrodb.dev/en/modeling/schema/
-Attribute Doc: https://electrodb.dev/en/modeling/attributes/
-Indexes Doc: https://electrodb.dev/en/modeling/indexes/
-
 Data Access Patterns:
 1. Get all topics for a site: allBySiteId(siteId)
 2. Get a specific topic: findById(siteId, topicId)

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

@@ -44,6 +44,17 @@ export interface CodeConfig {
   s3StoragePath?: string;
 }
 
+export interface DeliveryConfig {
+  programId?: string;
+  environmentId?: string;
+  authorURL?: string;
+  siteId?: string;
+  tenantId?: string;
+  ipAllowlistExists?: boolean;
+  imsOrgId?: string;
+  [key: string]: unknown;
+}
+
 export type IMPORT_TYPES = {
   readonly ORGANIC_KEYWORDS: 'organic-keywords';
   readonly ORGANIC_TRAFFIC: 'organic-traffic';

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

@@ -25,12 +25,6 @@ import SchemaBuilder from '../base/schema.builder.js';
 import Site, { computeExternalIds } from './site.model.js';
 import SiteCollection from './site.collection.js';
 
-/*
-Schema Doc: https://electrodb.dev/en/modeling/schema/
-Attribute Doc: https://electrodb.dev/en/modeling/attributes/
-Indexes Doc: https://electrodb.dev/en/modeling/indexes/
- */
-
 const schema = new SchemaBuilder(Site, SiteCollection)
   // this will add an attribute 'organizationId' as well as an index 'byOrganizationId'
   .addReference('belongs_to', 'Organization')
@@ -120,6 +114,9 @@ const schema = new SchemaBuilder(Site, SiteCollection)
       environmentId: { type: 'string' },
       authorURL: { type: 'string', validate: (value) => isValidUrl(value) },
       siteId: { type: 'string' },
+      tenantId: { type: 'string' },
+      ipAllowlistExists: { type: 'boolean' },
+      imsOrgId: { type: 'string' },
     },
   })
   .addAttribute('hlxConfig', {

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

@@ -18,12 +18,6 @@ import SchemaBuilder from '../base/schema.builder.js';
 import SiteCandidate from './site-candidate.model.js';
 import SiteCandidateCollection from './site-candidate.collection.js';
 
-/*
-Schema Doc: https://electrodb.dev/en/modeling/schema/
-Attribute Doc: https://electrodb.dev/en/modeling/attributes/
-Indexes Doc: https://electrodb.dev/en/modeling/indexes/
- */
-
 const schema = new SchemaBuilder(SiteCandidate, SiteCandidateCollection)
   .addReference('belongs_to', 'Site')
   .addAttribute('siteId', {

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

@@ -14,12 +14,6 @@ import SchemaBuilder from '../base/schema.builder.js';
 import SiteEnrollment from './site-enrollment.model.js';
 import SiteEnrollmentCollection from './site-enrollment.collection.js';
 
-/*
-Schema Doc: https://electrodb.dev/en/modeling/schema/
-Attribute Doc: https://electrodb.dev/en/modeling/attributes/
-Indexes Doc: https://electrodb.dev/en/modeling/indexes/
- */
-
 const schema = new SchemaBuilder(SiteEnrollment, SiteEnrollmentCollection)
   // Reference to Site (many-to-one relationship)
   .addReference('belongs_to', 'Site')

package/src/models/site-top-form/site-top-form.schema.js

@@ -23,12 +23,6 @@ import SchemaBuilder from '../base/schema.builder.js';
 import SiteTopForm from './site-top-form.model.js';
 import SiteTopFormCollection from './site-top-form.collection.js';
 
-/*
-Schema Doc: https://electrodb.dev/en/modeling/schema/
-Attribute Doc: https://electrodb.dev/en/modeling/attributes/
-Indexes Doc: https://electrodb.dev/en/modeling/indexes/
- */
-
 const schema = new SchemaBuilder(SiteTopForm, SiteTopFormCollection)
   .addReference('belongs_to', 'Site', ['source', 'traffic'])
   .addAttribute('siteId', {

package/src/models/site-top-page/site-top-page.schema.js

@@ -23,12 +23,6 @@ import SchemaBuilder from '../base/schema.builder.js';
 import SiteTopPage from './site-top-page.model.js';
 import SiteTopPageCollection from './site-top-page.collection.js';
 
-/*
-Schema Doc: https://electrodb.dev/en/modeling/schema/
-Attribute Doc: https://electrodb.dev/en/modeling/attributes/
-Indexes Doc: https://electrodb.dev/en/modeling/indexes/
- */
-
 const schema = new SchemaBuilder(SiteTopPage, SiteTopPageCollection)
   .addReference('belongs_to', 'Site', ['source', 'geo', 'traffic'])
   .addAttribute('siteId', {

package/src/models/suggestion/suggestion.schema.js

@@ -18,12 +18,6 @@ import SchemaBuilder from '../base/schema.builder.js';
 import Suggestion from './suggestion.model.js';
 import SuggestionCollection from './suggestion.collection.js';
 
-/*
-Schema Doc: https://electrodb.dev/en/modeling/schema/
-Attribute Doc: https://electrodb.dev/en/modeling/attributes/
-Indexes Doc: https://electrodb.dev/en/modeling/indexes/
- */
-
 const schema = new SchemaBuilder(Suggestion, SuggestionCollection)
   .addReference('belongs_to', 'Opportunity', ['status', 'rank'])
   .addReference('has_many', 'FixEntitySuggestion', ['updatedAt'], { removeDependents: true })

package/src/models/trial-user/trial-user.schema.js

@@ -15,12 +15,6 @@ import SchemaBuilder from '../base/schema.builder.js';
 import TrialUser from './trial-user.model.js';
 import TrialUserCollection from './trial-user.collection.js';
 
-/*
-Schema Doc: https://electrodb.dev/en/modeling/schema/
-Attribute Doc: https://electrodb.dev/en/modeling/attributes/
-Indexes Doc: https://electrodb.dev/en/modeling/indexes/
-*/
-
 const schema = new SchemaBuilder(TrialUser, TrialUserCollection)
   // Reference to Organization (many-to-one relationship)
   .addReference('belongs_to', 'Organization')

package/src/models/trial-user-activity/trial-user-activity.schema.js

@@ -15,12 +15,6 @@ import TrialUserActivity from './trial-user-activity.model.js';
 import TrialUserActivityCollection from './trial-user-activity.collection.js';
 import Entitlement from '../entitlement/entitlement.model.js';
 
-/*
-Schema Doc: https://electrodb.dev/en/modeling/schema/
-Attribute Doc: https://electrodb.dev/en/modeling/attributes/
-Indexes Doc: https://electrodb.dev/en/modeling/indexes/
-*/
-
 const schema = new SchemaBuilder(TrialUserActivity, TrialUserActivityCollection)
   .addReference('belongs_to', 'TrialUser')
   // Reference to Organization (many-to-one relationship)

package/migration.sh

@@ -1,137 +0,0 @@
-#!/bin/bash
-
-# Define AWS CLI command with local DynamoDB endpoint
-AWS_CMD="aws dynamodb --endpoint-url http://localhost:8000"
-REGION="us-west-2"
-
-# Define table names
-SITE_TABLE="spacecat-services-sites"
-ORGANIZATION_TABLE="spacecat-services-organizations"
-
-# Fetch all sites
-SITES=$($AWS_CMD scan --table-name $SITE_TABLE)
-ORGANIZATIONS=$($AWS_CMD scan --table-name $ORGANIZATION_TABLE)
-
-# Migrate each site
-echo "$SITES" | jq -c '.Items[]' | while read -r site; do
-    SITE_ID=$(echo $site | jq -r '.id.S')
-    BASE_URL=$(echo $site | jq -r '.baseURL.S')
-    DELIVERY_TYPE=$(echo $site | jq -r '.deliveryType.S')
-    GITHUB_URL=$(echo $site | jq -r '.gitHubURL.S')
-    ORG_ID=$(echo $site | jq -r '.organizationId.S')
-    IS_LIVE=$(echo $site | jq -r '.isLive.BOOL // false')
-    IS_LIVE_TOGGLED_AT=$(echo $site | jq -r '.isLiveToggledAt.S // empty')
-    GSI1PK=$(echo $site | jq -r '.GSI1PK.S')
-    CREATED_AT=$(echo $site | jq -r '.createdAt.S')
-    UPDATED_AT=$(echo $site | jq -r '.updatedAt.S')
-    SLACK=$(echo $site | jq -r '.config.M.slack // {"M": {}}')
-    IMPORTS=$(echo $site | jq -r '.config.M.imports // {"L": []}')
-    HLX_CONFIG=$(echo $site | jq -r '.hlxConfig // {"M": {}}')
-
-    # Check for 404 and broken-backlinks mentions
-    ALERTS=$(echo $site | jq -c '.config.M.alerts.L')
-    MENTIONS_404_SLACK='{"L":[]}'
-    MENTIONS_BROKEN_BACKLINKS_SLACK='{"L":[]}'
-    for alert in $(echo "$ALERTS" | jq -c '.[]'); do
-        ALERT_TYPE=$(echo $alert | jq -r '.M.type.S // empty')
-        if [ "$ALERT_TYPE" == "404" ]; then
-            MENTIONS_404_SLACK=$(echo $alert | jq -r '.M.mentions.L[0].M.slack // {"L":[]}')
-        elif [ "$ALERT_TYPE" == "broken-backlinks" ]; then
-            MENTIONS_BROKEN_BACKLINKS_SLACK=$(echo $alert | jq -r '.M.mentions.L[0].M.slack // {"L":[]}')
-        fi
-    done
-
-    # Get excluded URLs
-    EXCLUDED_URLS=$(echo $site | jq -c '.auditConfig.M.auditTypeConfigs.M["broken-backlinks"].M.excludedURLs // {"L" :[]} ')
-    MANUAL_OVERWRITES=$(echo $site | jq -c '.auditConfig.M.auditTypeConfigs.M["broken-backlinks"].M.manualOverwrites // {"L" :[]} ')
-    FIXED_URLS=$(echo $site | jq -c '.auditConfig.M.auditTypeConfigs.M["broken-backlinks"].M.fixedURLs // {"L" :[]} ')
-    MIGRATED_SITE=$(cat <<EOF
-{
-    "id": {"S": "$SITE_ID"},
-    "baseURL": {"S": "$BASE_URL"},
-    "deliveryType": {"S": "$DELIVERY_TYPE"},
-    "gitHubURL": {"S": "$GITHUB_URL"},
-    "organizationId": {"S": "$ORG_ID"},
-    "isLive": {"BOOL": $IS_LIVE},
-    "isLiveToggledAt": {"S": "$IS_LIVE_TOGGLED_AT"},
-    "GSI1PK": {"S": "$GSI1PK"},
-    "createdAt": {"S": "$CREATED_AT"},
-    "updatedAt": {"S": "$UPDATED_AT"},
-    "hlxConfig": $HLX_CONFIG,
-    "config": {
-        "M": {
-            "slack": $SLACK,
-            "imports": $IMPORTS,
-            "handlers": {
-                "M": {
-                    "404": {"M": {"mentions": {"M": {"slack": $MENTIONS_404_SLACK}}}},
-                    "broken-backlinks": {"M": {"mentions": {"M": {"slack": $MENTIONS_BROKEN_BACKLINKS_SLACK}}, "excludedURLs": $EXCLUDED_URLS, "manualOverwrites": $MANUAL_OVERWRITES, "fixedURLs": $FIXED_URLS}}
-                }
-              }
-          }
-    }
-}
-EOF
-)
-
-    # Insert migrated site data into the site table
-    $AWS_CMD put-item --table-name $SITE_TABLE --item "$MIGRATED_SITE"
-done
-
-# Migrate each organization
-echo "$ORGANIZATIONS" | jq -c '.Items[]' | while read -r org; do
-    ORG_ID=$(echo $org | jq -r '.id.S')
-    IMS_ORG_ID=$(echo $org | jq -r '.imsOrgId.S')
-    NAME=$(echo $org | jq -r '.name.S')
-    GSI1PK=$(echo $org | jq -r '.GSI1PK.S')
-    CREATED_AT=$(echo $org | jq -r '.createdAt.S')
-    UPDATED_AT=$(echo $org | jq -r '.updatedAt.S')
-    FULLFILLABLE_ITEMS=$(echo $org | jq -r '.fulfillableItems // {"M": {}}')
-    SLACK=$(echo $org | jq -r '.config.M.slack // {"M": {}}')
-    IMPORTS=$(echo $org | jq -r '.config.M.imports // {"L": []}')
-
-    # Check for 404 and broken-backlinks mentions
-    ALERTS=$(echo $org | jq -c '.config.M.alerts.L')
-    MENTIONS_404_SLACK='{"L":[]}'
-    MENTIONS_BROKEN_BACKLINKS_SLACK='{"L":[]}'
-    for alert in $(echo "$ALERTS" | jq -c '.[]'); do
-        ALERT_TYPE=$(echo $alert | jq -r '.M.type.S // empty')
-        if [ "$ALERT_TYPE" == "404" ]; then
-            MENTIONS_404_SLACK=$(echo $alert | jq -r '.M.mentions.L[0].M.slack // {"L":[]}')
-        elif [ "$ALERT_TYPE" == "broken-backlinks" ]; then
-            MENTIONS_BROKEN_BACKLINKS_SLACK=$(echo $alert | jq -r '.M.mentions.L[0].M.slack // {"L":[]}')
-        fi
-    done
-
-
-
-    MIGRATED_ORG=$(cat <<EOF
-{
-    "id": {"S": "$ORG_ID"},
-    "imsOrgId": {"S": "$IMS_ORG_ID"},
-    "name": {"S": "$NAME"},
-    "GSI1PK": {"S": "$GSI1PK"},
-    "createdAt": {"S": "$CREATED_AT"},
-    "updatedAt": {"S": "$UPDATED_AT"},
-    "fulfillableItems": $FULLFILLABLE_ITEMS,
-    "config": {
-        "M": {
-          "slack": $SLACK,
-          "imports": $IMPORTS,
-          "handlers": {
-              "M": {
-                  "404": {"M": {"mentions": {"M": {"slack": $MENTIONS_404_SLACK}}}},
-                  "broken-backlinks": {"M": {"mentions": {"M": {"slack": $MENTIONS_BROKEN_BACKLINKS_SLACK}}}}
-              }
-        }
-    }
-}
-}
-EOF
-)
-
-    # Insert migrated organization data into the organization table
-    $AWS_CMD put-item --table-name $ORGANIZATION_TABLE --item "$MIGRATED_ORG"
-done
-
-echo "Migration completed successfully."