surge-auth-generator
Version:
Generate AUTH files for basic authentication in surge.sh projects
205 lines • 15.3 kB
JavaScript
;
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (_) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.generate = exports.writeAuthFile = exports.getCredentialString = exports.getAllCasePermutations = void 0;
var fs = require("fs");
var path = require("path");
var appRoot = require("app-root-path");
var isValid = require("is-valid-path");
/**
* @description Generate all case permutations for a given string
* @param input the string for which to determine permutations
* @returns all possible case permutations
* @see adopted from {@link https://stackoverflow.com/a/27995370|stackoverflow answer}
* @license {@link https://creativecommons.org/licenses/by-sa/3.0/|Creative Commons licence 3.0}
*/
exports.getAllCasePermutations = function (input) {
if (!input || typeof input === undefined) {
return [];
}
var characters = input.split('');
// amount of possible case combinations are equal to length squared
var combinationCount = Math.pow(input.length, 2);
var stringPermutations = [];
for (var permIndex = 0; permIndex < combinationCount; permIndex++) {
// update the capitalization depending on the current permutation
/* tslint:disable:no-bitwise */
characters.reduce(function (permutation, character, charIndex) {
characters[charIndex] =
permutation & 1 ? character.toUpperCase() : character.toLowerCase();
return permutation >> 1;
}, permIndex);
/* tslint:enable:no-bitwise */
var result = characters.join('');
stringPermutations.push(result);
}
return Array.from(new Set(stringPermutations));
};
/**
* @description Generate AUTH file string for given credentials
* @param credentials the credentials to convert to AUTH file string
* @returns the credential string
* @example
* // returns 'foo:bar'
* getCredentialString({username: 'foo', password: 'bar', isCaseInsensitive: false});
*/
exports.getCredentialString = function (credential) {
var username = credential.username, password = credential.password, caseInsensitive = credential.caseInsensitive;
return caseInsensitive
? exports.getAllCasePermutations(username)
.map(function (name) { return name + ":" + (password || ''); })
.join('\n')
: (username || '') + ":" + (password || '');
};
/**
* @description Writes a file to the filesystem
* @param filePath the full path of the file
* @param content the file contents
* @returns promise resolving in the full path of the written file
*/
var writeFile = function (filePath, content) {
return new Promise(function (resolveWrite, rejectWrite) {
fs.promises
.writeFile(filePath, content)
.then(function () {
console.log("File generated at " + filePath);
resolveWrite(filePath);
})
.catch(function (error) { return rejectWrite(error); });
});
};
/**
* @description Creates a directory if it doesn't exist yet
* @param directoryPath the path of the directory
* @returns promise
*/
var createDirectoryIfNotExist = function (directoryPath) { return __awaiter(void 0, void 0, void 0, function () {
var directoryExists;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, fs.promises
.access(directoryPath)
.then(function () { return true; })
.catch(function () { return false; })];
case 1:
directoryExists = _a.sent();
if (!!directoryExists) return [3 /*break*/, 3];
return [4 /*yield*/, fs.promises.mkdir(directoryPath, { recursive: true })];
case 2:
_a.sent();
_a.label = 3;
case 3: return [2 /*return*/];
}
});
}); };
/**
* @description Write an AUTH file to the file system
* @param content the file contents
* @param directory the output directory
* @returns promise resolving in the full path of the written file
*/
exports.writeAuthFile = function (content, directory) { return __awaiter(void 0, void 0, void 0, function () {
var outDir, outPath;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
outDir = path.resolve(directory ? directory : '');
outPath = path.resolve(outDir, 'AUTH');
// check whether path contains invalid characters
if (!isValid(outDir)) {
throw new Error('Invalid path');
}
return [4 /*yield*/, createDirectoryIfNotExist(outDir)];
case 1:
_a.sent();
return [4 /*yield*/, writeFile(outPath, content)];
case 2: return [2 /*return*/, _a.sent()];
}
});
}); };
/**
* @description Resolves a directory path
* @param [passedDirectory] the path to be solved
* @returns the resolved directory or the current app root when no directory supplied)
*/
var resolveDirectory = function (passedDirectory) {
if (!passedDirectory) {
// set output directory to app root when no directory specified
passedDirectory = appRoot.path;
}
return path.resolve(passedDirectory);
};
/**
* @description Logs a credential to console
* @param credential the credential to be logged
*/
var logCredential = function (credential) {
var username = credential.username, password = credential.password, caseInsensitive = credential.caseInsensitive;
var caseSensitiveString = " (" + (caseInsensitive ? 'not ' : '') + "case sensitive)";
console.log((username
? "Set username: " + username + caseSensitiveString
: 'No username set.') + " (" + caseSensitiveString + ")");
console.log("" + (password ? "Set password: " + password : 'No password set.'));
};
/**
* @description Write an AUTH file with given credentials
* @param [credentials={}] the credentials to be written
* @param [directory=require.main.filename] the output directory (defaults to project root)
*/
exports.generate = function (credentials, directory) {
if (credentials === void 0) { credentials = {}; }
return new Promise(function (resolveGenerate, rejectGenerate) { return __awaiter(void 0, void 0, void 0, function () {
var fileContents;
return __generator(this, function (_a) {
console.log('Generating AUTH file...');
fileContents = Array.isArray(credentials)
? credentials
.map(function (credential) { return exports.getCredentialString(credential); })
.join('\n')
: exports.getCredentialString(credentials);
Array.isArray(credentials)
? console.log('Multiple credentials set.')
: logCredential(credentials);
exports.writeAuthFile(fileContents, resolveDirectory(directory))
.then(function (authFilePath) { return resolveGenerate(authFilePath); })
.catch(function (error) { return rejectGenerate(error); });
return [2 /*return*/];
});
}); });
};
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O0FBQUEsdUJBQTBCO0FBQzFCLDJCQUE4QjtBQUM5Qix1Q0FBMEM7QUFDMUMsdUNBQTBDO0FBZ0IxQzs7Ozs7O0dBTUc7QUFDVSxRQUFBLHNCQUFzQixHQUFHLFVBQ3BDLEtBQXlCO0lBRXpCLElBQUksQ0FBQyxLQUFLLElBQUksT0FBTyxLQUFLLEtBQUssU0FBUyxFQUFFO1FBQ3hDLE9BQU8sRUFBRSxDQUFDO0tBQ1g7SUFDRCxJQUFNLFVBQVUsR0FBRyxLQUFLLENBQUMsS0FBSyxDQUFDLEVBQUUsQ0FBQyxDQUFDO0lBQ25DLG1FQUFtRTtJQUNuRSxJQUFNLGdCQUFnQixHQUFHLElBQUksQ0FBQyxHQUFHLENBQUMsS0FBSyxDQUFDLE1BQU0sRUFBRSxDQUFDLENBQUMsQ0FBQztJQUVuRCxJQUFNLGtCQUFrQixHQUFhLEVBQUUsQ0FBQztJQUN4QyxLQUFLLElBQUksU0FBUyxHQUFHLENBQUMsRUFBRSxTQUFTLEdBQUcsZ0JBQWdCLEVBQUUsU0FBUyxFQUFFLEVBQUU7UUFDakUsaUVBQWlFO1FBQ2pFLCtCQUErQjtRQUMvQixVQUFVLENBQUMsTUFBTSxDQUFDLFVBQUMsV0FBVyxFQUFFLFNBQVMsRUFBRSxTQUFTO1lBQ2xELFVBQVUsQ0FBQyxTQUFTLENBQUM7Z0JBQ25CLFdBQVcsR0FBRyxDQUFDLENBQUMsQ0FBQyxDQUFDLFNBQVMsQ0FBQyxXQUFXLEVBQUUsQ0FBQyxDQUFDLENBQUMsU0FBUyxDQUFDLFdBQVcsRUFBRSxDQUFDO1lBQ3RFLE9BQU8sV0FBVyxJQUFJLENBQUMsQ0FBQztRQUMxQixDQUFDLEVBQUUsU0FBUyxDQUFDLENBQUM7UUFDZCw4QkFBOEI7UUFFOUIsSUFBTSxNQUFNLEdBQUcsVUFBVSxDQUFDLElBQUksQ0FBQyxFQUFFLENBQUMsQ0FBQztRQUNuQyxrQkFBa0IsQ0FBQyxJQUFJLENBQUMsTUFBTSxDQUFDLENBQUM7S0FDakM7SUFDRCxPQUFPLEtBQUssQ0FBQyxJQUFJLENBQUMsSUFBSSxHQUFHLENBQUMsa0JBQWtCLENBQUMsQ0FBQyxDQUFDO0FBQ2pELENBQUMsQ0FBQztBQUVGOzs7Ozs7O0dBT0c7QUFDVSxRQUFBLG1CQUFtQixHQUFHLFVBQUMsVUFBc0I7SUFDaEQsSUFBQSxRQUFRLEdBQWdDLFVBQVUsU0FBMUMsRUFBRSxRQUFRLEdBQXNCLFVBQVUsU0FBaEMsRUFBRSxlQUFlLEdBQUssVUFBVSxnQkFBZixDQUFnQjtJQUUzRCxPQUFPLGVBQWU7UUFDcEIsQ0FBQyxDQUFDLDhCQUFzQixDQUFDLFFBQVEsQ0FBQzthQUM3QixHQUFHLENBQUMsVUFBQyxJQUFJLElBQUssT0FBRyxJQUFJLFVBQUksUUFBUSxJQUFJLEVBQUUsQ0FBRSxFQUEzQixDQUEyQixDQUFDO2FBQzFDLElBQUksQ0FBQyxJQUFJLENBQUM7UUFDZixDQUFDLENBQUMsQ0FBRyxRQUFRLElBQUksRUFBRSxXQUFJLFFBQVEsSUFBSSxFQUFFLENBQUUsQ0FBQztBQUM1QyxDQUFDLENBQUM7QUFFRjs7Ozs7R0FLRztBQUNILElBQU0sU0FBUyxHQUFHLFVBQ2hCLFFBQWdCLEVBQ2hCLE9BQWU7SUFFZixPQUFBLElBQUksT0FBTyxDQUFDLFVBQUMsWUFBWSxFQUFFLFdBQVc7UUFDcEMsRUFBRSxDQUFDLFFBQVE7YUFDUixTQUFTLENBQUMsUUFBUSxFQUFFLE9BQU8sQ0FBQzthQUM1QixJQUFJLENBQUM7WUFDSixPQUFPLENBQUMsR0FBRyxDQUFDLHVCQUFxQixRQUFVLENBQUMsQ0FBQztZQUM3QyxZQUFZLENBQUMsUUFBUSxDQUFDLENBQUM7UUFDekIsQ0FBQyxDQUFDO2FBQ0QsS0FBSyxDQUFDLFVBQUMsS0FBSyxJQUFLLE9BQUEsV0FBVyxDQUFDLEtBQUssQ0FBQyxFQUFsQixDQUFrQixDQUFDLENBQUM7SUFDMUMsQ0FBQyxDQUFDO0FBUkYsQ0FRRSxDQUFDO0FBRUw7Ozs7R0FJRztBQUNILElBQU0seUJBQXlCLEdBQUcsVUFBTyxhQUFxQjs7OztvQkFDcEMscUJBQU0sRUFBRSxDQUFDLFFBQVE7cUJBQ3RDLE1BQU0sQ0FBQyxhQUFhLENBQUM7cUJBQ3JCLElBQUksQ0FBQyxjQUFNLE9BQUEsSUFBSSxFQUFKLENBQUksQ0FBQztxQkFDaEIsS0FBSyxDQUFDLGNBQU0sT0FBQSxLQUFLLEVBQUwsQ0FBSyxDQUFDLEVBQUE7O2dCQUhmLGVBQWUsR0FBRyxTQUdIO3FCQUNqQixDQUFDLGVBQWUsRUFBaEIsd0JBQWdCO2dCQUNsQixxQkFBTSxFQUFFLENBQUMsUUFBUSxDQUFDLEtBQUssQ0FBQyxhQUFhLEVBQUUsRUFBRSxTQUFTLEVBQUUsSUFBSSxFQUFFLENBQUMsRUFBQTs7Z0JBQTNELFNBQTJELENBQUM7Ozs7O0tBRS9ELENBQUM7QUFFRjs7Ozs7R0FLRztBQUNVLFFBQUEsYUFBYSxHQUFHLFVBQzNCLE9BQWUsRUFDZixTQUE2Qjs7Ozs7Z0JBRXZCLE1BQU0sR0FBRyxJQUFJLENBQUMsT0FBTyxDQUFDLFNBQVMsQ0FBQyxDQUFDLENBQUMsU0FBUyxDQUFDLENBQUMsQ0FBQyxFQUFFLENBQUMsQ0FBQztnQkFDbEQsT0FBTyxHQUFHLElBQUksQ0FBQyxPQUFPLENBQUMsTUFBTSxFQUFFLE1BQU0sQ0FBQyxDQUFDO2dCQUU3QyxpREFBaUQ7Z0JBQ2pELElBQUksQ0FBQyxPQUFPLENBQUMsTUFBTSxDQUFDLEVBQUU7b0JBQ3BCLE1BQU0sSUFBSSxLQUFLLENBQUMsY0FBYyxDQUFDLENBQUM7aUJBQ2pDO2dCQUVELHFCQUFNLHlCQUF5QixDQUFDLE1BQU0sQ0FBQyxFQUFBOztnQkFBdkMsU0FBdUMsQ0FBQztnQkFDakMscUJBQU0sU0FBUyxDQUFDLE9BQU8sRUFBRSxPQUFPLENBQUMsRUFBQTtvQkFBeEMsc0JBQU8sU0FBaUMsRUFBQzs7O0tBQzFDLENBQUM7QUFFRjs7OztHQUlHO0FBQ0gsSUFBTSxnQkFBZ0IsR0FBRyxVQUFDLGVBQXdCO0lBQ2hELElBQUksQ0FBQyxlQUFlLEVBQUU7UUFDcEIsK0RBQStEO1FBQy9ELGVBQWUsR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDO0tBQ2hDO0lBQ0QsT0FBTyxJQUFJLENBQUMsT0FBTyxDQUFDLGVBQWUsQ0FBQyxDQUFDO0FBQ3ZDLENBQUMsQ0FBQztBQUVGOzs7R0FHRztBQUNILElBQU0sYUFBYSxHQUFHLFVBQUMsVUFBc0I7SUFDbkMsSUFBQSxRQUFRLEdBQWdDLFVBQVUsU0FBMUMsRUFBRSxRQUFRLEdBQXNCLFVBQVUsU0FBaEMsRUFBRSxlQUFlLEdBQUssVUFBVSxnQkFBZixDQUFnQjtJQUMzRCxJQUFNLG1CQUFtQixHQUFHLFFBQzFCLGVBQWUsQ0FBQyxDQUFDLENBQUMsTUFBTSxDQUFDLENBQUMsQ0FBQyxFQUFFLHFCQUNkLENBQUM7SUFDbEIsT0FBTyxDQUFDLEdBQUcsQ0FDVCxDQUNFLFFBQVE7UUFDTixDQUFDLENBQUMsbUJBQWlCLFFBQVEsR0FBRyxtQkFBcUI7UUFDbkQsQ0FBQyxDQUFDLGtCQUFrQixXQUNuQixtQkFBbUIsTUFBRyxDQUM1QixDQUFDO0lBQ0YsT0FBTyxDQUFDLEdBQUcsQ0FDVCxNQUFHLFFBQVEsQ0FBQyxDQUFDLENBQUMsbUJBQWlCLFFBQVUsQ0FBQyxDQUFDLENBQUMsa0JBQWtCLENBQUUsQ0FDakUsQ0FBQztBQUNKLENBQUMsQ0FBQztBQUVGOzs7O0dBSUc7QUFDVSxRQUFBLFFBQVEsR0FBRyxVQUN0QixXQUEyQyxFQUMzQyxTQUFrQjtJQURsQiw0QkFBQSxFQUFBLGdCQUEyQztJQUczQyxPQUFBLElBQUksT0FBTyxDQUFDLFVBQU8sZUFBZSxFQUFFLGNBQWM7OztZQUNoRCxPQUFPLENBQUMsR0FBRyxDQUFDLHlCQUF5QixDQUFDLENBQUM7WUFFakMsWUFBWSxHQUFHLEtBQUssQ0FBQyxPQUFPLENBQUMsV0FBVyxDQUFDO2dCQUM3QyxDQUFDLENBQUMsV0FBVztxQkFDUixHQUFHLENBQUMsVUFBQyxVQUFVLElBQUssT0FBQSwyQkFBbUIsQ0FBQyxVQUFVLENBQUMsRUFBL0IsQ0FBK0IsQ0FBQztxQkFDcEQsSUFBSSxDQUFDLElBQUksQ0FBQztnQkFDZixDQUFDLENBQUMsMkJBQW1CLENBQUMsV0FBVyxDQUFDLENBQUM7WUFFckMsS0FBSyxDQUFDLE9BQU8sQ0FBQyxXQUFXLENBQUM7Z0JBQ3hCLENBQUMsQ0FBQyxPQUFPLENBQUMsR0FBRyxDQUFDLDJCQUEyQixDQUFDO2dCQUMxQyxDQUFDLENBQUMsYUFBYSxDQUFDLFdBQVcsQ0FBQyxDQUFDO1lBRS9CLHFCQUFhLENBQUMsWUFBWSxFQUFFLGdCQUFnQixDQUFDLFNBQVMsQ0FBQyxDQUFDO2lCQUNyRCxJQUFJLENBQUMsVUFBQyxZQUFZLElBQUssT0FBQSxlQUFlLENBQUMsWUFBWSxDQUFDLEVBQTdCLENBQTZCLENBQUM7aUJBQ3JELEtBQUssQ0FBQyxVQUFDLEtBQUssSUFBSyxPQUFBLGNBQWMsQ0FBQyxLQUFLLENBQUMsRUFBckIsQ0FBcUIsQ0FBQyxDQUFDOzs7U0FDNUMsQ0FBQztBQWhCRixDQWdCRSxDQUFDIn0=