every-plugin 0.1.6 → 0.2.1
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/dist/client/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/plugin.d.ts +5 -12
- package/dist/plugin.d.ts.map +1 -1
- package/dist/plugin.js +0 -1
- package/dist/runtime/index.d.ts +21 -35
- package/dist/runtime/index.d.ts.map +1 -1
- package/dist/runtime/index.js +57 -69
- package/dist/runtime/services/module-federation.service.d.ts +7 -11
- package/dist/runtime/services/module-federation.service.d.ts.map +1 -1
- package/dist/runtime/services/module-federation.service.js +7 -9
- package/dist/runtime/services/plugin-lifecycle.service.d.ts +9 -12
- package/dist/runtime/services/plugin-lifecycle.service.d.ts.map +1 -1
- package/dist/runtime/services/plugin-lifecycle.service.js +5 -6
- package/dist/runtime/services/plugin-loader.service.d.ts +34 -13
- package/dist/runtime/services/plugin-loader.service.d.ts.map +1 -1
- package/dist/runtime/services/plugin-loader.service.js +34 -27
- package/dist/runtime/services/plugin.service.d.ts +29 -17
- package/dist/runtime/services/plugin.service.d.ts.map +1 -1
- package/dist/runtime/services/plugin.service.js +13 -7
- package/dist/runtime/services/secrets.service.d.ts +8 -9
- package/dist/runtime/services/secrets.service.d.ts.map +1 -1
- package/dist/runtime/services/secrets.service.js +28 -27
- package/dist/runtime/services.d.ts +3 -1
- package/dist/runtime/services.d.ts.map +1 -1
- package/dist/runtime/services.js +3 -1
- package/dist/testing/index.d.ts +45 -12
- package/dist/testing/index.d.ts.map +1 -1
- package/dist/testing/index.js +34 -27
- package/dist/testing/mocks/module-federation.service.d.ts +3 -5
- package/dist/testing/mocks/module-federation.service.d.ts.map +1 -1
- package/dist/testing/mocks/module-federation.service.js +18 -24
- package/dist/types.d.ts +40 -74
- package/dist/types.d.ts.map +1 -1
- package/package.json +4 -1
package/dist/types.d.ts
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
import type { AnyContractRouter } from "@orpc/contract";
|
|
2
|
-
import type { Context,
|
|
3
|
-
import { Scope } from "effect";
|
|
2
|
+
import type { Context, RouterClient } from "@orpc/server";
|
|
3
|
+
import type { Scope } from "effect";
|
|
4
4
|
import type { z } from "zod";
|
|
5
|
-
import type { Plugin, PluginConfigFor
|
|
6
|
-
|
|
5
|
+
import type { Plugin, PluginConfigFor } from "./plugin";
|
|
6
|
+
import type { PluginRuntime } from "./runtime";
|
|
7
7
|
/**
|
|
8
8
|
* Base type for any plugin instance.
|
|
9
9
|
* This is the foundation that enables type inference across the entire plugin system.
|
|
@@ -26,7 +26,7 @@ export type RegistryBindings = Record<string, {
|
|
|
26
26
|
export type PluginOf<B> = B extends {
|
|
27
27
|
contract: infer C;
|
|
28
28
|
config: infer Conf;
|
|
29
|
-
} ? Conf extends PluginConfigFor<infer V, infer S> ? C extends AnyContractRouter ? Plugin<C, V, S> : never : never : never;
|
|
29
|
+
} ? Conf extends PluginConfigFor<infer V, infer S> ? C extends AnyContractRouter ? Plugin<C, V, S, Context> : never : never : never;
|
|
30
30
|
/**
|
|
31
31
|
* Extracts the config type from a binding definition.
|
|
32
32
|
* This provides strongly-typed configuration based on the plugin's zod schema.
|
|
@@ -42,48 +42,11 @@ export type RouterOf<T extends AnyPlugin> = ReturnType<T["createRouter"]>;
|
|
|
42
42
|
* This is used for typing the router client context parameter.
|
|
43
43
|
*/
|
|
44
44
|
export type ContextOf<T extends AnyPlugin> = T extends Plugin<AnyContractRouter, z.ZodTypeAny, z.ZodTypeAny, infer TContext> ? TContext : never;
|
|
45
|
-
/**
|
|
46
|
-
* Infers binding definitions from plugin constructor objects.
|
|
47
|
-
* Used to derive RegistryBindings from a collection of plugin constructors.
|
|
48
|
-
*/
|
|
49
|
-
export type InferBindingsFromPlugins<T> = {
|
|
50
|
-
[K in keyof T]: T[K] extends PluginConstructorWithBinding<infer C, infer V, infer S, infer Ctx> ? {
|
|
51
|
-
contract: C;
|
|
52
|
-
config: PluginConfigFor<V, S>;
|
|
53
|
-
} : never;
|
|
54
|
-
};
|
|
55
|
-
/**
|
|
56
|
-
* Converts registry bindings to plugin constructor types.
|
|
57
|
-
* This is used internally by the runtime to maintain type safety.
|
|
58
|
-
*/
|
|
59
|
-
export type PluginBindingsFor<R extends RegistryBindings> = {
|
|
60
|
-
[K in keyof R]: R[K] extends {
|
|
61
|
-
contract: infer C;
|
|
62
|
-
config: infer Conf;
|
|
63
|
-
} ? Conf extends PluginConfigFor<infer V, infer S> ? C extends AnyContractRouter ? PluginConstructorWithBinding<C, V, S, Context> : never : never : never;
|
|
64
|
-
};
|
|
65
45
|
/**
|
|
66
46
|
* Runtime registry configuration.
|
|
67
47
|
* Maps plugin IDs to their remote URLs and metadata.
|
|
68
48
|
*/
|
|
69
|
-
export type PluginRegistry = Record<string,
|
|
70
|
-
remoteUrl: string;
|
|
71
|
-
type: string;
|
|
72
|
-
version?: string;
|
|
73
|
-
description?: string;
|
|
74
|
-
}>;
|
|
75
|
-
/**
|
|
76
|
-
* Type-safe registry that enforces key alignment with bindings.
|
|
77
|
-
* When used with RegistryBindings, ensures plugin IDs match between registry and type definitions.
|
|
78
|
-
*/
|
|
79
|
-
export type PluginRegistryFor<R extends RegistryBindings> = {
|
|
80
|
-
[K in keyof R]: {
|
|
81
|
-
remoteUrl: string;
|
|
82
|
-
type: string;
|
|
83
|
-
version?: string;
|
|
84
|
-
description?: string;
|
|
85
|
-
};
|
|
86
|
-
};
|
|
49
|
+
export type PluginRegistry = Record<string, PluginMetadata>;
|
|
87
50
|
/**
|
|
88
51
|
* Configuration for secrets injection.
|
|
89
52
|
* Secrets are hydrated into plugin configs using template replacement.
|
|
@@ -92,44 +55,35 @@ export interface SecretsConfig {
|
|
|
92
55
|
[key: string]: string;
|
|
93
56
|
}
|
|
94
57
|
/**
|
|
95
|
-
*
|
|
96
|
-
*
|
|
58
|
+
* Shared metadata for plugin lifecycle stages.
|
|
59
|
+
* Contains information about the plugin that persists across different stages.
|
|
97
60
|
*/
|
|
98
|
-
export
|
|
61
|
+
export type PluginMetadata = {
|
|
62
|
+
readonly remoteUrl: string;
|
|
63
|
+
readonly version?: string;
|
|
64
|
+
readonly description?: string;
|
|
65
|
+
};
|
|
66
|
+
/**
|
|
67
|
+
* Loaded plugin with metadata.
|
|
68
|
+
*/
|
|
69
|
+
export interface LoadedPlugin<T extends AnyPlugin = AnyPlugin> {
|
|
99
70
|
readonly ctor: new () => T;
|
|
100
|
-
readonly metadata:
|
|
101
|
-
readonly pluginId: string;
|
|
102
|
-
readonly version?: string;
|
|
103
|
-
readonly description?: string;
|
|
104
|
-
readonly type?: string;
|
|
105
|
-
};
|
|
71
|
+
readonly metadata: PluginMetadata;
|
|
106
72
|
}
|
|
107
73
|
/**
|
|
108
74
|
* Instantiated plugin with metadata.
|
|
109
|
-
* Represents a plugin instance ready for initialization.
|
|
110
75
|
*/
|
|
111
76
|
export interface PluginInstance<T extends AnyPlugin = AnyPlugin> {
|
|
112
77
|
readonly plugin: T;
|
|
113
|
-
readonly metadata:
|
|
114
|
-
readonly pluginId: string;
|
|
115
|
-
readonly version?: string;
|
|
116
|
-
readonly description?: string;
|
|
117
|
-
readonly type?: string;
|
|
118
|
-
};
|
|
78
|
+
readonly metadata: PluginMetadata;
|
|
119
79
|
}
|
|
120
80
|
/**
|
|
121
81
|
* Fully initialized plugin ready for use.
|
|
122
82
|
* Contains the plugin instance, validated config, execution context, and scope.
|
|
123
|
-
* This is what gets passed to createPluginClient for type-safe procedure calls.
|
|
124
83
|
*/
|
|
125
84
|
export interface InitializedPlugin<T extends AnyPlugin = AnyPlugin> {
|
|
126
85
|
readonly plugin: T;
|
|
127
|
-
readonly metadata:
|
|
128
|
-
readonly pluginId: string;
|
|
129
|
-
readonly version?: string;
|
|
130
|
-
readonly description?: string;
|
|
131
|
-
readonly type?: string;
|
|
132
|
-
};
|
|
86
|
+
readonly metadata: PluginMetadata;
|
|
133
87
|
readonly config: z.infer<T["configSchema"]>;
|
|
134
88
|
readonly context: ContextOf<T>;
|
|
135
89
|
readonly scope: Scope.CloseableScope;
|
|
@@ -154,17 +108,29 @@ export interface RuntimeOptions {
|
|
|
154
108
|
/**
|
|
155
109
|
* Enhanced plugin result containing client, router, and metadata.
|
|
156
110
|
*/
|
|
157
|
-
export interface
|
|
158
|
-
readonly client:
|
|
111
|
+
export interface EveryPlugin<T extends AnyPlugin = AnyPlugin> {
|
|
112
|
+
readonly client: RouterClient<RouterOf<T>, Record<never, never>>;
|
|
159
113
|
readonly router: RouterOf<T>;
|
|
160
|
-
readonly metadata:
|
|
161
|
-
readonly pluginId: string;
|
|
162
|
-
readonly version?: string;
|
|
163
|
-
readonly description?: string;
|
|
164
|
-
readonly type?: string;
|
|
165
|
-
};
|
|
114
|
+
readonly metadata: PluginMetadata;
|
|
166
115
|
readonly initialized: InitializedPlugin<T>;
|
|
167
116
|
}
|
|
117
|
+
/**
|
|
118
|
+
* Namespace containing type utilities for working with plugin results.
|
|
119
|
+
*/
|
|
120
|
+
export declare namespace EveryPlugin {
|
|
121
|
+
/**
|
|
122
|
+
* Extract the typed plugin result from a runtime instance.
|
|
123
|
+
* Provides full type safety for plugin clients, routers, and metadata.
|
|
124
|
+
*
|
|
125
|
+
* @example
|
|
126
|
+
* ```ts
|
|
127
|
+
* const runtime = createPluginRuntime<MyBindings>({...});
|
|
128
|
+
* let plugin: EveryPlugin.Infer<typeof runtime, "my-plugin">;
|
|
129
|
+
* plugin = await runtime.usePlugin("my-plugin", config);
|
|
130
|
+
* ```
|
|
131
|
+
*/
|
|
132
|
+
type Infer<T extends PluginRuntime<any>, K extends T extends PluginRuntime<infer R> ? keyof R : never> = T extends PluginRuntime<infer R> ? EveryPlugin<PluginOf<R[K]>> : never;
|
|
133
|
+
}
|
|
168
134
|
/**
|
|
169
135
|
* Runtime configuration for the plugin system.
|
|
170
136
|
* The generic R parameter enables compile-time type safety when provided.
|
package/dist/types.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AACxD,OAAO,KAAK,EAAE,OAAO,EAAE,
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AACxD,OAAO,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAC1D,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAC;AACpC,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAC7B,OAAO,KAAK,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AACxD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAE/C;;;;GAIG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC,iBAAiB,EAAE,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;AAEnF;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE;IAC5C,QAAQ,EAAE,iBAAiB,CAAC;IAC5B,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC,UAAU,CAAC,CAAC;CACrD,CAAC,CAAC;AAEH;;;GAGG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,IACpB,CAAC,SAAS;IAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;IAAC,MAAM,EAAE,MAAM,IAAI,CAAA;CAAE,GACjD,IAAI,SAAS,eAAe,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,GAC9C,CAAC,SAAS,iBAAiB,GAC3B,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC,GACxB,KAAK,GACL,KAAK,GACL,KAAK,CAAC;AAEV;;;GAGG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC;AAE/D;;;GAGG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,SAAS,SAAS,IAAI,UAAU,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC;AAE1E;;;GAGG;AACH,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS,SAAS,IAAI,CAAC,SAAS,MAAM,CAAC,iBAAiB,EAAE,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC,UAAU,EAAE,MAAM,QAAQ,CAAC,GAAG,QAAQ,GAAG,KAAK,CAAC;AAEhJ;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;AAE5D;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;CAC/B,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,YAAY,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS;IAC3D,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;IAC3B,QAAQ,CAAC,QAAQ,EAAE,cAAc,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,cAAc,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS;IAC7D,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;IACnB,QAAQ,CAAC,QAAQ,EAAE,cAAc,CAAC;CACnC;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS;IAChE,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;IACnB,QAAQ,CAAC,QAAQ,EAAE,cAAc,CAAC;IAClC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC;IAC5C,QAAQ,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;IAC/B,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,cAAc,CAAC;CACtC;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAI7B,2CAA2C;IAC3C,SAAS,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,MAAM,CAAC;IACzC,uCAAuC;IACvC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,2CAA2C;IAC3C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,6CAA6C;IAC7C,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,2BAA2B;IAC3B,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,gCAAgC;IAChC,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS;IAC1D,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;IACjE,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;IAC7B,QAAQ,CAAC,QAAQ,EAAE,cAAc,CAAC;IAClC,QAAQ,CAAC,WAAW,EAAE,iBAAiB,CAAC,CAAC,CAAC,CAAC;CAC5C;AAED;;GAEG;AACH,yBAAiB,WAAW,CAAC;IAC3B;;;;;;;;;;OAUG;IACH,KAAY,KAAK,CACf,CAAC,SAAS,aAAa,CAAC,GAAG,CAAC,EAC5B,CAAC,SAAS,CAAC,SAAS,aAAa,CAAC,MAAM,CAAC,CAAC,GAAG,MAAM,CAAC,GAAG,KAAK,IAC1D,CAAC,SAAS,aAAa,CAAC,MAAM,CAAC,CAAC,GAChC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAC3B,KAAK,CAAC;CACX;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB,CAAC,CAAC,SAAS,gBAAgB,GAAG,gBAAgB;IAChF,QAAQ,EAAE,cAAc,CAAC;IACzB,OAAO,CAAC,EAAE,aAAa,CAAC;IACxB,OAAO,CAAC,EAAE,cAAc,CAAC;CAC1B"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "every-plugin",
|
|
3
|
-
"version": "0.1
|
|
3
|
+
"version": "0.2.1",
|
|
4
4
|
"main": "dist/index.js",
|
|
5
5
|
"types": "dist/index.d.ts",
|
|
6
6
|
"exports": {
|
|
@@ -59,6 +59,9 @@
|
|
|
59
59
|
"devDependencies": {
|
|
60
60
|
"@effect/language-service": "^0.38.1",
|
|
61
61
|
"@effect/vitest": "^0.25.1",
|
|
62
|
+
"@orpc/client": "^1.9.2",
|
|
63
|
+
"@orpc/openapi": "^1.9.2",
|
|
64
|
+
"@orpc/zod": "^1.9.2",
|
|
62
65
|
"@rspack/cli": "^1.5.2",
|
|
63
66
|
"@rspack/core": "^1.5.2",
|
|
64
67
|
"@types/bun": "^1.2.21",
|