@adobedjangir/commerce-admin-management 0.0.16 → 0.0.18

package/README.md

@@ -51,15 +51,24 @@ and an extension point for host apps to add their own pages and actions.
 aio app init my-commerce-admin
 cd my-commerce-admin
 
-# 2. Install. The postinstall bumps the host's package.json to the
-#    React 18 / Spectrum 4 floor and re-runs `npm install` automatically.
-npm install @adobedjangir/commerce-admin-management
+# 2. Install with --legacy-peer-deps on first install.
+#    aio's default template pins React 16; this package requires React 18.
+npm install --legacy-peer-deps @adobedjangir/commerce-admin-management
 
-# 3. Fill in .env (see required values below)
-cp env.dist .env
+# 3. Run the setup helper. Bumps host deps to React 18 / Spectrum 4 floor,
+#    scaffolds web-src/, removes the dx/excshell/1 boilerplate, and
+#    generates AIO_DB_REGION + SYSTEM_CONFIG_CRYPT_KEY in .env.
+npx @adobedjangir/commerce-admin-management-setup
+
+# 4. Apply the bumped versions
+rm -rf node_modules package-lock.json
+npm install
+
+# 5. Fill in any missing .env values (OAUTH_*) — region + crypt key are
+#    auto-generated by step 3.
 $EDITOR .env
 
