campaign-cli 0.7.2

package/README.md

@@ -0,0 +1,242 @@
+# Campaign CLI
+
+**A command-line interface for ACC (Campaign Classic) developers**
+
+[![License: AGPL v3](https://img.shields.io/badge/License-AGPL_v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)
+[![Node.js](https://img.shields.io/badge/Node.js-22+-green.svg)](https://nodejs.org)
+[![npm](https://img.shields.io/badge/npm-CLI-blue.svg)](https://www.npmjs.com/)
+
+## 🚀 Quick Start
+
+### Quick usage
+
+```bash
+acc auth init --host https://instance.com --user username --password --alias staging
+
+acc instance pull --alias staging
+# Downloaded /Administration/Configuration/Form rendering
+# Downloaded /Administration/Configuration/Dynamic Javascript pages
+```
+
+### Quick installation
+
+```bash
+cd ~/Downloads
+git clone https://github.com/myrosblog/campaign-cli.git
+cd campaign-cli
+npm install
+npm link
+acc # check installation
+```
+
+### Basic Usage
+
+Folder structure recommendation, under a local folder, i.e. `Downloads`
+
+```bash
+/Downloads/
+├── campaign-cli/                  # Clone of this source code
+│
+├── instance1-staging/             # Staging Instance 1
+│   ├── config/                          # Instance-specific config => automatically created with acc check
+│   │   └── acc.config.json
+│   └── Administration/Configuration/    # Downloaded schemas => automatically downloaded with acc pull
+│       ├── schema1.xml
+│       └── schema2.xml
+│
+└── instance1-production/          # Production Instance 2
+    ├── config/
+    │   └── acc.config.json
+    └── Administration/Configuration/
+        ├── schema1.xml
+        └── schema2.xml
+```
+
+#### Step 1: Configure an ACC Instance
+
+```bash
+acc auth init \
+  --host http://localhost:8080 \
+  --user admin \
+  --password admin \
+  --alias local
+```
+
+This command:
+
+- Saves credentials securely in your config store
+- Tests the connection to your ACC instance
+- Lists available schemas and record counts
+
+#### Step 2: Pull Data from Your Instance with default configuration
+
+```bash
+acc instance check --alias local
+acc instance pull --alias local
+```
+
+This command:
+
+- Creates a local directory structure
+- Downloads schema definitions as XML files
+- Preserves original naming conventions
+- Implements pagination for large datasets
+
+#### Step 2-bis: Pull Data from Your Instance with custom configuration
+
+Create
+
+```bash
+
+```
+
+## 📚 Features
+
+### Authentication Management
+
+```bash
+# List all configured instances
+acc auth list
+
+# Troubleshoot IP via https://api.db-ip.com/v2/free/self @see https://opensource.adobe.com/acc-js-sdk/connecting.html
+acc auth ip
+
+# Login to an existing instance
+acc auth login --alias prod
+
+# Initialize a new instance
+acc auth init --alias staging --host https://staging.example.com
+```
+
+### Data Operations
+
+```bash
+# Check instance (count records without downloading)
+acc instance check --alias prod
+
+# Pull data with custom config
+acc instance pull \
+  --alias prod \
+  --path ./my-project/data \
+  --config ./config/acc.config.json
+```
+
+### Configuration Management
+
+Create a `acc.config.json` file to customize data pulling:
+
+```json
+{
+  "nms:delivery": {
+    "filename": "Deliveries/{%name%}.xml",
+    "queryDef": {
+      "where": {
+        "condition": [{ "expr": "@builtIn = false AND @isModel = true" }]
+      }
+    }
+  }
+}
+```
+
+## 🎯 Use Cases
+
+### For ACC Developers
+
+```bash
+# Setup development environment
+acc auth init --alias dev --host http://localhost:8080
+
+# Pull specific schemas
+acc instance pull --alias dev
+
+# Regular data refresh
+acc instance pull --alias prod --path ./backup/$(date +%Y-%m-%d)
+```
+
+### For DevOps Teams
+
+```bash
+# CI/CD integration
+acc auth init --alias ci --host $ACC_HOST --user $ACC_USER --password $ACC_PASSWORD
+acc instance check --alias ci || exit 1
+
+# Automated backups
+acc instance pull --alias prod --path /backups/acc/$(date +%Y-%m-%d)
+```
+
+### For Data Analysts
+
+```bash
+# Quick data extraction
+acc instance pull --alias analytics --config ./config/analytics.config.json
+
+# Schema documentation
+acc instance check --alias prod > schema_report.txt
+```
+
+## 🔧 Advanced Configuration
+
+### Custom Paths and Configs
+
+```bash
+acc instance pull \
+  --alias staging \
+  --path /projects/acc-migration/data \
+  --config ./config/migration.config.json
+```
+
+### Filename Patterns
+
+Available variables for filename patterns:
+
+- `%schema%` - Schema name (e.g., `nms_recipient`)
+- `%namespace%` - Schema namespace
+- `%name%` - Schema display name
+- `%internalName%` - Internal schema name
+
+## 🤝 Contributing
+
+Contributions are welcome! Please open a Pull Request!
+
+### Local development
+
+```bash
+# Clone repository
+git clone https://github.com/myrosblog/acc-cli.git
+cd acc-cli
+npm install
+npm link
+npm test
+```
+
+### Project Structure
+
+```
+src/
+├── main.js               # CLI entry point
+├── CampaignAuth.js       # Authentication and instance management
+├── CampaignInstance.js   # Data operations (check, pull, download)
+└── CampaignError.js      # Custom error handling
+
+test/
+├── CampaignAuth.spec.js  # Authentication tests
+├── CampaignInstance.spec.js # Data operation tests
+└── CampaignError.spec.js  # Error handling tests
+
+bin/
+└── acc            # Executable wrapper
+
+config/
+└── acc.config.json # Default configuration template
+```
+
+## Roadmap
+
+- Publish to npm
+
+## 🔒 Security
+
+- Credentials are stored securely using `configstore`
+- No credentials are logged or transmitted unnecessarily
+- All network communications use the official ACC JS SDK
+- Regular dependency updates for security patches

package/bin/acc

@@ -0,0 +1,19 @@
+#!/usr/bin/env node
+import { fileURLToPath } from "url";
+import { dirname, join } from "path";
+import { pathToFileURL } from "url";
+
+// Récupère le chemin absolu du fichier courant
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+// Chemin vers le fichier main.mjs (compatible Windows/macOS/Linux)
+const mainPath = join(__dirname, "..", "src", "main.js");
+const mainUrl = pathToFileURL(mainPath).href; // Convertit en URL valide pour ESM
+
+try {
+  await import(mainUrl);
+} catch (error) {
+  console.error("Failed to load acc:", error.message);
+  process.exit(1);
+}

package/config/acc.config.json

@@ -0,0 +1,339 @@
+{
+  "schemas": [
+    {
+      "schemaId": "nms:localOrgUnit",
+      "filename": "/Administration/Access Management/Organizational entities/{@name}.meta.xml",
+      "queryDef": {
+        "where": { "condition": [{ "expr": "@name NOT LIKE 'xtk%'" }] }
+      }
+    },
+    {
+      "schemaId": "nms:deliveryMapping",
+      "filename": "/Administration/Campaign Management/Target mappings/{@name}.meta.xml",
+      "queryDef": {
+        "where": { "condition": [{ "expr": "@builtIn = false" }] }
+      }
+    },
+    {
+      "schemaId": "nms:typology",
+      "filename": "/Administration/Campaign Management/Typology management/Typologies/{@name}.meta.xml",
+      "queryDef": {
+        "where": { "condition": [{ "expr": "@name NOT LIKE 'xtk%'" }] }
+      }
+    },
+    {
+      "schemaId": "nms:typologyRule",
+      "filename": "/Administration/Campaign Management/Typology management/Typology rules/{@name}.meta.xml",
+      "queryDef": {
+        "where": { "condition": [{ "expr": "@name NOT LIKE 'xtk%'" }] }
+      }
+    },
+    {
+      "schemaId": "xtk:srcSchema",
+      "filename": "/Administration/Configuration/Data schemas/{@namespace}/{@name}.xml",
+      "queryDef": {
+        "where": {
+          "condition": [
+            {
+              "expr": "@namespace NOT IN ('xtk', 'nl', 'ncm','nms', 'sfdc', 'crm', 'acx', 'adb')"
+            }
+          ]
+        },
+        "orderBy": { "node": [{ "expr": "@namespace" }, { "expr": "@name" }] }
+      }
+    },
+    {
+      "schemaId": "xtk:enum",
+      "filename": "/Administration/Platform/Enumerations/{@name}.xml",
+      "queryDef": {
+        "where": {
+          "condition": [
+            {
+              "expr": "@name NOT LIKE ''"
+            }
+          ]
+        }
+      }
+    },
+    {
+      "schemaId": "xtk:counter",
+      "filename": "/Administration/Platform/Counters/{@name}.xml",
+      "queryDef": {
+        "where": {
+          "condition": [
+            {
+              "expr": "@name NOT LIKE ''"
+            }
+          ]
+        }
+      }
+    },
+    {
+      "schemaId": "xtk:jssp",
+      "filename": "/Administration/Configuration/Dynamic JavaScript pages/{@namespace}/{@name}.meta.xml",
+      "decompose": {
+        "data": "/Administration/Configuration/Dynamic JavaScript pages/{@namespace}/{@name}.js"
+      },
+      "queryDef": {
+        "where": {
+          "condition": [
+            {
+              "expr": "@namespace NOT IN ('xtk', 'nl', 'ncm','nms', 'sfdc', 'crm', 'acx', 'adb')"
+            }
+          ]
+        }
+      }
+    },
+    {
+      "schemaId": "xtk:jst",
+      "filename": "/Administration/Configuration/JavaScript templates/{@namespace}/{@name}.meta.xml",
+      "decompose": {
+        "code": "/Administration/Configuration/JavaScript templates/{@namespace}/{@name}.js"
+      },
+      "queryDef": {
+        "where": {
+          "condition": [
+            {
+              "expr": "@namespace NOT IN ('xtk', 'nl', 'ncm','nms', 'sfdc', 'crm', 'acx', 'adb')"
+            }
+          ]
+        }
+      }
+    },
+    {
+      "schemaId": "xtk:formRendering",
+      "filename": "/Administration/Configuration/Form rendering/{@internalName}.meta.xml",
+      "decompose": {
+        "format/cssOverloading": "/Administration/Configuration/Form rendering/{@internalName}.css"
+      },
+      "queryDef": {
+        "where": {
+          "condition": [
+            {
+              "expr": "@internalName NOT LIKE 'xtk%' AND @internalName NOT LIKE 'nl%' AND @internalName NOT LIKE 'ncm%' AND @internalName NOT LIKE 'nms%'"
+            }
+          ]
+        }
+      }
+    },
+    {
+      "schemaId": "xtk:form",
+      "filename": "/Administration/Configuration/Input forms/{@namespace}/{@name}.xml",
+      "queryDef": {
+        "where": {
+          "condition": [
+            {
+              "expr": "@namespace NOT IN ('xtk', 'nl', 'ncm','nms', 'sfdc', 'crm', 'acx', 'adb')"
+            }
+          ]
+        }
+      }
+    },
+    {
+      "schemaId": "ncm:publishing",
+      "filename": "/Administration/Configuration/Publication Templates/{@namespace}/{@name}.meta.xml",
+      "queryDef": {
+        "where": {
+          "condition": [
+            {
+              "expr": "@namespace NOT IN ('xtk', 'nl', 'ncm','nms', 'sfdc', 'crm', 'acx', 'adb')"
+            }
+          ]
+        }
+      }
+    },
+    {
+      "schemaId": "xtk:javascript",
+      "filename": "/Administration/Configuration/JavaScript codes/{@namespace}/{@name}.meta.xml",
+      "decompose": {
+        "data": "/Administration/Configuration/JavaScript codes/{@namespace}/{@name}.js"
+      },
+      "queryDef": {
+        "where": {
+          "condition": [
+            {
+              "expr": "@namespace NOT IN ('xtk', 'nl', 'ncm','nms', 'sfdc', 'crm', 'acx', 'adb')"
+            }
+          ]
+        }
+      }
+    },
+    {
+      "schemaId": "xtk:navtree",
+      "filename": "/Administration/Configuration/Navigation hierarchies/{@namespace}/{@name}.xml",
+      "queryDef": {
+        "where": {
+          "condition": [
+            {
+              "expr": "@namespace NOT IN ('xtk', 'nl', 'ncm','nms', 'sfdc', 'crm', 'acx', 'adb')"
+            }
+          ]
+        }
+      }
+    },
+    {
+      "schemaId": "xtk:sql",
+      "filename": "/Administration/Configuration/SQL scripts/{@namespace}/{@name}.meta.xml",
+      "decompose": {
+        "data": "/Administration/Configuration/SQL scripts/{@namespace}/{@name}.sql"
+      },
+      "queryDef": {
+        "where": {
+          "condition": [
+            {
+              "expr": "@namespace NOT IN ('xtk', 'nl', 'ncm','nms', 'sfdc', 'crm', 'acx', 'adb')"
+            }
+          ]
+        }
+      }
+    },
+    {
+      "schemaId": "xtk:xslt",
+      "filename": "/Administration/Configuration/XSL style sheets/{@namespace}/{@name}.meta.xml",
+      "decompose": {
+        "data": "/Administration/Configuration/XSL style sheets/{@namespace}/{@name}.xsl"
+      },
+      "queryDef": {
+        "where": {
+          "condition": [
+            {
+              "expr": "@namespace NOT IN ('xtk', 'nl', 'ncm','nms', 'sfdc', 'crm', 'acx', 'adb')"
+            }
+          ]
+        }
+      }
+    },
+    {
+      "schemaId": "xtk:workflow",
+      "filename": "/Administration/Production/Objects created automatically/Campaign workflows/{@internalName}.meta.xml",
+      "queryDef": {
+        "where": {
+          "condition": [{ "expr": "@builtIn = true AND @isModel = false AND [@operation-id] != 0" }]
+        }
+      }
+    },
+    {
+      "schemaId": "xtk:workflow",
+      "filename": "/Administration/Production/Technical workflows/{@internalName}.meta.xml",
+      "queryDef": {
+        "where": {
+          "condition": [{ "expr": "@builtIn = true AND @isModel = false AND [@operation-id] = 0" }]
+        }
+      }
+    },
+    {
+      "schemaId": "xtk:workflow",
+      "filename": "/Resources/Templates/Workflow templates/{@internalName}.meta.xml",
+      "queryDef": {
+        "where": {
+          "condition": [{ "expr": "@builtIn = true AND @isModel = true" }]
+        }
+      }
+    },
+    {
+      "schemaId": "nms:operation",
+      "filename": "/Campaign Management/Campaigns/{@internalName}.meta.xml",
+      "queryDef": {
+        "where": {
+          "condition": [{ "expr": "@builtIn = false AND @isModel = true" }]
+        }
+      }
+    },
+    {
+      "schemaId": "nms:delivery",
+      "filename": "/Campaign Management/Deliveries/{@internalName}.meta.xml",
+      "decompose": {
+        "content/html/source": "/Campaign Management/Deliveries/{@internalName}.html",
+        "content/text/source": "/Campaign Management/Deliveries/{@internalName}.txt"
+      },
+      "excludeXPaths": ["@cryptedId"],
+      "queryDef": {
+        "where": {
+          "condition": [
+            { "expr": "@builtIn = true", "boolOperator": "AND" },
+            { "expr": "@isModel = false", "boolOperator": "AND" }
+          ]
+        }
+      }
+    },
+    {
+      "schemaId": "nms:delivery",
+      "filename": "/Resources/Templates/Delivery templates/{@internalName}.meta.xml",
+      "decompose": {
+        "content/html/source": "/Campaign Management/Deliveries/{@internalName}.html",
+        "content/text/source": "/Campaign Management/Deliveries/{@internalName}.txt"
+      },
+      "excludeXPaths": ["@cryptedId"],
+      "queryDef": {
+        "where": {
+          "condition": [
+            { "expr": "@builtIn = true", "boolOperator": "AND" },
+            { "expr": "@isModel = true", "boolOperator": "AND" }
+          ]
+        }
+      }
+    },
+    {
+      "schemaId": "nms:includeView",
+      "filename": "/Resources/Campaign Management/Personalization blocks/{@name}.meta.xml",
+      "decompose": {
+        "source/html": "/Resources/Campaign Management/Personalization blocks/{@name}.html",
+        "source/text": "/Resources/Campaign Management/Personalization blocks/{@name}.txt"
+      },
+      "queryDef": {
+        "where": {
+          "condition": [{ "expr": "@name NOT LIKE 'xtk%'" }]
+        }
+      }
+    },
+    {
+      "schemaId": "nms:deliveryCustomization",
+      "filename": "/Resources/Campaign Management/Personalization fields/{@name}.xml",
+      "queryDef": {
+        "where": { "condition": [{ "expr": "@isModel = true" }] }
+      }
+    },
+    {
+      "schemaId": "nms:webApp",
+      "filename": "/Resources/Online/Web applications/{@internalName}.xml",
+      "queryDef": {
+        "where": { "condition": [{ "expr": "@builtIn = false" }] }
+      }
+    },
+    {
+      "schemaId": "xtk:queryFilter",
+      "filename": "/Profiles and Targets/Predefined filters/{@name}.meta.xml",
+      "queryDef": {
+        "where": {
+          "condition": [{ "expr": "@name NOT LIKE ''" }]
+        }
+      }
+    },
+    {
+      "schemaId": "nms:group",
+      "filename": "/Profiles and Targets/Lists/{@name}.meta.xml",
+      "queryDef": {
+        "where": {
+          "condition": [
+            {
+              "expr": "@name NOT LIKE 'xtk%'"
+            }
+          ]
+        }
+      }
+    },
+    {
+      "schemaId": "xtk:folder",
+      "filename": "/Explorer/{@name}.meta.xml",
+      "queryDef": {
+        "where": {
+          "condition": [
+            {
+              "expr": "@builtIn = true"
+            }
+          ]
+        }
+      }
+    }
+  ]
+}

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "campaign-cli",
+  "version": "0.7.2",
+  "description": "Save time, reduce risk and improve code health with acc CLI",
+  "keywords": [
+    "adobe",
+    "adobe campaign",
+    "adobe campaign classic",
+    "acc"
+  ],
+  "bin": {
+    "acc": "./bin/acc"
+  },
+  "preferGlobal": true,
+  "files": [
+    "bin/",
+    "src/",
+    "config/"
+  ],
+  "scripts": {
+    "init": "node src/main.js",
+    "test": "c8 mocha test/index.js"
+  },
+  "type": "module",
+  "dependencies": {
+    "@adobe/acc-js-sdk": "^1.1.61",
+    "chalk": "^5.6.2",
+    "commander": "^14.0.3",
+    "configstore": "^8.0.0",
+    "fs-extra": "^11.3.3"
+  },
+  "devDependencies": {
+    "c8": "^11.0.0",
+    "chai": "^6.2.2",
+    "mocha": "^11.3.0",
+    "sinon": "^21.0.1",
+    "sinon-chai": "^4.0.1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/myrosblog/acc-cli.git"
+  },
+  "author": "Myros",
+  "license": "AGPL-3.0-only",
+  "bugs": {
+    "url": "https://github.com/myrosblog/acc-cli/issues"
+  },
+  "homepage": "https://myrosblog.com/adobe-campaign/acc-cli?utm_campaign=acc-cli"
+}