@pikku/core 0.6.10 → 0.6.11
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 +7 -0
- package/dist/channel/channel-runner.d.ts +1 -1
- package/dist/channel/channel.types.d.ts +6 -6
- package/dist/http/http-route-runner.d.ts +1 -1
- package/dist/types/core.types.d.ts +4 -3
- package/lcov.info +3729 -0
- package/package.json +2 -2
- package/src/channel/channel.types.ts +5 -6
- package/src/types/core.types.ts +4 -5
- package/tsconfig.tsbuildinfo +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -16,7 +16,7 @@ export declare const setChannelsMeta: (_channelsMeta: ChannelsMeta) => void;
|
|
|
16
16
|
export declare const getMatchingChannelConfig: (request: string) => {
|
|
17
17
|
matchedPath: import("path-to-regexp").MatchResult<Partial<Record<string, string | string[]>>>;
|
|
18
18
|
params: Partial<Record<string, string | string[]>>;
|
|
19
|
-
channelConfig: CoreAPIChannel<any, string, import("./channel.types.js").CoreChannelConnection<any, unknown, import("../types/core.types.js").CoreServices,
|
|
19
|
+
channelConfig: CoreAPIChannel<any, string, import("./channel.types.js").CoreChannelConnection<any, unknown, import("../types/core.types.js").CoreServices, CoreUserSession>, import("./channel.types.js").CoreChannelDisconnection<any, import("../types/core.types.js").CoreServices, CoreUserSession>, import("./channel.types.js").CoreChannelMessage<unknown, unknown, unknown, import("../types/core.types.js").CoreServices, CoreUserSession>, import("./channel.types.js").CoreChannelMessage<unknown, unknown, unknown, import("../types/core.types.js").CoreServices, CoreUserSession>, import("../index.js").CoreAPIPermission<any>>;
|
|
20
20
|
schemaName: string | null | undefined;
|
|
21
21
|
} | null;
|
|
22
22
|
export declare const openChannel: ({ route, singletonServices, skipUserSession, coerceToArray, http, }: Pick<CoreAPIChannel<unknown, string>, "route"> & Omit<RunChannelParams<unknown>, "response" | "request"> & RunChannelOptions) => Promise<{
|
|
@@ -2,7 +2,7 @@ import { PikkuError } from '../errors/error-handler.js';
|
|
|
2
2
|
import { HTTPFunctionMetaInputTypes, PikkuHTTP } from '../http/http-routes.types.js';
|
|
3
3
|
import { PikkuHTTPAbstractRequest } from '../http/pikku-http-abstract-request.js';
|
|
4
4
|
import { PikkuHTTPAbstractResponse } from '../http/pikku-http-abstract-response.js';
|
|
5
|
-
import { APIDocs, CoreServices, CoreSingletonServices, CoreUserSession, CreateSessionServices
|
|
5
|
+
import { APIDocs, CoreServices, CoreSingletonServices, CoreUserSession, CreateSessionServices } from '../types/core.types.js';
|
|
6
6
|
import { CoreAPIPermission } from '../types/functions.types.js';
|
|
7
7
|
import { PikkuRequest } from '../pikku-request.js';
|
|
8
8
|
import { PikkuResponse } from '../pikku-response.js';
|
|
@@ -15,7 +15,7 @@ export type RunChannelOptions = Partial<{
|
|
|
15
15
|
}>;
|
|
16
16
|
export type RunChannelParams<ChannelData> = {
|
|
17
17
|
channelId: string;
|
|
18
|
-
singletonServices:
|
|
18
|
+
singletonServices: CoreSingletonServices;
|
|
19
19
|
request?: PikkuRequest<ChannelData> | PikkuHTTPAbstractRequest<ChannelData>;
|
|
20
20
|
response?: PikkuResponse | PikkuHTTPAbstractResponse;
|
|
21
21
|
http?: PikkuHTTP;
|
|
@@ -43,8 +43,8 @@ export interface ChannelMeta {
|
|
|
43
43
|
docs?: APIDocs;
|
|
44
44
|
}
|
|
45
45
|
export type ChannelsMeta = ChannelMeta[];
|
|
46
|
-
export type CoreChannelConnection<ChannelData, Out = unknown, Services extends CoreServices = CoreServices, Session extends CoreUserSession = CoreUserSession> = (services:
|
|
47
|
-
export type CoreChannelDisconnection<ChannelData, Services extends CoreServices = CoreServices, Session extends CoreUserSession = CoreUserSession> = (services:
|
|
46
|
+
export type CoreChannelConnection<ChannelData, Out = unknown, Services extends CoreServices = CoreServices, Session extends CoreUserSession = CoreUserSession> = (services: Services, channel: PikkuChannel<Session, ChannelData, Out>) => Promise<void>;
|
|
47
|
+
export type CoreChannelDisconnection<ChannelData, Services extends CoreServices = CoreServices, Session extends CoreUserSession = CoreUserSession> = (services: Services, channel: PikkuChannel<Session, ChannelData, never>) => Promise<void>;
|
|
48
48
|
/**
|
|
49
49
|
* Represents a core channel function that performs an operation using core services and a user session.
|
|
50
50
|
*
|
|
@@ -52,12 +52,12 @@ export type CoreChannelDisconnection<ChannelData, Services extends CoreServices
|
|
|
52
52
|
* @template Services - The services type, defaults to `CoreServices`.
|
|
53
53
|
* @template Session - The session type, defaults to `CoreUserSession`.
|
|
54
54
|
*/
|
|
55
|
-
export type CoreChannelMessage<In, Out, ChannelData, Services extends CoreServices = CoreServices, Session extends CoreUserSession = CoreUserSession> = (services:
|
|
55
|
+
export type CoreChannelMessage<In, Out, ChannelData, Services extends CoreServices = CoreServices, Session extends CoreUserSession = CoreUserSession> = (services: Services, channel: PikkuChannel<Session, ChannelData, Out>, data: In) => Promise<void | Out>;
|
|
56
56
|
export type CoreAPIChannelMessage<ChannelFunctionMessage = CoreChannelMessage<unknown, unknown, unknown>> = {
|
|
57
57
|
func: ChannelFunctionMessage;
|
|
58
58
|
route: string;
|
|
59
59
|
};
|
|
60
|
-
export type CoreAPIChannel<ChannelData, Channel extends string, ChannelFunctionConnection = CoreChannelConnection<ChannelData>, ChannelFunctionDisconnection =
|
|
60
|
+
export type CoreAPIChannel<ChannelData, Channel extends string, ChannelFunctionConnection = CoreChannelConnection<ChannelData>, ChannelFunctionDisconnection = CoreChannelDisconnection<ChannelData>, ChannelFunctionDefaultMessage = CoreChannelMessage<unknown, unknown, unknown>, ChannelFunctionMessageRoute = CoreChannelMessage<unknown, unknown, unknown>, APIPermission = CoreAPIPermission<ChannelData>> = {
|
|
61
61
|
name: string;
|
|
62
62
|
route: Channel;
|
|
63
63
|
onConnect?: ChannelFunctionConnection;
|
|
@@ -21,7 +21,7 @@ export declare const getRoutes: () => {
|
|
|
21
21
|
routesMeta: HTTPRoutesMeta;
|
|
22
22
|
};
|
|
23
23
|
export declare const getUserSession: <UserSession extends CoreUserSession>(httpSessionService: HTTPSessionService<UserSession> | undefined, auth: boolean, request: PikkuHTTPAbstractRequest) => Promise<CoreUserSession | undefined>;
|
|
24
|
-
export declare const loadUserSession: (skipUserSession: boolean, requiresSession: boolean, http: PikkuHTTP | undefined, matchedPath: any, route: CoreHTTPFunctionRoute<unknown, unknown, any> | CoreAPIChannel<unknown, any>, logger: Logger, httpSessionService: HTTPSessionService | undefined) => Promise<
|
|
24
|
+
export declare const loadUserSession: (skipUserSession: boolean, requiresSession: boolean, http: PikkuHTTP | undefined, matchedPath: any, route: CoreHTTPFunctionRoute<unknown, unknown, any> | CoreAPIChannel<unknown, any>, logger: Logger, httpSessionService: HTTPSessionService | undefined) => Promise<CoreUserSession | undefined>;
|
|
25
25
|
export declare const createHTTPInteraction: (request: PikkuRequest | undefined, response: PikkuResponse | undefined) => PikkuHTTP | undefined;
|
|
26
26
|
export declare const handleError: (e: any, http: PikkuHTTP | undefined, trackerId: string, logger: Logger, logWarningsForStatusCodes: number[], respondWith404: boolean, bubbleError: boolean) => void;
|
|
27
27
|
/**
|
|
@@ -47,11 +47,12 @@ export type CoreConfig<Config extends Record<string, unknown> = {}> = {
|
|
|
47
47
|
/**
|
|
48
48
|
* Represents a core user session, which can be extended for more specific session information.
|
|
49
49
|
*/
|
|
50
|
-
export
|
|
50
|
+
export interface CoreUserSession {
|
|
51
|
+
}
|
|
51
52
|
/**
|
|
52
53
|
* Interface for core singleton services provided by Pikku.
|
|
53
54
|
*/
|
|
54
|
-
export
|
|
55
|
+
export interface CoreSingletonServices<Config extends CoreConfig = CoreConfig, UserSession extends CoreUserSession = CoreUserSession> {
|
|
55
56
|
/** The http permission service used for authorization (optional). */
|
|
56
57
|
enforceHTTPAccess?: enforceHTTPAccess;
|
|
57
58
|
/** The channel permission service used by the application (optional). */
|
|
@@ -72,7 +73,7 @@ export type CoreSingletonServices<Config extends CoreConfig = CoreConfig, UserSe
|
|
|
72
73
|
eventHub?: EventHubService<unknown>;
|
|
73
74
|
/** SecretServce */
|
|
74
75
|
secretService?: SecretService;
|
|
75
|
-
}
|
|
76
|
+
}
|
|
76
77
|
/**
|
|
77
78
|
* Represents different forms of interaction within Pikku and the outside world.
|
|
78
79
|
*/
|