proca 1.8.2 → 1.8.3

package/README.md

@@ -22,12 +22,12 @@ $# if you don't have your API token, generate one
 $ proca user reset --email <your_email> --passowrd <your password>
 $ proca config init --token=<API-token>
 ```
-you can set up the config folder the widget builder will use to store the caches. skip unless you want a different one than the default (your/widget/folder/config). 
 
+you can set up the config folder the widget builder will use to store the caches. skip unless you want a different one than the default (your/widget/folder/config).
 
 ### local development
 
-````sh-session
+```sh-session
    $ git clone https://github.com/fixthestatusquo/proca-cli.git
    $ cd proca-cli
    $ npm install
@@ -35,14 +35,14 @@ you can set up the config folder the widget builder will use to store the caches
    $./proca-cli config add --env=local  --url=http://localhost:4000/api
    $./proca-cli config server --env=local #check if the config is working
    $./proca-cli config user #check if the config is working
-````
+```
 
 you should also use the local proca-api in your [widget generator](https://github.com/fixthestatusquo/proca)
 
-````sh-session
+```sh-session
    $ cd /your/path/to/proca
    $ npm link proca # use the local proca-cli repo
-````
+```
 
 # Commands
 
@@ -55,11 +55,14 @@ you should also use the local proca-api in your [widget generator](https://githu
 * [`proca action requeue`](#proca-action-requeue)
 * [`proca campaign add [TITLE]`](#proca-campaign-add-title)
 * [`proca campaign close`](#proca-campaign-close)
+* [`proca campaign copy`](#proca-campaign-copy)
 * [`proca campaign delete`](#proca-campaign-delete)
 * [`proca campaign get`](#proca-campaign-get)
 * [`proca campaign list [TITLE]`](#proca-campaign-list-title)
 * [`proca campaign mtt`](#proca-campaign-mtt)
 * [`proca campaign status`](#proca-campaign-status)
+* [`proca campaign widget archive`](#proca-campaign-widget-archive)
+* [`proca campaign widget copy`](#proca-campaign-widget-copy)
 * [`proca campaign widget get`](#proca-campaign-widget-get)
 * [`proca campaign widget rebuild`](#proca-campaign-widget-rebuild)
 * [`proca config add [ENV] [HUMAN] [JSON] [CSV] [MARKDOWN] [SIMPLIFY]`](#proca-config-add-env-human-json-csv-markdown-simplify)
@@ -106,6 +109,7 @@ you should also use the local proca-api in your [widget generator](https://githu
 * [`proca widget get`](#proca-widget-get)
 * [`proca widget list`](#proca-widget-list)
 * [`proca widget rebuild`](#proca-widget-rebuild)
+* [`proca widget update`](#proca-widget-update)
 
 ## `proca action add`
 
@@ -362,19 +366,56 @@ EXAMPLES
   $ proca campaign close -i <campaign_id>
 ```
 
+## `proca campaign copy`
+
+Copy campaign settings to a new campaign
+
+```
+USAGE
+  $ proca campaign copy [ID_NAME_DXID] -t <campaign name> [--json | --human | --csv |
+    --markdown] [--env <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>] [-o <org name>] [--title
+    <campaign title>] [--dry-run]
+
+FLAGS
+  -i, --id=<value>
+  -n, --name=<the_short_name>   name
+  -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
+      --dry-run                 preview changes without executing
+      --env=<value>             [default: default] allow to switch between configurations (server or users)
+      --title=<campaign title>  title for the new campaign (defaults to source campaign title)
+
+OUTPUT FLAGS
+  --csv            Format output as csv
+  --human          Format output to be read on screen by a human [default]
+  --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
+
+DESCRIPTION
+  Copy campaign settings to a new campaign
+
+EXAMPLES
+  $ proca campaign copy test_2025 --to test_2026
+
+  $ proca campaign copy -n old_campaign --to new_campaign -o different_org
+```
+
 ## `proca campaign delete`
 
 delete a campaign
 
 ```
 USAGE
-  $ proca campaign delete [--json | --human | --csv | --markdown] [--env <value>]
-    [--simplify] [-i <organisation name>] [-n <campaign name>]
+  $ proca campaign delete [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
+    <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>]
 
 FLAGS
-  -i, --id=<organisation name>  id of the campaign
-  -n, --name=<campaign name>    name of the campaign
-      --env=<value>             [default: default] allow to switch between configurations (server or users)
+  -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)
 
 OUTPUT FLAGS
   --csv            Format output as csv
@@ -387,7 +428,13 @@ DESCRIPTION
   delete a campaign
 
 EXAMPLES
+  $ proca campaign delete 42
+
   $ proca campaign delete -i 42
+
+  $ proca campaign delete my_campaign
+
+  $ proca campaign delete -n my_campaign
 ```
 
 ## `proca campaign get`
