@directus/extensions-sdk 9.24.0 → 9.25.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.
Files changed (110) hide show
  1. package/cli.js +1 -1
  2. package/dist/{cjs/cli → cli}/commands/add.d.ts +0 -1
  3. package/dist/{esm/cli → cli}/commands/add.js +16 -18
  4. package/dist/{esm/cli → cli}/commands/build.d.ts +0 -1
  5. package/dist/{esm/cli → cli}/commands/build.js +23 -29
  6. package/dist/{cjs/cli → cli}/commands/create.d.ts +0 -1
  7. package/dist/{esm/cli → cli}/commands/create.js +12 -13
  8. package/dist/{cjs/cli → cli}/commands/helpers/copy-template.d.ts +2 -3
  9. package/dist/{esm/cli → cli}/commands/helpers/copy-template.js +2 -2
  10. package/dist/cli/commands/helpers/generate-bundle-entrypoint.d.ts +2 -0
  11. package/dist/{esm/cli → cli}/commands/helpers/generate-bundle-entrypoint.js +3 -3
  12. package/dist/{cjs/cli → cli}/commands/helpers/get-extension-dev-deps.d.ts +2 -3
  13. package/dist/{esm/cli → cli}/commands/helpers/get-extension-dev-deps.js +4 -4
  14. package/dist/cli/commands/helpers/load-config.d.ts +2 -0
  15. package/dist/{esm/cli → cli}/commands/helpers/load-config.js +2 -2
  16. package/dist/cli/commands/helpers/validate-cli-options.d.ts +2 -0
  17. package/dist/{esm/cli → cli}/commands/helpers/validate-cli-options.js +1 -1
  18. package/dist/{cjs/cli → cli}/commands/link.d.ts +0 -1
  19. package/dist/{esm/cli → cli}/commands/link.js +4 -5
  20. package/dist/cli/index.d.ts +3 -0
  21. package/dist/cli/index.js +3 -0
  22. package/dist/{esm/cli → cli}/run.js +4 -4
  23. package/dist/{esm/cli → cli}/types.d.ts +2 -3
  24. package/dist/cli/types.js +1 -0
  25. package/dist/{cjs/cli → cli}/utils/detect-json-indent.d.ts +0 -1
  26. package/dist/{esm/cli → cli}/utils/detect-json-indent.js +1 -2
  27. package/dist/{cjs/cli → cli}/utils/get-package-manager-agent.d.ts +0 -1
  28. package/dist/{esm/cli → cli}/utils/get-package-manager-agent.js +1 -1
  29. package/dist/cli/utils/get-package-manager-agent.test.d.ts +1 -0
  30. package/dist/{esm/cli → cli}/utils/get-package-manager-agent.test.js +3 -3
  31. package/dist/{cjs/cli → cli}/utils/get-package-manager.d.ts +0 -1
  32. package/dist/{esm/cli → cli}/utils/get-package-manager.js +3 -3
  33. package/dist/cli/utils/get-package-manager.test.d.ts +1 -0
  34. package/dist/{esm/cli → cli}/utils/get-package-manager.test.js +3 -3
  35. package/dist/{cjs/cli → cli}/utils/get-package-version.d.ts +0 -1
  36. package/dist/{cjs/cli → cli}/utils/get-sdk-version.d.ts +0 -1
  37. package/dist/cli/utils/get-sdk-version.js +8 -0
  38. package/dist/{cjs/cli → cli}/utils/get-template-path.d.ts +0 -1
  39. package/dist/{cjs/cli → cli}/utils/languages.d.ts +1 -2
  40. package/dist/{esm/cli → cli}/utils/languages.js +1 -1
  41. package/dist/{cjs/cli → cli}/utils/logger.d.ts +0 -1
  42. package/dist/cli/utils/try-parse-json.d.ts +2 -0
  43. package/dist/{cjs/index.d.ts → index.d.ts} +2 -3
  44. package/dist/{esm/index.js → index.js} +2 -2
  45. package/package.json +14 -25
  46. package/dist/cjs/cli/commands/add.js +0 -243
  47. package/dist/cjs/cli/commands/build.d.ts +0 -11
  48. package/dist/cjs/cli/commands/build.js +0 -446
  49. package/dist/cjs/cli/commands/create.js +0 -125
  50. package/dist/cjs/cli/commands/helpers/copy-template.js +0 -53
  51. package/dist/cjs/cli/commands/helpers/generate-bundle-entrypoint.d.ts +0 -3
  52. package/dist/cjs/cli/commands/helpers/generate-bundle-entrypoint.js +0 -24
  53. package/dist/cjs/cli/commands/helpers/get-extension-dev-deps.js +0 -27
  54. package/dist/cjs/cli/commands/helpers/load-config.d.ts +0 -3
  55. package/dist/cjs/cli/commands/helpers/load-config.js +0 -21
  56. package/dist/cjs/cli/commands/helpers/validate-cli-options.d.ts +0 -3
  57. package/dist/cjs/cli/commands/helpers/validate-cli-options.js +0 -23
  58. package/dist/cjs/cli/commands/link.js +0 -54
  59. package/dist/cjs/cli/index.d.ts +0 -4
  60. package/dist/cjs/cli/index.js +0 -10
  61. package/dist/cjs/cli/run.d.ts +0 -2
  62. package/dist/cjs/cli/run.js +0 -39
  63. package/dist/cjs/cli/types.d.ts +0 -13
  64. package/dist/cjs/cli/types.js +0 -2
  65. package/dist/cjs/cli/utils/detect-json-indent.js +0 -14
  66. package/dist/cjs/cli/utils/get-package-manager-agent.js +0 -15
  67. package/dist/cjs/cli/utils/get-package-manager-agent.test.d.ts +0 -2
  68. package/dist/cjs/cli/utils/get-package-manager-agent.test.js +0 -24
  69. package/dist/cjs/cli/utils/get-package-manager.js +0 -20
  70. package/dist/cjs/cli/utils/get-package-manager.test.d.ts +0 -2
  71. package/dist/cjs/cli/utils/get-package-manager.test.js +0 -42
  72. package/dist/cjs/cli/utils/get-package-version.js +0 -12
  73. package/dist/cjs/cli/utils/get-sdk-version.js +0 -7
  74. package/dist/cjs/cli/utils/get-template-path.js +0 -10
  75. package/dist/cjs/cli/utils/languages.js +0 -30
  76. package/dist/cjs/cli/utils/logger.js +0 -32
  77. package/dist/cjs/cli/utils/try-parse-json.d.ts +0 -3
  78. package/dist/cjs/cli/utils/try-parse-json.js +0 -11
  79. package/dist/cjs/index.js +0 -24
  80. package/dist/esm/cli/commands/add.d.ts +0 -2
  81. package/dist/esm/cli/commands/create.d.ts +0 -6
  82. package/dist/esm/cli/commands/helpers/copy-template.d.ts +0 -4
  83. package/dist/esm/cli/commands/helpers/generate-bundle-entrypoint.d.ts +0 -3
  84. package/dist/esm/cli/commands/helpers/get-extension-dev-deps.d.ts +0 -4
  85. package/dist/esm/cli/commands/helpers/load-config.d.ts +0 -3
  86. package/dist/esm/cli/commands/helpers/validate-cli-options.d.ts +0 -3
  87. package/dist/esm/cli/commands/link.d.ts +0 -2
  88. package/dist/esm/cli/index.d.ts +0 -4
  89. package/dist/esm/cli/index.js +0 -3
  90. package/dist/esm/cli/run.d.ts +0 -2
  91. package/dist/esm/cli/utils/detect-json-indent.d.ts +0 -2
  92. package/dist/esm/cli/utils/get-package-manager-agent.d.ts +0 -5
  93. package/dist/esm/cli/utils/get-package-manager-agent.test.d.ts +0 -2
  94. package/dist/esm/cli/utils/get-package-manager.d.ts +0 -5
  95. package/dist/esm/cli/utils/get-package-manager.test.d.ts +0 -2
  96. package/dist/esm/cli/utils/get-package-version.d.ts +0 -2
  97. package/dist/esm/cli/utils/get-sdk-version.d.ts +0 -2
  98. package/dist/esm/cli/utils/get-sdk-version.js +0 -4
  99. package/dist/esm/cli/utils/get-template-path.d.ts +0 -2
  100. package/dist/esm/cli/utils/languages.d.ts +0 -5
  101. package/dist/esm/cli/utils/logger.d.ts +0 -3
  102. package/dist/esm/cli/utils/try-parse-json.d.ts +0 -3
  103. package/dist/esm/index.d.ts +0 -3
  104. package/license +0 -674
  105. package/readme.md +0 -3
  106. /package/dist/{esm/cli/types.js → cli/run.d.ts} +0 -0
  107. /package/dist/{esm/cli → cli}/utils/get-package-version.js +0 -0
  108. /package/dist/{esm/cli → cli}/utils/get-template-path.js +0 -0
  109. /package/dist/{esm/cli → cli}/utils/logger.js +0 -0
  110. /package/dist/{esm/cli → cli}/utils/try-parse-json.js +0 -0
