proca 0.1.2 → 0.2.0

package/README.md

@@ -18,7 +18,7 @@ $ npm install -g proca
 $ proca COMMAND
 running command...
 $ proca (--version)
-proca/0.1.2 linux-x64 node-v20.12.2
+proca/0.2.0 linux-x64 node-v20.12.2
 $ proca --help [COMMAND]
 USAGE
   $ proca COMMAND
@@ -50,11 +50,87 @@ USAGE
 
 # Commands
 <!-- commands -->
+* [`proca action list [TITLE]`](#proca-action-list-title)
+* [`proca campaign delete`](#proca-campaign-delete)
 * [`proca campaign get`](#proca-campaign-get)
 * [`proca campaign list [TITLE]`](#proca-campaign-list-title)
 * [`proca config add [ENVIRONMENT]`](#proca-config-add-environment)
+* [`proca config get`](#proca-config-get)
 * [`proca config setup [ENVIRONMENT]`](#proca-config-setup-environment)
+* [`proca config user`](#proca-config-user)
+* [`proca help [COMMAND]`](#proca-help-command)
+* [`proca org add`](#proca-org-add)
 * [`proca org get`](#proca-org-get)
+* [`proca org join`](#proca-org-join)
+* [`proca plugins`](#proca-plugins)
+* [`proca plugins add PLUGIN`](#proca-plugins-add-plugin)
+* [`proca plugins:inspect PLUGIN...`](#proca-pluginsinspect-plugin)
+* [`proca plugins install PLUGIN`](#proca-plugins-install-plugin)
+* [`proca plugins link PATH`](#proca-plugins-link-path)
+* [`proca plugins remove [PLUGIN]`](#proca-plugins-remove-plugin)
+* [`proca plugins reset`](#proca-plugins-reset)
+* [`proca plugins uninstall [PLUGIN]`](#proca-plugins-uninstall-plugin)
+* [`proca plugins unlink [PLUGIN]`](#proca-plugins-unlink-plugin)
+* [`proca plugins update`](#proca-plugins-update)
+* [`proca user get`](#proca-user-get)
+* [`proca user leave`](#proca-user-leave)
+* [`proca user list`](#proca-user-list)
+* [`proca widget list`](#proca-widget-list)
+
+## `proca action list [TITLE]`
+
+```
+USAGE
+  $ proca action list [TITLE] -o <organisation name> [--simplify [--json | --csv |
+    --table]] [-c <campaign title>] [--limit <value>] [--optin] [--testing] [--doi] [--utm]
+
+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)
+      --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
+      --[no-]utm                   display the utm tracking parameters
+
+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]
+
+EXAMPLES
+  $ proca action list %pizza%
+```
+
+## `proca campaign delete`
+
+delete a campaign
+
+```
+USAGE
+  $ proca campaign delete [--simplify [--json | --csv | --table]] [-i <organisation name>]
+    [-n <campaign name>]
+
+FLAGS
+  -i, --id=<organisation name>  id of the campaign
+  -n, --name=<campaign name>    name of the campaign
+
+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
+  delete a campaign
+
+EXAMPLES
+  $ proca campaign delete -i 42
+```
 
 ## `proca campaign get`
 
@@ -92,7 +168,7 @@ list all the campaigns
 ```
 USAGE
   $ proca campaign list [TITLE] [--simplify [--json | --csv | --table]] [-o <organisation
-    name> | -t <campaign title>] [--stats]
+    name>] [-t <campaign title>] [--stats]
 
 ARGUMENTS
   TITLE  name of the campaign, % for wildchar
@@ -153,6 +229,24 @@ EXAMPLES
   $ proca config add --user=xavier@example.org --token=API-12345789
 ```
 
+## `proca config get`
+
+get the server config
+
+```
+USAGE
+  $ proca config get [--simplify [--json | --csv | --table]]
+
+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
+  get the server config
+```
+
 ## `proca config setup [ENVIRONMENT]`
 
 create setting to access the server authentication
@@ -191,6 +285,68 @@ EXAMPLES
   $ proca config setup --user=xavier@example.org --token=API-12345789
 ```
 
+## `proca config user`
+
+fetch the information about the current user (based on the token)
+
+```
+USAGE
+  $ proca config user [--simplify [--json | --csv | --table]]
+
+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
+  fetch the information about the current user (based on the token)
+
+EXAMPLES
+  $ proca config user
+```
+
+## `proca help [COMMAND]`
+
+Display help for proca.
+
+```
+USAGE
+  $ proca help [COMMAND...] [-n]
+
+ARGUMENTS
+  COMMAND...  Command to show help for.
+
+FLAGS
+  -n, --nested-commands  Include all nested commands in the output.
+
+DESCRIPTION
+  Display help for proca.
+```
+
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.14/src/commands/help.ts)_
+
+## `proca org add`
+
+```
+USAGE
+  $ proca org add [--simplify [--json | --csv | --table]] [--twitter <screen name>]
+    [-n <org name>]
+
+FLAGS
+  -n, --name=<org name>        name of the org
+      --twitter=<screen name>  twitter account
+
+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]
+
+EXAMPLES
+  $ proca org add --twitter <twitter of the organisation>
+```
+
 ## `proca org get`
 
 view a org
@@ -220,4 +376,426 @@ DESCRIPTION
 EXAMPLES
   $ proca org get <name of the ngo>
 ```
+
+## `proca org join`
+
+let a user join an organisation with a role
+
+```
+USAGE
+  $ proca org join [--simplify [--json | --csv | --table]] [--user <value>] [--role
+    owner|campaigner|coordinator|translator] [-o <org name>]
+
+FLAGS
+  -o, --org=<org name>  name of the org
+      --role=<option>   permission level in that org
+                        <options: owner|campaigner|coordinator|translator>
+      --user=<value>    user email
+
+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
+  let a user join an organisation with a role
+
+EXAMPLES
+  $ proca org join
+```
+
+## `proca plugins`
+
+List installed plugins.
+
+```
+USAGE
+  $ proca plugins [--json] [--core]
+
+FLAGS
+  --core  Show core plugins.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  List installed plugins.
+
+EXAMPLES
+  $ proca plugins
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.14/src/commands/plugins/index.ts)_
+
+## `proca plugins add PLUGIN`
+
+Installs a plugin into proca.
+
+```
+USAGE
+  $ proca plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]
+
+ARGUMENTS
+  PLUGIN...  Plugin to install.
+
+FLAGS
+  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
+  -h, --help     Show CLI help.
+  -s, --silent   Silences npm output.
+  -v, --verbose  Show verbose npm output.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Installs a plugin into proca.
+
+  Uses npm to install plugins.
+
+  Installation of a user-installed plugin will override a core plugin.
+
+  Use the PROCA_NPM_LOG_LEVEL environment variable to set the npm loglevel.
+  Use the PROCA_NPM_REGISTRY environment variable to set the npm registry.
+
+ALIASES
+  $ proca plugins add
+
+EXAMPLES
+  Install a plugin from npm registry.
+
+    $ proca plugins add myplugin
+
+  Install a plugin from a github url.
+
+    $ proca plugins add https://github.com/someuser/someplugin
+
+  Install a plugin from a github slug.
+
+    $ proca plugins add someuser/someplugin
+```
+
+## `proca plugins:inspect PLUGIN...`
+
+Displays installation properties of a plugin.
+
+```
+USAGE
+  $ proca plugins inspect PLUGIN...
+
+ARGUMENTS
+  PLUGIN...  [default: .] Plugin to inspect.
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Displays installation properties of a plugin.
+
+EXAMPLES
+  $ proca plugins inspect myplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.14/src/commands/plugins/inspect.ts)_
+
+## `proca plugins install PLUGIN`
+
+Installs a plugin into proca.
+
+```
+USAGE
+  $ proca plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]
+
+ARGUMENTS
+  PLUGIN...  Plugin to install.
+
+FLAGS
+  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
+  -h, --help     Show CLI help.
+  -s, --silent   Silences npm output.
+  -v, --verbose  Show verbose npm output.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Installs a plugin into proca.
+
+  Uses npm to install plugins.
+
+  Installation of a user-installed plugin will override a core plugin.
+
+  Use the PROCA_NPM_LOG_LEVEL environment variable to set the npm loglevel.
+  Use the PROCA_NPM_REGISTRY environment variable to set the npm registry.
+
+ALIASES
+  $ proca plugins add
+
+EXAMPLES
+  Install a plugin from npm registry.
+
+    $ proca plugins install myplugin
+
+  Install a plugin from a github url.
+
+    $ proca plugins install https://github.com/someuser/someplugin
+
+  Install a plugin from a github slug.
+
+    $ proca plugins install someuser/someplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.14/src/commands/plugins/install.ts)_
+
+## `proca plugins link PATH`
+
+Links a plugin into the CLI for development.
+
+```
+USAGE
+  $ proca plugins link PATH [-h] [--install] [-v]
+
+ARGUMENTS
+  PATH  [default: .] path to plugin
+
+FLAGS
+  -h, --help          Show CLI help.
+  -v, --verbose
+      --[no-]install  Install dependencies after linking the plugin.
+
+DESCRIPTION
+  Links a plugin into the CLI for development.
+
+  Installation of a linked plugin will override a user-installed or core plugin.
+
+  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
+  command will override the user-installed or core plugin implementation. This is useful for development work.
+
+
+EXAMPLES
+  $ proca plugins link myplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.14/src/commands/plugins/link.ts)_
+
+## `proca plugins remove [PLUGIN]`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ proca plugins remove [PLUGIN...] [-h] [-v]
+
+ARGUMENTS
+  PLUGIN...  plugin to uninstall
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Removes a plugin from the CLI.
+
+ALIASES
+  $ proca plugins unlink
+  $ proca plugins remove
+
+EXAMPLES
+  $ proca plugins remove myplugin
+```
+
+## `proca plugins reset`
+
+Remove all user-installed and linked plugins.
+
+```
+USAGE
+  $ proca plugins reset [--hard] [--reinstall]
+
+FLAGS
+  --hard       Delete node_modules and package manager related files in addition to uninstalling plugins.
+  --reinstall  Reinstall all plugins after uninstalling.
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.14/src/commands/plugins/reset.ts)_
+
+## `proca plugins uninstall [PLUGIN]`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ proca plugins uninstall [PLUGIN...] [-h] [-v]
+
+ARGUMENTS
+  PLUGIN...  plugin to uninstall
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Removes a plugin from the CLI.
+
+ALIASES
+  $ proca plugins unlink
+  $ proca plugins remove
+
+EXAMPLES
+  $ proca plugins uninstall myplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.14/src/commands/plugins/uninstall.ts)_
+
+## `proca plugins unlink [PLUGIN]`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ proca plugins unlink [PLUGIN...] [-h] [-v]
+
+ARGUMENTS
+  PLUGIN...  plugin to uninstall
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Removes a plugin from the CLI.
+
+ALIASES
+  $ proca plugins unlink
+  $ proca plugins remove
+
+EXAMPLES
+  $ proca plugins unlink myplugin
+```
+
+## `proca plugins update`
+
+Update installed plugins.
+
+```
+USAGE
+  $ proca plugins update [-h] [-v]
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Update installed plugins.
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.14/src/commands/plugins/update.ts)_
+
+## `proca user get`
+
+fetch the information about a user
+
+```
+USAGE
+  $ proca user get [--simplify [--json | --csv | --table]] [--email <value>] [-o <org
+    name>] [-i <value>]
+
+FLAGS
+  -i, --id=<value>      id of the user
+  -o, --org=<org name>  name of the org
+      --email=<value>   user email
+
+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
+  fetch the information about a user
+
+EXAMPLES
+  $ proca user get
+```
+
+## `proca user leave`
+
+leave a org
+
+```
+USAGE
+  $ proca user leave --email <user email> -o <org name> [--simplify [--json | --csv |
+    --table]]
+
+FLAGS
+  -o, --org=<org name>      (required) name of the org
+      --email=<user email>  (required) email
+
+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
+  leave a org
+
+EXAMPLES
+  $ proca user leave -i 42
+```
+
+## `proca user list`
+
+list all the users
+
+```
+USAGE
+  $ proca user list -o <value> [--simplify [--json | --csv | --table]]
+
+FLAGS
+  -o, --org=<value>  (required) organisation
+
+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 users
+
+EXAMPLES
+  $ proca user list %pizza%
+```
+
+## `proca widget list`
+
+list all the widgets of an org or campaign
+
+```
+USAGE
+  $ proca widget list [--simplify [--json | --csv | --table]] [-o <organisation name>]
+    [-c <campaign name>] [--config]
+
+FLAGS
+  -c, --campaign=<campaign name>  widgets of the campaign (coordinator or partner)
+  -o, --org=<organisation name>   widgets of the organisation (coordinator or partner)
+      --[no-]config               get the config
+
+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 widgets of an org or campaign
+
+EXAMPLES
+  $ proca widget list -o <organisation>
+```
 <!-- commandsstop -->

package/package.json

@@ -1,8 +1,8 @@
 {
 	"name": "proca",
 	"description": "Access the proca api",
-	"version": "0.1.2",
-	"author": "=Xavier",
+	"version": "0.2.0",
+	"author": "Xavier",
 	"bin": {
 		"proca": "./proca-cli"
 	},
@@ -24,6 +24,7 @@
 		"@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"
@@ -31,29 +32,58 @@
 	"engines": {
 		"node": ">=18.0.0"
 	},
-	"files": ["/proca-cli", "/src", "/theme.json"],
+	"files": [
+		"/proca-cli",
+		"/src",
+		"/theme.json"
+	],
 	"homepage": "https://github.com/fixthestatusquo/git@github.com:fixthestatusquo/proca-cli.git",
-	"keywords": ["oclif"],
+	"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": "src/index.js",
+	"main": "./proca-cli",
 	"oclif": {
 		"repository": "github:fixthestatusquo/proca-cli",
 		"bin": "proca",
 		"theme": "theme.json",
 		"topicSeparator": " ",
 		"commands": "./src/commands",
+		"_hooks": {
+			"init": "./src/hooks/init.mjs"
+		},
 		"topics": {
 			"widget": {
-				"description": "Manage widgets"
+				"description": "widgets (actionPages in the API)"
 			},
 			"campaign": {
-				"description": "Handle campaigns"
+				"description": "campaigns"
+			},
+			"user": {
+				"description": "campaigners and other users"
 			}
 		},
-		"plugins": []
+		"plugins": [
+			"@oclif/plugin-plugins",
+			"@oclif/plugin-help",
+			"@oclif/plugin-commands"
+		]
 	},
 	"repository": "git@github.com:fixthestatusquo/proca-cli.git",
 	"scripts": {