@@ -520,6 +567,79 @@ EXAMPLES
   $ proca campaign status -i <campaign_id>
 ```
 
+## `proca campaign widget archive`
+
+Archive all widgets in the campaign by adding suffix
+
+```
+USAGE
+  $ proca campaign widget archive [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
+    <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>] [-s <suffix>] [--dry-run]
+
+FLAGS
+  -i, --id=<value>
+  -n, --name=<the_short_name>  name
+  -s, --suffix=<suffix>        [default: _archive] custom suffix to append (default: _archive)
+  -x, --dxid=<value>           dxid
+      --dry-run                preview changes without executing
+      --env=<value>            [default: default] allow to switch between configurations (server or users)
+
+OUTPUT FLAGS
+  --csv            Format output as csv
+  --human          Format output to be read on screen by a human [default]
+  --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
+
+DESCRIPTION
+  Archive all widgets in the campaign by adding suffix
+
+EXAMPLES
+  $ proca campaign widget archive old_campaign
+
+  $ proca campaign widget archive -n old_campaign --suffix _backup
+
+  $ proca campaign widget archive old_campaign --dry-run
+```
+
+## `proca campaign widget copy`
+
+Copy widgets from one campaign to another
+
+```
+USAGE
+  $ proca campaign widget copy [ID_NAME_DXID] -t <campaign name> [--json | --human | --csv |
+    --markdown] [--env <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>] [-s <suffix>] [--dry-run]
+
+FLAGS
+  -i, --id=<value>
+  -n, --name=<the_short_name>  name
+  -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
+      --dry-run                preview changes without executing
+      --env=<value>            [default: default] allow to switch between configurations (server or users)
+
+OUTPUT FLAGS
+  --csv            Format output as csv
+  --human          Format output to be read on screen by a human [default]
+  --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
+
+DESCRIPTION
+  Copy widgets from one campaign to another
+
+EXAMPLES
+  $ proca campaign widget copy old_campaign --to new_campaign
+
+  $ proca campaign widget copy -n old_campaign --to new_campaign
+
+  $ proca campaign widget copy old_campaign --to new_campaign --suffix _archive
+
+  $ proca campaign widget copy old_campaign --to new_campaign --dry-run
+```
+
 ## `proca campaign widget get`
 
 List widgets in a campaign
@@ -846,8 +966,6 @@ DESCRIPTION
   counter of supporters
 
 EXAMPLES
-  $ proca contact count --id <id of the campaign>
-
   $ proca contact count --name <name of the campaign>
 ```
 
@@ -983,23 +1101,28 @@ EXAMPLES
 
 ## `proca org email`
 
-Set service, usually email backend for an org
+Set email service and supporter confirmation for an org
 
 ```
 USAGE
-  $ proca org email [ID_NAME_DXID] --org <value> --mailer mailjet ses stripe
-    test_stripe system preview webhook supabase smtp [--json | --human | --csv | --markdown] [--env <value>]
-    [--simplify] [--from <value>]
+  $ proca org email [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
+    <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>] [--mailer mailjet ses stripe test_stripe
+    system preview webhook supabase smtp] [--from default <org>@proca.app] [--supporter-confirm]
+    [--supporter-confirm-template <value>]
 
 FLAGS
-  --env=<value>                                                                 [default: default] allow to switch
-                                                                                between configurations (server or users)
-  --from=<value>                                                                Email address to send from (default:
-                                                                                <org>@proca.app)
-  --mailer=mailjet ses stripe test_stripe system preview webhook supabase smtp  (required) [default: MAILJET] service to
-                                                                                send emails
-  --org=<value>                                                                 (required) organisation running the
-                                                                                service
+  -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)
+      --from=default <org>@proca.app                                                Email address to send from
+      --mailer=mailjet ses stripe test_stripe system preview webhook supabase smtp  [default: system] service to send
+                                                                                    emails
+      --[no-]supporter-confirm                                                      enable/disable action confirmation
+                                                                                    emails
+      --supporter-confirm-template=<value>                                          add confirmation template
 
 OUTPUT FLAGS
   --csv            Format output as csv
@@ -1009,7 +1132,7 @@ OUTPUT FLAGS
   --[no-]simplify  flatten and filter to output only the most important attributes, mostly relevant for json
 
 DESCRIPTION
-  Set service, usually email backend for an org
+  Set email service and supporter confirmation for an org
 ```
 
 ## `proca org get`
