@adobe/aio-cli-plugin-app-storage 1.0.1 → 1.0.3

package/README.md

@@ -23,8 +23,173 @@ $ aio app state --help
 
 # Commands
 <!-- commands -->
+* [`aio app state delete [KEYS]`](#aio-app-state-delete-keys)
+* [`aio app state get KEY`](#aio-app-state-get-key)
+* [`aio app state list`](#aio-app-state-list)
+* [`aio app state put KEY VALUE`](#aio-app-state-put-key-value)
+* [`aio app state stats`](#aio-app-state-stats)
 * [`aio help [COMMAND]`](#aio-help-command)
 
+## `aio app state delete [KEYS]`
+
+Delete key-values
+
+```
+USAGE
+  $ aio app state delete [KEYS...] [--json] [--region amer|emea] [--match <value>] [--force]
+
+ARGUMENTS
+  KEYS...  keys to delete. Above 5 keys, you will be prompted for confirmation
+
+FLAGS
+  --force            [use with caution!] force delete, no safety prompt
+  --match=<value>    [use with caution!] deletes ALL key-values matching the provided glob-like pattern
+  --region=<option>  State region. Defaults to 'AIO_STATE_REGION' env or 'amer' if neither is set.
+                     <options: amer|emea>
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Delete key-values
+
+ALIASES
+  $ aio app state del
+  $ aio app state remove
+  $ aio app state rm
+
+EXAMPLES
+  $ aio app state delete key
+
+  $ aio app state delete key1 key2 key3
+
+  $ aio app state delete --match 'gl*b'
+
+  $ aio app state delete --match 'gl*b' --json
+
+  $ aio app state delete --match 'be-carreful*' --force
+```
+
+## `aio app state get KEY`
+
+Get a key-value
+
+```
+USAGE
+  $ aio app state get KEY [--json] [--region amer|emea]
+
+ARGUMENTS
+  KEY  State key
+
+FLAGS
+  --region=<option>  State region. Defaults to 'AIO_STATE_REGION' env or 'amer' if neither is set.
+                     <options: amer|emea>
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Get a key-value
+
+EXAMPLES
+  $ aio app state get key
+
+  $ aio app state get key --json
+
+  $ aio app state get key | wc -c
+```
+
+## `aio app state list`
+
+List key-values
+
+```
+USAGE
+  $ aio app state list [--json] [--region amer|emea] [-m <value>]
+
+FLAGS
+  -m, --match=<value>    [default: *] Glob-like pattern to filter keys
+      --region=<option>  State region. Defaults to 'AIO_STATE_REGION' env or 'amer' if neither is set.
+                         <options: amer|emea>
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  List key-values
+
+ALIASES
+  $ aio app state ls
+
+EXAMPLES
+  $ aio app state list
+
+  $ aio app state list --match 'gl*b'
+
+  $ aio app state list --json
+
+  $ aio app state list | less
+
+  $ aio app state list | wc -l
+```
+
+## `aio app state put KEY VALUE`
+
+Put a key-value
+
+```
+USAGE
+  $ aio app state put KEY VALUE [--json] [--region amer|emea] [-t <value>]
+
+ARGUMENTS
+  KEY    State key
+  VALUE  State value
+
+FLAGS
+  -t, --ttl=<value>      Time to live in seconds. Default is 86400 (24 hours), max is 31536000 (1 year).
+      --region=<option>  State region. Defaults to 'AIO_STATE_REGION' env or 'amer' if neither is set.
+                         <options: amer|emea>
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Put a key-value
+
+EXAMPLES
+  $ aio app state put key value
+
+  $ aio app state put key value --ttl 3600
+
+  $ aio app state put key value --json
+
+  $ cat value/from/file | xargs -0 ./bin/run.js app state put key
+```
+
+## `aio app state stats`
+
+Display stats
+
+```
+USAGE
+  $ aio app state stats [--json] [--region amer|emea]
+
+FLAGS
+  --region=<option>  State region. Defaults to 'AIO_STATE_REGION' env or 'amer' if neither is set.
+                     <options: amer|emea>
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Display stats
+
+EXAMPLES
+  $ aio app state stats
+
+  $ aio app state stats --json
+```
+
 ## `aio help [COMMAND]`
 
 Display help for aio.
@@ -43,7 +208,7 @@ DESCRIPTION
   Display help for aio.
 ```
 
-_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.10/src/commands/help.ts)_
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.11/src/commands/help.ts)_
 <!-- commandsstop -->
 
 ## Contributing

package/oclif.manifest.json

@@ -2,7 +2,9 @@
   "commands": {
     "app:state:delete": {
       "aliases": [
-        "app:state:delete"
+        "app:state:del",
+        "app:state:remove",
+        "app:state:rm"
       ],
       "args": {
         "keys": {
@@ -55,11 +57,7 @@
         }
       },
       "hasDynamicHelp": false,
-      "hiddenAliases": [
-        "app:state:del",
-        "app:state:remove",
-        "app:state:rm"
-      ],
+      "hiddenAliases": [],
       "id": "app:state:delete",
       "pluginAlias": "@adobe/aio-cli-plugin-app-storage",
       "pluginName": "@adobe/aio-cli-plugin-app-storage",
@@ -76,9 +74,7 @@
       ]
     },
     "app:state:get": {
-      "aliases": [
-        "app:state:get"
-      ],
+      "aliases": [],
       "args": {
         "key": {
           "description": "State key",
@@ -132,7 +128,7 @@
     },
     "app:state:list": {
       "aliases": [
-        "app:state:list"
+        "app:state:ls"
       ],
       "args": {},
       "description": "List key-values",
@@ -175,9 +171,7 @@
         }
       },
       "hasDynamicHelp": false,
-      "hiddenAliases": [
-        "app:state:ls"
-      ],
+      "hiddenAliases": [],
       "id": "app:state:list",
       "pluginAlias": "@adobe/aio-cli-plugin-app-storage",
       "pluginName": "@adobe/aio-cli-plugin-app-storage",
@@ -194,9 +188,7 @@
       ]
     },
     "app:state:put": {
-      "aliases": [
-        "app:state:put"
-      ],
+      "aliases": [],
       "args": {
         "key": {
           "description": "State key",
@@ -264,9 +256,7 @@
       ]
     },
     "app:state:stats": {
-      "aliases": [
-        "app:state:stats"
-      ],
+      "aliases": [],
       "args": {},
       "description": "Display stats",
       "examples": [
@@ -312,5 +302,5 @@
       ]
     }
   },
-  "version": "1.0.1"
+  "version": "1.0.3"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/aio-cli-plugin-app-storage",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "dependencies": {
     "@adobe/aio-lib-core-config": "^5",
     "@adobe/aio-lib-core-logging": "^3",
@@ -46,7 +46,10 @@
     "repositoryPrefix": "<%- repo %>/blob/<%- version %>/<%- commandPath %>",
     "plugins": [
       "@oclif/plugin-help"
-    ]
+    ],
+    "helpOptions": {
+      "hideAliasesFromRoot": true
+    }
   },
   "main": "src/commands/BaseCommand.js",
   "scripts": {
@@ -55,7 +58,7 @@
     "test": "npm run unit-test && npm run lint",
     "prepack": "oclif manifest && oclif readme --no-aliases",
     "postpack": "rm -f oclif.manifest.json",
-    "version": "oclif readme && git add README.md",
+    "version": "oclif readme --no-aliases && git add README.md",
     "e2e": "node --experimental-vm-modules node_modules/jest/bin/jest.js --collectCoverage=false --testRegex 'e2e/e2e.js'"
   },
   "jest": {

package/src/BaseCommand.js

@@ -22,7 +22,7 @@ export class BaseCommand extends Command {
   async init () {
     await super.init()
     // eslint-disable-next-line node/no-unsupported-features/es-syntax
-    const { readFile } = await import('fs') // dynamic import to be able to mock fs, ESM and Jest are not friends
+    const { readFile } = await import('fs/promises') // dynamic import to be able to mock fs, ESM and Jest are not friends
 
     // setup debug logger
     const command = this.constructor.name.toLowerCase() // hacky but convenient
@@ -52,7 +52,7 @@ export class BaseCommand extends Command {
       const aioSdkVersion = packageJson.dependencies?.['@adobe/aio-sdk']
       if ((aioLibStateVersion && semver.lt(semver.coerce(aioLibStateVersion), '4.0.0')) ||
         (aioSdkVersion && semver.lt(semver.coerce(aioSdkVersion), '6.0.0'))) {
-        this.error('State commands are not available for legacy State, please migrate to "@adobe/aio-lib-state" > 4.0.0 (or "@adobe/aio-sdk" > 6.0.0).')
+        this.error('State commands are not available for legacy State, please migrate to the latest "@adobe/aio-lib-state" (or "@adobe/aio-sdk" >= 6.0.0).')
       }
     }
 

package/src/commands/app/state/delete.js

@@ -112,10 +112,6 @@ Delete.flags = {
 }
 
 Delete.aliases = [
-  'app:state:delete'
-]
-
-Delete.hiddenAliases = [
   'app:state:del',
   'app:state:remove',
   'app:state:rm'

package/src/commands/app/state/get.js

@@ -49,7 +49,3 @@ Get.args = {
     required: true
   })
 }
-
-Get.aliases = [
-  'app:state:get'
-]

package/src/commands/app/state/list.js

@@ -66,9 +66,5 @@ List.flags = {
 }
 
 List.aliases = [
-  'app:state:list'
-]
-// do not show in help
-List.hiddenAliases = [
   'app:state:ls'
 ]

package/src/commands/app/state/put.js

@@ -62,7 +62,3 @@ Put.flags = {
     required: false
   })
 }
-
-Put.aliases = [
-  'app:state:put'
-]

package/src/commands/app/state/stats.js

@@ -30,7 +30,3 @@ Stats.examples = [
   '$ aio app state stats',
   '$ aio app state stats --json'
 ]
-
-Stats.aliases = [
-  'app:state:stats'
-]