@proca/cli 3.3.1 → 3.8.3

package/package.json

@@ -1,83 +1,100 @@
 {
   "name": "@proca/cli",
-  "version": "3.3.1",
-  "description": "cli[ent] for Proca",
-  "main": "dist/index.js",
-  "browser": "dist/browser.js",
-  "types": "dist/index.d.ts",
-  "sideEffects": false,
-  "repository": "git@github.com:TechToThePeople/proca-gw.git",
-  "author": "xavier.dutoit <xavier@tttp.eu>",
-  "license": "AGPL-3.0",
+  "description": "Access the proca api",
+  "version": "3.8.3",
+  "author": "Xavier",
   "bin": {
-    "proca-cli": "bin/proca-cli"
+    "proca": "proca-cli"
   },
-  "scripts": {
-    "test": "echo No tests for proca/cli",
-    "build": "npx tsc",
-    "watch": "npx tsc -w",
-    "codegen": "yarn graphql-codegen",
-    "prepack": "yarn codegen && yarn build"
-  },
-  "files": [
-    "dist",
-    "bin",
-    "README.md"
-  ],
+  "bugs": "https://github.com/fixthestatusquo/git@github.com:fixthestatusquo/proca-cli.git/issues",
   "dependencies": {
-    "@proca/api": "^3.3.1",
-    "@proca/crypto": "^3.3.1",
-    "@types/node-mailjet": "^3.3.4",
-    "amqplib": "^0.8.0",
-    "backoff": "^2.5.0",
-    "base64url": "^3.0.1",
-    "cross-fetch": "^3.0.6",
-    "csv-stringify": "^5.5.1",
-    "dotenv": "^10.0.0",
-    "email-validator": "^2.0.4",
-    "esm": "^3.2.25",
-    "graphql": "15.5.0",
-    "inquirer": "^7.3.3",
-    "line-by-line": "^0.1.6",
-    "node-fetch": "^2.6.1",
-    "node-mailjet": "^3.3.1",
-    "tweetnacl": "^1.0.3",
-    "tweetnacl-util": "^0.15.1",
-    "urql-serialize-scalars-exchange": "1.0.5-0",
-    "yargs": "^16.2.0"
+    "@oclif/core": "^4.2.10",
+    "@oclif/plugin-help": "^6",
+    "@oclif/plugin-plugins": "^5",
+    "@urql/exchange-auth": "^2.2.0",
+    "date-fns": "^4.1.0",
+    "dotenv": "^16.4.5",
+    "dxid": "^2.2.1",
+    "easy-table": "^1.2.0",
+    "fast-csv": "^5.0.1",
+    "graphql": "^16.10.0",
+    "merge-anything": "^6.0.6",
+    "prompts": "^2.4.2",
+    "typescript": "^5.7.3",
+    "urql": "^4.1.0"
   },
   "devDependencies": {
-    "@graphql-codegen/cli": "^1.21.5",
-    "@graphql-codegen/introspection": "^1.18.2",
-    "@graphql-codegen/typed-document-node": "^1.18.6",
-    "@graphql-codegen/typescript": "^1.22.1",
-    "@graphql-codegen/typescript-operations": "^1.18.0",
-    "@types/amqplib": "^0.5.16",
-    "@types/backoff": "^2.5.1",
-    "@types/bent": "^7.3.2",
-    "@types/debug": "^4.1.5",
-    "@types/inquirer": "^7.3.1",
-    "@types/line-by-line": "^0.1.4",
-    "@types/lodash": "^4.14.168",
-    "@types/node": "^14.14.7",
-    "@types/yargs": "^16.0.0",
-    "codegen-graphql-scalar-locations": "1.0.0-0",
-    "ketting": "^7.2.0",
-    "ts-node": "^10.2.1"
+    "@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"
   },
-  "resolutions": {
-    "graphql": "15.5.0"
+  "engines": {
+    "node": ">=18.0.0"
   },
-  "peerDependencies": {
-    "@sentry/node": "^6.13.2",
-    "ketting": "^7.2.0",
-    "typescript": "^4.1.2"
+  "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"
+    ]
   },
-  "optionalDependencies": {
-    "@types/node-mailjet": "^3.3.4",
-    "bent": "^7.3.12",
-    "debug": "^4.3.1",
-    "node-mailjet": "^3.3.1"
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/fixthestatusquo/proca-cli.git"
   },
-  "gitHead": "881678623fc935adea06c46a8c5431e45b9dac3b"
+  "scripts": {
+    "check": "npx @biomejs/biome check --write",
+    "format": "npx @biomejs/biome format --write",
+    "lint": "npx @biomejs/biome lint --write",
+    "prepack": "oclif manifest && oclif readme",
+    "oclif": "oclif manifest && oclif readme",
+    "version": "oclif readme && git add README.md"
+  }
 }

