campaign-cli 0.7.6 → 0.7.8

package/README.md

@@ -2,7 +2,7 @@
 
 Save time, reduce risk, and improve code health with `acc`! This CLI tool helps you build on Adobe Campaign Classic platform. It quickly downloads Adobe Campaign **configuration, campaigns and online resources**. You can also use it to automate many common development tasks.
 
-Full article in the blog post [Getting started with acc](https://myrosblog.com/adobe-campaign/acc-cli-use-cases?utm_campaign=readme)
+Full documentation available on [Getting started with acc](https://myrosblog.com/adobe-campaign/acc-cli?utm_campaign=readme)
 
 ## Features
 
@@ -15,21 +15,25 @@ Full article in the blog post [Getting started with acc](https://myrosblog.com/a
 
 ## 🚀 Quick Start
 
-### Quick usage
+### Installation
 
 ```bash
-$ npm install -g campaign-cli
+npm install -g campaign-cli
+```
+
+### Usage
 
-$ acc auth init --host https://instance.com --user username --password --alias staging
+```bash
+acc auth init --host https://instance.com --user username --pass --alias staging
 
-$ acc instance pull --alias staging
+acc instance pull --alias staging
 # Downloaded /Administration/Configuration/Form rendering
 # Doanloaded /Administration/Configuration/Dynamic Javascript pages
 ```
 
 ### 🔧 Advanced Configuration
 
-[Advanced use cases with acc](https://myrosblog.com/adobe-campaign/acc-cli-use-cases?utm_campaign=readme)
+Read the [Advanced Use Cases documentation](https://myrosblog.com/adobe-campaign/acc-cli-use-cases?utm_campaign=readme)
 
 ## 🤝 Contributing
 
@@ -43,34 +47,10 @@ git clone https://github.com/myrosblog/acc-cli.git && cd acc-cli
 npm install && 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
 
 - `acc instance push`
 
-## 🔒 Security
+## 🔒 Architecture & Security
 
-- Credentials are stored securely using `configstore` outside of version controlled folders
-- No credentials are logged or transmitted unnecessarily
-- All network communications use the official ACC JS SDK
-- All sensitive information are trimmed by the official ACC JS SDK (headers `x-security-token` and `x-session-token`, session tokens) via `_removeBetween`
+Read the [Architecture & Security documentation](https://myrosblog.com/adobe-campaign/acc-cli-architecture?utm_campaign=readme).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "campaign-cli",
-  "version": "0.7.6",
+  "version": "0.7.8",
   "description": "Save time, reduce risk and improve code health with acc CLI",
   "keywords": [
     "adobe",

package/src/CampaignAuth.js

@@ -19,21 +19,21 @@ class CampaignAuth {
    * Creates a new CampaignAuth instance.
    *
    * @param {Object} sdk - ACC JS SDK instance
-   * @param {Object} config - Configstore instance for persistent storage
-   * @throws {CampaignError} Throws if SDK or config parameters are missing
+   * @param {Object} auth - Configstore instance for persistent storage
+   * @throws {CampaignError} Throws if SDK or auth parameters are missing
    *
    * @example
-   * const auth = new CampaignAuth(sdk, config);
+   * const auth = new CampaignAuth(sdk, auth);
    */
-  constructor(sdk, config) {
-    if (!sdk || !config) {
+  constructor(sdk, auth) {
+    if (!sdk || !auth) {
       throw new CampaignError(
         "SDK and Configstore instances are required to initialize CampaignAuth.",
       );
     }
     this.sdk = sdk;
-    this.config = config;
-    this.instances = config.get(this.INSTANCES_KEY) || {};
+    this.auth = auth;
+    this.instances = auth.get(this.INSTANCES_KEY) || {};
     this.instanceIds = Object.keys(this.instances);
   }
 
@@ -69,7 +69,7 @@ class CampaignAuth {
       );
     }
     const { alias, host, user, password } = options;
-    this.config.set(`${this.INSTANCES_KEY}.${alias}`, { host, user, password });
+    this.auth.set(`${this.INSTANCES_KEY}.${alias}`, { host, user, password });
     console.log(`✅ Instance ${alias} added successfully.`);
     return this.login(options);
   }
@@ -87,7 +87,7 @@ class CampaignAuth {
    */
   async login(options) {
     const { host, user, password } =
-      this.config.get(`instances.${options.alias}`) || {};
+      this.auth.get(`instances.${options.alias}`) || {};
     if (!host || !user || !password) {
       throw new CampaignError(
         `Authentication with alias "${options.alias}" doesn't exist. Use "acc auth list" to see all configured instances.`,
@@ -117,7 +117,8 @@ class CampaignAuth {
    * auth.list(); // Lists all configured instances
    */
   list() {
-    console.log(`📚 Reading ${this.instanceIds.length} instance(s)`);
+    console.log(`📚 Reading from authentication file ${this.auth.path} `);
+    console.log(`📚 Listing ${this.instanceIds.length} instance(s)`);
     if(this.instanceIds.length === 0) {
       console.log(`  No instances configured yet. Use "campaign auth init" to add an instance.`);
       return;

package/src/CampaignInstance.js

@@ -38,11 +38,12 @@ class CampaignInstance {
    *   { schemaId: "nms:recipient", filename: "recipient_%name%.xml" }
    * ]});
    */
-  constructor(client, accConfig, options = { verbose: false }) {
+  constructor(client, accConfig, options) {
     this.client = client;
     this.accConfig = accConfig;
     this.verbose = options.verbose;
     this.downloadPath = options.path;
+    this.metadata = options.metadata;
     /**
      * Array of schema names to process (excluding default config)
      * @type {string[]}
@@ -99,6 +100,14 @@ class CampaignInstance {
     );
 
     for (const schemaConfig of this.accConfig.schemas) {
+      // skip if metadata option was included and not matching
+      if (this.metadata && !this.metadata.includes(schemaConfig.schemaId)) {
+        if (this.verbose) {
+          this.log(`Skipping ${schemaConfig.schemaId}`);
+        }
+        continue;
+      }
+      // downalod and parse
       const lineCount = schemaConfig.queryDef?.lineCount || 10;
       let startLine = 1;
       let recordsLengthTotal = 0;

package/src/main.js

@@ -22,17 +22,16 @@ const defaultConfigPath = path.join(process.cwd(), "acc.config.json"); // defaul
 
 const vAcc = packageJson.version;
 const vSdk = sdk.getSDKVersion().version;
-const pathConfig = "config.path";
-console.log(
-  `🏠 acc ${vAcc} initialized with Adobe acc-js-sdk ${vSdk} and authentication from ${pathConfig}`,
+console.log(`🏠 acc ${vAcc} initialized with @adobe/acc-js-sdk ${vSdk}`);
+// blog post tracking
+const homepage = packageJson.homepage.replace(
+  "utm_campaign=package-json",
+  "utm_campaign=acc-cli",
 );
-const homepage = packageJson.homepage.replace('utm_campaign=package-json', 'utm_campaign=acc-cli')
 
 program
   .name("acc")
-  .description(
-    `${packageJson.description}. Documentation on ${homepage}`,
-  )
+  .description(`${packageJson.description}. Documentation on ${homepage}`)
   .version(vAcc);
 
 // AUTH
@@ -51,7 +50,7 @@ program
         "URL of Adobe Campaign root, e.g. http://localhost:8080",
       )
       .requiredOption("--user <user>", "Operator username")
-      .requiredOption("--password <pwd>", "Operator password")
+      .requiredOption("--pass <pwd>", "Operator password")
       .action(async (options) => {
         try {
           await auth.init(options);
@@ -118,6 +117,10 @@ program
         "Path to the configuration file. Defaults ./config/acc.config.json.",
         defaultConfigPath,
       )
+      .option(
+        "--metadata <schemasIds>",
+        "Comma-separated list of schema ids to retrieve, e.g. nms:delivery,nms:operation",
+      )
       .option(
         "--verbose",
         "Verbose output with details on each configuration item. Defaults to false.",