proca 0.8.1 → 1.1.5

package/package.json

@@ -1,103 +1,96 @@
 {
-  "name": "proca",
-  "version": "0.8.1",
-  "private": false,
-  "files": [
-    "dist",
-    "README.md"
-  ],
-  "main": "dist/module.js",
-  "licence": "aGPL3",
-  "nope.resolutions": {
-    "@babel/preset-env": "^7.8.7"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/TechToThePeople/proca"
-  },
-  "peerDependencies": {
-    "@material-ui/core": "^4.11.0",
-    "@material-ui/icons": "^4.9.1",
-    "@material-ui/lab": "^4.0.0-alpha.56",
-    "base64url": "^3.0.1",
-    "i18next": "^19.6.3",
-    "react": "^16.13.1",
-    "react-dom": "^16.13.1",
-    "react-hook-form": "^3.28.2",
-    "react-i18next": "^11.7.0",
-    "react-share": "^4.2.1",
-    "recoil": "^0.0.10",
-    "uuid": "^8.3.0"
-  },
-  "dependencies": {
-    "@alienfast/i18next-loader": "^1.1.4",
-    "base64url": "^3.0.1",
-    "dotenv": "^8.2.0",
-    "global": "^4.4.0",
-    "i18next": "^19.6.3",
-    "i18next-extract": "^0.1.3",
-    "i18next-xhr-backend": "^3.2.2",
-    "page-metadata-parser": "^1.1.4",
-    "react-i18next": "^11.7.0",
-    "react-ipgeolocation": "^1.3.0",
-    "react-share": "^4.2.1",
-    "recoil": "^0.0.10",
-    "uuid": "^8.3.0"
-  },
-  "devDependencies": {
-    "@babel/cli": "^7.10.5",
-    "@babel/plugin-proposal-class-properties": "^7.10.4",
-    "@babel/plugin-proposal-nullish-coalescing-operator": "^7.10.4",
-    "@babel/plugin-proposal-optional-chaining": "^7.11.0",
-    "@babel/plugin-transform-object-assign": "^7.10.4",
-    "@material-ui/core": "^4.11.0",
-    "@material-ui/icons": "^4.9.1",
-    "@material-ui/lab": "^4.0.0-alpha.54",
-    "@svgr/webpack": "5.4.0",
-    "@testing-library/jest-dom": "^4.2.4",
-    "@testing-library/react": "^9.3.2",
-    "@testing-library/user-event": "^7.1.2",
-    "babel-plugin-module-resolver": "^4.0.0",
-    "babel-plugin-optimize-clsx": "^2.6.1",
-    "compression-webpack-plugin": "^4.0.0",
-    "customize-cra": "^1.0.0",
-    "customize-cra-react-refresh": "^1.1.0",
-    "js-yaml": "^3.14.0",
-    "react": "^16.13.1",
-    "react-app-rewired": "^2.1.6",
-    "react-dom": "^16.13.1",
-    "react-hook-form-input": "^1.0.8",
-    "react-hot-loader": "^4.12.21",
-    "react-scripts": "3.4.2",
-    "react-test-renderer": "^16.12.0",
-    "webpack-hot-middleware": "^2.25.0",
-    "webpack-visualizer-plugin": "^0.1.11",
-    "yarn": "^1.21.1"
-  },
-  "scripts": {
-    "nope.prepublish": "babel src --out-dir lib",
-    "prepublishOnly": "node src/locales/index.js && rm -r dist/* && babel src --out-dir dist --copy-files",
-    "start": "react-app-rewired start",
-    "build": "react-app-rewired build",
-    "test": "react-app-rewired test --env=jsdom",
-    "eject": "react-scripts eject",
-    "ostart": "node scripts/start.js",
-    "obuild": "node scripts/build.js",
-    "otest": "node scripts/test.js"
-  },
-  "eslintConfig": {
-    "extends": "react-app"
-  },
-  "browserslist": {
-    "production": [
-      ">0.2%",
-      "not dead",
-      "not op_mini all"
-    ],
-    "development": [
-      "last 1 chrome version",
-      "last 1 firefox version",
-      "last 1 safari version"
-    ]
-  }
+	"name": "proca",
+	"description": "Access the proca api",
+	"version": "1.1.5",
+	"author": "Xavier",
+	"bin": {
+		"proca": "proca-cli"
+	},
+	"bugs": "https://github.com/fixthestatusquo/git@github.com:fixthestatusquo/proca-cli.git/issues",
+	"dependencies": {
+		"@oclif/core": "^4.2.10",
+		"@oclif/plugin-help": "^6",
+		"@oclif/plugin-plugins": "^5",
+		"@urql/exchange-auth": "^2.2.0",
+		"dotenv": "^16.4.5",
+		"dxid": "^2.2.1",
+		"easy-table": "^1.2.0",
+		"fast-csv": "^5.0.1",
+		"graphql": "^16.10.0",
+		"typescript": "^5.7.3",
+		"urql": "^4.1.0"
+	},
+	"devDependencies": {
+		"@biomejs/biome": "^1.9.3",
+		"@graphql-codegen/cli": "^2.x.x",
+		"@graphql-codegen/introspection": "^2.x.x",
+		"@graphql-codegen/typescript-operations": "^4.2.3",
+		"@graphql-codegen/typescript-urql": "^4.0.0",
+		"@oclif/plugin-autocomplete": "^3.2.5",
+		"@oclif/plugin-commands": "^4.1.3",
+		"@oclif/plugin-not-found": "^3.2.22",
+		"lefthook": "^1.7.18",
+		"oclif": "^4.17.46"
+	},
+	"engines": {
+		"node": ">=18.0.0"
+	},
+	"files": ["/proca-cli", "/src", "/theme.json"],
+	"homepage": "https://github.com/fixthestatusquo/git@github.com:fixthestatusquo/proca-cli.git",
+	"keywords": [
+		"cli",
+		"petition",
+		"proca",
+		"campaigning",
+		"digital-engagement",
+		"social-change",
+		"nonprofit",
+		"civic-tech",
+		"mobilisation",
+		"advocacy",
+		"activism",
+		"email-campaign",
+		"grassroots",
+		"gdpr"
+	],
+	"imports": {
+		"#src/*": "./src/*"
+	},
+	"license": "aGPL3",
+	"main": "./proca-cli",
+	"oclif": {
+		"repository": "github:fixthestatusquo/proca-cli",
+		"bin": "proca",
+		"theme": "theme.json",
+		"topicSeparator": " ",
+		"commands": "./src/commands",
+		"helpClass": "./src/hooks/help.mjs",
+		"topics": {
+			"widget": {
+				"description": "widgets (actionPages in the API)"
+			},
+			"campaign": {
+				"description": "campaigns"
+			},
+			"user": {
+				"description": "campaigners and other users"
+			}
+		},
+		"plugins": [
+			"@oclif/plugin-plugins",
+			"@oclif/plugin-help",
+			"@oclif/plugin-commands"
+		]
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+ssh://git@github.com/fixthestatusquo/proca-cli.git"
+	},
+	"scripts": {
+		"check": "npx @biomejs/biome check --write",
+		"format": "npx @biomejs/biome format --write",
+		"lint": "npx @biomejs/biome lint --write",
+		"prepack": "oclif manifest && oclif readme",
+		"version": "oclif readme && git add README.md"
+	}
 }