package/proca-cli

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

package/src/commands/action/add.mjs

@@ -0,0 +1,192 @@
+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";
+import { getTwitter } from "#src/util/twitter.mjs";
+
+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();
+  static strict = false; //THIS DOES NOT WORK
+
+  static flags = {
+    ...this.flagify({ multiid: true }),
+    id: Flags.integer({
+      char: "i",
+      description: "widget's id",
+      required: true,
+    }),
+    testing: Flags.boolean({
+      default: true,
+      allowNo: true, // ✅ enables --no-testing
+      description:
+        "Run action in testing mode (default: true). Use --no-testing to disable.",
+    }),
+    optin: Flags.boolean({
+      default: false,
+      allowNo: true, // ✅ enables --no-optin
+      description:
+        "Whether the user opts in (default: false). Use --optin to enable or --no-optin to explicitly disable.",
+    }),
+    action_type: Flags.string({
+      default: "register",
+    }),
+    firstname: Flags.string({
+      description: "supporter's firstname",
+      required: true,
+    }),
+    lastname: Flags.string(),
+    street: Flags.string(),
+    locality: Flags.string(),
+    region: Flags.string(),
+    country: Flags.string({
+      description: "2-letter country iso code",
+      parse: async (input) => {
+        if (input && !/^[A-Za-z]{2}$/.test(input)) {
+          throw new Error("Country code must be exactly 2 letters");
+        }
+        return input?.toUpperCase(); // optional: normalize to uppercase
+      },
+    }),
+    utm: Flags.string({
+      description: "utm=campaign.source.medium",
+    }),
+    email: Flags.string({
+      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) => {
+    const values = {
+      action: {
+        actionType: flags.action_type,
+        customFields: flags.customFields,
+        /*    "mtt": {
+      "body": "body",
+      "files": [
+        "files"
+      ],
+      "subject": "subject",
+      "targets": [
+        "targets"
+      ]
+    },
+*/
+        testing: flags.testing,
+      },
+      actionPageId: flags.id,
+      contact: {
+        address: {
+          country: flags.country,
+          locality: flags.locality,
+          postcode: flags.postcode,
+          region: flags.region,
+          street: flags.street,
+          //      "streetNumber": "streetNumber"
+        },
+        email: flags.email,
+        firstName: flags.firstname,
+        lastName: flags.lastname,
+        phone: flags.phone,
+      },
+      privacy: {
+        //    "leadOptIn": true,
+        optIn: flags.optin,
+      },
+      tracking: {
+        ...flags.tracking,
+        location: "proca-cli/action/add",
+      },
+    };
+
+    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!
+  $actionPageId: Int!
+  $contact: ContactInput!
+  $contactRef: ID
+  $privacy: ConsentInput!
+  $tracking: TrackingInput
+) {
+  addActionContact(
+    action: $action
+    actionPageId: $actionPageId
+    contact: $contact
+    contactRef: $contactRef
+    privacy: $privacy
+    tracking: $tracking
+  ) {
+    contactRef
+    firstName
+  }
+}`;
+
+    const result = await mutation(query, values);
+
+    console.log("result", result);
+    return result;
+  };
+
+  parseUnknownFlags = (argv) => {
+    const knownFlags = Object.entries(ActionAdd.flags).flatMap(([key, def]) => {
+      const chars = def.char ? [def.char] : [];
+      return [key, ...chars];
+    });
+    /* doesn't work static=false has no effect    const unknownFlags = Object.fromEntries(
+      argv
+        .filter(arg =>
+          (/^--?\w+=/.test(arg)) // --key=val or -x=val
+        )
+        .map(arg => {
+          const keyval = arg.replace(/^-+/, '').split('=')
+          return [keyval[0], keyval[1]]
+        })
+        .filter(([key]) => !knownFlags.includes(key))
+    )
+*/
+
+    // Extract key=val style positional args (e.g. foo=bar)
+    const kvArgs = Object.fromEntries(
+      argv
+        .filter((arg) => !arg.startsWith("-") && arg.includes("="))
+        .map((arg) => arg.split("=")),
+    );
+
+    if (!Object.keys(kvArgs).length) return undefined;
+
+    return kvArgs;
+  };
+  async run() {
+    const { args, flags } = await this.parse(ActionAdd, {
+      context: { strict: false /* this does not work*/ },
+    });
+
+    const customFields = this.parseUnknownFlags(this.argv);
+    if (customFields) flags.customFields = JSON.stringify(customFields);
+    if (flags.utm) {
+      const [campaign, source, medium] = flags.utm.split(".");
+      flags.tracking = { source, medium, campaign };
+    } else flags.tracking = {};
+    const data = await this.create(flags);
+    return this.output(data);
+  }
+}

package/src/commands/action/confirm.mjs

@@ -0,0 +1,93 @@
+import { Flags } from "@oclif/core";
+import Command from "#src/procaCommand.mjs";
+import { gql, mutation, query } from "#src/urql.mjs";
+
+export default class Actionconfirm extends Command {
+  static description =
+    "Should the supporter confirm the action? it can be set either for all the widgets or an organisation or all the widgets of a campaign";
+
+  static flags = {
+    ...super.globalFlags,
+    org: Flags.string({
+      aliases: ["name", "o"],
+      description: "organisation collecting the action",
+      exactlyOne: ["org", "campaign"],
+    }),
+    campaign: Flags.string({
+      aliases: ["c"],
+      description: "campaign collecting the action",
+    }),
+    confirm: Flags.boolean({
+      description: "should the supporters confirm each action",
+      default: true,
+      allowNo: true,
+    }),
+    template: Flags.string({
+      description: "template for sending the message",
+    }),
+  };
+
+  async mutate(flags) {
+    const DocumentOrg = gql`
+    mutation UpdateOrgProcessing(
+      $name: String!
+      $confirm: Boolean!
+      $template: String
+    ) {
+      updateOrgProcessing(
+        name: $name
+        supporterConfirmTemplate: $template
+        supporterConfirm: $confirm
+      ) {
+        id
+        name
+        processing {
+          supporterConfirm
+          supporterConfirmTemplate
+        }
+      }
+    }
+  `;
+    const DocumentCampaign = gql`
+    mutation UpdateCampaignProcessing(
+      $name: String!
+      $confirm: Boolean!
+      $template: String
+    ) {
+      updateCampaignProcessing(
+        name: $name
+        supporterConfirmTemplate: $template
+        supporterConfirm: $confirm
+      ) {
+        id
+        name
+        campaignProcessing {
+          supporterConfirm
+          supporterConfirmTemplate
+        }
+      }
+    }
+  `;
+    const Document = flags.org ? DocumentOrg : DocumentCampaign;
+
+    const result = await mutation(Document, {
+      name: flags.org || flags.campaign,
+      confirm: flags.confirm,
+      template: flags.template,
+    });
+    return result.updateOrgProcessing || result.updateCommandProcessing;
+  }
+
+  simplify = (d) => ({
+    id: d.id,
+    name: d.name,
+    template: d.processing.supporterConfirmTemplate,
+    confirm: d.processing.supporterConfirm,
+  });
+  async run() {
+    const { flags } = await this.parse();
+    const result = await this.mutate(flags);
+
+    this.output(result);
+  }
+}

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);
+  }
+}