@salesforce/b2c-tooling-sdk 0.11.0 → 0.13.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/README.md +6 -0
- package/dist/cjs/auth/oauth-implicit.d.ts +14 -0
- package/dist/cjs/auth/oauth-implicit.js +21 -10
- package/dist/cjs/auth/oauth-implicit.js.map +1 -1
- package/dist/cjs/auth/resolve.js +2 -0
- package/dist/cjs/auth/resolve.js.map +1 -1
- package/dist/cjs/auth/types.d.ts +8 -0
- package/dist/cjs/auth/types.js.map +1 -1
- package/dist/cjs/cli/am-command.js +2 -2
- package/dist/cjs/cli/am-command.js.map +1 -1
- package/dist/cjs/cli/base-command.js +1 -1
- package/dist/cjs/cli/base-command.js.map +1 -1
- package/dist/cjs/cli/oauth-command.d.ts +4 -0
- package/dist/cjs/cli/oauth-command.js +7 -1
- package/dist/cjs/cli/oauth-command.js.map +1 -1
- package/dist/cjs/cli/ods-command.js +2 -2
- package/dist/cjs/cli/ods-command.js.map +1 -1
- package/dist/cjs/clients/granular-replications.d.ts +70 -0
- package/dist/cjs/clients/granular-replications.generated.d.ts +416 -0
- package/dist/cjs/clients/granular-replications.generated.js +6 -0
- package/dist/cjs/clients/granular-replications.generated.js.map +1 -0
- package/dist/cjs/clients/granular-replications.js +70 -0
- package/dist/cjs/clients/granular-replications.js.map +1 -0
- package/dist/cjs/clients/index.d.ts +2 -0
- package/dist/cjs/clients/index.js +1 -0
- package/dist/cjs/clients/index.js.map +1 -1
- package/dist/cjs/clients/middleware-registry.d.ts +1 -1
- package/dist/cjs/clients/middleware-registry.js.map +1 -1
- package/dist/cjs/clients/mrt.js +2 -1
- package/dist/cjs/clients/mrt.js.map +1 -1
- package/dist/cjs/config/mapping.d.ts +13 -1
- package/dist/cjs/config/mapping.js +27 -1
- package/dist/cjs/config/mapping.js.map +1 -1
- package/dist/cjs/config/resolved-config.d.ts +1 -1
- package/dist/cjs/config/resolved-config.js +4 -2
- package/dist/cjs/config/resolved-config.js.map +1 -1
- package/dist/cjs/config/resolver.js +4 -1
- package/dist/cjs/config/resolver.js.map +1 -1
- package/dist/cjs/config/types.d.ts +6 -1
- package/dist/cjs/defaults.d.ts +8 -0
- package/dist/cjs/defaults.js +20 -0
- package/dist/cjs/defaults.js.map +1 -1
- package/dist/cjs/index.d.ts +3 -3
- package/dist/cjs/index.js +2 -2
- package/dist/cjs/index.js.map +1 -1
- package/dist/cjs/instance/index.js +2 -0
- package/dist/cjs/instance/index.js.map +1 -1
- package/dist/cjs/operations/bm-roles/index.d.ts +52 -0
- package/dist/cjs/operations/bm-roles/index.js +57 -0
- package/dist/cjs/operations/bm-roles/index.js.map +1 -0
- package/dist/cjs/operations/bm-roles/roles.d.ts +155 -0
- package/dist/cjs/operations/bm-roles/roles.js +194 -0
- package/dist/cjs/operations/bm-roles/roles.js.map +1 -0
- package/dist/cjs/operations/mrt/tail-logs.js +3 -2
- package/dist/cjs/operations/mrt/tail-logs.js.map +1 -1
- package/dist/cjs/operations/sites/cartridges.d.ts +114 -0
- package/dist/cjs/operations/sites/cartridges.js +378 -0
- package/dist/cjs/operations/sites/cartridges.js.map +1 -0
- package/dist/cjs/operations/sites/index.d.ts +46 -0
- package/dist/cjs/operations/sites/index.js +51 -0
- package/dist/cjs/operations/sites/index.js.map +1 -0
- package/dist/esm/auth/oauth-implicit.d.ts +14 -0
- package/dist/esm/auth/oauth-implicit.js +21 -10
- package/dist/esm/auth/oauth-implicit.js.map +1 -1
- package/dist/esm/auth/resolve.js +2 -0
- package/dist/esm/auth/resolve.js.map +1 -1
- package/dist/esm/auth/types.d.ts +8 -0
- package/dist/esm/auth/types.js.map +1 -1
- package/dist/esm/cli/am-command.js +2 -2
- package/dist/esm/cli/am-command.js.map +1 -1
- package/dist/esm/cli/base-command.js +1 -1
- package/dist/esm/cli/base-command.js.map +1 -1
- package/dist/esm/cli/oauth-command.d.ts +4 -0
- package/dist/esm/cli/oauth-command.js +7 -1
- package/dist/esm/cli/oauth-command.js.map +1 -1
- package/dist/esm/cli/ods-command.js +2 -2
- package/dist/esm/cli/ods-command.js.map +1 -1
- package/dist/esm/clients/granular-replications.d.ts +70 -0
- package/dist/esm/clients/granular-replications.generated.d.ts +416 -0
- package/dist/esm/clients/granular-replications.generated.js +6 -0
- package/dist/esm/clients/granular-replications.generated.js.map +1 -0
- package/dist/esm/clients/granular-replications.js +70 -0
- package/dist/esm/clients/granular-replications.js.map +1 -0
- package/dist/esm/clients/index.d.ts +2 -0
- package/dist/esm/clients/index.js +1 -0
- package/dist/esm/clients/index.js.map +1 -1
- package/dist/esm/clients/middleware-registry.d.ts +1 -1
- package/dist/esm/clients/middleware-registry.js.map +1 -1
- package/dist/esm/clients/mrt.js +2 -1
- package/dist/esm/clients/mrt.js.map +1 -1
- package/dist/esm/config/mapping.d.ts +13 -1
- package/dist/esm/config/mapping.js +27 -1
- package/dist/esm/config/mapping.js.map +1 -1
- package/dist/esm/config/resolved-config.d.ts +1 -1
- package/dist/esm/config/resolved-config.js +4 -2
- package/dist/esm/config/resolved-config.js.map +1 -1
- package/dist/esm/config/resolver.js +4 -1
- package/dist/esm/config/resolver.js.map +1 -1
- package/dist/esm/config/types.d.ts +6 -1
- package/dist/esm/defaults.d.ts +8 -0
- package/dist/esm/defaults.js +20 -0
- package/dist/esm/defaults.js.map +1 -1
- package/dist/esm/index.d.ts +3 -3
- package/dist/esm/index.js +2 -2
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/instance/index.js +2 -0
- package/dist/esm/instance/index.js.map +1 -1
- package/dist/esm/operations/bm-roles/index.d.ts +52 -0
- package/dist/esm/operations/bm-roles/index.js +57 -0
- package/dist/esm/operations/bm-roles/index.js.map +1 -0
- package/dist/esm/operations/bm-roles/roles.d.ts +155 -0
- package/dist/esm/operations/bm-roles/roles.js +194 -0
- package/dist/esm/operations/bm-roles/roles.js.map +1 -0
- package/dist/esm/operations/mrt/tail-logs.js +3 -2
- package/dist/esm/operations/mrt/tail-logs.js.map +1 -1
- package/dist/esm/operations/sites/cartridges.d.ts +114 -0
- package/dist/esm/operations/sites/cartridges.js +378 -0
- package/dist/esm/operations/sites/cartridges.js.map +1 -0
- package/dist/esm/operations/sites/index.d.ts +46 -0
- package/dist/esm/operations/sites/index.js +51 -0
- package/dist/esm/operations/sites/index.js.map +1 -0
- package/package.json +22 -2
- package/specs/granular-replications-v1.yaml +657 -0
|
@@ -0,0 +1,194 @@
|
|
|
1
|
+
import { getApiErrorMessage } from '../../clients/error-utils.js';
|
|
2
|
+
/**
|
|
3
|
+
* Lists all access roles on a B2C Commerce instance.
|
|
4
|
+
*
|
|
5
|
+
* @param instance - B2C instance to query
|
|
6
|
+
* @param options - Pagination options
|
|
7
|
+
* @returns Roles collection with pagination info
|
|
8
|
+
*
|
|
9
|
+
* @example
|
|
10
|
+
* ```typescript
|
|
11
|
+
* const roles = await listBmRoles(instance);
|
|
12
|
+
* for (const role of roles.data ?? []) {
|
|
13
|
+
* console.log(role.id, role.description);
|
|
14
|
+
* }
|
|
15
|
+
* ```
|
|
16
|
+
*/
|
|
17
|
+
export async function listBmRoles(instance, options = {}) {
|
|
18
|
+
const { start, count } = options;
|
|
19
|
+
const { data, error, response } = await instance.ocapi.GET('/roles', {
|
|
20
|
+
params: { query: { start, count, select: '(**)' } },
|
|
21
|
+
});
|
|
22
|
+
if (error) {
|
|
23
|
+
throw new Error(`Failed to list roles: ${getApiErrorMessage(error, response)}`, { cause: error });
|
|
24
|
+
}
|
|
25
|
+
return data;
|
|
26
|
+
}
|
|
27
|
+
/**
|
|
28
|
+
* Gets details of a specific access role.
|
|
29
|
+
*
|
|
30
|
+
* @param instance - B2C instance to query
|
|
31
|
+
* @param roleId - Role ID (e.g. "Administrator")
|
|
32
|
+
* @param options - Expand options
|
|
33
|
+
* @returns Role details
|
|
34
|
+
*
|
|
35
|
+
* @example
|
|
36
|
+
* ```typescript
|
|
37
|
+
* const role = await getBmRole(instance, 'Administrator', { expand: ['users'] });
|
|
38
|
+
* console.log(role.id, role.user_count);
|
|
39
|
+
* ```
|
|
40
|
+
*/
|
|
41
|
+
export async function getBmRole(instance, roleId, options = {}) {
|
|
42
|
+
const { expand } = options;
|
|
43
|
+
const { data, error, response } = await instance.ocapi.GET('/roles/{id}', {
|
|
44
|
+
params: { path: { id: roleId }, query: { expand } },
|
|
45
|
+
});
|
|
46
|
+
if (error) {
|
|
47
|
+
throw new Error(`Failed to get role ${roleId}: ${getApiErrorMessage(error, response)}`, { cause: error });
|
|
48
|
+
}
|
|
49
|
+
return data;
|
|
50
|
+
}
|
|
51
|
+
/**
|
|
52
|
+
* Creates a new access role on an instance.
|
|
53
|
+
*
|
|
54
|
+
* @param instance - B2C instance
|
|
55
|
+
* @param roleId - Role ID to create
|
|
56
|
+
* @param role - Role properties (description, etc.)
|
|
57
|
+
* @returns Created role
|
|
58
|
+
*
|
|
59
|
+
* @example
|
|
60
|
+
* ```typescript
|
|
61
|
+
* const role = await createBmRole(instance, 'MyCustomRole', { description: 'A custom role' });
|
|
62
|
+
* ```
|
|
63
|
+
*/
|
|
64
|
+
export async function createBmRole(instance, roleId, role = {}) {
|
|
65
|
+
const { data, error, response } = await instance.ocapi.PUT('/roles/{id}', {
|
|
66
|
+
params: { path: { id: roleId } },
|
|
67
|
+
body: { id: roleId, ...role },
|
|
68
|
+
});
|
|
69
|
+
if (error) {
|
|
70
|
+
throw new Error(`Failed to create role ${roleId}: ${getApiErrorMessage(error, response)}`, { cause: error });
|
|
71
|
+
}
|
|
72
|
+
return data;
|
|
73
|
+
}
|
|
74
|
+
/**
|
|
75
|
+
* Deletes an access role from an instance.
|
|
76
|
+
*
|
|
77
|
+
* System roles (e.g. "Administrator", "Support") cannot be deleted.
|
|
78
|
+
*
|
|
79
|
+
* @param instance - B2C instance
|
|
80
|
+
* @param roleId - Role ID to delete
|
|
81
|
+
*
|
|
82
|
+
* @example
|
|
83
|
+
* ```typescript
|
|
84
|
+
* await deleteBmRole(instance, 'MyCustomRole');
|
|
85
|
+
* ```
|
|
86
|
+
*/
|
|
87
|
+
export async function deleteBmRole(instance, roleId) {
|
|
88
|
+
const { error, response } = await instance.ocapi.DELETE('/roles/{id}', {
|
|
89
|
+
params: { path: { id: roleId } },
|
|
90
|
+
});
|
|
91
|
+
if (error) {
|
|
92
|
+
throw new Error(`Failed to delete role ${roleId}: ${getApiErrorMessage(error, response)}`, { cause: error });
|
|
93
|
+
}
|
|
94
|
+
}
|
|
95
|
+
/**
|
|
96
|
+
* Assigns a user to an access role on an instance.
|
|
97
|
+
*
|
|
98
|
+
* @param instance - B2C instance
|
|
99
|
+
* @param roleId - Role ID to grant
|
|
100
|
+
* @param login - User login (email)
|
|
101
|
+
* @returns The user object after assignment
|
|
102
|
+
*
|
|
103
|
+
* @example
|
|
104
|
+
* ```typescript
|
|
105
|
+
* const user = await grantBmRole(instance, 'Administrator', 'user@example.com');
|
|
106
|
+
* ```
|
|
107
|
+
*/
|
|
108
|
+
export async function grantBmRole(instance, roleId, login) {
|
|
109
|
+
const { data, error, response } = await instance.ocapi.PUT('/roles/{id}/users/{login}', {
|
|
110
|
+
params: { path: { id: roleId, login } },
|
|
111
|
+
});
|
|
112
|
+
if (error) {
|
|
113
|
+
throw new Error(`Failed to grant role ${roleId} to ${login}: ${getApiErrorMessage(error, response)}`, {
|
|
114
|
+
cause: error,
|
|
115
|
+
});
|
|
116
|
+
}
|
|
117
|
+
return data;
|
|
118
|
+
}
|
|
119
|
+
/**
|
|
120
|
+
* Unassigns a user from an access role on an instance.
|
|
121
|
+
*
|
|
122
|
+
* @param instance - B2C instance
|
|
123
|
+
* @param roleId - Role ID to revoke
|
|
124
|
+
* @param login - User login (email)
|
|
125
|
+
*
|
|
126
|
+
* @example
|
|
127
|
+
* ```typescript
|
|
128
|
+
* await revokeBmRole(instance, 'Administrator', 'user@example.com');
|
|
129
|
+
* ```
|
|
130
|
+
*/
|
|
131
|
+
export async function revokeBmRole(instance, roleId, login) {
|
|
132
|
+
const { error, response } = await instance.ocapi.DELETE('/roles/{id}/users/{login}', {
|
|
133
|
+
params: { path: { id: roleId, login } },
|
|
134
|
+
});
|
|
135
|
+
if (error) {
|
|
136
|
+
throw new Error(`Failed to revoke role ${roleId} from ${login}: ${getApiErrorMessage(error, response)}`, {
|
|
137
|
+
cause: error,
|
|
138
|
+
});
|
|
139
|
+
}
|
|
140
|
+
}
|
|
141
|
+
/**
|
|
142
|
+
* Gets permissions assigned to an access role.
|
|
143
|
+
*
|
|
144
|
+
* @param instance - B2C instance
|
|
145
|
+
* @param roleId - Role ID
|
|
146
|
+
* @returns Role permissions object
|
|
147
|
+
*
|
|
148
|
+
* @example
|
|
149
|
+
* ```typescript
|
|
150
|
+
* const permissions = await getBmRolePermissions(instance, 'Administrator');
|
|
151
|
+
* console.log(permissions.functional?.organization?.length);
|
|
152
|
+
* ```
|
|
153
|
+
*/
|
|
154
|
+
export async function getBmRolePermissions(instance, roleId) {
|
|
155
|
+
const { data, error, response } = await instance.ocapi.GET('/roles/{id}/permissions', {
|
|
156
|
+
params: { path: { id: roleId } },
|
|
157
|
+
});
|
|
158
|
+
if (error) {
|
|
159
|
+
throw new Error(`Failed to get permissions for role ${roleId}: ${getApiErrorMessage(error, response)}`, {
|
|
160
|
+
cause: error,
|
|
161
|
+
});
|
|
162
|
+
}
|
|
163
|
+
return data;
|
|
164
|
+
}
|
|
165
|
+
/**
|
|
166
|
+
* Sets (replaces) all permissions for an access role.
|
|
167
|
+
*
|
|
168
|
+
* This is a full replacement — all existing permissions are replaced with the provided set.
|
|
169
|
+
*
|
|
170
|
+
* @param instance - B2C instance
|
|
171
|
+
* @param roleId - Role ID
|
|
172
|
+
* @param permissions - Complete permissions object
|
|
173
|
+
* @returns Updated permissions
|
|
174
|
+
*
|
|
175
|
+
* @example
|
|
176
|
+
* ```typescript
|
|
177
|
+
* const perms = await getBmRolePermissions(instance, 'MyRole');
|
|
178
|
+
* // ... modify perms ...
|
|
179
|
+
* await setBmRolePermissions(instance, 'MyRole', perms);
|
|
180
|
+
* ```
|
|
181
|
+
*/
|
|
182
|
+
export async function setBmRolePermissions(instance, roleId, permissions) {
|
|
183
|
+
const { data, error, response } = await instance.ocapi.PUT('/roles/{id}/permissions', {
|
|
184
|
+
params: { path: { id: roleId } },
|
|
185
|
+
body: permissions,
|
|
186
|
+
});
|
|
187
|
+
if (error) {
|
|
188
|
+
throw new Error(`Failed to set permissions for role ${roleId}: ${getApiErrorMessage(error, response)}`, {
|
|
189
|
+
cause: error,
|
|
190
|
+
});
|
|
191
|
+
}
|
|
192
|
+
return data;
|
|
193
|
+
}
|
|
194
|
+
//# sourceMappingURL=roles.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"roles.js","sourceRoot":"","sources":["../../../../src/operations/bm-roles/roles.ts"],"names":[],"mappings":"AAYA,OAAO,EAAC,kBAAkB,EAAC,MAAM,8BAA8B,CAAC;AAmChE;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,QAAqB,EAAE,UAA8B,EAAE;IACvF,MAAM,EAAC,KAAK,EAAE,KAAK,EAAC,GAAG,OAAO,CAAC;IAE/B,MAAM,EAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAC,GAAG,MAAM,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE;QACjE,MAAM,EAAE,EAAC,KAAK,EAAE,EAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAC,EAAC;KAChD,CAAC,CAAC;IAEH,IAAI,KAAK,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CAAC,yBAAyB,kBAAkB,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,EAAE,EAAC,KAAK,EAAE,KAAK,EAAC,CAAC,CAAC;IAClG,CAAC;IAED,OAAO,IAAe,CAAC;AACzB,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAC7B,QAAqB,EACrB,MAAc,EACd,UAA4B,EAAE;IAE9B,MAAM,EAAC,MAAM,EAAC,GAAG,OAAO,CAAC;IAEzB,MAAM,EAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAC,GAAG,MAAM,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,aAAa,EAAE;QACtE,MAAM,EAAE,EAAC,IAAI,EAAE,EAAC,EAAE,EAAE,MAAM,EAAC,EAAE,KAAK,EAAE,EAAC,MAAM,EAAC,EAAC;KAC9C,CAAC,CAAC;IAEH,IAAI,KAAK,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CAAC,sBAAsB,MAAM,KAAK,kBAAkB,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,EAAE,EAAC,KAAK,EAAE,KAAK,EAAC,CAAC,CAAC;IAC1G,CAAC;IAED,OAAO,IAAc,CAAC;AACxB,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,QAAqB,EACrB,MAAc,EACd,OAA+B,EAAE;IAEjC,MAAM,EAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAC,GAAG,MAAM,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,aAAa,EAAE;QACtE,MAAM,EAAE,EAAC,IAAI,EAAE,EAAC,EAAE,EAAE,MAAM,EAAC,EAAC;QAC5B,IAAI,EAAE,EAAC,EAAE,EAAE,MAAM,EAAE,GAAG,IAAI,EAAkC;KAC7D,CAAC,CAAC;IAEH,IAAI,KAAK,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CAAC,yBAAyB,MAAM,KAAK,kBAAkB,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,EAAE,EAAC,KAAK,EAAE,KAAK,EAAC,CAAC,CAAC;IAC7G,CAAC;IAED,OAAO,IAAc,CAAC;AACxB,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,QAAqB,EAAE,MAAc;IACtE,MAAM,EAAC,KAAK,EAAE,QAAQ,EAAC,GAAG,MAAM,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,aAAa,EAAE;QACnE,MAAM,EAAE,EAAC,IAAI,EAAE,EAAC,EAAE,EAAE,MAAM,EAAC,EAAC;KAC7B,CAAC,CAAC;IAEH,IAAI,KAAK,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CAAC,yBAAyB,MAAM,KAAK,kBAAkB,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,EAAE,EAAC,KAAK,EAAE,KAAK,EAAC,CAAC,CAAC;IAC7G,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,QAAqB,EACrB,MAAc,EACd,KAAa;IAEb,MAAM,EAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAC,GAAG,MAAM,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,2BAA2B,EAAE;QACpF,MAAM,EAAE,EAAC,IAAI,EAAE,EAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAC,EAAC;KACpC,CAAC,CAAC;IAEH,IAAI,KAAK,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CAAC,wBAAwB,MAAM,OAAO,KAAK,KAAK,kBAAkB,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,EAAE;YACpG,KAAK,EAAE,KAAK;SACb,CAAC,CAAC;IACL,CAAC;IAED,OAAO,IAAqC,CAAC;AAC/C,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,QAAqB,EAAE,MAAc,EAAE,KAAa;IACrF,MAAM,EAAC,KAAK,EAAE,QAAQ,EAAC,GAAG,MAAM,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,2BAA2B,EAAE;QACjF,MAAM,EAAE,EAAC,IAAI,EAAE,EAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAC,EAAC;KACpC,CAAC,CAAC;IAEH,IAAI,KAAK,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CAAC,yBAAyB,MAAM,SAAS,KAAK,KAAK,kBAAkB,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,EAAE;YACvG,KAAK,EAAE,KAAK;SACb,CAAC,CAAC;IACL,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CAAC,QAAqB,EAAE,MAAc;IAC9E,MAAM,EAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAC,GAAG,MAAM,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,yBAAyB,EAAE;QAClF,MAAM,EAAE,EAAC,IAAI,EAAE,EAAC,EAAE,EAAE,MAAM,EAAC,EAAC;KAC7B,CAAC,CAAC;IAEH,IAAI,KAAK,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CAAC,sCAAsC,MAAM,KAAK,kBAAkB,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,EAAE;YACtG,KAAK,EAAE,KAAK;SACb,CAAC,CAAC;IACL,CAAC;IAED,OAAO,IAAyB,CAAC;AACnC,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,QAAqB,EACrB,MAAc,EACd,WAA8B;IAE9B,MAAM,EAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAC,GAAG,MAAM,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,yBAAyB,EAAE;QAClF,MAAM,EAAE,EAAC,IAAI,EAAE,EAAC,EAAE,EAAE,MAAM,EAAC,EAAC;QAC5B,IAAI,EAAE,WAAwD;KAC/D,CAAC,CAAC;IAEH,IAAI,KAAK,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CAAC,sCAAsC,MAAM,KAAK,kBAAkB,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,EAAE;YACtG,KAAK,EAAE,KAAK;SACb,CAAC,CAAC;IACL,CAAC;IAED,OAAO,IAAyB,CAAC;AACnC,CAAC"}
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { DEFAULT_MRT_ORIGIN } from '../../clients/mrt.js';
|
|
2
|
+
import { normalizeOriginUrl } from '../../config/mapping.js';
|
|
2
3
|
import { getLogger } from '../../logging/logger.js';
|
|
3
4
|
/** Known platform log levels. */
|
|
4
5
|
const PLATFORM_LEVELS = new Set(['ERROR', 'WARN', 'WARNING', 'INFO', 'DEBUG', 'TRACE']);
|
|
@@ -17,7 +18,7 @@ const HEARTBEAT_INTERVAL_MS = 5 * 60 * 1000;
|
|
|
17
18
|
export async function createLoggingToken(options, auth) {
|
|
18
19
|
const logger = getLogger();
|
|
19
20
|
const { projectSlug, environmentSlug, origin } = options;
|
|
20
|
-
const baseUrl = origin || DEFAULT_MRT_ORIGIN;
|
|
21
|
+
const baseUrl = normalizeOriginUrl(origin) || DEFAULT_MRT_ORIGIN;
|
|
21
22
|
logger.debug({ projectSlug, environmentSlug }, '[MRT] Creating logging token');
|
|
22
23
|
const url = `${baseUrl}/api/projects/${encodeURIComponent(projectSlug)}/target/${encodeURIComponent(environmentSlug)}/jwt/`;
|
|
23
24
|
const response = await auth.fetch(url, {
|
|
@@ -125,7 +126,7 @@ export function getLogsWebSocketUrl(origin) {
|
|
|
125
126
|
export async function tailMrtLogs(options, auth) {
|
|
126
127
|
const logger = getLogger();
|
|
127
128
|
const { projectSlug, environmentSlug, origin, user, onEntry, onConnect, onError, onClose } = options;
|
|
128
|
-
const baseOrigin = origin || DEFAULT_MRT_ORIGIN;
|
|
129
|
+
const baseOrigin = normalizeOriginUrl(origin) || DEFAULT_MRT_ORIGIN;
|
|
129
130
|
logger.debug({ projectSlug, environmentSlug, origin: baseOrigin }, '[MRT] Starting log tail');
|
|
130
131
|
// Step 1: Get JWT token
|
|
131
132
|
logger.trace({ projectSlug, environmentSlug }, '[MRT] Requesting logging JWT token');
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"tail-logs.js","sourceRoot":"","sources":["../../../../src/operations/mrt/tail-logs.ts"],"names":[],"mappings":"AAcA,OAAO,EAAC,kBAAkB,EAAC,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAC,SAAS,EAAC,MAAM,yBAAyB,CAAC;AAgElD,iCAAiC;AACjC,MAAM,eAAe,GAAG,IAAI,GAAG,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;AAExF,sEAAsE;AACtE,MAAM,qBAAqB,GAAG,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC;AAE5C;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CAAC,OAAkC,EAAE,IAAkB;IAC7F,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;IAC3B,MAAM,EAAC,WAAW,EAAE,eAAe,EAAE,MAAM,EAAC,GAAG,OAAO,CAAC;IACvD,MAAM,OAAO,GAAG,MAAM,IAAI,kBAAkB,CAAC;
|
|
1
|
+
{"version":3,"file":"tail-logs.js","sourceRoot":"","sources":["../../../../src/operations/mrt/tail-logs.ts"],"names":[],"mappings":"AAcA,OAAO,EAAC,kBAAkB,EAAC,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAC,kBAAkB,EAAC,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAC,SAAS,EAAC,MAAM,yBAAyB,CAAC;AAgElD,iCAAiC;AACjC,MAAM,eAAe,GAAG,IAAI,GAAG,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;AAExF,sEAAsE;AACtE,MAAM,qBAAqB,GAAG,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC;AAE5C;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CAAC,OAAkC,EAAE,IAAkB;IAC7F,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;IAC3B,MAAM,EAAC,WAAW,EAAE,eAAe,EAAE,MAAM,EAAC,GAAG,OAAO,CAAC;IACvD,MAAM,OAAO,GAAG,kBAAkB,CAAC,MAAM,CAAC,IAAI,kBAAkB,CAAC;IAEjE,MAAM,CAAC,KAAK,CAAC,EAAC,WAAW,EAAE,eAAe,EAAC,EAAE,8BAA8B,CAAC,CAAC;IAE7E,MAAM,GAAG,GAAG,GAAG,OAAO,iBAAiB,kBAAkB,CAAC,WAAW,CAAC,WAAW,kBAAkB,CAAC,eAAe,CAAC,OAAO,CAAC;IAE5H,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE;QACrC,MAAM,EAAE,MAAM;KACf,CAAC,CAAC;IAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC;QACnD,MAAM,IAAI,KAAK,CAAC,mCAAmC,QAAQ,CAAC,MAAM,MAAM,IAAI,EAAE,CAAC,CAAC;IAClF,CAAC;IAED,MAAM,IAAI,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAoB,CAAC;IACxD,MAAM,CAAC,KAAK,CAAC,6BAA6B,CAAC,CAAC;IAE5C,OAAO,IAAI,CAAC,KAAK,CAAC;AACpB,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,eAAe,CAAC,GAAW;IACzC,+DAA+D;IAC/D,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAE9B,IAAI,KAAK,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;QACtB,MAAM,CAAC,SAAS,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,YAAY,CAAC,GAAG,KAAK,CAAC;QAE7D,4EAA4E;QAC5E,IAAI,SAAS,IAAI,oBAAoB,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;YACtD,MAAM,OAAO,GAAG,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACxC,OAAO;gBACL,SAAS;gBACT,SAAS;gBACT,cAAc,EAAE,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS;gBAC/E,KAAK,EAAE,KAAK,IAAI,SAAS;gBACzB,OAAO;gBACP,GAAG;aACJ,CAAC;QACJ,CAAC;IACH,CAAC;IAED,uCAAuC;IACvC,MAAM,QAAQ,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAClC,IAAI,QAAQ,GAAG,CAAC,EAAE,CAAC;QACjB,MAAM,UAAU,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,WAAW,EAAE,CAAC;QACxD,IAAI,eAAe,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC;YACpC,OAAO;gBACL,KAAK,EAAE,UAAU;gBACjB,OAAO,EAAE,GAAG,CAAC,KAAK,CAAC,QAAQ,GAAG,CAAC,CAAC;gBAChC,GAAG;aACJ,CAAC;QACJ,CAAC;IACH,CAAC;IAED,uCAAuC;IACvC,OAAO;QACL,OAAO,EAAE,GAAG;QACZ,GAAG;KACJ,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,mBAAmB,CAAC,MAAc;IAChD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC;IAC5B,GAAG,CAAC,QAAQ,GAAG,MAAM,CAAC;IACtB,GAAG,CAAC,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IACrD,OAAO,GAAG,CAAC,MAAM,CAAC;AACpB,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,OAA2B,EAAE,IAAkB;IAC/E,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;IAC3B,MAAM,EAAC,WAAW,EAAE,eAAe,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,OAAO,EAAC,GAAG,OAAO,CAAC;IACnG,MAAM,UAAU,GAAG,kBAAkB,CAAC,MAAM,CAAC,IAAI,kBAAkB,CAAC;IAEpE,MAAM,CAAC,KAAK,CAAC,EAAC,WAAW,EAAE,eAAe,EAAE,MAAM,EAAE,UAAU,EAAC,EAAE,yBAAyB,CAAC,CAAC;IAE5F,wBAAwB;IACxB,MAAM,CAAC,KAAK,CAAC,EAAC,WAAW,EAAE,eAAe,EAAC,EAAE,oCAAoC,CAAC,CAAC;IACnF,MAAM,KAAK,GAAG,MAAM,kBAAkB,CAAC,EAAC,WAAW,EAAE,eAAe,EAAE,MAAM,EAAE,UAAU,EAAC,EAAE,IAAI,CAAC,CAAC;IACjG,MAAM,CAAC,KAAK,CAAC,kCAAkC,CAAC,CAAC;IAEjD,2EAA2E;IAC3E,MAAM,MAAM,GAAG,mBAAmB,CAAC,UAAU,CAAC,CAAC;IAC/C,MAAM,CAAC,KAAK,CAAC,EAAC,WAAW,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAC,EAAE,oDAAoD,CAAC,CAAC;IAEhH,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC;IAC9B,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;IAC/C,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,aAAa,EAAE,eAAe,CAAC,CAAC;IACvD,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC;IAC9C,IAAI,IAAI,EAAE,CAAC;QACT,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACvC,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,EAAC,KAAK,EAAE,KAAK,CAAC,QAAQ,EAAE,EAAC,EAAE,oCAAoC,CAAC,CAAC;IAE9E,yBAAyB;IACzB,MAAM,EAAE,GAAG,IAAI,SAAS,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC3C,MAAM,CAAC,KAAK,CAAC,EAAC,UAAU,EAAE,EAAE,CAAC,UAAU,EAAC,EAAE,kCAAkC,CAAC,CAAC;IAE9E,IAAI,cAA0D,CAAC;IAC/D,IAAI,OAAO,GAAG,KAAK,CAAC;IACpB,IAAI,QAAQ,GAAG,KAAK,CAAC;IAErB,MAAM,IAAI,GAAG,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACjD,EAAE,CAAC,gBAAgB,CAAC,MAAM,EAAE,GAAG,EAAE;YAC/B,MAAM,CAAC,KAAK,CAAC,wCAAwC,CAAC,CAAC;YACvD,SAAS,EAAE,EAAE,CAAC;YAEd,yEAAyE;YACzE,cAAc,GAAG,WAAW,CAAC,GAAG,EAAE;gBAChC,IAAI,EAAE,CAAC,UAAU,KAAK,SAAS,CAAC,IAAI,EAAE,CAAC;oBACrC,MAAM,CAAC,KAAK,CAAC,mCAAmC,CAAC,CAAC;oBAClD,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBACd,CAAC;YACH,CAAC,EAAE,qBAAqB,CAAC,CAAC;YAC1B,MAAM,CAAC,KAAK,CAAC,EAAC,UAAU,EAAE,qBAAqB,EAAC,EAAE,+BAA+B,CAAC,CAAC;QACrF,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC,KAAK,EAAE,EAAE;YACvC,MAAM,CAAC,KAAK,CAAC,EAAC,UAAU,EAAE,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,EAAC,EAAE,kCAAkC,CAAC,CAAC;YAC1F,IAAI,CAAC,OAAO;gBAAE,OAAO;YAErB,IAAI,CAAC;gBACH,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAA6B,CAAC;gBAC5E,MAAM,CAAC,KAAK,CAAC,EAAC,YAAY,EAAE,QAAQ,CAAC,MAAM,EAAC,EAAE,sCAAsC,CAAC,CAAC;gBACtF,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE,CAAC;oBAC3B,IAAI,GAAG,CAAC,OAAO,EAAE,CAAC;wBAChB,MAAM,KAAK,GAAG,eAAe,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;wBAC3C,OAAO,CAAC,KAAK,CAAC,CAAC;oBACjB,CAAC;gBACH,CAAC;YACH,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,MAAM,CAAC,KAAK,CACV,EAAC,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,EAAC,EACvD,yCAAyC,CAC1C,CAAC;YACJ,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,wEAAwE;QACxE,4EAA4E;QAC5E,2CAA2C;QAC3C,EAAE,CAAC,gBAAgB,CAAC,OAAO,EAAE,GAAG,EAAE;YAChC,QAAQ,GAAG,IAAI,CAAC;YAChB,MAAM,CAAC,KAAK,CAAC,yEAAyE,CAAC,CAAC;QAC1F,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YACrC,IAAI,cAAc,EAAE,CAAC;gBACnB,aAAa,CAAC,cAAc,CAAC,CAAC;gBAC9B,MAAM,CAAC,KAAK,CAAC,+BAA+B,CAAC,CAAC;YAChD,CAAC;YAED,MAAM,CAAC,KAAK,CACV,EAAC,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,KAAK,CAAC,IAAI,KAAK,IAAI,EAAC,EAC1F,wBAAwB,CACzB,CAAC;YAEF,IAAI,QAAQ,IAAI,CAAC,OAAO,EAAE,CAAC;gBACzB,uDAAuD;gBACvD,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,IAAI,cAAc,KAAK,CAAC,IAAI,EAAE,CAAC;gBAC1D,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,gCAAgC,MAAM,EAAE,CAAC,CAAC;gBAClE,MAAM,CAAC,KAAK,CAAC,EAAC,MAAM,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAC,EAAE,mCAAmC,CAAC,CAAC;gBACpG,OAAO,EAAE,CAAC,KAAK,CAAC,CAAC;gBACjB,OAAO,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;gBACpC,MAAM,CAAC,KAAK,CAAC,CAAC;YAChB,CAAC;iBAAM,CAAC;gBACN,OAAO,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;gBACpC,OAAO,EAAE,CAAC;YACZ,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,MAAM,IAAI,GAAG,GAAS,EAAE;QACtB,MAAM,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAC;QACxC,OAAO,GAAG,IAAI,CAAC;QACf,IAAI,cAAc,EAAE,CAAC;YACnB,aAAa,CAAC,cAAc,CAAC,CAAC;QAChC,CAAC;QACD,IAAI,EAAE,CAAC,UAAU,KAAK,SAAS,CAAC,IAAI,IAAI,EAAE,CAAC,UAAU,KAAK,SAAS,CAAC,UAAU,EAAE,CAAC;YAC/E,MAAM,CAAC,KAAK,CAAC,EAAC,UAAU,EAAE,EAAE,CAAC,UAAU,EAAC,EAAE,oCAAoC,CAAC,CAAC;YAChF,EAAE,CAAC,KAAK,EAAE,CAAC;QACb,CAAC;IACH,CAAC,CAAC;IAEF,OAAO,EAAC,IAAI,EAAE,IAAI,EAAC,CAAC;AACtB,CAAC"}
|
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
import type { B2CInstance } from '../../instance/index.js';
|
|
2
|
+
import type { WaitForJobOptions } from '../jobs/run.js';
|
|
3
|
+
/** The special site ID for Business Manager. */
|
|
4
|
+
export declare const BM_SITE_ID = "Sites-Site";
|
|
5
|
+
/** Position options for adding a cartridge. */
|
|
6
|
+
export type CartridgePosition = 'first' | 'last' | 'before' | 'after';
|
|
7
|
+
/** Options for adding a cartridge to a site's cartridge path. */
|
|
8
|
+
export interface AddCartridgeOptions {
|
|
9
|
+
/** Cartridge name to add. */
|
|
10
|
+
name: string;
|
|
11
|
+
/** Position to add the cartridge (default: 'first'). */
|
|
12
|
+
position: CartridgePosition;
|
|
13
|
+
/** Target cartridge name (required when position is 'before' or 'after'). */
|
|
14
|
+
target?: string;
|
|
15
|
+
}
|
|
16
|
+
/** Options for cartridge path update operations that may run jobs. */
|
|
17
|
+
export interface CartridgeUpdateOptions {
|
|
18
|
+
/** Callback for operation-level status messages (e.g. "Exporting site preferences..."). */
|
|
19
|
+
log?: (message: string) => void;
|
|
20
|
+
/** Wait options for underlying job execution (polling interval, timeout, progress). */
|
|
21
|
+
waitOptions?: WaitForJobOptions;
|
|
22
|
+
}
|
|
23
|
+
/** Result of a cartridge path operation. */
|
|
24
|
+
export interface CartridgePathResult {
|
|
25
|
+
/** Site ID. */
|
|
26
|
+
siteId: string;
|
|
27
|
+
/** Colon-separated cartridge path string. */
|
|
28
|
+
cartridges: string;
|
|
29
|
+
/** Cartridge names as an ordered array. */
|
|
30
|
+
cartridgeList: string[];
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* Gets the cartridge path for a site.
|
|
34
|
+
*
|
|
35
|
+
* Uses OCAPI `GET /sites/{site_id}` to read the cartridge path.
|
|
36
|
+
* Works for all sites including Business Manager (Sites-Site).
|
|
37
|
+
*
|
|
38
|
+
* @param instance - B2C instance to query
|
|
39
|
+
* @param siteId - Site ID (e.g. 'RefArch', 'Sites-Site')
|
|
40
|
+
* @returns Cartridge path result
|
|
41
|
+
*
|
|
42
|
+
* @example
|
|
43
|
+
* ```typescript
|
|
44
|
+
* const result = await getCartridgePath(instance, 'RefArch');
|
|
45
|
+
* console.log(result.cartridgeList); // ['app_storefront_base', 'plugin_applepay']
|
|
46
|
+
*
|
|
47
|
+
* // Business Manager
|
|
48
|
+
* const bmResult = await getCartridgePath(instance, 'Sites-Site');
|
|
49
|
+
* ```
|
|
50
|
+
*/
|
|
51
|
+
export declare function getCartridgePath(instance: B2CInstance, siteId: string): Promise<CartridgePathResult>;
|
|
52
|
+
/**
|
|
53
|
+
* Adds a cartridge to a site's cartridge path.
|
|
54
|
+
*
|
|
55
|
+
* For regular sites, tries OCAPI `POST /sites/{site_id}/cartridges` first,
|
|
56
|
+
* falling back to site archive import if OCAPI permissions are unavailable.
|
|
57
|
+
* For Business Manager (Sites-Site), always uses site archive import.
|
|
58
|
+
*
|
|
59
|
+
* @param instance - B2C instance
|
|
60
|
+
* @param siteId - Site ID
|
|
61
|
+
* @param options - Cartridge name, position, and optional target
|
|
62
|
+
* @returns Updated cartridge path
|
|
63
|
+
*
|
|
64
|
+
* @example
|
|
65
|
+
* ```typescript
|
|
66
|
+
* // Add to beginning (default)
|
|
67
|
+
* await addCartridge(instance, 'RefArch', { name: 'my_cartridge', position: 'first' });
|
|
68
|
+
*
|
|
69
|
+
* // Add before a specific cartridge
|
|
70
|
+
* await addCartridge(instance, 'RefArch', {
|
|
71
|
+
* name: 'my_cartridge', position: 'before', target: 'app_storefront_base'
|
|
72
|
+
* });
|
|
73
|
+
*
|
|
74
|
+
* // Business Manager
|
|
75
|
+
* await addCartridge(instance, 'Sites-Site', { name: 'bm_ext', position: 'first' });
|
|
76
|
+
* ```
|
|
77
|
+
*/
|
|
78
|
+
export declare function addCartridge(instance: B2CInstance, siteId: string, options: AddCartridgeOptions, updateOptions?: CartridgeUpdateOptions): Promise<CartridgePathResult>;
|
|
79
|
+
/**
|
|
80
|
+
* Removes a cartridge from a site's cartridge path.
|
|
81
|
+
*
|
|
82
|
+
* For regular sites, tries OCAPI `DELETE /sites/{site_id}/cartridges/{cartridge_name}`
|
|
83
|
+
* first, falling back to site archive import if OCAPI permissions are unavailable.
|
|
84
|
+
* For Business Manager (Sites-Site), always uses site archive import.
|
|
85
|
+
*
|
|
86
|
+
* @param instance - B2C instance
|
|
87
|
+
* @param siteId - Site ID
|
|
88
|
+
* @param cartridgeName - Name of the cartridge to remove
|
|
89
|
+
* @returns Updated cartridge path
|
|
90
|
+
*
|
|
91
|
+
* @example
|
|
92
|
+
* ```typescript
|
|
93
|
+
* await removeCartridge(instance, 'RefArch', 'old_cartridge');
|
|
94
|
+
* ```
|
|
95
|
+
*/
|
|
96
|
+
export declare function removeCartridge(instance: B2CInstance, siteId: string, cartridgeName: string, updateOptions?: CartridgeUpdateOptions): Promise<CartridgePathResult>;
|
|
97
|
+
/**
|
|
98
|
+
* Replaces the entire cartridge path for a site.
|
|
99
|
+
*
|
|
100
|
+
* For regular sites, tries OCAPI `PUT /sites/{site_id}/cartridges` first,
|
|
101
|
+
* falling back to site archive import if OCAPI permissions are unavailable.
|
|
102
|
+
* For Business Manager (Sites-Site), always uses site archive import.
|
|
103
|
+
*
|
|
104
|
+
* @param instance - B2C instance
|
|
105
|
+
* @param siteId - Site ID
|
|
106
|
+
* @param cartridges - New cartridge path (colon-separated string)
|
|
107
|
+
* @returns Updated cartridge path
|
|
108
|
+
*
|
|
109
|
+
* @example
|
|
110
|
+
* ```typescript
|
|
111
|
+
* await setCartridgePath(instance, 'RefArch', 'app_storefront_base:plugin_applepay');
|
|
112
|
+
* ```
|
|
113
|
+
*/
|
|
114
|
+
export declare function setCartridgePath(instance: B2CInstance, siteId: string, cartridges: string, updateOptions?: CartridgeUpdateOptions): Promise<CartridgePathResult>;
|