package/proca-cli

@@ -0,0 +1,8 @@
+#!/usr/bin/env -S node --trace-warnings
+const url = require('url');
+
+(async () => {
+  const metaUrl = url.pathToFileURL(__filename).href;  
+  const { execute } = await import('@oclif/core');
+  await execute({ dir: metaUrl });
+})();

package/src/commands/action/count.mjs

@@ -0,0 +1,61 @@
+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 {
+	ignored = ["share_confirmed"];
+	secondary = ["share"];
+
+	static description = "counter of actions";
+
+	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 }),
+	};
+
+	fetch = async (params) => {
+		const GetCounterDocument = gql`
+      query GetCounter($name: String, $id: Int) {
+        campaign(name: $name, id: $id) {
+          stats {
+            actionCount {actionType, count}
+          }
+        }
+      }
+    `;
+		const result = await query(GetCounterDocument, params);
+		return result.campaign.stats;
+	};
+
+	simplify = (d) => {
+		const result = { sharer: undefined };
+		let primary = 0;
+		let secondary = 0;
+		d.actionCount.forEach((type) => {
+			if (this.ignored.includes(type.actionType)) return;
+			if (this.secondary.includes(type.actionType)) {
+				secondary += type.count;
+			} else {
+				primary += type.count;
+			}
+			result[type.actionType] = type.count;
+		});
+		if (primary) result.sharer = `${Math.round((100 * secondary) / primary)}%`;
+		return result;
+	};
+	table = (r) => {
+		super.table(r, null, null);
+	};
+
+	async run() {
+		const { args, flags } = await this.parse();
+		const data = await this.fetch(flags);
+		return this.output(data);
+	}
+}

