configuration-management 0.1.6 → 0.1.10

package/README.md

@@ -2,7 +2,7 @@
 
 Schema-driven system configuration for **Adobe Commerce** and **Adobe App Builder** sync applications.
 
-Mirrors Magento's `core_config_data` model: scoped configuration (`default` / `websites` / `stores`) stored in **Adobe App Builder Database (ABDB)** with AES-256-GCM encryption for sensitive fields.
+Config reading (`getConfig`, ABDB, crypto, Commerce REST) lives in the companion package [`configuration-get-config`](https://www.npmjs.com/package/configuration-get-config). This package adds the React Admin UI, OpenWhisk actions, and App Builder setup.
 
 ## Install
 
@@ -27,7 +27,12 @@ npm install react react-dom @adobe/react-spectrum @adobe/uix-guest @adobe/exc-ap
 Read a config value from ABDB inside an App Builder action:
 
 ```js
+// Preferred — config reader package (installed automatically with configuration-management)
+const { getConfig } = require('configuration-get-config')
+
+// Or re-exported from this package
 const { getConfig } = require('configuration-management')
+// const { getConfig } = require('configuration-management/config')
 
 async function main (params) {
   const apiUrl = await getConfig('sync_general/api/url', params, {
@@ -40,7 +45,9 @@ async function main (params) {
 
 ## API
 
-### Config resolution
+### Config resolution (`configuration-get-config`)
+
+Implemented in [`configuration-get-config`](https://www.npmjs.com/package/configuration-get-config) and re-exported here.
 
 | Export | Description |
 |--------|-------------|
@@ -98,8 +105,17 @@ createRoot(document.getElementById('root')).render(
 )
 ```
 
-The web UI is **pre-built** in the package (`web/dist/index.js`), so no Parcel
-`includeNodeModules` or webpack aliases are required in your host `package.json`.
+The web UI is **pre-built** in the package. Import the JS entry — styles load automatically:
+
+```js
+import { ConfigurationManagementApp, configureWeb } from 'configuration-management/web'
+```
+
+Or import styles separately:
+
+```js
+import 'configuration-management/web/styles.css'
+```
 
 | Export | Description |
 |--------|-------------|
@@ -117,9 +133,8 @@ OpenWhisk runtime actions and the Commerce Admin extension manifest ship with th
 
 #### Automatic wiring on `npm install`
 
-The package runs a **postinstall** script that:
-
-1. Patches your project's `app.config.yaml` (if present) with:
+The package runs a **postinstall** script that patches your project's `app.config.yaml`
+(if present) with:
 
 ```yaml
 extensions:
@@ -127,20 +142,8 @@ extensions:
     $include: node_modules/configuration-management/actions/configurations/ext.config.yaml
 ```
 
-2. Scaffolds a minimal `web-src/` bootstrap (if missing or previously auto-generated):
-
-```
-web-src/
-├── index.html
-└── src/
-    ├── index.js       ← imports ConfigurationManagementApp from the package
-    ├── exc-runtime.js
-    └── config.json    ← created empty; filled by aio app deploy
-```
-
-Custom `web-src` files are left untouched unless they were created by a prior install
-(files containing the `configuration-management: auto-generated bootstrap` marker, or
-an older bootstrap that imports `configuration-management/web`).
+It does **not** modify your `web-src/` files. Add the UI to your existing App Builder
+bootstrap manually (see React Admin UI above).
 
 - Run `npm install` from your App Builder project root (where `app.config.yaml` lives).
 - Do not use `npm install --ignore-scripts` (that skips postinstall).
@@ -176,11 +179,10 @@ The bundled `ext.config.yaml` declares all actions under the `ConfigurationManag
 
 ```
 my-app/
-├── app.config.yaml          ← $include ext.config from node_modules (above)
+├── app.config.yaml          ← $include ext.config (auto-patched on npm install)
 ├── web-src/
-│   ├── index.html
 │   └── src/
-│       ├── index.js         ← import ConfigurationManagementApp + configureWeb
+│       ├── index.js         ← your app bootstrap + package imports (see above)
 │       └── config.json      ← generated by aio app deploy
 ├── .env
 └── package.json             ← depends on configuration-management

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "configuration-management",
-  "version": "0.1.6",
+  "version": "0.1.10",
   "description": "Schema-driven system configuration for Adobe Commerce App Builder sync apps. Magento-style scoped config in Adobe App Builder Database (ABDB) with encryption, Commerce REST helpers, and React Admin UI.",
   "license": "Apache-2.0",
   "author": "Adobe Inc.",
@@ -30,9 +30,10 @@
     "./crypto": "./src/system-config-crypto.js",
     "./shared": "./src/system-config-shared.js",
     "./oauth1a": "./src/oauth1a.js",
-    "./web": "./web/dist/index.js",
-    "./web/index.js": "./web/dist/index.js",
-    "./web/styles.css": "./web/src/styles/index.css",
+    "./web": "./web/index.js",
+    "./web/index.js": "./web/index.js",
+    "./web/styles.css": "./web/styles.css",
+    "./web/dist/index.css": "./web/dist/index.css",
     "./web/src/styles/index.css": "./web/src/styles/index.css",
     "./actions/utils": "./actions/utils.js",
     "./actions/ext.config.yaml": "./actions/configurations/ext.config.yaml"
@@ -63,9 +64,8 @@
     "react-router-dom": "^6.8.1"
   },
   "dependencies": {
-    "esbuild": "^0.25.12",
-    "got": "^11.8.5",
-    "oauth-1.0a": "^2.2.6"
+    "configuration-get-config": "^0.1.0",
+    "esbuild": "^0.25.12"
   },
   "repository": {
     "type": "git",

package/scripts/build-web.js

@@ -20,6 +20,8 @@ async function main () {
   const entry = path.join(pkgRoot, 'web/src/index.js')
   const outdir = path.join(pkgRoot, 'web/dist')
   const outfile = path.join(outdir, 'index.js')
+  const stylesSrc = path.join(pkgRoot, 'web/src/styles/index.css')
+  const stylesFlat = path.join(pkgRoot, 'web/styles.css')
 
   fs.mkdirSync(outdir, { recursive: true })
 
@@ -31,12 +33,19 @@ async function main () {
     outfile,
     packages: 'external',
     jsx: 'automatic',
-    loader: { '.js': 'jsx' },
+    loader: { '.js': 'jsx', '.css': 'css' },
     target: ['chrome79', 'firefox85', 'safari13'],
     logLevel: 'info'
   })
 
+  // Parcel does not resolve nested @import inside node_modules — ship a flat file.
+  fs.copyFileSync(stylesSrc, stylesFlat)
+
   console.log('[configuration-management] built web/dist/index.js')
+  if (fs.existsSync(path.join(outdir, 'index.css'))) {
+    console.log('[configuration-management] built web/dist/index.css')
+  }
+  console.log('[configuration-management] copied web/styles.css')
 }
 
 if (require.main === module) {

package/scripts/setup.js

@@ -10,9 +10,6 @@ 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, '\\$&')
@@ -21,10 +18,7 @@ function escapeRe (str) {
 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'))
-    ) {
+    if (fs.existsSync(path.join(dir, 'app.config.yaml'))) {
       return dir
     }
     dir = path.dirname(dir)
@@ -41,57 +35,6 @@ function resolveProjectRoot () {
   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')
 }
@@ -176,38 +119,6 @@ function setupAppConfig (projectRoot) {
   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
@@ -228,18 +139,10 @@ function main () {
       `[configuration-management] Updated app.config.yaml (${app.reason}):\n` +
         `  $include: ${app.detail}`
     )
+    return
   }
 
-  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.')
-  }
+  console.log('[configuration-management] app.config.yaml already configured.')
 }
 
 if (require.main === module) {
@@ -254,7 +157,6 @@ if (require.main === module) {
 module.exports = {
   patchAppConfig,
   setupAppConfig,
-  setupWebSrc,
   INCLUDE_REL,
   EXTENSION_POINT
 }

package/src/abdb-config.js

@@ -5,237 +5,4 @@ you may not use this file except in compliance with the License. You may obtain
 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
-}
+module.exports = require('configuration-get-config/config')