This repository was archived by the owner on May 20, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 531
Expand file tree
/
Copy pathmanagement-sdk.ts
More file actions
396 lines (314 loc) · 17 KB
/
management-sdk.ts
File metadata and controls
396 lines (314 loc) · 17 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
import * as fs from "fs";
import * as path from "path";
import slash = require("slash");
import * as recursiveFs from "recursive-fs";
import * as yazl from "yazl";
import Adapter from "../utils/adapter/adapter"
import RequestManager from "../utils/request-manager"
import { CodePushUnauthorizedError } from "./code-push-error"
import FileUploadClient, { IProgress } from "appcenter-file-upload-client";
import { AccessKey, AccessKeyRequest, Account, App, AppCreationRequest, CollaboratorMap, Deployment, DeploymentMetrics, Headers, Package, PackageInfo, ReleaseUploadAssets, UploadReleaseProperties, CodePushError } from "./types";
interface JsonResponse {
headers: Headers;
body?: any;
}
interface PackageFile {
isTemporary: boolean;
path: string;
}
// A template string tag function that URL encodes the substituted values
function urlEncode(strings: TemplateStringsArray, ...values: string[]): string {
var result = "";
for (var i = 0; i < strings.length; i++) {
result += strings[i];
if (i < values.length) {
result += encodeURIComponent(values[i]);
}
}
return result;
}
class AccountManager {
public static AppPermission = {
OWNER: "Owner",
COLLABORATOR: "Collaborator"
};
private _accessKey: string;
private _requestManager: RequestManager;
private _adapter: Adapter;
private _fileUploadClient: FileUploadClient;
constructor(accessKey: string, customHeaders?: Headers, serverUrl?: string, proxy?: string) {
if (!accessKey) throw new CodePushUnauthorizedError("A token must be specified.");
this._accessKey = accessKey;
this._requestManager = new RequestManager(accessKey, customHeaders, serverUrl, proxy);
this._adapter = new Adapter(this._requestManager);
this._fileUploadClient = new FileUploadClient();
}
public get accessKey(): string {
return this._accessKey;
}
public async isAuthenticated(throwIfUnauthorized?: boolean): Promise<boolean> {
let res: JsonResponse;
let codePushError: CodePushError;
try {
res = await this._requestManager.get(urlEncode`/user`, false);
} catch (error) {
codePushError = error as CodePushError;
if (codePushError && (codePushError.statusCode !== RequestManager.ERROR_UNAUTHORIZED || throwIfUnauthorized)) {
throw codePushError;
}
}
const authenticated: boolean = !!res && !!res.body;
return authenticated;
}
// Access keys
public async addAccessKey(friendlyName: string, ttl?: number): Promise<AccessKey> {
if (!friendlyName) {
throw new CodePushUnauthorizedError("A name must be specified when adding an access key.");
}
const accessKeyRequest: AccessKeyRequest = {
description: friendlyName
};
const res: JsonResponse = await this._requestManager.post(urlEncode`/api_tokens`, JSON.stringify(accessKeyRequest), /*expectResponseBody=*/ true);
const accessKey = this._adapter.toLegacyAccessKey(res.body);
return accessKey;
}
public async getAccessKeys(): Promise<AccessKey[]> {
const res: JsonResponse = await this._requestManager.get(urlEncode`/api_tokens`);
const accessKeys = this._adapter.toLegacyAccessKeyList(res.body);
return accessKeys;
}
public async removeAccessKey(name: string): Promise<void> {
const accessKey = await this._adapter.resolveAccessKey(name);
await this._requestManager.del(urlEncode`/api_tokens/${accessKey.id}`);
return null;
}
// Account
public async getAccountInfo(): Promise<Account> {
const res: JsonResponse = await this._requestManager.get(urlEncode`/user`);
const accountInfo = this._adapter.toLegacyAccount(res.body);
return accountInfo;
}
// Apps
public async getApps(): Promise<App[]> {
const res: JsonResponse = await this._requestManager.get(urlEncode`/apps`);
const apps = await this._adapter.toLegacyApps(res.body);
return apps;
}
public async getApp(appName: string): Promise<App> {
const appParams = await this._adapter.parseApiAppName(appName);
const res: JsonResponse = await this._requestManager.get(urlEncode`/apps/${appParams.appOwner}/${appParams.appName}`);
const app = await this._adapter.toLegacyApp(res.body);
return app;
}
public async addApp(appName: string, appOs: string, appPlatform: string, manuallyProvisionDeployments: boolean = false): Promise<App> {
var app: AppCreationRequest = {
name: appName,
os: appOs,
platform: appPlatform,
manuallyProvisionDeployments: manuallyProvisionDeployments
};
const apigatewayAppCreationRequest = this._adapter.toApigatewayAppCreationRequest(app);
const path = apigatewayAppCreationRequest.org ? `/orgs/${apigatewayAppCreationRequest.org}/apps` : `/apps`;
await this._requestManager.post(path, JSON.stringify(apigatewayAppCreationRequest.appcenterClientApp), /*expectResponseBody=*/ false);
if (!manuallyProvisionDeployments) {
await this._adapter.addStandardDeployments(appName);
}
return app;
}
public async removeApp(appName: string): Promise<void> {
const appParams = await this._adapter.parseApiAppName(appName);
await this._requestManager.del(urlEncode`/apps/${appParams.appOwner}/${appParams.appName}`);
return null;
}
public async renameApp(oldAppName: string, newAppName: string): Promise<void> {
const { appOwner, appName } = await this._adapter.parseApiAppName(oldAppName);
const updatedApp = await this._adapter.getRenamedApp(newAppName, appOwner, appName);
await this._requestManager.patch(urlEncode`/apps/${appOwner}/${appName}`, JSON.stringify(updatedApp));
return null;
}
public async transferApp(appName: string, orgName: string): Promise<void> {
const appParams = await this._adapter.parseApiAppName(appName);
await this._requestManager.post(urlEncode`/apps/${appParams.appOwner}/${appParams.appName}/transfer/${orgName}`, /*requestBody=*/ null, /*expectResponseBody=*/ false);
return null;
}
// Collaborators
public async getCollaborators(appName: string): Promise<CollaboratorMap> {
const appParams = await this._adapter.parseApiAppName(appName);
const res: JsonResponse = await this._requestManager.get(urlEncode`/apps/${appParams.appOwner}/${appParams.appName}/users`);
const collaborators = await this._adapter.toLegacyCollaborators(res.body, appParams.appOwner);
return collaborators;
}
public async addCollaborator(appName: string, email: string): Promise<void> {
const appParams = await this._adapter.parseApiAppName(appName);
const userEmailRequest = {
user_email: email
};
await this._requestManager.post(urlEncode`/apps/${appParams.appOwner}/${appParams.appName}/invitations`, JSON.stringify(userEmailRequest), /*expectResponseBody=*/ false);
return null;
}
public async removeCollaborator(appName: string, email: string): Promise<void> {
const appParams = await this._adapter.parseApiAppName(appName);
await this._requestManager.del(urlEncode`/apps/${appParams.appOwner}/${appParams.appName}/invitations/${email}`);
return null;
}
// Deployments
public async addDeployment(appName: string, deploymentName: string): Promise<Deployment> {
const deployment = <Deployment>{ name: deploymentName };
const appParams = await this._adapter.parseApiAppName(appName);
const res = await this._requestManager.post(urlEncode`/apps/${appParams.appOwner}/${appParams.appName}/deployments/`, JSON.stringify(deployment), /*expectResponseBody=*/ true);
return this._adapter.toLegacyDeployment(res.body);
}
public async clearDeploymentHistory(appName: string, deploymentName: string): Promise<void> {
const appParams = await this._adapter.parseApiAppName(appName);
await this._requestManager.del(urlEncode`/apps/${appParams.appOwner}/${appParams.appName}/deployments/${deploymentName}/releases`);
return null;
}
public async getDeployments(appName: string): Promise<Deployment[]> {
const appParams = await this._adapter.parseApiAppName(appName);
const res: JsonResponse = await this._requestManager.get(urlEncode`/apps/${appParams.appOwner}/${appParams.appName}/deployments/`);
return this._adapter.toLegacyDeployments(res.body);
}
public async getDeployment(appName: string, deploymentName: string): Promise<Deployment> {
const appParams = await this._adapter.parseApiAppName(appName);
const res: JsonResponse = await this._requestManager.get(urlEncode`/apps/${appParams.appOwner}/${appParams.appName}/deployments/${deploymentName}`);
return this._adapter.toLegacyDeployment(res.body);
}
public async renameDeployment(appName: string, oldDeploymentName: string, newDeploymentName: string): Promise<void> {
const appParams = await this._adapter.parseApiAppName(appName);
await this._requestManager.patch(urlEncode`/apps/${appParams.appOwner}/${appParams.appName}/deployments/${oldDeploymentName}`, JSON.stringify({ name: newDeploymentName }));
return null;
}
public async removeDeployment(appName: string, deploymentName: string): Promise<void> {
const appParams = await this._adapter.parseApiAppName(appName);
await this._requestManager.del(urlEncode`/apps/${appParams.appOwner}/${appParams.appName}/deployments/${deploymentName}`);
return null;
}
public async getDeploymentMetrics(appName: string, deploymentName: string): Promise<DeploymentMetrics> {
const appParams = await this._adapter.parseApiAppName(appName);
const res = await this._requestManager.get(urlEncode`/apps/${appParams.appOwner}/${appParams.appName}/deployments/${deploymentName}/metrics`);
const deploymentMetrics = this._adapter.toLegacyDeploymentMetrics(res.body);
return deploymentMetrics;
}
public async getDeploymentHistory(appName: string, deploymentName: string): Promise<Package[]> {
const appParams = await this._adapter.parseApiAppName(appName);
const res = await this._requestManager.get(urlEncode`/apps/${appParams.appOwner}/${appParams.appName}/deployments/${deploymentName}/releases`);
return this._adapter.toLegacyDeploymentHistory(res.body);
}
// Releases
public async release(appName: string, deploymentName: string, filePath: string, targetBinaryVersion: string, updateMetadata: PackageInfo, uploadProgressCallback?: (progress: number) => void): Promise<Package> {
updateMetadata.appVersion = targetBinaryVersion;
const packageFile: PackageFile = await this.packageFileFromPath(filePath);
const appParams = await this._adapter.parseApiAppName(appName);
const assetJsonResponse: JsonResponse = await this._requestManager.post(urlEncode`/apps/${appParams.appOwner}/${appParams.appName}/deployments/${deploymentName}/uploads`, null, true)
const assets = assetJsonResponse.body as ReleaseUploadAssets;
await this._fileUploadClient.upload({
assetId: assets.id,
assetDomain: assets.upload_domain,
assetToken: assets.token,
file: packageFile.path,
onProgressChanged: (progressData: IProgress) => {
if (uploadProgressCallback) {
uploadProgressCallback(progressData.percentCompleted);
}
},
});
const releaseUploadProperties: UploadReleaseProperties = this._adapter.toReleaseUploadProperties(updateMetadata, assets, deploymentName);
const releaseJsonResponse: JsonResponse = await this._requestManager.post(urlEncode`/apps/${appParams.appOwner}/${appParams.appName}/deployments/${deploymentName}/releases`, JSON.stringify(releaseUploadProperties), true);
const releasePackage: Package = this._adapter.releaseToPackage(releaseJsonResponse.body);
return releasePackage;
}
public async patchRelease(appName: string, deploymentName: string, label: string, updateMetadata: PackageInfo): Promise<void> {
const appParams = await this._adapter.parseApiAppName(appName);
const requestBody = this._adapter.toRestReleaseModification(updateMetadata);
await this._requestManager.patch(urlEncode`/apps/${appParams.appOwner}/${appParams.appName}/deployments/${deploymentName}/releases/${label}`, JSON.stringify(requestBody), /*expectResponseBody=*/ false)
return null;
}
public async promote(appName: string, sourceDeploymentName: string, destinationDeploymentName: string, updateMetadata: PackageInfo): Promise<Package> {
const appParams = await this._adapter.parseApiAppName(appName);
const requestBody = this._adapter.toRestReleaseModification(updateMetadata);
const res = await this._requestManager.post(urlEncode`/apps/${appParams.appOwner}/${appParams.appName}/deployments/${sourceDeploymentName}/promote_release/${destinationDeploymentName}`, JSON.stringify(requestBody), /*expectResponseBody=*/ true);
const releasePackage: Package = this._adapter.releaseToPackage(res.body);
return releasePackage;
}
public async rollback(appName: string, deploymentName: string, targetRelease?: string): Promise<void> {
const appParams = await this._adapter.parseApiAppName(appName);
const requestBody = targetRelease ? {
label: targetRelease
} : {};
await this._requestManager.post(urlEncode`/apps/${appParams.appOwner}/${appParams.appName}/deployments/${deploymentName}/rollback_release`, JSON.stringify(requestBody), /*expectResponseBody=*/ false);
return null;
}
// Deprecated
public getAccessKey(accessKeyName: string): CodePushError {
throw {
message: 'Method is deprecated',
statusCode: 404
}
}
// Deprecated
public getSessions(): CodePushError {
throw this.getDeprecatedMethodError();
}
// Deprecated
public patchAccessKey(oldName: string, newName?: string, ttl?: number): CodePushError {
throw this.getDeprecatedMethodError();
}
// Deprecated
public removeSession(machineName: string): CodePushError {
throw this.getDeprecatedMethodError();
}
private packageFileFromPath(filePath: string): Promise<PackageFile> {
var getPackageFilePromise: Promise<PackageFile>;
if (fs.lstatSync(filePath).isDirectory()) {
getPackageFilePromise = new Promise<PackageFile>((resolve: (file: PackageFile) => void, reject: (reason: Error) => void): void => {
var directoryPath: string = filePath;
recursiveFs.readdirr(directoryPath, (error?: any, directories?: string[], files?: string[]): void => {
if (error) {
reject(error);
return;
}
var baseDirectoryPath = path.dirname(directoryPath);
var fileName: string = this.generateRandomFilename(15) + ".zip";
var zipFile = new yazl.ZipFile();
var writeStream: fs.WriteStream = fs.createWriteStream(fileName);
zipFile.outputStream.pipe(writeStream)
.on("error", (error: Error): void => {
reject(error);
})
.on("close", (): void => {
filePath = path.join(process.cwd(), fileName);
resolve({ isTemporary: true, path: filePath });
});
for (var i = 0; i < files.length; ++i) {
var file: string = files[i];
var relativePath: string = path.relative(baseDirectoryPath, file);
// yazl does not like backslash (\) in the metadata path.
relativePath = slash(relativePath);
zipFile.addFile(file, relativePath);
}
zipFile.end();
});
});
} else {
getPackageFilePromise = new Promise<PackageFile>((resolve: (file: PackageFile) => void, reject: (reason: Error) => void): void => {
resolve({ isTemporary: false, path: filePath });
});
}
return getPackageFilePromise;
}
private generateRandomFilename(length: number): string {
var filename: string = "";
var validChar: string = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789";
for (var i = 0; i < length; i++) {
filename += validChar.charAt(Math.floor(Math.random() * validChar.length));
}
return filename;
}
private getDeprecatedMethodError() {
return {
message: 'Method is deprecated',
statusCode: 404
};
}
}
export = AccountManager;