@mikeyt23/node-cli-utils 2.0.6 → 2.0.8

package/dist/cjs/dockerUtils.js

@@ -0,0 +1,299 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deleteDockerVolume = exports.dockerVolumeExists = exports.getDockerComposeVolumeName = exports.deleteDockerComposeVolume = exports.ensureDockerRunning = exports.isDockerRunning = exports.isDockerInstalled = exports.simpleSpawnDockerAsync = exports.spawnDockerCompose = exports.isValidDockerContainerName = exports.isValidDockerComposeProjectName = void 0;
+const child_process_1 = require("child_process");
+const node_fs_1 = __importDefault(require("node:fs"));
+const path_1 = __importDefault(require("path"));
+const NodeCliUtilsConfig_js_1 = require("./NodeCliUtilsConfig.js");
+const generalUtils_js_1 = require("./generalUtils.js");
+const generalUtilsInternal_js_1 = require("./generalUtilsInternal.js");
+const dockerComposeCommandsThatSupportDetached = ['exec', 'logs', 'ps', 'restart', 'run', 'start', 'stop', 'up'];
+/**
+ * Check if the string is a valid docker compose project name:
+ *
+ * - Must contain only lowercase letters, digits, dashes and underscores
+ * - Must start with a lowercase letter or digit
+ *
+ * See https://docs.docker.com/compose/environment-variables/envvars/#compose_project_name.
+ * @param projectName The string to validate
+ * @returns `true` if the string is a valid docker compose project name, `false` otherwise
+ */
+function isValidDockerComposeProjectName(projectName) {
+    (0, generalUtils_js_1.requireString)('projectName', projectName);
+    // Ensure first char is a lowercase letter or digit
+    if (!/^[a-z0-9]/.test(projectName[0])) {
+        return false;
+    }
+    // Ensure the rest of the chars are only lowercase letters, digits, dashes and underscores
+    return /^[a-z0-9-_]+$/.test(projectName);
+}
+exports.isValidDockerComposeProjectName = isValidDockerComposeProjectName;
+/**
+ * Check if the string is a valid docker container name:
+ *
+ * - Must start with a letter or digit
+ * - Contain only letters, digits, underscores and periods
+ * - Must not end with a period
+ * @param containerName The docker container name to validate.
+ * @returns `true` if valid, `false otherwise
+ */
+function isValidDockerContainerName(containerName) {
+    return /[a-zA-Z0-9][a-zA-Z0-9_.-]+/.test(containerName) && !containerName.endsWith('.');
+}
+exports.isValidDockerContainerName = isValidDockerContainerName;
+/**
+ * For docker compose commands, see https://docs.docker.com/compose/reference/. For available options for this wrapper function, see {@link DockerComposeOptions}.
+ *
+ * The current working directory will be the directory of the {@link dockerComposePath} unless specified in the options. This ensures relative paths in the
+ * docker compose file will be relative to itself by default.
+ *
+ * See {@link DockerComposeOptions.projectName} for info on where to locate your docker compose file and how to specify the docker project name.
+ * @param dockerComposePath Path to docker-compose.yml
+ * @param dockerComposeCommand The docker-compose command to run
+ * @param options {@link DockerComposeOptions} to use, including additional arguments to pass to the docker compose command and the project name
+ */
+async function spawnDockerCompose(dockerComposePath, dockerComposeCommand, options) {
+    (0, generalUtils_js_1.requireValidPath)('dockerComposePath', dockerComposePath);
+    (0, generalUtils_js_1.requireString)('dockerComposeCommand', dockerComposeCommand);
+    if (options === null || options === void 0 ? void 0 : options.cwd) {
+        (0, generalUtils_js_1.requireValidPath)('cwd', options.cwd);
+    }
+    if (options === null || options === void 0 ? void 0 : options.altEnvFilePath) {
+        (0, generalUtils_js_1.requireValidPath)('altEnvFilePath', options.altEnvFilePath);
+    }
+    if ((options === null || options === void 0 ? void 0 : options.projectName) && !isValidDockerComposeProjectName(options.projectName)) {
+        throw new Error('Invalid docker compose project name specified for the projectName param. Project names must contain only lowercase letters, decimal digits, dashes, and underscores, and must begin with a lowercase letter or decimal digit.');
+    }
+    if ((options === null || options === void 0 ? void 0 : options.profile) && !/[a-zA-Z0-9][a-zA-Z0-9_.-]+/.test(options.profile)) {
+        throw new Error('Invalid profile option - must match regex: [a-zA-Z0-9][a-zA-Z0-9_.-]+');
+    }
+    if (!await isDockerRunning()) {
+        throw new Error('Docker is not running');
+    }
+    const defaultOptions = { args: [], attached: false, projectName: undefined, cwd: undefined };
+    const mergedOptions = { ...defaultOptions, ...options };
+    if (!options || options.useWslPrefix === undefined) {
+        mergedOptions.useWslPrefix = NodeCliUtilsConfig_js_1.config.useWslPrefixForDockerCommandsOnWindows;
+    }
+    const dockerComposeDir = path_1.default.dirname(dockerComposePath);
+    const dockerComposeFilename = path_1.default.basename(dockerComposePath);
+    if (!mergedOptions.cwd) {
+        mergedOptions.cwd = dockerComposeDir;
+    }
+    let dockerComposePathResolved = mergedOptions.cwd ? path_1.default.resolve(dockerComposePath) : dockerComposeFilename;
+    if (mergedOptions.useWslPrefix) {
+        dockerComposePathResolved = (0, generalUtils_js_1.toWslPath)(dockerComposePathResolved);
+    }
+    let spawnArgs = ['compose', '-f', dockerComposePathResolved];
+    if (mergedOptions.projectName) {
+        spawnArgs.push('--project-name', mergedOptions.projectName);
+    }
+    if (mergedOptions.profile) {
+        spawnArgs.push('--profile', mergedOptions.profile);
+    }
+    if (mergedOptions.altEnvFilePath) {
+        spawnArgs.push('--env-file', mergedOptions.useWslPrefix ? (0, generalUtils_js_1.toWslPath)(mergedOptions.altEnvFilePath) : mergedOptions.altEnvFilePath);
+    }
+    spawnArgs.push(dockerComposeCommand);
+    if (!mergedOptions.attached && dockerComposeCommandsThatSupportDetached.includes(dockerComposeCommand)) {
+        spawnArgs.push('--detach');
+    }
+    if (mergedOptions.args) {
+        spawnArgs = spawnArgs.concat(mergedOptions.args);
+    }
+    (0, generalUtils_js_1.trace)(`running command in ${mergedOptions.cwd}: docker ${spawnArgs.join(' ')}`);
+    const longRunning = dockerComposeCommandsThatSupportDetached.includes(dockerComposeCommand) && (options === null || options === void 0 ? void 0 : options.attached) === true;
+    (0, generalUtils_js_1.trace)(`docker compose command will be configured to use long running option: ${longRunning}`);
+    const spawnOptions = {
+        cwd: mergedOptions.cwd,
+        shell: (0, generalUtils_js_1.isPlatformWindows)(),
+        isLongRunning: longRunning
+    };
+    const spawnResult = mergedOptions.useWslPrefix ?
+        await (0, generalUtilsInternal_js_1.spawnAsyncInternal)('wsl', ['docker', ...spawnArgs], spawnOptions) :
+        await (0, generalUtilsInternal_js_1.spawnAsyncInternal)('docker', spawnArgs, spawnOptions);
+    if (spawnResult.code !== 0) {
+        throw new Error(`docker compose command failed with code ${spawnResult.code}`);
+    }
+}
+exports.spawnDockerCompose = spawnDockerCompose;
+/**
+ * Similar to {@link simpleSpawnAsync} but meant for `docker` calls only. Determines whether to run `docker` or `wsl docker` based
+ * on platform being windows and config setting `useWslPrefixForDockerCommands`.
+ * @param args The args to be passed to the docker command.
+ */
+async function simpleSpawnDockerAsync(args) {
+    const command = NodeCliUtilsConfig_js_1.config.useWslPrefixForDockerCommandsOnWindows ? 'wsl' : 'docker';
+    const spawnArgs = command === 'docker' ? args : ['docker', ...args];
+    return await (0, generalUtils_js_1.simpleSpawnAsync)(command, spawnArgs);
+}
+exports.simpleSpawnDockerAsync = simpleSpawnDockerAsync;
+/**
+* Uses {@link which} to determine if docker is installed. If the `which` call doesn't find docker and the platform
+* is Windows, then this will check the output of `wsl docker --version` to see if just the engine is installed.
+* @returns `true` if docker is installed, `false` otherwise
+*/
+async function isDockerInstalled() {
+    if ((await (0, generalUtils_js_1.which)('docker')).location) {
+        return true;
+    }
+    if ((0, generalUtils_js_1.isPlatformWindows)()) {
+        const result = await (0, generalUtils_js_1.simpleSpawnAsync)('wsl', ['docker', '--version']);
+        return result.code === 0;
+    }
+    return false;
+}
+exports.isDockerInstalled = isDockerInstalled;
+/**
+ * Runs the `docker info` command and looks for "error during connect" in the output to determine if docker is running. If you
+ * want to check if docker is installed, use {@link isDockerInstalled}.
+ * @returns `true` if docker is installed and running, `false` otherwise
+ */
+async function isDockerRunning() {
+    try {
+        const result = (0, generalUtils_js_1.isPlatformWindows)() ?
+            await (0, generalUtils_js_1.simpleSpawnAsync)('wsl', ['docker', 'info']) :
+            await (0, generalUtils_js_1.simpleSpawnAsync)('docker', ['info']);
+        return result.code === 0 && !result.stdout.includes('error during connect');
+    }
+    catch (err) {
+        return false;
+    }
+}
+exports.isDockerRunning = isDockerRunning;
+/**
+ * Attempt to start the docker service if it isn't running. Whether it's running is determined by a call to {@link isDockerRunning}.
+ *
+ * Notes on docker startup command:
+ * - May require entering a password
+ * - On Windows with Docker Desktop and from within powershell or cmd it will run in powershell: `Start-Process "C:\Program Files\Docker\Docker\Docker Desktop.exe" -NoNewWindow`
+ * - On Windows without Docker Desktop from within powershell or cmd it will run: `sudo service docker start`
+ * - On Linux (including WSL) it will run: `sudo systemctl start docker`
+ * - Not currently supported on Mac
+ * - If you're on Windows and have Docker Desktop but it is stopped and you're in a WSL shell, docker will appear as if it's not installed and this method will throw
+ *
+ * @throws An {@link Error} If docker is not detected on the system.
+ * @throws An {@link Error} if docker is detected as installed and not running but the OS is Mac.
+ */
+async function ensureDockerRunning() {
+    if (!await isDockerInstalled()) {
+        throw new Error('Docker does not appear to be installed');
+    }
+    if (await isDockerRunning()) {
+        return;
+    }
+    let command;
+    let args = [];
+    const isWindows = (0, generalUtils_js_1.isPlatformWindows)();
+    const isLinux = (0, generalUtils_js_1.isPlatformLinux)();
+    const dockerDesktopPath = 'C:\\Program Files\\Docker\\Docker\\Docker Desktop.exe';
+    let useExec = false;
+    if (isWindows) {
+        if (node_fs_1.default.existsSync(dockerDesktopPath)) {
+            command = 'powershell';
+            args = (0, generalUtils_js_1.getPowershellHackArgs)(`Start-Process 'C:\\Program Files\\Docker\\Docker\\Docker Desktop.exe' -NoNewWindow`);
+        }
+        else {
+            command = 'C:\\windows\\system32\\wsl.exe -u root -e sh -c "service docker start"';
+            useExec = true;
+        }
+    }
+    else if (isLinux) {
+        command = 'sudo';
+        args = ['service', 'docker', 'start'];
+    }
+    else {
+        throw new Error('Starting docker within ensureDockerRunning is only supported on Windows and Linux - you will have to start docker manually');
+    }
+    if (useExec) {
+        try {
+            (0, child_process_1.execSync)(command, { stdio: 'inherit' });
+        }
+        catch (err) {
+            throw new generalUtils_js_1.ExtendedError('Unable to start docker', (0, generalUtils_js_1.getNormalizedError)(err));
+        }
+    }
+    else {
+        const result = await (0, generalUtils_js_1.spawnAsync)(command, args, { shell: isWindows });
+        if (result.code !== 0) {
+            throw new Error('Unable to start docker - see error above');
+        }
+    }
+    // Wait for docker to be up and ready before continuing
+    await (0, generalUtils_js_1.withRetryAsync)(generalUtilsInternal_js_1.throwIfDockerNotReady, 6, 3000, { initialDelayMilliseconds: 3000 });
+}
+exports.ensureDockerRunning = ensureDockerRunning;
+/**
+ * The name of a docker volume to delete. Respects the config value `useWslPrefixForDockerCommands`.
+ * @param volumeName The name of the docker volume to delete.
+ * @throws An {@link ExtendedError} if the volume does not exist or the volume is in use.
+ */
+async function deleteDockerComposeVolume(volumeName) {
+    (0, generalUtils_js_1.requireString)('volumeName', volumeName);
+    // Docker compose volume names will have the same character restrictions as docker compose project names
+    if (!isValidDockerComposeProjectName(volumeName)) {
+        throw new Error(`Invalid volume name: ${volumeName}`);
+    }
+    try {
+        const composeVolumeName = await getDockerComposeVolumeName(volumeName);
+        if (!composeVolumeName) {
+            (0, generalUtils_js_1.log)(`volume ${volumeName} not found in docker compose config - skipping`);
+            return;
+        }
+        if (!await dockerVolumeExists(composeVolumeName)) {
+            (0, generalUtils_js_1.log)(`docker compose volume ${composeVolumeName} does not appear to exist - skipping`);
+            return;
+        }
+        await deleteDockerVolume(composeVolumeName);
+    }
+    catch (err) {
+        throw new generalUtils_js_1.ExtendedError(`Error removing the volume ${volumeName}`, (0, generalUtils_js_1.getNormalizedError)(err));
+    }
+}
+exports.deleteDockerComposeVolume = deleteDockerComposeVolume;
+/**
+ * This function will take the volume name as you defined it in `docker-compose.yml` and try getting the actual volume name that docker
+ * compose will use. This is needed because docker compose will prefix the volume name with the compose project name (directory name or env
+ * `COMPOSE_PROJECT_NAME` or `-p` passed to docker compose commands).
+ *
+ * This function respects the `useWslPrefixForDockerCommands` config option. See also: {@link deleteDockerComposeVolume}.
+ * @param volumeName The volume name as defined in the `docker-compose.yml` file.
+ * @returns The full name of the docker-compose-actualized docker volume.
+ */
+async function getDockerComposeVolumeName(volumeName) {
+    var _a, _b;
+    const result = await simpleSpawnDockerAsync(['compose', 'config', '--format', 'json']);
+    const composeConfigJson = JSON.parse(result.stdout);
+    return (_b = (_a = composeConfigJson === null || composeConfigJson === void 0 ? void 0 : composeConfigJson.volumes) === null || _a === void 0 ? void 0 : _a[volumeName]) === null || _b === void 0 ? void 0 : _b.name;
+}
+exports.getDockerComposeVolumeName = getDockerComposeVolumeName;
+/**
+ * Check if a docker volume exists based on inclusion of the specified `volumeName` in any of the output lines of `docker volume ls`.
+ *
+ * This function respects the `useWslPrefixForDockerCommands` config option. See also: {@link deleteDockerComposeVolume}.
+ * @param volumeName The docker volume name to check.
+ * @returns `true` if the docker volume exists, otherwise `false`.
+ */
+async function dockerVolumeExists(volumeName) {
+    const result = await simpleSpawnDockerAsync(['volume', 'ls']);
+    return result.stdoutLines.filter(ln => ln.includes(volumeName)).length > 0;
+}
+exports.dockerVolumeExists = dockerVolumeExists;
+/**
+ * This will attempt to delete a docker volume using the `docker volume rm` command.
+ *
+ * **Warning: ** there will be no prompt or confirmation before attempting to delete the volume.
+ *
+ * This function respects the `useWslPrefixForDockerCommands` config option. See also: {@link deleteDockerComposeVolume}.
+ * @param volumeName The name of the docker volume to delete.
+ * @throws An {@link Error} if the volume doesn't exist or is in use.
+ */
+async function deleteDockerVolume(volumeName) {
+    (0, generalUtils_js_1.trace)(`deleting docker compose volume ${volumeName}`);
+    await simpleSpawnDockerAsync(['volume', 'rm', volumeName]);
+}
+exports.deleteDockerVolume = deleteDockerVolume;
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"dockerUtils.js","sourceRoot":"","sources":["../../src/dockerUtils.ts"],"names":[],"mappings":";;;;;;AAAA,iDAAwC;AACxC,sDAAwB;AACxB,gDAAuB;AACvB,mEAAgD;AAChD,uDAAgQ;AAChQ,uEAA2G;AAO3G,MAAM,wCAAwC,GAA2B,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,CAAA;AAExI;;;;;;;;;GASG;AACH,SAAgB,+BAA+B,CAAC,WAAmB;IACjE,IAAA,+BAAa,EAAC,aAAa,EAAE,WAAW,CAAC,CAAA;IAEzC,mDAAmD;IACnD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,EAAE;QACrC,OAAO,KAAK,CAAA;KACb;IAED,0FAA0F;IAC1F,OAAO,eAAe,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;AAC1C,CAAC;AAVD,0EAUC;AAED;;;;;;;;GAQG;AACH,SAAgB,0BAA0B,CAAC,aAAqB;IAC9D,OAAO,4BAA4B,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAA;AACzF,CAAC;AAFD,gEAEC;AAmED;;;;;;;;;;GAUG;AACI,KAAK,UAAU,kBAAkB,CAAC,iBAAyB,EAAE,oBAA0C,EAAE,OAAuC;IACrJ,IAAA,kCAAgB,EAAC,mBAAmB,EAAE,iBAAiB,CAAC,CAAA;IACxD,IAAA,+BAAa,EAAC,sBAAsB,EAAE,oBAAoB,CAAC,CAAA;IAC3D,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,GAAG,EAAE;QAChB,IAAA,kCAAgB,EAAC,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,CAAA;KACrC;IACD,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,cAAc,EAAE;QAC3B,IAAA,kCAAgB,EAAC,gBAAgB,EAAE,OAAO,CAAC,cAAc,CAAC,CAAA;KAC3D;IACD,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,WAAW,KAAI,CAAC,+BAA+B,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE;QACjF,MAAM,IAAI,KAAK,CAAC,+NAA+N,CAAC,CAAA;KACjP;IACD,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO,KAAI,CAAC,4BAA4B,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;QAC3E,MAAM,IAAI,KAAK,CAAC,uEAAuE,CAAC,CAAA;KACzF;IACD,IAAI,CAAC,MAAM,eAAe,EAAE,EAAE;QAC5B,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAA;KACzC;IAED,MAAM,cAAc,GAAyB,EAAE,IAAI,EAAE,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,WAAW,EAAE,SAAS,EAAE,GAAG,EAAE,SAAS,EAAE,CAAA;IAClH,MAAM,aAAa,GAAG,EAAE,GAAG,cAAc,EAAE,GAAG,OAAO,EAAE,CAAA;IACvD,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,YAAY,KAAK,SAAS,EAAE;QAClD,aAAa,CAAC,YAAY,GAAG,8BAAM,CAAC,sCAAsC,CAAA;KAC3E;IAED,MAAM,gBAAgB,GAAG,cAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAA;IACxD,MAAM,qBAAqB,GAAG,cAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAA;IAE9D,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE;QACtB,aAAa,CAAC,GAAG,GAAG,gBAAgB,CAAA;KACrC;IAED,IAAI,yBAAyB,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,cAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,qBAAqB,CAAA;IAC3G,IAAI,aAAa,CAAC,YAAY,EAAE;QAC9B,yBAAyB,GAAG,IAAA,2BAAS,EAAC,yBAAyB,CAAC,CAAA;KACjE;IAED,IAAI,SAAS,GAAG,CAAC,SAAS,EAAE,IAAI,EAAE,yBAAyB,CAAC,CAAA;IAE5D,IAAI,aAAa,CAAC,WAAW,EAAE;QAC7B,SAAS,CAAC,IAAI,CAAC,gBAAgB,EAAE,aAAa,CAAC,WAAW,CAAC,CAAA;KAC5D;IAED,IAAI,aAAa,CAAC,OAAO,EAAE;QACzB,SAAS,CAAC,IAAI,CAAC,WAAW,EAAE,aAAa,CAAC,OAAO,CAAC,CAAA;KACnD;IAED,IAAI,aAAa,CAAC,cAAc,EAAE;QAChC,SAAS,CAAC,IAAI,CAAC,YAAY,EAAE,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC,IAAA,2BAAS,EAAC,aAAa,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,cAAc,CAAC,CAAA;KAClI;IAED,SAAS,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAA;IAEpC,IAAI,CAAC,aAAa,CAAC,QAAQ,IAAI,wCAAwC,CAAC,QAAQ,CAAC,oBAAoB,CAAC,EAAE;QACtG,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;KAC3B;IAED,IAAI,aAAa,CAAC,IAAI,EAAE;QACtB,SAAS,GAAG,SAAS,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,CAAA;KACjD;IAED,IAAA,uBAAK,EAAC,sBAAsB,aAAa,CAAC,GAAG,YAAY,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;IAE/E,MAAM,WAAW,GAAG,wCAAwC,CAAC,QAAQ,CAAC,oBAAoB,CAAC,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ,MAAK,IAAI,CAAA;IAEzH,IAAA,uBAAK,EAAC,yEAAyE,WAAW,EAAE,CAAC,CAAA;IAE7F,MAAM,YAAY,GAAkC;QAClD,GAAG,EAAE,aAAa,CAAC,GAAG;QACtB,KAAK,EAAE,IAAA,mCAAiB,GAAE;QAC1B,aAAa,EAAE,WAAW;KAC3B,CAAA;IAED,MAAM,WAAW,GAAG,aAAa,CAAC,YAAY,CAAC,CAAC;QAC9C,MAAM,IAAA,4CAAkB,EAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,GAAG,SAAS,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC;QACzE,MAAM,IAAA,4CAAkB,EAAC,QAAQ,EAAE,SAAS,EAAE,YAAY,CAAC,CAAA;IAE7D,IAAI,WAAW,CAAC,IAAI,KAAK,CAAC,EAAE;QAC1B,MAAM,IAAI,KAAK,CAAC,2CAA2C,WAAW,CAAC,IAAI,EAAE,CAAC,CAAA;KAC/E;AACH,CAAC;AAhFD,gDAgFC;AAED;;;;GAIG;AACI,KAAK,UAAU,sBAAsB,CAAC,IAAc;IACzD,MAAM,OAAO,GAAG,8BAAM,CAAC,sCAAsC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAA;IAChF,MAAM,SAAS,GAAG,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,GAAG,IAAI,CAAC,CAAA;IACnE,OAAO,MAAM,IAAA,kCAAgB,EAAC,OAAO,EAAE,SAAS,CAAC,CAAA;AACnD,CAAC;AAJD,wDAIC;AAED;;;;EAIE;AACK,KAAK,UAAU,iBAAiB;IACrC,IAAI,CAAC,MAAM,IAAA,uBAAK,EAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,EAAE;QACpC,OAAO,IAAI,CAAA;KACZ;IACD,IAAI,IAAA,mCAAiB,GAAE,EAAE;QACvB,MAAM,MAAM,GAAG,MAAM,IAAA,kCAAgB,EAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC,CAAA;QACrE,OAAO,MAAM,CAAC,IAAI,KAAK,CAAC,CAAA;KACzB;IACD,OAAO,KAAK,CAAA;AACd,CAAC;AATD,8CASC;AAED;;;;GAIG;AACI,KAAK,UAAU,eAAe;IACnC,IAAI;QACF,MAAM,MAAM,GAAG,IAAA,mCAAiB,GAAE,CAAC,CAAC;YAClC,MAAM,IAAA,kCAAgB,EAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;YACnD,MAAM,IAAA,kCAAgB,EAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,CAAC,CAAA;QAC5C,OAAO,MAAM,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,sBAAsB,CAAC,CAAA;KAC5E;IAAC,OAAO,GAAG,EAAE;QACZ,OAAO,KAAK,CAAA;KACb;AACH,CAAC;AATD,0CASC;AAED;;;;;;;;;;;;;GAaG;AACI,KAAK,UAAU,mBAAmB;IACvC,IAAI,CAAC,MAAM,iBAAiB,EAAE,EAAE;QAC9B,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAA;KAC1D;IAED,IAAI,MAAM,eAAe,EAAE,EAAE;QAC3B,OAAM;KACP;IAED,IAAI,OAAe,CAAA;IACnB,IAAI,IAAI,GAAa,EAAE,CAAA;IACvB,MAAM,SAAS,GAAG,IAAA,mCAAiB,GAAE,CAAA;IACrC,MAAM,OAAO,GAAG,IAAA,iCAAe,GAAE,CAAA;IACjC,MAAM,iBAAiB,GAAG,uDAAuD,CAAA;IACjF,IAAI,OAAO,GAAG,KAAK,CAAA;IAEnB,IAAI,SAAS,EAAE;QACb,IAAI,iBAAE,CAAC,UAAU,CAAC,iBAAiB,CAAC,EAAE;YACpC,OAAO,GAAG,YAAY,CAAA;YACtB,IAAI,GAAG,IAAA,uCAAqB,EAAC,oFAAoF,CAAC,CAAA;SACnH;aAAM;YACL,OAAO,GAAG,wEAAwE,CAAA;YAClF,OAAO,GAAG,IAAI,CAAA;SACf;KACF;SAAM,IAAI,OAAO,EAAE;QAClB,OAAO,GAAG,MAAM,CAAA;QAChB,IAAI,GAAG,CAAC,SAAS,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAA;KACtC;SAAM;QACL,MAAM,IAAI,KAAK,CAAC,4HAA4H,CAAC,CAAA;KAC9I;IAED,IAAI,OAAO,EAAE;QACX,IAAI;YACF,IAAA,wBAAQ,EAAC,OAAO,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAA;SACxC;QAAC,OAAO,GAAG,EAAE;YACZ,MAAM,IAAI,+BAAa,CAAC,wBAAwB,EAAE,IAAA,oCAAkB,EAAC,GAAG,CAAC,CAAC,CAAA;SAC3E;KACF;SAAM;QACL,MAAM,MAAM,GAAG,MAAM,IAAA,4BAAU,EAAC,OAAO,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAA;QACpE,IAAI,MAAM,CAAC,IAAI,KAAK,CAAC,EAAE;YACrB,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAA;SAC5D;KACF;IAED,uDAAuD;IACvD,MAAM,IAAA,gCAAc,EAAC,+CAAqB,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,wBAAwB,EAAE,IAAI,EAAE,CAAC,CAAA;AAC1F,CAAC;AA9CD,kDA8CC;AAED;;;;GAIG;AACI,KAAK,UAAU,yBAAyB,CAAC,UAAkB;IAChE,IAAA,+BAAa,EAAC,YAAY,EAAE,UAAU,CAAC,CAAA;IAEvC,wGAAwG;IACxG,IAAI,CAAC,+BAA+B,CAAC,UAAU,CAAC,EAAE;QAChD,MAAM,IAAI,KAAK,CAAC,wBAAwB,UAAU,EAAE,CAAC,CAAA;KACtD;IAED,IAAI;QACF,MAAM,iBAAiB,GAAG,MAAM,0BAA0B,CAAC,UAAU,CAAC,CAAA;QAEtE,IAAI,CAAC,iBAAiB,EAAE;YACtB,IAAA,qBAAG,EAAC,UAAU,UAAU,gDAAgD,CAAC,CAAA;YACzE,OAAM;SACP;QAED,IAAI,CAAC,MAAM,kBAAkB,CAAC,iBAAiB,CAAC,EAAE;YAChD,IAAA,qBAAG,EAAC,yBAAyB,iBAAiB,sCAAsC,CAAC,CAAA;YACrF,OAAM;SACP;QAED,MAAM,kBAAkB,CAAC,iBAAiB,CAAC,CAAA;KAC5C;IAAC,OAAO,GAAG,EAAE;QACZ,MAAM,IAAI,+BAAa,CAAC,6BAA6B,UAAU,EAAE,EAAE,IAAA,oCAAkB,EAAC,GAAG,CAAC,CAAC,CAAA;KAC5F;AACH,CAAC;AAzBD,8DAyBC;AAED;;;;;;;;GAQG;AACI,KAAK,UAAU,0BAA0B,CAAC,UAAkB;;IACjE,MAAM,MAAM,GAAG,MAAM,sBAAsB,CAAC,CAAC,SAAS,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC,CAAA;IACtF,MAAM,iBAAiB,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;IACnD,OAAO,MAAA,MAAA,iBAAiB,aAAjB,iBAAiB,uBAAjB,iBAAiB,CAAE,OAAO,0CAAG,UAAU,CAAC,0CAAE,IAAI,CAAA;AACvD,CAAC;AAJD,gEAIC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,kBAAkB,CAAC,UAAkB;IACzD,MAAM,MAAM,GAAG,MAAM,sBAAsB,CAAC,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAA;IAC7D,OAAO,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAA;AAC5E,CAAC;AAHD,gDAGC;AAED;;;;;;;;GAQG;AACI,KAAK,UAAU,kBAAkB,CAAC,UAAkB;IACzD,IAAA,uBAAK,EAAC,kCAAkC,UAAU,EAAE,CAAC,CAAA;IACrD,MAAM,sBAAsB,CAAC,CAAC,QAAQ,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC,CAAA;AAC5D,CAAC;AAHD,gDAGC"}

