@smplkit/sdk 1.3.38 → 1.3.40
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/README.md +148 -27
- package/dist/index.cjs +164 -71
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +149 -42
- package/dist/index.d.ts +149 -42
- package/dist/index.js +161 -71
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -176,6 +176,27 @@ interface ConfigChangeEvent {
|
|
|
176
176
|
/** How the change was delivered. */
|
|
177
177
|
source: "websocket" | "manual";
|
|
178
178
|
}
|
|
179
|
+
/**
|
|
180
|
+
* Management API for smplkit Config — CRUD operations on Config models.
|
|
181
|
+
*
|
|
182
|
+
* Access via `SmplClient.config.management`.
|
|
183
|
+
*/
|
|
184
|
+
declare class ConfigManagement {
|
|
185
|
+
private readonly _client;
|
|
186
|
+
constructor(_client: ConfigClient);
|
|
187
|
+
/** Create an unsaved config. Call `.save()` to persist. */
|
|
188
|
+
new(id: string, options?: {
|
|
189
|
+
name?: string;
|
|
190
|
+
description?: string;
|
|
191
|
+
parent?: string;
|
|
192
|
+
}): Config;
|
|
193
|
+
/** Fetch a config by id. */
|
|
194
|
+
get(id: string): Promise<Config>;
|
|
195
|
+
/** List all configs. */
|
|
196
|
+
list(): Promise<Config[]>;
|
|
197
|
+
/** Delete a config by id. */
|
|
198
|
+
delete(id: string): Promise<void>;
|
|
199
|
+
}
|
|
179
200
|
/**
|
|
180
201
|
* Client for the smplkit Config API.
|
|
181
202
|
*
|
|
@@ -196,23 +217,23 @@ declare class ConfigClient {
|
|
|
196
217
|
readonly _service: string | null;
|
|
197
218
|
readonly _metrics: MetricsReporter | null;
|
|
198
219
|
} | null;
|
|
220
|
+
/** Management API — CRUD operations on Config models. */
|
|
221
|
+
readonly management: ConfigManagement;
|
|
199
222
|
private _configCache;
|
|
200
223
|
private _initialized;
|
|
201
224
|
private _listeners;
|
|
202
225
|
/** @internal */
|
|
203
226
|
constructor(apiKey: string, timeout?: number);
|
|
204
|
-
/**
|
|
205
|
-
|
|
227
|
+
/** @internal */
|
|
228
|
+
_mgNew(id: string, options?: {
|
|
206
229
|
name?: string;
|
|
207
230
|
description?: string;
|
|
208
231
|
parent?: string;
|
|
209
232
|
}): Config;
|
|
210
|
-
/**
|
|
211
|
-
|
|
212
|
-
/**
|
|
213
|
-
|
|
214
|
-
/** Delete a config by id. */
|
|
215
|
-
delete(id: string): Promise<void>;
|
|
233
|
+
/** @internal */
|
|
234
|
+
_mgList(): Promise<Config[]>;
|
|
235
|
+
/** @internal */
|
|
236
|
+
_mgDelete(id: string): Promise<void>;
|
|
216
237
|
/** @internal — POST a new config. */
|
|
217
238
|
_createConfig(config: Config): Promise<Config>;
|
|
218
239
|
/** @internal — PUT a config update. */
|
|
@@ -220,12 +241,12 @@ declare class ConfigClient {
|
|
|
220
241
|
/** @internal — fetch a config by id. */
|
|
221
242
|
_getById(id: string): Promise<Config>;
|
|
222
243
|
/**
|
|
223
|
-
*
|
|
244
|
+
* Get a config's resolved values for the current environment.
|
|
224
245
|
*
|
|
225
246
|
* Returns the resolved key-value pairs for the given config.
|
|
226
247
|
* Optionally pass a model class to map the resolved values.
|
|
227
248
|
*/
|
|
228
|
-
|
|
249
|
+
get<T = Record<string, unknown>>(id: string, model?: new (data: any) => T): Promise<T>;
|
|
229
250
|
/**
|
|
230
251
|
* Subscribe to a config's values. Returns a proxy whose properties
|
|
231
252
|
* always reflect the latest resolved values.
|
|
@@ -645,6 +666,57 @@ declare class FlagStats {
|
|
|
645
666
|
readonly cacheMisses: number;
|
|
646
667
|
constructor(cacheHits: number, cacheMisses: number);
|
|
647
668
|
}
|
|
669
|
+
/**
|
|
670
|
+
* Management API for smplkit Flags — CRUD operations on Flag models.
|
|
671
|
+
*
|
|
672
|
+
* Access via `SmplClient.flags.management`.
|
|
673
|
+
*/
|
|
674
|
+
declare class FlagsManagement {
|
|
675
|
+
private readonly _client;
|
|
676
|
+
constructor(_client: FlagsClient);
|
|
677
|
+
/** Create an unsaved boolean flag. Call `.save()` to persist. */
|
|
678
|
+
newBooleanFlag(id: string, options: {
|
|
679
|
+
default: boolean;
|
|
680
|
+
name?: string;
|
|
681
|
+
description?: string;
|
|
682
|
+
}): BooleanFlag;
|
|
683
|
+
/** Create an unsaved string flag. Call `.save()` to persist. */
|
|
684
|
+
newStringFlag(id: string, options: {
|
|
685
|
+
default: string;
|
|
686
|
+
name?: string;
|
|
687
|
+
description?: string;
|
|
688
|
+
values?: Array<{
|
|
689
|
+
name: string;
|
|
690
|
+
value: unknown;
|
|
691
|
+
}>;
|
|
692
|
+
}): StringFlag;
|
|
693
|
+
/** Create an unsaved number flag. Call `.save()` to persist. */
|
|
694
|
+
newNumberFlag(id: string, options: {
|
|
695
|
+
default: number;
|
|
696
|
+
name?: string;
|
|
697
|
+
description?: string;
|
|
698
|
+
values?: Array<{
|
|
699
|
+
name: string;
|
|
700
|
+
value: unknown;
|
|
701
|
+
}>;
|
|
702
|
+
}): NumberFlag;
|
|
703
|
+
/** Create an unsaved JSON flag. Call `.save()` to persist. */
|
|
704
|
+
newJsonFlag(id: string, options: {
|
|
705
|
+
default: Record<string, any>;
|
|
706
|
+
name?: string;
|
|
707
|
+
description?: string;
|
|
708
|
+
values?: Array<{
|
|
709
|
+
name: string;
|
|
710
|
+
value: unknown;
|
|
711
|
+
}>;
|
|
712
|
+
}): JsonFlag;
|
|
713
|
+
/** Fetch a flag by id. */
|
|
714
|
+
get(id: string): Promise<Flag>;
|
|
715
|
+
/** List all flags. */
|
|
716
|
+
list(): Promise<Flag[]>;
|
|
717
|
+
/** Delete a flag by id. */
|
|
718
|
+
delete(id: string): Promise<void>;
|
|
719
|
+
}
|
|
648
720
|
/**
|
|
649
721
|
* Client for the smplkit Flags API.
|
|
650
722
|
*
|
|
@@ -676,16 +748,18 @@ declare class FlagsClient {
|
|
|
676
748
|
readonly _service: string | null;
|
|
677
749
|
readonly _metrics: MetricsReporter | null;
|
|
678
750
|
} | null;
|
|
751
|
+
/** Management API — CRUD operations on Flag models. */
|
|
752
|
+
readonly management: FlagsManagement;
|
|
679
753
|
/** @internal */
|
|
680
754
|
constructor(apiKey: string, ensureWs: () => SharedWebSocket, timeout?: number);
|
|
681
|
-
/**
|
|
682
|
-
|
|
755
|
+
/** @internal */
|
|
756
|
+
_mgNewBooleanFlag(id: string, options: {
|
|
683
757
|
default: boolean;
|
|
684
758
|
name?: string;
|
|
685
759
|
description?: string;
|
|
686
760
|
}): BooleanFlag;
|
|
687
|
-
/**
|
|
688
|
-
|
|
761
|
+
/** @internal */
|
|
762
|
+
_mgNewStringFlag(id: string, options: {
|
|
689
763
|
default: string;
|
|
690
764
|
name?: string;
|
|
691
765
|
description?: string;
|
|
@@ -694,8 +768,8 @@ declare class FlagsClient {
|
|
|
694
768
|
value: unknown;
|
|
695
769
|
}>;
|
|
696
770
|
}): StringFlag;
|
|
697
|
-
/**
|
|
698
|
-
|
|
771
|
+
/** @internal */
|
|
772
|
+
_mgNewNumberFlag(id: string, options: {
|
|
699
773
|
default: number;
|
|
700
774
|
name?: string;
|
|
701
775
|
description?: string;
|
|
@@ -704,8 +778,8 @@ declare class FlagsClient {
|
|
|
704
778
|
value: unknown;
|
|
705
779
|
}>;
|
|
706
780
|
}): NumberFlag;
|
|
707
|
-
/**
|
|
708
|
-
|
|
781
|
+
/** @internal */
|
|
782
|
+
_mgNewJsonFlag(id: string, options: {
|
|
709
783
|
default: Record<string, any>;
|
|
710
784
|
name?: string;
|
|
711
785
|
description?: string;
|
|
@@ -714,12 +788,12 @@ declare class FlagsClient {
|
|
|
714
788
|
value: unknown;
|
|
715
789
|
}>;
|
|
716
790
|
}): JsonFlag;
|
|
717
|
-
/**
|
|
718
|
-
|
|
719
|
-
/**
|
|
720
|
-
|
|
721
|
-
/**
|
|
722
|
-
|
|
791
|
+
/** @internal */
|
|
792
|
+
_mgGet(id: string): Promise<Flag>;
|
|
793
|
+
/** @internal */
|
|
794
|
+
_mgList(): Promise<Flag[]>;
|
|
795
|
+
/** @internal */
|
|
796
|
+
_mgDelete(id: string): Promise<void>;
|
|
723
797
|
/** @internal — POST a new flag. */
|
|
724
798
|
_createFlag(flag: Flag): Promise<Flag>;
|
|
725
799
|
/** @internal — PUT a flag update. */
|
|
@@ -966,6 +1040,37 @@ interface LoggingAdapter {
|
|
|
966
1040
|
* LoggingClient — management and runtime for Smpl Logging.
|
|
967
1041
|
*/
|
|
968
1042
|
|
|
1043
|
+
/**
|
|
1044
|
+
* Management API for smplkit Logging — CRUD operations on Logger and LogGroup models.
|
|
1045
|
+
*
|
|
1046
|
+
* Access via `SmplClient.logging.management`.
|
|
1047
|
+
*/
|
|
1048
|
+
declare class LoggingManagement {
|
|
1049
|
+
private readonly _client;
|
|
1050
|
+
constructor(_client: LoggingClient);
|
|
1051
|
+
/** Create an unsaved logger. Call `.save()` to persist. */
|
|
1052
|
+
new(id: string, options?: {
|
|
1053
|
+
name?: string;
|
|
1054
|
+
managed?: boolean;
|
|
1055
|
+
}): Logger;
|
|
1056
|
+
/** Fetch a logger by id. */
|
|
1057
|
+
get(id: string): Promise<Logger>;
|
|
1058
|
+
/** List all loggers. */
|
|
1059
|
+
list(): Promise<Logger[]>;
|
|
1060
|
+
/** Delete a logger by id. */
|
|
1061
|
+
delete(id: string): Promise<void>;
|
|
1062
|
+
/** Create an unsaved log group. Call `.save()` to persist. */
|
|
1063
|
+
newGroup(id: string, options?: {
|
|
1064
|
+
name?: string;
|
|
1065
|
+
group?: string;
|
|
1066
|
+
}): LogGroup;
|
|
1067
|
+
/** Fetch a log group by id. */
|
|
1068
|
+
getGroup(id: string): Promise<LogGroup>;
|
|
1069
|
+
/** List all log groups. */
|
|
1070
|
+
listGroups(): Promise<LogGroup[]>;
|
|
1071
|
+
/** Delete a log group by id. */
|
|
1072
|
+
deleteGroup(id: string): Promise<void>;
|
|
1073
|
+
}
|
|
969
1074
|
/**
|
|
970
1075
|
* Client for the smplkit Logging API.
|
|
971
1076
|
*
|
|
@@ -984,6 +1089,8 @@ declare class LoggingClient {
|
|
|
984
1089
|
readonly _service: string | null;
|
|
985
1090
|
readonly _metrics: MetricsReporter | null;
|
|
986
1091
|
} | null;
|
|
1092
|
+
/** Management API — CRUD operations on Logger and LogGroup models. */
|
|
1093
|
+
readonly management: LoggingManagement;
|
|
987
1094
|
private readonly _ensureWs;
|
|
988
1095
|
private _wsManager;
|
|
989
1096
|
private _started;
|
|
@@ -1000,28 +1107,28 @@ declare class LoggingClient {
|
|
|
1000
1107
|
* registered adapters will be used.
|
|
1001
1108
|
*/
|
|
1002
1109
|
registerAdapter(adapter: LoggingAdapter): void;
|
|
1003
|
-
/**
|
|
1004
|
-
|
|
1110
|
+
/** @internal */
|
|
1111
|
+
_mgNew(id: string, options?: {
|
|
1005
1112
|
name?: string;
|
|
1006
1113
|
managed?: boolean;
|
|
1007
1114
|
}): Logger;
|
|
1008
|
-
/**
|
|
1009
|
-
|
|
1010
|
-
/**
|
|
1011
|
-
|
|
1012
|
-
/**
|
|
1013
|
-
|
|
1014
|
-
/**
|
|
1015
|
-
|
|
1115
|
+
/** @internal */
|
|
1116
|
+
_mgGet(id: string): Promise<Logger>;
|
|
1117
|
+
/** @internal */
|
|
1118
|
+
_mgList(): Promise<Logger[]>;
|
|
1119
|
+
/** @internal */
|
|
1120
|
+
_mgDelete(id: string): Promise<void>;
|
|
1121
|
+
/** @internal */
|
|
1122
|
+
_mgNewGroup(id: string, options?: {
|
|
1016
1123
|
name?: string;
|
|
1017
1124
|
group?: string;
|
|
1018
1125
|
}): LogGroup;
|
|
1019
|
-
/**
|
|
1020
|
-
|
|
1021
|
-
/**
|
|
1022
|
-
|
|
1023
|
-
/**
|
|
1024
|
-
|
|
1126
|
+
/** @internal */
|
|
1127
|
+
_mgGetGroup(id: string): Promise<LogGroup>;
|
|
1128
|
+
/** @internal */
|
|
1129
|
+
_mgListGroups(): Promise<LogGroup[]>;
|
|
1130
|
+
/** @internal */
|
|
1131
|
+
_mgDeleteGroup(id: string): Promise<void>;
|
|
1025
1132
|
/** @internal — POST or PUT a logger. */
|
|
1026
1133
|
_saveLogger(logger: Logger): Promise<Logger>;
|
|
1027
1134
|
/** @internal — POST or PUT a log group. */
|
|
@@ -1111,7 +1218,7 @@ interface SmplClientOptions {
|
|
|
1111
1218
|
* console.log(flag.get());
|
|
1112
1219
|
*
|
|
1113
1220
|
* // Config runtime
|
|
1114
|
-
* const values = await client.config.
|
|
1221
|
+
* const values = await client.config.get("user-service");
|
|
1115
1222
|
* ```
|
|
1116
1223
|
*/
|
|
1117
1224
|
declare class SmplClient {
|
|
@@ -1238,4 +1345,4 @@ declare class SmplValidationError extends SmplError {
|
|
|
1238
1345
|
constructor(message: string, statusCode?: number, responseBody?: string, errors?: ApiErrorObject[]);
|
|
1239
1346
|
}
|
|
1240
1347
|
|
|
1241
|
-
export { type ApiErrorObject, BooleanFlag, Config, type ConfigChangeEvent, ConfigClient, Context, Flag, FlagChangeEvent, FlagStats, FlagsClient, JsonFlag, LiveConfigProxy, LogGroup, LogLevel, Logger, type LoggerChangeEvent, type LoggingAdapter, LoggingClient, NumberFlag, PinoAdapter, type PinoAdapterConfig, Rule, SharedWebSocket, SmplClient, type SmplClientOptions, SmplConflictError, SmplConnectionError, SmplError, SmplNotFoundError, SmplTimeoutError, SmplValidationError, StringFlag, WinstonAdapter, type WinstonAdapterConfig };
|
|
1348
|
+
export { type ApiErrorObject, BooleanFlag, Config, type ConfigChangeEvent, ConfigClient, ConfigManagement, Context, Flag, FlagChangeEvent, FlagStats, FlagsClient, FlagsManagement, JsonFlag, LiveConfigProxy, LogGroup, LogLevel, Logger, type LoggerChangeEvent, type LoggingAdapter, LoggingClient, LoggingManagement, NumberFlag, PinoAdapter, type PinoAdapterConfig, Rule, SharedWebSocket, SmplClient, type SmplClientOptions, SmplConflictError, SmplConnectionError, SmplError, SmplNotFoundError, SmplTimeoutError, SmplValidationError, StringFlag, WinstonAdapter, type WinstonAdapterConfig };
|
package/dist/index.d.ts
CHANGED
|
@@ -176,6 +176,27 @@ interface ConfigChangeEvent {
|
|
|
176
176
|
/** How the change was delivered. */
|
|
177
177
|
source: "websocket" | "manual";
|
|
178
178
|
}
|
|
179
|
+
/**
|
|
180
|
+
* Management API for smplkit Config — CRUD operations on Config models.
|
|
181
|
+
*
|
|
182
|
+
* Access via `SmplClient.config.management`.
|
|
183
|
+
*/
|
|
184
|
+
declare class ConfigManagement {
|
|
185
|
+
private readonly _client;
|
|
186
|
+
constructor(_client: ConfigClient);
|
|
187
|
+
/** Create an unsaved config. Call `.save()` to persist. */
|
|
188
|
+
new(id: string, options?: {
|
|
189
|
+
name?: string;
|
|
190
|
+
description?: string;
|
|
191
|
+
parent?: string;
|
|
192
|
+
}): Config;
|
|
193
|
+
/** Fetch a config by id. */
|
|
194
|
+
get(id: string): Promise<Config>;
|
|
195
|
+
/** List all configs. */
|
|
196
|
+
list(): Promise<Config[]>;
|
|
197
|
+
/** Delete a config by id. */
|
|
198
|
+
delete(id: string): Promise<void>;
|
|
199
|
+
}
|
|
179
200
|
/**
|
|
180
201
|
* Client for the smplkit Config API.
|
|
181
202
|
*
|
|
@@ -196,23 +217,23 @@ declare class ConfigClient {
|
|
|
196
217
|
readonly _service: string | null;
|
|
197
218
|
readonly _metrics: MetricsReporter | null;
|
|
198
219
|
} | null;
|
|
220
|
+
/** Management API — CRUD operations on Config models. */
|
|
221
|
+
readonly management: ConfigManagement;
|
|
199
222
|
private _configCache;
|
|
200
223
|
private _initialized;
|
|
201
224
|
private _listeners;
|
|
202
225
|
/** @internal */
|
|
203
226
|
constructor(apiKey: string, timeout?: number);
|
|
204
|
-
/**
|
|
205
|
-
|
|
227
|
+
/** @internal */
|
|
228
|
+
_mgNew(id: string, options?: {
|
|
206
229
|
name?: string;
|
|
207
230
|
description?: string;
|
|
208
231
|
parent?: string;
|
|
209
232
|
}): Config;
|
|
210
|
-
/**
|
|
211
|
-
|
|
212
|
-
/**
|
|
213
|
-
|
|
214
|
-
/** Delete a config by id. */
|
|
215
|
-
delete(id: string): Promise<void>;
|
|
233
|
+
/** @internal */
|
|
234
|
+
_mgList(): Promise<Config[]>;
|
|
235
|
+
/** @internal */
|
|
236
|
+
_mgDelete(id: string): Promise<void>;
|
|
216
237
|
/** @internal — POST a new config. */
|
|
217
238
|
_createConfig(config: Config): Promise<Config>;
|
|
218
239
|
/** @internal — PUT a config update. */
|
|
@@ -220,12 +241,12 @@ declare class ConfigClient {
|
|
|
220
241
|
/** @internal — fetch a config by id. */
|
|
221
242
|
_getById(id: string): Promise<Config>;
|
|
222
243
|
/**
|
|
223
|
-
*
|
|
244
|
+
* Get a config's resolved values for the current environment.
|
|
224
245
|
*
|
|
225
246
|
* Returns the resolved key-value pairs for the given config.
|
|
226
247
|
* Optionally pass a model class to map the resolved values.
|
|
227
248
|
*/
|
|
228
|
-
|
|
249
|
+
get<T = Record<string, unknown>>(id: string, model?: new (data: any) => T): Promise<T>;
|
|
229
250
|
/**
|
|
230
251
|
* Subscribe to a config's values. Returns a proxy whose properties
|
|
231
252
|
* always reflect the latest resolved values.
|
|
@@ -645,6 +666,57 @@ declare class FlagStats {
|
|
|
645
666
|
readonly cacheMisses: number;
|
|
646
667
|
constructor(cacheHits: number, cacheMisses: number);
|
|
647
668
|
}
|
|
669
|
+
/**
|
|
670
|
+
* Management API for smplkit Flags — CRUD operations on Flag models.
|
|
671
|
+
*
|
|
672
|
+
* Access via `SmplClient.flags.management`.
|
|
673
|
+
*/
|
|
674
|
+
declare class FlagsManagement {
|
|
675
|
+
private readonly _client;
|
|
676
|
+
constructor(_client: FlagsClient);
|
|
677
|
+
/** Create an unsaved boolean flag. Call `.save()` to persist. */
|
|
678
|
+
newBooleanFlag(id: string, options: {
|
|
679
|
+
default: boolean;
|
|
680
|
+
name?: string;
|
|
681
|
+
description?: string;
|
|
682
|
+
}): BooleanFlag;
|
|
683
|
+
/** Create an unsaved string flag. Call `.save()` to persist. */
|
|
684
|
+
newStringFlag(id: string, options: {
|
|
685
|
+
default: string;
|
|
686
|
+
name?: string;
|
|
687
|
+
description?: string;
|
|
688
|
+
values?: Array<{
|
|
689
|
+
name: string;
|
|
690
|
+
value: unknown;
|
|
691
|
+
}>;
|
|
692
|
+
}): StringFlag;
|
|
693
|
+
/** Create an unsaved number flag. Call `.save()` to persist. */
|
|
694
|
+
newNumberFlag(id: string, options: {
|
|
695
|
+
default: number;
|
|
696
|
+
name?: string;
|
|
697
|
+
description?: string;
|
|
698
|
+
values?: Array<{
|
|
699
|
+
name: string;
|
|
700
|
+
value: unknown;
|
|
701
|
+
}>;
|
|
702
|
+
}): NumberFlag;
|
|
703
|
+
/** Create an unsaved JSON flag. Call `.save()` to persist. */
|
|
704
|
+
newJsonFlag(id: string, options: {
|
|
705
|
+
default: Record<string, any>;
|
|
706
|
+
name?: string;
|
|
707
|
+
description?: string;
|
|
708
|
+
values?: Array<{
|
|
709
|
+
name: string;
|
|
710
|
+
value: unknown;
|
|
711
|
+
}>;
|
|
712
|
+
}): JsonFlag;
|
|
713
|
+
/** Fetch a flag by id. */
|
|
714
|
+
get(id: string): Promise<Flag>;
|
|
715
|
+
/** List all flags. */
|
|
716
|
+
list(): Promise<Flag[]>;
|
|
717
|
+
/** Delete a flag by id. */
|
|
718
|
+
delete(id: string): Promise<void>;
|
|
719
|
+
}
|
|
648
720
|
/**
|
|
649
721
|
* Client for the smplkit Flags API.
|
|
650
722
|
*
|
|
@@ -676,16 +748,18 @@ declare class FlagsClient {
|
|
|
676
748
|
readonly _service: string | null;
|
|
677
749
|
readonly _metrics: MetricsReporter | null;
|
|
678
750
|
} | null;
|
|
751
|
+
/** Management API — CRUD operations on Flag models. */
|
|
752
|
+
readonly management: FlagsManagement;
|
|
679
753
|
/** @internal */
|
|
680
754
|
constructor(apiKey: string, ensureWs: () => SharedWebSocket, timeout?: number);
|
|
681
|
-
/**
|
|
682
|
-
|
|
755
|
+
/** @internal */
|
|
756
|
+
_mgNewBooleanFlag(id: string, options: {
|
|
683
757
|
default: boolean;
|
|
684
758
|
name?: string;
|
|
685
759
|
description?: string;
|
|
686
760
|
}): BooleanFlag;
|
|
687
|
-
/**
|
|
688
|
-
|
|
761
|
+
/** @internal */
|
|
762
|
+
_mgNewStringFlag(id: string, options: {
|
|
689
763
|
default: string;
|
|
690
764
|
name?: string;
|
|
691
765
|
description?: string;
|
|
@@ -694,8 +768,8 @@ declare class FlagsClient {
|
|
|
694
768
|
value: unknown;
|
|
695
769
|
}>;
|
|
696
770
|
}): StringFlag;
|
|
697
|
-
/**
|
|
698
|
-
|
|
771
|
+
/** @internal */
|
|
772
|
+
_mgNewNumberFlag(id: string, options: {
|
|
699
773
|
default: number;
|
|
700
774
|
name?: string;
|
|
701
775
|
description?: string;
|
|
@@ -704,8 +778,8 @@ declare class FlagsClient {
|
|
|
704
778
|
value: unknown;
|
|
705
779
|
}>;
|
|
706
780
|
}): NumberFlag;
|
|
707
|
-
/**
|
|
708
|
-
|
|
781
|
+
/** @internal */
|
|
782
|
+
_mgNewJsonFlag(id: string, options: {
|
|
709
783
|
default: Record<string, any>;
|
|
710
784
|
name?: string;
|
|
711
785
|
description?: string;
|
|
@@ -714,12 +788,12 @@ declare class FlagsClient {
|
|
|
714
788
|
value: unknown;
|
|
715
789
|
}>;
|
|
716
790
|
}): JsonFlag;
|
|
717
|
-
/**
|
|
718
|
-
|
|
719
|
-
/**
|
|
720
|
-
|
|
721
|
-
/**
|
|
722
|
-
|
|
791
|
+
/** @internal */
|
|
792
|
+
_mgGet(id: string): Promise<Flag>;
|
|
793
|
+
/** @internal */
|
|
794
|
+
_mgList(): Promise<Flag[]>;
|
|
795
|
+
/** @internal */
|
|
796
|
+
_mgDelete(id: string): Promise<void>;
|
|
723
797
|
/** @internal — POST a new flag. */
|
|
724
798
|
_createFlag(flag: Flag): Promise<Flag>;
|
|
725
799
|
/** @internal — PUT a flag update. */
|
|
@@ -966,6 +1040,37 @@ interface LoggingAdapter {
|
|
|
966
1040
|
* LoggingClient — management and runtime for Smpl Logging.
|
|
967
1041
|
*/
|
|
968
1042
|
|
|
1043
|
+
/**
|
|
1044
|
+
* Management API for smplkit Logging — CRUD operations on Logger and LogGroup models.
|
|
1045
|
+
*
|
|
1046
|
+
* Access via `SmplClient.logging.management`.
|
|
1047
|
+
*/
|
|
1048
|
+
declare class LoggingManagement {
|
|
1049
|
+
private readonly _client;
|
|
1050
|
+
constructor(_client: LoggingClient);
|
|
1051
|
+
/** Create an unsaved logger. Call `.save()` to persist. */
|
|
1052
|
+
new(id: string, options?: {
|
|
1053
|
+
name?: string;
|
|
1054
|
+
managed?: boolean;
|
|
1055
|
+
}): Logger;
|
|
1056
|
+
/** Fetch a logger by id. */
|
|
1057
|
+
get(id: string): Promise<Logger>;
|
|
1058
|
+
/** List all loggers. */
|
|
1059
|
+
list(): Promise<Logger[]>;
|
|
1060
|
+
/** Delete a logger by id. */
|
|
1061
|
+
delete(id: string): Promise<void>;
|
|
1062
|
+
/** Create an unsaved log group. Call `.save()` to persist. */
|
|
1063
|
+
newGroup(id: string, options?: {
|
|
1064
|
+
name?: string;
|
|
1065
|
+
group?: string;
|
|
1066
|
+
}): LogGroup;
|
|
1067
|
+
/** Fetch a log group by id. */
|
|
1068
|
+
getGroup(id: string): Promise<LogGroup>;
|
|
1069
|
+
/** List all log groups. */
|
|
1070
|
+
listGroups(): Promise<LogGroup[]>;
|
|
1071
|
+
/** Delete a log group by id. */
|
|
1072
|
+
deleteGroup(id: string): Promise<void>;
|
|
1073
|
+
}
|
|
969
1074
|
/**
|
|
970
1075
|
* Client for the smplkit Logging API.
|
|
971
1076
|
*
|
|
@@ -984,6 +1089,8 @@ declare class LoggingClient {
|
|
|
984
1089
|
readonly _service: string | null;
|
|
985
1090
|
readonly _metrics: MetricsReporter | null;
|
|
986
1091
|
} | null;
|
|
1092
|
+
/** Management API — CRUD operations on Logger and LogGroup models. */
|
|
1093
|
+
readonly management: LoggingManagement;
|
|
987
1094
|
private readonly _ensureWs;
|
|
988
1095
|
private _wsManager;
|
|
989
1096
|
private _started;
|
|
@@ -1000,28 +1107,28 @@ declare class LoggingClient {
|
|
|
1000
1107
|
* registered adapters will be used.
|
|
1001
1108
|
*/
|
|
1002
1109
|
registerAdapter(adapter: LoggingAdapter): void;
|
|
1003
|
-
/**
|
|
1004
|
-
|
|
1110
|
+
/** @internal */
|
|
1111
|
+
_mgNew(id: string, options?: {
|
|
1005
1112
|
name?: string;
|
|
1006
1113
|
managed?: boolean;
|
|
1007
1114
|
}): Logger;
|
|
1008
|
-
/**
|
|
1009
|
-
|
|
1010
|
-
/**
|
|
1011
|
-
|
|
1012
|
-
/**
|
|
1013
|
-
|
|
1014
|
-
/**
|
|
1015
|
-
|
|
1115
|
+
/** @internal */
|
|
1116
|
+
_mgGet(id: string): Promise<Logger>;
|
|
1117
|
+
/** @internal */
|
|
1118
|
+
_mgList(): Promise<Logger[]>;
|
|
1119
|
+
/** @internal */
|
|
1120
|
+
_mgDelete(id: string): Promise<void>;
|
|
1121
|
+
/** @internal */
|
|
1122
|
+
_mgNewGroup(id: string, options?: {
|
|
1016
1123
|
name?: string;
|
|
1017
1124
|
group?: string;
|
|
1018
1125
|
}): LogGroup;
|
|
1019
|
-
/**
|
|
1020
|
-
|
|
1021
|
-
/**
|
|
1022
|
-
|
|
1023
|
-
/**
|
|
1024
|
-
|
|
1126
|
+
/** @internal */
|
|
1127
|
+
_mgGetGroup(id: string): Promise<LogGroup>;
|
|
1128
|
+
/** @internal */
|
|
1129
|
+
_mgListGroups(): Promise<LogGroup[]>;
|
|
1130
|
+
/** @internal */
|
|
1131
|
+
_mgDeleteGroup(id: string): Promise<void>;
|
|
1025
1132
|
/** @internal — POST or PUT a logger. */
|
|
1026
1133
|
_saveLogger(logger: Logger): Promise<Logger>;
|
|
1027
1134
|
/** @internal — POST or PUT a log group. */
|
|
@@ -1111,7 +1218,7 @@ interface SmplClientOptions {
|
|
|
1111
1218
|
* console.log(flag.get());
|
|
1112
1219
|
*
|
|
1113
1220
|
* // Config runtime
|
|
1114
|
-
* const values = await client.config.
|
|
1221
|
+
* const values = await client.config.get("user-service");
|
|
1115
1222
|
* ```
|
|
1116
1223
|
*/
|
|
1117
1224
|
declare class SmplClient {
|
|
@@ -1238,4 +1345,4 @@ declare class SmplValidationError extends SmplError {
|
|
|
1238
1345
|
constructor(message: string, statusCode?: number, responseBody?: string, errors?: ApiErrorObject[]);
|
|
1239
1346
|
}
|
|
1240
1347
|
|
|
1241
|
-
export { type ApiErrorObject, BooleanFlag, Config, type ConfigChangeEvent, ConfigClient, Context, Flag, FlagChangeEvent, FlagStats, FlagsClient, JsonFlag, LiveConfigProxy, LogGroup, LogLevel, Logger, type LoggerChangeEvent, type LoggingAdapter, LoggingClient, NumberFlag, PinoAdapter, type PinoAdapterConfig, Rule, SharedWebSocket, SmplClient, type SmplClientOptions, SmplConflictError, SmplConnectionError, SmplError, SmplNotFoundError, SmplTimeoutError, SmplValidationError, StringFlag, WinstonAdapter, type WinstonAdapterConfig };
|
|
1348
|
+
export { type ApiErrorObject, BooleanFlag, Config, type ConfigChangeEvent, ConfigClient, ConfigManagement, Context, Flag, FlagChangeEvent, FlagStats, FlagsClient, FlagsManagement, JsonFlag, LiveConfigProxy, LogGroup, LogLevel, Logger, type LoggerChangeEvent, type LoggingAdapter, LoggingClient, LoggingManagement, NumberFlag, PinoAdapter, type PinoAdapterConfig, Rule, SharedWebSocket, SmplClient, type SmplClientOptions, SmplConflictError, SmplConnectionError, SmplError, SmplNotFoundError, SmplTimeoutError, SmplValidationError, StringFlag, WinstonAdapter, type WinstonAdapterConfig };
|