forked from Azure/static-web-apps-cli
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathconstants.ts
More file actions
341 lines (316 loc) · 11.4 KB
/
constants.ts
File metadata and controls
341 lines (316 loc) · 11.4 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
import os from "node:os";
import path from "node:path";
import { fileURLToPath } from "node:url";
import { DEFAULT_CONFIG } from "../config.js";
import { address, isHttpUrl } from "./utils/net.js";
const __filename = fileURLToPath(import.meta.url);
const __dirname = path.dirname(__filename);
// StaticSiteClient related constants
export const DEPLOY_BINARY_NAME = "StaticSitesClient";
export const DEPLOY_BINARY_STABLE_TAG = "stable";
export const DEPLOY_FOLDER = path.join(os.homedir(), ".swa", "deploy");
export const STATIC_SITE_CLIENT_RELEASE_METADATA_URL = "https://aka.ms/swalocaldeploy";
// Data-api-builder related constants
export const DATA_API_BUILDER_BINARY_NAME = "DataApiBuilder";
export const DATA_API_BUILDER_COMMAND = "dab";
export const DATA_API_BUILDER_RELEASE_METADATA_URL = "https://go.microsoft.com/fwlink/?linkid=2226493";
export const DATA_API_BUILDER_FOLDER = path.join(os.homedir(), ".swa", "dataApiBuilder");
export const DATA_API_BUILDER_RELEASE_TAG = "released";
export const DATA_API_BUILDER_LATEST_TAG = "latest";
export const DATA_API_BUILDER_DEFAULT_CONFIG_FILE_NAME = "staticwebapp.database.config.json";
export const DATA_API_BUILDER_DEFAULT_SCHEMA_FILE_NAME = "staticwebapp.database.schema.gql";
export const DATA_API_BUILDER_DEFAULT_FOLDER = "swa-db-connections";
export const DATA_API_BUILDER_DEFAULT_REST_PATH = "/rest";
export const DATA_API_BUILDER_VERSION_ID = "1.3.19";
export const DEFAULT_DATA_API_BUILDER_BINARY = {
Windows: "Microsoft.DataApiBuilder.exe",
Linux: "Microsoft.DataApiBuilder",
MacOs: "Microsoft.DataApiBuilder",
};
export const DATA_API_BUILDER_DATABASE_TYPES = {
MsSql: "mssql",
CosmosDbNoSql: "cosmosdb_nosql",
CosmosDbPostGreSql: "cosmosdb_postgresql",
MySql: "mysql",
PostGreSql: "postgresql",
};
// General SWA_CLI constants
export const SWA_COMMANDS = ["login", "init", "start", "deploy", "build", "db init"] as const;
// Type cannot be in swa.d.ts as it's inferred from SWA_COMMANDS
export type SWACommand = (typeof SWA_COMMANDS)[number];
export const SWA_RUNTIME_CONFIG_MAX_SIZE_IN_KB = 20; // 20kb
export const SWA_AUTH_CONTEXT_COOKIE = `StaticWebAppsAuthContextCookie`;
export const SWA_AUTH_COOKIE = `StaticWebAppsAuthCookie`;
export const ALLOWED_HTTP_METHODS_FOR_STATIC_CONTENT = ["GET", "HEAD", "OPTIONS"];
// Custom Auth constants
export const SUPPORTED_CUSTOM_AUTH_PROVIDERS = ["google", "github", "aad", "facebook", "twitter", "dummy"];
/*
The full name is required in staticwebapp.config.json's schema that will be normalized to aad
https://learn.microsoft.com/en-us/azure/static-web-apps/authentication-custom?tabs=aad%2Cinvitations
*/
export const ENTRAID_FULL_NAME = "azureActiveDirectory";
export const CUSTOM_AUTH_TOKEN_ENDPOINT_MAPPING: AuthIdentityTokenEndpoints = {
google: {
host: "oauth2.googleapis.com",
path: "/token",
},
github: {
host: "github.com",
path: "/login/oauth/access_token",
},
aad: {
host: "login.microsoftonline.com",
path: "/tenantId/oauth2/v2.0/token",
},
facebook: {
host: "graph.facebook.com",
path: "/v11.0/oauth/access_token",
},
twitter: {
host: "api.twitter.com",
path: "/2/oauth2/token",
},
};
export const CUSTOM_AUTH_USER_ENDPOINT_MAPPING: AuthIdentityTokenEndpoints = {
google: {
host: "www.googleapis.com",
path: "/oauth2/v2/userinfo",
},
github: {
host: "api.github.com",
path: "/user",
},
aad: {
host: "graph.microsoft.com",
path: "/oidc/userinfo",
},
twitter: {
host: "api.twitter.com",
path: "/2/users/me",
},
};
export const CUSTOM_AUTH_ISS_MAPPING: AuthIdentityIssHosts = {
google: "https://account.google.com",
github: "",
aad: "https://graph.microsoft.com",
facebook: "https://www.facebook.com",
twitter: "https://www.x.com",
};
export const CUSTOM_AUTH_REQUIRED_FIELDS: AuthIdentityRequiredFields = {
google: ["clientIdSettingName", "clientSecretSettingName"],
github: ["clientIdSettingName", "clientSecretSettingName"],
aad: ["clientIdSettingName", "clientSecretSettingName", "openIdIssuer"],
facebook: ["appIdSettingName", "appSecretSettingName"],
twitter: ["consumerKeySettingName", "consumerSecretSettingName"],
};
export const AUTH_STATUS = {
NoAuth: 0,
HostNameAuthLogin: 1,
HostNameAuthComplete: 2,
HostNameAuthLogout: 3,
IdentityAuthLogin: 4,
IdentityRedirect: 5,
IdentityAuthLoginDone: 6,
IdentityAuthConsentGranted: 7,
HostNameAuthAcceptInvitation: 8,
AuthMe: 9,
HostNameAuthLogoutComplete: 10,
IdentityRedirectLogout: 11,
IdentityAuthLogoutComplete: 12,
IdentityAuthPurgeBegin: 13,
IdentityAuthPurgeWarning: 14,
IdentityAuthPurgeComplete: 15,
HostNameAuthPurge: 16,
HostNameAuthLoginCallback: 17,
IdentityAuthLoginCallback: 18,
IdentityAuthLogout: 19,
};
// this list must cover this set at least: https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types
export const MIME_TYPE_LIST: { [key: string]: string } = {
".aac": "audio/aac",
".abw": "application/x-abiword",
".appinstaller": "application/appinstaller",
".appx": "application/appx",
".appxbundle": "application/appxbundle",
".arc": "application/x-freearc",
".asf": "video/x-ms-asf",
".asx": "video/x-ms-asf",
".avi": "video/x-msvideo",
".azw": "application/vnd.amazon.ebook",
".bin": "application/octet-stream",
".bmp": "image/bmp",
".bz": "application/x-bzip",
".bz2": "application/x-bzip2",
".cco": "application/x-cocoa",
".crt": "application/x-x509-ca-cert",
".csh": "application/x-csh",
".css": "text/css",
".csv": "text/csv",
".deb": "application/octet-stream",
".der": "application/x-x509-ca-cert",
".dll": "application/octet-stream",
".dmg": "application/octet-stream",
".doc": "application/msword",
".docx": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
".ear": "application/java-archive",
".eot": "application/octet-stream",
".epub": "application/epub+zip",
".exe": "application/octet-stream",
".flv": "video/x-flv",
".gif": "image/gif",
".gz": "application/gzip",
".hqx": "application/mac-binhex40",
".htc": "text/x-component",
".htm": "text/html",
".html": "text/html",
".ico": "image/vnd.microsoft.icon",
".ics": "text/calendar",
".img": "application/octet-stream",
".iso": "application/octet-stream",
".jar": "application/java-archive",
".jardiff": "application/x-java-archive-diff",
".jng": "image/x-jng",
".jnlp": "application/x-java-jnlp-file",
".jpeg": "image/jpeg",
".jpg": "image/jpeg",
".js": "text/javascript",
".vue": "text/javascript",
".json": "application/json",
".map": "application/json",
".jsonld": "application/ld+json",
".mid": "audio/midi",
".midi": "audio/x-midi",
".mjs": "text/javascript",
".mml": "text/mathml",
".mng": "video/x-mng",
".mov": "video/quicktime",
".mp3": "audio/mpeg",
".mpeg": "video/mpeg",
".mpg": "video/mpeg",
".mpkg": "application/vnd.apple.installer+xml",
".msi": "application/octet-stream",
".msix": "application/msix",
".msixbundle": "application/msixbundle",
".msm": "application/octet-stream",
".msp": "application/octet-stream",
".odp": "application/vnd.oasis.opendocument.presentation",
".ods": "application/vnd.oasis.opendocument.spreadsheet",
".odt": "application/vnd.oasis.opendocument.text",
".oga": "audio/ogg",
".ogv": "video/ogg",
".ogx": "application/ogg",
".opus": "audio/opus",
".otf": "font/otf",
".pdb": "application/x-pilot",
".pdf": "application/pdf",
".pem": "application/x-x509-ca-cert",
".php": "application/php",
".pl": "application/x-perl",
".pm": "application/x-perl",
".png": "image/png",
".ppt": "application/vnd.ms-powerpoint",
".pptx": "application/vnd.openxmlformats-officedocument.presentationml.presentation",
".prc": "application/x-pilot",
".ra": "audio/x-realaudio",
".rar": "application/x-rar-compressed",
".rpm": "application/x-redhat-package-manager",
".rss": "text/xml",
".rtf": "application/rtf",
".run": "application/x-makeself",
".sea": "application/x-sea",
".sh": "application/x-sh",
".shtml": "text/html",
".sit": "application/x-stuffit",
".svg": "image/svg+xml",
".swf": "application/x-shockwave-flash",
".tar": "application/x-tar",
".tcl": "application/x-tcl",
".tif": "image/tiff",
".tiff": "image/tiff",
".tk": "application/x-tcl",
".ts": "video/mp2t",
".ttf": "font/ttf",
".txt": "text/plain",
".vsd": "application/vnd.visio",
".war": "application/java-archive",
".wasm": "application/wasm",
".wav": "audio/wav",
".weba": "audio/webm",
".webm": "video/webm",
".webp": "image/webp",
".wbmp": "image/vnd.wap.wbmp",
".wmv": "video/x-ms-wmv",
".woff": "font/woff",
".woff2": "font/woff2",
".xhtml": "application/xhtml+xml",
".xls": "application/vnd.ms-excel",
".xlsx": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
".xml": "text/xml",
".xpi": "application/x-xpinstall",
".xul": "application/vnd.mozilla.xul+xml",
".zip": "application/zip",
".3gp": "video/3gpp",
".3g2": "video/3gpp2",
".7z": "application/x-7z-compressed",
};
export const DEFAULT_DATA_API_BUILDER_SCHEMA_CONTENT = `
"""
Add your CosmosDB NoSQL database schema in this file
For example:
type Book @model {
id: ID
title: String
}
"""
`;
export const DEFAULT_MIME_TYPE = "application/octet-stream";
export const HEADER_DELETE_KEYWORD = "@@HEADER_DELETE_KEYWORD@@";
export const CACHE_CONTROL_MAX_AGE = 30;
export const ENV_FILENAME = ".env";
export const GIT_IGNORE_FILENAME = ".gitignore";
export const SWA_CLI_APP_PROTOCOL = DEFAULT_CONFIG.ssl ? `https` : `http`;
export const SWA_PUBLIC_DIR = path.resolve(__dirname, "..", "public"); //SWA_PUBLIC_DIR = "../public"
export const HAS_API = Boolean(DEFAULT_CONFIG.apiLocation && SWA_CLI_API_URI());
export const SWA_CONFIG_FILENAME = "staticwebapp.config.json";
export const SWA_CONFIG_FILENAME_LEGACY = "routes.json";
export const CUSTOM_URL_SCHEME = "swa://";
export const OVERRIDABLE_ERROR_CODES = [400, 401, 403, 404];
export const SWA_CONFIG_SCHEME_URL = "https://json.schemastore.org/staticwebapp.config.json";
export const SWA_CONFIG_SCHEME_FALLBACK_PATH = path.join(__dirname, "../../schema", SWA_CONFIG_FILENAME);
// Constants related to Api runtime
export const DEFAULT_VERSION = {
Node: "22",
Dotnet: "8.0",
DotnetIsolated: "8.0",
Python: "3.11",
};
export const SUPPORTED_VERSIONS = {
Node: ["18", "20", "22"],
Dotnet: ["8.0"],
DotnetIsolated: ["8.0", "9.0"],
Python: ["3.9", "3.10", "3.11"],
};
export const DEFAULT_RUNTIME_LANGUAGE = "node";
// --
// Note: declare these as functions so that their body gets evaluated at runtime!
// The reason for this is that these function depend on values set by environment variables which are set
// during the startup of the CLI (see src/cli/commands/start.ts)
export function IS_APP_DEV_SERVER() {
return isHttpUrl(DEFAULT_CONFIG.outputLocation);
}
export function IS_API_DEV_SERVER() {
return isHttpUrl(DEFAULT_CONFIG.apiLocation);
}
export function SWA_CLI_API_URI() {
return IS_API_DEV_SERVER() ? DEFAULT_CONFIG.apiLocation : address(DEFAULT_CONFIG.host, DEFAULT_CONFIG.apiPort);
}
export function IS_DATA_API_DEV_SERVER() {
return isHttpUrl(DEFAULT_CONFIG.dataApiLocation);
}
export function SWA_CLI_DATA_API_URI() {
return IS_DATA_API_DEV_SERVER() ? DEFAULT_CONFIG.dataApiLocation : address(DEFAULT_CONFIG.host, DEFAULT_CONFIG.dataApiPort, "http");
}
// Constants related to swa login
const azureFolderName = ".azure";
const azureProfileFilename = "azureProfile.json";
export const AZURE_LOGIN_CONFIG = path.join(os.homedir(), azureFolderName, azureProfileFilename);