package/dist/cjs/generalUtils.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="node" />
+/// <reference types="node" />
 import { SpawnOptions } from 'node:child_process';
 /**
  * Just a wrapper for console.log() to type less.
@@ -83,10 +84,6 @@ export interface WhichResult {
     additionalLocations: string[] | undefined;
     error: Error | undefined;
 }
-/**
- * Type guard for command passed to {@link spawnDockerCompose}.
- */
-export type DockerComposeCommand = 'build' | 'config' | 'cp' | 'create' | 'down' | 'events' | 'exec' | 'images' | 'kill' | 'logs' | 'ls' | 'pause' | 'port' | 'ps' | 'pull' | 'push' | 'restart' | 'rm' | 'run' | 'start' | 'stop' | 'top' | 'unpause' | 'up' | 'version';
 /**
  * Sleeps for the specified number of milliseconds.
  * @param ms The number of milliseconds to sleep
@@ -178,84 +175,6 @@ export declare function requireString(paramName: string, paramValue: string): vo
  * @param paramValue The value of the parameter
  */
 export declare function requireValidPath(paramName: string, paramValue: string): void;
-/**
- * Project names must contain only lowercase letters, decimal digits, dashes, and underscores, and must begin with a lowercase letter or decimal digit.
- *
- * See https://docs.docker.com/compose/environment-variables/envvars/#compose_project_name.
- * @param projectName The string to validate
- * @returns `true` if it's a valid docker compose project name and `false` otherwise
- */
-export declare function isDockerComposeProjectNameValid(projectName: string): boolean;
-/**
- * Options for {@link spawnDockerCompose}.
- * @param projectName
- * Note that there are other better options such as using the environment variable `COMPOSE_PROJECT_NAME`. See https://docs.docker.com/compose/environment-variables/envvars/#compose_project_name.
- * @param attached Default: false. All commands that support the detached option wil use it unless attached is specified as true (-d support: exec, logs, ps, restart, run, start, stop, up)
- * @param useDockerComposeFileDirectoryAsCwd Default: false. If true, the docker compose command will be run in the directory containing the docker compose file.
- */
-export interface DockerComposeOptions {
-    /** Additional arguments to pass to the docker-compose command. */
-    args: string[];
-    /**
-     * Defaults to `false`. Controls whether or not the `--detach` option is passed. Note that this only applies to
-     * some commands (exec, logs, ps, restart, run, start, stop, up).
-     */
-    attached: boolean;
-    /**
-    * If not provided, it will default to using the directory that the docker-compose.yml is located in.
-    * Specifies what current working directory to use with the spawn command.
-    *
-    * **Important:**: this only affects the current working directory of the spawned process itself. The docker command will still only pull in env values from a `.env`
-    * file in the same directory as the docker-compose.yml, NOT the cwd passed here. If a different `.env` file path is needed, use the {@link altEnvFilePath} option. If
-    * you use the {@link altEnvFilePath} option with a relative path, ensure that it is relative to the current working directory passed with this option.
-    */
-    cwd?: string;
-    /**
-     * Optional. If provided, projectName will be passed as the `--project-name` param to `docker compose` so that generated containers will use it as a prefix
-     * instead of the default, which is the directory name where the docker-compose.yml is located.
-     *
-     * Alternate approaches for setting the docker compose project name:
-     *
-     * - Locate your docker-compose.yml file in the root of your project so that docker will use that directory name for prefixing generated containers
-     * - OR, locate your docker-compose.yml in a sub-directory named appropriately for use as a prefix for generated containers
-     * - OR, put a `.env` file in the same directory as your docker-compose.yml
-     * with the entry `COMPOSE_PROJECT_NAME=your-project-name`
-     *
-     * Additional note on docker compose project names form the official docker compose docs: "Project names must contain only lowercase letters, decimal digits,
-     * dashes, and underscores, and must begin with a lowercase letter or decimal digit". See https://docs.docker.com/compose/environment-variables/envvars/#compose_project_name.
-     *
-     */
-    projectName?: string;
-    /**
-     * Optional. If provided, profile is passed to docker compose along with `--profile` param. Must match this regex: `[a-zA-Z0-9][a-zA-Z0-9_.-]+`.
-     *
-     * See https://docs.docker.com/compose/profiles/.
-     */
-    profile?: string;
-    /**
-     * The option `useWslPrefix` set to `true` can be used If Docker Desktop is not installed on Windows and docker commands need to execute via wsl.
-     */
-    useWslPrefix?: boolean;
-    /**
-     * Specify an alternative env file. This is useful since docker will normally only use a `.env` file in the same directory as the docker-compose.yml file,
-     * regardless of the current working directory of the running command. This path will be passed to docker compose using the `--env-file` option.
-     *
-     * **Important:** if using a relative path, be sure pass the appropriate value for {@link cwd} to this method so that the relative path can correctly be resolved.
-     */
-    altEnvFilePath?: string;
-}
-/**
- * For docker compose commands, see https://docs.docker.com/compose/reference/. For available options for this wrapper function, see {@link DockerComposeOptions}.
- *
- * The current working directory will be the directory of the {@link dockerComposePath} unless specified in the options. This ensures relative paths in the
- * docker compose file will be relative to itself by default.
- *
- * See {@link DockerComposeOptions.projectName} for info on where to locate your docker compose file and how to specify the docker project name.
- * @param dockerComposePath Path to docker-compose.yml
- * @param dockerComposeCommand The docker-compose command to run
- * @param options {@link DockerComposeOptions} to use, including additional arguments to pass to the docker compose command and the project name
- */
-export declare function spawnDockerCompose(dockerComposePath: string, dockerComposeCommand: DockerComposeCommand, options?: Partial<DockerComposeOptions>): Promise<void>;
 /**
  * Splits a string into lines, removing `\n` and `\r` characters. Does not return empty lines. Also see {@link stringToLines}.
  * @param str String to split into lines
@@ -360,33 +279,6 @@ export declare function which(commandName: string): Promise<WhichResult>;
  * @returns The location of the command, any additional locations, and an error if one occurred
  */
 export declare function whichSync(commandName: string): WhichResult;
