proca 1.5.0 → 1.7.0

package/README.md

@@ -12,19 +12,18 @@ One of Proca's standout features is its robust support for coalition campaigns,
 
 ### global installation
 
-  <!-- usage -->
+if you have or plan to have multiple servers (eg. production and staging) or multiple users, you can setup multiple environments. each proca command support a --env <environment> param (optional, 'default' if not specified.
+
+All the examples are using the default environment, add --env=staging if you need to access another server than your default one. By convention, we keep default for production.
+
 ```sh-session
 $ npm install -g proca
-$ proca COMMAND
-running command...
-$ proca (--version)
-proca/1.5.0 linux-x64 node-v20.12.2
-$ proca --help [COMMAND]
-USAGE
-  $ proca COMMAND
-...
+$# 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>
 ```
-<!-- usagestop -->
+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
 
@@ -36,27 +35,15 @@ USAGE
    $./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-api
    $ npm link proca # use the local proca-cli repo
-...
-
-
 ````
 
-### TOPICS
-
-- campaign Handle campaigns
-- org
-- config create setting to access the server authentication
-- widget
-- supporters (counter)
-
 # Commands
 
 <!-- commands -->
@@ -69,6 +56,7 @@ you should also use the local proca-api in your [widget generator](https://githu
 * [`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 config add [ENV] [HUMAN] [JSON] [CSV] [SIMPLIFY]`](#proca-config-add-env-human-json-csv-simplify)
 * [`proca config folder`](#proca-config-folder)
@@ -95,6 +83,7 @@ you should also use the local proca-api in your [widget generator](https://githu
 * [`proca plugins uninstall [PLUGIN]`](#proca-plugins-uninstall-plugin)
 * [`proca plugins unlink [PLUGIN]`](#proca-plugins-unlink-plugin)
 * [`proca plugins update`](#proca-plugins-update)
+* [`proca target add`](#proca-target-add)
 * [`proca user get`](#proca-user-get)
 * [`proca user leave`](#proca-user-leave)
 * [`proca user list`](#proca-user-list)
@@ -111,13 +100,14 @@ USAGE
   $ proca action add [ID_NAME_DXID...] -i <value> --firstname <value> --email <value>
     [--json | --human | --csv] [--env <value>] [--simplify] [-x <value>] [-n <the_short_name>] [--testing] [--optin]
     [--action_type <value>] [--lastname <value>] [--street <value>] [--locality <value>] [--region <value>] [--country
-    <value>] [--utm <value>]
+    <value>] [--utm <value>] [--target <value>] [--subject <value>] [--body <value>]
 
 FLAGS
   -i, --id=<value>             (required) widget's id
   -n, --name=<the_short_name>  name
   -x, --dxid=<value>           dxid
       --action_type=<value>    [default: register]
+      --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)
@@ -127,6 +117,8 @@ FLAGS
   --optin
   --region=<value>
   --street=<value>
+      --subject=<value>        [mtt] subject of the email
+      --target=<value>         [mtt] uid of the target
   --testing
       --utm=<value>            utm=campaign.source.medium
 
@@ -140,6 +132,8 @@ EXAMPLES
   $ proca action add -i <widget_id> --firstname=John --email=john@example.org
 
   $ proca action add -i <widget_id> --firstname=John --email=john@example.org --country=FR custom1=A custom2=B
+
+  $ 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 count`
@@ -369,6 +363,40 @@ EXAMPLES
   $ proca campaign list %pizza%
 ```
 
+## `proca campaign mtt`
+
+set the mail to target (mtt) params
+
+```
+USAGE
+  $ proca campaign mtt [ID_NAME_DXID] --from <value> --to <value> [--json | --human |
+    --csv] [--env <value>] [--simplify] [-i <value> | -n <the_short_name> | -x <value>] [--template <value>] [--period
+    <value>] [--email <value>]
+
+FLAGS
+  -i, --id=<value>
+  -n, --name=<the_short_name>  name
+  -x, --dxid=<value>           dxid
+      --email=<value>          test email address
+      --env=<value>            [default: default] allow to switch between configurations (server or users)
+      --from=<value>           (required) start date (yyyy-mm-dd)
+      --period=<value>         [default: 09:09-18:18] period of the day (HH:HH-HH:HH)
+      --template=<value>       mtt template to use
+      --to=<value>             (required) end date (yyyy-mm-dd)
+
+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
+  set the mail to target (mtt) params
+
+EXAMPLES
+  $ proca campaign mtt -n <test-mtt-campaign>
+```
+
 ## `proca campaign status`
 
 ```
@@ -403,7 +431,8 @@ create setting to access to a server
 ```
 USAGE
   $ proca config add [ENV] [HUMAN] [JSON] [CSV] [SIMPLIFY] [--json | --human | --csv]
-    [--env <value>] [--simplify] [--url <url>] [--token <API-token>] [--folder /var/www/proca]
+    [--env <value>] [--simplify] [--url http://localhost:4000] [--token API-token>] [--email you@example.org] [--folder
+    /var/www/proca/config.example]
 
 ARGUMENTS
   ENV       [default: default] allow to switch between configurations (server or users)
@@ -413,10 +442,11 @@ ARGUMENTS
   SIMPLIFY  flatten and filter to output only the most important attributes, mostly relevant for json
 
 FLAGS
-  --env=<value>            [default: default] allow to switch between configurations (server or users)
-  --folder=/var/www/proca  config folder (in the proca widget generator)
-  --token=<API-token>      user token on proca server
-  --url=<url>              [default: https://api.proca.app/api] url of the proca server api
+  --email=you@example.org                 user email on proca server
+  --env=<value>                           [default: default] allow to switch between configurations (server or users)
+  --folder=/var/www/proca/config.example  config folder (in the proca widget generator)
+  --token=API-token>                      user token on proca server
+  --url=http://localhost:4000             [default: https://api.proca.app/api] url of the proca server api
 
 OUTPUT FLAGS
   --csv            Format output as csv
@@ -465,7 +495,8 @@ create setting to access to a server
 ```
 USAGE
   $ proca config init [ENV] [HUMAN] [JSON] [CSV] [SIMPLIFY] [--json | --human | --csv]
-    [--env <value>] [--simplify] [--url <url>] [--token <API-token>] [--folder /var/www/proca]
+    [--env <value>] [--simplify] [--url http://localhost:4000] [--token API-token>] [--email you@example.org] [--folder
+    /var/www/proca/config.example]
 
 ARGUMENTS
   ENV       [default: default] allow to switch between configurations (server or users)
@@ -475,10 +506,11 @@ ARGUMENTS
   SIMPLIFY  flatten and filter to output only the most important attributes, mostly relevant for json
 
 FLAGS
-  --env=<value>            [default: default] allow to switch between configurations (server or users)
-  --folder=/var/www/proca  config folder (in the proca widget generator)
-  --token=<API-token>      user token on proca server
-  --url=<url>              [default: https://api.proca.app/api] url of the proca server api
+  --email=you@example.org                 user email on proca server
+  --env=<value>                           [default: default] allow to switch between configurations (server or users)
+  --folder=/var/www/proca/config.example  config folder (in the proca widget generator)
+  --token=API-token>                      user token on proca server
+  --url=http://localhost:4000             [default: https://api.proca.app/api] url of the proca server api
 
 OUTPUT FLAGS
   --csv            Format output as csv
@@ -562,7 +594,8 @@ create setting to access to a server
 ```
 USAGE
   $ proca config setup [ENV] [HUMAN] [JSON] [CSV] [SIMPLIFY] [--json | --human | --csv]
-    [--env <value>] [--simplify] [--url <url>] [--token <API-token>] [--folder /var/www/proca]
+    [--env <value>] [--simplify] [--url http://localhost:4000] [--token API-token>] [--email you@example.org] [--folder
+    /var/www/proca/config.example]
 
 ARGUMENTS
   ENV       [default: default] allow to switch between configurations (server or users)
@@ -572,10 +605,11 @@ ARGUMENTS
   SIMPLIFY  flatten and filter to output only the most important attributes, mostly relevant for json
 
 FLAGS
-  --env=<value>            [default: default] allow to switch between configurations (server or users)
-  --folder=/var/www/proca  config folder (in the proca widget generator)
-  --token=<API-token>      user token on proca server
-  --url=<url>              [default: https://api.proca.app/api] url of the proca server api
+  --email=you@example.org                 user email on proca server
+  --env=<value>                           [default: default] allow to switch between configurations (server or users)
+  --folder=/var/www/proca/config.example  config folder (in the proca widget generator)
+  --token=API-token>                      user token on proca server
+  --url=http://localhost:4000             [default: https://api.proca.app/api] url of the proca server api
 
 OUTPUT FLAGS
   --csv            Format output as csv
@@ -1126,6 +1160,27 @@ DESCRIPTION
 
 _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.25/src/commands/plugins/update.ts)_
 
+## `proca target add`
+
+```
+USAGE
+  $ proca target add -c <value> --name <value> --email <value> [--json | --human |
+    --csv] [--env <value>] [--simplify] [--external_id <value>]
+
+FLAGS
+  -c, --campaign=<value>     (required) mtt campaign to add the target
+      --email=<value>        (required) email of the target
+      --env=<value>          [default: default] allow to switch between configurations (server or users)
+      --external_id=<value>  external id of the target
+      --name=<value>         (required) name of the target
+
+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
+```
+
 ## `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.5.0",
+	"version": "1.7.0",
 	"author": "Xavier",
 	"bin": {
 		"proca": "proca-cli"

package/src/commands/action/add.mjs

@@ -9,6 +9,7 @@ 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();
@@ -50,6 +51,9 @@ export default class ActionAdd extends Command {
 			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) => {
@@ -95,6 +99,16 @@ export default class ActionAdd extends Command {
 			},
 		};
 
+		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!

package/src/commands/campaign/get.mjs

@@ -2,6 +2,7 @@ import { Args, Flags } from "@oclif/core";
 import { error, stdout, ux } from "@oclif/core/ux";
 import Command from "#src/procaCommand.mjs";
 import {
+	FragmentMtt,
 	FragmentOrg,
 	FragmentStats,
 	FragmentSummary,
@@ -43,11 +44,13 @@ export default class CampaignGet extends Command {
           ...Org
           config
           ...Stats @include(if: $withStats)
+          ...Mtt
         }
       }
       ${FragmentStats}
       ${FragmentSummary}
       ${FragmentOrg}
+      ${FragmentMtt}
     `;
 		const result = await query(GetCampaignDocument, {
 			id: id,
@@ -67,6 +70,20 @@ export default class CampaignGet extends Command {
 			locales: d.config.locales && Object.keys(d.config.locales).join(" "),
 			journey: d.config.journey?.join(" → "),
 		};
+		if (d.mtt) {
+			// we have an mtt
+			const hhmm = (date) =>
+				new Date(date).toLocaleTimeString(undefined, {
+					hour: "2-digit",
+					minute: "2-digit",
+					hour12: false,
+				});
+			result.from = d.mtt.startAt.substring(0, 10);
+			result.to = d.mtt.endAt.substring(0, 10);
+			result.period = `${hhmm(d.mtt.startAt)}↔${hhmm(d.mtt.endAt)}`;
+			result["test email"] = d.mtt.testEmail;
+			result["mtt template"] = d.mtt.template;
+		}
 		if (this.flags.stats) {
 			result["#Supporters"] = d.stats.supporterCount;
 

package/src/commands/campaign/mtt.mjs

@@ -0,0 +1,108 @@
+import { Args, Flags } from "@oclif/core";
+import { error, stdout, ux } from "@oclif/core/ux";
+import Command from "#src/procaCommand.mjs";
+import { FragmentMtt } from "#src/queries/campaign.mjs";
+import { gql, mutation } from "#src/urql.mjs";
+
+export default class CampaignMtt extends Command {
+	static args = this.multiid();
+
+	static description = "set the mail to target (mtt) params";
+
+	static examples = [
+		"<%= config.bin %> <%= command.id %> -n <test-mtt-campaign>",
+	];
+
+	static flags = {
+		...this.flagify({ multiid: true }),
+		from: Flags.string({
+			description: "start date (yyyy-mm-dd)",
+			required: true,
+		}),
+		to: Flags.string({
+			description: "end date (yyyy-mm-dd)",
+			required: true,
+		}),
+		template: Flags.string({
+			description: "mtt template to use",
+		}),
+		period: Flags.string({
+			description: "period of the day (HH:HH-HH:HH)",
+			default: "09:09-18:18",
+		}),
+		email: Flags.string({
+			description: "test email address",
+		}),
+	};
+
+	updateMtt = async (flags) => {
+		const Query = gql`
+mutation (
+$id: Int,
+$name: String
+$mtt: CampaignMttInput!
+) {
+  updateCampaign (id:$id, name: $name, input: { mtt: $mtt }) {
+    id, name
+          ...Mtt
+  }
+      ${FragmentMtt}
+}
+    `;
+		const testEmail = flags.email || `campaign+${flags.name}@proca.app`;
+
+		const [startPeriod, endPeriod] = flags.period.split("-");
+		const [startHour, startMinute] = startPeriod.split(":");
+		const [endHour, endMinute] = endPeriod.split(":");
+
+		const startAt = new Date(flags.from);
+		startAt.setHours(startHour, startMinute, 0, 0);
+
+		const endAt = new Date(flags.to);
+		endAt.setHours(endHour, endMinute, 0, 0);
+
+		const result = await mutation(Query, {
+			//			org: props.org,
+			id: flags.id,
+			name: flags.name,
+			mtt: {
+				startAt: startAt.toISOString(),
+				endAt: endAt.toISOString(),
+				messageTemplate: flags.template,
+				testEmail: testEmail,
+			},
+		});
+
+		return result.updateCampaign;
+	};
+
+	simplify = (d) => {
+		const result = {
+			id: d.id,
+			Name: d.name,
+		};
+		const hhmm = (date) =>
+			new Date(date).toLocaleTimeString(undefined, {
+				hour: "2-digit",
+				minute: "2-digit",
+				hour12: false,
+			});
+		result.from = d.mtt.startAt.substring(0, 10);
+		result.to = d.mtt.endAt.substring(0, 10);
+		result.period = `${hhmm(d.mtt.startAt)}↔${hhmm(d.mtt.endAt)}`;
+		result["test email"] = d.mtt.testEmail;
+		result["mtt template"] = d.mtt.template;
+		return result;
+	};
+
+	table = (r) => {
+		super.table(r, null, null);
+	};
+
+	async run() {
+		const { args, flags } = await this.parse();
+
+		const result = await this.updateMtt(flags);
+		this.output(result);
+	}
+}

package/src/commands/config/add.mjs

@@ -25,15 +25,19 @@ export default class ConfigAdd extends Command {
 		url: Flags.string({
 			description: "url of the proca server api",
 			default: "https://api.proca.app/api",
-			helpValue: "<url>",
+			helpValue: "http://localhost:4000",
 		}),
 		token: Flags.string({
 			description: "user token on proca server",
-			helpValue: "<API-token>",
+			helpValue: "API-token>",
+		}),
+		email: Flags.string({
+			description: "user email on proca server",
+			helpValue: "you@example.org",
 		}),
 		folder: Flags.string({
 			description: "config folder (in the proca widget generator)",
-			helpValue: "/var/www/proca",
+			helpValue: "/var/www/proca/config.example",
 		}),
 		//		n8n: Flags.string({			description: "api access on the n8n server",			helpValue: "<n8n api>",		}),
 		//		supabase: Flags.string({description: "url of the supabase",helpValue: "<url>"}),

package/src/commands/target/add.mjs

@@ -0,0 +1,94 @@
+import fs from "node:fs";
+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 TargetAdd extends Command {
+	static flags = {
+		// flag with no value (-f, --force)
+		...this.flagify({ multiid: false }),
+		campaign: Flags.string({
+			char: "c",
+			description: "mtt campaign to add the target",
+			required: true,
+		}),
+		name: Flags.string({
+			description: "name of the target",
+			required: true,
+		}),
+		email: Flags.string({
+			description: "email of the target",
+			required: true,
+		}),
+		external_id: Flags.string({
+			description: "external id of the target",
+		}),
+	};
+
+	getCampaignId = async (name) => {
+		const Document = gql`
+query getCampaignId($campaign: String!) {
+  campaign (name:$campaign) { id 
+  }
+}`;
+
+		const result = await query(Document, {
+			campaign: name,
+		});
+		return result.campaign.id;
+	};
+
+	create = async (flags) => {
+		const id = await this.getCampaignId(flags.campaign);
+
+		const Document = gql`
+      mutation (
+        $campaignId: Int!
+        $outdatedTargets: OutdatedTargets
+        $targets: [TargetInput!]!
+      ) {
+        upsertTargets(
+          campaignId: $campaignId
+          outdatedTargets: $outdatedTargets
+          targets: $targets
+        ) {
+          area
+          emails {
+            email
+            emailStatus
+            error
+          }
+          externalId
+          fields
+          id
+          locale
+          name
+        }
+      }
+    `;
+		const result = await mutation(Document, {
+			campaignId: id,
+			outdatedTargets: "KEEP",
+			targets: [
+				{
+					name: flags.name,
+					externalId: flags.external_id,
+					emails: [{ email: flags.email }],
+				},
+			],
+		});
+		return result.upsertTargets;
+	};
+
+	async run() {
+		//const { args, flags } = await this.parse(CampaignAdd);
+		const { args, flags } = await this.parse();
+		if (!flags.external_id) {
+			flags.external_id = `${flags.campaign}_${flags.email}`;
+		}
+
+		const data = await this.create(flags);
+		return this.output(data);
+	}
+}

package/src/procaCommand.mjs

@@ -201,16 +201,20 @@ class ProcaCommand extends Command {
 	table(data, transformRow, print = (table) => table.toString()) {
 		if (!transformRow) {
 			if (this.flags.simplify !== false) {
-				transformRow = (d, cell) => {
-					for (const [key, value] of Object.entries(this.simplify(d))) {
+				transformRow = (d, cell, idx) => {
+					const r = this.simplify(d);
+					if (r === null) return null;
+					for (const [key, value] of Object.entries(r)) {
 						cell(key, value);
 					}
+					return true;
 				};
 			} else {
-				transformRow = (d, cell) => {
+				transformRow = (d, cell, idx) => {
 					for (const [key, value] of Object.entries(this.flatten(d))) {
 						cell(key, value);
 					}
+					return true;
 				};
 			}
 		}
@@ -227,6 +231,7 @@ class ProcaCommand extends Command {
 			}, this);
 			return this.newRow();
 		};
+
 		this.log(Table.print(data, transformRow, print));
 	}
 

package/src/queries/campaign.mjs

@@ -2,6 +2,17 @@ import { gql } from "#src/urql.mjs";
 
 export const FragmentSummary = gql`fragment Summary on Campaign {id name title externalId status}`;
 
+export const FragmentMtt = gql`
+      fragment Mtt on PrivateCampaign {
+        mtt {
+          startAt
+          endAt
+          messageTemplate
+          testEmail
+        }
+      }
+    `;
+
 export const FragmentOrg = gql`
       fragment Org on Campaign {
         org {