@salesforce/b2c-tooling-sdk 0.0.0-nightly.20260122154743 → 0.0.0-nightly.20260123023856
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/cjs/auth/index.d.ts +2 -0
- package/dist/cjs/auth/index.js +2 -0
- package/dist/cjs/auth/index.js.map +1 -1
- package/dist/cjs/auth/middleware.d.ts +196 -0
- package/dist/cjs/auth/middleware.js +190 -0
- package/dist/cjs/auth/middleware.js.map +1 -0
- package/dist/cjs/auth/oauth.js +21 -9
- package/dist/cjs/auth/oauth.js.map +1 -1
- package/dist/cjs/cli/base-command.d.ts +10 -0
- package/dist/cjs/cli/base-command.js +36 -0
- package/dist/cjs/cli/base-command.js.map +1 -1
- package/dist/cjs/cli/hooks.d.ts +85 -0
- package/dist/cjs/cli/hooks.js.map +1 -1
- package/dist/cjs/clients/index.d.ts +3 -2
- package/dist/cjs/clients/index.js +3 -1
- package/dist/cjs/clients/index.js.map +1 -1
- package/dist/cjs/clients/middleware.d.ts +25 -0
- package/dist/cjs/clients/middleware.js +16 -10
- package/dist/cjs/clients/middleware.js.map +1 -1
- package/dist/cjs/clients/user-agent.d.ts +43 -0
- package/dist/cjs/clients/user-agent.js +87 -0
- package/dist/cjs/clients/user-agent.js.map +1 -0
- package/dist/cjs/index.d.ts +1 -0
- package/dist/cjs/index.js +2 -0
- package/dist/cjs/index.js.map +1 -1
- package/dist/cjs/version.d.ts +14 -0
- package/dist/cjs/version.js +29 -0
- package/dist/cjs/version.js.map +1 -0
- package/dist/esm/auth/index.d.ts +2 -0
- package/dist/esm/auth/index.js +2 -0
- package/dist/esm/auth/index.js.map +1 -1
- package/dist/esm/auth/middleware.d.ts +196 -0
- package/dist/esm/auth/middleware.js +190 -0
- package/dist/esm/auth/middleware.js.map +1 -0
- package/dist/esm/auth/oauth.js +21 -9
- package/dist/esm/auth/oauth.js.map +1 -1
- package/dist/esm/cli/base-command.d.ts +10 -0
- package/dist/esm/cli/base-command.js +36 -0
- package/dist/esm/cli/base-command.js.map +1 -1
- package/dist/esm/cli/hooks.d.ts +85 -0
- package/dist/esm/cli/hooks.js.map +1 -1
- package/dist/esm/clients/index.d.ts +3 -2
- package/dist/esm/clients/index.js +3 -1
- package/dist/esm/clients/index.js.map +1 -1
- package/dist/esm/clients/middleware.d.ts +25 -0
- package/dist/esm/clients/middleware.js +16 -10
- package/dist/esm/clients/middleware.js.map +1 -1
- package/dist/esm/clients/user-agent.d.ts +43 -0
- package/dist/esm/clients/user-agent.js +87 -0
- package/dist/esm/clients/user-agent.js.map +1 -0
- package/dist/esm/index.d.ts +1 -0
- package/dist/esm/index.js +2 -0
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/version.d.ts +14 -0
- package/dist/esm/version.js +29 -0
- package/dist/esm/version.js.map +1 -0
- package/package.json +1 -1
package/dist/esm/cli/hooks.d.ts
CHANGED
|
@@ -30,6 +30,7 @@
|
|
|
30
30
|
import type { Hook } from '@oclif/core';
|
|
31
31
|
import type { ConfigSource, ResolveConfigOptions } from '../config/types.js';
|
|
32
32
|
import type { HttpMiddlewareProvider } from '../clients/middleware-registry.js';
|
|
33
|
+
import type { AuthMiddlewareProvider } from '../auth/middleware.js';
|
|
33
34
|
/**
|
|
34
35
|
* Options passed to the `b2c:config-sources` hook.
|
|
35
36
|
*
|
|
@@ -213,6 +214,86 @@ export interface HttpMiddlewareHookResult {
|
|
|
213
214
|
* ```
|
|
214
215
|
*/
|
|
215
216
|
export type HttpMiddlewareHook = Hook<'b2c:http-middleware'>;
|
|
217
|
+
/**
|
|
218
|
+
* Options passed to the `b2c:auth-middleware` hook.
|
|
219
|
+
*/
|
|
220
|
+
export interface AuthMiddlewareHookOptions {
|
|
221
|
+
/**
|
|
222
|
+
* All parsed CLI flags from the current command.
|
|
223
|
+
*
|
|
224
|
+
* Plugins can inspect flags but cannot add new flags to commands.
|
|
225
|
+
* For plugin-specific configuration, use environment variables instead.
|
|
226
|
+
*/
|
|
227
|
+
flags?: Record<string, unknown>;
|
|
228
|
+
/** Index signature for oclif hook compatibility */
|
|
229
|
+
[key: string]: unknown;
|
|
230
|
+
}
|
|
231
|
+
/**
|
|
232
|
+
* Result returned by the `b2c:auth-middleware` hook.
|
|
233
|
+
*
|
|
234
|
+
* Plugins return one or more AuthMiddlewareProvider instances that will be
|
|
235
|
+
* registered with the global auth middleware registry.
|
|
236
|
+
*/
|
|
237
|
+
export interface AuthMiddlewareHookResult {
|
|
238
|
+
/** Middleware providers to register */
|
|
239
|
+
providers: AuthMiddlewareProvider[];
|
|
240
|
+
}
|
|
241
|
+
/**
|
|
242
|
+
* Hook type for `b2c:auth-middleware`.
|
|
243
|
+
*
|
|
244
|
+
* Implement this hook in your oclif plugin to provide custom middleware
|
|
245
|
+
* that will be applied to OAuth token requests.
|
|
246
|
+
*
|
|
247
|
+
* The hook is called during command initialization, after flags are parsed
|
|
248
|
+
* but before any authentication is performed.
|
|
249
|
+
*
|
|
250
|
+
* ## Plugin Registration
|
|
251
|
+
*
|
|
252
|
+
* Register the hook in your plugin's package.json:
|
|
253
|
+
*
|
|
254
|
+
* ```json
|
|
255
|
+
* {
|
|
256
|
+
* "oclif": {
|
|
257
|
+
* "hooks": {
|
|
258
|
+
* "b2c:auth-middleware": "./dist/hooks/auth-middleware.js"
|
|
259
|
+
* }
|
|
260
|
+
* }
|
|
261
|
+
* }
|
|
262
|
+
* ```
|
|
263
|
+
*
|
|
264
|
+
* ## Hook Context
|
|
265
|
+
*
|
|
266
|
+
* Inside the hook function, you have access to:
|
|
267
|
+
* - `this.config` - oclif Config object
|
|
268
|
+
* - `this.debug()`, `this.log()`, `this.warn()`, `this.error()` - logging methods
|
|
269
|
+
*
|
|
270
|
+
* @example
|
|
271
|
+
* ```typescript
|
|
272
|
+
* import type { AuthMiddlewareHook } from '@salesforce/b2c-tooling-sdk/cli';
|
|
273
|
+
* import type { AuthMiddlewareProvider } from '@salesforce/b2c-tooling-sdk/auth';
|
|
274
|
+
*
|
|
275
|
+
* const hook: AuthMiddlewareHook = async function(options) {
|
|
276
|
+
* this.debug('Registering auth middleware');
|
|
277
|
+
*
|
|
278
|
+
* const userAgentProvider: AuthMiddlewareProvider = {
|
|
279
|
+
* name: 'custom-user-agent',
|
|
280
|
+
* getMiddleware() {
|
|
281
|
+
* return {
|
|
282
|
+
* onRequest({ request }) {
|
|
283
|
+
* request.headers.set('User-Agent', 'my-app/1.0');
|
|
284
|
+
* return request;
|
|
285
|
+
* },
|
|
286
|
+
* };
|
|
287
|
+
* },
|
|
288
|
+
* };
|
|
289
|
+
*
|
|
290
|
+
* return { providers: [userAgentProvider] };
|
|
291
|
+
* };
|
|
292
|
+
*
|
|
293
|
+
* export default hook;
|
|
294
|
+
* ```
|
|
295
|
+
*/
|
|
296
|
+
export type AuthMiddlewareHook = Hook<'b2c:auth-middleware'>;
|
|
216
297
|
export type { B2COperationType, B2COperationContext, BeforeB2COperationResult, B2COperationResult, AfterB2COperationResult, B2COperationLifecycleProvider, B2COperationLifecycleHookOptions, B2COperationLifecycleHookResult, B2COperationLifecycleHook, } from './lifecycle.js';
|
|
217
298
|
export { createB2COperationContext, B2CLifecycleRunner } from './lifecycle.js';
|
|
218
299
|
export type { CartridgeDiscoveryOptions, CartridgeProvider, CartridgeTransformer, CartridgeProvidersHookOptions, CartridgeProvidersHookResult, CartridgeProvidersHook, } from './cartridge-providers.js';
|
|
@@ -227,6 +308,10 @@ declare module '@oclif/core' {
|
|
|
227
308
|
options: HttpMiddlewareHookOptions;
|
|
228
309
|
return: HttpMiddlewareHookResult;
|
|
229
310
|
};
|
|
311
|
+
'b2c:auth-middleware': {
|
|
312
|
+
options: AuthMiddlewareHookOptions;
|
|
313
|
+
return: AuthMiddlewareHookResult;
|
|
314
|
+
};
|
|
230
315
|
'b2c:operation-lifecycle': {
|
|
231
316
|
options: import('./lifecycle.js').B2COperationLifecycleHookOptions;
|
|
232
317
|
return: import('./lifecycle.js').B2COperationLifecycleHookResult;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"hooks.js","sourceRoot":"","sources":["../../../src/cli/hooks.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"hooks.js","sourceRoot":"","sources":["../../../src/cli/hooks.ts"],"names":[],"mappings":"AA2UA,OAAO,EAAC,yBAAyB,EAAE,kBAAkB,EAAC,MAAM,gBAAgB,CAAC;AAW7E,OAAO,EAAC,uBAAuB,EAAC,MAAM,0BAA0B,CAAC"}
|
|
@@ -112,8 +112,9 @@
|
|
|
112
112
|
*/
|
|
113
113
|
export { WebDavClient } from './webdav.js';
|
|
114
114
|
export type { PropfindEntry, WebDavClientOptions } from './webdav.js';
|
|
115
|
-
export { createAuthMiddleware, createLoggingMiddleware, createExtraParamsMiddleware } from './middleware.js';
|
|
116
|
-
export type { ExtraParamsConfig, LoggingMiddlewareConfig } from './middleware.js';
|
|
115
|
+
export { createAuthMiddleware, createLoggingMiddleware, createExtraParamsMiddleware, createUserAgentMiddleware, } from './middleware.js';
|
|
116
|
+
export type { ExtraParamsConfig, LoggingMiddlewareConfig, UserAgentConfig } from './middleware.js';
|
|
117
|
+
export { setUserAgent, getUserAgent, resetUserAgent, userAgentProvider } from './user-agent.js';
|
|
117
118
|
export { MiddlewareRegistry, globalMiddlewareRegistry } from './middleware-registry.js';
|
|
118
119
|
export type { HttpClientType, HttpMiddlewareProvider, UnifiedMiddleware } from './middleware-registry.js';
|
|
119
120
|
export { createOcapiClient } from './ocapi.js';
|
|
@@ -116,7 +116,9 @@
|
|
|
116
116
|
* @module clients
|
|
117
117
|
*/
|
|
118
118
|
export { WebDavClient } from './webdav.js';
|
|
119
|
-
export { createAuthMiddleware, createLoggingMiddleware, createExtraParamsMiddleware } from './middleware.js';
|
|
119
|
+
export { createAuthMiddleware, createLoggingMiddleware, createExtraParamsMiddleware, createUserAgentMiddleware, } from './middleware.js';
|
|
120
|
+
// User-Agent provider (auto-registers on import)
|
|
121
|
+
export { setUserAgent, getUserAgent, resetUserAgent, userAgentProvider } from './user-agent.js';
|
|
120
122
|
export { MiddlewareRegistry, globalMiddlewareRegistry } from './middleware-registry.js';
|
|
121
123
|
export { createOcapiClient } from './ocapi.js';
|
|
122
124
|
export { createSlasClient } from './slas-admin.js';
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/clients/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+GG;AACH,OAAO,EAAC,YAAY,EAAC,MAAM,aAAa,CAAC;AAGzC,OAAO,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/clients/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+GG;AACH,OAAO,EAAC,YAAY,EAAC,MAAM,aAAa,CAAC;AAGzC,OAAO,EACL,oBAAoB,EACpB,uBAAuB,EACvB,2BAA2B,EAC3B,yBAAyB,GAC1B,MAAM,iBAAiB,CAAC;AAGzB,iDAAiD;AACjD,OAAO,EAAC,YAAY,EAAE,YAAY,EAAE,cAAc,EAAE,iBAAiB,EAAC,MAAM,iBAAiB,CAAC;AAE9F,OAAO,EAAC,kBAAkB,EAAE,wBAAwB,EAAC,MAAM,0BAA0B,CAAC;AAGtF,OAAO,EAAC,iBAAiB,EAAC,MAAM,YAAY,CAAC;AAU7C,OAAO,EAAC,gBAAgB,EAAC,MAAM,iBAAiB,CAAC;AAUjD,OAAO,EAAC,eAAe,EAAC,MAAM,UAAU,CAAC;AAUzC,OAAO,EAAC,eAAe,EAAE,kBAAkB,EAAC,MAAM,UAAU,CAAC;AAW7D,OAAO,EACL,sBAAsB,EACtB,gBAAgB,EAChB,UAAU,EACV,gBAAgB,EAChB,sBAAsB,EACtB,yBAAyB,EACzB,0BAA0B,GAC3B,MAAM,kBAAkB,CAAC;AAU1B,OAAO,EAAC,wBAAwB,EAAE,4BAA4B,EAAC,MAAM,oBAAoB,CAAC;AAa1F,OAAO,EAAC,oBAAoB,EAAE,qBAAqB,EAAE,mBAAmB,EAAC,MAAM,gBAAgB,CAAC;AAgBhG,OAAO,EAAC,kBAAkB,EAAE,sBAAsB,EAAC,MAAM,cAAc,CAAC;AAaxE,OAAO,EAAC,kBAAkB,EAAC,MAAM,kBAAkB,CAAC"}
|
|
@@ -82,4 +82,29 @@ export declare function createLoggingMiddleware(config?: string | LoggingMiddlew
|
|
|
82
82
|
* }));
|
|
83
83
|
* ```
|
|
84
84
|
*/
|
|
85
|
+
/**
|
|
86
|
+
* Configuration for User-Agent middleware.
|
|
87
|
+
*/
|
|
88
|
+
export interface UserAgentConfig {
|
|
89
|
+
/**
|
|
90
|
+
* The User-Agent string to set on requests.
|
|
91
|
+
*/
|
|
92
|
+
userAgent: string;
|
|
93
|
+
}
|
|
94
|
+
/**
|
|
95
|
+
* Creates middleware that sets the User-Agent header on requests.
|
|
96
|
+
*
|
|
97
|
+
* Sets both the standard `User-Agent` header and a custom `sfdc_user_agent` header
|
|
98
|
+
* with the same value.
|
|
99
|
+
*
|
|
100
|
+
* @param config - Configuration with the User-Agent string
|
|
101
|
+
* @returns Middleware that sets the User-Agent headers
|
|
102
|
+
*
|
|
103
|
+
* @example
|
|
104
|
+
* ```typescript
|
|
105
|
+
* const client = createOcapiClient(config, auth);
|
|
106
|
+
* client.use(createUserAgentMiddleware({ userAgent: 'b2c-cli/0.1.0' }));
|
|
107
|
+
* ```
|
|
108
|
+
*/
|
|
109
|
+
export declare function createUserAgentMiddleware(config: UserAgentConfig): Middleware;
|
|
85
110
|
export declare function createExtraParamsMiddleware(config: ExtraParamsConfig): Middleware;
|
|
@@ -118,23 +118,29 @@ export function createLoggingMiddleware(config) {
|
|
|
118
118
|
};
|
|
119
119
|
}
|
|
120
120
|
/**
|
|
121
|
-
* Creates middleware that
|
|
121
|
+
* Creates middleware that sets the User-Agent header on requests.
|
|
122
122
|
*
|
|
123
|
-
*
|
|
124
|
-
*
|
|
123
|
+
* Sets both the standard `User-Agent` header and a custom `sfdc_user_agent` header
|
|
124
|
+
* with the same value.
|
|
125
125
|
*
|
|
126
|
-
* @param config - Configuration with
|
|
127
|
-
* @returns Middleware that
|
|
126
|
+
* @param config - Configuration with the User-Agent string
|
|
127
|
+
* @returns Middleware that sets the User-Agent headers
|
|
128
128
|
*
|
|
129
129
|
* @example
|
|
130
130
|
* ```typescript
|
|
131
|
-
* const client =
|
|
132
|
-
* client.use(
|
|
133
|
-
* query: { debug: 'true', internal_flag: '1' },
|
|
134
|
-
* body: { _internal: { trace: true } }
|
|
135
|
-
* }));
|
|
131
|
+
* const client = createOcapiClient(config, auth);
|
|
132
|
+
* client.use(createUserAgentMiddleware({ userAgent: 'b2c-cli/0.1.0' }));
|
|
136
133
|
* ```
|
|
137
134
|
*/
|
|
135
|
+
export function createUserAgentMiddleware(config) {
|
|
136
|
+
return {
|
|
137
|
+
async onRequest({ request }) {
|
|
138
|
+
request.headers.set('User-Agent', config.userAgent);
|
|
139
|
+
request.headers.set('sfdc_user_agent', config.userAgent);
|
|
140
|
+
return request;
|
|
141
|
+
},
|
|
142
|
+
};
|
|
143
|
+
}
|
|
138
144
|
export function createExtraParamsMiddleware(config) {
|
|
139
145
|
const logger = getLogger();
|
|
140
146
|
return {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"middleware.js","sourceRoot":"","sources":["../../../src/clients/middleware.ts"],"names":[],"mappings":"AAeA,OAAO,EAAC,SAAS,EAAC,MAAM,sBAAsB,CAAC;AAc/C;;GAEG;AACH,SAAS,eAAe,CAAC,OAAgB;IACvC,MAAM,MAAM,GAA2B,EAAE,CAAC;IAC1C,OAAO,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;QAC7B,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;IACtB,CAAC,CAAC,CAAC;IACH,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,oBAAoB,CAAC,IAAkB;IACrD,OAAO;QACL,KAAK,CAAC,SAAS,CAAC,EAAC,OAAO,EAAC;YACvB,IAAI,IAAI,CAAC,sBAAsB,EAAE,CAAC;gBAChC,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,sBAAsB,EAAE,CAAC;gBACvD,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,UAAU,CAAC,CAAC;YACnD,CAAC;YACD,OAAO,OAAO,CAAC;QACjB,CAAC;KACF,CAAC;AACJ,CAAC;AAmBD;;;GAGG;AACH,SAAS,QAAQ,CAAC,IAAa,EAAE,UAAqB;IACpD,IAAI,CAAC,UAAU,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;QACxF,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,MAAM,GAAG,EAAC,GAAI,IAAgC,EAAC,CAAC;IACtD,KAAK,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;QAC7B,IAAI,GAAG,IAAI,MAAM,EAAE,CAAC;YAClB,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;QACtB,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,UAAU,uBAAuB,CAAC,MAAyC;IAC/E,6EAA6E;IAC7E,MAAM,EAAC,MAAM,EAAE,YAAY,EAAC,GAC1B,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAC,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,SAAS,EAAC,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC;IAE1F,MAAM,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,MAAM,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;IAC/C,MAAM,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,MAAM,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;IAEjD,OAAO;QACL,KAAK,CAAC,SAAS,CAAC,EAAC,OAAO,EAAC;YACvB,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;YAC3B,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;YAExB,MAAM,CAAC,KAAK,CAAC,EAAC,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,GAAG,EAAC,EAAE,GAAG,MAAM,IAAI,OAAO,CAAC,MAAM,IAAI,GAAG,EAAE,CAAC,CAAC;YAElF,mEAAmE;YACnE,IAAI,IAAa,CAAC;YAClB,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;gBACjB,MAAM,aAAa,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;gBACtC,MAAM,IAAI,GAAG,MAAM,aAAa,CAAC,IAAI,EAAE,CAAC;gBACxC,IAAI,CAAC;oBACH,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBAC1B,CAAC;gBAAC,MAAM,CAAC;oBACP,IAAI,GAAG,IAAI,CAAC;gBACd,CAAC;YACH,CAAC;YAED,gDAAgD;YAChD,MAAM,UAAU,GAAG,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;YAChD,MAAM,CAAC,KAAK,CACV,EAAC,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,eAAe,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,UAAU,EAAC,EAC1F,GAAG,MAAM,IAAI,OAAO,CAAC,MAAM,IAAI,GAAG,OAAO,CAC1C,CAAC;YAED,OAA2C,CAAC,UAAU,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YAErE,OAAO,OAAO,CAAC;QACjB,CAAC;QAED,KAAK,CAAC,UAAU,CAAC,EAAC,OAAO,EAAE,QAAQ,EAAC;YAClC,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;YAC3B,MAAM,SAAS,GAAI,OAA2C,CAAC,UAAU,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;YACxF,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC;YACxC,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;YAExB,MAAM,CAAC,KAAK,CACV,EAAC,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE,QAAQ,EAAC,EAChE,GAAG,OAAO,IAAI,OAAO,CAAC,MAAM,IAAI,GAAG,IAAI,QAAQ,CAAC,MAAM,IAAI,QAAQ,IAAI,CACvE,CAAC;YAEF,MAAM,cAAc,GAAG,QAAQ,CAAC,KAAK,EAAE,CAAC;YACxC,IAAI,YAAqB,CAAC;YAC1B,iDAAiD;YACjD,mFAAmF;YACnF,yEAAyE;YACzE,MAAM,IAAI,GAAG,MAAM,cAAc,CAAC,IAAI,EAAE,CAAC;YACzC,IAAI,CAAC;gBACH,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAClC,CAAC;YAAC,MAAM,CAAC;gBACP,YAAY,GAAG,IAAI,CAAC;YACtB,CAAC;YAED,gDAAgD;YAChD,MAAM,kBAAkB,GAAG,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;YAChE,MAAM,CAAC,KAAK,CACV,EAAC,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,eAAe,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,kBAAkB,EAAC,EACnG,GAAG,OAAO,IAAI,OAAO,CAAC,MAAM,IAAI,GAAG,OAAO,CAC3C,CAAC;YAEF,OAAO,QAAQ,CAAC;QAClB,CAAC;KACF,CAAC;AACJ,CAAC;
|
|
1
|
+
{"version":3,"file":"middleware.js","sourceRoot":"","sources":["../../../src/clients/middleware.ts"],"names":[],"mappings":"AAeA,OAAO,EAAC,SAAS,EAAC,MAAM,sBAAsB,CAAC;AAc/C;;GAEG;AACH,SAAS,eAAe,CAAC,OAAgB;IACvC,MAAM,MAAM,GAA2B,EAAE,CAAC;IAC1C,OAAO,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;QAC7B,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;IACtB,CAAC,CAAC,CAAC;IACH,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,oBAAoB,CAAC,IAAkB;IACrD,OAAO;QACL,KAAK,CAAC,SAAS,CAAC,EAAC,OAAO,EAAC;YACvB,IAAI,IAAI,CAAC,sBAAsB,EAAE,CAAC;gBAChC,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,sBAAsB,EAAE,CAAC;gBACvD,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,UAAU,CAAC,CAAC;YACnD,CAAC;YACD,OAAO,OAAO,CAAC;QACjB,CAAC;KACF,CAAC;AACJ,CAAC;AAmBD;;;GAGG;AACH,SAAS,QAAQ,CAAC,IAAa,EAAE,UAAqB;IACpD,IAAI,CAAC,UAAU,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;QACxF,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,MAAM,GAAG,EAAC,GAAI,IAAgC,EAAC,CAAC;IACtD,KAAK,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;QAC7B,IAAI,GAAG,IAAI,MAAM,EAAE,CAAC;YAClB,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;QACtB,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,UAAU,uBAAuB,CAAC,MAAyC;IAC/E,6EAA6E;IAC7E,MAAM,EAAC,MAAM,EAAE,YAAY,EAAC,GAC1B,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAC,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,SAAS,EAAC,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC;IAE1F,MAAM,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,MAAM,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;IAC/C,MAAM,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,MAAM,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;IAEjD,OAAO;QACL,KAAK,CAAC,SAAS,CAAC,EAAC,OAAO,EAAC;YACvB,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;YAC3B,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;YAExB,MAAM,CAAC,KAAK,CAAC,EAAC,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,GAAG,EAAC,EAAE,GAAG,MAAM,IAAI,OAAO,CAAC,MAAM,IAAI,GAAG,EAAE,CAAC,CAAC;YAElF,mEAAmE;YACnE,IAAI,IAAa,CAAC;YAClB,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;gBACjB,MAAM,aAAa,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;gBACtC,MAAM,IAAI,GAAG,MAAM,aAAa,CAAC,IAAI,EAAE,CAAC;gBACxC,IAAI,CAAC;oBACH,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBAC1B,CAAC;gBAAC,MAAM,CAAC;oBACP,IAAI,GAAG,IAAI,CAAC;gBACd,CAAC;YACH,CAAC;YAED,gDAAgD;YAChD,MAAM,UAAU,GAAG,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;YAChD,MAAM,CAAC,KAAK,CACV,EAAC,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,eAAe,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,UAAU,EAAC,EAC1F,GAAG,MAAM,IAAI,OAAO,CAAC,MAAM,IAAI,GAAG,OAAO,CAC1C,CAAC;YAED,OAA2C,CAAC,UAAU,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YAErE,OAAO,OAAO,CAAC;QACjB,CAAC;QAED,KAAK,CAAC,UAAU,CAAC,EAAC,OAAO,EAAE,QAAQ,EAAC;YAClC,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;YAC3B,MAAM,SAAS,GAAI,OAA2C,CAAC,UAAU,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;YACxF,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC;YACxC,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;YAExB,MAAM,CAAC,KAAK,CACV,EAAC,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE,QAAQ,EAAC,EAChE,GAAG,OAAO,IAAI,OAAO,CAAC,MAAM,IAAI,GAAG,IAAI,QAAQ,CAAC,MAAM,IAAI,QAAQ,IAAI,CACvE,CAAC;YAEF,MAAM,cAAc,GAAG,QAAQ,CAAC,KAAK,EAAE,CAAC;YACxC,IAAI,YAAqB,CAAC;YAC1B,iDAAiD;YACjD,mFAAmF;YACnF,yEAAyE;YACzE,MAAM,IAAI,GAAG,MAAM,cAAc,CAAC,IAAI,EAAE,CAAC;YACzC,IAAI,CAAC;gBACH,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAClC,CAAC;YAAC,MAAM,CAAC;gBACP,YAAY,GAAG,IAAI,CAAC;YACtB,CAAC;YAED,gDAAgD;YAChD,MAAM,kBAAkB,GAAG,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;YAChE,MAAM,CAAC,KAAK,CACV,EAAC,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,eAAe,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,kBAAkB,EAAC,EACnG,GAAG,OAAO,IAAI,OAAO,CAAC,MAAM,IAAI,GAAG,OAAO,CAC3C,CAAC;YAEF,OAAO,QAAQ,CAAC;QAClB,CAAC;KACF,CAAC;AACJ,CAAC;AA8BD;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,yBAAyB,CAAC,MAAuB;IAC/D,OAAO;QACL,KAAK,CAAC,SAAS,CAAC,EAAC,OAAO,EAAC;YACvB,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC;YACpD,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC;YACzD,OAAO,OAAO,CAAC;QACjB,CAAC;KACF,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,2BAA2B,CAAC,MAAyB;IACnE,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;IAE3B,OAAO;QACL,KAAK,CAAC,SAAS,CAAC,EAAC,OAAO,EAAC;YACvB,IAAI,eAAe,GAAG,OAAO,CAAC;YAE9B,+CAA+C;YAC/C,MAAM,kBAAkB,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;YAC3C,MAAM,WAAW,GAAG,CAAC,kBAAkB,CAAC,QAAQ,CAAC,eAAe,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC;YAEvF,uDAAuD;YACvD,IAAI,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC7D,MAAM,UAAU,GAAG,IAAI,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;gBACxD,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;oBAC1D,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBAC7B,CAAC;gBACD,MAAM,CAAC,KAAK,CAAC,EAAC,YAAY,EAAE,MAAM,CAAC,OAAO,EAAC,EAAE,+CAA+C,CAAC,CAAC;gBAC9F,eAAe,GAAG,IAAI,OAAO,CAAC,eAAe,CAAC,GAAG,EAAE;oBACjD,MAAM,EAAE,eAAe,CAAC,MAAM;oBAC9B,OAAO,EAAE,UAAU;oBACnB,GAAG,CAAC,WAAW,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,EAAC,IAAI,EAAE,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAC,CAAC,CAAC,CAAC,EAAE,CAAC;iBAC9E,CAAC,CAAC;YACpB,CAAC;YAED,6BAA6B;YAC7B,IAAI,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACzD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;gBACzC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;oBACxD,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;wBACxB,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;oBAC3C,CAAC;gBACH,CAAC;gBACD,MAAM,CAAC,KAAK,CACV,EAAC,UAAU,EAAE,MAAM,CAAC,KAAK,EAAE,WAAW,EAAE,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,CAAC,QAAQ,EAAE,EAAC,EACpF,gDAAgD,CACjD,CAAC;gBACF,eAAe,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE;oBAC5C,MAAM,EAAE,eAAe,CAAC,MAAM;oBAC9B,OAAO,EAAE,eAAe,CAAC,OAAO;oBAChC,GAAG,CAAC,WAAW,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,EAAC,IAAI,EAAE,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAC,CAAC,CAAC,CAAC,EAAE,CAAC;iBAC9E,CAAC,CAAC;YACpB,CAAC;YAED,4CAA4C;YAC5C,IAAI,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACvD,MAAM,WAAW,GAAG,eAAe,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;gBAChE,IAAI,WAAW,EAAE,QAAQ,CAAC,kBAAkB,CAAC,IAAI,eAAe,CAAC,IAAI,EAAE,CAAC;oBACtE,MAAM,aAAa,GAAG,eAAe,CAAC,KAAK,EAAE,CAAC;oBAC9C,MAAM,YAAY,GAAG,MAAM,aAAa,CAAC,IAAI,EAAE,CAAC;oBAChD,IAAI,CAAC;wBACH,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAA4B,CAAC;wBACvE,MAAM,UAAU,GAAG,EAAC,GAAG,UAAU,EAAE,GAAG,MAAM,CAAC,IAAI,EAAC,CAAC;wBACnD,MAAM,CAAC,KAAK,CACV,EAAC,YAAY,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,CAAC,IAAI,EAAE,UAAU,EAAC,EAC9D,sDAAsD,CACvD,CAAC;wBACF,eAAe,GAAG,IAAI,OAAO,CAAC,eAAe,CAAC,GAAG,EAAE;4BACjD,MAAM,EAAE,eAAe,CAAC,MAAM;4BAC9B,OAAO,EAAE,eAAe,CAAC,OAAO;4BAChC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC;yBACjC,CAAC,CAAC;oBACL,CAAC;oBAAC,MAAM,CAAC;wBACP,MAAM,CAAC,IAAI,CAAC,yEAAyE,CAAC,CAAC;oBACzF,CAAC;gBACH,CAAC;qBAAM,IAAI,CAAC,eAAe,CAAC,IAAI,IAAI,WAAW,EAAE,CAAC;oBAChD,sFAAsF;oBACtF,MAAM,CAAC,KAAK,CAAC,EAAC,IAAI,EAAE,MAAM,CAAC,IAAI,EAAC,EAAE,mDAAmD,CAAC,CAAC;oBACvF,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;oBACrD,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;oBAChD,eAAe,GAAG,IAAI,OAAO,CAAC,eAAe,CAAC,GAAG,EAAE;wBACjD,MAAM,EAAE,eAAe,CAAC,MAAM;wBAC9B,OAAO;wBACP,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC;qBAClC,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;YAED,OAAO,eAAe,CAAC;QACzB,CAAC;KACF,CAAC;AACJ,CAAC"}
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
import type { HttpMiddlewareProvider } from './middleware-registry.js';
|
|
2
|
+
import type { AuthMiddlewareProvider } from '../auth/middleware.js';
|
|
3
|
+
/**
|
|
4
|
+
* Sets the User-Agent string for all HTTP requests.
|
|
5
|
+
*
|
|
6
|
+
* Call this early in your application to override the default SDK User-Agent.
|
|
7
|
+
* The CLI uses this to set a combined CLI+SDK User-Agent.
|
|
8
|
+
*
|
|
9
|
+
* @param userAgent - The User-Agent string to use
|
|
10
|
+
*
|
|
11
|
+
* @example
|
|
12
|
+
* ```typescript
|
|
13
|
+
* // CLI usage:
|
|
14
|
+
* setUserAgent('b2c-cli/1.0.0');
|
|
15
|
+
* ```
|
|
16
|
+
*/
|
|
17
|
+
export declare function setUserAgent(userAgent: string): void;
|
|
18
|
+
/**
|
|
19
|
+
* Gets the current User-Agent string.
|
|
20
|
+
*
|
|
21
|
+
* @returns The current User-Agent string
|
|
22
|
+
*/
|
|
23
|
+
export declare function getUserAgent(): string;
|
|
24
|
+
/**
|
|
25
|
+
* Resets the User-Agent to the default SDK value.
|
|
26
|
+
*
|
|
27
|
+
* Primarily useful for testing.
|
|
28
|
+
*/
|
|
29
|
+
export declare function resetUserAgent(): void;
|
|
30
|
+
/**
|
|
31
|
+
* User-Agent middleware provider for HTTP clients.
|
|
32
|
+
*
|
|
33
|
+
* This provider is automatically registered with the global middleware registry
|
|
34
|
+
* when this module is imported.
|
|
35
|
+
*/
|
|
36
|
+
export declare const userAgentProvider: HttpMiddlewareProvider;
|
|
37
|
+
/**
|
|
38
|
+
* User-Agent middleware provider for auth requests.
|
|
39
|
+
*
|
|
40
|
+
* This provider is automatically registered with the global auth middleware registry
|
|
41
|
+
* when this module is imported. It ensures OAuth token requests include User-Agent headers.
|
|
42
|
+
*/
|
|
43
|
+
export declare const userAgentAuthProvider: AuthMiddlewareProvider;
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Copyright (c) 2025, Salesforce, Inc.
|
|
3
|
+
* SPDX-License-Identifier: Apache-2
|
|
4
|
+
* For full license text, see the license.txt file in the repo root or http://www.apache.org/licenses/LICENSE-2.0
|
|
5
|
+
*/
|
|
6
|
+
/**
|
|
7
|
+
* User-Agent middleware provider for HTTP clients.
|
|
8
|
+
*
|
|
9
|
+
* This module provides a global User-Agent that is applied to all HTTP requests.
|
|
10
|
+
* The SDK sets a default User-Agent, which can be overridden by the CLI to include
|
|
11
|
+
* both CLI and SDK version information.
|
|
12
|
+
*
|
|
13
|
+
* @module clients/user-agent
|
|
14
|
+
*/
|
|
15
|
+
import { SDK_USER_AGENT } from '../version.js';
|
|
16
|
+
import { createUserAgentMiddleware } from './middleware.js';
|
|
17
|
+
import { globalMiddlewareRegistry } from './middleware-registry.js';
|
|
18
|
+
import { globalAuthMiddlewareRegistry } from '../auth/middleware.js';
|
|
19
|
+
// Current User-Agent string - defaults to SDK User-Agent
|
|
20
|
+
let currentUserAgent = SDK_USER_AGENT;
|
|
21
|
+
/**
|
|
22
|
+
* Sets the User-Agent string for all HTTP requests.
|
|
23
|
+
*
|
|
24
|
+
* Call this early in your application to override the default SDK User-Agent.
|
|
25
|
+
* The CLI uses this to set a combined CLI+SDK User-Agent.
|
|
26
|
+
*
|
|
27
|
+
* @param userAgent - The User-Agent string to use
|
|
28
|
+
*
|
|
29
|
+
* @example
|
|
30
|
+
* ```typescript
|
|
31
|
+
* // CLI usage:
|
|
32
|
+
* setUserAgent('b2c-cli/1.0.0');
|
|
33
|
+
* ```
|
|
34
|
+
*/
|
|
35
|
+
export function setUserAgent(userAgent) {
|
|
36
|
+
currentUserAgent = userAgent;
|
|
37
|
+
}
|
|
38
|
+
/**
|
|
39
|
+
* Gets the current User-Agent string.
|
|
40
|
+
*
|
|
41
|
+
* @returns The current User-Agent string
|
|
42
|
+
*/
|
|
43
|
+
export function getUserAgent() {
|
|
44
|
+
return currentUserAgent;
|
|
45
|
+
}
|
|
46
|
+
/**
|
|
47
|
+
* Resets the User-Agent to the default SDK value.
|
|
48
|
+
*
|
|
49
|
+
* Primarily useful for testing.
|
|
50
|
+
*/
|
|
51
|
+
export function resetUserAgent() {
|
|
52
|
+
currentUserAgent = SDK_USER_AGENT;
|
|
53
|
+
}
|
|
54
|
+
/**
|
|
55
|
+
* User-Agent middleware provider for HTTP clients.
|
|
56
|
+
*
|
|
57
|
+
* This provider is automatically registered with the global middleware registry
|
|
58
|
+
* when this module is imported.
|
|
59
|
+
*/
|
|
60
|
+
export const userAgentProvider = {
|
|
61
|
+
name: 'user-agent',
|
|
62
|
+
getMiddleware() {
|
|
63
|
+
return createUserAgentMiddleware({ userAgent: currentUserAgent });
|
|
64
|
+
},
|
|
65
|
+
};
|
|
66
|
+
/**
|
|
67
|
+
* User-Agent middleware provider for auth requests.
|
|
68
|
+
*
|
|
69
|
+
* This provider is automatically registered with the global auth middleware registry
|
|
70
|
+
* when this module is imported. It ensures OAuth token requests include User-Agent headers.
|
|
71
|
+
*/
|
|
72
|
+
export const userAgentAuthProvider = {
|
|
73
|
+
name: 'user-agent',
|
|
74
|
+
getMiddleware() {
|
|
75
|
+
return {
|
|
76
|
+
async onRequest({ request }) {
|
|
77
|
+
request.headers.set('User-Agent', currentUserAgent);
|
|
78
|
+
request.headers.set('sfdc_user_agent', currentUserAgent);
|
|
79
|
+
return request;
|
|
80
|
+
},
|
|
81
|
+
};
|
|
82
|
+
},
|
|
83
|
+
};
|
|
84
|
+
// Auto-register with global middleware registries on module import
|
|
85
|
+
globalMiddlewareRegistry.register(userAgentProvider);
|
|
86
|
+
globalAuthMiddlewareRegistry.register(userAgentAuthProvider);
|
|
87
|
+
//# sourceMappingURL=user-agent.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"user-agent.js","sourceRoot":"","sources":["../../../src/clients/user-agent.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH;;;;;;;;GAQG;AACH,OAAO,EAAC,cAAc,EAAC,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAC,yBAAyB,EAAC,MAAM,iBAAiB,CAAC;AAC1D,OAAO,EAAC,wBAAwB,EAAC,MAAM,0BAA0B,CAAC;AAElE,OAAO,EAAC,4BAA4B,EAAC,MAAM,uBAAuB,CAAC;AAGnE,yDAAyD;AACzD,IAAI,gBAAgB,GAAG,cAAc,CAAC;AAEtC;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,YAAY,CAAC,SAAiB;IAC5C,gBAAgB,GAAG,SAAS,CAAC;AAC/B,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,YAAY;IAC1B,OAAO,gBAAgB,CAAC;AAC1B,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,cAAc;IAC5B,gBAAgB,GAAG,cAAc,CAAC;AACpC,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAA2B;IACvD,IAAI,EAAE,YAAY;IAClB,aAAa;QACX,OAAO,yBAAyB,CAAC,EAAC,SAAS,EAAE,gBAAgB,EAAC,CAAC,CAAC;IAClE,CAAC;CACF,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAA2B;IAC3D,IAAI,EAAE,YAAY;IAClB,aAAa;QACX,OAAO;YACL,KAAK,CAAC,SAAS,CAAC,EAAC,OAAO,EAAC;gBACvB,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,gBAAgB,CAAC,CAAC;gBACpD,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,gBAAgB,CAAC,CAAC;gBACzD,OAAO,OAAO,CAAC;YACjB,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC;AAEF,mEAAmE;AACnE,wBAAwB,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC;AACrD,4BAA4B,CAAC,QAAQ,CAAC,qBAAqB,CAAC,CAAC"}
|
package/dist/esm/index.d.ts
CHANGED
|
@@ -23,3 +23,4 @@ export type { Site } from './operations/sites/index.js';
|
|
|
23
23
|
export { searchDocs, readDoc, readDocByQuery, listDocs, loadSearchIndex, listSchemas, readSchema, readSchemaByQuery, searchSchemas, downloadDocs, } from './operations/docs/index.js';
|
|
24
24
|
export type { DocEntry, SearchIndex, SearchResult, SchemaEntry, SchemaIndex, SchemaSearchResult, DownloadDocsOptions, DownloadDocsResult, } from './operations/docs/index.js';
|
|
25
25
|
export { DEFAULT_ACCOUNT_MANAGER_HOST, DEFAULT_ODS_HOST } from './defaults.js';
|
|
26
|
+
export { SDK_NAME, SDK_VERSION, SDK_USER_AGENT } from './version.js';
|
package/dist/esm/index.js
CHANGED
|
@@ -28,4 +28,6 @@ export { listSites, getSite } from './operations/sites/index.js';
|
|
|
28
28
|
export { searchDocs, readDoc, readDocByQuery, listDocs, loadSearchIndex, listSchemas, readSchema, readSchemaByQuery, searchSchemas, downloadDocs, } from './operations/docs/index.js';
|
|
29
29
|
// Defaults
|
|
30
30
|
export { DEFAULT_ACCOUNT_MANAGER_HOST, DEFAULT_ODS_HOST } from './defaults.js';
|
|
31
|
+
// Version info
|
|
32
|
+
export { SDK_NAME, SDK_VERSION, SDK_USER_AGENT } from './version.js';
|
|
31
33
|
//# sourceMappingURL=index.js.map
|
package/dist/esm/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAAC,YAAY,EAAE,eAAe,EAAE,SAAS,EAAE,WAAW,EAAE,kBAAkB,EAAC,MAAM,oBAAoB,CAAC;AAG7G,kEAAkE;AAClE,OAAO,EAAC,UAAU,EAAE,aAAa,EAAE,SAAS,EAAE,SAAS,IAAI,eAAe,EAAC,MAAM,aAAa,CAAC;AAG/F,OAAO;AACP,OAAO,EAAC,CAAC,EAAE,WAAW,EAAE,WAAW,EAAE,eAAe,EAAE,oBAAoB,EAAE,aAAa,EAAC,MAAM,iBAAiB,CAAC;AAGlH,SAAS;AACT,OAAO,EAAC,UAAU,EAAE,UAAU,EAAE,aAAa,EAAE,cAAc,EAAE,oBAAoB,EAAC,MAAM,mBAAmB,CAAC;AAgB9G,yCAAyC;AACzC,OAAO,EACL,iBAAiB,EACjB,aAAa,EACb,qBAAqB,EACrB,cAAc,EACd,SAAS,EACT,mBAAmB,EACnB,yBAAyB,EACzB,gBAAgB,GACjB,MAAM,iBAAiB,CAAC;AAiBzB,2BAA2B;AAC3B,OAAO,EAAC,WAAW,EAAC,MAAM,qBAAqB,CAAC;AAGhD,UAAU;AACV,OAAO,EACL,YAAY,EACZ,iBAAiB,EACjB,oBAAoB,EACpB,2BAA2B,EAC3B,gBAAgB,EAChB,eAAe,EACf,sBAAsB,EACtB,oBAAoB,EACpB,gBAAgB,EAChB,UAAU,EACV,gBAAgB,EAChB,kBAAkB,EAClB,sBAAsB,EACtB,yBAAyB,EACzB,0BAA0B,EAC1B,qBAAqB,EACrB,mBAAmB,GACpB,MAAM,oBAAoB,CAAC;AAsC5B,2BAA2B;AAC3B,OAAO,EAAC,SAAS,EAAE,SAAS,EAAC,MAAM,qBAAqB,CAAC;AAGzD,oBAAoB;AACpB,OAAO,EACL,cAAc,EACd,gBAAgB,EAChB,oBAAoB,EACpB,mBAAmB,EACnB,iBAAiB,EACjB,iBAAiB,EACjB,iBAAiB,EACjB,uBAAuB,EACvB,gBAAgB,EAChB,gBAAgB,EAChB,eAAe,GAChB,MAAM,4BAA4B,CAAC;AAYpC,oBAAoB;AACpB,OAAO,EACL,UAAU,EACV,eAAe,EACf,UAAU,EACV,mBAAmB,EACnB,uBAAuB,EACvB,SAAS,EACT,kBAAkB,EAClB,iBAAiB,EACjB,iBAAiB,EACjB,iBAAiB,EACjB,uBAAuB,GACxB,MAAM,4BAA4B,CAAC;AAmBpC,qBAAqB;AACrB,OAAO,EAAC,SAAS,EAAE,OAAO,EAAC,MAAM,6BAA6B,CAAC;AAG/D,oBAAoB;AACpB,OAAO,EACL,UAAU,EACV,OAAO,EACP,cAAc,EACd,QAAQ,EACR,eAAe,EACf,WAAW,EACX,UAAU,EACV,iBAAiB,EACjB,aAAa,EACb,YAAY,GACb,MAAM,4BAA4B,CAAC;AAYpC,WAAW;AACX,OAAO,EAAC,4BAA4B,EAAE,gBAAgB,EAAC,MAAM,eAAe,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAAC,YAAY,EAAE,eAAe,EAAE,SAAS,EAAE,WAAW,EAAE,kBAAkB,EAAC,MAAM,oBAAoB,CAAC;AAG7G,kEAAkE;AAClE,OAAO,EAAC,UAAU,EAAE,aAAa,EAAE,SAAS,EAAE,SAAS,IAAI,eAAe,EAAC,MAAM,aAAa,CAAC;AAG/F,OAAO;AACP,OAAO,EAAC,CAAC,EAAE,WAAW,EAAE,WAAW,EAAE,eAAe,EAAE,oBAAoB,EAAE,aAAa,EAAC,MAAM,iBAAiB,CAAC;AAGlH,SAAS;AACT,OAAO,EAAC,UAAU,EAAE,UAAU,EAAE,aAAa,EAAE,cAAc,EAAE,oBAAoB,EAAC,MAAM,mBAAmB,CAAC;AAgB9G,yCAAyC;AACzC,OAAO,EACL,iBAAiB,EACjB,aAAa,EACb,qBAAqB,EACrB,cAAc,EACd,SAAS,EACT,mBAAmB,EACnB,yBAAyB,EACzB,gBAAgB,GACjB,MAAM,iBAAiB,CAAC;AAiBzB,2BAA2B;AAC3B,OAAO,EAAC,WAAW,EAAC,MAAM,qBAAqB,CAAC;AAGhD,UAAU;AACV,OAAO,EACL,YAAY,EACZ,iBAAiB,EACjB,oBAAoB,EACpB,2BAA2B,EAC3B,gBAAgB,EAChB,eAAe,EACf,sBAAsB,EACtB,oBAAoB,EACpB,gBAAgB,EAChB,UAAU,EACV,gBAAgB,EAChB,kBAAkB,EAClB,sBAAsB,EACtB,yBAAyB,EACzB,0BAA0B,EAC1B,qBAAqB,EACrB,mBAAmB,GACpB,MAAM,oBAAoB,CAAC;AAsC5B,2BAA2B;AAC3B,OAAO,EAAC,SAAS,EAAE,SAAS,EAAC,MAAM,qBAAqB,CAAC;AAGzD,oBAAoB;AACpB,OAAO,EACL,cAAc,EACd,gBAAgB,EAChB,oBAAoB,EACpB,mBAAmB,EACnB,iBAAiB,EACjB,iBAAiB,EACjB,iBAAiB,EACjB,uBAAuB,EACvB,gBAAgB,EAChB,gBAAgB,EAChB,eAAe,GAChB,MAAM,4BAA4B,CAAC;AAYpC,oBAAoB;AACpB,OAAO,EACL,UAAU,EACV,eAAe,EACf,UAAU,EACV,mBAAmB,EACnB,uBAAuB,EACvB,SAAS,EACT,kBAAkB,EAClB,iBAAiB,EACjB,iBAAiB,EACjB,iBAAiB,EACjB,uBAAuB,GACxB,MAAM,4BAA4B,CAAC;AAmBpC,qBAAqB;AACrB,OAAO,EAAC,SAAS,EAAE,OAAO,EAAC,MAAM,6BAA6B,CAAC;AAG/D,oBAAoB;AACpB,OAAO,EACL,UAAU,EACV,OAAO,EACP,cAAc,EACd,QAAQ,EACR,eAAe,EACf,WAAW,EACX,UAAU,EACV,iBAAiB,EACjB,aAAa,EACb,YAAY,GACb,MAAM,4BAA4B,CAAC;AAYpC,WAAW;AACX,OAAO,EAAC,4BAA4B,EAAE,gBAAgB,EAAC,MAAM,eAAe,CAAC;AAE7E,eAAe;AACf,OAAO,EAAC,QAAQ,EAAE,WAAW,EAAE,cAAc,EAAC,MAAM,cAAc,CAAC"}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The SDK package name.
|
|
3
|
+
*/
|
|
4
|
+
export declare const SDK_NAME: string;
|
|
5
|
+
/**
|
|
6
|
+
* The SDK package version.
|
|
7
|
+
*/
|
|
8
|
+
export declare const SDK_VERSION: string;
|
|
9
|
+
/**
|
|
10
|
+
* Default User-Agent string for the SDK.
|
|
11
|
+
*
|
|
12
|
+
* Format: `b2c-tooling-sdk/0.1.0`
|
|
13
|
+
*/
|
|
14
|
+
export declare const SDK_USER_AGENT: string;
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Copyright (c) 2025, Salesforce, Inc.
|
|
3
|
+
* SPDX-License-Identifier: Apache-2
|
|
4
|
+
* For full license text, see the license.txt file in the repo root or http://www.apache.org/licenses/LICENSE-2.0
|
|
5
|
+
*/
|
|
6
|
+
/**
|
|
7
|
+
* SDK version information and User-Agent string.
|
|
8
|
+
*
|
|
9
|
+
* @module version
|
|
10
|
+
*/
|
|
11
|
+
import { createRequire } from 'node:module';
|
|
12
|
+
const require = createRequire(import.meta.url);
|
|
13
|
+
// Use the package.json exports path to resolve correctly from both src/ and dist/
|
|
14
|
+
const pkg = require('@salesforce/b2c-tooling-sdk/package.json');
|
|
15
|
+
/**
|
|
16
|
+
* The SDK package name.
|
|
17
|
+
*/
|
|
18
|
+
export const SDK_NAME = pkg.name;
|
|
19
|
+
/**
|
|
20
|
+
* The SDK package version.
|
|
21
|
+
*/
|
|
22
|
+
export const SDK_VERSION = pkg.version;
|
|
23
|
+
/**
|
|
24
|
+
* Default User-Agent string for the SDK.
|
|
25
|
+
*
|
|
26
|
+
* Format: `b2c-tooling-sdk/0.1.0`
|
|
27
|
+
*/
|
|
28
|
+
export const SDK_USER_AGENT = `${SDK_NAME.replace(/^@salesforce\//, '')}/${SDK_VERSION}`;
|
|
29
|
+
//# sourceMappingURL=version.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"version.js","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH;;;;GAIG;AACH,OAAO,EAAC,aAAa,EAAC,MAAM,aAAa,CAAC;AAE1C,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC/C,kFAAkF;AAClF,MAAM,GAAG,GAAG,OAAO,CAAC,0CAA0C,CAAoC,CAAC;AAEnG;;GAEG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,GAAG,CAAC,IAAI,CAAC;AAEjC;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,GAAG,CAAC,OAAO,CAAC;AAEvC;;;;GAIG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,GAAG,QAAQ,CAAC,OAAO,CAAC,gBAAgB,EAAE,EAAE,CAAC,IAAI,WAAW,EAAE,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@salesforce/b2c-tooling-sdk",
|
|
3
|
-
"version": "0.0.0-nightly.
|
|
3
|
+
"version": "0.0.0-nightly.20260123023856",
|
|
4
4
|
"description": "Core tooling library for Salesforce Commerce Cloud B2C CLI",
|
|
5
5
|
"author": "Charles Lavery",
|
|
6
6
|
"license": "Apache-2.0",
|