-/**
- * Uses {@link which} to determine if docker is installed. If the `which` call doesn't find docker and the platform
- * is Windows, then this will check the output of `wsl docker --version` to see if just the engine is installed.
- * @returns `true` if docker is installed, `false` otherwise
- */
-export declare function isDockerInstalled(): Promise<boolean>;
-/**
- * Runs the `docker info` command and looks for "error during connect" in the output to determine if docker is running. If you
- * want to check if docker is installed, use {@link isDockerInstalled}.
- * @returns `true` if docker is installed and running, `false` otherwise
- */
-export declare function isDockerRunning(): Promise<boolean>;
-/**
- * Attempt to start the docker service if it isn't running. Whether it's running is determined by a call to {@link isDockerRunning}.
- *
- * Notes on docker startup command:
- * - May require entering a password
- * - On Windows with Docker Desktop and from within powershell or cmd it will run in powershell: `Start-Process "C:\Program Files\Docker\Docker\Docker Desktop.exe" -NoNewWindow`
- * - On Windows without Docker Desktop from within powershell or cmd it will run: `sudo service docker start`
- * - On Linux (including WSL) it will run: `sudo systemctl start docker`
- * - Not currently supported on Mac
- * - If you're on Windows and have Docker Desktop but it is stopped and you're in a WSL shell, docker will appear as if it's not installed and this method will throw
- *
- * @throws An {@link Error} If docker is not detected on the system.
- * @throws An {@link Error} if docker is detected as installed and not running but the OS is Mac.
- */
-export declare function ensureDockerRunning(): Promise<void>;
 /**
  * Uses built-in NodeJS readline to ask a question and return the user's answer.
  * @param query The question to ask
@@ -589,7 +481,8 @@ export declare enum Emoji {
     NoEntry = "\u26D4",
     Stop = "\uD83D\uDED1",
     Certificate = "\uD83D\uDCDC",
-    Key = "\uD83D\uDD11"
+    Key = "\uD83D\uDD11",
+    Scull = "\u2620\uFE0F"
 }
 /**
  * Converts a windows path to a WSL path (Windows Subsystem for Linux) if it's an absolute path, otherwise returns it unchanged.
@@ -604,7 +497,70 @@ export declare enum Emoji {
  * @returns The wsl equivalent path.
  */
 export declare function toWslPath(winPath: string, wrapInQuotesIfSpaces?: boolean): string;