package/src/commands/action/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 CampaignList 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
+      ) {
+        exportActions(
+          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.exportActions.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/action/replay.mjs

@@ -0,0 +1,54 @@
+import { Args, Flags } from "@oclif/core";
+import { error, stdout, ux } from "@oclif/core/ux";
+import Command from "#src/procaCommand.mjs";
+import { gql, query } from "#src/urql.mjs";
+
+export default class ReplayAction extends Command {
+	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>",
+		}),
+		/*    queue: Flag.string({
+      default: "CUSTOM_ACTION_DELIVER",
+options: [
+    'CUSTOM_ACTION_CONFIRM',
+    'CUSTOM_ACTION_DELIVER',
+    'CUSTOM_SUPPORTER_CONFIRM',
+    'EMAIL_SUPPORTER',
+    'SQS',
+    'WEBHOOK'
+],
+    }),
+*/
+		campaign: Flags.string({
+			char: "c",
+			description: "name of the campaign, % for wildchar",
+			helpValue: "<campaign title>",
+		}),
+	};
+
+	mutate = async (org, id, queue) => {
+		const Document = gql`
+        mutation Requeue($org: String!, $ids: [Int!]!, $queue: Queue!){
+            requeueActions(orgName:$org, ids: $ids, queue: $queue) {
+                count failed
+            }
+        }`;
+	};
+
+	async run() {
+		const { args, flags } = await this.parse();
+		let data = [];
+		const ids = [];
+		data = await this.mutate(flags.org, ids, flags.queue);
+		return this.output(data);
+	}
+}

package/src/commands/campaign/add.mjs

@@ -0,0 +1,101 @@
+import { Args, Flags } from "@oclif/core";
+import { error, stdout, ux } from "@oclif/core/ux";
+import OrgGet from "#src/commands/org/get.mjs";
+import Command from "#src/procaCommand.mjs";
+import { gql, mutation } from "#src/urql.mjs";
+import { getTwitter } from "#src/util/twitter.mjs";
+
+export default class CampaignAdd extends Command {
+	static args = {
+		title: Args.string({
+			description: "title of the campaign",
+			multiple: true,
+		}),
+	};
+	//  static strict = false;
+
+	static examples = [
+		"<%= config.bin %> <%= command.id %> -n <new_campaign> the full name of the campaign",
+	];
+
+	static flags = {
+		// flag with no value (-f, --force)
+		...super.globalFlags,
+		name: Flags.string({
+			char: "n",
+			description: "name of the campaign",
+			helpValue: "<campaign name>",
+			required: true,
+		}),
+		org: Flags.string({
+			char: "o",
+			description: "name of the coordinator",
+			helpValue: "<org name>",
+			required: true,
+		}),
+	};
+
+	create = async (campaign) => {
+		const org = await this.getOrg(campaign.org);
+
+		const config = {
+			locales: {
+				en: {
+					"campaign:": {
+						description: "",
+					},
+					"common:": {},
+				},
+			},
+		};
+		if (org.config.locale && org.config.locale !== "en") {
+			config.locales[org.config.locale] = {};
+		}
+		if (!config.portal) {
+			config.portal = [];
+		}
+		const AddOrgDocument = gql`
+mutation ($org: String!
+$name: String!
+$title: String!
+$config: Json!
+) {
+  addCampaign (input: { name: $name, title: $title, config: $config }, orgName: $org) {
+    name
+    title
+    config
+  }
+}
+    `;
+		const result = await mutation(AddOrgDocument, {
+			org: org.name,
+			name: campaign.name,
+			title: campaign.title,
+			config: JSON.stringify(config),
+		});
+
+		console.log("result", result);
+		return result;
+	};
+
+	async getOrg(orgName) {
+		const { config } = this;
+		const orgGet = new OrgGet({}, this.config);
+		const org = await orgGet.fetch({ name: orgName });
+		return org;
+	}
+
+	async run() {
+		//const { args, flags } = await this.parse(CampaignAdd);
+		const { args, flags } = await this.parse();
+
+		const campaign = {
+			org: flags.org,
+			name: flags.name,
+			title: args.title || flags.name,
+		};
+
+		const data = await this.create(campaign);
+		return this.output(data);
+	}
+}