-# 4. Deploy. ABDB is auto-provisioned; actions + web assets ship to CDN.
+# 6. Deploy. ABDB is auto-provisioned; actions + web assets ship to CDN.
 aio app deploy
 ```
 

package/actions/configurations/ext.config.yaml

@@ -36,9 +36,13 @@ runtimeManifest:
             LOG_LEVEL: debug
             SYSTEM_CONFIG_CRYPT_KEY: $SYSTEM_CONFIG_CRYPT_KEY
             OAUTH_CLIENT_ID: $OAUTH_CLIENT_ID
+            IMS_OAUTH_S2S_CLIENT_ID: $IMS_OAUTH_S2S_CLIENT_ID
             OAUTH_CLIENT_SECRET: $OAUTH_CLIENT_SECRET
+            IMS_OAUTH_S2S_CLIENT_SECRET: $IMS_OAUTH_S2S_CLIENT_SECRET
             OAUTH_ORG_ID: $OAUTH_ORG_ID
+            IMS_OAUTH_S2S_ORG_ID: $IMS_OAUTH_S2S_ORG_ID
             OAUTH_SCOPES: $OAUTH_SCOPES
+            IMS_OAUTH_S2S_SCOPES: $IMS_OAUTH_S2S_SCOPES
             AIO_DB_REGION: $AIO_DB_REGION
           annotations:
             require-adobe-auth: false
@@ -52,9 +56,13 @@ runtimeManifest:
             LOG_LEVEL: debug
             SYSTEM_CONFIG_CRYPT_KEY: $SYSTEM_CONFIG_CRYPT_KEY
             OAUTH_CLIENT_ID: $OAUTH_CLIENT_ID
+            IMS_OAUTH_S2S_CLIENT_ID: $IMS_OAUTH_S2S_CLIENT_ID
             OAUTH_CLIENT_SECRET: $OAUTH_CLIENT_SECRET
+            IMS_OAUTH_S2S_CLIENT_SECRET: $IMS_OAUTH_S2S_CLIENT_SECRET
             OAUTH_ORG_ID: $OAUTH_ORG_ID
+            IMS_OAUTH_S2S_ORG_ID: $IMS_OAUTH_S2S_ORG_ID
             OAUTH_SCOPES: $OAUTH_SCOPES
+            IMS_OAUTH_S2S_SCOPES: $IMS_OAUTH_S2S_SCOPES
             AIO_DB_REGION: $AIO_DB_REGION
           annotations:
             require-adobe-auth: false
@@ -68,9 +76,13 @@ runtimeManifest:
             LOG_LEVEL: debug
             SYSTEM_CONFIG_CRYPT_KEY: $SYSTEM_CONFIG_CRYPT_KEY
             OAUTH_CLIENT_ID: $OAUTH_CLIENT_ID
+            IMS_OAUTH_S2S_CLIENT_ID: $IMS_OAUTH_S2S_CLIENT_ID
             OAUTH_CLIENT_SECRET: $OAUTH_CLIENT_SECRET
+            IMS_OAUTH_S2S_CLIENT_SECRET: $IMS_OAUTH_S2S_CLIENT_SECRET
             OAUTH_ORG_ID: $OAUTH_ORG_ID
+            IMS_OAUTH_S2S_ORG_ID: $IMS_OAUTH_S2S_ORG_ID
             OAUTH_SCOPES: $OAUTH_SCOPES
+            IMS_OAUTH_S2S_SCOPES: $IMS_OAUTH_S2S_SCOPES
             AIO_DB_REGION: $AIO_DB_REGION
           annotations:
             require-adobe-auth: false
@@ -83,9 +95,13 @@ runtimeManifest:
           inputs:
             LOG_LEVEL: debug
             OAUTH_CLIENT_ID: $OAUTH_CLIENT_ID
+            IMS_OAUTH_S2S_CLIENT_ID: $IMS_OAUTH_S2S_CLIENT_ID
             OAUTH_CLIENT_SECRET: $OAUTH_CLIENT_SECRET
+            IMS_OAUTH_S2S_CLIENT_SECRET: $IMS_OAUTH_S2S_CLIENT_SECRET
             OAUTH_ORG_ID: $OAUTH_ORG_ID
+            IMS_OAUTH_S2S_ORG_ID: $IMS_OAUTH_S2S_ORG_ID
             OAUTH_SCOPES: $OAUTH_SCOPES
+            IMS_OAUTH_S2S_SCOPES: $IMS_OAUTH_S2S_SCOPES
             AIO_DB_REGION: $AIO_DB_REGION
           annotations:
             require-adobe-auth: false
@@ -99,9 +115,13 @@ runtimeManifest:
             LOG_LEVEL: debug
             SYSTEM_CONFIG_CRYPT_KEY: $SYSTEM_CONFIG_CRYPT_KEY
             OAUTH_CLIENT_ID: $OAUTH_CLIENT_ID
+            IMS_OAUTH_S2S_CLIENT_ID: $IMS_OAUTH_S2S_CLIENT_ID
             OAUTH_CLIENT_SECRET: $OAUTH_CLIENT_SECRET
+            IMS_OAUTH_S2S_CLIENT_SECRET: $IMS_OAUTH_S2S_CLIENT_SECRET
             OAUTH_ORG_ID: $OAUTH_ORG_ID
+            IMS_OAUTH_S2S_ORG_ID: $IMS_OAUTH_S2S_ORG_ID
             OAUTH_SCOPES: $OAUTH_SCOPES
+            IMS_OAUTH_S2S_SCOPES: $IMS_OAUTH_S2S_SCOPES
             AIO_DB_REGION: $AIO_DB_REGION
           annotations:
             require-adobe-auth: false
@@ -118,9 +138,13 @@ runtimeManifest:
             LOG_LEVEL: debug
             SYSTEM_CONFIG_CRYPT_KEY: $SYSTEM_CONFIG_CRYPT_KEY
             OAUTH_CLIENT_ID: $OAUTH_CLIENT_ID
+            IMS_OAUTH_S2S_CLIENT_ID: $IMS_OAUTH_S2S_CLIENT_ID
             OAUTH_CLIENT_SECRET: $OAUTH_CLIENT_SECRET
+            IMS_OAUTH_S2S_CLIENT_SECRET: $IMS_OAUTH_S2S_CLIENT_SECRET
             OAUTH_ORG_ID: $OAUTH_ORG_ID
+            IMS_OAUTH_S2S_ORG_ID: $IMS_OAUTH_S2S_ORG_ID
             OAUTH_SCOPES: $OAUTH_SCOPES
+            IMS_OAUTH_S2S_SCOPES: $IMS_OAUTH_S2S_SCOPES
             AIO_DB_REGION: $AIO_DB_REGION
           annotations:
             require-adobe-auth: false
@@ -134,9 +158,13 @@ runtimeManifest:
             LOG_LEVEL: debug
             SYSTEM_CONFIG_CRYPT_KEY: $SYSTEM_CONFIG_CRYPT_KEY
             OAUTH_CLIENT_ID: $OAUTH_CLIENT_ID
+            IMS_OAUTH_S2S_CLIENT_ID: $IMS_OAUTH_S2S_CLIENT_ID
             OAUTH_CLIENT_SECRET: $OAUTH_CLIENT_SECRET
+            IMS_OAUTH_S2S_CLIENT_SECRET: $IMS_OAUTH_S2S_CLIENT_SECRET
             OAUTH_ORG_ID: $OAUTH_ORG_ID
+            IMS_OAUTH_S2S_ORG_ID: $IMS_OAUTH_S2S_ORG_ID
             OAUTH_SCOPES: $OAUTH_SCOPES
+            IMS_OAUTH_S2S_SCOPES: $IMS_OAUTH_S2S_SCOPES
             AIO_DB_REGION: $AIO_DB_REGION
           annotations:
             require-adobe-auth: false
@@ -150,9 +178,13 @@ runtimeManifest:
             LOG_LEVEL: debug
             SYSTEM_CONFIG_CRYPT_KEY: $SYSTEM_CONFIG_CRYPT_KEY
             OAUTH_CLIENT_ID: $OAUTH_CLIENT_ID
+            IMS_OAUTH_S2S_CLIENT_ID: $IMS_OAUTH_S2S_CLIENT_ID
             OAUTH_CLIENT_SECRET: $OAUTH_CLIENT_SECRET
+            IMS_OAUTH_S2S_CLIENT_SECRET: $IMS_OAUTH_S2S_CLIENT_SECRET
             OAUTH_ORG_ID: $OAUTH_ORG_ID
+            IMS_OAUTH_S2S_ORG_ID: $IMS_OAUTH_S2S_ORG_ID
             OAUTH_SCOPES: $OAUTH_SCOPES
+            IMS_OAUTH_S2S_SCOPES: $IMS_OAUTH_S2S_SCOPES
             AIO_DB_REGION: $AIO_DB_REGION
           annotations:
             require-adobe-auth: false
@@ -166,9 +198,13 @@ runtimeManifest:
             LOG_LEVEL: debug
             SYSTEM_CONFIG_CRYPT_KEY: $SYSTEM_CONFIG_CRYPT_KEY
             OAUTH_CLIENT_ID: $OAUTH_CLIENT_ID
+            IMS_OAUTH_S2S_CLIENT_ID: $IMS_OAUTH_S2S_CLIENT_ID
             OAUTH_CLIENT_SECRET: $OAUTH_CLIENT_SECRET
+            IMS_OAUTH_S2S_CLIENT_SECRET: $IMS_OAUTH_S2S_CLIENT_SECRET
             OAUTH_ORG_ID: $OAUTH_ORG_ID
+            IMS_OAUTH_S2S_ORG_ID: $IMS_OAUTH_S2S_ORG_ID
             OAUTH_SCOPES: $OAUTH_SCOPES
+            IMS_OAUTH_S2S_SCOPES: $IMS_OAUTH_S2S_SCOPES
             AIO_DB_REGION: $AIO_DB_REGION
           annotations:
             require-adobe-auth: false
@@ -182,9 +218,13 @@ runtimeManifest:
             LOG_LEVEL: debug
             SYSTEM_CONFIG_CRYPT_KEY: $SYSTEM_CONFIG_CRYPT_KEY
             OAUTH_CLIENT_ID: $OAUTH_CLIENT_ID
+            IMS_OAUTH_S2S_CLIENT_ID: $IMS_OAUTH_S2S_CLIENT_ID
             OAUTH_CLIENT_SECRET: $OAUTH_CLIENT_SECRET
+            IMS_OAUTH_S2S_CLIENT_SECRET: $IMS_OAUTH_S2S_CLIENT_SECRET
             OAUTH_ORG_ID: $OAUTH_ORG_ID
+            IMS_OAUTH_S2S_ORG_ID: $IMS_OAUTH_S2S_ORG_ID
             OAUTH_SCOPES: $OAUTH_SCOPES
+            IMS_OAUTH_S2S_SCOPES: $IMS_OAUTH_S2S_SCOPES
             AIO_DB_REGION: $AIO_DB_REGION
           annotations:
             require-adobe-auth: false

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobedjangir/commerce-admin-management",
-  "version": "0.0.16",
+  "version": "0.0.18",
   "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.",

package/scripts/setup.js

@@ -591,24 +591,55 @@ function ensureHostDeps (projectRoot) {
   try { pkg = JSON.parse(fs.readFileSync(pkgPath, 'utf8')) } catch (_) {
     return { changed: false, reason: 'unreadable-package-json' }
   }
-  pkg.dependencies = pkg.dependencies || {}
 
+  // Decide which deps need bumping by reading the current package.json.
   const bumped = []
   for (const [name, floor] of Object.entries(REQUIRED_HOST_DEPS)) {
-    const declared = pkg.dependencies[name] || (pkg.devDependencies && pkg.devDependencies[name])
+    const declared = (pkg.dependencies && pkg.dependencies[name]) ||
+                     (pkg.devDependencies && pkg.devDependencies[name])
     if (declared && satisfiesFloor(declared, floor)) continue
-    // Move it to dependencies (out of devDependencies if it was there) and
-    // set to the floor.
-    pkg.dependencies[name] = floor
-    if (pkg.devDependencies && pkg.devDependencies[name]) {
-      delete pkg.devDependencies[name]
-    }
     bumped.push({ name, was: declared || '(missing)', now: floor })
   }
 
   if (bumped.length === 0) return { changed: false, reason: 'already-satisfies' }
 
-  fs.writeFileSync(pkgPath, JSON.stringify(pkg, null, 2) + '\n', 'utf8')
+  // Persist via `npm pkg set` rather than fs.writeFileSync. The outer
+  // `npm install <pkg>` keeps a buffered copy of package.json that it
+  // writes at the very end of the install (to add the package itself
+  // as a dependency) — that write clobbers anything we'd done via
+  // fs.writeFileSync. `npm pkg set` goes through npm's own metadata
+  // layer and persists across that final write.
+  const { execSync } = require('child_process')
+  const args = bumped
+    .map((b) => `dependencies.${b.name}=${b.now}`)
+    // Some keys contain "@" which `npm pkg set` accepts unquoted; we
+    // shell-quote the whole assignment to be safe.
+    .map((a) => `'${a.replace(/'/g, "'\\''")}'`)
+    .join(' ')
+  try {
+    execSync(`npm pkg set ${args}`, {
+      cwd: projectRoot,
+      stdio: 'pipe',
+      env: { ...process.env, COMMERCE_ADMIN_MANAGEMENT_SKIP_SETUP: '1' }
+    })
+  } catch (e) {
+    return { changed: false, reason: `npm-pkg-set-failed: ${e.message}` }
+  }
+
+  // Also remove from devDependencies so the bumped value in dependencies
+  // is the only spec npm will see on the next resolution.
+  const inDev = bumped.filter((b) => pkg.devDependencies && pkg.devDependencies[b.name])
+  if (inDev.length) {
+    const delArgs = inDev.map((b) => `'devDependencies.${b.name}'`).join(' ')
+    try {
+      execSync(`npm pkg delete ${delArgs}`, {
+        cwd: projectRoot,
+        stdio: 'pipe',
+        env: { ...process.env, COMMERCE_ADMIN_MANAGEMENT_SKIP_SETUP: '1' }
+      })
+    } catch (_) { /* non-fatal */ }
+  }
+
   return { changed: true, bumped }
 }
 
