configuration-management 0.1.3 → 0.1.6

package/scripts/setup.js

@@ -0,0 +1,260 @@
+#!/usr/bin/env node
+/*
+Copyright 2025 Adobe. All rights reserved.
+Licensed under the Apache License, Version 2.0
+*/
+
+const fs = require('fs')
+const path = require('path')
+
+const EXTENSION_POINT = 'commerce/backend-ui/1'
+const INCLUDE_REL = 'node_modules/configuration-management/actions/configurations/ext.config.yaml'
+const MARKER = '# configuration-management (auto-linked on npm install)'
+const WEB_BOOTSTRAP_MARKER = 'configuration-management: auto-generated bootstrap'
+
+const TEMPLATES_DIR = path.join(__dirname, 'templates')
+
+function escapeRe (str) {
+  return str.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')
+}
+
+function findProjectRoot (startDir) {
+  let dir = startDir
+  while (dir && dir !== path.dirname(dir)) {
+    if (
+      fs.existsSync(path.join(dir, 'app.config.yaml')) ||
+      fs.existsSync(path.join(dir, 'web-src'))
+    ) {
+      return dir
+    }
+    dir = path.dirname(dir)
+  }
+  return null
+}
+
+function resolveProjectRoot () {
+  const initCwd = process.env.INIT_CWD
+  if (initCwd) {
+    const fromInit = findProjectRoot(initCwd)
+    if (fromInit) return fromInit
+  }
+  return findProjectRoot(process.cwd())
+}
+
+function readTemplate (name) {
+  return fs.readFileSync(path.join(TEMPLATES_DIR, name), 'utf8')
+}
+
+function writeIfMissingOrManaged (filePath, content, marker) {
+  if (fs.existsSync(filePath)) {
+    const existing = fs.readFileSync(filePath, 'utf8')
+    if (existing.includes(marker)) {
+      const dir = path.dirname(filePath)
+      fs.mkdirSync(dir, { recursive: true })
+      const changed = existing !== content
+      if (changed) {
+        fs.writeFileSync(filePath, content, 'utf8')
+      }
+      return { changed, reason: changed ? 'updated-managed' : 'unchanged-managed', path: filePath }
+    }
+    return { changed: false, reason: 'skipped-custom-file', path: filePath }
+  }
+  const dir = path.dirname(filePath)
+  fs.mkdirSync(dir, { recursive: true })
+  fs.writeFileSync(filePath, content, 'utf8')
+  return { changed: true, reason: 'written', path: filePath }
+}
+
+function writeWebSrcIndex (projectRoot) {
+  const filePath = path.join(projectRoot, 'web-src', 'src', 'index.js')
+  const content = readTemplate('web-src-index.js')
+
+  if (!fs.existsSync(filePath)) {
+    fs.mkdirSync(path.dirname(filePath), { recursive: true })
+    fs.writeFileSync(filePath, content, 'utf8')
+    return { changed: true, reason: 'written', path: filePath }
+  }
+
+  const existing = fs.readFileSync(filePath, 'utf8')
+  if (existing.includes(WEB_BOOTSTRAP_MARKER)) {
+    const changed = existing !== content
+    if (changed) {
+      fs.writeFileSync(filePath, content, 'utf8')
+    }
+    return { changed, reason: changed ? 'updated-managed' : 'unchanged-managed', path: filePath }
+  }
+
+  if (existing.includes('configuration-management/web')) {
+    fs.writeFileSync(filePath, content, 'utf8')
+    return { changed: true, reason: 'migrated-stale-bootstrap', path: filePath }
+  }
+
+  return { changed: false, reason: 'skipped-custom-file', path: filePath }
+}
+
+function alreadyLinked (content) {
+  return content.includes('configuration-management/actions/configurations/ext.config.yaml')
+}
+
+function hasExtensionPoint (content) {
+  return /^[ \t]*commerce\/backend-ui\/1:/m.test(content)
+}
+
+function buildExtensionBlock () {
+  return [
+    MARKER,
+    'extensions:',
+    `  ${EXTENSION_POINT}:`,
+    `    $include: ${INCLUDE_REL}`
+  ].join('\n')
+}
+
+function updateExistingExtensionBlock (content) {
+  const match = content.match(/^([ \t]*)commerce\/backend-ui\/1:/m)
+  if (!match) return null
+
+  const indent = match[1]
+  const includeIndent = `${indent}  `
+  const blockRe = new RegExp(
+    `^${escapeRe(indent)}commerce/backend-ui/1:[ \\t]*\\n` +
+      `(?:${escapeRe(includeIndent)}\\$include:[^\\n]*\\n)?`,
+    'm'
+  )
+  const replacement =
+    `${indent}${EXTENSION_POINT}:\n${includeIndent}$include: ${INCLUDE_REL}\n`
+  const next = content.replace(blockRe, replacement)
+  return next !== content ? next : null
+}
+
+function patchAppConfig (content) {
+  if (alreadyLinked(content)) {
+    return { content, changed: false, reason: 'already-linked' }
+  }
+
+  if (hasExtensionPoint(content)) {
+    const updated = updateExistingExtensionBlock(content)
+    if (updated) {
+      return { content: updated, changed: true, reason: 'updated-existing-extension' }
+    }
+    return { content, changed: false, reason: 'extension-exists-unmodified' }
+  }
+
+  if (/^extensions:[ \t]*\n/m.test(content)) {
+    const injection = `  ${EXTENSION_POINT}:\n    $include: ${INCLUDE_REL}\n`
+    const next = content.replace(/^extensions:[ \t]*\n/m, `extensions:\n${injection}`)
+    if (next !== content) {
+      return { content: next, changed: true, reason: 'added-under-extensions' }
+    }
+  }
+
+  if (!/^extensions:/m.test(content)) {
+    const trimmed = content.replace(/\s+$/, '')
+    const separator = trimmed.length > 0 ? '\n\n' : ''
+    return {
+      content: `${trimmed}${separator}${buildExtensionBlock()}\n`,
+      changed: true,
+      reason: 'appended'
+    }
+  }
+
+  return { content, changed: false, reason: 'no-change' }
+}
+
+function setupAppConfig (projectRoot) {
+  const appConfigPath = path.join(projectRoot, 'app.config.yaml')
+  if (!fs.existsSync(appConfigPath)) {
+    return { changed: false, reason: 'no-app-config' }
+  }
+
+  const original = fs.readFileSync(appConfigPath, 'utf8')
+  const { content, changed, reason } = patchAppConfig(original)
+  if (!changed) {
+    return { changed: false, reason }
+  }
+
+  fs.writeFileSync(appConfigPath, content, 'utf8')
+  return { changed: true, reason, detail: INCLUDE_REL }
+}
+
+function setupWebSrc (projectRoot) {
+  const webSrcDir = path.join(projectRoot, 'web-src')
+  const results = []
+
+  const indexJs = writeWebSrcIndex(projectRoot)
+  results.push(indexJs)
+
+  const indexHtml = writeIfMissingOrManaged(
+    path.join(webSrcDir, 'index.html'),
+    readTemplate('web-src-index.html'),
+    'configuration-management'
+  )
+  results.push(indexHtml)
+
+  const excRuntime = writeIfMissingOrManaged(
+    path.join(webSrcDir, 'src', 'exc-runtime.js'),
+    readTemplate('exc-runtime.js'),
+    'Module Runtime: Needs to be within an iframe'
+  )
+  results.push(excRuntime)
+
+  const configPath = path.join(webSrcDir, 'src', 'config.json')
+  if (!fs.existsSync(configPath)) {
+    fs.mkdirSync(path.dirname(configPath), { recursive: true })
+    fs.writeFileSync(configPath, '{}\n', 'utf8')
+    results.push({ changed: true, reason: 'created-config-json', path: configPath })
+  }
+
+  const changed = results.some((r) => r.changed)
+  return { changed, results }
+}
+
+function main () {
+  if (process.env.CONFIGURATION_MANAGEMENT_SKIP_SETUP === '1') {
+    return
+  }
+
+  const projectRoot = resolveProjectRoot()
+  if (!projectRoot) {
+    console.log(
+      '[configuration-management] No App Builder project found — skip setup. ' +
+        'Run `npx configuration-management-setup` from your project root after `aio app init`.'
+    )
+    return
+  }
+
+  const app = setupAppConfig(projectRoot)
+  if (app.changed) {
+    console.log(
+      `[configuration-management] Updated app.config.yaml (${app.reason}):\n` +
+        `  $include: ${app.detail}`
+    )
+  }
+
+  const web = setupWebSrc(projectRoot)
+  for (const r of web.results || []) {
+    if (r.changed) {
+      console.log(`[configuration-management] Wrote ${r.path}`)
+    }
+  }
+
+  if (!app.changed && !web.changed) {
+    console.log('[configuration-management] Project already configured.')
+  }
+}
+
+if (require.main === module) {
+  try {
+    main()
+  } catch (err) {
+    console.error('[configuration-management] setup failed:', err.message)
+    process.exitCode = 1
+  }
+}
+
+module.exports = {
+  patchAppConfig,
+  setupAppConfig,
+  setupWebSrc,
+  INCLUDE_REL,
+  EXTENSION_POINT
+}