+/**
+ * Serialize a class instance. Ignore properties with underscore prefix and include getters. Useful for overriding the `toJSON` function of
+ * a class so that calls to `JSON.stringify()` will generate more appropriate JSON.
+ *
+ * @example
+ * ```
+ * class MyClass {
+ *   //...
+ *   toJSON = () => classToJson(this)
+ *   //...
+ * }
+ * ```
+ * @param instance A class instance, usually `this` if `classToJson` is being used as a class method.
+ * @returns Json serialization of the class instance.
+ */
 export declare function classToJson(instance: object): {
     [key: string]: unknown;
 };
+/**
+ * Get's the value for the CLI param at process.argv[`argvIndex`] and throws the specified optional `errorMessage`
+ * or a default error message if the CLI arg is missing.
+ *
+ * Notes on common index position values:
+ *
+ * - `0`: NodeJS path
+ * - `1`: Script path
+ * - `2`: First script param - for `swig` this will be the task name
+ * @param errorMessage
+ * @returns
+ */
+export declare function getRequiredCliParam(argvIndex: number, errorMessage?: string): string;
+type AsyncBooleanFunc = () => Promise<boolean>;
+type AsyncFunc<T> = () => Promise<T>;
+/**
+ * Executes an asynchronous function conditionally.
+ *
+ * @overload
+ * @template T The type of value that the `asyncFunc` returns.
+ * @param condition A boolean that determines if the `asyncFunc` should be executed.
+ * @param asyncFunc The async function to execute if the condition is true.
+ * @param logEnabled Optional. Determines whether to enable logging. Defaults to `false`.
+ * @returns Returns a Promise resolving to the value returned by `asyncFunc` if the condition is true, otherwise returns `undefined`.
+ */
+export declare function conditionallyAsync<T>(condition: boolean, asyncFunc: AsyncFunc<T>, logEnabled?: boolean): Promise<T | undefined>;
+/**
+ * Executes an asynchronous function conditionally.
+ *
+ * @overload
+ * @template T The type of value that the `asyncFunc` returns.
+ * @param conditionAsyncFunc An async function that returns a boolean that determines whether `asyncFunc` should be executed.
+ * @param asyncFunc The async function to execute if the condition is true.
+ * @param logEnabled Optional. Determines whether to enable logging. Defaults to `false`.
+ * @returns Returns a Promise resolving to the value returned by `asyncFunc` if the condition is true, otherwise returns `undefined`.
+ */
+export declare function conditionallyAsync<T>(conditionAsyncFunc: AsyncBooleanFunc, asyncFunc: AsyncFunc<T>, logEnabled?: boolean): Promise<T | undefined>;
+/**
+ * Type guard function to check if an Error is a `NodeJS.ErrnoException`.
+ * @param err The Error object to check.
+ * @returns `true` if it's a NodeJS.ErrnoException and `false` otherwise.
+ */
+export declare function isErrnoException(err: unknown): err is NodeJS.ErrnoException;
+/**
+ * Return `true` if `err` is a `NodeJS.ErrnoException` and has a `code` property equal to `ENOENT`.
+ */
+export declare function isErrorEnoent(err: unknown): boolean;
+export {};
 //# sourceMappingURL=generalUtils.d.ts.map

