@africode/core 5.0.11 → 5.0.13
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/AGENTS.md +585 -585
- package/AGENT_INSTRUCTIONS.md +595 -595
- package/COMPONENT_SCHEMA.json +1826 -1800
- package/LICENSE +623 -623
- package/README.md +476 -476
- package/bin/africode.js +73 -73
- package/bin/cli.ts +82 -82
- package/bin/create-africode.js +220 -220
- package/bin/scaffold.ts +218 -218
- package/components/accordion.js +183 -183
- package/components/alert.js +131 -131
- package/components/auth-form.js +154 -154
- package/components/auth.js +172 -172
- package/components/avatar.js +117 -117
- package/components/badge.js +104 -104
- package/components/base.d.ts +139 -139
- package/components/base.js +234 -234
- package/components/breadcrumb.js +76 -72
- package/components/button.js +164 -164
- package/components/card.js +144 -137
- package/components/carousel.js +32 -32
- package/components/cart-drawer.js +28 -28
- package/components/code-block.js +20 -20
- package/components/contact-form.js +25 -25
- package/components/cookie-consent.js +23 -23
- package/components/cta-banner.js +38 -38
- package/components/cultural-card.js +243 -243
- package/components/dashboard-activity-list.js +103 -103
- package/components/dashboard-card.js +85 -85
- package/components/dashboard-metric.js +81 -81
- package/components/dashboard-shell.js +85 -85
- package/components/dashboard-topbar.js +84 -84
- package/components/divider.js +83 -83
- package/components/dropdown.js +171 -171
- package/components/error-boundary.js +155 -155
- package/components/faq-accordion.js +23 -23
- package/components/feature-grid.js +85 -85
- package/components/file-uploader.js +22 -22
- package/components/filter-bar.js +19 -19
- package/components/footer.js +113 -113
- package/components/form.js +131 -131
- package/components/gallery.js +22 -22
- package/components/hero.js +140 -138
- package/components/icon.js +36 -36
- package/components/index.js +128 -128
- package/components/input.js +252 -256
- package/components/kanga-card.js +185 -185
- package/components/kyc-upload.js +173 -173
- package/components/language-switcher.js +108 -108
- package/components/loader.js +80 -80
- package/components/modal.js +262 -262
- package/components/motion.js +84 -84
- package/components/nav-drawer.js +216 -216
- package/components/navbar.js +243 -236
- package/components/newsletter-signup.js +24 -24
- package/components/pagination.js +31 -31
- package/components/pattern-showcase.js +225 -225
- package/components/pricing-card.js +100 -100
- package/components/product-card.js +41 -41
- package/components/progress.js +132 -134
- package/components/react.js +111 -111
- package/components/search-box.js +24 -24
- package/components/section.js +54 -54
- package/components/select.js +321 -322
- package/components/sidebar.js +180 -180
- package/components/simple-chart.js +22 -22
- package/components/skeleton.js +85 -85
- package/components/stepper.js +28 -28
- package/components/table.js +181 -181
- package/components/tabs.js +202 -202
- package/components/team-grid.js +23 -23
- package/components/testimonial.js +94 -94
- package/components/theme-toggle.js +82 -82
- package/components/toast.js +139 -139
- package/components/tooltip.js +167 -167
- package/components/transaction-ledger.js +138 -138
- package/components/ui-avatar.js +79 -79
- package/components/ui-badge.js +61 -61
- package/components/ui-button.js +149 -149
- package/components/ui-card.js +74 -75
- package/components/ui-chip.js +87 -87
- package/components/ui-input.js +110 -110
- package/components/ui-popover.js +84 -84
- package/components/ui-progress-ring.js +60 -60
- package/components/ui-select.js +85 -85
- package/components/ui-stat.js +75 -75
- package/components/ui-switch.js +85 -85
- package/components/ui-table.js +69 -69
- package/components/ui-tabs.js +99 -99
- package/components/ui-tag.js +64 -64
- package/components/ui-textarea.js +84 -84
- package/components/ui-tooltip.js +66 -66
- package/components/video-player.js +22 -22
- package/components/wallet-balance.js +114 -114
- package/core/a2ui-schema-manager.js +351 -351
- package/core/a2ui.js +696 -696
- package/core/actions.js +27 -27
- package/core/bun-runtime.js +396 -396
- package/core/cli/commands/add.js +23 -23
- package/core/cli/commands/audit.js +58 -58
- package/core/cli/commands/build.js +193 -193
- package/core/cli/commands/create-plugin.js +241 -241
- package/core/cli/commands/dev.js +248 -283
- package/core/cli/commands/lint.js +23 -23
- package/core/cli/commands/test.js +33 -34
- package/core/cli/migrator.js +71 -71
- package/core/cli/ui.js +56 -56
- package/core/compliance.js +823 -823
- package/core/config.js +265 -265
- package/core/db-advanced.js +478 -481
- package/core/db.js +282 -284
- package/core/enhanced-hmr.js +406 -406
- package/core/errors.js +222 -222
- package/core/file-router.js +47 -47
- package/core/hmr-client.js +203 -204
- package/core/hmr.js +205 -197
- package/core/html.d.ts +30 -30
- package/core/html.js +84 -84
- package/core/hydration.js +52 -52
- package/core/lipa-namba-journey.js +548 -605
- package/core/logging.js +14 -14
- package/core/middleware.js +145 -145
- package/core/motion.js +106 -106
- package/core/nida-cig-middleware.js +417 -460
- package/core/patterns.d.ts +124 -124
- package/core/patterns.js +947 -1001
- package/core/plugins/index.js +345 -345
- package/core/request-analytics.js +253 -253
- package/core/request-identity.js +93 -93
- package/core/router.js +386 -386
- package/core/sdk-browser.js +140 -140
- package/core/sdk-client.js +61 -61
- package/core/sdk.d.ts +133 -133
- package/core/sdk.js +148 -148
- package/core/seo.js +76 -76
- package/core/server/auth-endpoints.js +339 -339
- package/core/server/auth.js +180 -180
- package/core/server/csrf.js +200 -206
- package/core/server/db.js +39 -39
- package/core/server/middleware.js +324 -324
- package/core/server/rate-limit.js +238 -238
- package/core/server/render.js +67 -69
- package/core/server/router.js +23 -11
- package/core/session-store.js +68 -68
- package/core/shim.js +28 -28
- package/core/state.d.ts +86 -86
- package/core/state.js +276 -276
- package/core/store.d.ts +122 -122
- package/core/store.js +61 -61
- package/core/validation.d.ts +232 -232
- package/core/validation.js +602 -602
- package/core/websocket.js +656 -641
- package/dist/africode.js +233 -230
- package/dist/africode.js.map +83 -83
- package/dist/build-info.json +3 -3
- package/dist/components.js +195 -192
- package/dist/components.js.map +73 -73
- package/dist/styles/africanity.css +321 -321
- package/dist/styles/typography.css +140 -140
- package/docs/IDE-Guide.md +50 -50
- package/package.json +113 -113
- package/scripts/generate-component-schema.js +82 -79
- package/styles/africanity.css +321 -321
- package/styles/typography.css +140 -140
- package/templates/starter/.env.example +15 -15
- package/templates/starter/africode.config.js +40 -40
- package/templates/starter/package.json +13 -13
- package/templates/starter/src/index.js +18 -18
- package/templates/starter/src/pages/index.html +55 -55
- package/templates/starter/src/pages/index.js +17 -17
- package/templates/starter/src/styles/main.css +3 -3
- package/templates/starter-3d/.env.example +7 -7
- package/templates/starter-3d/africode.config.js +29 -29
- package/templates/starter-3d/components/af-model-viewer.js +125 -125
- package/templates/starter-3d/package.json +14 -14
- package/templates/starter-3d/src/pages/index.html +55 -55
- package/templates/starter-3d/src/pages/index.js +50 -50
- package/templates/starter-3d/src/styles/main.css +3 -3
- package/templates/starter-dashboard/.env.example +21 -21
- package/templates/starter-dashboard/africode.config.js +20 -20
- package/templates/starter-dashboard/package.json +14 -14
- package/templates/starter-dashboard/src/index.js +17 -17
- package/templates/starter-dashboard/src/pages/api/analytics.js +24 -24
- package/templates/starter-dashboard/src/pages/index.html +118 -118
- package/templates/starter-dashboard/src/pages/index.js +110 -110
- package/templates/starter-dashboard/src/styles/main.css +172 -172
- package/templates/starter-fintech/.env.example +28 -28
- package/templates/starter-fintech/africode.config.js +20 -20
- package/templates/starter-fintech/package.json +15 -15
- package/templates/starter-fintech/src/index.js +17 -17
- package/templates/starter-fintech/src/pages/api/auth.js +45 -45
- package/templates/starter-fintech/src/pages/api/transfer.js +65 -65
- package/templates/starter-fintech/src/pages/api/wallet.js +39 -39
- package/templates/starter-fintech/src/pages/api/webhooks/payment.js +32 -32
- package/templates/starter-fintech/src/pages/index.html +169 -169
- package/templates/starter-fintech/src/pages/index.js +161 -161
- package/templates/starter-fintech/src/styles/main.css +246 -246
- package/templates/starter-react/.env.example +15 -15
- package/templates/starter-react/africode.config.js +40 -40
- package/templates/starter-react/package.json +15 -15
- package/templates/starter-react/src/pages/index.html +55 -55
- package/templates/starter-react/src/pages/index.js +68 -68
- package/templates/starter-react/src/styles/main.css +3 -3
- package/templates/starter-tailwind/.env.example +15 -15
- package/templates/starter-tailwind/africode.config.js +40 -40
- package/templates/starter-tailwind/package.json +19 -19
- package/templates/starter-tailwind/src/pages/index.html +55 -55
- package/templates/starter-tailwind/src/pages/index.js +67 -67
- package/templates/starter-tailwind/src/styles/main.css +3 -3
- package/templates/starter-tailwind/src/styles/tailwind.css +1 -1
- package/templates/starter-tailwind/src/tailwind-loader.js +30 -30
- package/templates/starter-tailwind/tailwind.config.cjs +18 -18
- package/templates/starter-website/.env.example +18 -18
- package/templates/starter-website/africode.config.js +20 -20
- package/templates/starter-website/package.json +14 -14
- package/templates/starter-website/src/index.js +17 -17
- package/templates/starter-website/src/pages/index.html +124 -124
- package/templates/starter-website/src/pages/index.js +116 -116
- package/templates/starter-website/src/styles/main.css +195 -195
- package/bin/africode.js.1758507140 +0 -343
- package/core/heartbeat.js +0 -64
|
@@ -1,241 +1,241 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* AfriCode Plugin Scaffolder
|
|
3
|
-
*
|
|
4
|
-
* Generates a complete, testable, safe plugin project.
|
|
5
|
-
* Usage: africode create plugin my-plugin [--minimal] [--with-tests] [--hook onRequest,onResponse]
|
|
6
|
-
*/
|
|
7
|
-
import { mkdir, writeFile } from 'fs/promises';
|
|
8
|
-
import { existsSync } from 'fs';
|
|
9
|
-
import path from 'path';
|
|
10
|
-
|
|
11
|
-
const ALLOWED_HOOKS = [
|
|
12
|
-
'onConfigLoad', 'onComponentRegister', 'onRouteRegister',
|
|
13
|
-
'onStateInit', 'onServerStart', 'onRequest', 'onResponse',
|
|
14
|
-
'onError', 'onCliCommandRegister',
|
|
15
|
-
];
|
|
16
|
-
|
|
17
|
-
export async function createPlugin(pluginName, args = []) {
|
|
18
|
-
if (!pluginName) {
|
|
19
|
-
console.error('✗ Please provide a plugin name: africode create plugin my-plugin');
|
|
20
|
-
process.exit(1);
|
|
21
|
-
}
|
|
22
|
-
|
|
23
|
-
const isMinimal = args.includes('--minimal');
|
|
24
|
-
const withTests = args.includes('--with-tests') || !isMinimal;
|
|
25
|
-
const hookFlagIdx = args.indexOf('--hook');
|
|
26
|
-
const selectedHooks = hookFlagIdx > -1
|
|
27
|
-
? args[hookFlagIdx + 1]?.split(',').filter(h => ALLOWED_HOOKS.includes(h)) || ['onRequest', 'onResponse']
|
|
28
|
-
: ['onConfigLoad', 'onRequest', 'onResponse'];
|
|
29
|
-
|
|
30
|
-
const pluginDir = path.join(process.cwd(), pluginName);
|
|
31
|
-
|
|
32
|
-
if (existsSync(pluginDir)) {
|
|
33
|
-
console.error(`✗ Directory "${pluginName}" already exists`);
|
|
34
|
-
process.exit(1);
|
|
35
|
-
}
|
|
36
|
-
|
|
37
|
-
console.log(`\n🔌 Scaffolding AfriCode Plugin: ${pluginName}\n`);
|
|
38
|
-
|
|
39
|
-
// Create directory tree
|
|
40
|
-
await mkdir(path.join(pluginDir, 'src', 'hooks'), { recursive: true });
|
|
41
|
-
await mkdir(path.join(pluginDir, 'src', 'utils'), { recursive: true });
|
|
42
|
-
if (withTests) await mkdir(path.join(pluginDir, 'tests'), { recursive: true });
|
|
43
|
-
if (!isMinimal) await mkdir(path.join(pluginDir, 'examples'), { recursive: true });
|
|
44
|
-
|
|
45
|
-
// --- package.json ---
|
|
46
|
-
await writeFile(path.join(pluginDir, 'package.json'), JSON.stringify({
|
|
47
|
-
name: pluginName,
|
|
48
|
-
version: '1.0.0',
|
|
49
|
-
description: `AfriCode plugin: ${pluginName}`,
|
|
50
|
-
type: 'module',
|
|
51
|
-
main: 'index.js',
|
|
52
|
-
scripts: {
|
|
53
|
-
test: 'bun test',
|
|
54
|
-
},
|
|
55
|
-
keywords: ['africode', 'plugin', pluginName],
|
|
56
|
-
license: 'MIT',
|
|
57
|
-
peerDependencies: {
|
|
58
|
-
africode: '^3.0.0',
|
|
59
|
-
},
|
|
60
|
-
}, null, 2));
|
|
61
|
-
|
|
62
|
-
// --- manifest.js ---
|
|
63
|
-
await writeFile(path.join(pluginDir, 'src', 'manifest.js'),
|
|
64
|
-
`export default {
|
|
65
|
-
name: '${pluginName}',
|
|
66
|
-
version: '1.0.0',
|
|
67
|
-
compatibleWith: '^3.0.0',
|
|
68
|
-
hooks: ${JSON.stringify(selectedHooks)},
|
|
69
|
-
critical: false,
|
|
70
|
-
};
|
|
71
|
-
`);
|
|
72
|
-
|
|
73
|
-
// --- Hook files ---
|
|
74
|
-
for (const hook of selectedHooks) {
|
|
75
|
-
await writeFile(path.join(pluginDir, 'src', 'hooks', `${hook}.js`),
|
|
76
|
-
`/**
|
|
77
|
-
* ${hook} handler for ${pluginName}
|
|
78
|
-
*/
|
|
79
|
-
export default async function ${hook}(ctx) {
|
|
80
|
-
// Your plugin logic here
|
|
81
|
-
ctx.logger?.info?.(\`[${pluginName}] ${hook} executed\`);
|
|
82
|
-
}
|
|
83
|
-
`);
|
|
84
|
-
}
|
|
85
|
-
|
|
86
|
-
// --- Logger util ---
|
|
87
|
-
await writeFile(path.join(pluginDir, 'src', 'utils', 'logger.js'),
|
|
88
|
-
`/**
|
|
89
|
-
* Simple structured logger for ${pluginName}
|
|
90
|
-
*/
|
|
91
|
-
export const logger = {
|
|
92
|
-
info: (msg) => console.log(\`[INFO] \${msg}\`),
|
|
93
|
-
warn: (msg) => console.warn(\`[WARN] \${msg}\`),
|
|
94
|
-
error: (msg) => console.error(\`[ERROR] \${msg}\`),
|
|
95
|
-
};
|
|
96
|
-
`);
|
|
97
|
-
|
|
98
|
-
// --- index.js ---
|
|
99
|
-
const hookImports = selectedHooks.map(h => `import ${h} from './src/hooks/${h}.js';`).join('\n');
|
|
100
|
-
const hookEntries = selectedHooks.map(h => ` ${h},`).join('\n');
|
|
101
|
-
await writeFile(path.join(pluginDir, 'index.js'),
|
|
102
|
-
`import manifest from './src/manifest.js';
|
|
103
|
-
${hookImports}
|
|
104
|
-
|
|
105
|
-
export default {
|
|
106
|
-
manifest,
|
|
107
|
-
${hookEntries}
|
|
108
|
-
};
|
|
109
|
-
`);
|
|
110
|
-
|
|
111
|
-
// --- plugin.config.js ---
|
|
112
|
-
await writeFile(path.join(pluginDir, 'plugin.config.js'),
|
|
113
|
-
`/**
|
|
114
|
-
* Plugin configuration defaults.
|
|
115
|
-
* These can be overridden by the host application's config.
|
|
116
|
-
*/
|
|
117
|
-
export default {
|
|
118
|
-
enabled: true,
|
|
119
|
-
logLevel: 'info',
|
|
120
|
-
};
|
|
121
|
-
`);
|
|
122
|
-
|
|
123
|
-
// --- Tests ---
|
|
124
|
-
if (withTests) {
|
|
125
|
-
await writeFile(path.join(pluginDir, 'tests', 'plugin.test.js'),
|
|
126
|
-
`import { describe, it, expect } from 'bun:test';
|
|
127
|
-
import plugin from '../index.js';
|
|
128
|
-
|
|
129
|
-
describe('${pluginName}', () => {
|
|
130
|
-
it('should have a valid manifest', () => {
|
|
131
|
-
expect(plugin.manifest).toBeDefined();
|
|
132
|
-
expect(plugin.manifest.name).toBe('${pluginName}');
|
|
133
|
-
expect(plugin.manifest.version).toBeDefined();
|
|
134
|
-
expect(plugin.manifest.compatibleWith).toBeDefined();
|
|
135
|
-
});
|
|
136
|
-
|
|
137
|
-
it('should only declare allowed hooks', () => {
|
|
138
|
-
const allowed = new Set([
|
|
139
|
-
'onConfigLoad', 'onComponentRegister', 'onRouteRegister',
|
|
140
|
-
'onStateInit', 'onServerStart', 'onRequest', 'onResponse',
|
|
141
|
-
'onError', 'onCliCommandRegister',
|
|
142
|
-
]);
|
|
143
|
-
for (const hook of plugin.manifest.hooks) {
|
|
144
|
-
expect(allowed.has(hook)).toBe(true);
|
|
145
|
-
}
|
|
146
|
-
});
|
|
147
|
-
|
|
148
|
-
it('should expose all declared hooks as functions', () => {
|
|
149
|
-
for (const hook of plugin.manifest.hooks) {
|
|
150
|
-
expect(typeof plugin[hook]).toBe('function');
|
|
151
|
-
}
|
|
152
|
-
});
|
|
153
|
-
|
|
154
|
-
it('hooks should execute without throwing', async () => {
|
|
155
|
-
const mockCtx = { logger: { info: () => {}, warn: () => {}, error: () => {} } };
|
|
156
|
-
for (const hook of plugin.manifest.hooks) {
|
|
157
|
-
await expect(plugin[hook](mockCtx)).resolves.toBeUndefined();
|
|
158
|
-
}
|
|
159
|
-
});
|
|
160
|
-
});
|
|
161
|
-
`);
|
|
162
|
-
}
|
|
163
|
-
|
|
164
|
-
// --- README.md ---
|
|
165
|
-
await writeFile(path.join(pluginDir, 'README.md'),
|
|
166
|
-
`# ${pluginName}
|
|
167
|
-
|
|
168
|
-
An AfriCode Framework plugin.
|
|
169
|
-
|
|
170
|
-
## What this plugin does
|
|
171
|
-
|
|
172
|
-
Describe your plugin's purpose here.
|
|
173
|
-
|
|
174
|
-
## Supported Hooks
|
|
175
|
-
|
|
176
|
-
${selectedHooks.map(h => `- \`${h}\``).join('\n')}
|
|
177
|
-
|
|
178
|
-
## Install
|
|
179
|
-
|
|
180
|
-
\`\`\`bash
|
|
181
|
-
bun add ${pluginName}
|
|
182
|
-
\`\`\`
|
|
183
|
-
|
|
184
|
-
## Register
|
|
185
|
-
|
|
186
|
-
\`\`\`javascript
|
|
187
|
-
import plugin from '${pluginName}';
|
|
188
|
-
|
|
189
|
-
africode.plugins.register(plugin.manifest, plugin);
|
|
190
|
-
\`\`\`
|
|
191
|
-
|
|
192
|
-
## Configuration
|
|
193
|
-
|
|
194
|
-
Edit \`plugin.config.js\` to adjust defaults.
|
|
195
|
-
|
|
196
|
-
## Troubleshooting
|
|
197
|
-
|
|
198
|
-
- Ensure your AfriCode version satisfies \`${'^3.0.0'}\`
|
|
199
|
-
- Check that only valid hooks are declared in the manifest
|
|
200
|
-
|
|
201
|
-
## Compatibility
|
|
202
|
-
|
|
203
|
-
| AfriCode Version | Plugin Version |
|
|
204
|
-
|:---:|:---:|
|
|
205
|
-
| ^3.0.0 | 1.0.0 |
|
|
206
|
-
`);
|
|
207
|
-
|
|
208
|
-
// --- Example usage ---
|
|
209
|
-
if (!isMinimal) {
|
|
210
|
-
await writeFile(path.join(pluginDir, 'examples', 'usage.js'),
|
|
211
|
-
`/**
|
|
212
|
-
* Example: registering ${pluginName} in an AfriCode app
|
|
213
|
-
*/
|
|
214
|
-
import { AfriPluginRegistry } from 'africode/core/plugins/index.js';
|
|
215
|
-
import plugin from '../index.js';
|
|
216
|
-
|
|
217
|
-
const registry = new AfriPluginRegistry();
|
|
218
|
-
registry.register(plugin.manifest, plugin);
|
|
219
|
-
|
|
220
|
-
// Simulate a hook emission
|
|
221
|
-
await registry.emit('onRequest', { req: {}, meta: {} });
|
|
222
|
-
console.log('Plugin executed successfully!');
|
|
223
|
-
`);
|
|
224
|
-
}
|
|
225
|
-
|
|
226
|
-
console.log(`✓ Created ${pluginName}/`);
|
|
227
|
-
console.log(` ├── package.json`);
|
|
228
|
-
console.log(` ├── index.js`);
|
|
229
|
-
console.log(` ├── plugin.config.js`);
|
|
230
|
-
console.log(` ├── README.md`);
|
|
231
|
-
console.log(` ├── src/`);
|
|
232
|
-
console.log(` │ ├── manifest.js`);
|
|
233
|
-
console.log(` │ ├── hooks/`);
|
|
234
|
-
selectedHooks.forEach(h => console.log(` │ │ └── ${h}.js`));
|
|
235
|
-
console.log(` │ └── utils/logger.js`);
|
|
236
|
-
if (withTests) console.log(` ├── tests/plugin.test.js`);
|
|
237
|
-
if (!isMinimal) console.log(` └── examples/usage.js`);
|
|
238
|
-
console.log(`\n🚀 Next steps:`);
|
|
239
|
-
console.log(` cd ${pluginName}`);
|
|
240
|
-
console.log(` bun test\n`);
|
|
241
|
-
}
|
|
1
|
+
/**
|
|
2
|
+
* AfriCode Plugin Scaffolder
|
|
3
|
+
*
|
|
4
|
+
* Generates a complete, testable, safe plugin project.
|
|
5
|
+
* Usage: africode create plugin my-plugin [--minimal] [--with-tests] [--hook onRequest,onResponse]
|
|
6
|
+
*/
|
|
7
|
+
import { mkdir, writeFile } from 'fs/promises';
|
|
8
|
+
import { existsSync } from 'fs';
|
|
9
|
+
import path from 'path';
|
|
10
|
+
|
|
11
|
+
const ALLOWED_HOOKS = [
|
|
12
|
+
'onConfigLoad', 'onComponentRegister', 'onRouteRegister',
|
|
13
|
+
'onStateInit', 'onServerStart', 'onRequest', 'onResponse',
|
|
14
|
+
'onError', 'onCliCommandRegister',
|
|
15
|
+
];
|
|
16
|
+
|
|
17
|
+
export async function createPlugin(pluginName, args = []) {
|
|
18
|
+
if (!pluginName) {
|
|
19
|
+
console.error('✗ Please provide a plugin name: africode create plugin my-plugin');
|
|
20
|
+
process.exit(1);
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
const isMinimal = args.includes('--minimal');
|
|
24
|
+
const withTests = args.includes('--with-tests') || !isMinimal;
|
|
25
|
+
const hookFlagIdx = args.indexOf('--hook');
|
|
26
|
+
const selectedHooks = hookFlagIdx > -1
|
|
27
|
+
? args[hookFlagIdx + 1]?.split(',').filter(h => ALLOWED_HOOKS.includes(h)) || ['onRequest', 'onResponse']
|
|
28
|
+
: ['onConfigLoad', 'onRequest', 'onResponse'];
|
|
29
|
+
|
|
30
|
+
const pluginDir = path.join(process.cwd(), pluginName);
|
|
31
|
+
|
|
32
|
+
if (existsSync(pluginDir)) {
|
|
33
|
+
console.error(`✗ Directory "${pluginName}" already exists`);
|
|
34
|
+
process.exit(1);
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
console.log(`\n🔌 Scaffolding AfriCode Plugin: ${pluginName}\n`);
|
|
38
|
+
|
|
39
|
+
// Create directory tree
|
|
40
|
+
await mkdir(path.join(pluginDir, 'src', 'hooks'), { recursive: true });
|
|
41
|
+
await mkdir(path.join(pluginDir, 'src', 'utils'), { recursive: true });
|
|
42
|
+
if (withTests) {await mkdir(path.join(pluginDir, 'tests'), { recursive: true });}
|
|
43
|
+
if (!isMinimal) {await mkdir(path.join(pluginDir, 'examples'), { recursive: true });}
|
|
44
|
+
|
|
45
|
+
// --- package.json ---
|
|
46
|
+
await writeFile(path.join(pluginDir, 'package.json'), JSON.stringify({
|
|
47
|
+
name: pluginName,
|
|
48
|
+
version: '1.0.0',
|
|
49
|
+
description: `AfriCode plugin: ${pluginName}`,
|
|
50
|
+
type: 'module',
|
|
51
|
+
main: 'index.js',
|
|
52
|
+
scripts: {
|
|
53
|
+
test: 'bun test',
|
|
54
|
+
},
|
|
55
|
+
keywords: ['africode', 'plugin', pluginName],
|
|
56
|
+
license: 'MIT',
|
|
57
|
+
peerDependencies: {
|
|
58
|
+
africode: '^3.0.0',
|
|
59
|
+
},
|
|
60
|
+
}, null, 2));
|
|
61
|
+
|
|
62
|
+
// --- manifest.js ---
|
|
63
|
+
await writeFile(path.join(pluginDir, 'src', 'manifest.js'),
|
|
64
|
+
`export default {
|
|
65
|
+
name: '${pluginName}',
|
|
66
|
+
version: '1.0.0',
|
|
67
|
+
compatibleWith: '^3.0.0',
|
|
68
|
+
hooks: ${JSON.stringify(selectedHooks)},
|
|
69
|
+
critical: false,
|
|
70
|
+
};
|
|
71
|
+
`);
|
|
72
|
+
|
|
73
|
+
// --- Hook files ---
|
|
74
|
+
for (const hook of selectedHooks) {
|
|
75
|
+
await writeFile(path.join(pluginDir, 'src', 'hooks', `${hook}.js`),
|
|
76
|
+
`/**
|
|
77
|
+
* ${hook} handler for ${pluginName}
|
|
78
|
+
*/
|
|
79
|
+
export default async function ${hook}(ctx) {
|
|
80
|
+
// Your plugin logic here
|
|
81
|
+
ctx.logger?.info?.(\`[${pluginName}] ${hook} executed\`);
|
|
82
|
+
}
|
|
83
|
+
`);
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
// --- Logger util ---
|
|
87
|
+
await writeFile(path.join(pluginDir, 'src', 'utils', 'logger.js'),
|
|
88
|
+
`/**
|
|
89
|
+
* Simple structured logger for ${pluginName}
|
|
90
|
+
*/
|
|
91
|
+
export const logger = {
|
|
92
|
+
info: (msg) => console.log(\`[INFO] \${msg}\`),
|
|
93
|
+
warn: (msg) => console.warn(\`[WARN] \${msg}\`),
|
|
94
|
+
error: (msg) => console.error(\`[ERROR] \${msg}\`),
|
|
95
|
+
};
|
|
96
|
+
`);
|
|
97
|
+
|
|
98
|
+
// --- index.js ---
|
|
99
|
+
const hookImports = selectedHooks.map(h => `import ${h} from './src/hooks/${h}.js';`).join('\n');
|
|
100
|
+
const hookEntries = selectedHooks.map(h => ` ${h},`).join('\n');
|
|
101
|
+
await writeFile(path.join(pluginDir, 'index.js'),
|
|
102
|
+
`import manifest from './src/manifest.js';
|
|
103
|
+
${hookImports}
|
|
104
|
+
|
|
105
|
+
export default {
|
|
106
|
+
manifest,
|
|
107
|
+
${hookEntries}
|
|
108
|
+
};
|
|
109
|
+
`);
|
|
110
|
+
|
|
111
|
+
// --- plugin.config.js ---
|
|
112
|
+
await writeFile(path.join(pluginDir, 'plugin.config.js'),
|
|
113
|
+
`/**
|
|
114
|
+
* Plugin configuration defaults.
|
|
115
|
+
* These can be overridden by the host application's config.
|
|
116
|
+
*/
|
|
117
|
+
export default {
|
|
118
|
+
enabled: true,
|
|
119
|
+
logLevel: 'info',
|
|
120
|
+
};
|
|
121
|
+
`);
|
|
122
|
+
|
|
123
|
+
// --- Tests ---
|
|
124
|
+
if (withTests) {
|
|
125
|
+
await writeFile(path.join(pluginDir, 'tests', 'plugin.test.js'),
|
|
126
|
+
`import { describe, it, expect } from 'bun:test';
|
|
127
|
+
import plugin from '../index.js';
|
|
128
|
+
|
|
129
|
+
describe('${pluginName}', () => {
|
|
130
|
+
it('should have a valid manifest', () => {
|
|
131
|
+
expect(plugin.manifest).toBeDefined();
|
|
132
|
+
expect(plugin.manifest.name).toBe('${pluginName}');
|
|
133
|
+
expect(plugin.manifest.version).toBeDefined();
|
|
134
|
+
expect(plugin.manifest.compatibleWith).toBeDefined();
|
|
135
|
+
});
|
|
136
|
+
|
|
137
|
+
it('should only declare allowed hooks', () => {
|
|
138
|
+
const allowed = new Set([
|
|
139
|
+
'onConfigLoad', 'onComponentRegister', 'onRouteRegister',
|
|
140
|
+
'onStateInit', 'onServerStart', 'onRequest', 'onResponse',
|
|
141
|
+
'onError', 'onCliCommandRegister',
|
|
142
|
+
]);
|
|
143
|
+
for (const hook of plugin.manifest.hooks) {
|
|
144
|
+
expect(allowed.has(hook)).toBe(true);
|
|
145
|
+
}
|
|
146
|
+
});
|
|
147
|
+
|
|
148
|
+
it('should expose all declared hooks as functions', () => {
|
|
149
|
+
for (const hook of plugin.manifest.hooks) {
|
|
150
|
+
expect(typeof plugin[hook]).toBe('function');
|
|
151
|
+
}
|
|
152
|
+
});
|
|
153
|
+
|
|
154
|
+
it('hooks should execute without throwing', async () => {
|
|
155
|
+
const mockCtx = { logger: { info: () => {}, warn: () => {}, error: () => {} } };
|
|
156
|
+
for (const hook of plugin.manifest.hooks) {
|
|
157
|
+
await expect(plugin[hook](mockCtx)).resolves.toBeUndefined();
|
|
158
|
+
}
|
|
159
|
+
});
|
|
160
|
+
});
|
|
161
|
+
`);
|
|
162
|
+
}
|
|
163
|
+
|
|
164
|
+
// --- README.md ---
|
|
165
|
+
await writeFile(path.join(pluginDir, 'README.md'),
|
|
166
|
+
`# ${pluginName}
|
|
167
|
+
|
|
168
|
+
An AfriCode Framework plugin.
|
|
169
|
+
|
|
170
|
+
## What this plugin does
|
|
171
|
+
|
|
172
|
+
Describe your plugin's purpose here.
|
|
173
|
+
|
|
174
|
+
## Supported Hooks
|
|
175
|
+
|
|
176
|
+
${selectedHooks.map(h => `- \`${h}\``).join('\n')}
|
|
177
|
+
|
|
178
|
+
## Install
|
|
179
|
+
|
|
180
|
+
\`\`\`bash
|
|
181
|
+
bun add ${pluginName}
|
|
182
|
+
\`\`\`
|
|
183
|
+
|
|
184
|
+
## Register
|
|
185
|
+
|
|
186
|
+
\`\`\`javascript
|
|
187
|
+
import plugin from '${pluginName}';
|
|
188
|
+
|
|
189
|
+
africode.plugins.register(plugin.manifest, plugin);
|
|
190
|
+
\`\`\`
|
|
191
|
+
|
|
192
|
+
## Configuration
|
|
193
|
+
|
|
194
|
+
Edit \`plugin.config.js\` to adjust defaults.
|
|
195
|
+
|
|
196
|
+
## Troubleshooting
|
|
197
|
+
|
|
198
|
+
- Ensure your AfriCode version satisfies \`${'^3.0.0'}\`
|
|
199
|
+
- Check that only valid hooks are declared in the manifest
|
|
200
|
+
|
|
201
|
+
## Compatibility
|
|
202
|
+
|
|
203
|
+
| AfriCode Version | Plugin Version |
|
|
204
|
+
|:---:|:---:|
|
|
205
|
+
| ^3.0.0 | 1.0.0 |
|
|
206
|
+
`);
|
|
207
|
+
|
|
208
|
+
// --- Example usage ---
|
|
209
|
+
if (!isMinimal) {
|
|
210
|
+
await writeFile(path.join(pluginDir, 'examples', 'usage.js'),
|
|
211
|
+
`/**
|
|
212
|
+
* Example: registering ${pluginName} in an AfriCode app
|
|
213
|
+
*/
|
|
214
|
+
import { AfriPluginRegistry } from 'africode/core/plugins/index.js';
|
|
215
|
+
import plugin from '../index.js';
|
|
216
|
+
|
|
217
|
+
const registry = new AfriPluginRegistry();
|
|
218
|
+
registry.register(plugin.manifest, plugin);
|
|
219
|
+
|
|
220
|
+
// Simulate a hook emission
|
|
221
|
+
await registry.emit('onRequest', { req: {}, meta: {} });
|
|
222
|
+
console.log('Plugin executed successfully!');
|
|
223
|
+
`);
|
|
224
|
+
}
|
|
225
|
+
|
|
226
|
+
console.log(`✓ Created ${pluginName}/`);
|
|
227
|
+
console.log(` ├── package.json`);
|
|
228
|
+
console.log(` ├── index.js`);
|
|
229
|
+
console.log(` ├── plugin.config.js`);
|
|
230
|
+
console.log(` ├── README.md`);
|
|
231
|
+
console.log(` ├── src/`);
|
|
232
|
+
console.log(` │ ├── manifest.js`);
|
|
233
|
+
console.log(` │ ├── hooks/`);
|
|
234
|
+
selectedHooks.forEach(h => console.log(` │ │ └── ${h}.js`));
|
|
235
|
+
console.log(` │ └── utils/logger.js`);
|
|
236
|
+
if (withTests) {console.log(` ├── tests/plugin.test.js`);}
|
|
237
|
+
if (!isMinimal) {console.log(` └── examples/usage.js`);}
|
|
238
|
+
console.log(`\n🚀 Next steps:`);
|
|
239
|
+
console.log(` cd ${pluginName}`);
|
|
240
|
+
console.log(` bun test\n`);
|
|
241
|
+
}
|