package/scripts/templates/exc-runtime.js

@@ -0,0 +1,14 @@
+/*
+Copyright 2025 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+
+/* eslint-disable-next-line */
+(function(e,t){if(t.location===t.parent.location)throw new Error("Module Runtime: Needs to be within an iframe!");var o=function(e){var t=new URL(e.location.href).searchParams.get("_mr");return t||!e.EXC_US_HMR?t:e.sessionStorage.getItem("unifiedShellMRScript")}(t);if(!o)throw new Error("Module Runtime: Missing script!");if("https:"!==(o=new URL(decodeURIComponent(o))).protocol)throw new Error("Module Runtime: Must be HTTPS!");if(!/^(exc-unifiedcontent\.)?experience(-qa|-stage|-cdn|-cdn-stage)?\.adobe\.(com|net)$/.test(o.hostname)&&!/localhost\.corp\.adobe\.com$/.test(o.hostname))throw new Error("Module Runtime: Invalid domain!");if(!/\.js$/.test(o.pathname))throw new Error("Module Runtime: Must be a JavaScript file!");t.EXC_US_HMR&&t.sessionStorage.setItem("unifiedShellMRScript",o.toString());var n=e.createElement("script");n.async=1,n.src=o.toString(),n.onload=n.onreadystatechange=function(){n.readyState&&!/loaded|complete/.test(n.readyState)||(n.onload=n.onreadystatechange=null,n=void 0,"EXC_MR_READY"in t&&t.EXC_MR_READY())},e.head.appendChild(n)})(document,window);