@@ -1865,4 +1988,46 @@ EXAMPLES
 
   $ proca campaign widget rebuild   Rebuild all the widgets of a campaign
 ```
+
+## `proca widget update`
+
+Update a widget's properties
+
+```
+USAGE
+  $ proca widget update [ID_NAME_DXID] [--json | --human | --csv | --markdown] [--env
+    <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>] [-n <widget name>] [-l <locale>] [--color <hex
+    code>] [--confirm-optin] [--confirm-action] [--dry-run]
+
+FLAGS
+  -i, --id=<value>
+  -l, --locale=<locale>        change the locale
+  -n, --name=<the_short_name>  name
+  -n, --rename=<widget name>   new name for the widget
+  -x, --dxid=<value>           dxid
+      --color=<hex code>       update color (not yet implemented)
+      --confirm-action         add actionConfirm (check email snack) to consent.email component
+      --confirm-optin          add confirmOptIn (check email snack) to consent.email component
+      --dry-run                Show changes without updating the widget
+      --env=<value>            [default: default] allow to switch between configurations (server or users)
+
+OUTPUT FLAGS
+  --csv            Format output as csv
+  --human          Format output to be read on screen by a human [default]
+  --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
+
+DESCRIPTION
+  Update a widget's properties
+
+EXAMPLES
+  $ proca widget update 4454 --name new_widget_name
+
+  $ proca widget update 4454 --locale fr
+
+  $ proca widget update 4454 --confirm-optin
+
+  $ proca widget update 4454 --confirm-optin --dry-run
+```
 <!-- commandsstop -->

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "proca",
   "description": "Access the proca api",
-  "version": "1.8.2",
+  "version": "1.8.3",
   "author": "Xavier",
   "bin": {
     "proca": "proca-cli"
@@ -94,6 +94,7 @@
     "format": "npx @biomejs/biome format --write",
     "lint": "npx @biomejs/biome lint --write",
     "prepack": "oclif manifest && oclif readme",
+    "oclif": "oclif manifest && oclif readme",
     "version": "oclif readme && git add README.md"
   }
 }

package/proca-cli

@@ -1,5 +1,5 @@
-#!/usr/bin/env -S node --trace-warnings
-const url = require('url');
+#!/usr/bin/env -S node
+const url = require('node:url');
 
 (async () => {
   const metaUrl = url.pathToFileURL(__filename).href;  

package/src/commands/action/add.mjs

@@ -5,72 +5,72 @@ 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 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 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: "register",
-		}),
-		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" }),
-	};
+  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: "register",
+    }),
+    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": {
+  create = async (flags) => {
+    const values = {
+      action: {
+        actionType: flags.action_type,
+        customFields: flags.customFields,
+        /*    "mtt": {
       "body": "body",
       "files": [
         "files"
@@ -81,44 +81,44 @@ export default class ActionAdd extends Command {
       ]
     },
 */
-				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",
-			},
-		};
+        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);
+    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`
+    const query = gql`
  mutation (
   $action: ActionInput!
   $actionPageId: Int!
@@ -140,18 +140,18 @@ export default class ActionAdd extends Command {
   }
 }`;
 
-		const result = await mutation(query, values);
+    const result = await mutation(query, values);
 
-		console.log("result", result);
-		return result;
-	};
+    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(
+  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
@@ -164,29 +164,29 @@ export default class ActionAdd extends Command {
     )
 */
 
-		// 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("=")),
-		);
+    // 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;
+    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*/ },
-		});
+    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);
-	}
+    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);
+  }
 }