package/package.json CHANGED
@@ -1,8 +1,9 @@
1
1
  {
2
2
  "name": "@directus/extensions-sdk",
3
- "version": "9.24.0",
3
+ "version": "9.25.0",
4
4
  "description": "A toolkit to develop extensions to extend Directus",
5
5
  "homepage": "https://directus.io",
6
+ "type": "module",
6
7
  "bugs": {
7
8
  "url": "https://github.com/directus/directus/issues"
8
9
  },
@@ -14,24 +15,12 @@
14
15
  "funding": "https://github.com/directus/directus?sponsor=1",
15
16
  "author": "Nicola Krumschmidt",
16
17
  "exports": {
17
- ".": {
18
- "import": {
19
- "types": "./dist/esm/index.d.ts",
20
- "default": "./dist/esm/index.js"
21
- },
22
- "require": {
23
- "types": "./dist/cjs/index.d.ts",
24
- "default": "./dist/cjs/index.js"
25
- }
26
- },
27
- "./cli": {
28
- "import": "./dist/esm/cli/index.js",
29
- "require": "./dist/cjs/cli/index.js"
30
- },
18
+ ".": "./dist/index.js",
19
+ "./cli": "./dist/cli/index.js",
31
20
  "./package.json": "./package.json"
32
21
  },
33
- "main": "dist/cjs/index.js",
34
- "types": "dist/cjs/index.d.ts",
22
+ "main": "dist/index.js",
23
+ "types": "dist/index.d.ts",
35
24
  "bin": {
36
25
  "directus-extension": "cli.js"
37
26
  },
@@ -59,9 +48,13 @@
59
48
  "rollup-plugin-esbuild": "5.0.0",
60
49
  "rollup-plugin-styles": "4.0.0",
61
50
  "rollup-plugin-vue": "6.0.0",
62
- "@directus/shared": "9.24.0"
51
+ "@directus/composables": "9.25.0",
52
+ "@directus/constants": "9.25.0",
53
+ "@directus/types": "9.25.0",
54
+ "@directus/utils": "9.25.0"
63
55
  },
