proca 1.7.2 → 1.7.4

package/README.md

@@ -52,6 +52,7 @@ you should also use the local proca-api in your [widget generator](https://githu
 * [`proca action count`](#proca-action-count)
 * [`proca action list [TITLE]`](#proca-action-list-title)
 * [`proca action replay`](#proca-action-replay)
+* [`proca action requeue`](#proca-action-requeue)
 * [`proca campaign add [TITLE]`](#proca-campaign-add-title)
 * [`proca campaign close`](#proca-campaign-close)
 * [`proca campaign delete`](#proca-campaign-delete)
@@ -90,6 +91,7 @@ you should also use the local proca-api in your [widget generator](https://githu
 * [`proca template add`](#proca-template-add)
 * [`proca template list`](#proca-template-list)
 * [`proca user get`](#proca-user-get)
+* [`proca user invite`](#proca-user-invite)
 * [`proca user join`](#proca-user-join)
 * [`proca user leave`](#proca-user-leave)
 * [`proca user list`](#proca-user-list)
@@ -97,6 +99,7 @@ you should also use the local proca-api in your [widget generator](https://githu
 * [`proca user reset [USER]`](#proca-user-reset-user)
 * [`proca user whoami`](#proca-user-whoami)
 * [`proca widget add`](#proca-widget-add)
+* [`proca widget delete`](#proca-widget-delete)
 * [`proca widget get`](#proca-widget-get)
 * [`proca widget list`](#proca-widget-list)
 
@@ -206,24 +209,24 @@ EXAMPLES
 ```
 USAGE
   $ proca action list [TITLE] -o <organisation name> [--json | --human | --csv] [--env
-    <value>] [-c <campaign title>] [--limit <value>] [--today | --after 2025-04-09] [--optin] [--testing] [--doi] [--utm
+    <value>] [-c <campaign name>] [--limit <value>] [--today | --after 2025-04-09] [--optin] [--testing] [--doi] [--utm
     | --simplify] [--comment | ]
 
 ARGUMENTS
   TITLE  name of the campaign, % for wildchar
 
 FLAGS
-  -c, --campaign=<campaign title>  name of the campaign, % for wildchar
-  -o, --org=<organisation name>    (required) campaigns of the organisation (coordinator or partner)
-      --after=2025-04-09           only actions after a date
-      --[no-]comment               display the comment
-      --doi                        only export the double optin actions
-      --env=<value>                [default: default] allow to switch between configurations (server or users)
-      --limit=<value>              max number of actions
-      --optin                      only export the optin actions
-      --testing                    also export the test actions
-      --today                      only actions today
-      --[no-]utm                   display the utm tracking parameters
+  -c, --campaign=<campaign name>  name of the campaign, % for wildchar
+  -o, --org=<organisation name>   (required) campaigns of the organisation (coordinator or partner)
+      --after=2025-04-09          only actions after a date
+      --[no-]comment              display the comment
+      --doi                       only export the double optin actions
+      --env=<value>               [default: default] allow to switch between configurations (server or users)
+      --limit=<value>             max number of actions
+      --optin                     only export the optin actions
+      --testing                   also export the test actions
+      --today                     only actions today
+      --[no-]utm                  display the utm tracking parameters
 
 OUTPUT FLAGS
   --csv            Format output as csv
@@ -257,6 +260,44 @@ EXAMPLES
   $ proca action replay %pizza%
 ```
 
+## `proca action requeue`
+
+requeue actions
+
+```
+USAGE
+  $ proca action requeue -o <org name> -q
+    CUSTOM_ACTION_CONFIRM|CUSTOM_ACTION_DELIVER|CUSTOM_SUPPORTER_CONFIRM|EMAIL_SUPPORTER|SQS|WEBHOOK [--json | --human |
+    --csv] [--env <value>] [--simplify] [-c <campaign name>] [--limit <value>] [--today | --after 2025-04-09] [--optin]
+    [--testing] [--doi]
+
+FLAGS
+  -c, --campaign=<campaign name>  name of the campaign, % for wildchar
+  -o, --org=<org name>            (required) name of the org
+  -q, --queue=<option>            (required) [default: CUSTOM_ACTION_DELIVER] queue to redeliver to
+                                  <options: CUSTOM_ACTION_CONFIRM|CUSTOM_ACTION_DELIVER|CUSTOM_SUPPORTER_CONFIRM|EMAIL_S
+                                  UPPORTER|SQS|WEBHOOK>
+      --after=2025-04-09          only actions after a date
+      --doi                       only export the double optin actions
+      --env=<value>               [default: default] allow to switch between configurations (server or users)
+      --limit=<value>             [default: 1000] how many actions per page
+      --optin                     only export the optin actions
+      --testing                   also export the test actions
+      --today                     only actions today
+
+OUTPUT FLAGS
+  --csv            Format output as csv
+  --human          Format output to be read on screen by a human [default]
+  --json           Format output as json
+  --[no-]simplify  flatten and filter to output only the most important attributes, mostly relevant for json
+
+DESCRIPTION
+  requeue actions
+
+EXAMPLES
+  $ proca action requeue
+```
+
 ## `proca campaign add [TITLE]`
 
 ```
@@ -1346,6 +1387,35 @@ EXAMPLES
   $ proca user get
 ```
 
+## `proca user invite`
+
+invite a user to join an organisation with a role
+
+```
+USAGE
+  $ proca user invite -o <org name> -u <user email> [--json | --human | --csv] [--env
+    <value>] [--simplify] [--role owner|campaigner|coordinator|translator]
+
+FLAGS
+  -o, --org=<org name>     (required) name of the org
+  -u, --user=<user email>  (required) email
+      --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
+  --human          Format output to be read on screen by a human [default]
+  --json           Format output as json
+  --[no-]simplify  flatten and filter to output only the most important attributes, mostly relevant for json
+
+DESCRIPTION
+  invite a user to join an organisation with a role
+
+EXAMPLES
+  $ proca user invite
+```
+
 ## `proca user join`
 
 let a user join an organisation with a role
@@ -1533,6 +1603,31 @@ OUTPUT FLAGS
   --[no-]simplify  flatten and filter to output only the most important attributes, mostly relevant for json
 ```
 
+## `proca widget delete`
+
+Delete a widget
+
+```
+USAGE
+  $ proca widget delete [ID_NAME_DXID] [--json | --human | --csv] [--env <value>]
+    [--simplify] [-i <value> | -n <the_short_name> | -x <value>]
+
+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)
+
+OUTPUT FLAGS
+  --csv            Format output as csv
+  --human          Format output to be read on screen by a human [default]
+  --json           Format output as json
+  --[no-]simplify  flatten and filter to output only the most important attributes, mostly relevant for json
+
+DESCRIPTION
+  Delete a widget
+```
+
 ## `proca widget get`
 
 view a widget

package/package.json

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

package/src/commands/action/list.mjs

@@ -30,7 +30,7 @@ export default class List extends Command {
 		campaign: Flags.string({
 			char: "c",
 			description: "name of the campaign, % for wildchar",
-			helpValue: "<campaign title>",
+			helpValue: "<campaign name>",
 		}),
 		limit: Flags.string({
 			description: "max number of actions",

package/src/commands/action/replay.mjs

@@ -48,6 +48,8 @@ options: [
 		const { args, flags } = await this.parse();
 		let data = [];
 		const ids = [];
+		this.fatal("not implemented yet");
+		process.exit(1);
 		data = await this.mutate(flags.org, ids, flags.queue);
 		return this.output(data);
 	}

package/src/commands/action/requeue.mjs

@@ -0,0 +1,156 @@
+import { Args, Flags } from "@oclif/core";
+import { error, stdout, ux } from "@oclif/core/ux";
+import Command from "#src/procaCommand.mjs";
+import { gql, mutation, query } from "#src/urql.mjs";
+
+export default class ActionRequeue extends Command {
+	static description = "requeue actions";
+
+	static examples = ["<%= config.bin %> <%= command.id %>"];
+
+	static flags = {
+		...super.globalFlags,
+		org: Flags.string({
+			char: "o",
+			required: true,
+			description: "name of the org",
+			helpValue: "<org name>",
+		}),
+		campaign: Flags.string({
+			char: "c",
+			description: "name of the campaign, % for wildchar",
+			helpValue: "<campaign name>",
+		}),
+		queue: Flags.string({
+			char: "q",
+			required: true,
+			description: "queue to redeliver to",
+			default: "CUSTOM_ACTION_DELIVER",
+			options: [
+				"CUSTOM_ACTION_CONFIRM",
+				"CUSTOM_ACTION_DELIVER",
+				"CUSTOM_SUPPORTER_CONFIRM",
+				"EMAIL_SUPPORTER",
+				"SQS",
+				"WEBHOOK",
+			],
+		}),
+		limit: Flags.string({
+			description: "how many actions per page",
+			default: 1000,
+			parse: (input) => Number.parseInt(input, 10),
+		}),
+		after: Flags.string({
+			description: "only actions after a date",
+			helpValue: "2025-04-09",
+			parse: (input) => new Date(input).toISOString(),
+		}),
+		today: Flags.boolean({
+			description: "only actions today",
+			exclusive: ["after"],
+			parse: (input) => `${new Date().toISOString().split("T")[0]}T00:00:00Z`,
+		}),
+		optin: Flags.boolean({
+			description: "only export the optin actions",
+			default: false,
+		}),
+		testing: Flags.boolean({
+			description: "also export the test actions",
+			default: false,
+		}),
+		doi: Flags.boolean({
+			description: "only export the double optin actions",
+			default: false,
+		}),
+	};
+
+	process = async (flags) => {
+		let page = 0;
+		let actions = 0;
+		let requeued = 0;
+		let error = 0;
+		while (true) {
+			const ids = await this.fetch(flags);
+			if (ids.length === 0) break;
+			const result = await this.requeue(flags.org, flags.queue, ids);
+			requeued += result.count;
+			error += result.failed;
+			flags.start = ids[ids.length - 1] + 1;
+			process.stdout.write(`\rrequeued ${requeued}, id> ${flags.start}`);
+			page += 1;
+			actions += ids.length;
+		}
+		process.stdout.write("\r\x1b[K");
+		return { pages: page, actions, requeued, error };
+	};
+
+	fetch = async (flags) => {
+		const Document = gql`
+      query (
+        $after: DateTime
+        $campaignId: Int
+        $campaignName: String
+        $includeTesting: Boolean
+        $limit: Int
+        $onlyDoubleOptIn: Boolean
+        $onlyOptIn: Boolean
+        $orgName: String!
+        $start: Int
+      ) {
+        actions (
+          after: $after
+          campaignId: $campaignId
+          campaignName: $campaignName
+          includeTesting: $includeTesting
+          limit: $limit
+          onlyDoubleOptIn: $onlyDoubleOptIn
+          onlyOptIn: $onlyOptIn
+          orgName: $orgName
+          start: $start
+        ) {
+          actionId
+          }
+      }
+    `;
+		const result = await query(Document, {
+			after: flags.after,
+			campaignName: flags.campaign,
+			includeTesting: flags.testing,
+			limit: flags.limit,
+			onlyDoubleOptIn: flags.doi,
+			onlyOptIn: flags.optin,
+			orgName: flags.org,
+			start: flags.start,
+		});
+		const ids = [];
+		result.actions.forEach((d) => ids.push(d.actionId));
+		return ids;
+	};
+
+	requeue = async (org, queue, ids) => {
+		const Document = gql`
+mutation ($ids: [Int!], $org: String!, $queue: Queue!) {
+  requeueActions(ids: $ids, orgName: $org, queue: $queue) {
+    count
+    failed
+  }
+}`;
+		const result = await mutation(Document, {
+			org,
+			queue,
+			ids,
+		});
+		//return result.users.map (d => {d.config = JSON.parse(d.config); return d});
+		return result.requeueActions;
+	};
+
+	table = (r) => {
+		super.table(r, null, null);
+	};
+
+	async run() {
+		const { args, flags } = await this.parse();
+		const data = await this.process(flags);
+		this.output(data);
+	}
+}

package/src/commands/user/invite.mjs

@@ -0,0 +1,56 @@
+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";
+
+export default class UserInviteOrg extends Command {
+	static description = "invite a user to join an organisation with a role";
+
+	static examples = ["<%= config.bin %> <%= command.id %>"];
+
+	static flags = {
+		...super.globalFlags,
+		role: Flags.string({
+			description: "permission level in that org",
+			default: "campaigner",
+			options: ["owner", "campaigner", "coordinator", "translator"],
+		}),
+		org: Flags.string({
+			char: "o",
+			required: true,
+			description: "name of the org",
+			helpValue: "<org name>",
+		}),
+		user: Flags.string({
+			char: "u",
+			required: true,
+			description: "email",
+			helpValue: "<user email>",
+		}),
+	};
+
+	invite = async (params) => {
+		const Document = gql`
+mutation ($user: String!, $role: String!, $org: String!, $message: String) {
+  inviteOrgUser(orgName: $org,  message: $message, input: { email: $user, role: $role}) {
+      objectId
+      code
+  }
+}
+    `;
+		const result = await mutation(Document, params);
+		//return result.users.map (d => {d.config = JSON.parse(d.config); return d});
+		console.log(result);
+		return result.inviteOrgUser;
+	};
+
+	table = (r) => {
+		super.table(r, null, null);
+	};
+
+	async run() {
+		const { args, flags } = await this.parse();
+		const data = await this.invite(flags);
+		this.output(data);
+	}
+}

package/src/commands/widget/delete.mjs

@@ -0,0 +1,45 @@
+import { createInterface } from "node:readline";
+import { Flags } from "@oclif/core";
+import WidgetGet from "#src/commands/widget/get.mjs";
+import Command from "#src/procaCommand.mjs";
+import { gql, mutation } from "#src/urql.mjs";
+
+export default class WidgetDelete extends Command {
+	static description = "Delete a widget";
+
+	static args = this.multiid();
+
+	static flags = {
+		...this.flagify({ multiid: true }),
+	};
+
+	delete = async (flags) => {
+		const deletePageDocument = gql`
+      mutation delete( $name:String!) {
+        deleteActionPage(name: $name)
+      }
+    `;
+
+		const r = await mutation(deletePageDocument, { name: flags.name });
+		return { deleted: r.deleteActionPage };
+	};
+
+	table = (r) => {
+		super.table(r, null, null);
+	};
+
+	async run() {
+		const { flags } = await this.parse(WidgetDelete);
+		const wg = new WidgetGet([], this.config);
+		const widget = await wg.fetch(flags);
+		try {
+			const data = await this.delete({ name: widget.name });
+			widget.status = data.deleted;
+		} catch (e) {
+			widget.status = "can't delete widgets with actions";
+			this.output(widget);
+			this.error("a widget with actions can't be deleted");
+		}
+		return this.output(widget);
+	}
+}

package/src/commands/widget/list.mjs

@@ -1,7 +1,7 @@
 import { Args, Flags } from "@oclif/core";
 import { error, stdout, ux } from "@oclif/core/ux";
 import Command from "#src/procaCommand.mjs";
-import { FragmentSummary } from "#src/queries/widget.mjs";
+import { FragmentSummary, FragmentSummaryOrg } from "#src/queries/widget.mjs";
 import { gql, query } from "#src/urql.mjs";
 
 export default class WidgetList extends Command {
@@ -68,7 +68,7 @@ query SearchWidgets($org: String!, $withConfig: Boolean!) {
       }
     }
   }
-${FragmentSummary}
+${FragmentSummaryOrg}
 }`;
 		const result = await query(Document, {
 			org: name,
@@ -96,8 +96,13 @@ ${FragmentSummary}
 			result.extra = d.extraSupporters;
 		}
 		//		if (d.journey) result.journey = d.journey.join(" → ");
-		result.org = d.org.name;
-		result.org_id = d.org.id;
+		if (d.org) {
+			result.org = d.org.name;
+			result.org_id = d.org.id;
+		}
+		if (d.campaign) {
+			result.campaign = d.campaign.name;
+		}
 		if (this.flags.config) {
 		}
 		return result;

package/src/queries/widget.mjs

@@ -11,3 +11,15 @@ location
 org {name, ... on PrivateOrg {id} }
 }
 `;
+
+export const FragmentSummaryOrg = gql`fragment Summary on PrivateActionPage {
+id
+locale
+name
+journey
+extraSupporters
+status
+location
+campaign {name }
+}
+`;