proca 0.1.1

package/README.md

@@ -0,0 +1,214 @@
+Access the proca api
+
+## usage
+
+### global installation
+  <!-- usage -->
+```sh-session
+$ npm install -g proca
+$ proca COMMAND
+running command...
+$ proca (--version)
+proca/0.1.1 linux-x64 node-v20.12.2
+$ proca --help [COMMAND]
+USAGE
+  $ proca COMMAND
+...
+```
+<!-- usagestop -->
+
+### local development
+
+```sh-session
+   $ git clone https://github.com/fixthestatusquo/proca-cli.git
+   $ git install
+   $ cd proca-cli
+   $./proca-cli --help
+...
+```
+
+### TOPICS
+-  campaign  Handle campaigns
+- org
+-  config    create setting to access the server authentication
+
+### TODO TOPICS
+
+- widget
+- actions
+- service
+- target
+
+# Commands
+<!-- commands -->
+* [`proca campaign get`](#proca-campaign-get)
+* [`proca campaign list [TITLE]`](#proca-campaign-list-title)
+* [`proca config add [ENVIRONMENT]`](#proca-config-add-environment)
+* [`proca config setup [ENVIRONMENT]`](#proca-config-setup-environment)
+* [`proca org get`](#proca-org-get)
+
+## `proca campaign get`
+
+view a campaign
+
+```
+USAGE
+  $ proca campaign get [--simplify [--json | --csv | --table]] [-i <organisation name>]
+    [-n <campaign name>] [--config] [--stats] [--locale <value>]
+
+FLAGS
+  -i, --id=<organisation name>  id of the campaign
+  -n, --name=<campaign name>    name of the campaign
+      --[no-]config             display the config
+      --locale=<value>          display a locale
+      --[no-]stats              display the stats
+
+OUTPUT FLAGS
+  --csv       Format output as csv
+  --json      Format output as json
+  --simplify  flatten and filter to output only the most important attributes
+  --table     Format output as table [default]
+
+DESCRIPTION
+  view a campaign
+
+EXAMPLES
+  $ proca campaign get -i 42
+```
+
+## `proca campaign list [TITLE]`
+
+list all the campaigns
+
+```
+USAGE
+  $ proca campaign list [TITLE] [--simplify [--json | --csv | --table]] [-o <organisation
+    name> | -t <campaign title>] [--stats]
+
+ARGUMENTS
+  TITLE  name of the campaign, % for wildchar
+
+FLAGS
+  -o, --org=<organisation name>  campaigns of the organisation (coordinator or partner)
+  -t, --title=<campaign title>   name of the campaign, % for wildchar
+      --[no-]stats               display the stats
+
+OUTPUT FLAGS
+  --csv       Format output as csv
+  --json      Format output as json
+  --simplify  flatten and filter to output only the most important attributes
+  --table     Format output as table [default]
+
+DESCRIPTION
+  list all the campaigns
+
+EXAMPLES
+  $ proca campaign list %pizza%
+```
+
+## `proca config add [ENVIRONMENT]`
+
+create setting to access the server authentication
+
+```
+USAGE
+  $ proca config add [ENVIRONMENT] --token <API-token> [--simplify [--json | --csv |
+    --table]] [--force] [--url <url>] [--n8n <n8n api>] [--supabase <url>] [--supabase-anon-key <value>]
+    [--supabase-secrey-key <value>]
+
+ARGUMENTS
+  ENVIRONMENT  [default: default] environment
+
+FLAGS
+  --force                        write over an existing configuration
+  --n8n=<n8n api>                api access on the n8n server
+  --supabase=<url>               url of the supabase
+  --supabase-anon-key=<value>    anonymous key
+  --supabase-secrey-key=<value>  secret service key
+  --token=<API-token>            (required) user token on proca server
+  --url=<url>                    [default: https://api.proca.app/api] url of the proca server api
+
+OUTPUT FLAGS
+  --csv       Format output as csv
+  --json      Format output as json
+  --simplify  flatten and filter to output only the most important attributes
+  --table     Format output as table [default]
+
+DESCRIPTION
+  create setting to access the server authentication
+
+ALIASES
+  $ proca config setup
+
+EXAMPLES
+  $ proca config add --user=xavier@example.org --token=API-12345789
+```
+
+## `proca config setup [ENVIRONMENT]`
+
+create setting to access the server authentication
+
+```
+USAGE
+  $ proca config setup [ENVIRONMENT] --token <API-token> [--simplify [--json | --csv |
+    --table]] [--force] [--url <url>] [--n8n <n8n api>] [--supabase <url>] [--supabase-anon-key <value>]
+    [--supabase-secrey-key <value>]
+
+ARGUMENTS
+  ENVIRONMENT  [default: default] environment
+
+FLAGS
+  --force                        write over an existing configuration
+  --n8n=<n8n api>                api access on the n8n server
+  --supabase=<url>               url of the supabase
+  --supabase-anon-key=<value>    anonymous key
+  --supabase-secrey-key=<value>  secret service key
+  --token=<API-token>            (required) user token on proca server
+  --url=<url>                    [default: https://api.proca.app/api] url of the proca server api
+
+OUTPUT FLAGS
+  --csv       Format output as csv
+  --json      Format output as json
+  --simplify  flatten and filter to output only the most important attributes
+  --table     Format output as table [default]
+
+DESCRIPTION
+  create setting to access the server authentication
+
+ALIASES
+  $ proca config setup
+
+EXAMPLES
+  $ proca config setup --user=xavier@example.org --token=API-12345789
+```
+
+## `proca org get`
+
+view a org
+
+```
+USAGE
+  $ proca org get [--simplify [--json | --csv | --table]] [-n <org name>] [--config]
+    [--keys] [--campaigns] [--widgets] [--users]
+
+FLAGS
+  -n, --name=<org name>  name of the org
+  --[no-]campaigns
+      --[no-]config      display the config
+  --[no-]keys
+  --[no-]users
+  --[no-]widgets
+
+OUTPUT FLAGS
+  --csv       Format output as csv
+  --json      Format output as json
+  --simplify  flatten and filter to output only the most important attributes
+  --table     Format output as table [default]
+
+DESCRIPTION
+  view a org
+
+EXAMPLES
+  $ proca org get <name of the ngo>
+```
+<!-- commandsstop -->

package/package.json

@@ -0,0 +1,66 @@
+{
+	"name": "proca",
+	"description": "Access the proca api",
+	"version": "0.1.1",
+	"author": "=Xavier",
+	"bin": {
+		"proca": "./proca-cli"
+	},
+	"bugs": "https://github.com/fixthestatusquo/git@github.com:fixthestatusquo/proca-cli.git/issues",
+	"dependencies": {
+		"@oclif/core": "^4",
+		"@oclif/plugin-help": "^6",
+		"@oclif/plugin-plugins": "^5",
+		"@urql/exchange-auth": "^2.2.0",
+		"dotenv": "^16.4.5",
+		"easy-table": "^1.2.0",
+		"fast-csv": "^5.0.1",
+		"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-not-found": "^3.2.22",
+		"lefthook": "^1.7.18",
+		"oclif": "^4"
+	},
+	"engines": {
+		"node": ">=18.0.0"
+	},
+	"files": ["/proca-cli", "/src", "/theme.json"],
+	"homepage": "https://github.com/fixthestatusquo/git@github.com:fixthestatusquo/proca-cli.git",
+	"keywords": ["oclif"],
+	"imports": {
+		"#src/*": "./src/*"
+	},
+	"license": "aGPL3",
+	"main": "src/index.js",
+	"oclif": {
+		"repository": "github:fixthestatusquo/proca-cli",
+		"bin": "proca",
+		"theme": "theme.json",
+		"topicSeparator": " ",
+		"commands": "./src/commands",
+		"topics": {
+			"widget": {
+				"description": "Manage widgets"
+			},
+			"campaign": {
+				"description": "Handle campaigns"
+			}
+		},
+		"plugins": []
+	},
+	"repository": "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/campaign/get.mjs

@@ -0,0 +1,121 @@
+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 CampaignGet extends Command {
+	actionTypes = new Set();
+
+	static args = {};
+
+	static description = "view a campaign";
+
+	static examples = ["<%= config.bin %> <%= command.id %> -i 42"];
+
+	static flags = {
+		// flag with no value (-f, --force)
+		...super.globalFlags,
+		id: Flags.string({
+			char: "i",
+			parse: (input) => {
+				return Number.parseInt(input, 10);
+			},
+			description: "id of the campaign",
+			exactlyOne: ["id", "name"],
+			helpValue: "<organisation name>",
+		}),
+		name: Flags.string({
+			char: "n",
+			description: "name of the campaign",
+			helpValue: "<campaign name>",
+		}),
+		config: Flags.boolean({
+			description: "display the config",
+			default: false,
+			allowNo: true,
+		}),
+		stats: Flags.boolean({
+			description: "display the stats",
+			default: true,
+			allowNo: true,
+		}),
+		locale: Flags.string({
+			description: "display a locale",
+		}),
+	};
+
+	Get = async (id, name) => {
+		const GetCampaignDocument = gql`
+      query GetCampaign($id: Int, $name: String, $withStats: Boolean = false) {
+        campaign (name: $name, id: $id) {
+          ...Summary
+          ...Org
+          config
+          ...Stats @include(if: $withStats)
+        }
+      }
+      ${FragmentStats}
+      ${FragmentSummary}
+      ${FragmentOrg}
+    `;
+		const result = await query(GetCampaignDocument, {
+			id: id,
+			name: name,
+			withStats: this.flags.stats,
+		});
+		return result.campaign;
+	};
+
+	simplify = (d) => {
+		const result = {
+			id: d.id,
+			Name: d.name,
+			Title: d.title,
+			Org: d.org.name,
+			Status: d.status,
+			locales: d.config.locales && Object.keys(d.config.locales).join(" "),
+			journey: d.config.journey?.join(" → "),
+		};
+		if (this.flags.stats) {
+			result["#Supporters"] = d.stats.supporterCount;
+
+			this.actionTypes.forEach((type) => {
+				const action = d.stats.actionCount.find(
+					(action) => action.actionType === type,
+				);
+				if (action) result[`#${type}`] = action.count;
+			});
+		}
+		return result;
+	};
+
+	table = (r) => {
+		r.config = JSON.parse(r.config);
+		super.table(this.simplify(r), null, null);
+		if (this.flags.locale) {
+			this.prettyJson(r.config.locales[this.flags.locale]);
+		}
+		if (this.flags.config) {
+			r.config.locales = undefined;
+			this.prettyJson(r.config);
+		}
+	};
+
+	async run() {
+		const { args, flags } = await this.parse();
+
+		const data = await this.Get(flags.id, flags.name);
+		if (this.flags.stats) {
+			data.stats.actionCount.forEach((d) => {
+				//skip share_confirmed?
+				this.actionTypes.add(d.actionType);
+			});
+		}
+		return this.output(data);
+	}
+}

package/src/commands/campaign/list.mjs

@@ -0,0 +1,165 @@
+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 description = "list all the campaigns";
+
+	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)",
+			exclusive: ["title"],
+			helpValue: "<organisation name>",
+		}),
+		title: Flags.string({
+			char: "t",
+			description: "name of the campaign, % for wildchar",
+			exclusive: ["org"],
+			helpValue: "<campaign title>",
+		}),
+		stats: Flags.boolean({
+			description: "display the stats",
+			default: true,
+			allowNo: true,
+		}),
+	};
+
+	OrgSearch = async (name) => {
+		const SearchCampaignsDocument = gql`
+      query SearchCampaigns($org: String!, $withStats: Boolean = false) {
+        org (name:$org) {
+        campaigns {
+          ...Summary
+          ...Org
+          ...Stats @include(if: $withStats)
+        }
+        }
+      }
+      ${FragmentStats}
+      ${FragmentOrg}
+      ${FragmentSummary}
+    `;
+		const result = await query(SearchCampaignsDocument, {
+			org: name,
+			withStats: this.flags.stats,
+		});
+		return result.org.campaigns;
+		//return result.campaigns.map (d => {d.config = JSON.parse(d.config); return d});
+	};
+
+	Search = async (title) => {
+		const SearchCampaignsDocument = gql`
+      query SearchCampaigns($title: String!, $withStats: Boolean = false) {
+        campaigns(title: $title) {
+          ...Summary
+          ...Org
+          ...Stats @include(if: $withStats)
+        }
+      }
+      ${FragmentStats}
+      ${FragmentOrg}
+      ${FragmentSummary}
+    `;
+		const result = await query(SearchCampaignsDocument, {
+			title: title,
+			withStats: this.flags.stats,
+		});
+		return result.campaigns;
+		//return result.campaigns.map (d => {d.config = JSON.parse(d.config); return d});
+	};
+
+	simplify = (d, context) => {
+		const result = {
+			id: d.id,
+			Name: d.name,
+			Title: d.title,
+			Org: d.org.name,
+			Status: d.status,
+		};
+		if (this.flags.stats) {
+			result["#Supporters"] = d.stats.supporterCount;
+
+			this.actionTypes.forEach((type) => {
+				const action = d.stats.actionCount.find(
+					(action) => action.actionType === type,
+				);
+				if (action) result[`#${type}`] = action.count;
+			});
+		}
+		return result;
+	};
+
+	table = (r) => {
+		super.table(
+			r,
+			(d, cell) => {
+				for (const [key, value] of Object.entries(this.simplify(d))) {
+					cell(key, value);
+				}
+			},
+			(table) => table.sort(["ID"]).toString(),
+		);
+	};
+
+	async run() {
+		const { args, flags } = await this.parse(CampaignList);
+		let data = [];
+
+		if (args.title && flags.title) {
+			throw new Error(
+				`${this.id} EITHER [title of the campaign] OR --title [title of the campaign]`,
+			);
+		}
+		if (args.title) {
+			flags.title = args.title;
+		}
+
+		if (!flags.title && !flags.org) {
+			throw new Error(
+				`${this.id} -t [title of the campaign] or -o [organisation]`,
+			);
+		}
+
+		if (flags.title) {
+			data = await this.Search(flags.title);
+			if (this.flags.stats) {
+				data.forEach((d) => {
+					d.stats.actionCount.forEach((d) => {
+						//skip share_confirmed?
+						this.actionTypes.add(d.actionType);
+					});
+				});
+			}
+		}
+
+		if (flags.org) {
+			data = await this.OrgSearch(flags.org);
+			if (this.flags.stats) {
+				data.forEach((d) => {
+					d.stats.actionCount.forEach((d) => {
+						//skip share_confirmed?
+						this.actionTypes.add(d.actionType);
+					});
+				});
+			}
+		}
+		return this.output(data);
+	}
+}

package/src/commands/campaign/queries.graphql

@@ -0,0 +1,19 @@
+query SearchCampaigns($name: String!) {
+	campaigns(name: $name) {
+		id
+		name
+		title
+		config
+	}
+}
+
+query GetOrgCampaigns($org: String!) {
+	org(name: $org) {
+		campaigns {
+			id
+			name
+			title
+			config
+		}
+	}
+}

package/src/commands/config/add.mjs

@@ -0,0 +1,108 @@
+import { Args, Flags } from "@oclif/core";
+import { error, stdout, ux } from "@oclif/core/ux";
+import { get as getConfig, getFilename, write } from "#src/config.mjs";
+import Command from "#src/procaCommand.mjs";
+
+export default class CampaignList extends Command {
+	static enableJsonFlag = true;
+	static aliases = ["config:setup"];
+	static deprecateAliases = true;
+
+	static args = {
+		environment: Args.string({
+			description: "environment",
+			default: "default",
+		}),
+	};
+
+	static description = "create setting to access the server authentication";
+
+	static examples = [
+		"<%= config.bin %> <%= command.id %> --user=xavier@example.org --token=API-12345789",
+	];
+
+	static flags = {
+		// flag with no value (-f, --force)
+		...super.globalFlags,
+		force: Flags.boolean({
+			description: "write over an existing configuration",
+			default: false,
+			helpValue: "(default false)",
+		}),
+		url: Flags.string({
+			description: "url of the proca server api",
+			default: "https://api.proca.app/api",
+			helpValue: "<url>",
+		}),
+		token: Flags.string({
+			description: "user token on proca server",
+			helpValue: "<API-token>",
+			required: true,
+		}),
+		n8n: Flags.string({
+			description: "api access on the n8n server",
+			helpValue: "<n8n api>",
+		}),
+		supabase: Flags.string({
+			description: "url of the supabase",
+			helpValue: "<url>",
+		}),
+		"supabase-anon-key": Flags.string({
+			description: "anonymous key",
+		}),
+		"supabase-secrey-key": Flags.string({
+			description: "secret service key",
+		}),
+	};
+
+	format = (obj) => {
+		const content = ["# generated by proca-api"];
+		for (const [key, value] of Object.entries(obj)) {
+			if (value) {
+				content.push(`${key}='${value.replace(/'/g, "''")}'`);
+			} else {
+				content.push(`#${key}= `);
+			}
+		}
+		return content.join("\n");
+	};
+
+	generate = function () {
+		console.log(this.flags);
+
+		const mapping = {
+			REACT_APP_NAME: "proca",
+			REACT_APP_API_URL: this.flags.url,
+			PROCA_TOKEN: this.flags.token,
+			N8N_TOKEN: this.flags.n8n,
+			REACT_APP_SUPABASE_URL: this.flags.supabase,
+			REACT_APP_SUPABASE_ANON_KEY: this.flags.supabase_anon_key,
+			SUPABASE_SECRET_KEY: this.flags.supabase_secret_key,
+		};
+
+		return this.format(mapping);
+	};
+
+	async run() {
+		const { args, flags } = await this.parse();
+		const file = getFilename(this.config.configDir);
+		let exists = true;
+		const userConfig = getConfig({
+			folder: this.config.configDir,
+			onMissing: (missingFile) => {
+				exists = false;
+			},
+		});
+		if (exists && !this.flags.force) {
+			this.error("config file exists already", {
+				code: "CONFIG_ERR",
+				_ref: "README.md#",
+				suggestions: [
+					`edit ${file}`,
+					"add --force flag\nWARNING, it will delete the existing file",
+				],
+			});
+		}
+		write(file, this.generate());
+	}
+}