proca 1.1.5 → 1.2.0

package/README.md

@@ -18,7 +18,7 @@ $ npm install -g proca
 $ proca COMMAND
 running command...
 $ proca (--version)
-proca/1.1.5 linux-x64 node-v20.12.2
+proca/1.2.0 linux-x64 node-v20.12.2
 $ proca --help [COMMAND]
 USAGE
   $ proca COMMAND
@@ -58,6 +58,7 @@ USAGE
 * [`proca config setup [ENVIRONMENT]`](#proca-config-setup-environment)
 * [`proca config token`](#proca-config-token)
 * [`proca config user`](#proca-config-user)
+* [`proca contact list [TITLE]`](#proca-contact-list-title)
 * [`proca help [COMMAND]`](#proca-help-command)
 * [`proca org add`](#proca-org-add)
 * [`proca org crm`](#proca-org-crm)
@@ -74,7 +75,6 @@ USAGE
 * [`proca plugins uninstall [PLUGIN]`](#proca-plugins-uninstall-plugin)
 * [`proca plugins unlink [PLUGIN]`](#proca-plugins-unlink-plugin)
 * [`proca plugins update`](#proca-plugins-update)
-* [`proca supporter count`](#proca-supporter-count)
 * [`proca user get`](#proca-user-get)
 * [`proca user leave`](#proca-user-leave)
 * [`proca user list`](#proca-user-list)
@@ -448,6 +448,39 @@ EXAMPLES
   $ proca config user
 ```
 
+## `proca contact list [TITLE]`
+
+```
+USAGE
+  $ proca contact list [TITLE] -o <organisation name> [--json | --human | --csv] [-c
+    <campaign title>] [--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
+      --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
+  --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
+
+EXAMPLES
+  $ proca contact list %pizza%
+```
+
 ## `proca help [COMMAND]`
 
 Display help for proca.
@@ -882,39 +915,6 @@ DESCRIPTION
 
 _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.25/src/commands/plugins/update.ts)_
 
-## `proca supporter count`
-
-counter of supporters
-
-```
-USAGE
-  $ proca supporter count [ID_NAME_DXID] [--json | --human | --csv] [--simplify] [-i <value>
-    | -n <the_short_name> | -x <value>] [--org] [--area] [--number --without <value>]
-
-FLAGS
-  -i, --id=<value>
-  -n, --name=<the_short_name>  name
-  -x, --dxid=<value>           dxid
-      --area                   segment by area
-      --number                 just return the number to add to the partner's counter
-      --org                    segment by partner
-      --without=<value>        total to add to the partner's counter
-
-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
-  counter of supporters
-
-EXAMPLES
-  $ proca supporter count --id <id of the campaign>
-
-  $ proca supporter count --name <name of the campaign>
-```
-
 ## `proca user get`
 
 fetch the information about a user

package/package.json

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

package/src/commands/action/list.mjs

@@ -8,7 +8,7 @@ import {
 } from "#src/queries/campaign.mjs";
 import { gql, query } from "#src/urql.mjs";
 
-export default class CampaignList extends Command {
+export default class List extends Command {
 	actionTypes = new Set();
 
 	static args = {
@@ -85,7 +85,7 @@ export default class CampaignList extends Command {
         $orgName: String!
         $start: Int
       ) {
-        exportActions(
+        actions (
           after: $after
           campaignId: $campaignId
           campaignName: $campaignName
@@ -142,7 +142,7 @@ export default class CampaignList extends Command {
 			orgName: flags.org,
 			start: flags.start,
 		});
-		return result.exportActions.map((d) => {
+		return result.actions.map((d) => {
 			d.customFields = JSON.parse(d.customFields);
 			if (!d.contact.publicKey) {
 				const ref = d.contactRef;

package/src/commands/contact/list.mjs

@@ -0,0 +1,204 @@
+import { Args, Flags } from "@oclif/core";
+import { error, stdout, ux } from "@oclif/core/ux";
+import Command from "#src/procaCommand.mjs";
+import {
+	FragmentOrg,
+	FragmentStats,
+	FragmentSummary,
+} from "#src/queries/campaign.mjs";
+import { gql, query } from "#src/urql.mjs";
+
+export default class List extends Command {
+	actionTypes = new Set();
+
+	static args = {
+		title: Args.string({ description: "name of the campaign, % for wildchar" }),
+	};
+
+	static examples = ["<%= config.bin %> <%= command.id %> %pizza%"];
+
+	static flags = {
+		// flag with no value (-f, --force)
+		...super.globalFlags,
+		org: Flags.string({
+			char: "o",
+			description: "campaigns of the organisation (coordinator or partner)",
+			required: true,
+			//			exactlyOne: ["org", "title"],
+			helpValue: "<organisation name>",
+		}),
+		campaign: Flags.string({
+			char: "c",
+			description: "name of the campaign, % for wildchar",
+			helpValue: "<campaign title>",
+		}),
+		limit: Flags.string({
+			description: "max number of actions",
+			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,
+		}),
+		utm: Flags.boolean({
+			description: "display the utm tracking parameters",
+			default: true,
+			allowNo: true,
+			exclusive: ["simplify"],
+		}),
+		comment: Flags.boolean({
+			description: "display the comment",
+			default: true,
+			allowNo: true,
+			exclusive: ["simplify"],
+		}),
+	};
+
+	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
+      ) {
+        contacts(
+          after: $after
+          campaignId: $campaignId
+          campaignName: $campaignName
+          includeTesting: $includeTesting
+          limit: $limit
+          onlyDoubleOptIn: $onlyDoubleOptIn
+          onlyOptIn: $onlyOptIn
+          orgName: $orgName
+          start: $start
+        ) {
+          actionId
+          actionPage {
+            locale
+            name
+          }
+          actionType
+          campaign {
+            name
+          }
+          contact {
+            contactRef
+            payload
+            nonce
+            publicKey {
+              public
+            }
+          }
+          createdAt
+          customFields
+          privacy {
+            emailStatus
+            emailStatusChanged
+            givenAt
+            optIn
+            withConsent
+          }
+          tracking {
+            campaign
+            content
+            medium
+            source
+          }
+        }
+      }
+    `;
+		const result = await query(Document, {
+			after: flags.after,
+			//  "campaignId": 42,
+			campaignName: flags.campaign,
+			includeTesting: flags.testing,
+			limit: flags.limit,
+			onlyDoubleOptIn: flags.doi,
+			onlyOptIn: flags.optin,
+			orgName: flags.org,
+			start: flags.start,
+		});
+		return result.contacts.map((d) => {
+			d.customFields = JSON.parse(d.customFields);
+			if (!d.contact.publicKey) {
+				const ref = d.contactRef;
+				d.contact = JSON.parse(d.contact.payload);
+				d.contact.contactRef = ref;
+			} else {
+				this.error(
+					`encrypted contact we need the private key for ${d.contact.publicKey.public}`,
+				);
+			}
+			return d;
+		});
+		//		return result.exportActions;
+	};
+
+	simplify = (d) => {
+		const result = {
+			id: d.actionId,
+			firstname: d.contact.firstName,
+			country: d.contact.country,
+			email: d.contact.email,
+			type: d.actionType,
+			date: d.createdAt,
+			campaign: d.campaign.name,
+			widget_id: d.actionPage.id,
+			widget: d.actionPage.name,
+			//            customFields
+		};
+		if (this.flags.comment && d.customFields?.comment)
+			result.comment = d.customFields.comment;
+		if (d.customFields?.emailProvider)
+			result.provider = d.customFields.emailProvider;
+		if (this.flags.utm && d.tracking) {
+			result.utm_medium =
+				d.tracking.medium === "unknown" ? undefined : d.tracking.medium;
+			result.utm_source =
+				d.tracking.source === "unknown" ? undefined : d.tracking.source;
+			result.utm_campaign =
+				d.tracking.campaign === "unknown" ? undefined : d.tracking.campaign;
+			if (d.tracking.content)
+				result.utm_content =
+					d.tracking.content === "unknown" ? undefined : d.tracking.content;
+		}
+		return result;
+	};
+
+	_table = (r) => {
+		super.table(r, null, (table) => table.sort(["id|des"]).toString());
+	};
+
+	async run() {
+		const { args, flags } = await this.parse();
+		if (flags.today) flags.after = flags.today;
+		let data = [];
+
+		data = await this.fetch(flags);
+		return this.output(data);
+	}
+}

package/src/commands/supporter/count.mjs

@@ -1,96 +0,0 @@
-import { Args, Flags } from "@oclif/core";
-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 examples = [
-		"<%= config.bin %> <%= command.id %> --id <id of the campaign>",
-		"<%= config.bin %> <%= command.id %> --name <name of the campaign>",
-	];
-
-	static args = this.multiid();
-	static flags = {
-		// flag with no value (-f, --force)
-		...this.flagify({ multiid: true }),
-		org: Flags.boolean({
-			description: "segment by partner",
-			default: false,
-		}),
-		area: Flags.boolean({
-			description: "segment by area",
-			default: false,
-		}),
-		without: Flags.string({
-			description: "total to add to the partner's counter",
-		}),
-		number: Flags.boolean({
-			description: "just return the number to add to the partner's counter",
-			dependsOn: ["without"],
-		}),
-	};
-
-	fetchExcluding = async (params) => {
-		const GetCounterDocument = gql`
-query GetCounter($name: String, $id: Int, $without: String!) {
-  campaign(name: $name, id: $id) {
-    stats {
-      supporterCount
-      supporterCountByOthers (orgName: $without) 
-    }
-  }
-}`;
-
-		const result = await query(GetCounterDocument, params);
-		return result.campaign.stats;
-	};
-
-	fetch = async (params) => {
-		const GetCounterDocument = gql`
-query GetCounter($name: String, $id: Int, $org: Boolean = false, $area: Boolean = false) {
-  campaign(name: $name, id: $id) {
-    stats {
-      supporterCount
-      supporterCountByOrg @include(if: $org) { org { name } count }
-      supporterCountByArea @include(if: $area) { area count }
-    }
-  }
-}`;
-
-		const result = await query(GetCounterDocument, params);
-		return result.campaign.stats;
-	};
-
-	simplify = (d) => {
-		const result = { total: d.supporterCount };
-		d.supporterCountByOrg
-			?.sort((a, b) => b.count - a.count)
-			.forEach((org) => {
-				result[org.org.name] = org.count;
-			});
-		d.supporterCountByArea
-			?.sort((a, b) => b.count - a.count)
-			.forEach((area) => {
-				result[area.area] = area.count;
-			});
-		if (d.supporterCountByOthers) {
-			result[`without ${this.flags.without}`] = d.supporterCountByOthers;
-		}
-		return result;
-	};
-	table = (r) => {
-		super.table(r, null, null);
-	};
-
-	async run() {
-		const { args, flags } = await this.parse();
-		if (flags.without) {
-			const data = await this.fetchExcluding(flags);
-			if (flags.number) return console.log(data.supporterCountByOthers);
-			return this.output(data);
-		}
-		const data = await this.fetch(flags);
-		return this.output(data);
-	}
-}