@pikku/cli 0.9.1 → 0.9.3
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/CHANGELOG.md +35 -0
- package/bin/pikku-all.ts +13 -6
- package/bin/pikku-nextjs.ts +3 -3
- package/cli.schema.json +4 -0
- package/dist/bin/pikku-all.js +10 -6
- package/dist/bin/pikku-nextjs.js +3 -3
- package/dist/src/pikku-cli-config.d.ts +3 -0
- package/dist/src/pikku-cli-config.js +15 -4
- package/dist/src/serialize-import-map.js +62 -1
- package/dist/src/serialize-pikku-types.js +30 -27
- package/dist/src/utils.js +24 -2
- package/dist/src/wirings/functions/pikku-command-function-types.js +2 -2
- package/dist/src/wirings/functions/pikku-command-functions.d.ts +0 -4
- package/dist/src/wirings/functions/pikku-command-functions.js +10 -31
- package/dist/src/wirings/functions/pikku-command-services.js +1 -1
- package/dist/src/wirings/functions/pikku-function-types.js +2 -2
- package/dist/src/wirings/functions/serialize-function-imports.d.ts +6 -0
- package/dist/src/wirings/functions/serialize-function-imports.js +59 -0
- package/dist/src/wirings/rpc/pikku-command-rpc-client.js +3 -3
- package/dist/src/wirings/rpc/pikku-command-rpc-map.d.ts +2 -1
- package/dist/src/wirings/rpc/pikku-command-rpc-map.js +9 -3
- package/dist/src/wirings/rpc/pikku-command-rpc.js +7 -2
- package/dist/src/wirings/rpc/serialize-typed-rpc-map.d.ts +1 -2
- package/dist/src/wirings/rpc/serialize-typed-rpc-map.js +2 -1
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/package.json +11 -11
- package/src/pikku-cli-config.ts +35 -5
- package/src/serialize-import-map.ts +67 -2
- package/src/serialize-pikku-types.ts +30 -27
- package/src/utils.ts +31 -2
- package/src/wirings/functions/pikku-command-function-types.ts +6 -2
- package/src/wirings/functions/pikku-command-functions.ts +28 -64
- package/src/wirings/functions/pikku-command-services.ts +1 -1
- package/src/wirings/functions/pikku-function-types.ts +6 -2
- package/src/wirings/functions/serialize-function-imports.ts +97 -0
- package/src/wirings/rpc/pikku-command-rpc-client.ts +9 -5
- package/src/wirings/rpc/pikku-command-rpc-map.ts +27 -4
- package/src/wirings/rpc/pikku-command-rpc.ts +16 -6
- package/src/wirings/rpc/serialize-typed-rpc-map.ts +4 -5
- package/dist/src/wirings/functions/pikku-functions.d.ts +0 -6
- package/dist/src/wirings/functions/pikku-functions.js +0 -35
- package/dist/src/wirings/rpc/pikku-rpc.d.ts +0 -2
- package/dist/src/wirings/rpc/pikku-rpc.js +0 -6
- package/src/wirings/functions/pikku-functions.ts +0 -84
- package/src/wirings/rpc/pikku-rpc.ts +0 -22
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { serializeRPCWrapper } from './serialize-rpc-wrapper.js';
|
|
2
2
|
import { getFileImportRelativePath, logCommandInfoAndTime, writeFileInDir, } from '../../utils.js';
|
|
3
|
-
export const pikkuRPCClient = async (logger, { rpcWiringsFile, rpcMapDeclarationFile, packageMappings }) => {
|
|
4
|
-
return await logCommandInfoAndTime(logger, 'Generating RPC
|
|
5
|
-
rpcWiringsFile === undefined,
|
|
3
|
+
export const pikkuRPCClient = async (logger, { rpcWiringsFile, rpcMapDeclarationFile, rpcInternalMapDeclarationFile, packageMappings, }) => {
|
|
4
|
+
return await logCommandInfoAndTime(logger, 'Generating RPC wrappers', 'Generated RPC wrappers', [
|
|
5
|
+
rpcWiringsFile === undefined || rpcWiringsFile === null,
|
|
6
6
|
"rpcWiringsFile isn't set in the pikku config",
|
|
7
7
|
], async () => {
|
|
8
8
|
if (!rpcWiringsFile) {
|
|
@@ -1,8 +1,14 @@
|
|
|
1
1
|
import { logCommandInfoAndTime, writeFileInDir } from '../../utils.js';
|
|
2
2
|
import { serializeTypedRPCMap } from './serialize-typed-rpc-map.js';
|
|
3
|
-
export const
|
|
4
|
-
return await logCommandInfoAndTime(logger, 'Creating RPC map', 'Created RPC map', [false], async () => {
|
|
5
|
-
const content = serializeTypedRPCMap(
|
|
3
|
+
export const pikkuRPCInternalMap = async (logger, { rpcInternalMapDeclarationFile, packageMappings }, { functions, rpc }) => {
|
|
4
|
+
return await logCommandInfoAndTime(logger, 'Creating RPC internal map', 'Created RPC internal map', [false], async () => {
|
|
5
|
+
const content = serializeTypedRPCMap(rpcInternalMapDeclarationFile, packageMappings, functions.typesMap, functions.meta, rpc.internalMeta);
|
|
6
|
+
await writeFileInDir(logger, rpcInternalMapDeclarationFile, content);
|
|
7
|
+
});
|
|
8
|
+
};
|
|
9
|
+
export const pikkuRPCExposedMap = async (logger, { rpcMapDeclarationFile, packageMappings }, { functions, rpc }) => {
|
|
10
|
+
return await logCommandInfoAndTime(logger, 'Creating RPC external map', 'Created RPC external map', [false], async () => {
|
|
11
|
+
const content = serializeTypedRPCMap(rpcMapDeclarationFile, packageMappings, functions.typesMap, functions.meta, rpc.exposedMeta);
|
|
6
12
|
await writeFileInDir(logger, rpcMapDeclarationFile, content);
|
|
7
13
|
});
|
|
8
14
|
};
|
|
@@ -1,6 +1,11 @@
|
|
|
1
1
|
import { logCommandInfoAndTime, writeFileInDir } from '../../utils.js';
|
|
2
|
-
export const pikkuRPC = async (logger, { rpcWiringMetaFile }, { rpc }) => {
|
|
2
|
+
export const pikkuRPC = async (logger, { rpcInternalWiringMetaFile, rpcWiringMetaFile }, { rpc }) => {
|
|
3
3
|
return await logCommandInfoAndTime(logger, 'Finding RPCs tasks', 'Found RPCs', [false], async () => {
|
|
4
|
-
|
|
4
|
+
if (rpc.internalFiles.size > 0) {
|
|
5
|
+
await writeFileInDir(logger, rpcInternalWiringMetaFile, `import { pikkuState } from '@pikku/core'\npikkuState('rpc', 'meta', ${JSON.stringify(rpc.internalMeta, null, 2)})`);
|
|
6
|
+
}
|
|
7
|
+
if (rpc.exposedFiles.size > 0) {
|
|
8
|
+
await writeFileInDir(logger, rpcWiringMetaFile, `import { pikkuState } from '@pikku/core'\npikkuState('rpc', 'meta', ${JSON.stringify(rpc.exposedFiles, null, 2)})`);
|
|
9
|
+
}
|
|
5
10
|
});
|
|
6
11
|
};
|
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
import type { RPCMeta } from '@pikku/core/rpc';
|
|
2
1
|
import { TypesMap } from '@pikku/inspector';
|
|
3
2
|
import { FunctionsMeta } from '@pikku/core';
|
|
4
|
-
export declare const serializeTypedRPCMap: (relativeToPath: string, packageMappings: Record<string, string>, typesMap: TypesMap, functionsMeta: FunctionsMeta, rpcMeta: Record<string,
|
|
3
|
+
export declare const serializeTypedRPCMap: (relativeToPath: string, packageMappings: Record<string, string>, typesMap: TypesMap, functionsMeta: FunctionsMeta, rpcMeta: Record<string, string>) => string;
|
|
@@ -31,6 +31,7 @@ export type TypedPikkuRPC = {
|
|
|
31
31
|
depth: number;
|
|
32
32
|
global: boolean;
|
|
33
33
|
invoke: RPCInvoke;
|
|
34
|
+
invokeExposed: (name: string, data: any) => Promise<any>
|
|
34
35
|
}
|
|
35
36
|
`;
|
|
36
37
|
};
|
|
@@ -38,7 +39,7 @@ function generateRPCs(rpcMeta, functionsMeta, typesMap, requiredTypes) {
|
|
|
38
39
|
// Initialize an object to collect RPCs
|
|
39
40
|
const rpcsObj = {};
|
|
40
41
|
// Iterate through RPC metadata
|
|
41
|
-
for (const [funcName,
|
|
42
|
+
for (const [funcName, pikkuFuncName] of Object.entries(rpcMeta)) {
|
|
42
43
|
const functionMeta = functionsMeta[pikkuFuncName];
|
|
43
44
|
if (!functionMeta) {
|
|
44
45
|
throw new Error(`Function ${funcName} not found in functionsMeta. Please check your configuration.`);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"root":["../bin/pikku-all.ts","../bin/pikku-fetch.ts","../bin/pikku-nextjs.ts","../bin/pikku-openapi.ts","../bin/pikku-queue-service.ts","../bin/pikku-schemas.ts","../bin/pikku-websocket.ts","../bin/pikku.ts","../src/inspector-glob.ts","../src/pikku-cli-config.ts","../src/pikku-command-schemas.ts","../src/schema-generator.ts","../src/schemas.ts","../src/serialize-import-map.ts","../src/serialize-pikku-types.ts","../src/types.ts","../src/utils.ts","../src/runtimes/nextjs/pikku-command-nextjs.ts","../src/runtimes/nextjs/serialize-nextjs-backend-wrapper.ts","../src/runtimes/nextjs/serialize-nextjs-http-wrapper.ts","../src/wirings/channels/pikku-channels.ts","../src/wirings/channels/pikku-command-channels-map.ts","../src/wirings/channels/pikku-command-channels.ts","../src/wirings/channels/pikku-command-websocket-typed.ts","../src/wirings/channels/serialize-typed-channel-map.ts","../src/wirings/channels/serialize-websocket-wrapper.ts","../src/wirings/fetch/index.ts","../src/wirings/functions/pikku-command-function-types.ts","../src/wirings/functions/pikku-command-functions.ts","../src/wirings/functions/pikku-command-services.ts","../src/wirings/functions/pikku-function-types.ts","../src/wirings/functions/
|
|
1
|
+
{"root":["../bin/pikku-all.ts","../bin/pikku-fetch.ts","../bin/pikku-nextjs.ts","../bin/pikku-openapi.ts","../bin/pikku-queue-service.ts","../bin/pikku-schemas.ts","../bin/pikku-websocket.ts","../bin/pikku.ts","../src/inspector-glob.ts","../src/pikku-cli-config.ts","../src/pikku-command-schemas.ts","../src/schema-generator.ts","../src/schemas.ts","../src/serialize-import-map.ts","../src/serialize-pikku-types.ts","../src/types.ts","../src/utils.ts","../src/runtimes/nextjs/pikku-command-nextjs.ts","../src/runtimes/nextjs/serialize-nextjs-backend-wrapper.ts","../src/runtimes/nextjs/serialize-nextjs-http-wrapper.ts","../src/wirings/channels/pikku-channels.ts","../src/wirings/channels/pikku-command-channels-map.ts","../src/wirings/channels/pikku-command-channels.ts","../src/wirings/channels/pikku-command-websocket-typed.ts","../src/wirings/channels/serialize-typed-channel-map.ts","../src/wirings/channels/serialize-websocket-wrapper.ts","../src/wirings/fetch/index.ts","../src/wirings/functions/pikku-command-function-types.ts","../src/wirings/functions/pikku-command-functions.ts","../src/wirings/functions/pikku-command-services.ts","../src/wirings/functions/pikku-function-types.ts","../src/wirings/functions/serialize-function-imports.ts","../src/wirings/http/openapi-spec-generator.ts","../src/wirings/http/pikku-command-http-map.ts","../src/wirings/http/pikku-command-http-routes.ts","../src/wirings/http/pikku-command-openapi.ts","../src/wirings/http/pikku-http-routes.ts","../src/wirings/http/serialize-fetch-wrapper.ts","../src/wirings/http/serialize-typed-http-map.ts","../src/wirings/mcp/pikku-command-mcp-json.ts","../src/wirings/mcp/pikku-command-mcp.ts","../src/wirings/mcp/serialize-mcp-json.ts","../src/wirings/queue/pikku-command-queue-map.ts","../src/wirings/queue/pikku-command-queue-service.ts","../src/wirings/queue/pikku-command-queue.ts","../src/wirings/queue/pikku-queue-map.ts","../src/wirings/queue/pikku-queue.ts","../src/wirings/queue/serialize-queue-map.ts","../src/wirings/queue/serialize-queue-meta.ts","../src/wirings/queue/serialize-queue-wrapper.ts","../src/wirings/rpc/pikku-command-rpc-client.ts","../src/wirings/rpc/pikku-command-rpc-map.ts","../src/wirings/rpc/pikku-command-rpc.ts","../src/wirings/rpc/serialize-rpc-wrapper.ts","../src/wirings/rpc/serialize-typed-rpc-map.ts","../src/wirings/scheduler/pikku-command-scheduler.ts","../src/wirings/scheduler/serialize-scheduler-meta.ts"],"version":"5.9.2"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@pikku/cli",
|
|
3
|
-
"version": "0.9.
|
|
3
|
+
"version": "0.9.3",
|
|
4
4
|
"author": "yasser.fadl@gmail.com",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"bin": {
|
|
@@ -21,22 +21,22 @@
|
|
|
21
21
|
"test:coverage": "bash run-tests.sh --coverage"
|
|
22
22
|
},
|
|
23
23
|
"dependencies": {
|
|
24
|
-
"@openapi-contrib/json-schema-to-openapi-schema": "^
|
|
25
|
-
"@pikku/core": "^0.9.
|
|
26
|
-
"@pikku/inspector": "^0.9.
|
|
27
|
-
"@types/cookie": "^0.
|
|
24
|
+
"@openapi-contrib/json-schema-to-openapi-schema": "^4.0.2",
|
|
25
|
+
"@pikku/core": "^0.9.3",
|
|
26
|
+
"@pikku/inspector": "^0.9.3",
|
|
27
|
+
"@types/cookie": "^1.0.0",
|
|
28
28
|
"@types/uuid": "^10.0.0",
|
|
29
|
-
"chalk": "^5.
|
|
29
|
+
"chalk": "^5.5.0",
|
|
30
30
|
"chokidar": "^4.0.3",
|
|
31
|
-
"commander": "^
|
|
31
|
+
"commander": "^14",
|
|
32
32
|
"path-to-regexp": "^8.2.0",
|
|
33
33
|
"tinyglobby": "^0.2.12",
|
|
34
|
-
"ts-json-schema-generator": "^2.
|
|
35
|
-
"typescript": "^5.
|
|
36
|
-
"yaml": "^2.
|
|
34
|
+
"ts-json-schema-generator": "^2.4.0",
|
|
35
|
+
"typescript": "^5.9",
|
|
36
|
+
"yaml": "^2.8.1"
|
|
37
37
|
},
|
|
38
38
|
"devDependencies": {
|
|
39
|
-
"@types/node": "^
|
|
39
|
+
"@types/node": "^24.2.1"
|
|
40
40
|
},
|
|
41
41
|
"engines": {
|
|
42
42
|
"node": ">=18"
|
package/src/pikku-cli-config.ts
CHANGED
|
@@ -15,6 +15,7 @@ export interface PikkuCLICoreOutputFiles {
|
|
|
15
15
|
// Function definitions
|
|
16
16
|
functionsFile: string
|
|
17
17
|
functionsMetaFile: string
|
|
18
|
+
functionsMetaMinFile: string
|
|
18
19
|
|
|
19
20
|
// HTTP
|
|
20
21
|
httpWiringsFile: string
|
|
@@ -26,7 +27,11 @@ export interface PikkuCLICoreOutputFiles {
|
|
|
26
27
|
channelsWiringMetaFile: string
|
|
27
28
|
channelsMapDeclarationFile: string
|
|
28
29
|
|
|
29
|
-
// RPC
|
|
30
|
+
// RPC Internal
|
|
31
|
+
rpcInternalWiringMetaFile: string
|
|
32
|
+
rpcInternalMapDeclarationFile: string
|
|
33
|
+
|
|
34
|
+
// RPC Exposed
|
|
30
35
|
rpcWiringMetaFile: string
|
|
31
36
|
rpcMapDeclarationFile: string
|
|
32
37
|
|
|
@@ -166,7 +171,8 @@ const _getPikkuCLIConfig = async (
|
|
|
166
171
|
const functionDir = join(result.outDir, 'function')
|
|
167
172
|
const httpDir = join(result.outDir, 'http')
|
|
168
173
|
const channelDir = join(result.outDir, 'channel')
|
|
169
|
-
const
|
|
174
|
+
const internalRPCDirectory = join(result.outDir, 'rpc-internal')
|
|
175
|
+
const externalRPCDirectory = join(result.outDir, 'rpc')
|
|
170
176
|
const schedulerDir = join(result.outDir, 'scheduler')
|
|
171
177
|
const queueDir = join(result.outDir, 'queue')
|
|
172
178
|
const mcpDir = join(result.outDir, 'mcp')
|
|
@@ -187,6 +193,12 @@ const _getPikkuCLIConfig = async (
|
|
|
187
193
|
'pikku-functions-meta.gen.ts'
|
|
188
194
|
)
|
|
189
195
|
}
|
|
196
|
+
if (!result.functionsMetaMinFile) {
|
|
197
|
+
result.functionsMetaMinFile = join(
|
|
198
|
+
functionDir,
|
|
199
|
+
'pikku-functions-meta.min.gen.ts'
|
|
200
|
+
)
|
|
201
|
+
}
|
|
190
202
|
if (!result.typesDeclarationFile) {
|
|
191
203
|
result.typesDeclarationFile = join(result.outDir, 'pikku-types.gen.ts')
|
|
192
204
|
}
|
|
@@ -225,13 +237,31 @@ const _getPikkuCLIConfig = async (
|
|
|
225
237
|
)
|
|
226
238
|
}
|
|
227
239
|
|
|
228
|
-
//
|
|
240
|
+
// Internal
|
|
241
|
+
if (!result.rpcInternalWiringMetaFile) {
|
|
242
|
+
result.rpcInternalWiringMetaFile = join(
|
|
243
|
+
internalRPCDirectory,
|
|
244
|
+
'pikku-rpc-wirings-meta.internal.gen.ts'
|
|
245
|
+
)
|
|
246
|
+
}
|
|
247
|
+
|
|
248
|
+
if (!result.rpcInternalMapDeclarationFile) {
|
|
249
|
+
result.rpcInternalMapDeclarationFile = join(
|
|
250
|
+
internalRPCDirectory,
|
|
251
|
+
'pikku-rpc-wirings-map.internal.gen.d.ts'
|
|
252
|
+
)
|
|
253
|
+
}
|
|
254
|
+
|
|
255
|
+
// External
|
|
229
256
|
if (!result.rpcWiringMetaFile) {
|
|
230
|
-
result.rpcWiringMetaFile = join(
|
|
257
|
+
result.rpcWiringMetaFile = join(
|
|
258
|
+
externalRPCDirectory,
|
|
259
|
+
'pikku-rpc-wirings-meta.gen.ts'
|
|
260
|
+
)
|
|
231
261
|
}
|
|
232
262
|
if (!result.rpcMapDeclarationFile) {
|
|
233
263
|
result.rpcMapDeclarationFile = join(
|
|
234
|
-
|
|
264
|
+
externalRPCDirectory,
|
|
235
265
|
'pikku-rpc-wirings-map.gen.d.ts'
|
|
236
266
|
)
|
|
237
267
|
}
|
|
@@ -9,8 +9,73 @@ export const serializeImportMap = (
|
|
|
9
9
|
) => {
|
|
10
10
|
const paths = new Map<string, string[]>()
|
|
11
11
|
Array.from(requiredTypes).forEach((requiredType) => {
|
|
12
|
-
|
|
13
|
-
|
|
12
|
+
let originalName, uniqueName, path
|
|
13
|
+
|
|
14
|
+
try {
|
|
15
|
+
const typeMeta = typesMap.getTypeMeta(requiredType)
|
|
16
|
+
originalName = typeMeta.originalName
|
|
17
|
+
uniqueName = typeMeta.uniqueName
|
|
18
|
+
path = typeMeta.path
|
|
19
|
+
} catch (e) {
|
|
20
|
+
// Handle missing types by trying to find a suitable import path
|
|
21
|
+
// Look through all existing types in the map to find a path that might contain this type
|
|
22
|
+
let foundPath: string | null = null
|
|
23
|
+
|
|
24
|
+
// Get all unique paths from the typesMap
|
|
25
|
+
const allPaths = new Set<string>()
|
|
26
|
+
typesMap.customTypes.forEach(({ type, references }) => {
|
|
27
|
+
references.forEach((ref) => {
|
|
28
|
+
try {
|
|
29
|
+
const refMeta = typesMap.getTypeMeta(ref)
|
|
30
|
+
if (refMeta.path) {
|
|
31
|
+
allPaths.add(refMeta.path)
|
|
32
|
+
}
|
|
33
|
+
} catch {
|
|
34
|
+
// Continue
|
|
35
|
+
}
|
|
36
|
+
})
|
|
37
|
+
})
|
|
38
|
+
|
|
39
|
+
// Also check direct types in the map
|
|
40
|
+
try {
|
|
41
|
+
const mapEntries = (typesMap as any).map?.entries?.() || []
|
|
42
|
+
for (const [_, typeMeta] of mapEntries) {
|
|
43
|
+
if (typeMeta.path) {
|
|
44
|
+
allPaths.add(typeMeta.path)
|
|
45
|
+
}
|
|
46
|
+
}
|
|
47
|
+
} catch {
|
|
48
|
+
// Continue
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
// For PascalCase types, prefer paths that look like type definition files
|
|
52
|
+
if (/^[A-Z]/.test(requiredType)) {
|
|
53
|
+
for (const candidatePath of allPaths) {
|
|
54
|
+
if (
|
|
55
|
+
candidatePath.includes('types') ||
|
|
56
|
+
candidatePath.includes('.d.')
|
|
57
|
+
) {
|
|
58
|
+
foundPath = candidatePath
|
|
59
|
+
break
|
|
60
|
+
}
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
// If no types file found, use the first available path
|
|
64
|
+
if (!foundPath && allPaths.size > 0) {
|
|
65
|
+
foundPath = Array.from(allPaths)[0] || null
|
|
66
|
+
}
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
if (foundPath) {
|
|
70
|
+
originalName = requiredType
|
|
71
|
+
uniqueName = requiredType
|
|
72
|
+
path = foundPath
|
|
73
|
+
} else {
|
|
74
|
+
// No suitable path found, skip
|
|
75
|
+
return
|
|
76
|
+
}
|
|
77
|
+
}
|
|
78
|
+
|
|
14
79
|
if (!path) {
|
|
15
80
|
// This is a custom type that exists in file, so we don't need to import it
|
|
16
81
|
return
|
|
@@ -13,7 +13,7 @@ export const serializePikkuTypes = (
|
|
|
13
13
|
* This is used to provide the application types in the typescript project
|
|
14
14
|
*/
|
|
15
15
|
|
|
16
|
-
import { CorePikkuPermission,
|
|
16
|
+
import { CorePikkuFunctionConfig, CorePikkuPermission, CorePikkuMiddleware, addHTTPMiddleware } from '@pikku/core'
|
|
17
17
|
import { CorePikkuFunction, CorePikkuFunctionSessionless } from '@pikku/core/function'
|
|
18
18
|
import { CoreHTTPFunctionWiring, AssertHTTPWiringParams, wireHTTP as wireHTTPCore } from '@pikku/core/http'
|
|
19
19
|
import { CoreScheduledTask, wireScheduler as wireSchedulerCore } from '@pikku/core/scheduler'
|
|
@@ -41,7 +41,7 @@ export type PikkuPermission<In = unknown, RequiredServices extends ${singletonSe
|
|
|
41
41
|
*
|
|
42
42
|
* @template RequiredServices - The services required for this middleware
|
|
43
43
|
*/
|
|
44
|
-
export type
|
|
44
|
+
export type PikkuMiddleware<RequiredServices extends ${singletonServicesTypeName} = ${singletonServicesTypeName}> = CorePikkuMiddleware<RequiredServices, ${userSessionTypeName}>
|
|
45
45
|
|
|
46
46
|
/**
|
|
47
47
|
* A sessionless API function that doesn't require user authentication.
|
|
@@ -58,7 +58,7 @@ type PikkuFunctionSessionless<
|
|
|
58
58
|
Out = never,
|
|
59
59
|
ChannelData = null, // null means optional channel
|
|
60
60
|
MCPData = null, // null means optional MCP
|
|
61
|
-
RequiredServices extends Services = Services &
|
|
61
|
+
RequiredServices extends Services = Omit<Services, 'rpc'> &
|
|
62
62
|
{ rpc: TypedPikkuRPC } & (
|
|
63
63
|
[ChannelData] extends [null]
|
|
64
64
|
? { channel?: PikkuChannel<unknown, Out> } // Optional channel
|
|
@@ -84,7 +84,7 @@ type PikkuFunction<
|
|
|
84
84
|
Out = never,
|
|
85
85
|
ChannelData = null, // null means optional channel
|
|
86
86
|
MCPData = null, // null means optional MCP
|
|
87
|
-
RequiredServices extends Services = Services &
|
|
87
|
+
RequiredServices extends Services = Omit<Services, 'rpc'> &
|
|
88
88
|
{ rpc: TypedPikkuRPC } & (
|
|
89
89
|
[ChannelData] extends [null]
|
|
90
90
|
? { channel?: PikkuChannel<unknown, Out> } // Optional channel
|
|
@@ -103,7 +103,7 @@ type PikkuFunction<
|
|
|
103
103
|
* @template Out - Output type for the HTTP wiring
|
|
104
104
|
* @template Route - String literal type for the HTTP path (e.g., "/users/:id")
|
|
105
105
|
*/
|
|
106
|
-
type HTTPWiring<In, Out, Route extends string> = CoreHTTPFunctionWiring<In, Out, Route, PikkuFunction<In, Out>, PikkuFunctionSessionless<In, Out>, PikkuPermission<In>,
|
|
106
|
+
type HTTPWiring<In, Out, Route extends string> = CoreHTTPFunctionWiring<In, Out, Route, PikkuFunction<In, Out>, PikkuFunctionSessionless<In, Out>, PikkuPermission<In>, PikkuMiddleware>
|
|
107
107
|
|
|
108
108
|
/**
|
|
109
109
|
* Type definition for WebSocket channels with typed data exchange.
|
|
@@ -173,16 +173,7 @@ type MCPPromptWiring<In> = CoreMCPPrompt<PikkuFunctionSessionless<In, MCPPromptR
|
|
|
173
173
|
export const pikkuFunc = <In, Out = unknown>(
|
|
174
174
|
func:
|
|
175
175
|
| PikkuFunction<In, Out>
|
|
176
|
-
|
|
|
177
|
-
func: PikkuFunction<In, Out>
|
|
178
|
-
auth?: true
|
|
179
|
-
name?: string
|
|
180
|
-
}
|
|
181
|
-
| {
|
|
182
|
-
func: PikkuFunctionSessionless<In, Out>
|
|
183
|
-
auth: false
|
|
184
|
-
name?: string
|
|
185
|
-
}
|
|
176
|
+
| CorePikkuFunctionConfig<PikkuFunction<In, Out>, PikkuPermission<In>>
|
|
186
177
|
) => {
|
|
187
178
|
return typeof func === 'function' ? func : func.func
|
|
188
179
|
}
|
|
@@ -210,10 +201,7 @@ export const pikkuFunc = <In, Out = unknown>(
|
|
|
210
201
|
export const pikkuSessionlessFunc = <In, Out = unknown>(
|
|
211
202
|
func:
|
|
212
203
|
| PikkuFunctionSessionless<In, Out>
|
|
213
|
-
|
|
|
214
|
-
func: PikkuFunctionSessionless<In, Out>
|
|
215
|
-
name?: string
|
|
216
|
-
}
|
|
204
|
+
| CorePikkuFunctionConfig<PikkuFunctionSessionless<In, Out>, PikkuPermission<In>>
|
|
217
205
|
) => {
|
|
218
206
|
return typeof func === 'function' ? func : func.func
|
|
219
207
|
}
|
|
@@ -300,10 +288,7 @@ export const pikkuChannelDisconnectionFunc = <ChannelData = unknown>(
|
|
|
300
288
|
export const pikkuChannelFunc = <In = unknown, Out = unknown, ChannelData = unknown>(
|
|
301
289
|
func:
|
|
302
290
|
| PikkuFunctionSessionless<In, Out, ChannelData>
|
|
303
|
-
|
|
|
304
|
-
func: PikkuFunctionSessionless<In, Out, ChannelData>
|
|
305
|
-
name?: string
|
|
306
|
-
}
|
|
291
|
+
| CorePikkuFunctionConfig<PikkuFunction<In, Out, ChannelData>, PikkuPermission<In>>
|
|
307
292
|
) => {
|
|
308
293
|
return typeof func === 'function' ? func : func.func
|
|
309
294
|
}
|
|
@@ -327,10 +312,7 @@ export const pikkuChannelFunc = <In = unknown, Out = unknown, ChannelData = unkn
|
|
|
327
312
|
export const pikkuVoidFunc = (
|
|
328
313
|
func:
|
|
329
314
|
| PikkuFunctionSessionless<void, void>
|
|
330
|
-
|
|
|
331
|
-
func: PikkuFunctionSessionless<void, void>
|
|
332
|
-
name?: string
|
|
333
|
-
}
|
|
315
|
+
| CorePikkuFunctionConfig<PikkuFunction<void, void>, PikkuPermission<void>>
|
|
334
316
|
) => {
|
|
335
317
|
return typeof func === 'function' ? func : func.func
|
|
336
318
|
}
|
|
@@ -348,6 +330,27 @@ export const wireChannel = <ChannelData, Channel extends string>(
|
|
|
348
330
|
wireChannelCore(channel as any) // TODO
|
|
349
331
|
}
|
|
350
332
|
|
|
333
|
+
/**
|
|
334
|
+
* Registers middleware either globally or for a specific route.
|
|
335
|
+
*
|
|
336
|
+
* When a string route pattern is provided along with middleware, the middleware
|
|
337
|
+
* is applied only to that route. Otherwise, if an array is provided, it is treated
|
|
338
|
+
* as global middleware (applied to all routes).
|
|
339
|
+
*
|
|
340
|
+
* @param routeOrMiddleware - Either a global middleware array or a route pattern string
|
|
341
|
+
* @param middleware - The middleware array to apply when a route pattern is specified
|
|
342
|
+
*
|
|
343
|
+
* @example
|
|
344
|
+
* \`\`\`typescript
|
|
345
|
+
* // Add global middleware
|
|
346
|
+
* addHTTPMiddleware([authMiddleware, loggingMiddleware])
|
|
347
|
+
*
|
|
348
|
+
* // Add route-specific middleware
|
|
349
|
+
* addHTTPMiddleware('/api/admin/*', [adminAuthMiddleware])
|
|
350
|
+
* \`\`\`
|
|
351
|
+
*/
|
|
352
|
+
export { addHTTPMiddleware }
|
|
353
|
+
|
|
351
354
|
/**
|
|
352
355
|
* Registers an HTTP wiring with the Pikku framework.
|
|
353
356
|
*
|
package/src/utils.ts
CHANGED
|
@@ -371,9 +371,38 @@ export function generateCustomTypes(
|
|
|
371
371
|
${Array.from(typesMap.customTypes.entries())
|
|
372
372
|
.map(([name, { type, references }]) => {
|
|
373
373
|
references.forEach((name) => {
|
|
374
|
-
|
|
375
|
-
requiredTypes.add(originalName)
|
|
374
|
+
requiredTypes.add(name)
|
|
376
375
|
})
|
|
376
|
+
|
|
377
|
+
// Extract type names from the type string that might not be in references
|
|
378
|
+
const typeString = type
|
|
379
|
+
// Use regex to extract potential type names (PascalCase identifiers)
|
|
380
|
+
const typeNameRegex = /\b[A-Z][a-zA-Z0-9]*\b/g
|
|
381
|
+
const potentialTypes = typeString.match(typeNameRegex) || []
|
|
382
|
+
|
|
383
|
+
potentialTypes.forEach((typeName) => {
|
|
384
|
+
// Skip string literals and common keywords
|
|
385
|
+
if (
|
|
386
|
+
typeString.includes(`"${typeName}"`) ||
|
|
387
|
+
['Pick', 'Omit', 'Partial', 'Required', 'Record', 'Readonly'].includes(
|
|
388
|
+
typeName
|
|
389
|
+
)
|
|
390
|
+
) {
|
|
391
|
+
return
|
|
392
|
+
}
|
|
393
|
+
|
|
394
|
+
// Try to find this type in the typesMap and add it if found
|
|
395
|
+
try {
|
|
396
|
+
const typeMeta = typesMap.getTypeMeta(typeName)
|
|
397
|
+
if (typeMeta.path) {
|
|
398
|
+
requiredTypes.add(typeName)
|
|
399
|
+
}
|
|
400
|
+
} catch (e) {
|
|
401
|
+
// Type not found in map, but add it anyway for fallback resolution
|
|
402
|
+
requiredTypes.add(typeName)
|
|
403
|
+
}
|
|
404
|
+
})
|
|
405
|
+
|
|
377
406
|
return `export type ${name} = ${type}`
|
|
378
407
|
})
|
|
379
408
|
.join('\n')}`
|
|
@@ -9,7 +9,11 @@ import { PikkuCommand } from '../../types.js'
|
|
|
9
9
|
|
|
10
10
|
export const pikkuFunctionTypes: PikkuCommand = async (
|
|
11
11
|
logger,
|
|
12
|
-
{
|
|
12
|
+
{
|
|
13
|
+
typesDeclarationFile: typesFile,
|
|
14
|
+
packageMappings,
|
|
15
|
+
rpcInternalMapDeclarationFile,
|
|
16
|
+
},
|
|
13
17
|
visitState,
|
|
14
18
|
options = {}
|
|
15
19
|
) => {
|
|
@@ -39,7 +43,7 @@ export const pikkuFunctionTypes: PikkuCommand = async (
|
|
|
39
43
|
`import type { ${singletonServicesType.type} } from '${getFileImportRelativePath(typesFile, singletonServicesType.typePath, packageMappings)}'`,
|
|
40
44
|
singletonServicesType.type,
|
|
41
45
|
`import type { ${sessionServicesType.type} } from '${getFileImportRelativePath(typesFile, sessionServicesType.typePath, packageMappings)}'`,
|
|
42
|
-
`import type { TypedPikkuRPC } from '${getFileImportRelativePath(typesFile,
|
|
46
|
+
`import type { TypedPikkuRPC } from '${getFileImportRelativePath(typesFile, rpcInternalMapDeclarationFile, packageMappings)}'`
|
|
43
47
|
)
|
|
44
48
|
|
|
45
49
|
await writeFileInDir(logger, typesFile, content)
|
|
@@ -1,63 +1,14 @@
|
|
|
1
|
-
import {
|
|
2
|
-
getFileImportRelativePath,
|
|
3
|
-
logCommandInfoAndTime,
|
|
4
|
-
writeFileInDir,
|
|
5
|
-
} from '../../utils.js'
|
|
1
|
+
import { logCommandInfoAndTime, writeFileInDir } from '../../utils.js'
|
|
6
2
|
import { PikkuCommand } from '../../types.js'
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
packageMappings: Record<string, string> = {}
|
|
12
|
-
) => {
|
|
13
|
-
const serializedImports: string[] = [
|
|
14
|
-
`/* Import and register RPCs */`,
|
|
15
|
-
`import { addFunction } from '@pikku/core'`,
|
|
16
|
-
]
|
|
17
|
-
|
|
18
|
-
const serializedRegistrations: string[] = []
|
|
19
|
-
|
|
20
|
-
// Sort by function name for consistent output
|
|
21
|
-
const sortedEntries = Array.from(functionsMap.entries()).sort((a, b) =>
|
|
22
|
-
a[0].localeCompare(b[0])
|
|
23
|
-
)
|
|
24
|
-
|
|
25
|
-
for (const [name, { path, exportedName }] of sortedEntries) {
|
|
26
|
-
const filePath = getFileImportRelativePath(
|
|
27
|
-
outputPath,
|
|
28
|
-
path,
|
|
29
|
-
packageMappings
|
|
30
|
-
)
|
|
31
|
-
|
|
32
|
-
// For directly exported functions, we can just import and register them
|
|
33
|
-
if (name === exportedName) {
|
|
34
|
-
serializedImports.push(`import { ${exportedName} } from '${filePath}'`)
|
|
35
|
-
serializedRegistrations.push(
|
|
36
|
-
`addFunction('${name}', { func: ${exportedName} })`
|
|
37
|
-
)
|
|
38
|
-
}
|
|
39
|
-
// For renamed functions, we need to import and alias them
|
|
40
|
-
else {
|
|
41
|
-
serializedImports.push(
|
|
42
|
-
`import { ${exportedName} as ${name} } from '${filePath}'`
|
|
43
|
-
)
|
|
44
|
-
serializedRegistrations.push(`addFunction('${name}', ${name})`)
|
|
45
|
-
}
|
|
46
|
-
}
|
|
47
|
-
|
|
48
|
-
// Add a blank line between imports and registrations
|
|
49
|
-
if (serializedImports.length > 0 && serializedRegistrations.length > 0) {
|
|
50
|
-
serializedImports.push('')
|
|
51
|
-
}
|
|
52
|
-
|
|
53
|
-
// Combine the imports and registrations
|
|
54
|
-
return [...serializedImports, ...serializedRegistrations].join('\n')
|
|
55
|
-
}
|
|
3
|
+
import {
|
|
4
|
+
generateRuntimeMeta,
|
|
5
|
+
serializeFunctionImports,
|
|
6
|
+
} from './serialize-function-imports.js'
|
|
56
7
|
|
|
57
8
|
export const pikkuFunctions: PikkuCommand = async (
|
|
58
9
|
logger,
|
|
59
|
-
{ functionsMetaFile, functionsFile, packageMappings },
|
|
60
|
-
{ functions }
|
|
10
|
+
{ functionsMetaFile, functionsMetaMinFile, functionsFile, packageMappings },
|
|
11
|
+
{ functions, rpc }
|
|
61
12
|
) => {
|
|
62
13
|
return await logCommandInfoAndTime(
|
|
63
14
|
logger,
|
|
@@ -65,20 +16,33 @@ export const pikkuFunctions: PikkuCommand = async (
|
|
|
65
16
|
'Serialized Pikku functions',
|
|
66
17
|
[false],
|
|
67
18
|
async () => {
|
|
19
|
+
// Generate full metadata
|
|
68
20
|
await writeFileInDir(
|
|
69
21
|
logger,
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
functionsFile,
|
|
73
|
-
functions.files,
|
|
74
|
-
packageMappings
|
|
75
|
-
)
|
|
22
|
+
functionsMetaFile,
|
|
23
|
+
`import { pikkuState } from '@pikku/core'\npikkuState('function', 'meta', ${JSON.stringify(functions.meta, null, 2)})`
|
|
76
24
|
)
|
|
25
|
+
|
|
26
|
+
// Generate minimal metadata (runtime)
|
|
27
|
+
const runtimeMeta = generateRuntimeMeta(functions.meta)
|
|
77
28
|
await writeFileInDir(
|
|
78
29
|
logger,
|
|
79
|
-
|
|
80
|
-
`import { pikkuState } from '@pikku/core'\npikkuState('function', 'meta', ${JSON.stringify(
|
|
30
|
+
functionsMetaMinFile,
|
|
31
|
+
`import { pikkuState } from '@pikku/core'\npikkuState('function', 'meta', ${JSON.stringify(runtimeMeta, null, 2)})`
|
|
81
32
|
)
|
|
33
|
+
|
|
34
|
+
if (rpc.exposedFiles.size > 0 || rpc.internalFiles.size > 0) {
|
|
35
|
+
await writeFileInDir(
|
|
36
|
+
logger,
|
|
37
|
+
functionsFile,
|
|
38
|
+
serializeFunctionImports(
|
|
39
|
+
functionsFile,
|
|
40
|
+
rpc.internalFiles,
|
|
41
|
+
functions.meta,
|
|
42
|
+
packageMappings
|
|
43
|
+
)
|
|
44
|
+
)
|
|
45
|
+
}
|
|
82
46
|
}
|
|
83
47
|
)
|
|
84
48
|
}
|
|
@@ -95,7 +95,7 @@ export const pikkuServices: PikkuCommand = async (
|
|
|
95
95
|
logger,
|
|
96
96
|
'Generating Pikku services map',
|
|
97
97
|
'Generated Pikku services map',
|
|
98
|
-
[
|
|
98
|
+
[false],
|
|
99
99
|
async () => {
|
|
100
100
|
const { sessionServicesType, singletonServicesType } =
|
|
101
101
|
await getPikkuFilesAndMethods(
|
|
@@ -9,7 +9,11 @@ import { PikkuCommand } from '../../types.js'
|
|
|
9
9
|
|
|
10
10
|
export const pikkuFunctionTypes: PikkuCommand = async (
|
|
11
11
|
logger,
|
|
12
|
-
{
|
|
12
|
+
{
|
|
13
|
+
typesDeclarationFile: typesFile,
|
|
14
|
+
packageMappings,
|
|
15
|
+
rpcInternalMapDeclarationFile,
|
|
16
|
+
},
|
|
13
17
|
visitState,
|
|
14
18
|
options = {}
|
|
15
19
|
) => {
|
|
@@ -39,7 +43,7 @@ export const pikkuFunctionTypes: PikkuCommand = async (
|
|
|
39
43
|
`import type { ${singletonServicesType.type} } from '${getFileImportRelativePath(typesFile, singletonServicesType.typePath, packageMappings)}'`,
|
|
40
44
|
singletonServicesType.type,
|
|
41
45
|
`import type { ${sessionServicesType.type} } from '${getFileImportRelativePath(typesFile, sessionServicesType.typePath, packageMappings)}'`,
|
|
42
|
-
`import type { TypedPikkuRPC } from '${getFileImportRelativePath(typesFile,
|
|
46
|
+
`import type { TypedPikkuRPC } from '${getFileImportRelativePath(typesFile, rpcInternalMapDeclarationFile, packageMappings)}'`
|
|
43
47
|
)
|
|
44
48
|
await writeFileInDir(logger, typesFile, content)
|
|
45
49
|
}
|