proca 2.5.0 → 2.5.1

package/README.md

@@ -48,7 +48,6 @@ you should also use the local proca-api in your [widget generator](https://githu
 
 <!-- commands -->
 * [`proca action add`](#proca-action-add)
-* [`proca action add mtt`](#proca-action-add-mtt)
 * [`proca action confirm`](#proca-action-confirm)
 * [`proca action count`](#proca-action-count)
 * [`proca action list [TITLE]`](#proca-action-list-title)
@@ -126,8 +125,8 @@ 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] [-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>]
+    [--action_type <value>] [--lastname <value>] [--street <value>] [--locality <value>] [--region <value>] [--postcode
+    <value>] [--country <value>] [--utm <value>] [--target <value>] [--subject <value>] [--body <value>]
 
 FLAGS
   -i, --id=<value>             (required) widget's id
@@ -143,6 +142,7 @@ FLAGS
   --locality=<value>
       --[no-]optin             Whether the user opts in (default: false). Use --optin to enable or --no-optin to
                                explicitly disable.
+  --postcode=<value>
   --region=<value>
   --street=<value>
       --subject=<value>        [mtt] subject of the email
@@ -164,50 +164,6 @@ EXAMPLES
   $ proca action add -i <widget_id> --firstname=John --email=john@example.org target=715a9580-cfe6-4005-9e23-61a62ddecfea --subject='MTT subject' --body='message MTT'
 ```
 
-## `proca action add mtt`
-
-```
-USAGE
-  $ proca action add mtt [ID_NAME_DXID...] -i <value> --firstname <value> --email <value>
-    [--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 (technical short name, also called slug)
-  -x, --dxid=<value>           dxid
-      --action_type=<value>    [default: email]
-      --body=<value>           [mtt] body of the email
-      --country=<value>        2-letter country iso code
-      --email=<value>          (required) email
-      --env=<value>            [default: default] allow to switch between configurations (server or users)
-      --firstname=<value>      (required) supporter's firstname
-  --lastname=<value>
-  --locality=<value>
-      --[no-]optin             Whether the user opts in (default: false). Use --optin to enable or --no-optin to
-                               explicitly disable.
-  --region=<value>
-  --street=<value>
-      --subject=<value>        [mtt] subject of the email
-      --target=<value>         [mtt] uid of the target
-      --[no-]testing           Run action in testing mode (default: true). Use --no-testing to disable.
-      --utm=<value>            utm=campaign.source.medium
-
-OUTPUT FLAGS
-  --csv            Format output as csv
-  --json           Format output as json
-  --markdown       Format output as markdown table
-  --[no-]simplify  flatten and filter to output only the most important attributes, mostly relevant for json
-
-EXAMPLES
-  $ proca action add mtt -i <widget_id> --firstname=John --email=john@example.org
-
-  $ proca action add mtt -i <widget_id> --firstname=John --email=john@example.org --country=FR custom1=A custom2=B
-
-  $ proca action add mtt -i <widget_id> --firstname=John --email=john@example.org target=715a9580-cfe6-4005-9e23-61a62ddecfea --subject='MTT subject' --body='message MTT'
-```
-
 ## `proca action confirm`
 
 Should the supporter confirm the action? it can be set either for all the widgets or an organisation or all the widgets of a campaign
@@ -1206,6 +1162,15 @@ OUTPUT FLAGS
 
 DESCRIPTION
   Set email service and supporter confirmation for an org
+
+EXAMPLES
+  $ proca org email myorg --mailer=ses --from=hello@example.com
+
+  $ proca org email myorg --mailer=mailjet
+
+  $ proca org email myorg --supporter-confirm --supporter-confirm-template=confirm_v2
+
+  $ proca org email myorg --no-supporter-confirm
 ```
 
 ## `proca org get`
@@ -1268,7 +1233,7 @@ EXAMPLES
   $ proca org logo <name of the ngo>
 ```
 
-_See code: [src/commands/org/logo.ts](https://github.com/fixthestatusquo/proca-cli/blob/v2.5.0/src/commands/org/logo.ts)_
+_See code: [src/commands/org/logo.ts](https://github.com/fixthestatusquo/proca-cli/blob/v2.5.1/src/commands/org/logo.ts)_
 
 ## `proca org user get`
 
@@ -1782,14 +1747,14 @@ let a user join an organisation with a role
 ```
 USAGE
   $ proca user join [ID_NAME_DXID] [--json | --csv | --markdown] [--env <value>]
-    [--simplify] [-n <org>] [--role owner|campaigner|coordinator|translator] [-u <user email>]
+    [--simplify] [-n <org>] [-r owner|campaigner|coordinator|translator] [-u <user email>]
 
 FLAGS
   -n, --name=<org>         name (technical short name, also called slug)
+  -r, --role=<option>      [default: campaigner] permission level in that org
+                           <options: owner|campaigner|coordinator|translator>
   -u, --user=<user email>  email, default current user
       --env=<value>        [default: default] allow to switch between configurations (server or users)
-      --role=<option>      [default: campaigner] permission level in that org
-                           <options: owner|campaigner|coordinator|translator>
 
 OUTPUT FLAGS
   --csv            Format output as csv
@@ -2050,7 +2015,7 @@ EXAMPLES
   $ proca widget external cron
 ```
 
-_See code: [src/commands/widget/external/cron.ts](https://github.com/fixthestatusquo/proca-cli/blob/v2.5.0/src/commands/widget/external/cron.ts)_
+_See code: [src/commands/widget/external/cron.ts](https://github.com/fixthestatusquo/proca-cli/blob/v2.5.1/src/commands/widget/external/cron.ts)_
 
 ## `proca widget get`
 

package/package.json

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

package/src/commands/action/add.mjs

@@ -1,8 +1,16 @@
-import { Args, Flags } from "@oclif/core";
-import { error, stdout, ux } from "@oclif/core/ux";
+import { Flags } from "@oclif/core";
 import Command from "#src/procaCommand.mjs";
 import { gql, mutation } from "#src/urql.mjs";
-import { getTwitter } from "#src/util/twitter.mjs";
+
+export const addAction = async (params) => {
+  const d = new ActionAdd([]);
+  if (params.utm) {
+    const [campaign, source, medium] = params.utm.split(".");
+    params.tracking = { source, medium, campaign };
+  } else params.tracking = {};
+  const data = await d.create(params);
+  return data;
+};
 
 export default class ActionAdd extends Command {
   static examples = [
@@ -44,6 +52,7 @@ export default class ActionAdd extends Command {
     street: Flags.string(),
     locality: Flags.string(),
     region: Flags.string(),
+    postcode: Flags.string(),
     country: Flags.string({
       description: "2-letter country iso code",
       parse: async (input) => {
@@ -116,7 +125,6 @@ export default class ActionAdd extends Command {
       };
       values.action.actionType = "mail2target";
     }
-    console.log(values.action.mtt);
 
     const query = gql`
  mutation (
@@ -139,11 +147,9 @@ export default class ActionAdd extends Command {
     firstName
   }
 }`;
-
     const result = await mutation(query, values);
 
-    console.log("result", result);
-    return result;
+    return result.addActionContact;
   };
 
   parseUnknownFlags = (argv) => {
@@ -151,20 +157,6 @@ export default class ActionAdd extends Command {
       const chars = def.char ? [def.char] : [];
       return [key, ...chars];
     });
-    /* doesn't work static=false has no effect    const unknownFlags = Object.fromEntries(
-      argv
-        .filter(arg =>
-          (/^--?\w+=/.test(arg)) // --key=val or -x=val
-        )
-        .map(arg => {
-          const keyval = arg.replace(/^-+/, '').split('=')
-          return [keyval[0], keyval[1]]
-        })
-        .filter(([key]) => !knownFlags.includes(key))
-    )
-*/
-
-    // Extract key=val style positional args (e.g. foo=bar)
     const kvArgs = Object.fromEntries(
       argv
         .filter((arg) => !arg.startsWith("-") && arg.includes("="))
@@ -175,6 +167,7 @@ export default class ActionAdd extends Command {
 
     return kvArgs;
   };
+
   async run() {
     const { args, flags } = await this.parse(ActionAdd, {
       context: { strict: false /* this does not work*/ },

package/src/commands/org/email.mjs

@@ -18,6 +18,13 @@ export default class OrgEmail extends Command {
   static description =
     "Set email service and supporter confirmation for an org";
 
+  static examples = [
+    "<%= config.bin %> <%= command.id %> myorg --mailer=ses --from=hello@example.com",
+    "<%= config.bin %> <%= command.id %> myorg --mailer=mailjet",
+    "<%= config.bin %> <%= command.id %> myorg --supporter-confirm --supporter-confirm-template=confirm_v2",
+    "<%= config.bin %> <%= command.id %> myorg --no-supporter-confirm",
+  ];
+
   static args = this.multiid();
 
   static flags = {

package/src/commands/user/join.mjs

@@ -14,6 +14,7 @@ export default class UserJoinOrg extends Command {
     // flag with no value (-f, --force)
     ...this.flagify({ multiid: false, name: "org", char: "o" }),
     role: Flags.string({
+      char: "r",
       description: "permission level in that org",
       default: "campaigner",
       options: ["owner", "campaigner", "coordinator", "translator"],

package/src/commands/action/add/mtt.mjs

@@ -1,192 +0,0 @@
-import { Args, Flags } from "@oclif/core";
-import { error, stdout, ux } from "@oclif/core/ux";
-import Command from "#src/procaCommand.mjs";
-import { gql, mutation } from "#src/urql.mjs";
-import { getTwitter } from "#src/util/twitter.mjs";
-
-export default class ActionAdd extends Command {
-  static examples = [
-    "<%= config.bin %> <%= command.id %> -i <widget_id> --firstname=John --email=john@example.org",
-    "<%= config.bin %> <%= command.id %> -i <widget_id> --firstname=John --email=john@example.org --country=FR custom1=A custom2=B",
-    "<%= config.bin %> <%= command.id %> -i <widget_id> --firstname=John --email=john@example.org target=715a9580-cfe6-4005-9e23-61a62ddecfea --subject='MTT subject' --body='message MTT'",
-  ];
-
-  static args = this.multiid();
-  static strict = false; //THIS DOES NOT WORK
-
-  static flags = {
-    ...this.flagify({ multiid: true }),
-    id: Flags.integer({
-      char: "i",
-      description: "widget's id",
-      required: true,
-    }),
-    testing: Flags.boolean({
-      default: true,
-      allowNo: true, // ✅ enables --no-testing
-      description:
-        "Run action in testing mode (default: true). Use --no-testing to disable.",
-    }),
-    optin: Flags.boolean({
-      default: false,
-      allowNo: true, // ✅ enables --no-optin
-      description:
-        "Whether the user opts in (default: false). Use --optin to enable or --no-optin to explicitly disable.",
-    }),
-    action_type: Flags.string({
-      default: "email",
-    }),
-    firstname: Flags.string({
-      description: "supporter's firstname",
-      required: true,
-    }),
-    lastname: Flags.string(),
-    street: Flags.string(),
-    locality: Flags.string(),
-    region: Flags.string(),
-    country: Flags.string({
-      description: "2-letter country iso code",
-      parse: async (input) => {
-        if (input && !/^[A-Za-z]{2}$/.test(input)) {
-          throw new Error("Country code must be exactly 2 letters");
-        }
-        return input?.toUpperCase(); // optional: normalize to uppercase
-      },
-    }),
-    utm: Flags.string({
-      description: "utm=campaign.source.medium",
-    }),
-    email: Flags.string({
-      description: "email",
-      required: true,
-    }),
-    target: Flags.string({ description: "[mtt] uid of the target" }),
-    subject: Flags.string({ description: "[mtt] subject of the email" }),
-    body: Flags.string({ description: "[mtt] body of the email" }),
-  };
-
-  create = async (flags) => {
-    const values = {
-      action: {
-        actionType: flags.action_type,
-        customFields: flags.customFields,
-        /*    "mtt": {
-      "body": "body",
-      "files": [
-        "files"
-      ],
-      "subject": "subject",
-      "targets": [
-        "targets"
-      ]
-    },
-*/
-        testing: flags.testing,
-      },
-      actionPageId: flags.id,
-      contact: {
-        address: {
-          country: flags.country,
-          locality: flags.locality,
-          postcode: flags.postcode,
-          region: flags.region,
-          street: flags.street,
-          //      "streetNumber": "streetNumber"
-        },
-        email: flags.email,
-        firstName: flags.firstname,
-        lastName: flags.lastname,
-        phone: flags.phone,
-      },
-      privacy: {
-        //    "leadOptIn": true,
-        optIn: flags.optin,
-      },
-      tracking: {
-        ...flags.tracking,
-        location: "proca-cli/action/add",
-      },
-    };
-
-    if (flags.target) {
-      values.action.mtt = {
-        targets: [flags.target],
-        subject: flags.subject || "Test MTT",
-        body: flags.body || "Please ignore, this is a test",
-      };
-      values.action.actionType = "mail2target";
-    }
-    console.log(values.action.mtt);
-
-    const query = gql`
- mutation (
-  $action: ActionInput!
-  $actionPageId: Int!
-  $contact: ContactInput!
-  $contactRef: ID
-  $privacy: ConsentInput!
-  $tracking: TrackingInput
-) {
-  addActionContact(
-    action: $action
-    actionPageId: $actionPageId
-    contact: $contact
-    contactRef: $contactRef
-    privacy: $privacy
-    tracking: $tracking
-  ) {
-    contactRef
-    firstName
-  }
-}`;
-
-    const result = await mutation(query, values);
-
-    console.log("result", result);
-    return result;
-  };
-
-  parseUnknownFlags = (argv) => {
-    const knownFlags = Object.entries(ActionAdd.flags).flatMap(([key, def]) => {
-      const chars = def.char ? [def.char] : [];
-      return [key, ...chars];
-    });
-    /* doesn't work static=false has no effect    const unknownFlags = Object.fromEntries(
-      argv
-        .filter(arg =>
-          (/^--?\w+=/.test(arg)) // --key=val or -x=val
-        )
-        .map(arg => {
-          const keyval = arg.replace(/^-+/, '').split('=')
-          return [keyval[0], keyval[1]]
-        })
-        .filter(([key]) => !knownFlags.includes(key))
-    )
-*/
-
-    // Extract key=val style positional args (e.g. foo=bar)
-    const kvArgs = Object.fromEntries(
-      argv
-        .filter((arg) => !arg.startsWith("-") && arg.includes("="))
-        .map((arg) => arg.split("=")),
-    );
-
-    if (!Object.keys(kvArgs).length) return undefined;
-
-    return kvArgs;
-  };
-  async run() {
-    const { args, flags } = await this.parse(ActionAdd, {
-      context: { strict: false /* this does not work*/ },
-    });
-
-    const customFields = this.parseUnknownFlags(this.argv);
-    if (customFields) flags.customFields = JSON.stringify(customFields);
-    if (flags.utm) {
-      const [campaign, source, medium] = flags.utm.split(".");
-      flags.tracking = { source, medium, campaign };
-    } else flags.tracking = {};
-    const data = await this.create(flags);
-    return this.output(data);
-  }
-}