proca 2.1.0 → 2.2.0

package/README.md

@@ -119,13 +119,13 @@ you should also use the local proca-api in your [widget generator](https://githu
 ```
 USAGE
   $ proca action add [ID_NAME_DXID...] -i <value> --firstname <value> --email <value>
-    [--json | --csv | --markdown] [--env <value>] [--simplify] [-x <value>] [-n <the_short_name>] [--testing] [--optin]
+    [--json | --csv | --markdown] [--env <value>] [--simplify] [-n <the_short_name>] [-x <value>] [--testing] [--optin]
     [--action_type <value>] [--lastname <value>] [--street <value>] [--locality <value>] [--region <value>] [--country
     <value>] [--utm <value>] [--target <value>] [--subject <value>] [--body <value>]
 
 FLAGS
   -i, --id=<value>             (required) widget's id
-  -n, --name=<the_short_name>  name
+  -n, --name=<the_short_name>  name (technical short name, also called slug)
   -x, --dxid=<value>           dxid
       --action_type=<value>    [default: register]
       --body=<value>           [mtt] body of the email
@@ -196,7 +196,7 @@ USAGE
 
 FLAGS
   -i, --id=<value>
-  -n, --name=<the_short_name>  name
+  -n, --name=<the_short_name>  name (technical short name, also called slug)
   -x, --dxid=<value>           dxid
       --env=<value>            [default: default] allow to switch between configurations (server or users)
 
@@ -371,7 +371,7 @@ USAGE
 
 FLAGS
   -i, --id=<value>
-  -n, --name=<the_short_name>   name
+  -n, --name=<the_short_name>   name (technical short name, also called slug)
   -o, --org=<org name>          organization for the new campaign (defaults to source campaign org)
   -t, --to=<campaign name>      (required) new campaign name
   -x, --dxid=<value>            dxid
@@ -405,7 +405,7 @@ USAGE
 
 FLAGS
   -i, --id=<value>
-  -n, --name=<the_short_name>  name
+  -n, --name=<the_short_name>  name (technical short name, also called slug)
   -x, --dxid=<value>           dxid
       --env=<value>            [default: default] allow to switch between configurations (server or users)
 
@@ -439,7 +439,7 @@ USAGE
 
 FLAGS
   -i, --id=<value>
-  -n, --name=<the_short_name>  name
+  -n, --name=<the_short_name>  name (technical short name, also called slug)
   -x, --dxid=<value>           dxid
       --[no-]config            display the config
       --env=<value>            [default: default] allow to switch between configurations (server or users)
@@ -466,13 +466,13 @@ list all the campaigns
 ```
 USAGE
   $ proca campaign list [--json | --csv | --markdown] [--env <value>] [--simplify] [-n
-    <the_short_name>] [-t <campaign title>...] [--stats]
+    <name of the organisation>] [-t <campaign title>...] [--stats]
 
 FLAGS
-  -n, --name=<the_short_name>      name of the organisation
-  -t, --title=<campaign title>...  name of the campaign
-      --env=<value>                [default: default] allow to switch between configurations (server or users)
-      --[no-]stats                 display the stats
+  -n, --name=<name of the organisation>  name (technical short name, also called slug)
+  -t, --title=<campaign title>...        name of the campaign
+      --env=<value>                      [default: default] allow to switch between configurations (server or users)
+      --[no-]stats                       display the stats
 
 OUTPUT FLAGS
   --csv            Format output as csv
@@ -496,7 +496,7 @@ USAGE
 
 FLAGS
   -i, --id=<value>
-  -n, --name=<the_short_name>  name
+  -n, --name=<the_short_name>  name (technical short name, also called slug)
   -x, --dxid=<value>           dxid
       --cc=<value>             comma-separated list of CC email addresses
       --drip                   drip delivery or deliver as fast as possible
@@ -559,7 +559,7 @@ USAGE
 
 FLAGS
   -i, --id=<value>
-  -n, --name=<the_short_name>  name
+  -n, --name=<the_short_name>  name (technical short name, also called slug)
   -s, --suffix=<suffix>        [default: _archive] custom suffix to append (default: _archive)
   -x, --dxid=<value>           dxid
       --dry-run                preview changes without executing
@@ -593,7 +593,7 @@ USAGE
 
 FLAGS
   -i, --id=<value>
-  -n, --name=<the_short_name>  name
+  -n, --name=<the_short_name>  name (technical short name, also called slug)
   -s, --suffix=<suffix>        [default: _archive] suffix to remove from widget names (e.g., _archive, -v1)
   -t, --to=<campaign name>     (required) destination campaign name
   -x, --dxid=<value>           dxid
@@ -630,7 +630,7 @@ USAGE
 
 FLAGS
   -i, --id=<value>