@@ -624,6 +655,62 @@ function ensureHostDeps (projectRoot) {
  *
  * Returns { changed, set: [{key, source}], file }.
  */
+/**
+ * Mirror IMS_OAUTH_S2S_* → OAUTH_* in the host's .env. Newer Adobe Developer
+ * Console templates use the IMS_OAUTH_S2S_ prefix; our actions still read
+ * the legacy OAUTH_ names. We append aliases so both work — only when
+ * IMS_OAUTH_S2S_* is set and OAUTH_* isn't. Idempotent: re-running won't
+ * duplicate the block (we identify our own mirror block by its comment).
+ */
+function mirrorImsOauthAliases (projectRoot) {
+  const envPath = path.join(projectRoot, '.env')
+  if (!fs.existsSync(envPath)) return { changed: false, reason: 'no-env' }
+  let env = ''
+  try { env = fs.readFileSync(envPath, 'utf8') } catch (_) { return { changed: false, reason: 'unreadable' } }
+
+  const grab = (k) => {
+    const m = env.match(new RegExp('^' + k + '=(.*)$', 'm'))
+    return m ? m[1] : ''
+  }
+  const id  = grab('IMS_OAUTH_S2S_CLIENT_ID')
+  const sec = grab('IMS_OAUTH_S2S_CLIENT_SECRET')
+  const org = grab('IMS_OAUTH_S2S_ORG_ID')
+  let scopes = grab('IMS_OAUTH_S2S_SCOPES')
+
+  if (!id || !sec || !org) return { changed: false, reason: 'ims-vars-missing' }
+
+  // SCOPES is often a JSON array; the action expects a comma-separated string.
+  if (scopes.trim().startsWith('[')) {
+    try { scopes = JSON.parse(scopes).join(', ') } catch (_) { /* leave as-is */ }
+  }
+
+  // If OAUTH_* already non-empty, leave the user's values alone.
+  const existing = {
+    OAUTH_CLIENT_ID:     grab('OAUTH_CLIENT_ID'),
+    OAUTH_CLIENT_SECRET: grab('OAUTH_CLIENT_SECRET'),
+    OAUTH_ORG_ID:        grab('OAUTH_ORG_ID'),
+    OAUTH_SCOPES:        grab('OAUTH_SCOPES')
+  }
+  const anyMissing = Object.values(existing).some((v) => !v)
+  if (!anyMissing) return { changed: false, reason: 'already-aliased' }
+
+  // Strip any previously-mirrored block so re-runs don't accumulate.
+  env = env.replace(/\n# Aliases mirrored from IMS_OAUTH_S2S_\*[\s\S]*?(?=\n[A-Z_]+=|\n*$)/g, '')
+
+  const block = [
+    '',
+    '# Aliases mirrored from IMS_OAUTH_S2S_* — required by the commerce-admin-management actions.',
+    `OAUTH_CLIENT_ID=${id}`,
+    `OAUTH_CLIENT_SECRET=${sec}`,
+    `OAUTH_ORG_ID=${org}`,
+    `OAUTH_SCOPES=${scopes}`,
+    ''
+  ].join('\n')
+
+  fs.writeFileSync(envPath, env + block, 'utf8')
+  return { changed: true }
+}
+
 function ensureEnvDefaults (projectRoot) {
   const envPath = path.join(projectRoot, '.env')
   let lines = []
@@ -751,6 +838,12 @@ function main () {
       console.log(`[@adobedjangir/commerce-admin-management] .env ${s.source}: ${s.key}`)
     }
   }
+  // Newer Adobe Developer Console templates use IMS_OAUTH_S2S_* prefix in
+  // .env. Our actions still read OAUTH_*. Mirror automatically so both work.
+  const mirror = mirrorImsOauthAliases(projectRoot)
+  if (mirror.changed) {
+    console.log('[@adobedjangir/commerce-admin-management] .env mirrored IMS_OAUTH_S2S_* → OAUTH_*')
+  }
 
   // Bump host package.json so React-18 + Spectrum-4 peers are satisfied
   // without the consumer running a long `npm install --save react@^18 ...`