@salesforce/b2c-tooling-sdk 0.0.8 → 0.2.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/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 +15 -0
- package/dist/cjs/cli/base-command.js +58 -2
- package/dist/cjs/cli/base-command.js.map +1 -1
- package/dist/cjs/cli/hooks.d.ts +98 -5
- package/dist/cjs/cli/hooks.js.map +1 -1
- package/dist/cjs/cli/instance-command.d.ts +1 -0
- package/dist/cjs/cli/mrt-command.d.ts +2 -1
- package/dist/cjs/cli/mrt-command.js +3 -2
- package/dist/cjs/cli/mrt-command.js.map +1 -1
- package/dist/cjs/cli/oauth-command.d.ts +1 -0
- package/dist/cjs/cli/oauth-command.js +6 -0
- package/dist/cjs/cli/oauth-command.js.map +1 -1
- package/dist/cjs/cli/ods-command.d.ts +1 -0
- package/dist/cjs/cli/webdav-command.d.ts +1 -0
- package/dist/cjs/clients/cdn-zones.d.ts +154 -0
- package/dist/cjs/clients/cdn-zones.generated.d.ts +8330 -0
- package/dist/cjs/clients/cdn-zones.generated.js +6 -0
- package/dist/cjs/clients/cdn-zones.generated.js.map +1 -0
- package/dist/cjs/clients/cdn-zones.js +100 -0
- package/dist/cjs/clients/cdn-zones.js.map +1 -0
- package/dist/cjs/clients/error-utils.d.ts +35 -0
- package/dist/cjs/clients/error-utils.js +69 -0
- package/dist/cjs/clients/error-utils.js.map +1 -0
- package/dist/cjs/clients/index.d.ts +11 -2
- package/dist/cjs/clients/index.js +8 -1
- 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/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/mrt-b2c.d.ts +114 -0
- package/dist/cjs/clients/mrt-b2c.generated.d.ts +176 -0
- package/dist/cjs/clients/mrt-b2c.generated.js +6 -0
- package/dist/cjs/clients/mrt-b2c.generated.js.map +1 -0
- package/dist/cjs/clients/mrt-b2c.js +86 -0
- package/dist/cjs/clients/mrt-b2c.js.map +1 -0
- package/dist/cjs/clients/scapi-schemas.d.ts +132 -0
- package/dist/cjs/clients/scapi-schemas.generated.d.ts +328 -0
- package/dist/cjs/clients/scapi-schemas.generated.js +6 -0
- package/dist/cjs/clients/scapi-schemas.generated.js.map +1 -0
- package/dist/cjs/clients/scapi-schemas.js +95 -0
- package/dist/cjs/clients/scapi-schemas.js.map +1 -0
- 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/config/dw-json.d.ts +6 -0
- package/dist/cjs/config/dw-json.js.map +1 -1
- package/dist/cjs/config/mapping.js +3 -0
- package/dist/cjs/config/mapping.js.map +1 -1
- package/dist/cjs/config/resolver.d.ts +2 -1
- package/dist/cjs/config/resolver.js +14 -7
- package/dist/cjs/config/resolver.js.map +1 -1
- package/dist/cjs/config/sources/dw-json-source.d.ts +1 -0
- package/dist/cjs/config/sources/dw-json-source.js +1 -0
- package/dist/cjs/config/sources/dw-json-source.js.map +1 -1
- package/dist/cjs/config/sources/index.d.ts +1 -0
- package/dist/cjs/config/sources/index.js +1 -0
- package/dist/cjs/config/sources/index.js.map +1 -1
- package/dist/cjs/config/sources/mobify-source.d.ts +1 -0
- package/dist/cjs/config/sources/mobify-source.js +1 -0
- package/dist/cjs/config/sources/mobify-source.js.map +1 -1
- package/dist/cjs/config/sources/package-json-source.d.ts +14 -0
- package/dist/cjs/config/sources/package-json-source.js +86 -0
- package/dist/cjs/config/sources/package-json-source.js.map +1 -0
- package/dist/cjs/config/types.d.ts +14 -0
- package/dist/cjs/index.d.ts +3 -2
- package/dist/cjs/index.js +3 -1
- package/dist/cjs/index.js.map +1 -1
- package/dist/cjs/operations/code/deploy.js +9 -3
- package/dist/cjs/operations/code/deploy.js.map +1 -1
- package/dist/cjs/operations/mrt/access-control.d.ts +192 -0
- package/dist/cjs/operations/mrt/access-control.js +152 -0
- package/dist/cjs/operations/mrt/access-control.js.map +1 -0
- package/dist/cjs/operations/mrt/b2c-config.d.ts +201 -0
- package/dist/cjs/operations/mrt/b2c-config.js +195 -0
- package/dist/cjs/operations/mrt/b2c-config.js.map +1 -0
- package/dist/cjs/operations/mrt/cache.d.ts +80 -0
- package/dist/cjs/operations/mrt/cache.js +65 -0
- package/dist/cjs/operations/mrt/cache.js.map +1 -0
- package/dist/cjs/operations/mrt/deployment.d.ts +157 -0
- package/dist/cjs/operations/mrt/deployment.js +109 -0
- package/dist/cjs/operations/mrt/deployment.js.map +1 -0
- package/dist/cjs/operations/mrt/env.d.ts +141 -0
- package/dist/cjs/operations/mrt/env.js +119 -0
- package/dist/cjs/operations/mrt/env.js.map +1 -1
- package/dist/cjs/operations/mrt/index.d.ts +24 -4
- package/dist/cjs/operations/mrt/index.js +23 -3
- package/dist/cjs/operations/mrt/index.js.map +1 -1
- package/dist/cjs/operations/mrt/member.d.ts +281 -0
- package/dist/cjs/operations/mrt/member.js +244 -0
- package/dist/cjs/operations/mrt/member.js.map +1 -0
- package/dist/cjs/operations/mrt/notification.d.ts +252 -0
- package/dist/cjs/operations/mrt/notification.js +206 -0
- package/dist/cjs/operations/mrt/notification.js.map +1 -0
- package/dist/cjs/operations/mrt/organization.d.ts +80 -0
- package/dist/cjs/operations/mrt/organization.js +53 -0
- package/dist/cjs/operations/mrt/organization.js.map +1 -0
- package/dist/cjs/operations/mrt/project.d.ts +261 -0
- package/dist/cjs/operations/mrt/project.js +232 -0
- package/dist/cjs/operations/mrt/project.js.map +1 -0
- package/dist/cjs/operations/mrt/push.d.ts +122 -8
- package/dist/cjs/operations/mrt/push.js +83 -10
- package/dist/cjs/operations/mrt/push.js.map +1 -1
- package/dist/cjs/operations/mrt/redirect.d.ts +337 -0
- package/dist/cjs/operations/mrt/redirect.js +256 -0
- package/dist/cjs/operations/mrt/redirect.js.map +1 -0
- package/dist/cjs/operations/mrt/user.d.ts +135 -0
- package/dist/cjs/operations/mrt/user.js +153 -0
- package/dist/cjs/operations/mrt/user.js.map +1 -0
- package/dist/cjs/operations/scapi-schemas/collapse.d.ts +150 -0
- package/dist/cjs/operations/scapi-schemas/collapse.js +180 -0
- package/dist/cjs/operations/scapi-schemas/collapse.js.map +1 -0
- package/dist/cjs/operations/scapi-schemas/index.d.ts +53 -0
- package/dist/cjs/operations/scapi-schemas/index.js +59 -0
- package/dist/cjs/operations/scapi-schemas/index.js.map +1 -0
- package/dist/cjs/skills/agents.d.ts +41 -0
- package/dist/cjs/skills/agents.js +159 -0
- package/dist/cjs/skills/agents.js.map +1 -0
- package/dist/cjs/skills/github.d.ts +47 -0
- package/dist/cjs/skills/github.js +246 -0
- package/dist/cjs/skills/github.js.map +1 -0
- package/dist/cjs/skills/index.d.ts +42 -0
- package/dist/cjs/skills/index.js +14 -0
- package/dist/cjs/skills/index.js.map +1 -0
- package/dist/cjs/skills/installer.d.ts +34 -0
- package/dist/cjs/skills/installer.js +181 -0
- package/dist/cjs/skills/installer.js.map +1 -0
- package/dist/cjs/skills/parser.d.ts +39 -0
- package/dist/cjs/skills/parser.js +131 -0
- package/dist/cjs/skills/parser.js.map +1 -0
- package/dist/cjs/skills/types.d.ts +134 -0
- package/dist/cjs/skills/types.js +7 -0
- package/dist/cjs/skills/types.js.map +1 -0
- package/dist/cjs/test-utils/config-isolation.d.ts +2 -0
- package/dist/cjs/test-utils/config-isolation.js +41 -0
- package/dist/cjs/test-utils/config-isolation.js.map +1 -0
- package/dist/cjs/test-utils/index.d.ts +1 -0
- package/dist/cjs/test-utils/index.js +7 -0
- package/dist/cjs/test-utils/index.js.map +1 -0
- 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 +15 -0
- package/dist/esm/cli/base-command.js +58 -2
- package/dist/esm/cli/base-command.js.map +1 -1
- package/dist/esm/cli/hooks.d.ts +98 -5
- package/dist/esm/cli/hooks.js.map +1 -1
- package/dist/esm/cli/instance-command.d.ts +1 -0
- package/dist/esm/cli/mrt-command.d.ts +2 -1
- package/dist/esm/cli/mrt-command.js +3 -2
- package/dist/esm/cli/mrt-command.js.map +1 -1
- package/dist/esm/cli/oauth-command.d.ts +1 -0
- package/dist/esm/cli/oauth-command.js +6 -0
- package/dist/esm/cli/oauth-command.js.map +1 -1
- package/dist/esm/cli/ods-command.d.ts +1 -0
- package/dist/esm/cli/webdav-command.d.ts +1 -0
- package/dist/esm/clients/cdn-zones.d.ts +154 -0
- package/dist/esm/clients/cdn-zones.generated.d.ts +8330 -0
- package/dist/esm/clients/cdn-zones.generated.js +6 -0
- package/dist/esm/clients/cdn-zones.generated.js.map +1 -0
- package/dist/esm/clients/cdn-zones.js +100 -0
- package/dist/esm/clients/cdn-zones.js.map +1 -0
- package/dist/esm/clients/error-utils.d.ts +35 -0
- package/dist/esm/clients/error-utils.js +69 -0
- package/dist/esm/clients/error-utils.js.map +1 -0
- package/dist/esm/clients/index.d.ts +11 -2
- package/dist/esm/clients/index.js +8 -1
- 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/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/mrt-b2c.d.ts +114 -0
- package/dist/esm/clients/mrt-b2c.generated.d.ts +176 -0
- package/dist/esm/clients/mrt-b2c.generated.js +6 -0
- package/dist/esm/clients/mrt-b2c.generated.js.map +1 -0
- package/dist/esm/clients/mrt-b2c.js +86 -0
- package/dist/esm/clients/mrt-b2c.js.map +1 -0
- package/dist/esm/clients/scapi-schemas.d.ts +132 -0
- package/dist/esm/clients/scapi-schemas.generated.d.ts +328 -0
- package/dist/esm/clients/scapi-schemas.generated.js +6 -0
- package/dist/esm/clients/scapi-schemas.generated.js.map +1 -0
- package/dist/esm/clients/scapi-schemas.js +95 -0
- package/dist/esm/clients/scapi-schemas.js.map +1 -0
- 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/config/dw-json.d.ts +6 -0
- package/dist/esm/config/dw-json.js.map +1 -1
- package/dist/esm/config/mapping.js +3 -0
- package/dist/esm/config/mapping.js.map +1 -1
- package/dist/esm/config/resolver.d.ts +2 -1
- package/dist/esm/config/resolver.js +14 -7
- package/dist/esm/config/resolver.js.map +1 -1
- package/dist/esm/config/sources/dw-json-source.d.ts +1 -0
- package/dist/esm/config/sources/dw-json-source.js +1 -0
- package/dist/esm/config/sources/dw-json-source.js.map +1 -1
- package/dist/esm/config/sources/index.d.ts +1 -0
- package/dist/esm/config/sources/index.js +1 -0
- package/dist/esm/config/sources/index.js.map +1 -1
- package/dist/esm/config/sources/mobify-source.d.ts +1 -0
- package/dist/esm/config/sources/mobify-source.js +1 -0
- package/dist/esm/config/sources/mobify-source.js.map +1 -1
- package/dist/esm/config/sources/package-json-source.d.ts +14 -0
- package/dist/esm/config/sources/package-json-source.js +86 -0
- package/dist/esm/config/sources/package-json-source.js.map +1 -0
- package/dist/esm/config/types.d.ts +14 -0
- package/dist/esm/index.d.ts +3 -2
- package/dist/esm/index.js +3 -1
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/operations/code/deploy.js +9 -3
- package/dist/esm/operations/code/deploy.js.map +1 -1
- package/dist/esm/operations/mrt/access-control.d.ts +192 -0
- package/dist/esm/operations/mrt/access-control.js +152 -0
- package/dist/esm/operations/mrt/access-control.js.map +1 -0
- package/dist/esm/operations/mrt/b2c-config.d.ts +201 -0
- package/dist/esm/operations/mrt/b2c-config.js +195 -0
- package/dist/esm/operations/mrt/b2c-config.js.map +1 -0
- package/dist/esm/operations/mrt/cache.d.ts +80 -0
- package/dist/esm/operations/mrt/cache.js +65 -0
- package/dist/esm/operations/mrt/cache.js.map +1 -0
- package/dist/esm/operations/mrt/deployment.d.ts +157 -0
- package/dist/esm/operations/mrt/deployment.js +109 -0
- package/dist/esm/operations/mrt/deployment.js.map +1 -0
- package/dist/esm/operations/mrt/env.d.ts +141 -0
- package/dist/esm/operations/mrt/env.js +119 -0
- package/dist/esm/operations/mrt/env.js.map +1 -1
- package/dist/esm/operations/mrt/index.d.ts +24 -4
- package/dist/esm/operations/mrt/index.js +23 -3
- package/dist/esm/operations/mrt/index.js.map +1 -1
- package/dist/esm/operations/mrt/member.d.ts +281 -0
- package/dist/esm/operations/mrt/member.js +244 -0
- package/dist/esm/operations/mrt/member.js.map +1 -0
- package/dist/esm/operations/mrt/notification.d.ts +252 -0
- package/dist/esm/operations/mrt/notification.js +206 -0
- package/dist/esm/operations/mrt/notification.js.map +1 -0
- package/dist/esm/operations/mrt/organization.d.ts +80 -0
- package/dist/esm/operations/mrt/organization.js +53 -0
- package/dist/esm/operations/mrt/organization.js.map +1 -0
- package/dist/esm/operations/mrt/project.d.ts +261 -0
- package/dist/esm/operations/mrt/project.js +232 -0
- package/dist/esm/operations/mrt/project.js.map +1 -0
- package/dist/esm/operations/mrt/push.d.ts +122 -8
- package/dist/esm/operations/mrt/push.js +83 -10
- package/dist/esm/operations/mrt/push.js.map +1 -1
- package/dist/esm/operations/mrt/redirect.d.ts +337 -0
- package/dist/esm/operations/mrt/redirect.js +256 -0
- package/dist/esm/operations/mrt/redirect.js.map +1 -0
- package/dist/esm/operations/mrt/user.d.ts +135 -0
- package/dist/esm/operations/mrt/user.js +153 -0
- package/dist/esm/operations/mrt/user.js.map +1 -0
- package/dist/esm/operations/scapi-schemas/collapse.d.ts +150 -0
- package/dist/esm/operations/scapi-schemas/collapse.js +180 -0
- package/dist/esm/operations/scapi-schemas/collapse.js.map +1 -0
- package/dist/esm/operations/scapi-schemas/index.d.ts +53 -0
- package/dist/esm/operations/scapi-schemas/index.js +59 -0
- package/dist/esm/operations/scapi-schemas/index.js.map +1 -0
- package/dist/esm/skills/agents.d.ts +41 -0
- package/dist/esm/skills/agents.js +159 -0
- package/dist/esm/skills/agents.js.map +1 -0
- package/dist/esm/skills/github.d.ts +47 -0
- package/dist/esm/skills/github.js +246 -0
- package/dist/esm/skills/github.js.map +1 -0
- package/dist/esm/skills/index.d.ts +42 -0
- package/dist/esm/skills/index.js +14 -0
- package/dist/esm/skills/index.js.map +1 -0
- package/dist/esm/skills/installer.d.ts +34 -0
- package/dist/esm/skills/installer.js +181 -0
- package/dist/esm/skills/installer.js.map +1 -0
- package/dist/esm/skills/parser.d.ts +39 -0
- package/dist/esm/skills/parser.js +131 -0
- package/dist/esm/skills/parser.js.map +1 -0
- package/dist/esm/skills/types.d.ts +134 -0
- package/dist/esm/skills/types.js +7 -0
- package/dist/esm/skills/types.js.map +1 -0
- package/dist/esm/test-utils/config-isolation.d.ts +2 -0
- package/dist/esm/test-utils/config-isolation.js +41 -0
- package/dist/esm/test-utils/config-isolation.js.map +1 -0
- package/dist/esm/test-utils/index.d.ts +1 -0
- package/dist/esm/test-utils/index.js +7 -0
- package/dist/esm/test-utils/index.js.map +1 -0
- 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 +35 -2
- package/specs/cdn-zones-v1.yaml +9324 -0
- package/specs/mrt-b2c.json +384 -0
- package/specs/scapi-schemas-v1.yaml +341 -0
|
@@ -122,28 +122,101 @@ export async function uploadBundle(client, projectSlug, bundle, target) {
|
|
|
122
122
|
}
|
|
123
123
|
}
|
|
124
124
|
/**
|
|
125
|
-
*
|
|
125
|
+
* Lists bundles for an MRT project.
|
|
126
126
|
*
|
|
127
|
-
* @param
|
|
128
|
-
* @param
|
|
129
|
-
* @
|
|
130
|
-
* @
|
|
127
|
+
* @param options - List options including project slug
|
|
128
|
+
* @param auth - Authentication strategy (ApiKeyStrategy)
|
|
129
|
+
* @returns Paginated list of bundles
|
|
130
|
+
* @throws Error if request fails
|
|
131
|
+
*
|
|
132
|
+
* @example
|
|
133
|
+
* ```typescript
|
|
134
|
+
* import { ApiKeyStrategy } from '@salesforce/b2c-tooling-sdk/auth';
|
|
135
|
+
* import { listBundles } from '@salesforce/b2c-tooling-sdk/operations/mrt';
|
|
136
|
+
*
|
|
137
|
+
* const auth = new ApiKeyStrategy(process.env.MRT_API_KEY!, 'Authorization');
|
|
138
|
+
*
|
|
139
|
+
* const result = await listBundles({
|
|
140
|
+
* projectSlug: 'my-storefront'
|
|
141
|
+
* }, auth);
|
|
142
|
+
*
|
|
143
|
+
* for (const bundle of result.bundles) {
|
|
144
|
+
* console.log(`Bundle ${bundle.id}: ${bundle.message}`);
|
|
145
|
+
* }
|
|
146
|
+
* ```
|
|
131
147
|
*/
|
|
132
|
-
export async function listBundles(
|
|
148
|
+
export async function listBundles(options, auth) {
|
|
133
149
|
const logger = getLogger();
|
|
150
|
+
const { projectSlug, limit, offset, origin } = options;
|
|
134
151
|
logger.debug({ projectSlug }, '[MRT] Listing bundles');
|
|
152
|
+
const client = createMrtClient({ origin: origin || DEFAULT_MRT_ORIGIN }, auth);
|
|
135
153
|
const { data, error } = await client.GET('/api/projects/{project_slug}/bundles/', {
|
|
136
154
|
params: {
|
|
137
155
|
path: { project_slug: projectSlug },
|
|
138
156
|
query: {
|
|
139
|
-
limit
|
|
140
|
-
offset
|
|
157
|
+
limit,
|
|
158
|
+
offset,
|
|
141
159
|
},
|
|
142
160
|
},
|
|
143
161
|
});
|
|
144
162
|
if (error) {
|
|
145
|
-
|
|
163
|
+
const errorMessage = typeof error === 'object' && error !== null && 'message' in error
|
|
164
|
+
? String(error.message)
|
|
165
|
+
: JSON.stringify(error);
|
|
166
|
+
throw new Error(`Failed to list bundles: ${errorMessage}`);
|
|
167
|
+
}
|
|
168
|
+
logger.debug({ count: data.count }, '[MRT] Bundles listed');
|
|
169
|
+
return {
|
|
170
|
+
count: data.count ?? 0,
|
|
171
|
+
next: data.next ?? null,
|
|
172
|
+
previous: data.previous ?? null,
|
|
173
|
+
bundles: data.results ?? [],
|
|
174
|
+
};
|
|
175
|
+
}
|
|
176
|
+
/**
|
|
177
|
+
* Gets a presigned URL to download a bundle archive.
|
|
178
|
+
*
|
|
179
|
+
* The returned URL is valid for one hour.
|
|
180
|
+
*
|
|
181
|
+
* @param options - Download options
|
|
182
|
+
* @param auth - Authentication strategy (ApiKeyStrategy)
|
|
183
|
+
* @returns Download URL result
|
|
184
|
+
* @throws Error if request fails
|
|
185
|
+
*
|
|
186
|
+
* @example
|
|
187
|
+
* ```typescript
|
|
188
|
+
* import { ApiKeyStrategy } from '@salesforce/b2c-tooling-sdk/auth';
|
|
189
|
+
* import { downloadBundle } from '@salesforce/b2c-tooling-sdk/operations/mrt';
|
|
190
|
+
*
|
|
191
|
+
* const auth = new ApiKeyStrategy(process.env.MRT_API_KEY!, 'Authorization');
|
|
192
|
+
*
|
|
193
|
+
* const result = await downloadBundle({
|
|
194
|
+
* projectSlug: 'my-storefront',
|
|
195
|
+
* bundleId: 12345
|
|
196
|
+
* }, auth);
|
|
197
|
+
*
|
|
198
|
+
* console.log(`Download URL: ${result.downloadUrl}`);
|
|
199
|
+
* ```
|
|
200
|
+
*/
|
|
201
|
+
export async function downloadBundle(options, auth) {
|
|
202
|
+
const logger = getLogger();
|
|
203
|
+
const { projectSlug, bundleId, origin } = options;
|
|
204
|
+
logger.debug({ projectSlug, bundleId }, '[MRT] Getting bundle download URL');
|
|
205
|
+
const client = createMrtClient({ origin: origin || DEFAULT_MRT_ORIGIN }, auth);
|
|
206
|
+
const { data, error } = await client.GET('/api/projects/{project_slug}/bundles/{bundle_id}/download/', {
|
|
207
|
+
params: {
|
|
208
|
+
path: { project_slug: projectSlug, bundle_id: String(bundleId) },
|
|
209
|
+
},
|
|
210
|
+
});
|
|
211
|
+
if (error) {
|
|
212
|
+
const errorMessage = typeof error === 'object' && error !== null && 'message' in error
|
|
213
|
+
? String(error.message)
|
|
214
|
+
: JSON.stringify(error);
|
|
215
|
+
throw new Error(`Failed to get bundle download URL: ${errorMessage}`);
|
|
146
216
|
}
|
|
147
|
-
|
|
217
|
+
logger.debug({ bundleId }, '[MRT] Bundle download URL retrieved');
|
|
218
|
+
return {
|
|
219
|
+
downloadUrl: data.download_url,
|
|
220
|
+
};
|
|
148
221
|
}
|
|
149
222
|
//# sourceMappingURL=push.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"push.js","sourceRoot":"","sources":["../../../../src/operations/mrt/push.ts"],"names":[],"mappings":"AAaA,OAAO,EAAC,eAAe,EAAE,kBAAkB,EAAC,MAAM,sBAAsB,CAAC;AAEzE,OAAO,EAAC,SAAS,EAAC,MAAM,yBAAyB,CAAC;AAClD,OAAO,EAAC,YAAY,EAAC,MAAM,aAAa,CAAC;AAkDzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,OAAoB,EAAE,IAAkB;IACvE,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;IAC3B,MAAM,EAAC,WAAW,EAAE,MAAM,EAAE,MAAM,EAAC,GAAG,OAAO,CAAC;IAE9C,MAAM,CAAC,KAAK,CAAC,EAAC,WAAW,EAAE,MAAM,EAAC,EAAE,sBAAsB,CAAC,CAAC;IAE5D,oBAAoB;IACpB,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,OAAO,CAAC,CAAC;IAE3C,oBAAoB;IACpB,MAAM,MAAM,GAAG,eAAe,CAAC,EAAC,MAAM,EAAE,MAAM,IAAI,kBAAkB,EAAC,EAAE,IAAI,CAAC,CAAC;IAE7E,oBAAoB;IACpB,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IAEvE,MAAM,CAAC,KAAK,CAAC,EAAC,QAAQ,EAAE,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,CAAC,QAAQ,EAAC,EAAE,kCAAkC,CAAC,CAAC;IAEzG,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,MAAiB,EACjB,WAAmB,EACnB,MAAc,EACd,MAAe;IAEf,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;IAE3B,mDAAmD;IACnD,IAAI,MAAM,EAAE,CAAC;QACX,MAAM,CAAC,KAAK,CAAC,EAAC,WAAW,EAAE,MAAM,EAAC,EAAE,sCAAsC,CAAC,CAAC;QAE5E,MAAM,EAAC,IAAI,EAAE,KAAK,EAAC,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,oDAAoD,EAAE;YAC5F,MAAM,EAAE;gBACN,IAAI,EAAE;oBACJ,YAAY,EAAE,WAAW;oBACzB,WAAW,EAAE,MAAM;iBACpB;aACF;YACD,IAAI,EAAE;gBACJ,OAAO,EAAE,MAAM,CAAC,OAAO;gBACvB,QAAQ,EAAE,MAAM,CAAC,QAAQ;gBACzB,IAAI,EAAE,MAAM,CAAC,IAAI;gBACjB,cAAc,EAAE,MAAM,CAAC,cAAc;gBACrC,QAAQ,EAAE,MAAM,CAAC,QAAQ;gBACzB,UAAU,EAAE,MAAM,CAAC,UAAU;aAC9B;SACF,CAAC,CAAC;QAEH,IAAI,KAAK,EAAE,CAAC;YACV,MAAM,IAAI,KAAK,CAAC,0BAA0B,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACrE,CAAC;QAED,MAAM,SAAS,GAAG,IAAoC,CAAC;QAEvD,OAAO;YACL,QAAQ,EAAE,SAAS,CAAC,SAAS;YAC7B,WAAW;YACX,MAAM;YACN,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,MAAM,CAAC,OAAO;SACxB,CAAC;IACJ,CAAC;SAAM,CAAC;QACN,MAAM,CAAC,KAAK,CAAC,EAAC,WAAW,EAAC,EAAE,wCAAwC,CAAC,CAAC;QAEtE,MAAM,EAAC,IAAI,EAAE,KAAK,EAAC,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,sCAAsC,EAAE;YAC9E,MAAM,EAAE;gBACN,IAAI,EAAE;oBACJ,YAAY,EAAE,WAAW;iBAC1B;aACF;YACD,IAAI,EAAE;gBACJ,OAAO,EAAE,MAAM,CAAC,OAAO;gBACvB,QAAQ,EAAE,MAAM,CAAC,QAAQ;gBACzB,IAAI,EAAE,MAAM,CAAC,IAAI;gBACjB,cAAc,EAAE,MAAM,CAAC,cAAc;gBACrC,QAAQ,EAAE,MAAM,CAAC,QAAQ;gBACzB,UAAU,EAAE,MAAM,CAAC,UAAU;aAC9B;SACF,CAAC,CAAC;QAEH,IAAI,KAAK,EAAE,CAAC;YACV,MAAM,IAAI,KAAK,CAAC,0BAA0B,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACrE,CAAC;QAED,MAAM,SAAS,GAAG,IAAoC,CAAC;QAEvD,OAAO;YACL,QAAQ,EAAE,SAAS,CAAC,SAAS;YAC7B,WAAW;YACX,QAAQ,EAAE,KAAK;YACf,OAAO,EAAE,MAAM,CAAC,OAAO;SACxB,CAAC;IACJ,CAAC;AACH,CAAC;
|
|
1
|
+
{"version":3,"file":"push.js","sourceRoot":"","sources":["../../../../src/operations/mrt/push.ts"],"names":[],"mappings":"AAaA,OAAO,EAAC,eAAe,EAAE,kBAAkB,EAAC,MAAM,sBAAsB,CAAC;AAEzE,OAAO,EAAC,SAAS,EAAC,MAAM,yBAAyB,CAAC;AAClD,OAAO,EAAC,YAAY,EAAC,MAAM,aAAa,CAAC;AAkDzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,OAAoB,EAAE,IAAkB;IACvE,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;IAC3B,MAAM,EAAC,WAAW,EAAE,MAAM,EAAE,MAAM,EAAC,GAAG,OAAO,CAAC;IAE9C,MAAM,CAAC,KAAK,CAAC,EAAC,WAAW,EAAE,MAAM,EAAC,EAAE,sBAAsB,CAAC,CAAC;IAE5D,oBAAoB;IACpB,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,OAAO,CAAC,CAAC;IAE3C,oBAAoB;IACpB,MAAM,MAAM,GAAG,eAAe,CAAC,EAAC,MAAM,EAAE,MAAM,IAAI,kBAAkB,EAAC,EAAE,IAAI,CAAC,CAAC;IAE7E,oBAAoB;IACpB,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IAEvE,MAAM,CAAC,KAAK,CAAC,EAAC,QAAQ,EAAE,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,CAAC,QAAQ,EAAC,EAAE,kCAAkC,CAAC,CAAC;IAEzG,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,MAAiB,EACjB,WAAmB,EACnB,MAAc,EACd,MAAe;IAEf,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;IAE3B,mDAAmD;IACnD,IAAI,MAAM,EAAE,CAAC;QACX,MAAM,CAAC,KAAK,CAAC,EAAC,WAAW,EAAE,MAAM,EAAC,EAAE,sCAAsC,CAAC,CAAC;QAE5E,MAAM,EAAC,IAAI,EAAE,KAAK,EAAC,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,oDAAoD,EAAE;YAC5F,MAAM,EAAE;gBACN,IAAI,EAAE;oBACJ,YAAY,EAAE,WAAW;oBACzB,WAAW,EAAE,MAAM;iBACpB;aACF;YACD,IAAI,EAAE;gBACJ,OAAO,EAAE,MAAM,CAAC,OAAO;gBACvB,QAAQ,EAAE,MAAM,CAAC,QAAQ;gBACzB,IAAI,EAAE,MAAM,CAAC,IAAI;gBACjB,cAAc,EAAE,MAAM,CAAC,cAAc;gBACrC,QAAQ,EAAE,MAAM,CAAC,QAAQ;gBACzB,UAAU,EAAE,MAAM,CAAC,UAAU;aAC9B;SACF,CAAC,CAAC;QAEH,IAAI,KAAK,EAAE,CAAC;YACV,MAAM,IAAI,KAAK,CAAC,0BAA0B,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACrE,CAAC;QAED,MAAM,SAAS,GAAG,IAAoC,CAAC;QAEvD,OAAO;YACL,QAAQ,EAAE,SAAS,CAAC,SAAS;YAC7B,WAAW;YACX,MAAM;YACN,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,MAAM,CAAC,OAAO;SACxB,CAAC;IACJ,CAAC;SAAM,CAAC;QACN,MAAM,CAAC,KAAK,CAAC,EAAC,WAAW,EAAC,EAAE,wCAAwC,CAAC,CAAC;QAEtE,MAAM,EAAC,IAAI,EAAE,KAAK,EAAC,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,sCAAsC,EAAE;YAC9E,MAAM,EAAE;gBACN,IAAI,EAAE;oBACJ,YAAY,EAAE,WAAW;iBAC1B;aACF;YACD,IAAI,EAAE;gBACJ,OAAO,EAAE,MAAM,CAAC,OAAO;gBACvB,QAAQ,EAAE,MAAM,CAAC,QAAQ;gBACzB,IAAI,EAAE,MAAM,CAAC,IAAI;gBACjB,cAAc,EAAE,MAAM,CAAC,cAAc;gBACrC,QAAQ,EAAE,MAAM,CAAC,QAAQ;gBACzB,UAAU,EAAE,MAAM,CAAC,UAAU;aAC9B;SACF,CAAC,CAAC;QAEH,IAAI,KAAK,EAAE,CAAC;YACV,MAAM,IAAI,KAAK,CAAC,0BAA0B,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACrE,CAAC;QAED,MAAM,SAAS,GAAG,IAAoC,CAAC;QAEvD,OAAO;YACL,QAAQ,EAAE,SAAS,CAAC,SAAS;YAC7B,WAAW;YACX,QAAQ,EAAE,KAAK;YACf,OAAO,EAAE,MAAM,CAAC,OAAO;SACxB,CAAC;IACJ,CAAC;AACH,CAAC;AA0DD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,OAA2B,EAAE,IAAkB;IAC/E,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;IAC3B,MAAM,EAAC,WAAW,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAC,GAAG,OAAO,CAAC;IAErD,MAAM,CAAC,KAAK,CAAC,EAAC,WAAW,EAAC,EAAE,uBAAuB,CAAC,CAAC;IAErD,MAAM,MAAM,GAAG,eAAe,CAAC,EAAC,MAAM,EAAE,MAAM,IAAI,kBAAkB,EAAC,EAAE,IAAI,CAAC,CAAC;IAE7E,MAAM,EAAC,IAAI,EAAE,KAAK,EAAC,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,uCAAuC,EAAE;QAC9E,MAAM,EAAE;YACN,IAAI,EAAE,EAAC,YAAY,EAAE,WAAW,EAAC;YACjC,KAAK,EAAE;gBACL,KAAK;gBACL,MAAM;aACP;SACF;KACF,CAAC,CAAC;IAEH,IAAI,KAAK,EAAE,CAAC;QACV,MAAM,YAAY,GAChB,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,SAAS,IAAI,KAAK;YAC/D,CAAC,CAAC,MAAM,CAAE,KAA4B,CAAC,OAAO,CAAC;YAC/C,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QAC5B,MAAM,IAAI,KAAK,CAAC,2BAA2B,YAAY,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,EAAC,KAAK,EAAE,IAAI,CAAC,KAAK,EAAC,EAAE,sBAAsB,CAAC,CAAC;IAE1D,OAAO;QACL,KAAK,EAAE,IAAI,CAAC,KAAK,IAAI,CAAC;QACtB,IAAI,EAAE,IAAI,CAAC,IAAI,IAAI,IAAI;QACvB,QAAQ,EAAE,IAAI,CAAC,QAAQ,IAAI,IAAI;QAC/B,OAAO,EAAE,IAAI,CAAC,OAAO,IAAI,EAAE;KAC5B,CAAC;AACJ,CAAC;AAkCD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,OAA8B,EAC9B,IAAkB;IAElB,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;IAC3B,MAAM,EAAC,WAAW,EAAE,QAAQ,EAAE,MAAM,EAAC,GAAG,OAAO,CAAC;IAEhD,MAAM,CAAC,KAAK,CAAC,EAAC,WAAW,EAAE,QAAQ,EAAC,EAAE,mCAAmC,CAAC,CAAC;IAE3E,MAAM,MAAM,GAAG,eAAe,CAAC,EAAC,MAAM,EAAE,MAAM,IAAI,kBAAkB,EAAC,EAAE,IAAI,CAAC,CAAC;IAE7E,MAAM,EAAC,IAAI,EAAE,KAAK,EAAC,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,4DAA4D,EAAE;QACnG,MAAM,EAAE;YACN,IAAI,EAAE,EAAC,YAAY,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,CAAC,QAAQ,CAAC,EAAC;SAC/D;KACF,CAAC,CAAC;IAEH,IAAI,KAAK,EAAE,CAAC;QACV,MAAM,YAAY,GAChB,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,SAAS,IAAI,KAAK;YAC/D,CAAC,CAAC,MAAM,CAAE,KAA4B,CAAC,OAAO,CAAC;YAC/C,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QAC5B,MAAM,IAAI,KAAK,CAAC,sCAAsC,YAAY,EAAE,CAAC,CAAC;IACxE,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,EAAC,QAAQ,EAAC,EAAE,qCAAqC,CAAC,CAAC;IAEhE,OAAO;QACL,WAAW,EAAE,IAAI,CAAC,YAAY;KAC/B,CAAC;AACJ,CAAC"}
|
|
@@ -0,0 +1,337 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Redirect operations for Managed Runtime.
|
|
3
|
+
*
|
|
4
|
+
* Handles listing, creating, updating, and deleting redirects for MRT environments.
|
|
5
|
+
*
|
|
6
|
+
* @module operations/mrt/redirect
|
|
7
|
+
*/
|
|
8
|
+
import type { AuthStrategy } from '../../auth/types.js';
|
|
9
|
+
import type { components } from '../../clients/mrt.js';
|
|
10
|
+
/**
|
|
11
|
+
* Redirect type from API.
|
|
12
|
+
*/
|
|
13
|
+
export type MrtRedirect = components['schemas']['APIRedirectV2CreateUpdate'];
|
|
14
|
+
/**
|
|
15
|
+
* Patched redirect for updates.
|
|
16
|
+
*/
|
|
17
|
+
export type PatchedMrtRedirect = components['schemas']['PatchedAPIRedirectV2CreateUpdate'];
|
|
18
|
+
/**
|
|
19
|
+
* HTTP status code for redirects (301 or 302).
|
|
20
|
+
*/
|
|
21
|
+
export type RedirectHttpStatusCode = 301 | 302;
|
|
22
|
+
/**
|
|
23
|
+
* Options for listing redirects.
|
|
24
|
+
*/
|
|
25
|
+
export interface ListRedirectsOptions {
|
|
26
|
+
/**
|
|
27
|
+
* The project slug.
|
|
28
|
+
*/
|
|
29
|
+
projectSlug: string;
|
|
30
|
+
/**
|
|
31
|
+
* The target/environment slug.
|
|
32
|
+
*/
|
|
33
|
+
targetSlug: string;
|
|
34
|
+
/**
|
|
35
|
+
* Maximum number of results to return.
|
|
36
|
+
*/
|
|
37
|
+
limit?: number;
|
|
38
|
+
/**
|
|
39
|
+
* Offset for pagination.
|
|
40
|
+
*/
|
|
41
|
+
offset?: number;
|
|
42
|
+
/**
|
|
43
|
+
* Search term for filtering.
|
|
44
|
+
*/
|
|
45
|
+
search?: string;
|
|
46
|
+
/**
|
|
47
|
+
* Field to order results by.
|
|
48
|
+
*/
|
|
49
|
+
ordering?: string;
|
|
50
|
+
/**
|
|
51
|
+
* MRT API origin URL.
|
|
52
|
+
* @default "https://cloud.mobify.com"
|
|
53
|
+
*/
|
|
54
|
+
origin?: string;
|
|
55
|
+
}
|
|
56
|
+
/**
|
|
57
|
+
* Result of listing redirects.
|
|
58
|
+
*/
|
|
59
|
+
export interface ListRedirectsResult {
|
|
60
|
+
/**
|
|
61
|
+
* Total count of redirects.
|
|
62
|
+
*/
|
|
63
|
+
count: number;
|
|
64
|
+
/**
|
|
65
|
+
* URL for next page of results.
|
|
66
|
+
*/
|
|
67
|
+
next: string | null;
|
|
68
|
+
/**
|
|
69
|
+
* URL for previous page of results.
|
|
70
|
+
*/
|
|
71
|
+
previous: string | null;
|
|
72
|
+
/**
|
|
73
|
+
* Array of redirects.
|
|
74
|
+
*/
|
|
75
|
+
redirects: MrtRedirect[];
|
|
76
|
+
}
|
|
77
|
+
/**
|
|
78
|
+
* Lists redirects for an MRT environment.
|
|
79
|
+
*
|
|
80
|
+
* @param options - List options
|
|
81
|
+
* @param auth - Authentication strategy (ApiKeyStrategy)
|
|
82
|
+
* @returns Paginated list of redirects
|
|
83
|
+
* @throws Error if request fails
|
|
84
|
+
*
|
|
85
|
+
* @example
|
|
86
|
+
* ```typescript
|
|
87
|
+
* import { ApiKeyStrategy } from '@salesforce/b2c-tooling-sdk/auth';
|
|
88
|
+
* import { listRedirects } from '@salesforce/b2c-tooling-sdk/operations/mrt';
|
|
89
|
+
*
|
|
90
|
+
* const auth = new ApiKeyStrategy(process.env.MRT_API_KEY!, 'Authorization');
|
|
91
|
+
*
|
|
92
|
+
* const result = await listRedirects({
|
|
93
|
+
* projectSlug: 'my-storefront',
|
|
94
|
+
* targetSlug: 'staging'
|
|
95
|
+
* }, auth);
|
|
96
|
+
*
|
|
97
|
+
* for (const redirect of result.redirects) {
|
|
98
|
+
* console.log(`${redirect.from_path} -> ${redirect.to_url}`);
|
|
99
|
+
* }
|
|
100
|
+
* ```
|
|
101
|
+
*/
|
|
102
|
+
export declare function listRedirects(options: ListRedirectsOptions, auth: AuthStrategy): Promise<ListRedirectsResult>;
|
|
103
|
+
/**
|
|
104
|
+
* Options for creating a redirect.
|
|
105
|
+
*/
|
|
106
|
+
export interface CreateRedirectOptions {
|
|
107
|
+
/**
|
|
108
|
+
* The project slug.
|
|
109
|
+
*/
|
|
110
|
+
projectSlug: string;
|
|
111
|
+
/**
|
|
112
|
+
* The target/environment slug.
|
|
113
|
+
*/
|
|
114
|
+
targetSlug: string;
|
|
115
|
+
/**
|
|
116
|
+
* The source path to redirect from.
|
|
117
|
+
*/
|
|
118
|
+
fromPath: string;
|
|
119
|
+
/**
|
|
120
|
+
* The destination URL to redirect to.
|
|
121
|
+
*/
|
|
122
|
+
toUrl: string;
|
|
123
|
+
/**
|
|
124
|
+
* HTTP status code (301 or 302).
|
|
125
|
+
* @default 301
|
|
126
|
+
*/
|
|
127
|
+
httpStatusCode?: RedirectHttpStatusCode;
|
|
128
|
+
/**
|
|
129
|
+
* Forward query string parameters.
|
|
130
|
+
*/
|
|
131
|
+
forwardQuerystring?: boolean;
|
|
132
|
+
/**
|
|
133
|
+
* Forward wildcard path.
|
|
134
|
+
*/
|
|
135
|
+
forwardWildcard?: boolean;
|
|
136
|
+
/**
|
|
137
|
+
* MRT API origin URL.
|
|
138
|
+
* @default "https://cloud.mobify.com"
|
|
139
|
+
*/
|
|
140
|
+
origin?: string;
|
|
141
|
+
}
|
|
142
|
+
/**
|
|
143
|
+
* Creates a redirect for an MRT environment.
|
|
144
|
+
*
|
|
145
|
+
* @param options - Create redirect options
|
|
146
|
+
* @param auth - Authentication strategy (ApiKeyStrategy)
|
|
147
|
+
* @returns The created redirect
|
|
148
|
+
* @throws Error if request fails
|
|
149
|
+
*
|
|
150
|
+
* @example
|
|
151
|
+
* ```typescript
|
|
152
|
+
* import { ApiKeyStrategy } from '@salesforce/b2c-tooling-sdk/auth';
|
|
153
|
+
* import { createRedirect } from '@salesforce/b2c-tooling-sdk/operations/mrt';
|
|
154
|
+
*
|
|
155
|
+
* const auth = new ApiKeyStrategy(process.env.MRT_API_KEY!, 'Authorization');
|
|
156
|
+
*
|
|
157
|
+
* const redirect = await createRedirect({
|
|
158
|
+
* projectSlug: 'my-storefront',
|
|
159
|
+
* targetSlug: 'staging',
|
|
160
|
+
* fromPath: '/old-page',
|
|
161
|
+
* toUrl: '/new-page',
|
|
162
|
+
* httpStatusCode: 301
|
|
163
|
+
* }, auth);
|
|
164
|
+
* ```
|
|
165
|
+
*/
|
|
166
|
+
export declare function createRedirect(options: CreateRedirectOptions, auth: AuthStrategy): Promise<MrtRedirect>;
|
|
167
|
+
/**
|
|
168
|
+
* Options for getting a redirect.
|
|
169
|
+
*/
|
|
170
|
+
export interface GetRedirectOptions {
|
|
171
|
+
/**
|
|
172
|
+
* The project slug.
|
|
173
|
+
*/
|
|
174
|
+
projectSlug: string;
|
|
175
|
+
/**
|
|
176
|
+
* The target/environment slug.
|
|
177
|
+
*/
|
|
178
|
+
targetSlug: string;
|
|
179
|
+
/**
|
|
180
|
+
* The from_path of the redirect.
|
|
181
|
+
*/
|
|
182
|
+
fromPath: string;
|
|
183
|
+
/**
|
|
184
|
+
* MRT API origin URL.
|
|
185
|
+
* @default "https://cloud.mobify.com"
|
|
186
|
+
*/
|
|
187
|
+
origin?: string;
|
|
188
|
+
}
|
|
189
|
+
/**
|
|
190
|
+
* Gets a redirect from an MRT environment.
|
|
191
|
+
*
|
|
192
|
+
* @param options - Get redirect options
|
|
193
|
+
* @param auth - Authentication strategy (ApiKeyStrategy)
|
|
194
|
+
* @returns The redirect
|
|
195
|
+
* @throws Error if request fails
|
|
196
|
+
*/
|
|
197
|
+
export declare function getRedirect(options: GetRedirectOptions, auth: AuthStrategy): Promise<MrtRedirect>;
|
|
198
|
+
/**
|
|
199
|
+
* Options for updating a redirect.
|
|
200
|
+
*/
|
|
201
|
+
export interface UpdateRedirectOptions {
|
|
202
|
+
/**
|
|
203
|
+
* The project slug.
|
|
204
|
+
*/
|
|
205
|
+
projectSlug: string;
|
|
206
|
+
/**
|
|
207
|
+
* The target/environment slug.
|
|
208
|
+
*/
|
|
209
|
+
targetSlug: string;
|
|
210
|
+
/**
|
|
211
|
+
* The from_path of the redirect to update.
|
|
212
|
+
*/
|
|
213
|
+
fromPath: string;
|
|
214
|
+
/**
|
|
215
|
+
* New destination URL.
|
|
216
|
+
*/
|
|
217
|
+
toUrl?: string;
|
|
218
|
+
/**
|
|
219
|
+
* HTTP status code (301 or 302).
|
|
220
|
+
*/
|
|
221
|
+
httpStatusCode?: RedirectHttpStatusCode;
|
|
222
|
+
/**
|
|
223
|
+
* Forward query string parameters.
|
|
224
|
+
*/
|
|
225
|
+
forwardQuerystring?: boolean;
|
|
226
|
+
/**
|
|
227
|
+
* Forward wildcard path.
|
|
228
|
+
*/
|
|
229
|
+
forwardWildcard?: boolean;
|
|
230
|
+
/**
|
|
231
|
+
* MRT API origin URL.
|
|
232
|
+
* @default "https://cloud.mobify.com"
|
|
233
|
+
*/
|
|
234
|
+
origin?: string;
|
|
235
|
+
}
|
|
236
|
+
/**
|
|
237
|
+
* Updates a redirect in an MRT environment.
|
|
238
|
+
*
|
|
239
|
+
* @param options - Update redirect options
|
|
240
|
+
* @param auth - Authentication strategy (ApiKeyStrategy)
|
|
241
|
+
* @returns The updated redirect
|
|
242
|
+
* @throws Error if request fails
|
|
243
|
+
*/
|
|
244
|
+
export declare function updateRedirect(options: UpdateRedirectOptions, auth: AuthStrategy): Promise<MrtRedirect>;
|
|
245
|
+
/**
|
|
246
|
+
* Options for deleting a redirect.
|
|
247
|
+
*/
|
|
248
|
+
export interface DeleteRedirectOptions {
|
|
249
|
+
/**
|
|
250
|
+
* The project slug.
|
|
251
|
+
*/
|
|
252
|
+
projectSlug: string;
|
|
253
|
+
/**
|
|
254
|
+
* The target/environment slug.
|
|
255
|
+
*/
|
|
256
|
+
targetSlug: string;
|
|
257
|
+
/**
|
|
258
|
+
* The from_path of the redirect to delete.
|
|
259
|
+
*/
|
|
260
|
+
fromPath: string;
|
|
261
|
+
/**
|
|
262
|
+
* MRT API origin URL.
|
|
263
|
+
* @default "https://cloud.mobify.com"
|
|
264
|
+
*/
|
|
265
|
+
origin?: string;
|
|
266
|
+
}
|
|
267
|
+
/**
|
|
268
|
+
* Deletes a redirect from an MRT environment.
|
|
269
|
+
*
|
|
270
|
+
* @param options - Delete redirect options
|
|
271
|
+
* @param auth - Authentication strategy (ApiKeyStrategy)
|
|
272
|
+
* @throws Error if request fails
|
|
273
|
+
*/
|
|
274
|
+
export declare function deleteRedirect(options: DeleteRedirectOptions, auth: AuthStrategy): Promise<void>;
|
|
275
|
+
/**
|
|
276
|
+
* Options for cloning redirects.
|
|
277
|
+
*/
|
|
278
|
+
export interface CloneRedirectsOptions {
|
|
279
|
+
/**
|
|
280
|
+
* The project slug.
|
|
281
|
+
*/
|
|
282
|
+
projectSlug: string;
|
|
283
|
+
/**
|
|
284
|
+
* The source target/environment slug to clone from.
|
|
285
|
+
*/
|
|
286
|
+
fromTargetSlug: string;
|
|
287
|
+
/**
|
|
288
|
+
* The destination target/environment slug to clone to.
|
|
289
|
+
*/
|
|
290
|
+
toTargetSlug: string;
|
|
291
|
+
/**
|
|
292
|
+
* MRT API origin URL.
|
|
293
|
+
* @default "https://cloud.mobify.com"
|
|
294
|
+
*/
|
|
295
|
+
origin?: string;
|
|
296
|
+
}
|
|
297
|
+
/**
|
|
298
|
+
* Result of cloning redirects.
|
|
299
|
+
*/
|
|
300
|
+
export interface CloneRedirectsResult {
|
|
301
|
+
/**
|
|
302
|
+
* Number of redirects cloned.
|
|
303
|
+
*/
|
|
304
|
+
count: number;
|
|
305
|
+
/**
|
|
306
|
+
* The cloned redirects.
|
|
307
|
+
*/
|
|
308
|
+
redirects: MrtRedirect[];
|
|
309
|
+
}
|
|
310
|
+
/**
|
|
311
|
+
* Clones redirects from one target to another.
|
|
312
|
+
*
|
|
313
|
+
* Important: When you clone redirects, you're replacing all redirects
|
|
314
|
+
* in the destination target with all redirects from the source target.
|
|
315
|
+
*
|
|
316
|
+
* @param options - Clone redirects options
|
|
317
|
+
* @param auth - Authentication strategy (ApiKeyStrategy)
|
|
318
|
+
* @returns Result with cloned redirects
|
|
319
|
+
* @throws Error if request fails
|
|
320
|
+
*
|
|
321
|
+
* @example
|
|
322
|
+
* ```typescript
|
|
323
|
+
* import { ApiKeyStrategy } from '@salesforce/b2c-tooling-sdk/auth';
|
|
324
|
+
* import { cloneRedirects } from '@salesforce/b2c-tooling-sdk/operations/mrt';
|
|
325
|
+
*
|
|
326
|
+
* const auth = new ApiKeyStrategy(process.env.MRT_API_KEY!, 'Authorization');
|
|
327
|
+
*
|
|
328
|
+
* const result = await cloneRedirects({
|
|
329
|
+
* projectSlug: 'my-storefront',
|
|
330
|
+
* fromTargetSlug: 'staging',
|
|
331
|
+
* toTargetSlug: 'production'
|
|
332
|
+
* }, auth);
|
|
333
|
+
*
|
|
334
|
+
* console.log(`Cloned ${result.count} redirects`);
|
|
335
|
+
* ```
|
|
336
|
+
*/
|
|
337
|
+
export declare function cloneRedirects(options: CloneRedirectsOptions, auth: AuthStrategy): Promise<CloneRedirectsResult>;
|