-  -n, --name=<the_short_name>  name
+  -n, --name=<the_short_name>  name (technical short name, also called slug)
   -x, --dxid=<value>           dxid
       --env=<value>            [default: default] allow to switch between configurations (server or users)
 
@@ -655,7 +655,7 @@ USAGE
 
 FLAGS
   -i, --id=<value>
-  -n, --name=<the_short_name>  name
+  -n, --name=<the_short_name>  name (technical short name, also called slug)
   -x, --dxid=<value>           dxid
       --env=<value>            [default: default] allow to switch between configurations (server or users)
 
@@ -915,7 +915,7 @@ USAGE
 
 FLAGS
   -i, --id=<value>
-  -n, --name=<the_short_name>  name
+  -n, --name=<the_short_name>  name (technical short name, also called slug)
   -x, --dxid=<value>           dxid
       --env=<value>            [default: default] allow to switch between configurations (server or users)
 
@@ -934,18 +934,19 @@ EXAMPLES
 
 ## `proca contact count`
 
-counter of supporters
+counter of supporters of a campaign
 
 ```
 USAGE
   $ proca contact count [ID_NAME_DXID] [--json | --csv | --markdown] [--env <value>]
-    [--simplify] [-i <value> | -n <the_short_name> | -x <value>]
+    [--simplify] [-i <value> | -n <campaign> | -x <value>] [--query]
 
 FLAGS
   -i, --id=<value>
-  -n, --name=<the_short_name>  name
-  -x, --dxid=<value>           dxid
-      --env=<value>            [default: default] allow to switch between configurations (server or users)
+  -n, --name=<campaign>  name (technical short name, also called slug)
+  -x, --dxid=<value>     dxid
+      --env=<value>      [default: default] allow to switch between configurations (server or users)
+      --query            display the REST api query
 
 OUTPUT FLAGS
   --csv            Format output as csv
@@ -954,7 +955,7 @@ OUTPUT FLAGS
   --[no-]simplify  flatten and filter to output only the most important attributes, mostly relevant for json
 
 DESCRIPTION
-  counter of supporters
+  counter of supporters of a campaign
 
 EXAMPLES
   $ proca contact count --name <name of the campaign>
@@ -1095,7 +1096,8 @@ USAGE
 
 FLAGS
   -i, --id=<value>
-  -n, --name=<the_short_name>                                                       name
+  -n, --name=<the_short_name>                                                       name (technical short name, also
+                                                                                    called slug)
   -x, --dxid=<value>                                                                dxid
       --env=<value>                                                                 [default: default] allow to switch
                                                                                     between configurations (server or
@@ -1847,7 +1849,7 @@ USAGE
 
 FLAGS
   -i, --id=<value>
-  -n, --name=<the_short_name>  name
+  -n, --name=<the_short_name>  name (technical short name, also called slug)
   -x, --dxid=<value>           dxid
       --env=<value>            [default: default] allow to switch between configurations (server or users)
 
@@ -1872,7 +1874,7 @@ USAGE
 
 FLAGS
   -i, --id=<value>
-  -n, --name=<the_short_name>  name
+  -n, --name=<the_short_name>  name (technical short name, also called slug)
   -x, --dxid=<value>           dxid
       --[no-]config            display the config
       --env=<value>            [default: default] allow to switch between configurations (server or users)
@@ -1926,7 +1928,7 @@ USAGE
 
 FLAGS
   -i, --id=<value>
-  -n, --name=<the_short_name>  name
+  -n, --name=<the_short_name>  name (technical short name, also called slug)
   -x, --dxid=<value>           dxid
       --env=<value>            [default: default] allow to switch between configurations (server or users)
 
@@ -1962,7 +1964,7 @@ USAGE
 FLAGS
   -i, --id=<value>
   -l, --locale=<locale>        change the locale
-  -n, --name=<the_short_name>  name
+  -n, --name=<the_short_name>  name (technical short name, also called slug)
   -x, --dxid=<value>           dxid
       --color=<hex code>       update color (not yet implemented)
       --confirm-action         add actionConfirm (check email snack) to consent.email component
@@ -1980,8 +1982,6 @@ DESCRIPTION
   Update a widget's properties
 
 EXAMPLES
-  $ proca widget update -i 42 --rename campaign/new_name
-
   $ proca widget update -name campaign/widget --locale fr
 
   $ proca widget update 42 --confirm-optin
@@ -2000,7 +2000,7 @@ USAGE
 
 FLAGS
   -i, --id=<value>
-  -n, --name=<the_short_name>  name
+  -n, --name=<the_short_name>  name (technical short name, also called slug)
   -t, --total=<value>          (required) new total to include
   -x, --dxid=<value>           dxid
       --env=<value>            [default: default] allow to switch between configurations (server or users)
@@ -2029,7 +2029,7 @@ USAGE
 
 FLAGS
   -i, --id=<value>
-  -n, --name=<the_short_name>  name
+  -n, --name=<the_short_name>  name (technical short name, also called slug)
   -x, --dxid=<value>           dxid
       --env=<value>            [default: default] allow to switch between configurations (server or users)
       --rename=<widget name>   new name for the widget

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "proca",
   "description": "Access the proca api",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "author": "Xavier",
   "bin": {
     "proca": "proca-cli"

package/src/commands/campaign/widget/archive.mjs

@@ -2,7 +2,7 @@ import { Flags } from "@oclif/core";
 import prompts from "prompts";
 import CampaignGet from "#src/commands/campaign/get.mjs";
 import WidgetList from "#src/commands/widget/list.mjs";
-import WidgetUpdate from "#src/commands/widget/update.mjs";
+import WidgetUpdate from "#src/commands/widget/update/index.mjs";
 import Command from "#src/procaCommand.mjs";
 
 export default class CampaignWidgetArchive extends Command {

package/src/commands/contact/count.mjs

@@ -1,9 +1,11 @@
-import { Args, Flags } from "@oclif/core";
+import { Flags } from "@oclif/core";
+import { getCampaign } from "#src/commands/campaign/get.mjs";
 import Command from "#src/procaCommand.mjs";
+
 import { gql, query } from "#src/urql.mjs";
 
 export default class CounterGet extends Command {
-  static description = "counter of supporters";
+  static description = "counter of supporters of a campaign";
 
   static examples = [
     "<%= config.bin %> <%= command.id %> --name <name of the campaign>",
@@ -12,10 +14,28 @@ export default class CounterGet extends Command {
   static args = this.multiid();
   static flags = {
     // flag with no value (-f, --force)
-    ...this.flagify({ multiid: true }),
+    ...this.flagify({ multiid: true, name: "campaign" }),
+    query: Flags.boolean({
+      description: "display the REST api query",
+      default: false,
+    }),
   };
 
-  fetch = async (params) => {
+  getMinifiedDoc = (id) => {
+    const query = `{
+    campaign(id: ${id}) {
+      stats {
+        supporterCount
+      }
+    }
+  }`;
+    return query
+      .replace(/\s*([{}():,])\s*/g, "$1")
+      .replace(/\s+/g, " ")
+      .trim();
+  };
+
+  getDoc = () => {
     const GetCounterDocument = gql`
       query GetCounter($name: String, $id: Int) {
         campaign(name: $name, id: $id) {
@@ -25,6 +45,11 @@ export default class CounterGet extends Command {
         }
       }
     `;
+    return GetCounterDocument;
+  };
+
+  fetch = async (params) => {
+    const GetCounterDocument = this.getDoc();
     const result = await query(GetCounterDocument, params);
     return result.campaign.stats;
   };
@@ -34,7 +59,16 @@ export default class CounterGet extends Command {
   };
 
   async run() {
-    const { args, flags } = await this.parse();
+    const { flags } = await this.parse();
+    if (flags.query) {
+      const camp = await getCampaign(flags);
+      const query = this.getMinifiedDoc(camp.id);
+      return this.output({
+        api: query,
+        url: `${this.procaConfig.url}?query=${encodeURIComponent(query)}`,
+      });
+    }
+
     const data = await this.fetch(flags);
     return this.output(data);
   }

package/src/commands/widget/get.mjs

@@ -10,7 +10,6 @@ export const getWidget = (params) => {
 
 export default class WidgetGet extends Command {
   static description = "view a widget";
-
   static args = this.multiid();
 
   static flags = {

package/src/commands/widget/update/external.mjs

@@ -2,6 +2,11 @@ import { Flags } from "@oclif/core";
 import Command from "#src/procaCommand.mjs";
 import { gql, mutation } from "#src/urql.mjs";
 
+export const updateCounter = (id, counter) => {
+  const d = new CounterUpdate([]);
+  return d.updateCounter(id, counter);
+};
+
 export default class CounterUpdate extends Command {
   static description =
     "Update the global counter to add the actions collected elsewhere";

package/src/commands/widget/{update.mjs → update/index.mjs}

@@ -6,9 +6,7 @@ import { gql, mutation } from "#src/urql.mjs";
 
 export default class WidgetUpdate extends Command {
   static description = "Update a widget's properties";
-
   static examples = [
-    "<%= config.bin %> <%= command.id %> -i 42 --rename campaign/new_name",
     "<%= config.bin %> <%= command.id %> -name campaign/widget --locale fr",
     "<%= config.bin %> <%= command.id %> 42 --confirm-optin",
     "<%= config.bin %> <%= command.id %> --dxid=pnc -confirm-optin --dry-run",
@@ -16,8 +14,8 @@ export default class WidgetUpdate extends Command {
 
   static args = this.multiid();
 
+  // @ivana, let's make separate update xxx than inherit, check external
   static flags = {
-    // flag with no value (-f, --force)
     ...this.flagify({ multiid: true }),
     rename: Flags.string({
       hidden: true, // use proca widget update name instead

package/src/commands/widget/update/name.mjs

@@ -1,6 +1,6 @@
 import { Flags } from "@oclif/core";
 import { getWidget } from "#src/commands/widget/get.mjs";
-import UpdateCommand from "#src/commands/widget/update.mjs";
+import UpdateCommand from "#src/commands/widget/update/index.mjs";
 
 export default class CounterUpdate extends UpdateCommand {
   static description = "Update the name of a widget";

package/src/procaCommand.mjs

@@ -44,23 +44,23 @@ class ProcaCommand extends Command {
         ignoreStdin: true,
         hidden: true,
         description:
-          "it's better to use -i <id> or -x <dxid> or -n <name>, but you can for convenience",
+          "convenience, but try to use -i <id> or -x <dxid> or -n <name> instead",
       }),
     };
     return args;
   }
 
-  static flagify(params = {}) {
+  static flagify({ multiid = false, name = false } = {}) {
     const flags = Object.assign({}, ProcaCommand.baseFlags);
-    if (params.name) {
+    if (name || multiid) {
       flags.name = Flags.string({
         char: "n",
-        charAliases: ["o"],
-        description: typeof params.name === "string" ? params.name : "name",
-        helpValue: "<the_short_name>",
+        description: "name (technical short name, also called slug)",
+        helpValue: typeof name === "string" ? `<${name}>` : "<the_short_name>",
+        parse: (input) => ProcaCommand.safeName(input),
       });
     }
-    if (params.multiid) {
+    if (multiid) {
       flags.id = Flags.string({
         char: "i",
         parse: (input) => Number.parseInt(input, 10),
@@ -70,15 +70,18 @@ class ProcaCommand extends Command {
         char: "x",
         description: "dxid",
       });
-      flags.name = Flags.string({
-        char: "n",
-        description: "name",
-        helpValue: "<the_short_name>",
-      });
     }
     return flags;
   }
 
+  static safeName = (input) => {
+    const pattern = /^[a-zA-Z0-9\-_]+$/;
+    if (!pattern.test(input)) {
+      throw new Error(`Invalid characters in: ${input}`);
+    }
+    return input;
+  };
+
   async parse() {
     const parsed = await super.parse();
     if (this.ctor.args.id_name_dxid === undefined) {
@@ -86,9 +89,20 @@ class ProcaCommand extends Command {
     }
     const maybe = parsed.args.id_name_dxid;
     if (maybe) {
+      const identified = [
+        parsed.flags.name,
+        parsed.flags.id,
+        parsed.flags.dxid,
+      ].filter(Boolean).length;
+
+      if (identified > 0) {
+        super.error("can't have --name, --id, or --dxid and an unamed arg", {
+          code: 1,
+        });
+      }
       const d = dxid(maybe, false);
       if (d) parsed.flags.id = d;
-      else parsed.flags.name = maybe;
+      else parsed.flags.name = ProcaCommand.safeName(maybe);
     }
     if (parsed.flags.dxid) {
       parsed.flags.id = dxid(parsed.flags.dxid);
@@ -100,10 +114,11 @@ class ProcaCommand extends Command {
     ].filter(Boolean).length;
 
     if (identified === 0) {
-      this.error("One of --name, --id, or --dxid is required");
+      super.error("One of --name, --id, or --dxid is required", {
+        code: 1,
+      });
     }
 
-    await super.parse(); // check that either the first arg or the name/id/dxid are set
     return parsed;
   }
 
@@ -143,14 +158,14 @@ class ProcaCommand extends Command {
 
     if (err.networkError) {
       this.info("Looks like there’s a problem with your internet connection");
-      this.error(err.networkError.cause, { exit: err.exitCode || 1 });
+      this.error(err.networkError.cause, { exit: err.code || 1 });
     }
     if (err instanceof SyntaxError) {
-      this.error(`Syntax error: ${err.message}`, { exit: 1 });
+      this.error(`Syntax error: ${err.message}`, { code: 1 });
     }
 
     // Default error handling
-    this.error(err.message, { exit: err.exitCode || 1 });
+    this.error(err.message, { exit: err.code || 1 });
   }
 
   flatten = (obj, prefix = "", result = {}) => {