64
56
  "devDependencies": {
57
+ "@directus/tsconfig": "0.0.6",
65
58
  "@types/fs-extra": "11.0.1",
66
59
  "@types/inquirer": "8.2.6",
67
60
  "@vitest/coverage-c8": "0.29.3",
@@ -76,12 +69,8 @@
76
69
  "access": "public"
77
70
  },
78
71
  "scripts": {
79
- "build": "concurrently --prefix-colors auto --passthrough-arguments \"pnpm:build:* {@}\"",
80
- "build:esm": "tsc --project ./tsconfig.json --module ES2015 --outDir ./dist/esm",
81
- "build:cjs": "tsc --project ./tsconfig.json --module CommonJS --outDir ./dist/cjs",
82
- "test": "vitest run",
83
- "test:watch": "vitest",
84
- "test:coverage": "vitest run --coverage",
85
- "dev": "pnpm build -- -w --preserveWatchOutput --incremental"
72
+ "build": "tsc --build",
73
+ "dev": "tsc --watch",
74
+ "test": "vitest --watch=false"
86
75
  }
87
76
  }
@@ -1,243 +0,0 @@
1
- "use strict";
2
- var __importDefault = (this && this.__importDefault) || function (mod) {
3
- return (mod && mod.__esModule) ? mod : { "default": mod };
4
- };
5
- Object.defineProperty(exports, "__esModule", { value: true });
6
- const path_1 = __importDefault(require("path"));
7
- const chalk_1 = __importDefault(require("chalk"));
8
- const fs_extra_1 = __importDefault(require("fs-extra"));
9
- const inquirer_1 = __importDefault(require("inquirer"));
10
- const logger_1 = require("../utils/logger");
11
- const types_1 = require("@directus/shared/types");
12
- const utils_1 = require("@directus/shared/utils");
13
- const node_1 = require("@directus/shared/utils/node");
14
- const constants_1 = require("@directus/shared/constants");
15
- const languages_1 = require("../utils/languages");
16
- const get_extension_dev_deps_1 = __importDefault(require("./helpers/get-extension-dev-deps"));
17
- const execa_1 = __importDefault(require("execa"));
18
- const ora_1 = __importDefault(require("ora"));
19
- const copy_template_1 = __importDefault(require("./helpers/copy-template"));
20
- const detect_json_indent_1 = __importDefault(require("../utils/detect-json-indent"));
21
- const get_package_manager_1 = __importDefault(require("../utils/get-package-manager"));
22
- async function add() {
23
- var _a, _b;
24
- const extensionPath = process.cwd();
25
- const packagePath = path_1.default.resolve('package.json');
26
- if (!(await fs_extra_1.default.pathExists(packagePath))) {
27
- (0, logger_1.log)(`Current directory is not a valid package.`, 'error');
28
- process.exit(1);
29
- }
30
- let extensionManifest;
31
- let indent = null;
32
- try {
33
- const extensionManifestFile = await fs_extra_1.default.readFile(packagePath, 'utf8');
34
- extensionManifest = types_1.ExtensionManifest.passthrough().parse(JSON.parse(extensionManifestFile));
35
- indent = (0, detect_json_indent_1.default)(extensionManifestFile);
36
- }
37
- catch (e) {
38
- (0, logger_1.log)(`Current directory is not a valid Directus extension.`, 'error');
39
- process.exit(1);
40
- }
41
- const extensionOptions = extensionManifest[constants_1.EXTENSION_PKG_KEY];
42
- const sourceExists = await fs_extra_1.default.pathExists(path_1.default.resolve('src'));
43
- if (extensionOptions.type === 'bundle') {
44
- const { type, name, language, alternativeSource } = await inquirer_1.default.prompt([
45
- {
46
- type: 'list',
47
- name: 'type',
48
- message: 'Choose the extension type',
49
- choices: constants_1.EXTENSION_TYPES,
50
- },
51
- {
52
- type: 'input',
53
- name: 'name',
54
- message: 'Choose a name for the entry',
55
- validate: (name) => (name.length === 0 ? 'Entry name can not be empty.' : true),
56
- },
57
- {
58
- type: 'list',
59
- name: 'language',
60
- message: 'Choose the language to use',
61
- choices: constants_1.EXTENSION_LANGUAGES,
62
- },
63
- {
64
- type: 'input',
65
- name: 'alternativeSource',
66
- message: 'Specify the path to the extension source',
67
- when: !sourceExists && extensionOptions.entries.length > 0,
68
- },
69
- ]);
70
- const spinner = (0, ora_1.default)(chalk_1.default.bold('Modifying Directus extension...')).start();
71
- const source = alternativeSource !== null && alternativeSource !== void 0 ? alternativeSource : 'src';
72
- const sourcePath = path_1.default.resolve(source, name);
73
- await fs_extra_1.default.ensureDir(sourcePath);
74
- await (0, copy_template_1.default)(type, extensionPath, sourcePath, language);
75
- const newEntries = [
76
- ...extensionOptions.entries,
77
- (0, utils_1.isIn)(type, constants_1.HYBRID_EXTENSION_TYPES)
78
- ? {
79
- type,
80
- name,
81
- source: {
82
- app: `${(0, node_1.pathToRelativeUrl)(source)}/${name}/app.${(0, languages_1.languageToShort)(language)}`,
83
- api: `${(0, node_1.pathToRelativeUrl)(source)}/${name}/api.${(0, languages_1.languageToShort)(language)}`,
84
- },
85
- }
86
- : {
87
- type,
88
- name,
89
- source: `${(0, node_1.pathToRelativeUrl)(source)}/${name}/index.${(0, languages_1.languageToShort)(language)}`,
90
- },
91
- ];
92
- const newExtensionOptions = { ...extensionOptions, entries: newEntries };
93
- const newExtensionManifest = {
94
- ...extensionManifest,
95
- [constants_1.EXTENSION_PKG_KEY]: newExtensionOptions,
96
- devDependencies: await (0, get_extension_dev_deps_1.default)(newEntries.map((entry) => entry.type), getLanguageFromEntries(newEntries)),
97
- };
98
- await fs_extra_1.default.writeJSON(packagePath, newExtensionManifest, { spaces: indent !== null && indent !== void 0 ? indent : '\t' });
99
- const packageManager = (0, get_package_manager_1.default)();
100
- await (0, execa_1.default)(packageManager, ['install'], { cwd: extensionPath });
101
- spinner.succeed(chalk_1.default.bold('Done'));
102
- }
103
- else {
104
- const { proceed } = await inquirer_1.default.prompt([
105
- {
106
- type: 'confirm',
107
- name: 'proceed',
108
- message: 'This will convert your extension to a bundle. Do you want to proceed?',
109
- },
110
- ]);
111
- if (!proceed) {
112
- (0, logger_1.log)(`Extension has not been modified.`, 'info');
113
- process.exit(1);
114
- }
115
- const oldName = (_b = (_a = extensionManifest.name.match(constants_1.EXTENSION_NAME_REGEX)) === null || _a === void 0 ? void 0 : _a[1]) !== null && _b !== void 0 ? _b : extensionManifest.name;
116
- const { type, name, language, convertName, extensionName, alternativeSource } = await inquirer_1.default.prompt([
117
- {
118
- type: 'list',
119
- name: 'type',
120
- message: 'Choose the extension type',
121
- choices: constants_1.EXTENSION_TYPES,
122
- },
123
- {
124
- type: 'input',
125
- name: 'name',
126
- message: 'Choose a name for the entry',
127
- validate: (name) => (name.length === 0 ? 'Entry name can not be empty.' : true),
128
- },
129
- {
130
- type: 'list',
131
- name: 'language',
132
- message: 'Choose the language to use',
133
- choices: constants_1.EXTENSION_LANGUAGES,
134
- },
135
- {
136
- type: 'input',
137
- name: 'convertName',
138
- message: 'Choose a name for the extension that is converted to an entry',
139
- default: oldName,
140
- validate: (name) => (name.length === 0 ? 'Entry name can not be empty.' : true),
141
- },
142
- {
143
- type: 'input',
144
- name: 'extensionName',
145
- message: 'Choose a name for the extension',
146
- default: ({ convertName }) => (convertName !== oldName ? oldName : null),
147
- validate: (name) => (name.length === 0 ? 'Extension name can not be empty.' : true),
148
- },
149
- {
150
- type: 'input',
151
- name: 'alternativeSource',
152
- message: 'Specify the path to the extension source',
153
- when: !sourceExists,
154
- },
155
- ]);
156
- const spinner = (0, ora_1.default)(chalk_1.default.bold('Modifying Directus extension...')).start();
157
- const source = alternativeSource !== null && alternativeSource !== void 0 ? alternativeSource : 'src';
158
- const convertSourcePath = path_1.default.resolve(source, convertName);
159
- const entrySourcePath = path_1.default.resolve(source, name);
160
- const convertFiles = await fs_extra_1.default.readdir(source);
161
- await Promise.all(convertFiles.map((file) => fs_extra_1.default.move(path_1.default.resolve(source, file), path_1.default.join(convertSourcePath, file))));
162
- await fs_extra_1.default.ensureDir(entrySourcePath);
163
- await (0, copy_template_1.default)(type, extensionPath, entrySourcePath, language);
164
- const toConvertSourceUrl = (entrypoint) => path_1.default.posix.join((0, node_1.pathToRelativeUrl)(source), convertName, path_1.default.posix.relative(source, entrypoint));
165
- const entries = [
166
- (0, utils_1.isTypeIn)(extensionOptions, constants_1.HYBRID_EXTENSION_TYPES)
167
- ? {
168
- type: extensionOptions.type,
169
- name: convertName,
170
- source: {
171
- app: toConvertSourceUrl(extensionOptions.source.app),
172
- api: toConvertSourceUrl(extensionOptions.source.api),
173
- },
174
- }
175
- : {
176
- type: extensionOptions.type,
177
- name: convertName,
178
- source: toConvertSourceUrl(extensionOptions.source),
179
- },
180
- (0, utils_1.isIn)(type, constants_1.HYBRID_EXTENSION_TYPES)
181
- ? {
182
- type,
183
- name,
184
- source: {
185
- app: `${(0, node_1.pathToRelativeUrl)(source)}/${name}/app.${(0, languages_1.languageToShort)(language)}`,
186
- api: `${(0, node_1.pathToRelativeUrl)(source)}/${name}/api.${(0, languages_1.languageToShort)(language)}`,
187
- },
188
- }
189
- : {
190
- type,
191
- name,
192
- source: `${(0, node_1.pathToRelativeUrl)(source)}/${name}/index.${(0, languages_1.languageToShort)(language)}`,
193
- },
194
- ];
195
- const newExtensionOptions = {
196
- type: 'bundle',
197
- path: { app: 'dist/app.js', api: 'dist/api.js' },
198
- entries,
199
- host: extensionOptions.host,
200
- hidden: extensionOptions.hidden,
201
- };
202
- const newExtensionManifest = {
203
- ...extensionManifest,
204
- name: constants_1.EXTENSION_NAME_REGEX.test(extensionName) ? extensionName : `directus-extension-${extensionName}`,
205
- keywords: ['directus', 'directus-extension', `directus-custom-bundle`],
206
- [constants_1.EXTENSION_PKG_KEY]: newExtensionOptions,
207
- devDependencies: await (0, get_extension_dev_deps_1.default)(entries.map((entry) => entry.type), getLanguageFromEntries(entries)),
208
- };
209
- await fs_extra_1.default.writeJSON(packagePath, newExtensionManifest, { spaces: indent !== null && indent !== void 0 ? indent : '\t' });
210
- const packageManager = (0, get_package_manager_1.default)();
211
- await (0, execa_1.default)(packageManager, ['install'], { cwd: extensionPath });
212
- spinner.succeed(chalk_1.default.bold('Done'));
213
- }
214
- }
215
- exports.default = add;
216
- function getLanguageFromEntries(entries) {
217
- const languages = new Set();
218
- for (const entry of entries) {
219
- if ((0, utils_1.isTypeIn)(entry, constants_1.HYBRID_EXTENSION_TYPES)) {
220
- const languageApp = (0, languages_1.getLanguageFromPath)(entry.source.app);
221
- const languageApi = (0, languages_1.getLanguageFromPath)(entry.source.api);
222
- if (!(0, languages_1.isLanguage)(languageApp)) {
223
- (0, logger_1.log)(`App language ${chalk_1.default.bold(languageApp)} is not supported.`, 'error');
224
- process.exit(1);
225
- }
226
- if (!(0, languages_1.isLanguage)(languageApi)) {
227
- (0, logger_1.log)(`API language ${chalk_1.default.bold(languageApi)} is not supported.`, 'error');
228
- process.exit(1);
229
- }
230
- languages.add(languageApp);
231
- languages.add(languageApi);
232
- }
233
- else {
234
- const language = (0, languages_1.getLanguageFromPath)(entry.source);
235
- if (!(0, languages_1.isLanguage)(language)) {
236
- (0, logger_1.log)(`Language ${chalk_1.default.bold(language)} is not supported.`, 'error');
237
- process.exit(1);
238
- }
239
- languages.add(language);
240
- }
241
- }
242
- return Array.from(languages);
243
- }
@@ -1,11 +0,0 @@
1
- type BuildOptions = {
2
- type?: string;
3
- input?: string;
4
- output?: string;
5
- watch?: boolean;
6
- minify?: boolean;
7
- sourcemap?: boolean;
8
- };
9
- export default function build(options: BuildOptions): Promise<void>;
10
- export {};
11
- //# sourceMappingURL=build.d.ts.map