syncodemayo 1.0.9 → 2.0.0

package/{lib → dist/lib}/Client.d.ts

@@ -1,6 +1,6 @@
-import * as Log from './Log';
-import { IConfig, ITargetConfig } from './Config';
-import { TargetServer } from './TargetServer';
+import * as Log from './Log.js';
+import { IConfig, ITargetConfig } from './Config.js';
+import { TargetServer } from './TargetServer.js';
 export declare class Client {
     private _path;
     hasConfig: boolean | null;
@@ -9,7 +9,7 @@ export declare class Client {
     parseError: Error;
     whenReady: Promise<Client>;
     DEFAULT_CONFIG: string;
-    readonly hasError: boolean;
+    get hasError(): boolean;
     constructor(preferredPath: string | undefined);
     setVerbosity(level: Log.LogLevel): void;
     createConfig(preferredPath: string | undefined): Promise<boolean>;

package/dist/lib/Client.js

@@ -0,0 +1,73 @@
+import * as Log from './Log.js';
+import { resolve as resolvePath } from 'path';
+import { ConfigNotFoundError, loadConfigFile, resolveTarget } from './Config.js';
+import { TargetServer } from './TargetServer.js';
+import { DefaultConfig } from './ConfigSchema.js';
+import { writeLocalFile, localFileExists } from './Filelist.js';
+export class Client {
+    get hasError() {
+        return !!this.loadError || !!this.parseError;
+    }
+    constructor(preferredPath) {
+        this.hasConfig = null;
+        this.DEFAULT_CONFIG = "syncodemayo.json";
+        this._path = preferredPath;
+        this.whenReady = new Promise((resolve) => {
+            loadConfigFile(preferredPath)
+                .then((config) => {
+                this.config = config;
+                this._path = this.config._path;
+                this.hasConfig = true;
+                resolve(this);
+            })
+                .catch((err) => {
+                // No config file is not an error: hasConfig is false and neither error is set.
+                // Invalid JSON is a parse error; anything else (a schema error, a read failure) is a
+                // load error.
+                if (err instanceof SyntaxError)
+                    this.parseError = err;
+                else if (!(err instanceof ConfigNotFoundError))
+                    this.loadError = err;
+                this.hasConfig = false;
+                resolve(this);
+            });
+        });
+    }
+    setVerbosity(level) {
+        Log.setLogLevel(level);
+    }
+    async createConfig(preferredPath) {
+        const path = resolvePath(preferredPath || this._path || this.DEFAULT_CONFIG);
+        const alreadyExists = await localFileExists(path);
+        if (alreadyExists) {
+            throw new Error("Config already exists at " + path);
+        }
+        writeLocalFile(path, JSON.stringify(DefaultConfig, null, 2));
+        return true;
+    }
+    async getTargetNames() {
+        if (this.hasConfig === null)
+            throw new Error("Config not loaded yet.");
+        if (this.hasConfig === false) {
+            if (this.hasError) {
+                const error = this.loadError || this.parseError;
+                throw error;
+            }
+            else {
+                throw new Error("This directory has no SyncoDeMayo config.");
+            }
+        }
+        return Object.keys(this.config.targets).filter(name => this.config.targets[name].enabled);
+    }
+    getTargetConfig(name) {
+        return resolveTarget(this.config, name);
+    }
+    getTargetServer(name) {
+        return TargetServer.create(this.config, name);
+    }
+    static create(configPath) {
+        const client = new Client(configPath);
+        return client.whenReady;
+    }
+}
+//# sourceMappingURL=Client.js.map

package/dist/lib/Client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Client.js","sourceRoot":"./","sources":["lib/Client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,GAAG,MAAM,UAAU,CAAA;AAC/B,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,MAAM,CAAA;AAC7C,OAAO,EAAE,mBAAmB,EAAW,cAAc,EAAiB,aAAa,EAAE,MAAM,aAAa,CAAA;AACxG,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAA;AACjD,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,eAAe,CAAA;AAE/D,MAAM,OAAO,MAAM;IAUjB,IAAI,QAAQ;QACV,OAAO,CAAC,CAAC,IAAI,CAAC,SAAS,IAAI,CAAC,CAAC,IAAI,CAAC,UAAU,CAAA;IAC9C,CAAC;IAED,YAAY,aAAiC;QAZ7C,cAAS,GAAmB,IAAI,CAAA;QAMhC,mBAAc,GAAG,kBAAkB,CAAA;QAOjC,IAAI,CAAC,KAAK,GAAG,aAAa,CAAA;QAC1B,IAAI,CAAC,SAAS,GAAG,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YACvC,cAAc,CAAC,aAAa,CAAC;iBAC1B,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;gBACf,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;gBACpB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAA;gBAC9B,IAAI,CAAC,SAAS,GAAG,IAAI,CAAA;gBACrB,OAAO,CAAC,IAAI,CAAC,CAAA;YACf,CAAC,CAAC;iBACD,KAAK,CAAC,CAAC,GAAU,EAAE,EAAE;gBACpB,+EAA+E;gBAC/E,qFAAqF;gBACrF,cAAc;gBACd,IAAI,GAAG,YAAY,WAAW;oBAAE,IAAI,CAAC,UAAU,GAAG,GAAG,CAAA;qBAChD,IAAI,CAAC,CAAC,GAAG,YAAY,mBAAmB,CAAC;oBAAE,IAAI,CAAC,SAAS,GAAG,GAAG,CAAA;gBACpE,IAAI,CAAC,SAAS,GAAG,KAAK,CAAA;gBACtB,OAAO,CAAC,IAAI,CAAC,CAAA;YACf,CAAC,CAAC,CAAA;QACN,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,YAAY,CAAC,KAAmB;QAC9B,GAAG,CAAC,WAAW,CAAC,KAAK,CAAC,CAAA;IACxB,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,aAAiC;QAClD,MAAM,IAAI,GAAG,WAAW,CAAC,aAAa,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,cAAc,CAAC,CAAA;QAC5E,MAAM,aAAa,GAAG,MAAM,eAAe,CAAC,IAAI,CAAC,CAAA;QACjD,IAAI,aAAa,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CAAC,2BAA2B,GAAG,IAAI,CAAC,CAAA;QACrD,CAAC;QACD,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAA;QAC5D,OAAO,IAAI,CAAA;IACb,CAAC;IAED,KAAK,CAAC,cAAc;QAClB,IAAI,IAAI,CAAC,SAAS,KAAK,IAAI;YAAE,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAA;QACtE,IAAI,IAAI,CAAC,SAAS,KAAK,KAAK,EAAE,CAAC;YAC7B,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;gBAClB,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,UAAU,CAAA;gBAC/C,MAAM,KAAK,CAAA;YACb,CAAC;iBACI,CAAC;gBACJ,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAA;YAC9D,CAAC;QACH,CAAC;QACD,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CACpD,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAA;IACtC,CAAC;IAED,eAAe,CAAC,IAAwB;QACtC,OAAO,aAAa,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;IACzC,CAAC;IAED,eAAe,CAAC,IAAwC;QACtD,OAAO,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;IAC/C,CAAC;IAED,MAAM,CAAC,MAAM,CAAC,UAA8B;QAC1C,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,UAAU,CAAC,CAAA;QACrC,OAAO,MAAM,CAAC,SAAS,CAAA;IACzB,CAAC;CACF","sourcesContent":["import * as Log from './Log.js'\nimport { resolve as resolvePath } from 'path'\nimport { ConfigNotFoundError, IConfig, loadConfigFile, ITargetConfig, resolveTarget } from './Config.js'\nimport { TargetServer } from './TargetServer.js'\nimport { DefaultConfig } from './ConfigSchema.js'\nimport { writeLocalFile, localFileExists } from './Filelist.js'\n\nexport class Client {\n  private _path: string | undefined\n  hasConfig: boolean | null = null\n  config!: IConfig\n  loadError!: Error\n  parseError!: Error\n  whenReady: Promise<Client>\n\n  DEFAULT_CONFIG = \"syncodemayo.json\"\n\n  get hasError() {\n    return !!this.loadError || !!this.parseError\n  }\n\n  constructor(preferredPath: string | undefined) {\n    this._path = preferredPath\n    this.whenReady = new Promise((resolve) => {\n      loadConfigFile(preferredPath)\n        .then((config) => {\n          this.config = config\n          this._path = this.config._path\n          this.hasConfig = true\n          resolve(this)\n        })\n        .catch((err: Error) => {\n          // No config file is not an error: hasConfig is false and neither error is set.\n          // Invalid JSON is a parse error; anything else (a schema error, a read failure) is a\n          // load error.\n          if (err instanceof SyntaxError) this.parseError = err\n          else if (!(err instanceof ConfigNotFoundError)) this.loadError = err\n          this.hasConfig = false\n          resolve(this)\n        })\n    })\n  }\n\n  setVerbosity(level: Log.LogLevel) {\n    Log.setLogLevel(level)\n  }\n\n  async createConfig(preferredPath: string | undefined): Promise<boolean> {\n    const path = resolvePath(preferredPath || this._path || this.DEFAULT_CONFIG)\n    const alreadyExists = await localFileExists(path)\n    if (alreadyExists) {\n      throw new Error(\"Config already exists at \" + path)\n    }\n    writeLocalFile(path, JSON.stringify(DefaultConfig, null, 2))\n    return true\n  }\n\n  async getTargetNames(): Promise<string[]> {\n    if (this.hasConfig === null) throw new Error(\"Config not loaded yet.\")\n    if (this.hasConfig === false) {\n      if (this.hasError) {\n        const error = this.loadError || this.parseError\n        throw error\n      }\n      else {\n        throw new Error(\"This directory has no SyncoDeMayo config.\")\n      }\n    }\n    return Object.keys(this.config.targets).filter(name =>\n      this.config.targets[name].enabled)\n  }\n\n  getTargetConfig(name: string | undefined): ITargetConfig {\n    return resolveTarget(this.config, name)\n  }\n\n  getTargetServer(name: string | ITargetConfig | undefined): TargetServer {\n    return TargetServer.create(this.config, name)\n  }\n\n  static create(configPath: string | undefined): Promise<Client> {\n    const client = new Client(configPath)\n    return client.whenReady\n  }\n}"]}

package/dist/lib/Config.d.ts

@@ -0,0 +1,48 @@
+export interface IConfig {
+    local: ILocalConfig;
+    targets: {
+        [name: string]: ITargetConfig;
+    };
+    _path?: string;
+}
+export interface ILocalConfig {
+    path: string;
+    files: string;
+    exclude: string[];
+    defaultTarget: string;
+    deleteRemoteFiles: boolean;
+}
+export interface ITargetConfig {
+    host: string;
+    user: string;
+    pass?: string;
+    path: string;
+    port: number;
+    cache: string;
+    prompt?: boolean | string;
+    _name: string;
+    enabled?: boolean;
+    type?: string;
+    /** `false` (default): plain FTP. `true`: explicit FTPS. `"implicit"`: implicit FTPS. */
+    secure?: boolean | 'implicit';
+    /** Default `true`. `false` accepts self-signed or mismatched certificates, with a warning. */
+    rejectUnauthorized?: boolean;
+}
+/**
+ * Thrown by `loadConfigFile` when no config file exists: the preferred path is missing, or (with
+ * no preferred path) none of the default file names exists in the working directory.
+ */
+export declare class ConfigNotFoundError extends Error {
+    constructor(message?: string);
+}
+/** The config file names `loadConfigFile` tries, in order, when it isn't given a path. */
+export declare const CONFIG_FILE_NAMES: string[];
+/**
+ * Loads, validates, and fills in the defaults of a config file. With no preferred path it tries
+ * each of `CONFIG_FILE_NAMES` in the working directory and loads the first one that exists.
+ * Rejects with `ConfigNotFoundError` when there's no config file, with a `SyntaxError` when the
+ * file isn't valid JSON, and with a "Config Schema Error: ..." `Error` when it fails validation.
+ */
+export declare function loadConfigFile(preferredPath?: string): Promise<IConfig>;
+export declare function resolvePassword(targetConfig: ITargetConfig): string;
+export declare function resolveTarget(config: IConfig, name: string | ITargetConfig | undefined): ITargetConfig;

package/dist/lib/Config.js

@@ -0,0 +1,92 @@
+import { resolve as resolvePath } from 'path';
+import { validateConfig } from './ConfigSchema.js';
+import { localFileExists, readLocalFile } from './Filelist.js';
+import stripJsonComments from '../vendor/strip-json-comments.js';
+/**
+ * Thrown by `loadConfigFile` when no config file exists: the preferred path is missing, or (with
+ * no preferred path) none of the default file names exists in the working directory.
+ */
+export class ConfigNotFoundError extends Error {
+    constructor(message = "Local config not found.") {
+        super(message);
+        this.name = 'ConfigNotFoundError';
+    }
+}
+/** The config file names `loadConfigFile` tries, in order, when it isn't given a path. */
+export const CONFIG_FILE_NAMES = [
+    'syncodemayo.json',
+    '.syncodemayo.json',
+    'sync-config.json',
+];
+// Reads and parses a config file. Resolves undefined (which JSON never parses to) when the file
+// doesn't exist.
+async function evalConfigFromFile(pathname) {
+    if (typeof pathname !== 'string')
+        throw new Error(`Path must be a string. Got a ${typeof pathname}`);
+    const fullpath = resolvePath("./" + pathname);
+    if (!(await localFileExists(fullpath)))
+        return undefined;
+    const source = await readLocalFile(fullpath, false);
+    const data = JSON.parse(stripJsonComments(source));
+    if (typeof data === 'object' && data !== null)
+        data._path = fullpath;
+    return data;
+}
+/**
+ * Loads, validates, and fills in the defaults of a config file. With no preferred path it tries
+ * each of `CONFIG_FILE_NAMES` in the working directory and loads the first one that exists.
+ * Rejects with `ConfigNotFoundError` when there's no config file, with a `SyntaxError` when the
+ * file isn't valid JSON, and with a "Config Schema Error: ..." `Error` when it fails validation.
+ */
+export async function loadConfigFile(preferredPath) {
+    const potentialConfigs = (!!preferredPath) ? [preferredPath] : CONFIG_FILE_NAMES;
+    for (const path of potentialConfigs) {
+        const config = await evalConfigFromFile(path);
+        if (config !== undefined)
+            return massageConfigData(await validateConfig(config));
+    }
+    throw new ConfigNotFoundError();
+}
+async function massageConfigData(config) {
+    config.local.files = config.local.files || '**/**';
+    config.local.exclude = config.local.exclude || [];
+    config.local.defaultTarget = config.local.defaultTarget || "staging";
+    config.local.deleteRemoteFiles = config.local.deleteRemoteFiles === true;
+    Object.keys(config.targets).forEach(name => {
+        const target = config.targets[name];
+        target._name = name;
+        target.port = target.port || (target.secure === 'implicit' ? 990 : 21);
+        target.cache = target.cache || ".synco-filelist";
+        target.enabled = target.enabled !== false;
+        target.type = target.type || 'ftp'; // Will support more eventually
+        if (typeof target.prompt === 'undefined')
+            target.prompt = true;
+        target.secure = target.secure ?? false;
+        target.rejectUnauthorized = target.rejectUnauthorized ?? true;
+    });
+    return config;
+}
+export function resolvePassword(targetConfig) {
+    const password = targetConfig.pass || process.env[`${targetConfig._name.toUpperCase()}_PWD`];
+    if (typeof password === 'undefined') {
+        throw new Error("Cannot find password for target: " + targetConfig._name);
+    }
+    return password;
+}
+export function resolveTarget(config, name) {
+    if (typeof name === 'undefined')
+        name = config.local.defaultTarget;
+    if (typeof name === 'object')
+        return name;
+    const lookingFor = name;
+    const targetName = Object.keys(config.targets).find(namedTarget => (lookingFor.toUpperCase() === config.targets[namedTarget]._name.toUpperCase()));
+    if (!targetName) {
+        throw new Error("Target '" + name + "' not found.");
+    }
+    const target = config.targets[targetName];
+    if (!target.enabled) {
+        throw new Error("Target '" + name + "' not enabled.");
+    }
+    return target;
+}
+//# sourceMappingURL=Config.js.map

package/dist/lib/Config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Config.js","sourceRoot":"./","sources":["lib/Config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,MAAM,CAAA;AAC7C,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AAClD,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,eAAe,CAAA;AAC9D,OAAO,iBAAiB,MAAM,kCAAkC,CAAA;AAkChE;;;GAGG;AACH,MAAM,OAAO,mBAAoB,SAAQ,KAAK;IAC5C,YAAY,OAAO,GAAG,yBAAyB;QAC7C,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,qBAAqB,CAAA;IACnC,CAAC;CACF;AAED,0FAA0F;AAC1F,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,kBAAkB;IAClB,mBAAmB;IACnB,kBAAkB;CACnB,CAAA;AAED,gGAAgG;AAChG,iBAAiB;AACjB,KAAK,UAAU,kBAAkB,CAAC,QAAgB;IAChD,IAAI,OAAO,QAAQ,KAAK,QAAQ;QAC9B,MAAM,IAAI,KAAK,CAAC,gCAAgC,OAAO,QAAQ,EAAE,CAAC,CAAA;IAEpE,MAAM,QAAQ,GAAG,WAAW,CAAC,IAAI,GAAG,QAAQ,CAAC,CAAA;IAC7C,IAAI,CAAC,CAAC,MAAM,eAAe,CAAC,QAAQ,CAAC,CAAC;QACpC,OAAO,SAAS,CAAA;IAElB,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC,QAAQ,EAAE,KAAK,CAAW,CAAA;IAC7D,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAY,CAAA;IAE7D,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI;QAC3C,IAAI,CAAC,KAAK,GAAG,QAAQ,CAAA;IAEvB,OAAO,IAAI,CAAA;AACb,CAAC;AAGD;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,aAAsB;IACzD,MAAM,gBAAgB,GAAG,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAA;IAEhF,KAAK,MAAM,IAAI,IAAI,gBAAgB,EAAE,CAAC;QACpC,MAAM,MAAM,GAAG,MAAM,kBAAkB,CAAC,IAAI,CAAC,CAAA;QAC7C,IAAI,MAAM,KAAK,SAAS;YACtB,OAAO,iBAAiB,CAAC,MAAM,cAAc,CAAC,MAAM,CAAC,CAAC,CAAA;IAC1D,CAAC;IAED,MAAM,IAAI,mBAAmB,EAAE,CAAA;AACjC,CAAC;AAED,KAAK,UAAU,iBAAiB,CAAC,MAAe;IAC9C,MAAM,CAAC,KAAK,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,KAAK,IAAI,OAAO,CAAA;IAClD,MAAM,CAAC,KAAK,CAAC,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,OAAO,IAAI,EAAE,CAAA;IACjD,MAAM,CAAC,KAAK,CAAC,aAAa,GAAG,MAAM,CAAC,KAAK,CAAC,aAAa,IAAI,SAAS,CAAA;IACpE,MAAM,CAAC,KAAK,CAAC,iBAAiB,GAAG,MAAM,CAAC,KAAK,CAAC,iBAAiB,KAAK,IAAI,CAAA;IAExE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QACzC,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;QACnC,MAAM,CAAC,KAAK,GAAG,IAAI,CAAA;QACnB,MAAM,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAA;QACtE,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,IAAI,iBAAiB,CAAA;QAChD,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,KAAK,KAAK,CAAA;QACzC,MAAM,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,IAAI,KAAK,CAAA,CAAC,+BAA+B;QAClE,IAAI,OAAO,MAAM,CAAC,MAAM,KAAK,WAAW;YACtC,MAAM,CAAC,MAAM,GAAG,IAAI,CAAA;QACtB,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,IAAI,KAAK,CAAA;QACtC,MAAM,CAAC,kBAAkB,GAAG,MAAM,CAAC,kBAAkB,IAAI,IAAI,CAAA;IAC/D,CAAC,CAAC,CAAA;IAEF,OAAO,MAAM,CAAA;AACf,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,YAA2B;IACzD,MAAM,QAAQ,GAAG,YAAY,CAAC,IAAI,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,YAAY,CAAC,KAAK,CAAC,WAAW,EAAE,MAAM,CAAW,CAAA;IACtG,IAAI,OAAO,QAAQ,KAAK,WAAW,EAAE,CAAC;QACpC,MAAM,IAAI,KAAK,CAAC,mCAAmC,GAAG,YAAY,CAAC,KAAK,CAAC,CAAA;IAC3E,CAAC;IACD,OAAO,QAAQ,CAAA;AACjB,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,MAAe,EAAE,IAAwC;IACrF,IAAI,OAAO,IAAI,KAAK,WAAW;QAAE,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,aAAa,CAAA;IAClE,IAAI,OAAO,IAAI,KAAK,QAAQ;QAAE,OAAO,IAAI,CAAA;IAEzC,MAAM,UAAU,GAAG,IAAc,CAAA;IACjC,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CACjE,UAAU,CAAC,WAAW,EAAE,KAAK,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,KAAK,CAAC,WAAW,EAAE,CAC7E,CAAC,CAAA;IAEF,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,MAAM,IAAI,KAAK,CAAC,UAAU,GAAG,IAAI,GAAG,cAAc,CAAC,CAAA;IACrD,CAAC;IAED,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAA;IAEzC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACpB,MAAM,IAAI,KAAK,CAAC,UAAU,GAAG,IAAI,GAAG,gBAAgB,CAAC,CAAA;IACvD,CAAC;IAED,OAAO,MAAM,CAAA;AACf,CAAC","sourcesContent":["import { resolve as resolvePath } from 'path'\nimport { validateConfig } from './ConfigSchema.js'\nimport { localFileExists, readLocalFile } from './Filelist.js'\nimport stripJsonComments from '../vendor/strip-json-comments.js'\n\n\nexport interface IConfig {\n  local: ILocalConfig\n  targets: { [name: string]: ITargetConfig }\n  _path?: string\n}\n\nexport interface ILocalConfig {\n  path: string\n  files: string\n  exclude: string[]\n  defaultTarget: string\n  deleteRemoteFiles: boolean\n}\n\nexport interface ITargetConfig {\n  host: string\n  user: string\n  pass?: string\n  path: string\n  port: number\n  cache: string\n  prompt?: boolean | string\n  _name: string\n  enabled?: boolean\n  type?: string\n  /** `false` (default): plain FTP. `true`: explicit FTPS. `\"implicit\"`: implicit FTPS. */\n  secure?: boolean | 'implicit'\n  /** Default `true`. `false` accepts self-signed or mismatched certificates, with a warning. */\n  rejectUnauthorized?: boolean\n}\n\n/**\n * Thrown by `loadConfigFile` when no config file exists: the preferred path is missing, or (with\n * no preferred path) none of the default file names exists in the working directory.\n */\nexport class ConfigNotFoundError extends Error {\n  constructor(message = \"Local config not found.\") {\n    super(message)\n    this.name = 'ConfigNotFoundError'\n  }\n}\n\n/** The config file names `loadConfigFile` tries, in order, when it isn't given a path. */\nexport const CONFIG_FILE_NAMES = [\n  'syncodemayo.json',\n  '.syncodemayo.json',\n  'sync-config.json',\n]\n\n// Reads and parses a config file. Resolves undefined (which JSON never parses to) when the file\n// doesn't exist.\nasync function evalConfigFromFile(pathname: string): Promise<IConfig | undefined> {\n  if (typeof pathname !== 'string')\n    throw new Error(`Path must be a string. Got a ${typeof pathname}`)\n\n  const fullpath = resolvePath(\"./\" + pathname)\n  if (!(await localFileExists(fullpath)))\n    return undefined\n\n  const source = await readLocalFile(fullpath, false) as string\n  const data = JSON.parse(stripJsonComments(source)) as IConfig\n\n  if (typeof data === 'object' && data !== null)\n    data._path = fullpath\n\n  return data\n}\n\n\n/**\n * Loads, validates, and fills in the defaults of a config file. With no preferred path it tries\n * each of `CONFIG_FILE_NAMES` in the working directory and loads the first one that exists.\n * Rejects with `ConfigNotFoundError` when there's no config file, with a `SyntaxError` when the\n * file isn't valid JSON, and with a \"Config Schema Error: ...\" `Error` when it fails validation.\n */\nexport async function loadConfigFile(preferredPath?: string): Promise<IConfig> {\n  const potentialConfigs = (!!preferredPath) ? [preferredPath] : CONFIG_FILE_NAMES\n\n  for (const path of potentialConfigs) {\n    const config = await evalConfigFromFile(path)\n    if (config !== undefined)\n      return massageConfigData(await validateConfig(config))\n  }\n\n  throw new ConfigNotFoundError()\n}\n\nasync function massageConfigData(config: IConfig): Promise<IConfig> {\n  config.local.files = config.local.files || '**/**'\n  config.local.exclude = config.local.exclude || []\n  config.local.defaultTarget = config.local.defaultTarget || \"staging\"\n  config.local.deleteRemoteFiles = config.local.deleteRemoteFiles === true\n\n  Object.keys(config.targets).forEach(name => {\n    const target = config.targets[name]\n    target._name = name\n    target.port = target.port || (target.secure === 'implicit' ? 990 : 21)\n    target.cache = target.cache || \".synco-filelist\"\n    target.enabled = target.enabled !== false\n    target.type = target.type || 'ftp' // Will support more eventually\n    if (typeof target.prompt === 'undefined')\n      target.prompt = true\n    target.secure = target.secure ?? false\n    target.rejectUnauthorized = target.rejectUnauthorized ?? true\n  })\n\n  return config\n}\n\nexport function resolvePassword(targetConfig: ITargetConfig): string {\n  const password = targetConfig.pass || process.env[`${targetConfig._name.toUpperCase()}_PWD`] as string\n  if (typeof password === 'undefined') {\n    throw new Error(\"Cannot find password for target: \" + targetConfig._name)\n  }\n  return password\n}\n\nexport function resolveTarget(config: IConfig, name: string | ITargetConfig | undefined): ITargetConfig {\n  if (typeof name === 'undefined') name = config.local.defaultTarget\n  if (typeof name === 'object') return name\n\n  const lookingFor = name as string\n  const targetName = Object.keys(config.targets).find(namedTarget => (\n    lookingFor.toUpperCase() === config.targets[namedTarget]._name.toUpperCase()\n  ))\n\n  if (!targetName) {\n    throw new Error(\"Target '\" + name + \"' not found.\")\n  }\n\n  const target = config.targets[targetName]\n\n  if (!target.enabled) {\n    throw new Error(\"Target '\" + name + \"' not enabled.\")\n  }\n\n  return target\n}"]}

package/dist/lib/ConfigSchema.d.ts

@@ -0,0 +1,3 @@
+import { IConfig } from './Config.js';
+export declare function validateConfig(config: IConfig): Promise<IConfig>;
+export declare const DefaultConfig: any;

package/dist/lib/ConfigSchema.js

@@ -0,0 +1,132 @@
+const isPlainObject = (value) => typeof value === 'object' && value !== null && !Array.isArray(value);
+const string = (value) => {
+    if (typeof value !== 'string')
+        return 'must be a string';
+    if (value === '')
+        return 'must not be empty';
+    return undefined;
+};
+// v1 joi.bool(): a boolean, or the string "true"/"false" in any case.
+const boolean = (value) => {
+    if (typeof value === 'boolean')
+        return undefined;
+    if (typeof value === 'string' && ['true', 'false'].includes(value.toLowerCase()))
+        return undefined;
+    return 'must be a boolean';
+};
+// v1 joi.number(): a finite number, or a string that parseFloat reads and isFinite accepts.
+const number = (value) => {
+    if (typeof value === 'number')
+        return Number.isFinite(value) ? undefined : 'must be a finite number';
+    if (typeof value === 'string') {
+        const parsed = parseFloat(value);
+        if (!Number.isNaN(parsed) && isFinite(value))
+            return undefined;
+    }
+    return 'must be a number';
+};
+const stringArray = (value) => {
+    if (!Array.isArray(value))
+        return 'must be an array';
+    for (let i = 0; i < value.length; i++) {
+        const problem = string(value[i]);
+        if (problem)
+            return `item ${i} ${problem}`;
+    }
+    return undefined;
+};
+const booleanOrString = (value) => (boolean(value) && string(value)) ? 'must be a boolean or a non-empty string' : undefined;
+// Target `secure`: exactly true, false or "implicit".
+const secure = (value) => (value === true || value === false || value === 'implicit') ? undefined : 'must be true, false or "implicit"';
+// A JSON boolean only (no "true"/"false" strings).
+const strictBoolean = (value) => typeof value === 'boolean' ? undefined : 'must be a boolean';
+const localShape = {
+    path: { check: string, required: true },
+    files: { check: string },
+    exclude: { check: stringArray },
+    defaultTarget: { check: string },
+    deleteRemoteFiles: { check: boolean },
+};
+const targetShape = {
+    host: { check: string, required: true },
+    user: { check: string, required: true },
+    path: { check: string, required: true },
+    pass: { check: string },
+    port: { check: number },
+    cache: { check: string },
+    prompt: { check: booleanOrString },
+    enabled: { check: boolean },
+    secure: { check: secure },
+    rejectUnauthorized: { check: strictBoolean },
+    // For future use...
+    type: { check: string },
+};
+// Returns the first problem with `value` against `shape`, as `<path> <problem>`, or undefined.
+function checkShape(value, shape, path) {
+    if (!isPlainObject(value))
+        return `${path} must be an object`;
+    for (const key of Object.keys(shape)) {
+        const rule = shape[key];
+        const fieldValue = value[key];
+        if (fieldValue === undefined) {
+            if (rule.required)
+                return `${path}.${key} is required`;
+            continue;
+        }
+        const problem = rule.check(fieldValue);
+        if (problem)
+            return `${path}.${key} ${problem}`;
+    }
+    for (const key of Object.keys(value)) {
+        if (!Object.hasOwn(shape, key) && value[key] !== undefined)
+            return `${path}.${key} is not allowed`;
+    }
+    return undefined;
+}
+function findProblem(config) {
+    if (!isPlainObject(config))
+        return 'config must be an object';
+    if (config.local === undefined)
+        return 'local is required';
+    const localProblem = checkShape(config.local, localShape, 'local');
+    if (localProblem)
+        return localProblem;
+    if (config.targets === undefined)
+        return 'targets is required';
+    if (!isPlainObject(config.targets))
+        return 'targets must be an object';
+    for (const name of Object.keys(config.targets)) {
+        const targetProblem = checkShape(config.targets[name], targetShape, `targets.${name}`);
+        if (targetProblem)
+            return targetProblem;
+    }
+    return undefined;
+}
+export async function validateConfig(config) {
+    const problem = findProblem(config);
+    if (problem)
+        throw new Error("Config Schema Error: " + problem);
+    return config;
+}
+export const DefaultConfig = {
+    local: {
+        path: "public",
+        files: "**/**",
+        exclude: ["**/*.map", "**/.DS_Store", "**/.git*", "**/.env*"],
+        defaultTarget: "staging"
+    },
+    targets: {
+        staging: {
+            path: "Example/www/stage",
+            host: "www.example.com",
+            user: "USERNAME"
+        },
+        production: {
+            path: "Example/www",
+            host: "www.example.com",
+            user: "USERNAME",
+            prompt: "This will upload to PRODUCTION! Are you sure?"
+        }
+    }
+};
+//# sourceMappingURL=ConfigSchema.js.map

package/dist/lib/ConfigSchema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConfigSchema.js","sourceRoot":"./","sources":["lib/ConfigSchema.ts"],"names":[],"mappings":"AAuBA,MAAM,aAAa,GAAG,CAAC,KAAc,EAAuC,EAAE,CAC5E,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;AAEtE,MAAM,MAAM,GAAe,CAAC,KAAK,EAAE,EAAE;IACnC,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,kBAAkB,CAAA;IACxD,IAAI,KAAK,KAAK,EAAE;QAAE,OAAO,mBAAmB,CAAA;IAC5C,OAAO,SAAS,CAAA;AAClB,CAAC,CAAA;AAED,sEAAsE;AACtE,MAAM,OAAO,GAAe,CAAC,KAAK,EAAE,EAAE;IACpC,IAAI,OAAO,KAAK,KAAK,SAAS;QAAE,OAAO,SAAS,CAAA;IAChD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;QAAE,OAAO,SAAS,CAAA;IAClG,OAAO,mBAAmB,CAAA;AAC5B,CAAC,CAAA;AAED,4FAA4F;AAC5F,MAAM,MAAM,GAAe,CAAC,KAAK,EAAE,EAAE;IACnC,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,yBAAyB,CAAA;IACpG,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,MAAM,MAAM,GAAG,UAAU,CAAC,KAAK,CAAC,CAAA;QAChC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,QAAQ,CAAC,KAA0B,CAAC;YAAE,OAAO,SAAS,CAAA;IACrF,CAAC;IACD,OAAO,kBAAkB,CAAA;AAC3B,CAAC,CAAA;AAED,MAAM,WAAW,GAAe,CAAC,KAAK,EAAE,EAAE;IACxC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QAAE,OAAO,kBAAkB,CAAA;IACpD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACtC,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;QAChC,IAAI,OAAO;YAAE,OAAO,QAAQ,CAAC,IAAI,OAAO,EAAE,CAAA;IAC5C,CAAC;IACD,OAAO,SAAS,CAAA;AAClB,CAAC,CAAA;AAED,MAAM,eAAe,GAAe,CAAC,KAAK,EAAE,EAAE,CAC5C,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,yCAAyC,CAAC,CAAC,CAAC,SAAS,CAAA;AAE3F,sDAAsD;AACtD,MAAM,MAAM,GAAe,CAAC,KAAK,EAAE,EAAE,CACnC,CAAC,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,KAAK,IAAI,KAAK,KAAK,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,mCAAmC,CAAA;AAE/G,mDAAmD;AACnD,MAAM,aAAa,GAAe,CAAC,KAAK,EAAE,EAAE,CAC1C,OAAO,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,mBAAmB,CAAA;AAE9D,MAAM,UAAU,GAAU;IACxB,IAAI,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE;IACvC,KAAK,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE;IACxB,OAAO,EAAE,EAAE,KAAK,EAAE,WAAW,EAAE;IAC/B,aAAa,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE;IAChC,iBAAiB,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE;CACtC,CAAA;AAED,MAAM,WAAW,GAAU;IACzB,IAAI,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE;IACvC,IAAI,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE;IACvC,IAAI,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE;IACvC,IAAI,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE;IACvB,IAAI,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE;IACvB,KAAK,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE;IACxB,MAAM,EAAE,EAAE,KAAK,EAAE,eAAe,EAAE;IAClC,OAAO,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE;IAC3B,MAAM,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE;IACzB,kBAAkB,EAAE,EAAE,KAAK,EAAE,aAAa,EAAE;IAC5C,oBAAoB;IACpB,IAAI,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE;CACxB,CAAA;AAED,+FAA+F;AAC/F,SAAS,UAAU,CAAC,KAAc,EAAE,KAAY,EAAE,IAAY;IAC5D,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC;QAAE,OAAO,GAAG,IAAI,oBAAoB,CAAA;IAE7D,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QACrC,MAAM,IAAI,GAAG,KAAK,CAAC,GAAG,CAAC,CAAA;QACvB,MAAM,UAAU,GAAG,KAAK,CAAC,GAAG,CAAC,CAAA;QAC7B,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;YAC7B,IAAI,IAAI,CAAC,QAAQ;gBAAE,OAAO,GAAG,IAAI,IAAI,GAAG,cAAc,CAAA;YACtD,SAAQ;QACV,CAAC;QACD,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;QACtC,IAAI,OAAO;YAAE,OAAO,GAAG,IAAI,IAAI,GAAG,IAAI,OAAO,EAAE,CAAA;IACjD,CAAC;IAED,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QACrC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,KAAK,SAAS;YAAE,OAAO,GAAG,IAAI,IAAI,GAAG,iBAAiB,CAAA;IACpG,CAAC;IAED,OAAO,SAAS,CAAA;AAClB,CAAC;AAED,SAAS,WAAW,CAAC,MAAe;IAClC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC;QAAE,OAAO,0BAA0B,CAAA;IAE7D,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS;QAAE,OAAO,mBAAmB,CAAA;IAC1D,MAAM,YAAY,GAAG,UAAU,CAAC,MAAM,CAAC,KAAK,EAAE,UAAU,EAAE,OAAO,CAAC,CAAA;IAClE,IAAI,YAAY;QAAE,OAAO,YAAY,CAAA;IAErC,IAAI,MAAM,CAAC,OAAO,KAAK,SAAS;QAAE,OAAO,qBAAqB,CAAA;IAC9D,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,OAAO,CAAC;QAAE,OAAO,2BAA2B,CAAA;IACtE,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;QAC/C,MAAM,aAAa,GAAG,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,WAAW,EAAE,WAAW,IAAI,EAAE,CAAC,CAAA;QACtF,IAAI,aAAa;YAAE,OAAO,aAAa,CAAA;IACzC,CAAC;IAED,OAAO,SAAS,CAAA;AAClB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,MAAe;IAClD,MAAM,OAAO,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IACnC,IAAI,OAAO;QAAE,MAAM,IAAI,KAAK,CAAC,uBAAuB,GAAG,OAAO,CAAC,CAAA;IAC/D,OAAO,MAAM,CAAA;AACf,CAAC;AAED,MAAM,CAAC,MAAM,aAAa,GAAQ;IAChC,KAAK,EAAE;QACL,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,OAAO;QACd,OAAO,EAAE,CAAC,UAAU,EAAE,cAAc,EAAE,UAAU,EAAE,UAAU,CAAC;QAC7D,aAAa,EAAE,SAAS;KACzB;IACD,OAAO,EAAE;QACP,OAAO,EAAE;YACP,IAAI,EAAE,mBAAmB;YACzB,IAAI,EAAE,iBAAiB;YACvB,IAAI,EAAE,UAAU;SACjB;QACD,UAAU,EAAE;YACV,IAAI,EAAE,aAAa;YACnB,IAAI,EAAE,iBAAiB;YACvB,IAAI,EAAE,UAAU;YAChB,MAAM,EAAE,+CAA+C;SACxD;KACF;CACF,CAAA","sourcesContent":["import { IConfig } from './Config.js'\n\n/*\n * A hand-written validator for the config file. It accepts and rejects what the v1 joi schema did,\n * including where v1 joi and config.schema.json disagree (rework-1.md):\n *   - boolean fields also accept the strings \"true\" and \"false\" (in any case);\n *   - `port` also accepts a numeric string (parsed the way v1 joi did);\n *   - strings must not be empty;\n *   - unknown keys inside `local` and inside a target reject.\n * The FTPS fields added in v2 (`secure`, `rejectUnauthorized`) take JSON values only, as in\n * config.schema.json: no boolean strings.\n * Unknown top-level keys are allowed. The config is returned as given: nothing is converted.\n */\n\ntype FieldCheck = (value: unknown) => string | undefined\n\ninterface FieldRule {\n  check: FieldCheck\n  required?: boolean\n}\n\ntype Shape = { [key: string]: FieldRule }\n\nconst isPlainObject = (value: unknown): value is { [key: string]: unknown } =>\n  typeof value === 'object' && value !== null && !Array.isArray(value)\n\nconst string: FieldCheck = (value) => {\n  if (typeof value !== 'string') return 'must be a string'\n  if (value === '') return 'must not be empty'\n  return undefined\n}\n\n// v1 joi.bool(): a boolean, or the string \"true\"/\"false\" in any case.\nconst boolean: FieldCheck = (value) => {\n  if (typeof value === 'boolean') return undefined\n  if (typeof value === 'string' && ['true', 'false'].includes(value.toLowerCase())) return undefined\n  return 'must be a boolean'\n}\n\n// v1 joi.number(): a finite number, or a string that parseFloat reads and isFinite accepts.\nconst number: FieldCheck = (value) => {\n  if (typeof value === 'number') return Number.isFinite(value) ? undefined : 'must be a finite number'\n  if (typeof value === 'string') {\n    const parsed = parseFloat(value)\n    if (!Number.isNaN(parsed) && isFinite(value as unknown as number)) return undefined\n  }\n  return 'must be a number'\n}\n\nconst stringArray: FieldCheck = (value) => {\n  if (!Array.isArray(value)) return 'must be an array'\n  for (let i = 0; i < value.length; i++) {\n    const problem = string(value[i])\n    if (problem) return `item ${i} ${problem}`\n  }\n  return undefined\n}\n\nconst booleanOrString: FieldCheck = (value) =>\n  (boolean(value) && string(value)) ? 'must be a boolean or a non-empty string' : undefined\n\n// Target `secure`: exactly true, false or \"implicit\".\nconst secure: FieldCheck = (value) =>\n  (value === true || value === false || value === 'implicit') ? undefined : 'must be true, false or \"implicit\"'\n\n// A JSON boolean only (no \"true\"/\"false\" strings).\nconst strictBoolean: FieldCheck = (value) =>\n  typeof value === 'boolean' ? undefined : 'must be a boolean'\n\nconst localShape: Shape = {\n  path: { check: string, required: true },\n  files: { check: string },\n  exclude: { check: stringArray },\n  defaultTarget: { check: string },\n  deleteRemoteFiles: { check: boolean },\n}\n\nconst targetShape: Shape = {\n  host: { check: string, required: true },\n  user: { check: string, required: true },\n  path: { check: string, required: true },\n  pass: { check: string },\n  port: { check: number },\n  cache: { check: string },\n  prompt: { check: booleanOrString },\n  enabled: { check: boolean },\n  secure: { check: secure },\n  rejectUnauthorized: { check: strictBoolean },\n  // For future use...\n  type: { check: string },\n}\n\n// Returns the first problem with `value` against `shape`, as `<path> <problem>`, or undefined.\nfunction checkShape(value: unknown, shape: Shape, path: string): string | undefined {\n  if (!isPlainObject(value)) return `${path} must be an object`\n\n  for (const key of Object.keys(shape)) {\n    const rule = shape[key]\n    const fieldValue = value[key]\n    if (fieldValue === undefined) {\n      if (rule.required) return `${path}.${key} is required`\n      continue\n    }\n    const problem = rule.check(fieldValue)\n    if (problem) return `${path}.${key} ${problem}`\n  }\n\n  for (const key of Object.keys(value)) {\n    if (!Object.hasOwn(shape, key) && value[key] !== undefined) return `${path}.${key} is not allowed`\n  }\n\n  return undefined\n}\n\nfunction findProblem(config: unknown): string | undefined {\n  if (!isPlainObject(config)) return 'config must be an object'\n\n  if (config.local === undefined) return 'local is required'\n  const localProblem = checkShape(config.local, localShape, 'local')\n  if (localProblem) return localProblem\n\n  if (config.targets === undefined) return 'targets is required'\n  if (!isPlainObject(config.targets)) return 'targets must be an object'\n  for (const name of Object.keys(config.targets)) {\n    const targetProblem = checkShape(config.targets[name], targetShape, `targets.${name}`)\n    if (targetProblem) return targetProblem\n  }\n\n  return undefined\n}\n\nexport async function validateConfig(config: IConfig): Promise<IConfig> {\n  const problem = findProblem(config)\n  if (problem) throw new Error(\"Config Schema Error: \" + problem)\n  return config\n}\n\nexport const DefaultConfig: any = {\n  local: {\n    path: \"public\",\n    files: \"**/**\",\n    exclude: [\"**/*.map\", \"**/.DS_Store\", \"**/.git*\", \"**/.env*\"],\n    defaultTarget: \"staging\"\n  },\n  targets: {\n    staging: {\n      path: \"Example/www/stage\",\n      host: \"www.example.com\",\n      user: \"USERNAME\"\n    },\n    production: {\n      path: \"Example/www\",\n      host: \"www.example.com\",\n      user: \"USERNAME\",\n      prompt: \"This will upload to PRODUCTION! Are you sure?\"\n    }\n  }\n}\n"]}

package/dist/lib/Connection.d.ts

@@ -0,0 +1,41 @@
+import { ITargetConfig } from './Config.js';
+import { RemoteConnection } from './RemoteConnection.js';
+/** How to reach an FTP/FTPS server. */
+export interface ConnectionOptions {
+    host: string;
+    port: number;
+    user: string;
+    pass: string;
+    /** `false`: plain FTP. `true`: explicit FTPS (AUTH TLS). `"implicit"`: implicit FTPS. */
+    secure?: boolean | 'implicit';
+    /** `false` accepts self-signed or mismatched TLS certificates (with a warning). Default `true`. */
+    rejectUnauthorized?: boolean;
+    /** The target name, for messages. */
+    name?: string;
+}
+/**
+ * A `RemoteConnection` over FTP or FTPS, on `basic-ftp`. It logs in on the first operation and
+ * runs operations one at a time, in the order they were called. After creating directories it
+ * goes back to the login directory, so relative paths stay relative to it.
+ */
+export declare class Connection implements RemoteConnection {
+    private _options;
+    private _client;
+    private _connected;
+    private _queue;
+    private _closed;
+    constructor(options: ConnectionOptions);
+    private _run;
+    private _connect;
+    private _login;
+    getRemoteFile(filename: string): Promise<string>;
+    remoteDirectoryFound(pathname: string): Promise<boolean>;
+    remoteDirectoryExists(pathname: string): Promise<boolean>;
+    remoteFileExists(remotePath: string): Promise<boolean>;
+    putBuffer(buff: Buffer, remotePath: string): Promise<boolean>;
+    putContent(content: string, remotePath: string): Promise<boolean>;
+    putFile(filename: string, remotePath: string): Promise<string>;
+    deleteRemoteFile(remotePath: string): Promise<boolean>;
+    close(): Promise<void>;
+    static create(target: ITargetConfig): Connection;
+}

package/dist/lib/Connection.js

@@ -0,0 +1,176 @@
+import { Readable, Writable } from 'node:stream';
+import { Client as FtpClient } from 'basic-ftp';
+import * as Log from './Log.js';
+import { resolvePassword } from './Config.js';
+import { readLocalFile } from './Filelist.js';
+// Node TLS error codes meaning the server's certificate was not trusted.
+const UNTRUSTED_CERT_CODES = new Set([
+    'DEPTH_ZERO_SELF_SIGNED_CERT',
+    'SELF_SIGNED_CERT_IN_CHAIN',
+    'UNABLE_TO_VERIFY_LEAF_SIGNATURE',
+    'UNABLE_TO_GET_ISSUER_CERT',
+    'UNABLE_TO_GET_ISSUER_CERT_LOCALLY',
+    'CERT_HAS_EXPIRED',
+    'CERT_NOT_YET_VALID',
+    'CERT_UNTRUSTED',
+    'CERT_REJECTED',
+    'CERT_SIGNATURE_FAILURE',
+    'ERR_TLS_CERT_ALTNAME_INVALID',
+]);
+/**
+ * A `RemoteConnection` over FTP or FTPS, on `basic-ftp`. It logs in on the first operation and
+ * runs operations one at a time, in the order they were called. After creating directories it
+ * goes back to the login directory, so relative paths stay relative to it.
+ */
+export class Connection {
+    constructor(options) {
+        this._queue = Promise.resolve();
+        this._closed = false;
+        this._options = options;
+        this._client = new FtpClient();
+    }
+    // Runs `task` after every operation queued before it, so the client is never used concurrently.
+    _run(task) {
+        if (this._closed)
+            return Promise.reject(new Error("Connection is closed."));
+        const result = this._queue.then(async () => task(await this._connect()));
+        this._queue = result.catch(() => undefined);
+        return result;
+    }
+    // Connects and logs in once; resolves the login directory.
+    _connect() {
+        if (!this._connected)
+            this._connected = this._login();
+        return this._connected;
+    }
+    async _login() {
+        const { host, port, user, pass, name } = this._options;
+        const secure = this._options.secure ?? false;
+        const rejectUnauthorized = this._options.rejectUnauthorized !== false;
+        if (secure && !rejectUnauthorized) {
+            Log.urgent(`Warning: TLS certificate checks are off for target "${name ?? host}" (rejectUnauthorized: false). The certificate of ${host} is not verified.`);
+        }
+        try {
+            await this._client.access({ host, port, user, password: pass, secure, secureOptions: { rejectUnauthorized } });
+        }
+        catch (err) {
+            throw describeConnectError(err, this._options);
+        }
+        return this._client.pwd();
+    }
+    getRemoteFile(filename) {
+        return this._run(async () => {
+            Log.log(" <-", filename);
+            const chunks = [];
+            const sink = new Writable({
+                write(chunk, _encoding, callback) {
+                    chunks.push(chunk);
+                    callback();
+                },
+            });
+            await this._client.downloadTo(sink, filename);
+            return Buffer.concat(chunks).toString();
+        });
+    }
+    // Changes into the directory and back to the login directory: creates nothing.
+    remoteDirectoryFound(pathname) {
+        return this._run(async (startDir) => {
+            try {
+                await this._client.cd(pathname);
+                return true;
+            }
+            catch {
+                return false;
+            }
+            finally {
+                await this._client.cd(startDir);
+            }
+        });
+    }
+    // As in v1, this creates the directory and any missing parents (mkdir -p), and resolves
+    // whether that worked.
+    remoteDirectoryExists(pathname) {
+        return this._run(async (startDir) => {
+            try {
+                await this._client.ensureDir(pathname);
+                return true;
+            }
+            catch {
+                return false;
+            }
+            finally {
+                await this._client.cd(startDir);
+            }
+        });
+    }
+    remoteFileExists(remotePath) {
+        return this._run(async () => {
+            try {
+                await this._client.size(remotePath);
+                return true;
+            }
+            catch {
+                return false;
+            }
+        });
+    }
+    putBuffer(buff, remotePath) {
+        return this._run(async () => {
+            Log.log(" ->", remotePath);
+            await this._client.uploadFrom(Readable.from([buff]), remotePath);
+            return true;
+        });
+    }
+    putContent(content, remotePath) {
+        return this.putBuffer(Buffer.from(content), remotePath);
+    }
+    async putFile(filename, remotePath) {
+        const buffer = await readLocalFile(filename, true);
+        await this.putBuffer(buffer, remotePath);
+        return remotePath;
+    }
+    deleteRemoteFile(remotePath) {
+        return this._run(async () => {
+            Log.log("  x", remotePath);
+            try {
+                await this._client.remove(remotePath);
+                return true;
+            }
+            catch (err) {
+                Log.log("Error removing", remotePath, err.message);
+                return false;
+            }
+        });
+    }
+    // Waits for queued operations, then closes the control and data sockets. Safe to call twice.
+    async close() {
+        if (this._closed)
+            return;
+        this._closed = true;
+        await this._queue;
+        this._client.close();
+    }
+    static create(target) {
+        const pass = resolvePassword(target);
+        return new Connection({
+            host: target.host,
+            port: target.port,
+            user: target.user,
+            pass,
+            secure: target.secure,
+            rejectUnauthorized: target.rejectUnauthorized,
+            name: target._name,
+        });
+    }
+}
+// An untrusted certificate becomes an error that names the host and the opt-out; anything
+// else is returned as is.
+function describeConnectError(err, options) {
+    const code = err?.code;
+    if (typeof code !== 'string' || !UNTRUSTED_CERT_CODES.has(code))
+        return err;
+    const target = options.name ? ` on target "${options.name}"` : '';
+    return new Error(`The TLS certificate of ${options.host} was not trusted (${err.message}). ` +
+        `If you trust this server, set "rejectUnauthorized": false${target} to accept its certificate.`, { cause: err });
+}
+//# sourceMappingURL=Connection.js.map