@contentstack/cli-cm-import 1.20.2 → 1.21.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -47,7 +47,7 @@ $ npm install -g @contentstack/cli-cm-import
47
47
  $ csdx COMMAND
48
48
  running command...
49
49
  $ csdx (--version)
50
- @contentstack/cli-cm-import/1.20.2 linux-x64 node-v22.14.0
50
+ @contentstack/cli-cm-import/1.21.0 linux-x64 node-v22.14.0
51
51
  $ csdx --help [COMMAND]
52
52
  USAGE
53
53
  $ csdx COMMAND
@@ -59,7 +59,7 @@ USAGE
59
59
 
60
60
  <!-- commands -->
61
61
  * [`csdx cm:stacks:import [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--backup-dir <value>] [--branch <value>] [--import-webhook-status disable|current]`](#csdx-cmstacksimport--c-value--k-value--d-value--a-value---module-value---backup-dir-value---branch-value---import-webhook-status-disablecurrent)
62
- * [`csdx cm:stacks:import [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--backup-dir <value>] [--branch <value>] [--import-webhook-status disable|current]`](#csdx-cmstacksimport--c-value--k-value--d-value--a-value---module-value---backup-dir-value---branch-value---import-webhook-status-disablecurrent-1)
62
+ * [`csdx cm:stacks:import [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--backup-dir <value>] [--branch <value>] [--import-webhook-status disable|current]`](#csdx-cmstacksimport--c-value--k-value--d-value--a-value---module-value---backup-dir-value---branch-value---import-webhook-status-disablecurrent)
63
63
 
64
64
  ## `csdx cm:stacks:import [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--backup-dir <value>] [--branch <value>] [--import-webhook-status disable|current]`
65
65
 
@@ -67,39 +67,41 @@ Import content from a stack
67
67
 
68
68
  ```
69
69
  USAGE
70
- $ csdx cm:stacks:import [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--backup-dir <value>]
71
- [--branch <value>] [--import-webhook-status disable|current]
70
+ $ csdx cm:import cm:stacks:import [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>]
71
+ [--backup-dir <value>] [--branch <value>] [--import-webhook-status disable|current]
72
72
 
73
73
  FLAGS
74
- -B, --branch=<value> The name of the branch where you want to import your content. If you don't mention
75
- the branch name, then by default the content will be imported to the main branch.
76
- -a, --alias=<value> The management token of the destination stack where you will import the content.
77
- -b, --backup-dir=<value> [optional] Backup directory name when using specific module.
78
- -c, --config=<value> [optional] The path of the configuration JSON file containing all the options for
79
- a single run.
80
- -d, --data-dir=<value> The path or the location in your file system where the content, you intend to
81
- import, is stored. For example, -d "C:\Users\Name\Desktop\cli\content". If the
82
- export folder has branches involved, then the path should point till the
83
- particular branch. For example, “-d
84
- "C:\Users\Name\Desktop\cli\content\branch_name"
85
- -k, --stack-api-key=<value> API Key of the target stack
86
- -m, --module=<value> [optional] Specify the module to import into the target stack. If not specified,
87
- the import command will import all the modules into the stack. The available
88
- modules are assets, content-types, entries, environments, extensions,
89
- marketplace-apps, global-fields, labels, locales, webhooks, workflows,
90
- custom-roles, and taxonomies.
91
- -y, --yes [optional] Force override all Marketplace prompts.
92
- --exclude-global-modules Excludes the branch-independent module from the import operation.
93
- --import-webhook-status=<option> [default: disable] [default: disable] (optional) This webhook state keeps the same
94
- state of webhooks as the source stack. <options: disable|current>
95
- <options: disable|current>
96
- --personalize-project-name=<value> (optional) Provide a unique name for the Personalize project.
97
- --replace-existing Replaces the existing module in the target stack.
98
- --skip-app-recreation (optional) Skips the recreation of private apps if they already exist.
99
- --skip-assets-publish Skips asset publishing during the import process.
100
- --skip-audit Skips the audit fix that occurs during an import operation.
101
- --skip-entries-publish Skips entry publishing during the import process
102
- --skip-existing Skips the module exists warning messages.
74
+ -B, --branch=<value> The name of the branch where you want to import your content. If you don't
75
+ mention the branch name, then by default the content will be imported to the
76
+ main branch.
77
+ -a, --alias=<value> The management token of the destination stack where you will import the
78
+ content.
79
+ -b, --backup-dir=<value> [optional] Backup directory name when using specific module.
80
+ -c, --config=<value> [optional] The path of the configuration JSON file containing all the options
81
+ for a single run.
82
+ -d, --data-dir=<value> The path or the location in your file system where the content, you intend to
83
+ import, is stored. For example, -d "C:\Users\Name\Desktop\cli\content". If the
84
+ export folder has branches involved, then the path should point till the
85
+ particular branch. For example, “-d
86
+ "C:\Users\Name\Desktop\cli\content\branch_name"
87
+ -k, --stack-api-key=<value> API Key of the target stack
88
+ -m, --module=<value> [optional] Specify the module to import into the target stack. If not
89
+ specified, the import command will import all the modules into the stack. The
90
+ available modules are assets, content-types, entries, environments,
91
+ extensions, marketplace-apps, global-fields, labels, locales, webhooks,
92
+ workflows, custom-roles, and taxonomies.
93
+ -y, --yes [optional] Force override all Marketplace prompts.
94
+ --exclude-global-modules Excludes the branch-independent module from the import operation.
95
+ --import-webhook-status=<option> [default: disable] [default: disable] (optional) This webhook state keeps the
96
+ same state of webhooks as the source stack. <options: disable|current>
97
+ <options: disable|current>
98
+ --personalize-project-name=<value> (optional) Provide a unique name for the Personalize project.
99
+ --replace-existing Replaces the existing module in the target stack.
100
+ --skip-app-recreation (optional) Skips the recreation of private apps if they already exist.
101
+ --skip-assets-publish Skips asset publishing during the import process.
102
+ --skip-audit Skips the audit fix that occurs during an import operation.
103
+ --skip-entries-publish Skips entry publishing during the import process
104
+ --skip-existing Skips the module exists warning messages.
103
105
 
104
106
  DESCRIPTION
105
107
  Import content from a stack
@@ -131,39 +133,41 @@ Import content from a stack
131
133
 
132
134
  ```
133
135
  USAGE
134
- $ csdx cm:stacks:import [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--backup-dir <value>]
135
- [--branch <value>] [--import-webhook-status disable|current]
136
+ $ csdx cm:stacks:import [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--backup-dir
137
+ <value>] [--branch <value>] [--import-webhook-status disable|current]
136
138
 
137
139
  FLAGS
138
- -B, --branch=<value> The name of the branch where you want to import your content. If you don't mention
139
- the branch name, then by default the content will be imported to the main branch.
140
- -a, --alias=<value> The management token of the destination stack where you will import the content.
141
- -b, --backup-dir=<value> [optional] Backup directory name when using specific module.
142
- -c, --config=<value> [optional] The path of the configuration JSON file containing all the options for
143
- a single run.
144
- -d, --data-dir=<value> The path or the location in your file system where the content, you intend to
145
- import, is stored. For example, -d "C:\Users\Name\Desktop\cli\content". If the
146
- export folder has branches involved, then the path should point till the
147
- particular branch. For example, “-d
148
- "C:\Users\Name\Desktop\cli\content\branch_name"
149
- -k, --stack-api-key=<value> API Key of the target stack
150
- -m, --module=<value> [optional] Specify the module to import into the target stack. If not specified,
151
- the import command will import all the modules into the stack. The available
152
- modules are assets, content-types, entries, environments, extensions,
153
- marketplace-apps, global-fields, labels, locales, webhooks, workflows,
154
- custom-roles, and taxonomies.
155
- -y, --yes [optional] Force override all Marketplace prompts.
156
- --exclude-global-modules Excludes the branch-independent module from the import operation.
157
- --import-webhook-status=<option> [default: disable] [default: disable] (optional) This webhook state keeps the same
158
- state of webhooks as the source stack. <options: disable|current>
159
- <options: disable|current>
160
- --personalize-project-name=<value> (optional) Provide a unique name for the Personalize project.
161
- --replace-existing Replaces the existing module in the target stack.
162
- --skip-app-recreation (optional) Skips the recreation of private apps if they already exist.
163
- --skip-assets-publish Skips asset publishing during the import process.
164
- --skip-audit Skips the audit fix that occurs during an import operation.
165
- --skip-entries-publish Skips entry publishing during the import process
166
- --skip-existing Skips the module exists warning messages.
140
+ -B, --branch=<value> The name of the branch where you want to import your content. If you don't
141
+ mention the branch name, then by default the content will be imported to the
142
+ main branch.
143
+ -a, --alias=<value> The management token of the destination stack where you will import the
144
+ content.
145
+ -b, --backup-dir=<value> [optional] Backup directory name when using specific module.
146
+ -c, --config=<value> [optional] The path of the configuration JSON file containing all the options
147
+ for a single run.
148
+ -d, --data-dir=<value> The path or the location in your file system where the content, you intend to
149
+ import, is stored. For example, -d "C:\Users\Name\Desktop\cli\content". If the
150
+ export folder has branches involved, then the path should point till the
151
+ particular branch. For example, “-d
152
+ "C:\Users\Name\Desktop\cli\content\branch_name"
153
+ -k, --stack-api-key=<value> API Key of the target stack
154
+ -m, --module=<value> [optional] Specify the module to import into the target stack. If not
155
+ specified, the import command will import all the modules into the stack. The
156
+ available modules are assets, content-types, entries, environments,
157
+ extensions, marketplace-apps, global-fields, labels, locales, webhooks,
158
+ workflows, custom-roles, and taxonomies.
159
+ -y, --yes [optional] Force override all Marketplace prompts.
160
+ --exclude-global-modules Excludes the branch-independent module from the import operation.
161
+ --import-webhook-status=<option> [default: disable] [default: disable] (optional) This webhook state keeps the
162
+ same state of webhooks as the source stack. <options: disable|current>
163
+ <options: disable|current>
164
+ --personalize-project-name=<value> (optional) Provide a unique name for the Personalize project.
165
+ --replace-existing Replaces the existing module in the target stack.
166
+ --skip-app-recreation (optional) Skips the recreation of private apps if they already exist.
167
+ --skip-assets-publish Skips asset publishing during the import process.
168
+ --skip-audit Skips the audit fix that occurs during an import operation.
169
+ --skip-entries-publish Skips entry publishing during the import process
170
+ --skip-existing Skips the module exists warning messages.
167
171
 
168
172
  DESCRIPTION
169
173
  Import content from a stack
@@ -1,18 +1,11 @@
1
1
  {
2
- "version": "1.20.2",
3
2
  "commands": {
4
3
  "cm:stacks:import": {
5
- "id": "cm:stacks:import",
6
- "description": "Import content from a stack",
7
- "strict": true,
8
- "usage": "cm:stacks:import [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--backup-dir <value>] [--branch <value>] [--import-webhook-status disable|current]",
9
- "pluginName": "@contentstack/cli-cm-import",
10
- "pluginAlias": "@contentstack/cli-cm-import",
11
- "pluginType": "core",
12
4
  "aliases": [
13
5
  "cm:import"
14
6
  ],
15
- "hiddenAliases": [],
7
+ "args": {},
8
+ "description": "Import content from a stack",
16
9
  "examples": [
17
10
  "csdx cm:stacks:import --stack-api-key <stack_api_key> --data-dir <path/of/export/destination/dir>",
18
11
  "csdx cm:stacks:import --config <path/of/config/dir>",
@@ -25,158 +18,186 @@
25
18
  ],
26
19
  "flags": {
27
20
  "config": {
28
- "name": "config",
29
- "type": "option",
30
21
  "char": "c",
31
22
  "description": "[optional] The path of the configuration JSON file containing all the options for a single run.",
32
- "multiple": false
23
+ "name": "config",
24
+ "hasDynamicHelp": false,
25
+ "multiple": false,
26
+ "type": "option"
33
27
  },
34
28
  "stack-uid": {
35
- "name": "stack-uid",
36
- "type": "option",
37
29
  "char": "s",
38
30
  "description": "API key of the target stack.",
39
31
  "hidden": true,
40
- "multiple": false
32
+ "name": "stack-uid",
33
+ "hasDynamicHelp": false,
34
+ "multiple": false,
35
+ "type": "option"
41
36
  },
42
37
  "stack-api-key": {
43
- "name": "stack-api-key",
44
- "type": "option",
45
38
  "char": "k",
46
39
  "description": "API Key of the target stack",
47
- "multiple": false
40
+ "name": "stack-api-key",
41
+ "hasDynamicHelp": false,
42
+ "multiple": false,
43
+ "type": "option"
48
44
  },
49
45
  "data": {
50
- "name": "data",
51
- "type": "option",
52
46
  "description": "path and location where data is stored",
53
47
  "hidden": true,
54
- "multiple": false
48
+ "name": "data",
49
+ "hasDynamicHelp": false,
50
+ "multiple": false,
51
+ "type": "option"
55
52
  },
56
53
  "data-dir": {
57
- "name": "data-dir",
58
- "type": "option",
59
54
  "char": "d",
60
55
  "description": "The path or the location in your file system where the content, you intend to import, is stored. For example, -d \"C:\\Users\\Name\\Desktop\\cli\\content\". If the export folder has branches involved, then the path should point till the particular branch. For example, “-d \"C:\\Users\\Name\\Desktop\\cli\\content\\branch_name\"",
61
- "multiple": false
56
+ "name": "data-dir",
57
+ "hasDynamicHelp": false,
58
+ "multiple": false,
59
+ "type": "option"
62
60
  },
63
61
  "alias": {
64
- "name": "alias",
65
- "type": "option",
66
62
  "char": "a",
67
63
  "description": "The management token of the destination stack where you will import the content.",
68
- "multiple": false
64
+ "name": "alias",
65
+ "hasDynamicHelp": false,
66
+ "multiple": false,
67
+ "type": "option"
69
68
  },
70
69
  "management-token-alias": {
71
- "name": "management-token-alias",
72
- "type": "option",
73
70
  "description": "alias of the management token",
74
71
  "hidden": true,
75
- "multiple": false
72
+ "name": "management-token-alias",
73
+ "hasDynamicHelp": false,
74
+ "multiple": false,
75
+ "type": "option"
76
76
  },
77
77
  "auth-token": {
78
- "name": "auth-token",
79
- "type": "boolean",
80
78
  "char": "A",
81
79
  "description": "to use auth token",
82
80
  "hidden": true,
83
- "allowNo": false
81
+ "name": "auth-token",
82
+ "allowNo": false,
83
+ "type": "boolean"
84
84
  },
85
85
  "module": {
86
- "name": "module",
87
- "type": "option",
88
86
  "char": "m",
89
87
  "description": "[optional] Specify the module to import into the target stack. If not specified, the import command will import all the modules into the stack. The available modules are assets, content-types, entries, environments, extensions, marketplace-apps, global-fields, labels, locales, webhooks, workflows, custom-roles, and taxonomies.",
88
+ "name": "module",
90
89
  "required": false,
91
- "multiple": false
90
+ "hasDynamicHelp": false,
91
+ "multiple": false,
92
+ "type": "option"
92
93
  },
93
94
  "backup-dir": {
94
- "name": "backup-dir",
95
- "type": "option",
96
95
  "char": "b",
97
96
  "description": "[optional] Backup directory name when using specific module.",
98
- "multiple": false
97
+ "name": "backup-dir",
98
+ "hasDynamicHelp": false,
99
+ "multiple": false,
100
+ "type": "option"
99
101
  },
100
102
  "branch": {
101
- "name": "branch",
102
- "type": "option",
103
103
  "char": "B",
104
104
  "description": "The name of the branch where you want to import your content. If you don't mention the branch name, then by default the content will be imported to the main branch.",
105
- "multiple": false
105
+ "name": "branch",
106
+ "hasDynamicHelp": false,
107
+ "multiple": false,
108
+ "type": "option"
106
109
  },
107
110
  "import-webhook-status": {
108
- "name": "import-webhook-status",
109
- "type": "option",
110
111
  "description": "[default: disable] (optional) This webhook state keeps the same state of webhooks as the source stack. <options: disable|current>",
112
+ "name": "import-webhook-status",
111
113
  "required": false,
114
+ "default": "disable",
115
+ "hasDynamicHelp": false,
112
116
  "multiple": false,
113
117
  "options": [
114
118
  "disable",
115
119
  "current"
116
120
  ],
117
- "default": "disable"
121
+ "type": "option"
118
122
  },
119
123
  "yes": {
120
- "name": "yes",
121
- "type": "boolean",
122
124
  "char": "y",
123
125
  "description": "[optional] Force override all Marketplace prompts.",
126
+ "name": "yes",
124
127
  "required": false,
125
- "allowNo": false
128
+ "allowNo": false,
129
+ "type": "boolean"
126
130
  },
127
131
  "skip-app-recreation": {
128
- "name": "skip-app-recreation",
129
- "type": "boolean",
130
132
  "description": "(optional) Skips the recreation of private apps if they already exist.",
131
- "allowNo": false
133
+ "name": "skip-app-recreation",
134
+ "allowNo": false,
135
+ "type": "boolean"
132
136
  },
133
137
  "replace-existing": {
134
- "name": "replace-existing",
135
- "type": "boolean",
136
138
  "description": "Replaces the existing module in the target stack.",
139
+ "name": "replace-existing",
137
140
  "required": false,
138
- "allowNo": false
141
+ "allowNo": false,
142
+ "type": "boolean"
139
143
  },
140
144
  "skip-existing": {
141
- "name": "skip-existing",
142
- "type": "boolean",
143
145
  "description": "Skips the module exists warning messages.",
146
+ "name": "skip-existing",
144
147
  "required": false,
145
- "allowNo": false
148
+ "allowNo": false,
149
+ "type": "boolean"
146
150
  },
147
151
  "personalize-project-name": {
148
- "name": "personalize-project-name",
149
- "type": "option",
150
152
  "description": "(optional) Provide a unique name for the Personalize project.",
153
+ "name": "personalize-project-name",
151
154
  "required": false,
152
- "multiple": false
155
+ "hasDynamicHelp": false,
156
+ "multiple": false,
157
+ "type": "option"
153
158
  },
154
159
  "skip-audit": {
155
- "name": "skip-audit",
156
- "type": "boolean",
157
160
  "description": "Skips the audit fix that occurs during an import operation.",
158
- "allowNo": false
161
+ "name": "skip-audit",
162
+ "allowNo": false,
163
+ "type": "boolean"
159
164
  },
160
165
  "exclude-global-modules": {
161
- "name": "exclude-global-modules",
162
- "type": "boolean",
163
166
  "description": "Excludes the branch-independent module from the import operation.",
164
- "allowNo": false
167
+ "name": "exclude-global-modules",
168
+ "allowNo": false,
169
+ "type": "boolean"
165
170
  },
166
171
  "skip-assets-publish": {
167
- "name": "skip-assets-publish",
168
- "type": "boolean",
169
172
  "description": "Skips asset publishing during the import process.",
170
- "allowNo": false
173
+ "name": "skip-assets-publish",
174
+ "allowNo": false,
175
+ "type": "boolean"
171
176
  },
172
177
  "skip-entries-publish": {
173
- "name": "skip-entries-publish",
174
- "type": "boolean",
175
178
  "description": "Skips entry publishing during the import process",
176
- "allowNo": false
179
+ "name": "skip-entries-publish",
180
+ "allowNo": false,
181
+ "type": "boolean"
177
182
  }
178
183
  },
179
- "args": {}
184
+ "hasDynamicHelp": false,
185
+ "hiddenAliases": [],
186
+ "id": "cm:stacks:import",
187
+ "pluginAlias": "@contentstack/cli-cm-import",
188
+ "pluginName": "@contentstack/cli-cm-import",
189
+ "pluginType": "core",
190
+ "strict": true,
191
+ "usage": "cm:stacks:import [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--backup-dir <value>] [--branch <value>] [--import-webhook-status disable|current]",
192
+ "isESM": false,
193
+ "relativePath": [
194
+ "lib",
195
+ "commands",
196
+ "cm",
197
+ "stacks",
198
+ "import.js"
199
+ ]
180
200
  }
181
- }
201
+ },
202
+ "version": "1.21.0"
182
203
  }
package/package.json CHANGED
@@ -1,16 +1,16 @@
1
1
  {
2
2
  "name": "@contentstack/cli-cm-import",
3
3
  "description": "Contentstack CLI plugin to import content into stack",
4
- "version": "1.20.2",
4
+ "version": "1.21.0",
5
5
  "author": "Contentstack",
6
6
  "bugs": "https://github.com/contentstack/cli/issues",
7
7
  "dependencies": {
8
- "@contentstack/cli-audit": "~1.10.0",
9
- "@contentstack/cli-command": "~1.3.3",
10
- "@contentstack/cli-utilities": "~1.9.0",
11
- "@contentstack/management": "~1.18.4",
12
- "@contentstack/cli-variants": "~1.1.6",
13
- "@oclif/core": "^3.27.0",
8
+ "@contentstack/cli-audit": "~1.11.0",
9
+ "@contentstack/cli-command": "~1.5.0",
10
+ "@contentstack/cli-utilities": "~1.11.0",
11
+ "@contentstack/management": "~1.20.1",
12
+ "@contentstack/cli-variants": "~1.2.0",
13
+ "@oclif/core": "^4.2.7",
14
14
  "big-json": "^3.2.0",
15
15
  "bluebird": "^3.7.2",
16
16
  "chalk": "^4.1.2",
@@ -36,10 +36,10 @@
36
36
  "@types/uuid": "^9.0.8",
37
37
  "@typescript-eslint/eslint-plugin": "^5.62.0",
38
38
  "eslint": "^8.57.1",
39
- "eslint-config-oclif": "^4.0.0",
39
+ "eslint-config-oclif": "^6.0.15",
40
40
  "mocha": "^10.8.2",
41
41
  "nyc": "^15.1.0",
42
- "oclif": "^3.17.2",
42
+ "oclif": "^4.17.30",
43
43
  "ts-node": "^10.9.2",
44
44
  "typescript": "^4.9.5"
45
45
  },