package/scripts/templates/web-src-index.html

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0, shrink-to-fit=no">
+  <meta name="theme-color" content="#1473e6">
+  <meta http-equiv="X-UA-Compatible" content="ie=edge">
+  <link rel="icon" type="image/svg+xml" href="./favicon.svg">
+  <title>Sync Management</title>
+</head>
+<body>
+<noscript>You need to enable JavaScript to run this app.</noscript>
+<div id="root"></div>
+<script src="./src/index.js" async="true" type="module"></script>
+</body>
+</html>

package/scripts/templates/web-src-index.js

@@ -0,0 +1,61 @@
+/*
+Copyright 2025 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+*/
+// configuration-management: auto-generated bootstrap (updated on npm install)
+
+import 'core-js/stable'
+import 'regenerator-runtime/runtime'
+
+import React from 'react'
+import { createRoot } from 'react-dom/client'
+
+import Runtime, { init } from '@adobe/exc-app'
+import { ConfigurationManagementApp as App, configureWeb } from 'configuration-management/web'
+import actions from './config.json'
+import 'configuration-management/web/styles.css'
+
+configureWeb({ actionUrls: actions })
+
+window.React = React
+
+try {
+  require('./exc-runtime')
+  init(bootstrapInExcShell)
+} catch (e) {
+  console.log('application not running in Adobe Experience Cloud Shell')
+  bootstrapRaw()
+}
+
+function renderApp (runtime, ims) {
+  createRoot(document.getElementById('root')).render(
+    React.createElement(App, { runtime, ims })
+  )
+}
+
+function bootstrapRaw () {
+  renderApp({ on: () => {} }, {})
+}
+
+function bootstrapInExcShell () {
+  const runtime = Runtime()
+  runtime.favicon = './favicon.svg'
+
+  runtime.on('ready', ({ imsOrg, imsToken, imsProfile }) => {
+    runtime.done()
+    renderApp(runtime, {
+      profile: imsProfile,
+      org: imsOrg,
+      token: imsToken
+    })
+  })
+
+  runtime.solution = {
+    icon: 'AdobeExperienceCloud',
+    title: 'Sync Management',
+    shortTitle: 'Sync'
+  }
+  runtime.title = 'Sync Management'
+}

package/src/abdb-config.js

