@pikku/addon-graph 0.0.2 → 0.12.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/.pikku/addon/pikku-addon-types.gen.ts +30 -3
- package/.pikku/addon/pikku-package.gen.ts +3 -1
- package/.pikku/agent/pikku-agent-map.gen.d.ts +2 -14
- package/.pikku/agent/pikku-agent-types.gen.ts +13 -7
- package/.pikku/channel/pikku-channel-types.gen.ts +177 -0
- package/.pikku/cli/pikku-cli-types.gen.ts +105 -0
- package/.pikku/console/pikku-addon-meta.gen.json +281 -0
- package/.pikku/console/pikku-node-types.gen.ts +2 -2
- package/.pikku/function/pikku-function-types.gen.ts +70 -34
- package/.pikku/function/pikku-functions-meta-verbose.gen.json +274 -196
- package/.pikku/function/pikku-functions-meta.gen.json +160 -144
- package/.pikku/function/pikku-functions-meta.gen.ts +1 -1
- package/.pikku/function/pikku-functions.gen.ts +4 -2
- package/.pikku/http/pikku-http-types.gen.ts +147 -0
- package/.pikku/mcp/pikku-mcp-types.gen.ts +183 -0
- package/.pikku/pikku-bootstrap.gen.ts +2 -9
- package/.pikku/pikku-meta-service.gen.ts +10 -0
- package/.pikku/pikku-services.gen.ts +10 -3
- package/.pikku/pikku-types.gen.ts +1 -1
- package/.pikku/queue/pikku-queue-types.gen.ts +27 -0
- package/.pikku/rpc/pikku-rpc-wirings-map.gen.d.ts +212 -194
- package/.pikku/rpc/pikku-rpc-wirings-map.internal.gen.d.ts +221 -202
- package/.pikku/rpc/pikku-rpc-wirings-meta.internal.gen.json +27 -0
- package/.pikku/rpc/pikku-rpc-wirings-meta.internal.gen.ts +6 -0
- package/.pikku/scheduler/pikku-scheduler-types.gen.ts +25 -0
- package/.pikku/schemas/register.gen.ts +69 -65
- package/.pikku/schemas/schemas/SleepInput.schema.json +1 -0
- package/.pikku/secrets/pikku-secret-types.gen.ts +1 -1
- package/.pikku/secrets/pikku-secrets.gen.ts +1 -1
- package/.pikku/trigger/pikku-trigger-types.gen.ts +1 -1
- package/.pikku/variables/pikku-variable-types.gen.ts +1 -1
- package/.pikku/variables/pikku-variables.gen.ts +1 -1
- package/.pikku/workflow/pikku-workflow-map.gen.d.ts +9 -5
- package/.pikku/workflow/pikku-workflow-types.gen.ts +66 -57
- package/.pikku/workflow/pikku-workflow-wirings-meta.gen.ts +1 -1
- package/.pikku/workflow/pikku-workflow-wirings.gen.ts +1 -1
- package/dist/.pikku/addon/pikku-addon-types.gen.d.ts +18 -2
- package/dist/.pikku/addon/pikku-addon-types.gen.d.ts.map +1 -1
- package/dist/.pikku/addon/pikku-addon-types.gen.js +25 -2
- package/dist/.pikku/addon/pikku-addon-types.gen.js.map +1 -1
- package/dist/.pikku/addon/pikku-addon-types.gen.ts +30 -3
- package/dist/.pikku/addon/pikku-package.gen.js +2 -1
- package/dist/.pikku/addon/pikku-package.gen.js.map +1 -1
- package/dist/.pikku/addon/pikku-package.gen.ts +3 -1
- package/dist/.pikku/agent/pikku-agent-map.gen.d.ts +2 -14
- package/dist/.pikku/agent/pikku-agent-types.gen.d.ts +6 -6
- package/dist/.pikku/agent/pikku-agent-types.gen.d.ts.map +1 -1
- package/dist/.pikku/agent/pikku-agent-types.gen.js.map +1 -1
- package/dist/.pikku/agent/pikku-agent-types.gen.ts +13 -7
- package/dist/.pikku/channel/pikku-channel-types.gen.d.ts +112 -0
- package/dist/.pikku/channel/pikku-channel-types.gen.d.ts.map +1 -0
- package/dist/.pikku/channel/pikku-channel-types.gen.js +60 -0
- package/dist/.pikku/channel/pikku-channel-types.gen.js.map +1 -0
- package/dist/.pikku/channel/pikku-channel-types.gen.ts +177 -0
- package/dist/.pikku/cli/pikku-cli-types.gen.d.ts +78 -0
- package/dist/.pikku/cli/pikku-cli-types.gen.d.ts.map +1 -0
- package/dist/.pikku/cli/pikku-cli-types.gen.js +61 -0
- package/dist/.pikku/cli/pikku-cli-types.gen.js.map +1 -0
- package/dist/.pikku/cli/pikku-cli-types.gen.ts +105 -0
- package/dist/.pikku/console/pikku-addon-meta.gen.json +281 -0
- package/dist/.pikku/console/pikku-node-types.gen.d.ts +2 -2
- package/dist/.pikku/console/pikku-node-types.gen.d.ts.map +1 -1
- package/dist/.pikku/console/pikku-node-types.gen.ts +2 -2
- package/dist/.pikku/function/pikku-function-types.gen.d.ts +56 -30
- package/dist/.pikku/function/pikku-function-types.gen.d.ts.map +1 -1
- package/dist/.pikku/function/pikku-function-types.gen.js +31 -19
- package/dist/.pikku/function/pikku-function-types.gen.js.map +1 -1
- package/dist/.pikku/function/pikku-function-types.gen.ts +70 -34
- package/dist/.pikku/function/pikku-functions-meta-verbose.gen.json +274 -196
- package/dist/.pikku/function/pikku-functions-meta.gen.js +1 -1
- package/dist/.pikku/function/pikku-functions-meta.gen.json +160 -144
- package/dist/.pikku/function/pikku-functions-meta.gen.ts +1 -1
- package/dist/.pikku/function/pikku-functions.gen.js +4 -2
- package/dist/.pikku/function/pikku-functions.gen.js.map +1 -1
- package/dist/.pikku/function/pikku-functions.gen.ts +4 -2
- package/dist/.pikku/http/pikku-http-types.gen.d.ts +120 -0
- package/dist/.pikku/http/pikku-http-types.gen.d.ts.map +1 -0
- package/dist/.pikku/http/pikku-http-types.gen.js +72 -0
- package/dist/.pikku/http/pikku-http-types.gen.js.map +1 -0
- package/dist/.pikku/http/pikku-http-types.gen.ts +147 -0
- package/dist/.pikku/mcp/pikku-mcp-types.gen.d.ts +131 -0
- package/dist/.pikku/mcp/pikku-mcp-types.gen.d.ts.map +1 -0
- package/dist/.pikku/mcp/pikku-mcp-types.gen.js +38 -0
- package/dist/.pikku/mcp/pikku-mcp-types.gen.js.map +1 -0
- package/dist/.pikku/mcp/pikku-mcp-types.gen.ts +183 -0
- package/dist/.pikku/pikku-bootstrap.gen.d.ts +4 -2
- package/dist/.pikku/pikku-bootstrap.gen.d.ts.map +1 -1
- package/dist/.pikku/pikku-bootstrap.gen.js +2 -10
- package/dist/.pikku/pikku-bootstrap.gen.js.map +1 -1
- package/dist/.pikku/pikku-bootstrap.gen.ts +2 -9
- package/dist/.pikku/pikku-meta-service.gen.d.ts +8 -0
- package/dist/.pikku/pikku-meta-service.gen.d.ts.map +1 -0
- package/dist/.pikku/pikku-meta-service.gen.js +10 -0
- package/dist/.pikku/pikku-meta-service.gen.js.map +1 -0
- package/dist/.pikku/pikku-meta-service.gen.ts +10 -0
- package/dist/.pikku/pikku-services.gen.d.ts +8 -3
- package/dist/.pikku/pikku-services.gen.d.ts.map +1 -1
- package/dist/.pikku/pikku-services.gen.js +7 -1
- package/dist/.pikku/pikku-services.gen.js.map +1 -1
- package/dist/.pikku/pikku-services.gen.ts +10 -3
- package/dist/.pikku/pikku-types.gen.d.ts +1 -1
- package/dist/.pikku/pikku-types.gen.js +1 -1
- package/dist/.pikku/pikku-types.gen.ts +1 -1
- package/dist/.pikku/queue/pikku-queue-types.gen.d.ts +24 -0
- package/dist/.pikku/queue/pikku-queue-types.gen.d.ts.map +1 -0
- package/dist/.pikku/queue/pikku-queue-types.gen.js +17 -0
- package/dist/.pikku/queue/pikku-queue-types.gen.js.map +1 -0
- package/dist/.pikku/queue/pikku-queue-types.gen.ts +27 -0
- package/dist/.pikku/rpc/pikku-rpc-wirings-map.gen.d.ts +212 -194
- package/dist/.pikku/rpc/pikku-rpc-wirings-map.internal.gen.d.ts +221 -202
- package/dist/.pikku/rpc/pikku-rpc-wirings-meta.internal.gen.d.ts +2 -0
- package/dist/.pikku/rpc/pikku-rpc-wirings-meta.internal.gen.d.ts.map +1 -0
- package/dist/.pikku/rpc/pikku-rpc-wirings-meta.internal.gen.js +7 -0
- package/dist/.pikku/rpc/pikku-rpc-wirings-meta.internal.gen.js.map +1 -0
- package/dist/.pikku/rpc/pikku-rpc-wirings-meta.internal.gen.json +27 -0
- package/dist/.pikku/rpc/pikku-rpc-wirings-meta.internal.gen.ts +6 -0
- package/dist/.pikku/scheduler/pikku-scheduler-types.gen.d.ts +22 -0
- package/dist/.pikku/scheduler/pikku-scheduler-types.gen.d.ts.map +1 -0
- package/dist/.pikku/scheduler/pikku-scheduler-types.gen.js +17 -0
- package/dist/.pikku/scheduler/pikku-scheduler-types.gen.js.map +1 -0
- package/dist/.pikku/scheduler/pikku-scheduler-types.gen.ts +25 -0
- package/dist/.pikku/schemas/register.gen.js +35 -33
- package/dist/.pikku/schemas/register.gen.js.map +1 -1
- package/dist/.pikku/schemas/register.gen.ts +69 -65
- package/dist/.pikku/schemas/schemas/SleepInput.schema.json +1 -0
- package/dist/.pikku/secrets/pikku-secret-types.gen.d.ts +1 -1
- package/dist/.pikku/secrets/pikku-secret-types.gen.js +1 -1
- package/dist/.pikku/secrets/pikku-secret-types.gen.ts +1 -1
- package/dist/.pikku/secrets/pikku-secrets.gen.d.ts +1 -1
- package/dist/.pikku/secrets/pikku-secrets.gen.js +1 -1
- package/dist/.pikku/secrets/pikku-secrets.gen.ts +1 -1
- package/dist/.pikku/trigger/pikku-trigger-types.gen.d.ts +1 -1
- package/dist/.pikku/trigger/pikku-trigger-types.gen.js +1 -1
- package/dist/.pikku/trigger/pikku-trigger-types.gen.ts +1 -1
- package/dist/.pikku/variables/pikku-variable-types.gen.d.ts +1 -1
- package/dist/.pikku/variables/pikku-variable-types.gen.js +1 -1
- package/dist/.pikku/variables/pikku-variable-types.gen.ts +1 -1
- package/dist/.pikku/variables/pikku-variables.gen.d.ts +1 -1
- package/dist/.pikku/variables/pikku-variables.gen.js +1 -1
- package/dist/.pikku/variables/pikku-variables.gen.ts +1 -1
- package/dist/.pikku/workflow/pikku-workflow-map.gen.d.ts +9 -5
- package/dist/.pikku/workflow/pikku-workflow-types.gen.d.ts +36 -27
- package/dist/.pikku/workflow/pikku-workflow-types.gen.d.ts.map +1 -1
- package/dist/.pikku/workflow/pikku-workflow-types.gen.js +5 -18
- package/dist/.pikku/workflow/pikku-workflow-types.gen.js.map +1 -1
- package/dist/.pikku/workflow/pikku-workflow-types.gen.ts +66 -57
- package/dist/.pikku/workflow/pikku-workflow-wirings-meta.gen.js +1 -1
- package/dist/.pikku/workflow/pikku-workflow-wirings-meta.gen.ts +1 -1
- package/dist/.pikku/workflow/pikku-workflow-wirings.gen.d.ts +1 -1
- package/dist/.pikku/workflow/pikku-workflow-wirings.gen.js +1 -1
- package/dist/.pikku/workflow/pikku-workflow-wirings.gen.ts +1 -1
- package/dist/src/functions/data/jwt.function.d.ts.map +1 -1
- package/dist/src/functions/data/jwt.function.js +3 -2
- package/dist/src/functions/data/jwt.function.js.map +1 -1
- package/dist/src/functions/data/sleep.function.d.ts +16 -0
- package/dist/src/functions/data/sleep.function.d.ts.map +1 -0
- package/dist/src/functions/data/sleep.function.js +18 -0
- package/dist/src/functions/data/sleep.function.js.map +1 -0
- package/package.json +3 -2
- package/.pikku/agent/pikku-agent-wirings-meta.gen.json +0 -3
- package/.pikku/agent/pikku-agent-wirings-meta.gen.ts +0 -7
- package/.pikku/agent/pikku-agent-wirings.gen.ts +0 -3
- package/dist/.pikku/agent/pikku-agent-wirings-meta.gen.d.ts +0 -2
- package/dist/.pikku/agent/pikku-agent-wirings-meta.gen.d.ts.map +0 -1
- package/dist/.pikku/agent/pikku-agent-wirings-meta.gen.js +0 -7
- package/dist/.pikku/agent/pikku-agent-wirings-meta.gen.js.map +0 -1
- package/dist/.pikku/agent/pikku-agent-wirings-meta.gen.json +0 -3
- package/dist/.pikku/agent/pikku-agent-wirings-meta.gen.ts +0 -7
- package/dist/.pikku/agent/pikku-agent-wirings.gen.d.ts +0 -5
- package/dist/.pikku/agent/pikku-agent-wirings.gen.d.ts.map +0 -1
- package/dist/.pikku/agent/pikku-agent-wirings.gen.js +0 -5
- package/dist/.pikku/agent/pikku-agent-wirings.gen.js.map +0 -1
- package/dist/.pikku/agent/pikku-agent-wirings.gen.ts +0 -3
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* This file was generated by @pikku/cli@0.12.
|
|
2
|
+
* This file was generated by @pikku/cli@0.12.19
|
|
3
3
|
*/
|
|
4
4
|
/**
|
|
5
5
|
* Addon package types for pikkuAddonConfig and pikkuAddonServices
|
|
6
6
|
*/
|
|
7
7
|
|
|
8
|
-
import type { CreateConfig } from '@pikku/core'
|
|
8
|
+
import type { CreateConfig, PikkuWire } from '@pikku/core'
|
|
9
9
|
import type { SingletonServices } from '../../types/application-types.d.js'
|
|
10
10
|
import type { Config } from '../../types/application-types.d.js'
|
|
11
11
|
import type { RequiredSingletonServices } from '../pikku-services.gen.js'
|
|
@@ -15,6 +15,7 @@ import { TypedVariablesService } from '../variables/pikku-variables.gen.js'
|
|
|
15
15
|
|
|
16
16
|
|
|
17
17
|
|
|
18
|
+
|
|
18
19
|
/**
|
|
19
20
|
* Base services provided to addon package service factories.
|
|
20
21
|
* These are always available from the parent application.
|
|
@@ -63,16 +64,42 @@ export const pikkuAddonServices = <T extends Record<string, any>, ExistingServic
|
|
|
63
64
|
func: (config: Config, services: ExistingServices) => Promise<T>
|
|
64
65
|
) => {
|
|
65
66
|
return async (config: Config, existingServices?: Partial<SingletonServices>): Promise<RequiredSingletonServices> => {
|
|
66
|
-
const { logger, variables, secrets } = (existingServices ?? {}) as unknown as SingletonServices
|
|
67
|
+
const { logger, variables, secrets, schema } = (existingServices ?? {}) as unknown as SingletonServices
|
|
67
68
|
const typedVariables = new TypedVariablesService(variables)
|
|
68
69
|
const typedSecrets = new TypedSecretService(secrets)
|
|
69
70
|
const result = await func(config, { ...existingServices, logger, variables: typedVariables, secrets: typedSecrets } as ExistingServices)
|
|
70
71
|
return {
|
|
71
72
|
config,
|
|
72
73
|
logger,
|
|
74
|
+
schema,
|
|
73
75
|
variables: typedVariables,
|
|
74
76
|
secrets: typedSecrets,
|
|
75
77
|
...result,
|
|
76
78
|
} as unknown as RequiredSingletonServices
|
|
77
79
|
}
|
|
78
80
|
}
|
|
81
|
+
|
|
82
|
+
/**
|
|
83
|
+
* Creates a Pikku wire services factory for addon packages.
|
|
84
|
+
* Wire services are created per-request and have access to the HTTP request context.
|
|
85
|
+
*
|
|
86
|
+
* @param func - Wire services factory function that receives singleton services and the wire context
|
|
87
|
+
* @returns The wire services factory function
|
|
88
|
+
*
|
|
89
|
+
* @example
|
|
90
|
+
* ```typescript
|
|
91
|
+
* export const createWireServices = pikkuAddonWireServices(async (services, wire) => {
|
|
92
|
+
* const authHeader = wire.http?.request?.header('authorization')
|
|
93
|
+
* return { myService: new MyService(authHeader) }
|
|
94
|
+
* })
|
|
95
|
+
* ```
|
|
96
|
+
*/
|
|
97
|
+
export const pikkuAddonWireServices = <ExistingServices extends Omit<Partial<SingletonServices>, 'variables' | 'secrets'> & AddonBaseServices>(
|
|
98
|
+
func: (services: ExistingServices, wire: PikkuWire) => Promise<Record<string, any>>
|
|
99
|
+
) => {
|
|
100
|
+
return ((services: any, wire: PikkuWire) => {
|
|
101
|
+
const typedVariables = new TypedVariablesService(services.variables)
|
|
102
|
+
const typedSecrets = new TypedSecretService(services.secrets)
|
|
103
|
+
return func({ ...services, variables: typedVariables, secrets: typedSecrets } as ExistingServices, wire)
|
|
104
|
+
}) as any
|
|
105
|
+
}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* This file was generated by @pikku/cli@0.12.
|
|
2
|
+
* This file was generated by @pikku/cli@0.12.19
|
|
3
3
|
*/
|
|
4
4
|
import { pikkuState } from '@pikku/core/internal'
|
|
5
5
|
import { createSingletonServices as createSingletonServices } from '../../src/services.js'
|
|
@@ -7,3 +7,5 @@ import { createSingletonServices as createSingletonServices } from '../../src/se
|
|
|
7
7
|
pikkuState('@pikku/addon-graph', 'package', 'factories', {
|
|
8
8
|
createSingletonServices,
|
|
9
9
|
})
|
|
10
|
+
|
|
11
|
+
pikkuState('@pikku/addon-graph', 'package', 'requiredParentServices', ["jwt"])
|
|
@@ -1,16 +1,4 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* This file was generated by @pikku/cli@0.12.
|
|
2
|
+
* This file was generated by @pikku/cli@0.12.19
|
|
3
3
|
*/
|
|
4
|
-
|
|
5
|
-
* Agent type map with output types for each agent
|
|
6
|
-
*/
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
interface AgentHandler<O> {
|
|
12
|
-
output: O;
|
|
13
|
-
}
|
|
14
|
-
|
|
15
|
-
export type AgentMap = {
|
|
16
|
-
};
|
|
4
|
+
export type AgentMap = {}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* This file was generated by @pikku/cli@0.12.
|
|
2
|
+
* This file was generated by @pikku/cli@0.12.19
|
|
3
3
|
*/
|
|
4
4
|
import {
|
|
5
5
|
CoreAIAgent,
|
|
@@ -16,16 +16,22 @@ import type { StandardSchemaV1 } from '@standard-schema/spec'
|
|
|
16
16
|
import type { AIAgentMemoryConfig, AIAgentInput } from '@pikku/core/ai-agent'
|
|
17
17
|
import type { AgentMap } from './pikku-agent-map.gen.d.js'
|
|
18
18
|
|
|
19
|
-
type AIAgentConfig
|
|
20
|
-
|
|
21
|
-
|
|
19
|
+
type AIAgentConfig<
|
|
20
|
+
InputSchema extends StandardSchemaV1 | undefined = undefined,
|
|
21
|
+
OutputSchema extends StandardSchemaV1 | undefined = undefined
|
|
22
|
+
> = Omit<CoreAIAgent<PikkuPermission, PikkuMiddleware>, 'tools' | 'agents' | 'memory' | 'input' | 'output'> & {
|
|
23
|
+
input?: InputSchema
|
|
24
|
+
output?: OutputSchema
|
|
22
25
|
memory?: Omit<AIAgentMemoryConfig, 'workingMemory'> & { workingMemory?: StandardSchemaV1 }
|
|
23
26
|
tools?: object[]
|
|
24
|
-
agents?: AIAgentConfig[]
|
|
27
|
+
agents?: AIAgentConfig<StandardSchemaV1 | undefined, StandardSchemaV1 | undefined>[]
|
|
25
28
|
}
|
|
26
29
|
|
|
27
|
-
export const pikkuAIAgent =
|
|
28
|
-
|
|
30
|
+
export const pikkuAIAgent = <
|
|
31
|
+
InputSchema extends StandardSchemaV1 | undefined = undefined,
|
|
32
|
+
OutputSchema extends StandardSchemaV1 | undefined = undefined
|
|
33
|
+
>(
|
|
34
|
+
agent: AIAgentConfig<InputSchema, OutputSchema>
|
|
29
35
|
) => {
|
|
30
36
|
return agent
|
|
31
37
|
}
|
|
@@ -0,0 +1,177 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was generated by @pikku/cli@0.12.19
|
|
3
|
+
*/
|
|
4
|
+
/**
|
|
5
|
+
* Channel-specific type definitions for tree-shaking optimization
|
|
6
|
+
*/
|
|
7
|
+
|
|
8
|
+
import { CoreChannel, CorePikkuChannelMiddleware, CorePikkuChannelMiddlewareFactory, wireChannel as wireChannelCore, defineChannelRoutes as defineChannelRoutesCore, addChannelMiddleware as addChannelMiddlewareCore } from '@pikku/core/channel'
|
|
9
|
+
import { AssertHTTPWiringParams } from '@pikku/core/http'
|
|
10
|
+
import type { PikkuFunctionConfig, PikkuFunctionSessionless, PikkuPermission, PikkuMiddleware, Services } from '../function/pikku-function-types.gen.js'
|
|
11
|
+
import type { CorePermissionGroup } from '@pikku/core'
|
|
12
|
+
import type { StandardSchemaV1 } from '@standard-schema/spec'
|
|
13
|
+
|
|
14
|
+
/**
|
|
15
|
+
* Helper type to infer the output type from a Standard Schema
|
|
16
|
+
*/
|
|
17
|
+
type InferSchemaOutput<T> = T extends StandardSchemaV1<any, infer Output> ? Output : never
|
|
18
|
+
|
|
19
|
+
/**
|
|
20
|
+
* Type definition for WebSocket channels with typed data exchange.
|
|
21
|
+
* Supports connection, disconnection, and message handling.
|
|
22
|
+
* Accepts both session-based (PikkuFunction) and sessionless (PikkuFunctionSessionless) functions.
|
|
23
|
+
*
|
|
24
|
+
* @template ChannelData - Type of data exchanged through the channel
|
|
25
|
+
* @template Channel - String literal type for the channel name
|
|
26
|
+
*/
|
|
27
|
+
type ChannelWiring<ChannelData, Channel extends string> = CoreChannel<
|
|
28
|
+
ChannelData,
|
|
29
|
+
Channel,
|
|
30
|
+
PikkuFunctionConfig<void, any, 'channel' | 'session' | 'rpc'>,
|
|
31
|
+
PikkuFunctionConfig<void, void, 'channel' | 'session' | 'rpc'>,
|
|
32
|
+
PikkuFunctionConfig<any, any, 'channel' | 'session' | 'rpc'>,
|
|
33
|
+
PikkuPermission,
|
|
34
|
+
PikkuMiddleware
|
|
35
|
+
>
|
|
36
|
+
|
|
37
|
+
/**
|
|
38
|
+
* Creates a function that handles WebSocket channel connections.
|
|
39
|
+
* Called when a client connects to a channel.
|
|
40
|
+
*
|
|
41
|
+
* @template Out - Output type for connection response
|
|
42
|
+
* @param func - Function definition, either direct function or configuration object
|
|
43
|
+
* @returns The normalized configuration object
|
|
44
|
+
*/
|
|
45
|
+
export const pikkuChannelConnectionFunc = <Out = unknown>(
|
|
46
|
+
func:
|
|
47
|
+
| PikkuFunctionSessionless<void, Out, 'channel' | 'session' | 'rpc'>
|
|
48
|
+
| PikkuFunctionConfig<void, Out, 'channel' | 'session' | 'rpc'>
|
|
49
|
+
) => {
|
|
50
|
+
return typeof func === 'function' ? { func } : func
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
/**
|
|
54
|
+
* Creates a function that handles WebSocket channel disconnections.
|
|
55
|
+
* Called when a client disconnects from a channel.
|
|
56
|
+
*
|
|
57
|
+
* @param func - Function definition, either direct function or configuration object
|
|
58
|
+
* @returns The normalized configuration object
|
|
59
|
+
*/
|
|
60
|
+
export const pikkuChannelDisconnectionFunc = (
|
|
61
|
+
func:
|
|
62
|
+
| PikkuFunctionSessionless<void, void, 'channel'>
|
|
63
|
+
| PikkuFunctionConfig<void, void, 'channel' | 'session' | 'rpc'>
|
|
64
|
+
) => {
|
|
65
|
+
return typeof func === 'function' ? { func } : func
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
/**
|
|
69
|
+
* Configuration object for channel functions with Zod schema validation.
|
|
70
|
+
*/
|
|
71
|
+
type PikkuChannelFuncConfigWithSchema<
|
|
72
|
+
InputSchema extends StandardSchemaV1,
|
|
73
|
+
OutputSchema extends StandardSchemaV1 | undefined = undefined
|
|
74
|
+
> = {
|
|
75
|
+
name?: string
|
|
76
|
+
tags?: string[]
|
|
77
|
+
expose?: boolean
|
|
78
|
+
remote?: boolean
|
|
79
|
+
func: PikkuFunctionSessionless<
|
|
80
|
+
InferSchemaOutput<InputSchema>,
|
|
81
|
+
OutputSchema extends StandardSchemaV1 ? InferSchemaOutput<OutputSchema> : unknown,
|
|
82
|
+
'channel' | 'session' | 'rpc'
|
|
83
|
+
>
|
|
84
|
+
auth?: boolean
|
|
85
|
+
permissions?: CorePermissionGroup<PikkuPermission<InferSchemaOutput<InputSchema>>>
|
|
86
|
+
middleware?: PikkuMiddleware[]
|
|
87
|
+
input: InputSchema
|
|
88
|
+
output?: OutputSchema
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
/**
|
|
92
|
+
* Creates a function that handles WebSocket channel messages.
|
|
93
|
+
* Called when a message is received on a channel.
|
|
94
|
+
*
|
|
95
|
+
* Supports two patterns:
|
|
96
|
+
* 1. Generic types: `pikkuChannelFunc<Input, Output>({ func: ... })`
|
|
97
|
+
* 2. Zod schemas: `pikkuChannelFunc({ input: z.object(...), func: ... })`
|
|
98
|
+
*
|
|
99
|
+
* @template In - Input type for channel messages (inferred from schema if provided)
|
|
100
|
+
* @template Out - Output type for channel responses (inferred from schema if provided)
|
|
101
|
+
* @param func - Function definition, either direct function or configuration object
|
|
102
|
+
* @returns The normalized configuration object
|
|
103
|
+
*
|
|
104
|
+
* @example
|
|
105
|
+
* ```typescript
|
|
106
|
+
* // Pattern 1: Using generic types
|
|
107
|
+
* const handleMessage = pikkuChannelFunc<{text: string}, {received: boolean}>({
|
|
108
|
+
* func: async (_services, { text }) => ({ received: true })
|
|
109
|
+
* })
|
|
110
|
+
*
|
|
111
|
+
* // Pattern 2: Using Zod schemas
|
|
112
|
+
* const messageInput = z.object({ text: z.string() })
|
|
113
|
+
* const messageOutput = z.object({ received: z.boolean() })
|
|
114
|
+
*
|
|
115
|
+
* const handleMessage = pikkuChannelFunc({
|
|
116
|
+
* input: messageInput,
|
|
117
|
+
* output: messageOutput,
|
|
118
|
+
* func: async (_services, { text }) => ({ received: true })
|
|
119
|
+
* })
|
|
120
|
+
* ```
|
|
121
|
+
*/
|
|
122
|
+
export function pikkuChannelFunc<
|
|
123
|
+
InputSchema extends StandardSchemaV1,
|
|
124
|
+
OutputSchema extends StandardSchemaV1 | undefined = undefined
|
|
125
|
+
>(
|
|
126
|
+
config: PikkuChannelFuncConfigWithSchema<InputSchema, OutputSchema>
|
|
127
|
+
): PikkuFunctionConfig<InferSchemaOutput<InputSchema>, OutputSchema extends StandardSchemaV1 ? InferSchemaOutput<OutputSchema> : unknown, 'channel' | 'session' | 'rpc'>
|
|
128
|
+
export function pikkuChannelFunc<In, Out = unknown>(
|
|
129
|
+
func:
|
|
130
|
+
| PikkuFunctionSessionless<In, Out, 'channel' | 'session' | 'rpc'>
|
|
131
|
+
| PikkuFunctionConfig<In, Out, 'channel' | 'session' | 'rpc'>
|
|
132
|
+
): PikkuFunctionConfig<In, Out, 'channel' | 'session' | 'rpc'>
|
|
133
|
+
export function pikkuChannelFunc(func: any) {
|
|
134
|
+
return typeof func === 'function' ? { func } : func
|
|
135
|
+
}
|
|
136
|
+
|
|
137
|
+
/**
|
|
138
|
+
* Registers a WebSocket channel with the Pikku framework.
|
|
139
|
+
*
|
|
140
|
+
* @template ChannelData - Type of data associated with the channel
|
|
141
|
+
* @template Channel - String literal type for the channel name
|
|
142
|
+
* @param channel - Channel definition with connection, disconnection, and message handlers
|
|
143
|
+
*/
|
|
144
|
+
export const wireChannel = <ChannelData, Channel extends string>(
|
|
145
|
+
channel: ChannelWiring<ChannelData, Channel> & AssertHTTPWiringParams<ChannelData, Channel>
|
|
146
|
+
) => {
|
|
147
|
+
wireChannelCore(channel as any)
|
|
148
|
+
}
|
|
149
|
+
|
|
150
|
+
/**
|
|
151
|
+
* Type-safe helper for defining channel message routes that can be composed.
|
|
152
|
+
* Returns the routes record as-is for use with wireChannel's onMessageWiring.
|
|
153
|
+
*
|
|
154
|
+
* @template T - Record of channel route handlers
|
|
155
|
+
* @param routes - The channel routes record
|
|
156
|
+
* @returns The same routes record (identity function for type safety)
|
|
157
|
+
*/
|
|
158
|
+
export function defineChannelRoutes<T extends Record<string, any>>(routes: T): T {
|
|
159
|
+
return defineChannelRoutesCore(routes)
|
|
160
|
+
}
|
|
161
|
+
|
|
162
|
+
export type PikkuChannelMiddleware<RequiredServices extends Services = Services, Event = unknown> = CorePikkuChannelMiddleware<RequiredServices, Event>
|
|
163
|
+
|
|
164
|
+
export const pikkuChannelMiddleware = <RequiredServices extends Services = Services, Event = unknown>(
|
|
165
|
+
middleware: PikkuChannelMiddleware<RequiredServices, Event>
|
|
166
|
+
): PikkuChannelMiddleware<RequiredServices, Event> => {
|
|
167
|
+
return middleware
|
|
168
|
+
}
|
|
169
|
+
|
|
170
|
+
export const pikkuChannelMiddlewareFactory = <In = any>(
|
|
171
|
+
factory: CorePikkuChannelMiddlewareFactory<In>
|
|
172
|
+
): CorePikkuChannelMiddlewareFactory<In> => {
|
|
173
|
+
return factory
|
|
174
|
+
}
|
|
175
|
+
|
|
176
|
+
export const addChannelMiddleware = (tag: string, middleware: PikkuChannelMiddleware[]) =>
|
|
177
|
+
addChannelMiddlewareCore(tag, middleware, '@pikku/addon-graph')
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was generated by @pikku/cli@0.12.19
|
|
3
|
+
*/
|
|
4
|
+
/**
|
|
5
|
+
|
|
6
|
+
* CLI-specific type definitions for tree-shaking optimization
|
|
7
|
+
*/
|
|
8
|
+
|
|
9
|
+
import { CoreCLI, wireCLI as wireCLICore, CorePikkuCLIRender, CoreCLICommandConfig, defineCLICommands as defineCLICommandsCore } from '@pikku/core/cli'
|
|
10
|
+
import type { PikkuFunctionConfig, PikkuMiddleware } from '../function/pikku-function-types.gen.js'
|
|
11
|
+
import type { UserSession } from '../../types/application-types.d.js'
|
|
12
|
+
import type { SingletonServices } from '../../types/application-types.d.js'
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
type Session = UserSession
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
* Type-safe CLI renderer definition that can access your application's services.
|
|
19
|
+
* Use this to define custom renderers for CLI command output.
|
|
20
|
+
*
|
|
21
|
+
* @template Data - The output data type from the CLI command
|
|
22
|
+
* @template RequiredServices - The services required for this renderer
|
|
23
|
+
*/
|
|
24
|
+
type PikkuCLIRender<Data, RequiredServices extends SingletonServices = SingletonServices> = CorePikkuCLIRender<Data, RequiredServices, Session>
|
|
25
|
+
|
|
26
|
+
/**
|
|
27
|
+
* Creates a type-safe CLI renderer with access to your application's singleton services.
|
|
28
|
+
* The renderer receives the full singleton services and output data to format and display results.
|
|
29
|
+
*
|
|
30
|
+
* @template Data - The output data type from the CLI command
|
|
31
|
+
* @template RequiredServices - The minimum services required for type checking (defaults to SingletonServices)
|
|
32
|
+
* @param render - Function that receives singleton services and data to render output
|
|
33
|
+
* @returns A CLI renderer configuration
|
|
34
|
+
*
|
|
35
|
+
* @example
|
|
36
|
+
* ```typescript
|
|
37
|
+
* const myRenderer = pikkuCLIRender<MyData>(({ logger }, data) => {
|
|
38
|
+
* logger.info(data.message)
|
|
39
|
+
* })
|
|
40
|
+
* ```
|
|
41
|
+
*/
|
|
42
|
+
export const pikkuCLIRender = <Data, RequiredServices extends SingletonServices = SingletonServices>(
|
|
43
|
+
render: (services: SingletonServices, data: Data) => void | Promise<void>
|
|
44
|
+
): PikkuCLIRender<Data, RequiredServices> => {
|
|
45
|
+
return render as any
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
/**
|
|
49
|
+
* CLI command configuration with project-specific types.
|
|
50
|
+
* Uses CoreCLICommandConfig from @pikku/core with local middleware and render types.
|
|
51
|
+
*/
|
|
52
|
+
type CLICommandConfig<Func extends PikkuFunctionConfig<In, Out, 'cli' | 'rpc' | 'session'>, In = any, Out = any, Params extends string = string> = CoreCLICommandConfig<Func, PikkuMiddleware, PikkuCLIRender<any>, Params>
|
|
53
|
+
|
|
54
|
+
/**
|
|
55
|
+
* Type definition for CLI applications with commands and global options.
|
|
56
|
+
*
|
|
57
|
+
* @template Commands - Type describing the command structure
|
|
58
|
+
* @template GlobalOptions - Type for global CLI options
|
|
59
|
+
*/
|
|
60
|
+
type CLIWiring<Commands extends Record<string, CoreCLICommandConfig<any, PikkuMiddleware, PikkuCLIRender<any>, any>>, GlobalOptions> = CoreCLI<Commands, GlobalOptions, PikkuMiddleware, PikkuCLIRender<any>>
|
|
61
|
+
|
|
62
|
+
/**
|
|
63
|
+
* Registers a CLI application with the Pikku framework.
|
|
64
|
+
* Creates command-line interfaces with type-safe commands and options.
|
|
65
|
+
*
|
|
66
|
+
* @template Commands - Type describing the command structure
|
|
67
|
+
* @template GlobalOptions - Type for global CLI options
|
|
68
|
+
* @param cli - CLI definition with program name, commands, and global options
|
|
69
|
+
*/
|
|
70
|
+
export const wireCLI = <Commands extends Record<string, CoreCLICommandConfig<any, PikkuMiddleware, PikkuCLIRender<any>, any>>, GlobalOptions>(
|
|
71
|
+
cli: CLIWiring<Commands, GlobalOptions>
|
|
72
|
+
) => {
|
|
73
|
+
wireCLICore(cli as any)
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
/**
|
|
77
|
+
* Creates a CLI command definition with automatic option inference from the function's input type.
|
|
78
|
+
* This allows TypeScript to automatically derive CLI options from the function signature.
|
|
79
|
+
*
|
|
80
|
+
* @template FuncConfig - The Pikku function config type
|
|
81
|
+
* @template Params - The parameters string literal type
|
|
82
|
+
* @param config - CLI command configuration
|
|
83
|
+
* @returns CLI command configuration with inferred types
|
|
84
|
+
*/
|
|
85
|
+
export const pikkuCLICommand = <
|
|
86
|
+
FuncConfig extends PikkuFunctionConfig<any, any, 'cli' | 'rpc' | 'session'>,
|
|
87
|
+
Params extends string
|
|
88
|
+
>(
|
|
89
|
+
config: CLICommandConfig<FuncConfig, any, any, Params>
|
|
90
|
+
): CoreCLICommandConfig<FuncConfig, PikkuMiddleware, PikkuCLIRender<any>, string> => {
|
|
91
|
+
return config as any
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
/**
|
|
95
|
+
* Type-safe helper for defining CLI commands that can be composed and spread into wireCLI.
|
|
96
|
+
*
|
|
97
|
+
* @template T - Record of CLI command configurations
|
|
98
|
+
* @param commands - The CLI commands record
|
|
99
|
+
* @returns The same commands record (identity function for type safety)
|
|
100
|
+
*/
|
|
101
|
+
export const defineCLICommands = <T extends Record<string, CoreCLICommandConfig<any, PikkuMiddleware, PikkuCLIRender<any>, any>>>(
|
|
102
|
+
commands: T
|
|
103
|
+
): T => {
|
|
104
|
+
return defineCLICommandsCore(commands as any) as T
|
|
105
|
+
}
|