package/dist/cjs/generalUtils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"generalUtils.d.ts","sourceRoot":"","sources":["../../src/generalUtils.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,YAAY,EAAY,MAAM,oBAAoB,CAAA;AAgB3D;;;;GAIG;AACH,wBAAgB,GAAG,CAAC,IAAI,EAAE,OAAO,EAAE,GAAG,QAAQ,EAAE,OAAO,EAAE,QAExD;AAED;;;;GAIG;AACH,wBAAgB,KAAK,CAAC,SAAS,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,QAAQ,EAAE,OAAO,EAAE,QAI9E;AAED;;;;GAIG;AACH,wBAAgB,KAAK,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,GAAG,QAAQ,EAAE,OAAO,EAAE,QAK3D;AAED;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAAE,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,CAAA;AAE9D;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC;IACd;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;CACb;AAED;;;;GAIG;AACH,qBAAa,UAAW,SAAQ,KAAK;IACnC,MAAM,EAAE,WAAW,CAAA;gBAEP,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW;CAIjD;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAkB,SAAQ,WAAW;IACpD,WAAW,EAAE,MAAM,EAAE,CAAA;CACtB;AAED;;;;GAIG;AACH,qBAAa,gBAAiB,SAAQ,KAAK;IACzC,MAAM,EAAE,iBAAiB,CAAA;gBAEb,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,iBAAiB;CAIvD;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAA;IAC5B,mBAAmB,EAAE,MAAM,EAAE,GAAG,SAAS,CAAA;IACzC,KAAK,EAAE,KAAK,GAAG,SAAS,CAAA;CACzB;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,OAAO,GAAG,QAAQ,GAAG,IAAI,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,OAAO,GAAG,MAAM,GAAG,IAAI,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,GAAG,IAAI,GAAG,KAAK,GAAG,OAAO,GAAG,MAAM,GAAG,KAAK,GAAG,SAAS,GAAG,IAAI,GAAG,SAAS,CAAA;AAEzQ;;;;GAIG;AACH,wBAAsB,KAAK,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAIrD;AAED;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,YAAY;IACzD,cAAc,EAAE,OAAO,CAAA;IACvB,cAAc,CAAC,EAAE,MAAM,CAAA;CACxB;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAsB,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,GAAG,OAAO,CAAC,WAAW,CAAC,CAEjI;AAED;;;;;;;;;;;GAWG;AACH,wBAAsB,qBAAqB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAEhH;AAED;;;GAGG;AACH,wBAAsB,eAAe,CAAC,GAAG,EAAE,MAAM,iBAEhD;AAED;;;GAGG;AACH,wBAAsB,MAAM,CAAC,GAAG,EAAE,MAAM,iBASvC;AAED;;;GAGG;AACH,wBAAsB,UAAU,CAAC,GAAG,EAAE,MAAM,iBAG3C;AAED,MAAM,WAAW,qBAAqB;IACpC,gHAAgH;IAChH,2BAA2B,EAAE,MAAM,EAAE,CAAA;IACrC,KAAK,EAAE,OAAO,CAAA;IACd,gBAAgB,EAAE,OAAO,CAAA;CAC1B;AAED;;;;;GAKG;AACH,wBAAsB,cAAc,CAAC,gBAAgB,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,iBAwDtG;AAED;;;;;;GAMG;AACH,wBAAsB,qBAAqB,CAAC,eAAe,EAAE,MAAM,EAAE,oBAAoB,EAAE,MAAM,iBAoChG;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,QAIlE;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,QAMrE;AAED;;;;;;GAMG;AACH,wBAAgB,+BAA+B,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAU5E;AAED;;;;;;GAMG;AACH,MAAM,WAAW,oBAAoB;IACnC,kEAAkE;IAClE,IAAI,EAAE,MAAM,EAAE,CAAA;IAEd;;;OAGG;IACH,QAAQ,EAAE,OAAO,CAAA;IAEjB;;;;;;;MAOE;IACF,GAAG,CAAC,EAAE,MAAM,CAAA;IAEZ;;;;;;;;;;;;;;OAcG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IAEtB;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;CACxB;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,kBAAkB,CAAC,iBAAiB,EAAE,MAAM,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,oBAAoB,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAgFtK;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,CAG3D;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,CAGnD;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,EAAE,cAAc,GAAE,OAAc,GAAG,iBAAiB,CAMjH;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,EAAE,cAAc,GAAE,OAAc,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAMjI;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,EAAE,cAAc,GAAE,OAAc,GAAG,iBAAiB,CAEnH;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,gBAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,EAAE,cAAc,GAAE,OAAc,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAEnI;AAED;;GAEG;AACH,wBAAgB,iBAAiB,YAEhC;AAED;;;GAGG;AACH,wBAAgB,aAAa,YAE5B;AAED;;;GAGG;AACH,wBAAgB,eAAe,YAE9B;AAED;;;;;GAKG;AACH,wBAAsB,KAAK,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAErE;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,WAAW,EAAE,MAAM,GAAG,WAAW,CAE1D;AAED;;;;GAIG;AACH,wBAAsB,iBAAiB,IAAI,OAAO,CAAC,OAAO,CAAC,CAS1D;AAED;;;;GAIG;AACH,wBAAsB,eAAe,IAAI,OAAO,CAAC,OAAO,CAAC,CASxD;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAsB,mBAAmB,IAAI,OAAO,CAAC,IAAI,CAAC,CA8CzD;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAY1D;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAclE;AAED;;GAEG;AACH,wBAAsB,sBAAsB,kBAM3C;AAED;;;;;;;;;GASG;AACH,wBAAsB,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,iBAEjF;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,EAAE,uBAAuB,UAAQ,iBAElH;AAED;;;;;;;GAOG;AACH,wBAAsB,eAAe,CAAC,UAAU,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,aAAa,CAAC,EAAE,qBAAqB,iBAmB3I;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,qBAAqB,EAAE,SAAS,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,GAAG,qBAAqB,CAWxH;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,qBAAqB,GAAG,qBAAqB,CAYzF;AAED;;;GAGG;AACH,wBAAsB,iBAAiB,CAAC,OAAO,EAAE,MAAM,iBAStD;AAGD,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,EAAE,MAAM,CAAA;IAChB,qBAAqB,EAAE,MAAM,EAAE,CAAC;IAChC,+BAA+B,EAAE,OAAO,CAAA;CACzC;AAED;;;;;;;GAOG;AACH,wBAAsB,oBAAoB,CAAC,GAAG,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,gBAAgB,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAsCvI;AAED,+DAA+D;AAC/D,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAExD;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,GAAG,IAAI,CAgB/C;AAED;;GAEG;AACH,eAAO,MAAM,oBAAoB,2FAA2F,CAAA;AAE5H;;;;;;;;;GASG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,CAE/D;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,YAAY,EAAE,MAAM,UAgChD;AAED,qBAAa,aAAc,SAAQ,KAAK;IAC/B,UAAU,EAAE,KAAK,GAAG,IAAI,CAAA;gBAEnB,OAAO,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,KAAK;CAKhD;AAED,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAW/C;AAED,wBAAsB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAQhE;AAED,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAQrD;AAED,MAAM,MAAM,YAAY,GAAG,KAAK,GAAG,OAAO,GAAG,KAAK,CAAA;AAElD;;;GAGG;AACH,wBAAgB,eAAe,IAAI,YAAY,CAW9C;AAED;;;;GAIG;AACH,wBAAsB,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAkBpE;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,YAAY,UAAO,GAAG,MAAM,CAU9E;AAED,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,OAAO,GAAG,KAAK,CAkBtD;AAED,0CAA0C;AAC1C,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,wBAAwB,EAAE,MAAM,CAAA;IAChC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;;OAGG;IACH,YAAY,EAAE,OAAO,CAAA;IACrB;;OAEG;IACH,qBAAqB,EAAE,OAAO,CAAA;CAC/B;AAED;;;;;;GAMG;AACH,wBAAsB,cAAc,CAAC,IAAI,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,gBAAgB,CAAC,iBAuC/I;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAEtD;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAWvD;AAED,wBAAgB,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAElD;AAED,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAQ9D;AAED,oBAAY,KAAK;IACf,UAAU,iBAAO;IACjB,SAAS,iBAAO;IAChB,UAAU,WAAM;IAChB,OAAO,iBAAO;IACd,SAAS,WAAM;IACf,WAAW,WAAM;IACjB,WAAW,WAAM;IACjB,IAAI,WAAM;IACV,IAAI,iBAAO;IACX,OAAO,iBAAO;IACd,KAAK,uBAAQ;IACb,OAAO,WAAM;IACb,IAAI,iBAAO;IACX,WAAW,iBAAO;IAClB,GAAG,iBAAO;CACX;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,oBAAoB,GAAE,OAAc,GAAG,MAAM,CAqBvF;AAED,wBAAgB,WAAW,CAAC,QAAQ,EAAE,MAAM;;EAqB3C"}
+{"version":3,"file":"generalUtils.d.ts","sourceRoot":"","sources":["../../src/generalUtils.ts"],"names":[],"mappings":";;AACA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AAajD;;;;GAIG;AACH,wBAAgB,GAAG,CAAC,IAAI,EAAE,OAAO,EAAE,GAAG,QAAQ,EAAE,OAAO,EAAE,QAExD;AAED;;;;GAIG;AACH,wBAAgB,KAAK,CAAC,SAAS,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,QAAQ,EAAE,OAAO,EAAE,QAI9E;AAED;;;;GAIG;AACH,wBAAgB,KAAK,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,GAAG,QAAQ,EAAE,OAAO,EAAE,QAK3D;AAED;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAAE,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,CAAA;AAE9D;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC;IACd;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;CACb;AAED;;;;GAIG;AACH,qBAAa,UAAW,SAAQ,KAAK;IACnC,MAAM,EAAE,WAAW,CAAA;gBAEP,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW;CAIjD;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAkB,SAAQ,WAAW;IACpD,WAAW,EAAE,MAAM,EAAE,CAAA;CACtB;AAED;;;;GAIG;AACH,qBAAa,gBAAiB,SAAQ,KAAK;IACzC,MAAM,EAAE,iBAAiB,CAAA;gBAEb,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,iBAAiB;CAIvD;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAA;IAC5B,mBAAmB,EAAE,MAAM,EAAE,GAAG,SAAS,CAAA;IACzC,KAAK,EAAE,KAAK,GAAG,SAAS,CAAA;CACzB;AAED;;;;GAIG;AACH,wBAAsB,KAAK,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAIrD;AAED;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,YAAY;IACzD,cAAc,EAAE,OAAO,CAAA;IACvB,cAAc,CAAC,EAAE,MAAM,CAAA;CACxB;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAsB,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,GAAG,OAAO,CAAC,WAAW,CAAC,CAEjI;AAED;;;;;;;;;;;GAWG;AACH,wBAAsB,qBAAqB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAEhH;AAED;;;GAGG;AACH,wBAAsB,eAAe,CAAC,GAAG,EAAE,MAAM,iBAEhD;AAED;;;GAGG;AACH,wBAAsB,MAAM,CAAC,GAAG,EAAE,MAAM,iBASvC;AAED;;;GAGG;AACH,wBAAsB,UAAU,CAAC,GAAG,EAAE,MAAM,iBAG3C;AAED,MAAM,WAAW,qBAAqB;IACpC,gHAAgH;IAChH,2BAA2B,EAAE,MAAM,EAAE,CAAA;IACrC,KAAK,EAAE,OAAO,CAAA;IACd,gBAAgB,EAAE,OAAO,CAAA;CAC1B;AAED;;;;;GAKG;AACH,wBAAsB,cAAc,CAAC,gBAAgB,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,iBAwDtG;AAED;;;;;;GAMG;AACH,wBAAsB,qBAAqB,CAAC,eAAe,EAAE,MAAM,EAAE,oBAAoB,EAAE,MAAM,iBAoChG;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,QAIlE;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,QAMrE;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,CAG3D;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,CAGnD;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,EAAE,cAAc,GAAE,OAAc,GAAG,iBAAiB,CAMjH;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,EAAE,cAAc,GAAE,OAAc,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAMjI;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,EAAE,cAAc,GAAE,OAAc,GAAG,iBAAiB,CAEnH;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,gBAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,EAAE,cAAc,GAAE,OAAc,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAEnI;AAED;;GAEG;AACH,wBAAgB,iBAAiB,YAEhC;AAED;;;GAGG;AACH,wBAAgB,aAAa,YAE5B;AAED;;;GAGG;AACH,wBAAgB,eAAe,YAE9B;AAED;;;;;GAKG;AACH,wBAAsB,KAAK,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAErE;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,WAAW,EAAE,MAAM,GAAG,WAAW,CAE1D;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAY1D;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAclE;AAED;;GAEG;AACH,wBAAsB,sBAAsB,kBAM3C;AAED;;;;;;;;;GASG;AACH,wBAAsB,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,iBAEjF;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,EAAE,uBAAuB,UAAQ,iBAElH;AAED;;;;;;;GAOG;AACH,wBAAsB,eAAe,CAAC,UAAU,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,aAAa,CAAC,EAAE,qBAAqB,iBAmB3I;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,qBAAqB,EAAE,SAAS,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,GAAG,qBAAqB,CAWxH;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,qBAAqB,GAAG,qBAAqB,CAYzF;AAED;;;GAGG;AACH,wBAAsB,iBAAiB,CAAC,OAAO,EAAE,MAAM,iBAStD;AAGD,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,EAAE,MAAM,CAAA;IAChB,qBAAqB,EAAE,MAAM,EAAE,CAAC;IAChC,+BAA+B,EAAE,OAAO,CAAA;CACzC;AAED;;;;;;;GAOG;AACH,wBAAsB,oBAAoB,CAAC,GAAG,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,gBAAgB,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAsCvI;AAED,+DAA+D;AAC/D,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAExD;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,GAAG,IAAI,CAgB/C;AAED;;GAEG;AACH,eAAO,MAAM,oBAAoB,2FAA2F,CAAA;AAE5H;;;;;;;;;GASG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,CAE/D;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,YAAY,EAAE,MAAM,UAgChD;AAED,qBAAa,aAAc,SAAQ,KAAK;IAC/B,UAAU,EAAE,KAAK,GAAG,IAAI,CAAA;gBAEnB,OAAO,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,KAAK;CAKhD;AAED,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAW/C;AAED,wBAAsB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAQhE;AAED,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAQrD;AAED,MAAM,MAAM,YAAY,GAAG,KAAK,GAAG,OAAO,GAAG,KAAK,CAAA;AAElD;;;GAGG;AACH,wBAAgB,eAAe,IAAI,YAAY,CAW9C;AAED;;;;GAIG;AACH,wBAAsB,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAkBpE;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,YAAY,UAAO,GAAG,MAAM,CAU9E;AAED,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,OAAO,GAAG,KAAK,CAkBtD;AAED,0CAA0C;AAC1C,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,wBAAwB,EAAE,MAAM,CAAA;IAChC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;;OAGG;IACH,YAAY,EAAE,OAAO,CAAA;IACrB;;OAEG;IACH,qBAAqB,EAAE,OAAO,CAAA;CAC/B;AAED;;;;;;GAMG;AACH,wBAAsB,cAAc,CAAC,IAAI,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,gBAAgB,CAAC,iBAuC/I;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAEtD;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAWvD;AAED,wBAAgB,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAElD;AAED,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAQ9D;AAED,oBAAY,KAAK;IACf,UAAU,iBAAO;IACjB,SAAS,iBAAO;IAChB,UAAU,WAAM;IAChB,OAAO,iBAAO;IACd,SAAS,WAAM;IACf,WAAW,WAAM;IACjB,WAAW,WAAM;IACjB,IAAI,WAAM;IACV,IAAI,iBAAO;IACX,OAAO,iBAAO;IACd,KAAK,uBAAQ;IACb,OAAO,WAAM;IACb,IAAI,iBAAO;IACX,WAAW,iBAAO;IAClB,GAAG,iBAAO;IACV,KAAK,iBAAO;CACb;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,oBAAoB,GAAE,OAAc,GAAG,MAAM,CAqBvF;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,WAAW,CAAC,QAAQ,EAAE,MAAM;;EAmB3C;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,mBAAmB,CAAC,SAAS,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,UAW3E;AAED,KAAK,gBAAgB,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC,CAAA;AAC9C,KAAK,SAAS,CAAC,CAAC,IAAI,MAAM,OAAO,CAAC,CAAC,CAAC,CAAA;AAGpC;;;;;;;;;GASG;AACH,wBAAsB,kBAAkB,CAAC,CAAC,EAAE,SAAS,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC,CAAA;AAEtI;;;;;;;;;GASG;AACH,wBAAsB,kBAAkB,CAAC,CAAC,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC,CAAA;AAoBxJ;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,MAAM,CAAC,cAAc,CAM3E;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,OAAO,GAAG,OAAO,CAEnD"}