@@ -0,0 +1,241 @@
+/*
+Copyright 2025 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+*/
+
+const { getCommerceOauthClient } = require('./oauth1a')
+const {
+  isValidPath,
+  toStateKey,
+  buildInheritanceChain,
+  normalizeScope,
+  normalizeScopeId
+} = require('./system-config-shared')
+const { getClient } = require('./abdb-helper')
+const { isEncrypted, decrypt } = require('./system-config-crypto')
+
+const COLLECTION = 'system_config_data'
+const CACHE_TTL_MS = 5 * 60 * 1000
+
+// Per-lookup result cache.
+const cache = new Map() // key: `${scope}:${scopeId}:${path}` → { value, expiresAt }
+
+// Commerce code → numeric id maps. Refreshed at most every CACHE_TTL_MS.
+let websiteCodeToId = null     // Map<code, id>
+let websiteCodeToIdAt = 0
+let storeCodeToId = null       // Map<code, id> + parentWebsiteId
+let storeCodeToIdAt = 0
+
+function maybeParseJson (value) {
+  if (typeof value !== 'string') return value
+  const trimmed = value.trim()
+  if (!trimmed) return value
+  if (!(trimmed.startsWith('{') || trimmed.startsWith('['))) return value
+  try { return JSON.parse(trimmed) } catch { return value }
+}
+
+async function tryFindOne (collection, query) {
+  try {
+    const arr = await collection.find(query).limit(1).toArray()
+    return arr && arr.length ? arr[0] : null
+  } catch (err) {
+    const msg = err && err.message ? String(err.message) : String(err)
+    if (/not found/i.test(msg)) return null
+    throw err
+  }
+}
+
+function pickCommerceCreds (params) {
+  return {
+    url: params.COMMERCE_BASE_URL || process.env.COMMERCE_BASE_URL,
+    consumerKey: params.COMMERCE_CONSUMER_KEY || process.env.COMMERCE_CONSUMER_KEY,
+    consumerSecret: params.COMMERCE_CONSUMER_SECRET || process.env.COMMERCE_CONSUMER_SECRET,
+    accessToken: params.COMMERCE_ACCESS_TOKEN || process.env.COMMERCE_ACCESS_TOKEN,
+    accessTokenSecret: params.COMMERCE_ACCESS_TOKEN_SECRET || process.env.COMMERCE_ACCESS_TOKEN_SECRET
+  }
+}
+
+async function loadWebsiteCodeMap (params) {
+  const now = Date.now()
+  if (websiteCodeToId && (now - websiteCodeToIdAt) < CACHE_TTL_MS) return websiteCodeToId
+
+  const creds = pickCommerceCreds(params)
+  if (!creds.url) return websiteCodeToId || new Map()
+
+  try {
+    const oauth = getCommerceOauthClient(creds, { error: () => {}, info: () => {} })
+    const websites = await oauth.get('store/websites')
+    const map = new Map()
+    if (Array.isArray(websites)) {
+      for (const w of websites) {
+        if (w && w.code != null && w.id != null) {
+          map.set(String(w.code), String(w.id))
+        }
+      }
+    }
+    websiteCodeToId = map
+    websiteCodeToIdAt = now
+    return map
+  } catch (_) {
+    return websiteCodeToId || new Map()
+  }
+}
+
+async function loadStoreViewCodeMap (params) {
+  const now = Date.now()
+  if (storeCodeToId && (now - storeCodeToIdAt) < CACHE_TTL_MS) return storeCodeToId
+
+  const creds = pickCommerceCreds(params)
+  if (!creds.url) return storeCodeToId || new Map()
+
+  try {
+    const oauth = getCommerceOauthClient(creds, { error: () => {}, info: () => {} })
+    const stores = await oauth.get('store/storeViews')
+    const map = new Map()
+    if (Array.isArray(stores)) {
+      for (const s of stores) {
+        if (s && s.code != null && s.id != null) {
+          map.set(String(s.code), { id: String(s.id), websiteId: s.website_id != null ? String(s.website_id) : null })
+        }
+      }
+    }
+    storeCodeToId = map
+    storeCodeToIdAt = now
+    return map
+  } catch (_) {
+    return storeCodeToId || new Map()
+  }
+}
+
+/**
+ * Resolve a scope code (e.g. website 'ch', store view 'en_ch') to its numeric
+ * id via Commerce REST. Returns null when the code can't be resolved AND no
+ * verbatim fallback is wanted.
+ */
+async function resolveScopeId (scope, code, params) {
+  if (!code) return null
+  if (scope === 'websites') {
+    const map = await loadWebsiteCodeMap(params)
+    return map.get(String(code)) || null
+  }
+  if (scope === 'stores') {
+    const map = await loadStoreViewCodeMap(params)
+    return map.get(String(code))?.id || null
+  }
+  return null
+}
+
+/**
+ * Look up a single config value from ABDB.
+ *
+ * @param {string} path     `<section>/<group>/<field>` (e.g. 'campaign_general/url/url')
+ * @param {object} [params] action params containing OAuth + crypto + Commerce creds.
+ *                          Falls back to process.env when omitted.
+ * @param {object} [options]
+ * @param {string} [options.scope='default']        'default' | 'websites' | 'stores'
+ * @param {string} [options.scopeId]                website / store id (numeric string); takes precedence over scopeCode
+ * @param {string} [options.scopeCode]              website / store-view CODE — resolved to numeric id via Commerce REST
+ * @param {string|number} [options.parentWebsiteId] used when scope='stores' to fall back to the parent website
+ * @param {string} [options.parentWebsiteCode]      same as parentWebsiteId but resolved from a website code
+ * @param {boolean} [options.fresh]                 bypass the cache
+ * @returns {Promise<*|null>}
+ */
+async function getConfig (path, params = {}, options = {}) {
+  if (!isValidPath(path)) return null
+
+  let scope
+  try {
+    scope = normalizeScope(options.scope)
+  } catch (_) {
+    return null
+  }
+
+  // 1. Resolve the active scope id (numeric).
+  let resolvedScopeId
+  if (scope === 'default') {
+    resolvedScopeId = '0'
+  } else if (options.scopeId != null && options.scopeId !== '') {
+    resolvedScopeId = String(options.scopeId)
+  } else if (options.scopeCode) {
+    const fromCommerce = await resolveScopeId(scope, options.scopeCode, params)
+    // If Commerce isn't reachable, fall back to using the code verbatim — the
+    // value still gets queried, and the legacy `getSystemConfig` shim writes
+    // under the literal code so this keeps working.
+    resolvedScopeId = fromCommerce || String(options.scopeCode)
+  } else {
+    return null
+  }
+
+  // 2. Resolve the parent website id for store-scope inheritance.
+  let parentWebsiteId = options.parentWebsiteId
+  if (parentWebsiteId == null && options.parentWebsiteCode) {
+    parentWebsiteId =
+      await resolveScopeId('websites', options.parentWebsiteCode, params) ||
+      String(options.parentWebsiteCode)
+  }
+  // Auto-derive parentWebsiteId from the store view itself when not given.
+  if (parentWebsiteId == null && scope === 'stores' && options.scopeCode) {
+    const sMap = await loadStoreViewCodeMap(params)
+    parentWebsiteId = sMap.get(String(options.scopeCode))?.websiteId || undefined
+  }
+
+  let normalizedScopeId
+  try {
+    normalizedScopeId = normalizeScopeId(scope, resolvedScopeId)
+  } catch (_) {
+    return null
+  }
+
+  const cacheKey = `${scope}:${normalizedScopeId}:${path}`
+  const now = Date.now()
+  if (!options.fresh) {
+    const c = cache.get(cacheKey)
+    if (c && c.expiresAt > now) return c.value
+  }
+
+  let handle
+  try {
+    handle = await getClient(params)
+  } catch (_) {
+    return null
+  }
+
+  try {
+    const collection = await handle.client.collection(COLLECTION)
+    const chain = buildInheritanceChain(scope, normalizedScopeId, parentWebsiteId)
+
+    let resolved = null
+    for (const link of chain) {
+      const id = toStateKey(link.scope, link.scopeId, path)
+      const doc = await tryFindOne(collection, { _id: id })
+      if (!doc || doc.value === undefined) continue
+      let value = doc.value
+      if (isEncrypted(value)) {
+        try { value = decrypt(value, params) } catch (_) { /* keep raw */ }
+      }
+      value = maybeParseJson(value)
+      resolved = value
+      break
+    }
+
+    cache.set(cacheKey, { value: resolved, expiresAt: now + CACHE_TTL_MS })
+    return resolved
+  } finally {
+    try { await handle.close() } catch (_) { /* noop */ }
+  }
+}
+
+/** Clear the entire in-process cache (e.g. after a re-migration). */
+function clearAbdbConfigCache () {
+  cache.clear()
+  websiteCodeToId = null
+  storeCodeToId = null
+}
+
+module.exports = {
+  COLLECTION,
+  getConfig,
+  clearAbdbConfigCache
+}