dbdocs 0.16.1 → 0.16.2
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/oclif.manifest.json +383 -1
- package/package.json +6 -10
- package/src/commands/build.js +1 -1
- package/src/commands/login.js +1 -1
- package/src/commands/password.js +1 -1
- package/src/commands/remove.js +1 -1
- package/src/commands/rename.js +1 -1
- package/src/user_data.json +0 -1
package/oclif.manifest.json
CHANGED
|
@@ -1 +1,383 @@
|
|
|
1
|
-
{
|
|
1
|
+
{
|
|
2
|
+
"commands": {
|
|
3
|
+
"build": {
|
|
4
|
+
"aliases": [],
|
|
5
|
+
"args": {
|
|
6
|
+
"filepath": {
|
|
7
|
+
"description": "dbml file path",
|
|
8
|
+
"name": "filepath"
|
|
9
|
+
}
|
|
10
|
+
},
|
|
11
|
+
"description": "build docs",
|
|
12
|
+
"flags": {
|
|
13
|
+
"project": {
|
|
14
|
+
"description": "<username>/<project_name> or <project_name>",
|
|
15
|
+
"name": "project",
|
|
16
|
+
"hasDynamicHelp": false,
|
|
17
|
+
"multiple": false,
|
|
18
|
+
"type": "option"
|
|
19
|
+
},
|
|
20
|
+
"public": {
|
|
21
|
+
"description": "anyone with the URL can access",
|
|
22
|
+
"exclusive": [
|
|
23
|
+
"private",
|
|
24
|
+
"password"
|
|
25
|
+
],
|
|
26
|
+
"helpGroup": "sharing",
|
|
27
|
+
"name": "public",
|
|
28
|
+
"allowNo": false,
|
|
29
|
+
"type": "boolean"
|
|
30
|
+
},
|
|
31
|
+
"private": {
|
|
32
|
+
"description": "only invited people can access",
|
|
33
|
+
"exclusive": [
|
|
34
|
+
"public",
|
|
35
|
+
"password"
|
|
36
|
+
],
|
|
37
|
+
"helpGroup": "sharing",
|
|
38
|
+
"name": "private",
|
|
39
|
+
"allowNo": false,
|
|
40
|
+
"type": "boolean"
|
|
41
|
+
},
|
|
42
|
+
"password": {
|
|
43
|
+
"char": "p",
|
|
44
|
+
"description": "anyone with the URL + password can access",
|
|
45
|
+
"exclusive": [
|
|
46
|
+
"public",
|
|
47
|
+
"private"
|
|
48
|
+
],
|
|
49
|
+
"helpGroup": "sharing",
|
|
50
|
+
"name": "password",
|
|
51
|
+
"hasDynamicHelp": false,
|
|
52
|
+
"multiple": false,
|
|
53
|
+
"type": "option"
|
|
54
|
+
},
|
|
55
|
+
"versionName": {
|
|
56
|
+
"description": "name of the version",
|
|
57
|
+
"name": "versionName",
|
|
58
|
+
"hasDynamicHelp": false,
|
|
59
|
+
"helpValue": "your-version-name",
|
|
60
|
+
"multiple": false,
|
|
61
|
+
"type": "option"
|
|
62
|
+
}
|
|
63
|
+
},
|
|
64
|
+
"hasDynamicHelp": false,
|
|
65
|
+
"hiddenAliases": [],
|
|
66
|
+
"id": "build",
|
|
67
|
+
"pluginAlias": "dbdocs",
|
|
68
|
+
"pluginName": "dbdocs",
|
|
69
|
+
"pluginType": "core",
|
|
70
|
+
"strict": true,
|
|
71
|
+
"parse": true,
|
|
72
|
+
"parserOptions": {},
|
|
73
|
+
"isESM": false,
|
|
74
|
+
"relativePath": [
|
|
75
|
+
"src",
|
|
76
|
+
"commands",
|
|
77
|
+
"build.js"
|
|
78
|
+
]
|
|
79
|
+
},
|
|
80
|
+
"db2dbml": {
|
|
81
|
+
"aliases": [],
|
|
82
|
+
"args": {
|
|
83
|
+
"database-type": {
|
|
84
|
+
"description": "your database type (postgres, mysql, mssql, snowflake, bigquery)",
|
|
85
|
+
"name": "database-type",
|
|
86
|
+
"required": true
|
|
87
|
+
},
|
|
88
|
+
"connection-string": {
|
|
89
|
+
"description": "your database connection string (See below examples for more details)",
|
|
90
|
+
"name": "connection-string",
|
|
91
|
+
"required": true
|
|
92
|
+
}
|
|
93
|
+
},
|
|
94
|
+
"description": "Generate DBML directly from a database",
|
|
95
|
+
"examples": "Postgres:\n $ db2dbml postgres 'postgresql://user:password@localhost:5432/dbname?schemas=schema1,schema2'\nMySQL:\n $ db2dbml mysql 'mysql://user:password@localhost:3306/dbname'\nMSSQL:\n $ db2dbml mssql 'Server=localhost,1433;Database=master;User Id=sa;Password=your_password;Encrypt=true;TrustServerCertificate=true;Schemas=schema1,schema2;'\nSnowflake:\n Password-based authentication:\n $ db2dbml snowflake 'SERVER=<account_identifier>.<region>;UID=<your_username>;PWD=<your_password>;DATABASE=<your_database>;WAREHOUSE=<your_warehouse>;ROLE=<your_role>;SCHEMAS=schema1,schema2;'\n Key pair authentication:\n $ db2dbml snowflake 'SERVER=<account_identifier>.<region>;UID=<your_username>;AUTHENTICATOR=SNOWFLAKE_JWT;PRIVATE_KEY_PATH=<path_to_your_private_key.p8>;PASSPHRASE=<your_private_key_passphrase>;DATABASE=<your_database>;WAREHOUSE=<your_warehouse>;ROLE=<your_role>;SCHEMAS=schema1,schema2;'\n \n Note: If you did not use passphrase to encrypt your private key, you can leave the \"PASSPHRASE\" empty.\n \nBigQuery:\n $ db2dbml bigquery /path_to_json_credential.json\n \n Note: Your JSON credential file must contain:\n {\n \"project_id\": \"your-project-id\",\n \"client_email\": \"your-client-email\",\n \"private_key\": \"your-private-key\",\n \"datasets\": [\"dataset_1\", \"dataset_2\", ...]\n }\n If \"datasets\" key is not provided or is empty, it will fetch all datasets.",
|
|
96
|
+
"flags": {
|
|
97
|
+
"outFile": {
|
|
98
|
+
"char": "o",
|
|
99
|
+
"description": "output file path",
|
|
100
|
+
"name": "outFile",
|
|
101
|
+
"hasDynamicHelp": false,
|
|
102
|
+
"helpValue": "/path-to-your-file",
|
|
103
|
+
"multiple": false,
|
|
104
|
+
"type": "option"
|
|
105
|
+
}
|
|
106
|
+
},
|
|
107
|
+
"hasDynamicHelp": false,
|
|
108
|
+
"hiddenAliases": [],
|
|
109
|
+
"id": "db2dbml",
|
|
110
|
+
"pluginAlias": "dbdocs",
|
|
111
|
+
"pluginName": "dbdocs",
|
|
112
|
+
"pluginType": "core",
|
|
113
|
+
"strict": true,
|
|
114
|
+
"parse": true,
|
|
115
|
+
"parserOptions": {},
|
|
116
|
+
"isESM": false,
|
|
117
|
+
"relativePath": [
|
|
118
|
+
"src",
|
|
119
|
+
"commands",
|
|
120
|
+
"db2dbml.js"
|
|
121
|
+
]
|
|
122
|
+
},
|
|
123
|
+
"login": {
|
|
124
|
+
"aliases": [],
|
|
125
|
+
"args": {},
|
|
126
|
+
"description": "login to dbdocs\nlogin with your dbdocs credentials\n",
|
|
127
|
+
"flags": {},
|
|
128
|
+
"hasDynamicHelp": false,
|
|
129
|
+
"hiddenAliases": [],
|
|
130
|
+
"id": "login",
|
|
131
|
+
"pluginAlias": "dbdocs",
|
|
132
|
+
"pluginName": "dbdocs",
|
|
133
|
+
"pluginType": "core",
|
|
134
|
+
"strict": true,
|
|
135
|
+
"parse": true,
|
|
136
|
+
"parserOptions": {},
|
|
137
|
+
"isESM": false,
|
|
138
|
+
"relativePath": [
|
|
139
|
+
"src",
|
|
140
|
+
"commands",
|
|
141
|
+
"login.js"
|
|
142
|
+
]
|
|
143
|
+
},
|
|
144
|
+
"logout": {
|
|
145
|
+
"aliases": [],
|
|
146
|
+
"args": {},
|
|
147
|
+
"description": "logout\nclears local login credentials\n",
|
|
148
|
+
"flags": {},
|
|
149
|
+
"hasDynamicHelp": false,
|
|
150
|
+
"hiddenAliases": [],
|
|
151
|
+
"id": "logout",
|
|
152
|
+
"pluginAlias": "dbdocs",
|
|
153
|
+
"pluginName": "dbdocs",
|
|
154
|
+
"pluginType": "core",
|
|
155
|
+
"strict": true,
|
|
156
|
+
"parse": true,
|
|
157
|
+
"parserOptions": {},
|
|
158
|
+
"isESM": false,
|
|
159
|
+
"relativePath": [
|
|
160
|
+
"src",
|
|
161
|
+
"commands",
|
|
162
|
+
"logout.js"
|
|
163
|
+
]
|
|
164
|
+
},
|
|
165
|
+
"ls": {
|
|
166
|
+
"aliases": [],
|
|
167
|
+
"args": {},
|
|
168
|
+
"description": "list projects",
|
|
169
|
+
"flags": {},
|
|
170
|
+
"hasDynamicHelp": false,
|
|
171
|
+
"hiddenAliases": [],
|
|
172
|
+
"id": "ls",
|
|
173
|
+
"pluginAlias": "dbdocs",
|
|
174
|
+
"pluginName": "dbdocs",
|
|
175
|
+
"pluginType": "core",
|
|
176
|
+
"strict": true,
|
|
177
|
+
"parse": true,
|
|
178
|
+
"parserOptions": {},
|
|
179
|
+
"isESM": false,
|
|
180
|
+
"relativePath": [
|
|
181
|
+
"src",
|
|
182
|
+
"commands",
|
|
183
|
+
"ls.js"
|
|
184
|
+
]
|
|
185
|
+
},
|
|
186
|
+
"password": {
|
|
187
|
+
"aliases": [],
|
|
188
|
+
"args": {},
|
|
189
|
+
"description": "set password for your project or remove password",
|
|
190
|
+
"flags": {
|
|
191
|
+
"project": {
|
|
192
|
+
"char": "p",
|
|
193
|
+
"description": "project name",
|
|
194
|
+
"name": "project",
|
|
195
|
+
"hasDynamicHelp": false,
|
|
196
|
+
"helpValue": "project name",
|
|
197
|
+
"multiple": false,
|
|
198
|
+
"type": "option"
|
|
199
|
+
},
|
|
200
|
+
"set": {
|
|
201
|
+
"char": "s",
|
|
202
|
+
"description": "password for your project",
|
|
203
|
+
"name": "set",
|
|
204
|
+
"hasDynamicHelp": false,
|
|
205
|
+
"helpValue": "password",
|
|
206
|
+
"multiple": false,
|
|
207
|
+
"type": "option"
|
|
208
|
+
},
|
|
209
|
+
"remove": {
|
|
210
|
+
"char": "r",
|
|
211
|
+
"description": "remove password from your project",
|
|
212
|
+
"name": "remove",
|
|
213
|
+
"allowNo": false,
|
|
214
|
+
"type": "boolean"
|
|
215
|
+
}
|
|
216
|
+
},
|
|
217
|
+
"hasDynamicHelp": false,
|
|
218
|
+
"hiddenAliases": [],
|
|
219
|
+
"id": "password",
|
|
220
|
+
"pluginAlias": "dbdocs",
|
|
221
|
+
"pluginName": "dbdocs",
|
|
222
|
+
"pluginType": "core",
|
|
223
|
+
"strict": true,
|
|
224
|
+
"parse": true,
|
|
225
|
+
"parserOptions": {},
|
|
226
|
+
"isESM": false,
|
|
227
|
+
"relativePath": [
|
|
228
|
+
"src",
|
|
229
|
+
"commands",
|
|
230
|
+
"password.js"
|
|
231
|
+
]
|
|
232
|
+
},
|
|
233
|
+
"remove": {
|
|
234
|
+
"aliases": [],
|
|
235
|
+
"args": {
|
|
236
|
+
"project_name": {
|
|
237
|
+
"description": "name of the project which you want to remove",
|
|
238
|
+
"name": "project_name"
|
|
239
|
+
}
|
|
240
|
+
},
|
|
241
|
+
"description": "remove project",
|
|
242
|
+
"flags": {},
|
|
243
|
+
"hasDynamicHelp": false,
|
|
244
|
+
"hiddenAliases": [],
|
|
245
|
+
"id": "remove",
|
|
246
|
+
"pluginAlias": "dbdocs",
|
|
247
|
+
"pluginName": "dbdocs",
|
|
248
|
+
"pluginType": "core",
|
|
249
|
+
"strict": true,
|
|
250
|
+
"parse": true,
|
|
251
|
+
"parserOptions": {},
|
|
252
|
+
"isESM": false,
|
|
253
|
+
"relativePath": [
|
|
254
|
+
"src",
|
|
255
|
+
"commands",
|
|
256
|
+
"remove.js"
|
|
257
|
+
]
|
|
258
|
+
},
|
|
259
|
+
"rename": {
|
|
260
|
+
"aliases": [],
|
|
261
|
+
"args": {},
|
|
262
|
+
"description": "change your username",
|
|
263
|
+
"flags": {},
|
|
264
|
+
"hasDynamicHelp": false,
|
|
265
|
+
"hiddenAliases": [],
|
|
266
|
+
"id": "rename",
|
|
267
|
+
"pluginAlias": "dbdocs",
|
|
268
|
+
"pluginName": "dbdocs",
|
|
269
|
+
"pluginType": "core",
|
|
270
|
+
"strict": true,
|
|
271
|
+
"parse": true,
|
|
272
|
+
"parserOptions": {},
|
|
273
|
+
"isESM": false,
|
|
274
|
+
"relativePath": [
|
|
275
|
+
"src",
|
|
276
|
+
"commands",
|
|
277
|
+
"rename.js"
|
|
278
|
+
]
|
|
279
|
+
},
|
|
280
|
+
"set": {
|
|
281
|
+
"aliases": [],
|
|
282
|
+
"args": {},
|
|
283
|
+
"description": "Set the Web URL and API URL of dbdocs self-hosted server",
|
|
284
|
+
"examples": "$ dbdocs set --webUrl http://webserver.dev --apiUrl http://apiserver.dev",
|
|
285
|
+
"flags": {
|
|
286
|
+
"webUrl": {
|
|
287
|
+
"description": "Self-hosted web url",
|
|
288
|
+
"name": "webUrl",
|
|
289
|
+
"required": true,
|
|
290
|
+
"hasDynamicHelp": false,
|
|
291
|
+
"multiple": false,
|
|
292
|
+
"type": "option"
|
|
293
|
+
},
|
|
294
|
+
"apiUrl": {
|
|
295
|
+
"description": "Self-hosted api url",
|
|
296
|
+
"name": "apiUrl",
|
|
297
|
+
"required": true,
|
|
298
|
+
"hasDynamicHelp": false,
|
|
299
|
+
"multiple": false,
|
|
300
|
+
"type": "option"
|
|
301
|
+
}
|
|
302
|
+
},
|
|
303
|
+
"hasDynamicHelp": false,
|
|
304
|
+
"hiddenAliases": [],
|
|
305
|
+
"id": "set",
|
|
306
|
+
"pluginAlias": "dbdocs",
|
|
307
|
+
"pluginName": "dbdocs",
|
|
308
|
+
"pluginType": "core",
|
|
309
|
+
"strict": true,
|
|
310
|
+
"parse": true,
|
|
311
|
+
"parserOptions": {},
|
|
312
|
+
"isESM": false,
|
|
313
|
+
"relativePath": [
|
|
314
|
+
"src",
|
|
315
|
+
"commands",
|
|
316
|
+
"set.js"
|
|
317
|
+
]
|
|
318
|
+
},
|
|
319
|
+
"token": {
|
|
320
|
+
"aliases": [],
|
|
321
|
+
"args": {},
|
|
322
|
+
"description": "generate or revoke your authentication token",
|
|
323
|
+
"flags": {
|
|
324
|
+
"generate": {
|
|
325
|
+
"char": "g",
|
|
326
|
+
"description": "generate authentication token",
|
|
327
|
+
"name": "generate",
|
|
328
|
+
"allowNo": false,
|
|
329
|
+
"type": "boolean"
|
|
330
|
+
},
|
|
331
|
+
"revoke": {
|
|
332
|
+
"char": "r",
|
|
333
|
+
"description": "revoke authentication token",
|
|
334
|
+
"name": "revoke",
|
|
335
|
+
"allowNo": false,
|
|
336
|
+
"type": "boolean"
|
|
337
|
+
}
|
|
338
|
+
},
|
|
339
|
+
"hasDynamicHelp": false,
|
|
340
|
+
"hiddenAliases": [],
|
|
341
|
+
"id": "token",
|
|
342
|
+
"pluginAlias": "dbdocs",
|
|
343
|
+
"pluginName": "dbdocs",
|
|
344
|
+
"pluginType": "core",
|
|
345
|
+
"strict": true,
|
|
346
|
+
"parse": true,
|
|
347
|
+
"parserOptions": {},
|
|
348
|
+
"isESM": false,
|
|
349
|
+
"relativePath": [
|
|
350
|
+
"src",
|
|
351
|
+
"commands",
|
|
352
|
+
"token.js"
|
|
353
|
+
]
|
|
354
|
+
},
|
|
355
|
+
"validate": {
|
|
356
|
+
"aliases": [],
|
|
357
|
+
"args": {
|
|
358
|
+
"filepath": {
|
|
359
|
+
"description": "dbml file path",
|
|
360
|
+
"name": "filepath"
|
|
361
|
+
}
|
|
362
|
+
},
|
|
363
|
+
"description": "validate docs content",
|
|
364
|
+
"flags": {},
|
|
365
|
+
"hasDynamicHelp": false,
|
|
366
|
+
"hiddenAliases": [],
|
|
367
|
+
"id": "validate",
|
|
368
|
+
"pluginAlias": "dbdocs",
|
|
369
|
+
"pluginName": "dbdocs",
|
|
370
|
+
"pluginType": "core",
|
|
371
|
+
"strict": true,
|
|
372
|
+
"parse": true,
|
|
373
|
+
"parserOptions": {},
|
|
374
|
+
"isESM": false,
|
|
375
|
+
"relativePath": [
|
|
376
|
+
"src",
|
|
377
|
+
"commands",
|
|
378
|
+
"validate.js"
|
|
379
|
+
]
|
|
380
|
+
}
|
|
381
|
+
},
|
|
382
|
+
"version": "0.16.2"
|
|
383
|
+
}
|
package/package.json
CHANGED
|
@@ -1,23 +1,19 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "dbdocs",
|
|
3
|
-
"version": "0.16.
|
|
3
|
+
"version": "0.16.2",
|
|
4
4
|
"author": "@holistics",
|
|
5
5
|
"bin": {
|
|
6
6
|
"dbdocs": "./bin/run"
|
|
7
7
|
},
|
|
8
|
-
"resolutions": {
|
|
9
|
-
"oclif/**/ansi-regex": "^3.0.1",
|
|
10
|
-
"oclif/**/@octokit/rest": "21.1.1"
|
|
11
|
-
},
|
|
12
8
|
"dependencies": {
|
|
13
9
|
"@dbml/connector": "3.13.4",
|
|
14
10
|
"@dbml/core": "3.13.4",
|
|
15
11
|
"@oclif/core": "1.12.1",
|
|
16
|
-
"@oclif/plugin-help": "
|
|
17
|
-
"axios": "^1.
|
|
12
|
+
"@oclif/plugin-help": "6.2.32",
|
|
13
|
+
"axios": "^1.12.0",
|
|
18
14
|
"chalk": "^3.0.0",
|
|
19
15
|
"dotenv": "^8.2.0",
|
|
20
|
-
"inquirer": "^
|
|
16
|
+
"inquirer": "^12.9.4",
|
|
21
17
|
"netrc-parser": "^3.1.6",
|
|
22
18
|
"open": "^7.0.0",
|
|
23
19
|
"ora": "^4.0.3",
|
|
@@ -25,12 +21,12 @@
|
|
|
25
21
|
"update-notifier": "^6.0.2"
|
|
26
22
|
},
|
|
27
23
|
"devDependencies": {
|
|
28
|
-
"@oclif/test": "
|
|
24
|
+
"@oclif/test": "4.1.13",
|
|
29
25
|
"chai": "^4",
|
|
30
26
|
"globby": "^10",
|
|
31
27
|
"mocha": "^10.8.2",
|
|
32
28
|
"nyc": "^17.1.0",
|
|
33
|
-
"oclif": "^
|
|
29
|
+
"oclif": "^4.22.14"
|
|
34
30
|
},
|
|
35
31
|
"engines": {
|
|
36
32
|
"node": ">=18.0.0"
|
package/src/commands/build.js
CHANGED
package/src/commands/login.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
const { Command } = require('@oclif/core');
|
|
2
2
|
const open = require('open');
|
|
3
|
-
const inquirer = require('inquirer');
|
|
3
|
+
const inquirer = require('inquirer').default;
|
|
4
4
|
const axios = require('axios');
|
|
5
5
|
const ora = require('ora');
|
|
6
6
|
const netrc = require('netrc-parser').default;
|
package/src/commands/password.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
const { Command, Flags } = require('@oclif/core');
|
|
2
2
|
const axios = require('axios');
|
|
3
|
-
const inquirer = require('inquirer');
|
|
3
|
+
const inquirer = require('inquirer').default;
|
|
4
4
|
const ora = require('ora');
|
|
5
5
|
const { vars } = require('../vars');
|
|
6
6
|
const verifyToken = require('../utils/verifyToken');
|
package/src/commands/remove.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/* eslint-disable camelcase */
|
|
2
2
|
const { Command } = require('@oclif/core');
|
|
3
3
|
const axios = require('axios');
|
|
4
|
-
const inquirer = require('inquirer');
|
|
4
|
+
const inquirer = require('inquirer').default;
|
|
5
5
|
const ora = require('ora');
|
|
6
6
|
const { vars } = require('../vars');
|
|
7
7
|
const verifyToken = require('../utils/verifyToken');
|
package/src/commands/rename.js
CHANGED
package/src/user_data.json
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"BUILD_COUNT":2}
|