@portel/photon-core 1.0.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/LICENSE +21 -0
- package/README.md +403 -0
- package/dist/base.d.ts +58 -0
- package/dist/base.d.ts.map +1 -0
- package/dist/base.js +92 -0
- package/dist/base.js.map +1 -0
- package/dist/dependency-manager.d.ts +49 -0
- package/dist/dependency-manager.d.ts.map +1 -0
- package/dist/dependency-manager.js +165 -0
- package/dist/dependency-manager.js.map +1 -0
- package/dist/index.d.ts +39 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +43 -0
- package/dist/index.js.map +1 -0
- package/dist/schema-extractor.d.ts +110 -0
- package/dist/schema-extractor.d.ts.map +1 -0
- package/dist/schema-extractor.js +727 -0
- package/dist/schema-extractor.js.map +1 -0
- package/dist/types.d.ts +109 -0
- package/dist/types.d.ts.map +1 -0
- package/dist/types.js +12 -0
- package/dist/types.js.map +1 -0
- package/package.json +58 -0
- package/src/base.ts +105 -0
- package/src/dependency-manager.ts +206 -0
- package/src/index.ts +46 -0
- package/src/schema-extractor.ts +833 -0
- package/src/types.ts +117 -0
|
@@ -0,0 +1,165 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Dependency Manager for Photon MCPs
|
|
3
|
+
*
|
|
4
|
+
* Handles automatic installation of dependencies declared in MCP files
|
|
5
|
+
* Similar to Python's UV or npx behavior
|
|
6
|
+
*/
|
|
7
|
+
import * as fs from 'fs/promises';
|
|
8
|
+
import * as path from 'path';
|
|
9
|
+
import * as os from 'os';
|
|
10
|
+
import { spawn } from 'child_process';
|
|
11
|
+
/**
|
|
12
|
+
* Manages dependencies for Photon MCPs
|
|
13
|
+
*/
|
|
14
|
+
export class DependencyManager {
|
|
15
|
+
cacheDir;
|
|
16
|
+
constructor() {
|
|
17
|
+
// Store dependencies in ~/.cache/photon-mcp/dependencies/
|
|
18
|
+
this.cacheDir = path.join(os.homedir(), '.cache', 'photon-mcp', 'dependencies');
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* Extract dependencies from MCP source file
|
|
22
|
+
*
|
|
23
|
+
* Looks for @dependencies JSDoc tag:
|
|
24
|
+
* @dependencies axios@^1.0.0, date-fns@^2.0.0
|
|
25
|
+
* @dependencies octokit@^3.1.0
|
|
26
|
+
*/
|
|
27
|
+
async extractDependencies(sourceFilePath) {
|
|
28
|
+
const content = await fs.readFile(sourceFilePath, 'utf-8');
|
|
29
|
+
const dependencies = [];
|
|
30
|
+
// Match @dependencies tags in JSDoc comments
|
|
31
|
+
// Regex: @dependencies package@version, package2@version2
|
|
32
|
+
const dependencyRegex = /@dependencies\s+([\w@^~.,\s-]+)/g;
|
|
33
|
+
let match;
|
|
34
|
+
while ((match = dependencyRegex.exec(content)) !== null) {
|
|
35
|
+
const depString = match[1].trim();
|
|
36
|
+
// Split by comma for multiple dependencies
|
|
37
|
+
const deps = depString.split(',').map(d => d.trim());
|
|
38
|
+
for (const dep of deps) {
|
|
39
|
+
// Parse: package@version
|
|
40
|
+
const parts = dep.split('@');
|
|
41
|
+
// Handle scoped packages like @octokit/rest@^1.0.0
|
|
42
|
+
let name, version;
|
|
43
|
+
if (dep.startsWith('@')) {
|
|
44
|
+
// Scoped package: @scope/package@version
|
|
45
|
+
const atIndex = dep.indexOf('@', 1); // Find second @
|
|
46
|
+
if (atIndex > 0) {
|
|
47
|
+
name = dep.substring(0, atIndex);
|
|
48
|
+
version = dep.substring(atIndex + 1);
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
else {
|
|
52
|
+
// Regular package: package@version
|
|
53
|
+
[name, version] = parts;
|
|
54
|
+
}
|
|
55
|
+
if (name && version) {
|
|
56
|
+
dependencies.push({ name, version });
|
|
57
|
+
}
|
|
58
|
+
}
|
|
59
|
+
}
|
|
60
|
+
return dependencies;
|
|
61
|
+
}
|
|
62
|
+
/**
|
|
63
|
+
* Ensure dependencies are installed for an MCP
|
|
64
|
+
*
|
|
65
|
+
* Returns the path to node_modules where dependencies are installed
|
|
66
|
+
*/
|
|
67
|
+
async ensureDependencies(mcpName, dependencies) {
|
|
68
|
+
if (dependencies.length === 0) {
|
|
69
|
+
return null;
|
|
70
|
+
}
|
|
71
|
+
// Create MCP-specific directory
|
|
72
|
+
const mcpDir = path.join(this.cacheDir, mcpName);
|
|
73
|
+
const nodeModules = path.join(mcpDir, 'node_modules');
|
|
74
|
+
// Check if already installed
|
|
75
|
+
const installed = await this.checkInstalled(mcpDir, dependencies);
|
|
76
|
+
if (installed) {
|
|
77
|
+
console.error(`Dependencies already installed for ${mcpName}`);
|
|
78
|
+
return nodeModules;
|
|
79
|
+
}
|
|
80
|
+
// Create directory
|
|
81
|
+
await fs.mkdir(mcpDir, { recursive: true });
|
|
82
|
+
// Create minimal package.json
|
|
83
|
+
const packageJson = {
|
|
84
|
+
name: `photon-${mcpName}`,
|
|
85
|
+
version: '1.0.0',
|
|
86
|
+
type: 'module',
|
|
87
|
+
dependencies: Object.fromEntries(dependencies.map(d => [d.name, d.version])),
|
|
88
|
+
};
|
|
89
|
+
await fs.writeFile(path.join(mcpDir, 'package.json'), JSON.stringify(packageJson, null, 2));
|
|
90
|
+
// Install dependencies
|
|
91
|
+
console.error(`📦 Installing dependencies for ${mcpName}...`);
|
|
92
|
+
await this.runNpmInstall(mcpDir);
|
|
93
|
+
console.error(`✅ Dependencies installed for ${mcpName}`);
|
|
94
|
+
return nodeModules;
|
|
95
|
+
}
|
|
96
|
+
/**
|
|
97
|
+
* Check if dependencies are already installed
|
|
98
|
+
*/
|
|
99
|
+
async checkInstalled(mcpDir, dependencies) {
|
|
100
|
+
try {
|
|
101
|
+
const packageJsonPath = path.join(mcpDir, 'package.json');
|
|
102
|
+
const packageJson = JSON.parse(await fs.readFile(packageJsonPath, 'utf-8'));
|
|
103
|
+
// Check if all dependencies match
|
|
104
|
+
for (const dep of dependencies) {
|
|
105
|
+
if (packageJson.dependencies?.[dep.name] !== dep.version) {
|
|
106
|
+
return false;
|
|
107
|
+
}
|
|
108
|
+
}
|
|
109
|
+
// Check if node_modules exists
|
|
110
|
+
const nodeModules = path.join(mcpDir, 'node_modules');
|
|
111
|
+
await fs.access(nodeModules);
|
|
112
|
+
return true;
|
|
113
|
+
}
|
|
114
|
+
catch {
|
|
115
|
+
return false;
|
|
116
|
+
}
|
|
117
|
+
}
|
|
118
|
+
/**
|
|
119
|
+
* Run npm install in a directory
|
|
120
|
+
*/
|
|
121
|
+
async runNpmInstall(cwd) {
|
|
122
|
+
return new Promise((resolve, reject) => {
|
|
123
|
+
const npmCmd = process.platform === 'win32' ? 'npm.cmd' : 'npm';
|
|
124
|
+
const child = spawn(npmCmd, ['install', '--omit=dev', '--silent'], {
|
|
125
|
+
cwd,
|
|
126
|
+
stdio: 'inherit',
|
|
127
|
+
});
|
|
128
|
+
child.on('exit', (code) => {
|
|
129
|
+
if (code === 0) {
|
|
130
|
+
resolve();
|
|
131
|
+
}
|
|
132
|
+
else {
|
|
133
|
+
reject(new Error(`npm install failed with code ${code}`));
|
|
134
|
+
}
|
|
135
|
+
});
|
|
136
|
+
child.on('error', reject);
|
|
137
|
+
});
|
|
138
|
+
}
|
|
139
|
+
/**
|
|
140
|
+
* Clear cache for an MCP
|
|
141
|
+
*/
|
|
142
|
+
async clearCache(mcpName) {
|
|
143
|
+
const mcpDir = path.join(this.cacheDir, mcpName);
|
|
144
|
+
try {
|
|
145
|
+
await fs.rm(mcpDir, { recursive: true, force: true });
|
|
146
|
+
console.error(`🗑️ Cleared cache for ${mcpName}`);
|
|
147
|
+
}
|
|
148
|
+
catch (error) {
|
|
149
|
+
console.error(`Failed to clear cache for ${mcpName}: ${error.message}`);
|
|
150
|
+
}
|
|
151
|
+
}
|
|
152
|
+
/**
|
|
153
|
+
* Clear all cached dependencies
|
|
154
|
+
*/
|
|
155
|
+
async clearAllCache() {
|
|
156
|
+
try {
|
|
157
|
+
await fs.rm(this.cacheDir, { recursive: true, force: true });
|
|
158
|
+
console.error(`🗑️ Cleared all MCP dependency cache`);
|
|
159
|
+
}
|
|
160
|
+
catch (error) {
|
|
161
|
+
console.error(`Failed to clear cache: ${error.message}`);
|
|
162
|
+
}
|
|
163
|
+
}
|
|
164
|
+
}
|
|
165
|
+
//# sourceMappingURL=dependency-manager.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"dependency-manager.js","sourceRoot":"","sources":["../src/dependency-manager.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,MAAM,aAAa,CAAC;AAClC,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AACzB,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AAOtC;;GAEG;AACH,MAAM,OAAO,iBAAiB;IACpB,QAAQ,CAAS;IAEzB;QACE,0DAA0D;QAC1D,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,EAAE,QAAQ,EAAE,YAAY,EAAE,cAAc,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,mBAAmB,CAAC,cAAsB;QAC9C,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;QAE3D,MAAM,YAAY,GAAqB,EAAE,CAAC;QAE1C,6CAA6C;QAC7C,0DAA0D;QAC1D,MAAM,eAAe,GAAG,kCAAkC,CAAC;QAE3D,IAAI,KAAK,CAAC;QACV,OAAO,CAAC,KAAK,GAAG,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC;YACxD,MAAM,SAAS,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;YAElC,2CAA2C;YAC3C,MAAM,IAAI,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;YAErD,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;gBACvB,yBAAyB;gBACzB,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBAC7B,mDAAmD;gBACnD,IAAI,IAAI,EAAE,OAAO,CAAC;gBAClB,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;oBACxB,yCAAyC;oBACzC,MAAM,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,gBAAgB;oBACrD,IAAI,OAAO,GAAG,CAAC,EAAE,CAAC;wBAChB,IAAI,GAAG,GAAG,CAAC,SAAS,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;wBACjC,OAAO,GAAG,GAAG,CAAC,SAAS,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC;oBACvC,CAAC;gBACH,CAAC;qBAAM,CAAC;oBACN,mCAAmC;oBACnC,CAAC,IAAI,EAAE,OAAO,CAAC,GAAG,KAAK,CAAC;gBAC1B,CAAC;gBAED,IAAI,IAAI,IAAI,OAAO,EAAE,CAAC;oBACpB,YAAY,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;gBACvC,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,YAAY,CAAC;IACtB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,kBAAkB,CACtB,OAAe,EACf,YAA8B;QAE9B,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC9B,OAAO,IAAI,CAAC;QACd,CAAC;QAED,gCAAgC;QAChC,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QACjD,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;QAEtD,6BAA6B;QAC7B,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;QAClE,IAAI,SAAS,EAAE,CAAC;YACd,OAAO,CAAC,KAAK,CAAC,sCAAsC,OAAO,EAAE,CAAC,CAAC;YAC/D,OAAO,WAAW,CAAC;QACrB,CAAC;QAED,mBAAmB;QACnB,MAAM,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAE5C,8BAA8B;QAC9B,MAAM,WAAW,GAAG;YAClB,IAAI,EAAE,UAAU,OAAO,EAAE;YACzB,OAAO,EAAE,OAAO;YAChB,IAAI,EAAE,QAAQ;YACd,YAAY,EAAE,MAAM,CAAC,WAAW,CAC9B,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAC3C;SACF,CAAC;QAEF,MAAM,EAAE,CAAC,SAAS,CAChB,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,cAAc,CAAC,EACjC,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC,CACrC,CAAC;QAEF,uBAAuB;QACvB,OAAO,CAAC,KAAK,CAAC,kCAAkC,OAAO,KAAK,CAAC,CAAC;QAC9D,MAAM,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,CAAC,KAAK,CAAC,gCAAgC,OAAO,EAAE,CAAC,CAAC;QACzD,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,cAAc,CAC1B,MAAc,EACd,YAA8B;QAE9B,IAAI,CAAC;YACH,MAAM,eAAe,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;YAC1D,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAC5B,MAAM,EAAE,CAAC,QAAQ,CAAC,eAAe,EAAE,OAAO,CAAC,CAC5C,CAAC;YAEF,kCAAkC;YAClC,KAAK,MAAM,GAAG,IAAI,YAAY,EAAE,CAAC;gBAC/B,IAAI,WAAW,CAAC,YAAY,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,OAAO,EAAE,CAAC;oBACzD,OAAO,KAAK,CAAC;gBACf,CAAC;YACH,CAAC;YAED,+BAA+B;YAC/B,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;YACtD,MAAM,EAAE,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;YAE7B,OAAO,IAAI,CAAC;QACd,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,aAAa,CAAC,GAAW;QACrC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,MAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,KAAK,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC;YAEhE,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,SAAS,EAAE,YAAY,EAAE,UAAU,CAAC,EAAE;gBACjE,GAAG;gBACH,KAAK,EAAE,SAAS;aACjB,CAAC,CAAC;YAEH,KAAK,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE;gBACxB,IAAI,IAAI,KAAK,CAAC,EAAE,CAAC;oBACf,OAAO,EAAE,CAAC;gBACZ,CAAC;qBAAM,CAAC;oBACN,MAAM,CAAC,IAAI,KAAK,CAAC,gCAAgC,IAAI,EAAE,CAAC,CAAC,CAAC;gBAC5D,CAAC;YACH,CAAC,CAAC,CAAC;YAEH,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAC5B,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,UAAU,CAAC,OAAe;QAC9B,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QACjD,IAAI,CAAC;YACH,MAAM,EAAE,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;YACtD,OAAO,CAAC,KAAK,CAAC,0BAA0B,OAAO,EAAE,CAAC,CAAC;QACrD,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YACpB,OAAO,CAAC,KAAK,CAAC,6BAA6B,OAAO,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;QAC1E,CAAC;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,aAAa;QACjB,IAAI,CAAC;YACH,MAAM,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;YAC7D,OAAO,CAAC,KAAK,CAAC,uCAAuC,CAAC,CAAC;QACzD,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YACpB,OAAO,CAAC,KAAK,CAAC,0BAA0B,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;QAC3D,CAAC;IACH,CAAC;CACF"}
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @portel/photon-core
|
|
3
|
+
*
|
|
4
|
+
* Core Photon format library for parsing, loading, and managing .photon.ts files
|
|
5
|
+
* WITHOUT any runtime dependencies (MCP server, CLI, etc.)
|
|
6
|
+
*
|
|
7
|
+
* Use this package to build custom runtimes that work with Photon classes:
|
|
8
|
+
* - Multi-protocol API servers (REST, GraphQL, RPC, MCP)
|
|
9
|
+
* - Orchestrators (NCP)
|
|
10
|
+
* - Custom tool runners
|
|
11
|
+
*
|
|
12
|
+
* @example
|
|
13
|
+
* ```typescript
|
|
14
|
+
* import { PhotonMCP, DependencyManager, SchemaExtractor } from '@portel/photon-core';
|
|
15
|
+
*
|
|
16
|
+
* // Load and parse a Photon class
|
|
17
|
+
* const photonClass = await import('./my-tool.photon.ts');
|
|
18
|
+
* const instance = new photonClass.default();
|
|
19
|
+
*
|
|
20
|
+
* // Extract dependencies
|
|
21
|
+
* const depManager = new DependencyManager();
|
|
22
|
+
* const deps = await depManager.extractDependencies('./my-tool.photon.ts');
|
|
23
|
+
* await depManager.ensureDependencies('my-tool', deps);
|
|
24
|
+
*
|
|
25
|
+
* // Extract schemas
|
|
26
|
+
* const extractor = new SchemaExtractor();
|
|
27
|
+
* const schemas = await extractor.extractFromFile('./my-tool.photon.ts');
|
|
28
|
+
*
|
|
29
|
+
* // Call lifecycle hooks
|
|
30
|
+
* if (instance.onInitialize) {
|
|
31
|
+
* await instance.onInitialize();
|
|
32
|
+
* }
|
|
33
|
+
* ```
|
|
34
|
+
*/
|
|
35
|
+
export { PhotonMCP } from './base.js';
|
|
36
|
+
export { DependencyManager } from './dependency-manager.js';
|
|
37
|
+
export { SchemaExtractor } from './schema-extractor.js';
|
|
38
|
+
export * from './types.js';
|
|
39
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AAGH,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAGtC,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAG5D,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAGxD,cAAc,YAAY,CAAC"}
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @portel/photon-core
|
|
3
|
+
*
|
|
4
|
+
* Core Photon format library for parsing, loading, and managing .photon.ts files
|
|
5
|
+
* WITHOUT any runtime dependencies (MCP server, CLI, etc.)
|
|
6
|
+
*
|
|
7
|
+
* Use this package to build custom runtimes that work with Photon classes:
|
|
8
|
+
* - Multi-protocol API servers (REST, GraphQL, RPC, MCP)
|
|
9
|
+
* - Orchestrators (NCP)
|
|
10
|
+
* - Custom tool runners
|
|
11
|
+
*
|
|
12
|
+
* @example
|
|
13
|
+
* ```typescript
|
|
14
|
+
* import { PhotonMCP, DependencyManager, SchemaExtractor } from '@portel/photon-core';
|
|
15
|
+
*
|
|
16
|
+
* // Load and parse a Photon class
|
|
17
|
+
* const photonClass = await import('./my-tool.photon.ts');
|
|
18
|
+
* const instance = new photonClass.default();
|
|
19
|
+
*
|
|
20
|
+
* // Extract dependencies
|
|
21
|
+
* const depManager = new DependencyManager();
|
|
22
|
+
* const deps = await depManager.extractDependencies('./my-tool.photon.ts');
|
|
23
|
+
* await depManager.ensureDependencies('my-tool', deps);
|
|
24
|
+
*
|
|
25
|
+
* // Extract schemas
|
|
26
|
+
* const extractor = new SchemaExtractor();
|
|
27
|
+
* const schemas = await extractor.extractFromFile('./my-tool.photon.ts');
|
|
28
|
+
*
|
|
29
|
+
* // Call lifecycle hooks
|
|
30
|
+
* if (instance.onInitialize) {
|
|
31
|
+
* await instance.onInitialize();
|
|
32
|
+
* }
|
|
33
|
+
* ```
|
|
34
|
+
*/
|
|
35
|
+
// Core base class with lifecycle hooks
|
|
36
|
+
export { PhotonMCP } from './base.js';
|
|
37
|
+
// Dependency management
|
|
38
|
+
export { DependencyManager } from './dependency-manager.js';
|
|
39
|
+
// Schema extraction
|
|
40
|
+
export { SchemaExtractor } from './schema-extractor.js';
|
|
41
|
+
// Types
|
|
42
|
+
export * from './types.js';
|
|
43
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AAEH,uCAAuC;AACvC,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAEtC,wBAAwB;AACxB,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAE5D,oBAAoB;AACpB,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAExD,QAAQ;AACR,cAAc,YAAY,CAAC"}
|
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Schema Extractor
|
|
3
|
+
*
|
|
4
|
+
* Extracts JSON schemas from TypeScript method signatures and JSDoc comments
|
|
5
|
+
* Also extracts constructor parameters for config injection
|
|
6
|
+
* Supports Templates (@Template) and Static resources (@Static)
|
|
7
|
+
*
|
|
8
|
+
* Now uses TypeScript's compiler API for robust type parsing
|
|
9
|
+
*/
|
|
10
|
+
import { ExtractedSchema, ConstructorParam, TemplateInfo, StaticInfo } from './types.js';
|
|
11
|
+
export interface ExtractedMetadata {
|
|
12
|
+
tools: ExtractedSchema[];
|
|
13
|
+
templates: TemplateInfo[];
|
|
14
|
+
statics: StaticInfo[];
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* Extract schemas from a Photon MCP class file
|
|
18
|
+
*/
|
|
19
|
+
export declare class SchemaExtractor {
|
|
20
|
+
/**
|
|
21
|
+
* Extract method schemas from source code file
|
|
22
|
+
*/
|
|
23
|
+
extractFromFile(filePath: string): Promise<ExtractedSchema[]>;
|
|
24
|
+
/**
|
|
25
|
+
* Extract all metadata (tools, templates, statics) from source code
|
|
26
|
+
*/
|
|
27
|
+
extractAllFromSource(source: string): ExtractedMetadata;
|
|
28
|
+
/**
|
|
29
|
+
* Extract schemas from source code string (backward compatibility)
|
|
30
|
+
*/
|
|
31
|
+
extractFromSource(source: string): ExtractedSchema[];
|
|
32
|
+
/**
|
|
33
|
+
* Get JSDoc comment for a node
|
|
34
|
+
*/
|
|
35
|
+
private getJSDocComment;
|
|
36
|
+
/**
|
|
37
|
+
* Get the first parameter's type node
|
|
38
|
+
*/
|
|
39
|
+
private getFirstParameterType;
|
|
40
|
+
/**
|
|
41
|
+
* Build JSON schema from TypeScript type node
|
|
42
|
+
* Extracts: type, optional, readonly
|
|
43
|
+
*/
|
|
44
|
+
private buildSchemaFromType;
|
|
45
|
+
/**
|
|
46
|
+
* Convert TypeScript type node to JSON schema
|
|
47
|
+
*/
|
|
48
|
+
private typeNodeToSchema;
|
|
49
|
+
/**
|
|
50
|
+
* Extract enum values from a union of literal types
|
|
51
|
+
* Returns a proper enum schema if all types are literals of the same kind
|
|
52
|
+
* Returns an optimized anyOf schema for mixed unions (e.g., number | '+1' | '-1')
|
|
53
|
+
* Returns null if the union should use standard anyOf processing
|
|
54
|
+
*/
|
|
55
|
+
private extractEnumFromUnion;
|
|
56
|
+
/**
|
|
57
|
+
* Extract constructor parameters for config injection
|
|
58
|
+
*/
|
|
59
|
+
extractConstructorParams(source: string): ConstructorParam[];
|
|
60
|
+
/**
|
|
61
|
+
* Extract default value from initializer
|
|
62
|
+
*/
|
|
63
|
+
private extractDefaultValue;
|
|
64
|
+
/**
|
|
65
|
+
* Extract main description from JSDoc comment
|
|
66
|
+
*/
|
|
67
|
+
private extractDescription;
|
|
68
|
+
/**
|
|
69
|
+
* Extract parameter descriptions from JSDoc @param tags
|
|
70
|
+
* Also removes constraint tags from descriptions
|
|
71
|
+
*/
|
|
72
|
+
private extractParamDocs;
|
|
73
|
+
/**
|
|
74
|
+
* Extract parameter constraints from JSDoc @param tags
|
|
75
|
+
* Supports inline tags: {@min}, {@max}, {@pattern}, {@format}, {@default}, {@unique},
|
|
76
|
+
* {@example}, {@multipleOf}, {@deprecated}, {@readOnly}, {@writeOnly}
|
|
77
|
+
*/
|
|
78
|
+
private extractParamConstraints;
|
|
79
|
+
/**
|
|
80
|
+
* Apply constraints to a schema property based on type
|
|
81
|
+
* Handles: min/max (contextual), pattern, format, default, unique,
|
|
82
|
+
* examples, multipleOf, deprecated, readOnly, writeOnly
|
|
83
|
+
* Works with both simple types and anyOf schemas
|
|
84
|
+
*/
|
|
85
|
+
private applyConstraints;
|
|
86
|
+
/**
|
|
87
|
+
* Check if JSDoc contains @Template tag
|
|
88
|
+
*/
|
|
89
|
+
private hasTemplateTag;
|
|
90
|
+
/**
|
|
91
|
+
* Check if JSDoc contains @Static tag
|
|
92
|
+
*/
|
|
93
|
+
private hasStaticTag;
|
|
94
|
+
/**
|
|
95
|
+
* Extract URI pattern from @Static tag
|
|
96
|
+
* Example: @Static github://repos/{owner}/{repo}/readme
|
|
97
|
+
*/
|
|
98
|
+
private extractStaticURI;
|
|
99
|
+
/**
|
|
100
|
+
* Extract format hint from @format tag
|
|
101
|
+
* Example: @format table
|
|
102
|
+
*/
|
|
103
|
+
private extractFormat;
|
|
104
|
+
/**
|
|
105
|
+
* Extract MIME type from @mimeType tag
|
|
106
|
+
* Example: @mimeType text/markdown
|
|
107
|
+
*/
|
|
108
|
+
private extractMimeType;
|
|
109
|
+
}
|
|
110
|
+
//# sourceMappingURL=schema-extractor.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"schema-extractor.d.ts","sourceRoot":"","sources":["../src/schema-extractor.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAIH,OAAO,EAAE,eAAe,EAAE,gBAAgB,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAEzF,MAAM,WAAW,iBAAiB;IAChC,KAAK,EAAE,eAAe,EAAE,CAAC;IACzB,SAAS,EAAE,YAAY,EAAE,CAAC;IAC1B,OAAO,EAAE,UAAU,EAAE,CAAC;CACvB;AAED;;GAEG;AACH,qBAAa,eAAe;IAC1B;;OAEG;IACG,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IAUnE;;OAEG;IACH,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,iBAAiB;IAyHvD;;OAEG;IACH,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,eAAe,EAAE;IAIpD;;OAEG;IACH,OAAO,CAAC,eAAe;IAqBvB;;OAEG;IACH,OAAO,CAAC,qBAAqB;IAS7B;;;OAGG;IACH,OAAO,CAAC,mBAAmB;IAiC3B;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAyGxB;;;;;OAKG;IACH,OAAO,CAAC,oBAAoB;IA0F5B;;OAEG;IACH,wBAAwB,CAAC,MAAM,EAAE,MAAM,GAAG,gBAAgB,EAAE;IAmD5D;;OAEG;IACH,OAAO,CAAC,mBAAmB;IAuB3B;;OAEG;IACH,OAAO,CAAC,kBAAkB;IAqB1B;;;OAGG;IACH,OAAO,CAAC,gBAAgB;IA4BxB;;;;OAIG;IACH,OAAO,CAAC,uBAAuB;IA2G/B;;;;;OAKG;IACH,OAAO,CAAC,gBAAgB;IA0FxB;;OAEG;IACH,OAAO,CAAC,cAAc;IAItB;;OAEG;IACH,OAAO,CAAC,YAAY;IAIpB;;;OAGG;IACH,OAAO,CAAC,gBAAgB;IAKxB;;;OAGG;IACH,OAAO,CAAC,aAAa;IAQrB;;;OAGG;IACH,OAAO,CAAC,eAAe;CAIxB"}
|