@appium/docutils 0.2.1 → 0.2.2

package/build/lib/nav.d.ts

@@ -1,47 +0,0 @@
-/**
- * Handles updating/adding the `nav` property of `mkdocs.yml`, based on the output of `typedoc`;
- * specifically, the command documentation generated by `@appium/typedoc-plugin-appium`.
- *
- * @module
- */
-/**
- * Update the `nav` property of `mkdocs.yml` with a list of "command" files generated by TypeDoc via `@appium/typedoc-plugin-appium`
- * @param opts - Options
- * @todo implement `dryRun` option
- */
-export declare function updateNav<S extends string>({ cwd, mkdocsYml: mkDocsYmlPath, referenceHeader, noReferenceHeader, typedocJson: typeDocJsonPath, dryRun, }?: UpdateNavOpts<S>): Promise<void>;
-/**
- * Options for {@linkcode updateNav}
- */
-export interface UpdateNavOpts<S extends string> {
-    /**
-     * Current working directory
-     */
-    cwd?: string;
-    /**
-     * Path to `mkdocs.yml`
-     */
-    mkdocsYml?: string;
-    /**
-     * Path to `package.json`
-     */
-    packageJson?: string;
-    /**
-     * The name of the header in `nav` to use for reference docs.
-     */
-    referenceHeader?: S;
-    /**
-     * If `true`, do not add a reference header to `nav` if one does not exist
-     */
-    noReferenceHeader?: boolean;
-    /**
-     * Path to `typedoc.json`
-     */
-    typedocJson?: string;
-    /**
-     * If `true`, do not write any files
-     * @remarks Not yet implemented
-     */
-    dryRun?: boolean;
-}
-//# sourceMappingURL=nav.d.ts.map

package/build/lib/nav.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"nav.d.ts","sourceRoot":"","sources":["../../lib/nav.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AA4BH;;;;GAIG;AACH,wBAAsB,SAAS,CAAC,CAAC,SAAS,MAAM,EAAE,EAChD,GAAmB,EACnB,SAAS,EAAE,aAAa,EACxB,eAA6C,EAC7C,iBAAyB,EACzB,WAAW,EAAE,eAAe,EAC5B,MAAc,GACf,GAAE,aAAa,CAAC,CAAC,CAAM,iBA2HvB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC,SAAS,MAAM;IAC7C;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,eAAe,CAAC,EAAE,CAAC,CAAC;IACpB;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB"}

package/build/lib/nav.js

@@ -1,132 +0,0 @@
-"use strict";
-/**
- * Handles updating/adding the `nav` property of `mkdocs.yml`, based on the output of `typedoc`;
- * specifically, the command documentation generated by `@appium/typedoc-plugin-appium`.
- *
- * @module
- */
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.updateNav = void 0;
-const support_1 = require("@appium/support");
-const lodash_1 = __importDefault(require("lodash"));
-const node_path_1 = __importDefault(require("node:path"));
-const constants_1 = require("./constants");
-const error_1 = require("./error");
-const fs_1 = require("./fs");
-const logger_1 = __importDefault(require("./logger"));
-const util_1 = require("./util");
-const DEFAULT_REFERENCE_HEADER = 'Reference';
-const log = logger_1.default.withTag('mkdocs-nav');
-/**
- * Update the `nav` property of `mkdocs.yml` with a list of "command" files generated by TypeDoc via `@appium/typedoc-plugin-appium`
- * @param opts - Options
- * @todo implement `dryRun` option
- */
-async function updateNav({ cwd = process.cwd(), mkdocsYml: mkDocsYmlPath, referenceHeader = DEFAULT_REFERENCE_HEADER, noReferenceHeader = false, typedocJson: typeDocJsonPath, dryRun = false, } = {}) {
-    [mkDocsYmlPath, typeDocJsonPath] = await Promise.all([
-        mkDocsYmlPath ?? (0, fs_1.findMkDocsYml)(cwd),
-        typeDocJsonPath ?? (0, fs_1.findTypeDocJsonPath)(cwd),
-    ]);
-    if (!mkDocsYmlPath) {
-        throw new error_1.DocutilsError(`Could not find ${constants_1.NAME_MKDOCS_YML} from ${cwd};  run "${constants_1.NAME_BIN} init" to create it`);
-    }
-    if (!typeDocJsonPath) {
-        throw new error_1.DocutilsError(`Could not find ${constants_1.NAME_TYPEDOC_JSON} from ${cwd};  run "${constants_1.NAME_BIN} init" to create it`);
-    }
-    const relativePath = (0, util_1.relative)(cwd);
-    const relMkDocsYmlPath = relativePath(mkDocsYmlPath);
-    const typeDocJson = (0, fs_1.readTypedocJson)(typeDocJsonPath);
-    const mkDocsYml = (await (0, fs_1.readYaml)(mkDocsYmlPath));
-    const findRefDictIndex = lodash_1.default.partial(lodash_1.default.findIndex, lodash_1.default, lodash_1.default.overEvery([lodash_1.default.isObject, lodash_1.default.partial(lodash_1.default.has, lodash_1.default, referenceHeader)]));
-    /**
-     * Absolute path to `typedoc.json`
-     */
-    const absTypeDocJsonPath = node_path_1.default.isAbsolute(typeDocJsonPath)
-        ? typeDocJsonPath
-        : node_path_1.default.resolve(cwd, typeDocJsonPath);
-    /**
-     * Absolute path to TypeDoc's output directory (`out`)
-     */
-    const typeDocOutDir = node_path_1.default.resolve(node_path_1.default.dirname(absTypeDocJsonPath), typeDocJson.out ? typeDocJson.out : constants_1.DEFAULT_REL_TYPEDOC_OUT_PATH);
-    /**
-     * Absolute path to `mkdocs.yml`
-     */
-    const absMkdocsYmlPath = node_path_1.default.isAbsolute(mkDocsYmlPath)
-        ? mkDocsYmlPath
-        : node_path_1.default.resolve(cwd, mkDocsYmlPath);
-    const { docs_dir: docsDir, nav = [] } = mkDocsYml;
-    /**
-     * Absolute path to the directory containing MkDocs input docs
-     */
-    const mkDocsDocsDir = node_path_1.default.resolve(node_path_1.default.dirname(absMkdocsYmlPath), docsDir ?? 'docs');
-    /**
-     * The dir we need to prepend to all entries within `nav`
-     */
-    const relReferenceDir = node_path_1.default.relative(mkDocsDocsDir, typeDocOutDir);
-    const partitionRefArray = lodash_1.default.partialRight(lodash_1.default.partition, lodash_1.default.partialRight(lodash_1.default.startsWith, `${relReferenceDir}/`));
-    const newRefFilepaths = [];
-    // TODO: this doesn't respect the 'commandsDir' option for typedoc-plugin-appium.  in fact,
-    // typeDocJson does not even include it, because it's unknown.  I suppose that will mean we need
-    // to load plugins, but that means bootstrapping TypeDoc entirely just to read a `typedoc.json`
-    // file, which is slow.
-    const commandDir = node_path_1.default.join(typeDocOutDir, 'commands');
-    const relCommandDir = node_path_1.default.relative(mkDocsDocsDir, commandDir);
-    const commandDocFileEnts = await support_1.fs.readdir(commandDir, { withFileTypes: true });
-    if (!commandDocFileEnts.length) {
-        log.warn('No reference API docs were found in %s; skipping navigation update', commandDir);
-        return;
-    }
-    for (const ent of commandDocFileEnts) {
-        if (ent.isFile() && ent.name.endsWith('.md')) {
-            newRefFilepaths.push(node_path_1.default.join(relCommandDir, ent.name));
-        }
-    }
-    log.debug('New reference filepaths: %O', newRefFilepaths);
-    const navUsesHeaders = noReferenceHeader || !(0, util_1.isStringArray)(nav);
-    let shouldWriteMkDocsYml = false;
-    let refFilepaths;
-    let nonRefFilepaths;
-    const refDictIdx = findRefDictIndex(nav);
-    if (refDictIdx >= 0) {
-        const refDict = nav[refDictIdx];
-        const refArray = refDict[referenceHeader];
-        [refFilepaths, nonRefFilepaths] = partitionRefArray(refArray);
-    }
-    else {
-        [refFilepaths, nonRefFilepaths] = partitionRefArray(nav);
-    }
-    const symmetricDiff = lodash_1.default.xor(newRefFilepaths, refFilepaths);
-    if (symmetricDiff.length) {
-        log.debug('Difference in old nav vs new: %O', symmetricDiff);
-        shouldWriteMkDocsYml = true;
-        if (navUsesHeaders) {
-            if (refDictIdx >= 0) {
-                const res = [...nonRefFilepaths, ...newRefFilepaths];
-                mkDocsYml.nav[refDictIdx][referenceHeader] = res;
-                log.debug('Replaced "%s" section with %O', referenceHeader, res);
-            }
-            else {
-                mkDocsYml.nav = [...nonRefFilepaths, { [referenceHeader]: newRefFilepaths }];
-                log.debug('Added "%s" section with %O', referenceHeader, newRefFilepaths);
-            }
-        }
-        else {
-            mkDocsYml.nav = [...nonRefFilepaths, ...newRefFilepaths];
-            log.debug('Replaced nav with %O', mkDocsYml.nav);
-        }
-    }
-    if (shouldWriteMkDocsYml) {
-        const yaml = (0, fs_1.stringifyYaml)(mkDocsYml);
-        log.debug(yaml);
-        await (0, fs_1.safeWriteFile)(mkDocsYmlPath, yaml, true);
-        log.success('Updated navigation for reference documents in %s', relMkDocsYmlPath);
-    }
-    else {
-        log.info('No changes to navigation for reference documents in %s', relMkDocsYmlPath);
-    }
-}
-exports.updateNav = updateNav;
-//# sourceMappingURL=nav.js.map

package/build/lib/nav.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"nav.js","sourceRoot":"","sources":["../../lib/nav.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;;;AAEH,6CAAmC;AACnC,oDAAuB;AACvB,0DAA6B;AAC7B,2CAKqB;AACrB,mCAAsC;AACtC,6BAOc;AACd,sDAA8B;AAE9B,iCAA+C;AAE/C,MAAM,wBAAwB,GAAG,WAAW,CAAC;AAE7C,MAAM,GAAG,GAAG,gBAAM,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;AAEzC;;;;GAIG;AACI,KAAK,UAAU,SAAS,CAAmB,EAChD,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,EACnB,SAAS,EAAE,aAAa,EACxB,eAAe,GAAM,wBAAwB,EAC7C,iBAAiB,GAAG,KAAK,EACzB,WAAW,EAAE,eAAe,EAC5B,MAAM,GAAG,KAAK,MACM,EAAE;IACtB,CAAC,aAAa,EAAE,eAAe,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;QACnD,aAAa,IAAI,IAAA,kBAAa,EAAC,GAAG,CAAC;QACnC,eAAe,IAAI,IAAA,wBAAmB,EAAC,GAAG,CAAC;KAC5C,CAAC,CAAC;IACH,IAAI,CAAC,aAAa,EAAE;QAClB,MAAM,IAAI,qBAAa,CACrB,kBAAkB,2BAAe,SAAS,GAAG,WAAW,oBAAQ,qBAAqB,CACtF,CAAC;KACH;IACD,IAAI,CAAC,eAAe,EAAE;QACpB,MAAM,IAAI,qBAAa,CACrB,kBAAkB,6BAAiB,SAAS,GAAG,WAAW,oBAAQ,qBAAqB,CACxF,CAAC;KACH;IACD,MAAM,YAAY,GAAG,IAAA,eAAQ,EAAC,GAAG,CAAC,CAAC;IACnC,MAAM,gBAAgB,GAAG,YAAY,CAAC,aAAa,CAAC,CAAC;IACrD,MAAM,WAAW,GAAG,IAAA,oBAAe,EAAC,eAAe,CAAC,CAAC;IACrD,MAAM,SAAS,GAAG,CAAC,MAAM,IAAA,aAAQ,EAAC,aAAa,CAAC,CAAc,CAAC;IAC/D,MAAM,gBAAgB,GAAsC,gBAAC,CAAC,OAAO,CACnE,gBAAC,CAAC,SAAS,EACX,gBAAC,EACD,gBAAC,CAAC,SAAS,CAAC,CAAC,gBAAC,CAAC,QAAQ,EAAE,gBAAC,CAAC,OAAO,CAAC,gBAAC,CAAC,GAAG,EAAE,gBAAC,EAAE,eAAe,CAAC,CAAC,CAAC,CAChE,CAAC;IAEF;;OAEG;IACH,MAAM,kBAAkB,GAAG,mBAAI,CAAC,UAAU,CAAC,eAAe,CAAC;QACzD,CAAC,CAAC,eAAe;QACjB,CAAC,CAAC,mBAAI,CAAC,OAAO,CAAC,GAAG,EAAE,eAAe,CAAC,CAAC;IAEvC;;OAEG;IACH,MAAM,aAAa,GAAG,mBAAI,CAAC,OAAO,CAChC,mBAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAChC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,wCAA4B,CACjE,CAAC;IAEF;;OAEG;IACH,MAAM,gBAAgB,GAAG,mBAAI,CAAC,UAAU,CAAC,aAAa,CAAC;QACrD,CAAC,CAAC,aAAa;QACf,CAAC,CAAC,mBAAI,CAAC,OAAO,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;IAErC,MAAM,EAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,GAAG,EAAE,EAAC,GAAG,SAAS,CAAC;IAChD;;OAEG;IACH,MAAM,aAAa,GAAG,mBAAI,CAAC,OAAO,CAAC,mBAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAE,OAAO,IAAI,MAAM,CAAC,CAAC;IAEtF;;OAEG;IACH,MAAM,eAAe,GAAG,mBAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,aAAa,CAAC,CAAC;IAEpE,MAAM,iBAAiB,GACrB,gBAAC,CAAC,YAAY,CAAC,gBAAC,CAAC,SAAS,EAAE,gBAAC,CAAC,YAAY,CAAC,gBAAC,CAAC,UAAU,EAAE,GAAG,eAAe,GAAG,CAAC,CAAC,CAAC;IAEnF,MAAM,eAAe,GAAa,EAAE,CAAC;IAErC,2FAA2F;IAC3F,gGAAgG;IAChG,+FAA+F;IAC/F,uBAAuB;IACvB,MAAM,UAAU,GAAG,mBAAI,CAAC,IAAI,CAAC,aAAa,EAAE,UAAU,CAAC,CAAC;IACxD,MAAM,aAAa,GAAG,mBAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,UAAU,CAAC,CAAC;IAC/D,MAAM,kBAAkB,GAAG,MAAM,YAAE,CAAC,OAAO,CAAC,UAAU,EAAE,EAAC,aAAa,EAAE,IAAI,EAAC,CAAC,CAAC;IAC/E,IAAI,CAAC,kBAAkB,CAAC,MAAM,EAAE;QAC9B,GAAG,CAAC,IAAI,CAAC,oEAAoE,EAAE,UAAU,CAAC,CAAC;QAC3F,OAAO;KACR;IACD,KAAK,MAAM,GAAG,IAAI,kBAAkB,EAAE;QACpC,IAAI,GAAG,CAAC,MAAM,EAAE,IAAI,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;YAC5C,eAAe,CAAC,IAAI,CAAC,mBAAI,CAAC,IAAI,CAAC,aAAa,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;SAC1D;KACF;IAED,GAAG,CAAC,KAAK,CAAC,6BAA6B,EAAE,eAAe,CAAC,CAAC;IAE1D,MAAM,cAAc,GAAG,iBAAiB,IAAI,CAAC,IAAA,oBAAa,EAAC,GAAG,CAAC,CAAC;IAChE,IAAI,oBAAoB,GAAG,KAAK,CAAC;IACjC,IAAI,YAAsB,CAAC;IAC3B,IAAI,eAAyB,CAAC;IAE9B,MAAM,UAAU,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC;IACzC,IAAI,UAAU,IAAI,CAAC,EAAE;QACnB,MAAM,OAAO,GAAG,GAAG,CAAC,UAAU,CAAwB,CAAC;QACvD,MAAM,QAAQ,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;QAC1C,CAAC,YAAY,EAAE,eAAe,CAAC,GAAG,iBAAiB,CAAC,QAAQ,CAAC,CAAC;KAC/D;SAAM;QACL,CAAC,YAAY,EAAE,eAAe,CAAC,GAAG,iBAAiB,CAAW,GAAG,CAAC,CAAC;KACpE;IAED,MAAM,aAAa,GAAG,gBAAC,CAAC,GAAG,CAAC,eAAe,EAAE,YAAY,CAAC,CAAC;IAC3D,IAAI,aAAa,CAAC,MAAM,EAAE;QACxB,GAAG,CAAC,KAAK,CAAC,kCAAkC,EAAE,aAAa,CAAC,CAAC;QAC7D,oBAAoB,GAAG,IAAI,CAAC;QAC5B,IAAI,cAAc,EAAE;YAClB,IAAI,UAAU,IAAI,CAAC,EAAE;gBACnB,MAAM,GAAG,GAAG,CAAC,GAAG,eAAe,EAAE,GAAG,eAAe,CAAC,CAAC;gBACpD,SAAS,CAAC,GAAI,CAAC,UAAU,CAAyB,CAAC,eAAe,CAAC,GAAG,GAAG,CAAC;gBAC3E,GAAG,CAAC,KAAK,CAAC,+BAA+B,EAAE,eAAe,EAAE,GAAG,CAAC,CAAC;aAClE;iBAAM;gBACL,SAAS,CAAC,GAAG,GAAG,CAAC,GAAG,eAAe,EAAE,EAAC,CAAC,eAAe,CAAC,EAAE,eAAe,EAAC,CAAC,CAAC;gBAC3E,GAAG,CAAC,KAAK,CAAC,4BAA4B,EAAE,eAAe,EAAE,eAAe,CAAC,CAAC;aAC3E;SACF;aAAM;YACL,SAAS,CAAC,GAAG,GAAG,CAAC,GAAG,eAAe,EAAE,GAAG,eAAe,CAAC,CAAC;YACzD,GAAG,CAAC,KAAK,CAAC,sBAAsB,EAAE,SAAS,CAAC,GAAG,CAAC,CAAC;SAClD;KACF;IAED,IAAI,oBAAoB,EAAE;QACxB,MAAM,IAAI,GAAG,IAAA,kBAAa,EAAC,SAAS,CAAC,CAAC;QACtC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAChB,MAAM,IAAA,kBAAa,EAAC,aAAa,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;QAC/C,GAAG,CAAC,OAAO,CAAC,kDAAkD,EAAE,gBAAgB,CAAC,CAAC;KACnF;SAAM;QACL,GAAG,CAAC,IAAI,CAAC,wDAAwD,EAAE,gBAAgB,CAAC,CAAC;KACtF;AACH,CAAC;AAlID,8BAkIC"}

package/build/lib/test.d.ts

@@ -1,9 +0,0 @@
-declare namespace Mike {
-    interface MikeOpts {
-        remote?: string;
-        prefix?: string;
-        branch?: string;
-        configFile: string;
-    }
-}
-//# sourceMappingURL=test.d.ts.map

package/build/lib/test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"test.d.ts","sourceRoot":"","sources":["../../lib/test.ts"],"names":[],"mappings":"AAAA,kBAAU,IAAI,CAAC;IACb,UAAiB,QAAQ;QACvB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,UAAU,EAAE,MAAM,CAAC;KACpB;CACF"}

package/build/lib/test.js

@@ -1,2 +0,0 @@
-"use strict";
-//# sourceMappingURL=test.js.map

package/build/lib/test.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"test.js","sourceRoot":"","sources":["../../lib/test.ts"],"names":[],"mappings":""}

package/build/lib/typedoc.d.ts

@@ -1,55 +0,0 @@
-/**
- * Runs TypeDoc
- *
- * @module
- */
-/**
- * Executes TypeDoc _in the current process_
- *
- * Monkeypatches TypeDoc's homebrew "glob" implementation because it is broken
- * @param pkgRoot - Package root path
- * @param opts - TypeDoc options
- */
-export declare function runTypedoc(pkgRoot: string, opts: Record<string, string>): Promise<void>;
-/**
- * Options for {@linkcode buildReference}
- */
-export interface BuildReferenceOptions {
-    /**
-     * Path to `typedoc.json`
-     */
-    typedocJson?: string;
-    /**
-     * Current working directory
-     */
-    cwd?: string;
-    /**
-     * Path to `package.json`
-     */
-    packageJson?: string;
-    /**
-     * Path to `tsconfig.json`
-     */
-    tsconfigJson?: string;
-    /**
-     * "Title" for generated docs; this corresponds to {@linkcode typedoc.TypeDocOptionMap.name}
-     */
-    title?: string;
-    /**
-     * This is here because we pass it thru to TypeDoc
-     */
-    logLevel?: LogLevelName;
-}
-/**
- * Log level names as supported by this package
- *
- * Used to convert our log level to TypeDoc's
- */
-declare type LogLevelName = 'debug' | 'info' | 'error' | 'warn';
-/**
- * Build reference documentation via TypeDoc
- * @param opts - Options
- */
-export declare function buildReference({ typedocJson: typeDocJsonPath, cwd, tsconfigJson: tsconfig, logLevel, title, }?: BuildReferenceOptions): Promise<void>;
-export {};
-//# sourceMappingURL=typedoc.d.ts.map

package/build/lib/typedoc.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"typedoc.d.ts","sourceRoot":"","sources":["../../lib/typedoc.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AA+CH;;;;;;GAMG;AACH,wBAAsB,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,iBAkB7E;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,QAAQ,CAAC,EAAE,YAAY,CAAC;CACzB;AAED;;;;GAIG;AACH,aAAK,YAAY,GAAG,OAAO,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC;AAexD;;;GAGG;AACH,wBAAsB,cAAc,CAAC,EACnC,WAAW,EAAE,eAAe,EAC5B,GAAmB,EACnB,YAAY,EAAE,QAAQ,EACtB,QAA4B,EAC5B,KAAK,GACN,GAAE,qBAA0B,iBAwD5B"}

package/build/lib/typedoc.js

@@ -1,122 +0,0 @@
-"use strict";
-/**
- * Runs TypeDoc
- *
- * @module
- */
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.buildReference = exports.runTypedoc = void 0;
-const support_1 = require("@appium/support");
-const glob_1 = __importDefault(require("glob"));
-const lodash_1 = __importDefault(require("lodash"));
-const node_path_1 = __importDefault(require("node:path"));
-const typedoc_1 = require("typedoc");
-const constants_1 = require("./constants");
-const error_1 = require("./error");
-const fs_1 = require("./fs");
-const logger_1 = __importDefault(require("./logger"));
-const util_1 = require("./util");
-const log = logger_1.default.withTag('typedoc');
-/**
- * Replaces TypeDoc's homebrew "glob" implementation with a real one
- *
- * This cannot be done via `require('typedoc')` or `import` due to the file being excluded
- * from the export map in its `package.json`.
- * @see https://github.com/TypeStrong/typedoc/issues/2151
- */
-const monkeyPatchGlob = lodash_1.default.once((pkgRoot) => {
-    const tdFs = require(node_path_1.default.join(pkgRoot, 'node_modules', 'typedoc', 'dist', 'lib', 'utils', 'fs.js'));
-    tdFs.glob = glob_1.default.sync;
-});
-/**
- * Converts an object of string values to an array of arguments for CLI
- */
-const argify = lodash_1.default.flow(lodash_1.default.entries, lodash_1.default.flatten, (list) => list.map((v, idx) => (idx % 2 === 0 ? `--${v}` : v)));
-/**
- * Executes TypeDoc _in the current process_
- *
- * Monkeypatches TypeDoc's homebrew "glob" implementation because it is broken
- * @param pkgRoot - Package root path
- * @param opts - TypeDoc options
- */
-async function runTypedoc(pkgRoot, opts) {
-    monkeyPatchGlob(pkgRoot);
-    log.debug('Monkeypatched TypeDoc');
-    const args = argify(opts);
-    log.debug('TypeDoc args:', args);
-    const app = new typedoc_1.Application();
-    app.options.addReader(new typedoc_1.TypeDocReader());
-    app.options.addReader(new typedoc_1.ArgumentsReader(100, args));
-    app.bootstrap();
-    log.debug('Frozen options as computed by TypeDoc: %O', app.options.getRawValues());
-    const out = app.options.getValue('out');
-    const project = app.convert();
-    if (project) {
-        return await app.generateDocs(project, out);
-    }
-    throw new error_1.DocutilsError('TypeDoc found nothing to document. Is your package empty?');
-}
-exports.runTypedoc = runTypedoc;
-/**
- * Mapping of whatever our log level is to whatever TypeDoc's should be.
- *
- * TypeDoc's "info" is too verbose for our needs, and it's our default, so
- * we map it to "warn".
- */
-const TypeDocLogLevelMap = {
-    debug: 'Verbose',
-    info: 'Warn',
-    warn: 'Warn',
-    error: 'Error',
-};
-/**
- * Build reference documentation via TypeDoc
- * @param opts - Options
- */
-async function buildReference({ typedocJson: typeDocJsonPath, cwd = process.cwd(), tsconfigJson: tsconfig, logLevel = constants_1.DEFAULT_LOG_LEVEL, title, } = {}) {
-    const stop = (0, util_1.stopwatch)('buildReference');
-    typeDocJsonPath = typeDocJsonPath ?? (await (0, fs_1.findTypeDocJsonPath)(cwd));
-    if (!typeDocJsonPath) {
-        throw new error_1.DocutilsError(`Could not find ${constants_1.NAME_TYPEDOC_JSON} from ${cwd}; run "${constants_1.NAME_BIN}" to create it`);
-    }
-    const pkgRoot = support_1.fs.findRoot(cwd);
-    const relativePath = (0, util_1.relative)(cwd);
-    const relativeTypeDocJsonPath = relativePath(typeDocJsonPath);
-    log.debug(`Using ${relativeTypeDocJsonPath} as typedoc.json`);
-    let typeDocJson;
-    // we only need typedoc.json to make sure we have a custom "out" path.
-    try {
-        typeDocJson = (0, fs_1.readTypedocJson)(typeDocJsonPath);
-        log.debug('Contents of %s: %O', relativeTypeDocJsonPath, typeDocJson);
-    }
-    catch (err) {
-        log.error(err);
-        throw new error_1.DocutilsError(`Could not read ${relativeTypeDocJsonPath}; run "${constants_1.NAME_BIN} init" to create it`);
-    }
-    // if for some reason "out" is not in typedoc.json, we want to use our default path.
-    // otherwise, typedoc's default behavior is to write to the "docs" dir, which is the same dir that
-    // we use (by default) as a source dir for the mkdocs site--which might contain files under vcs.
-    let out;
-    if (!typeDocJson.out) {
-        out = node_path_1.default.relative(node_path_1.default.dirname(typeDocJsonPath), node_path_1.default.join(pkgRoot, constants_1.DEFAULT_REL_TYPEDOC_OUT_PATH));
-        log.debug('Overriding "out" option with %s', out);
-    }
-    else {
-        out = typeDocJson.out;
-        log.debug(`Found "out" option in ${constants_1.NAME_TYPEDOC_JSON}: ${out}`);
-    }
-    const extraTypedocOpts = lodash_1.default.pickBy({ tsconfig, name: title, out, logLevel: TypeDocLogLevelMap[logLevel] }, Boolean);
-    log.debug('Extra typedoc opts: %O', extraTypedocOpts);
-    try {
-        await runTypedoc(pkgRoot, extraTypedocOpts);
-        log.success('Reference docs built at %s (%dms)', node_path_1.default.isAbsolute(out) ? relativePath(out) : out, stop());
-    }
-    catch (err) {
-        log.error(err);
-    }
-}
-exports.buildReference = buildReference;
-//# sourceMappingURL=typedoc.js.map

package/build/lib/typedoc.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"typedoc.js","sourceRoot":"","sources":["../../lib/typedoc.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;;;;AAEH,6CAAmC;AACnC,gDAAwB;AACxB,oDAAuB;AACvB,0DAA6B;AAC7B,qCAAoF;AACpF,2CAKqB;AACrB,mCAAsC;AACtC,6BAA0D;AAC1D,sDAA8B;AAC9B,iCAA2C;AAE3C,MAAM,GAAG,GAAG,gBAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;AAEtC;;;;;;GAMG;AACH,MAAM,eAAe,GAAG,gBAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE;IACzC,MAAM,IAAI,GAAG,OAAO,CAAC,mBAAI,CAAC,IAAI,CAC5B,OAAO,EACP,cAAc,EACd,SAAS,EACT,MAAM,EACN,KAAK,EACL,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACH,IAAI,CAAC,IAAI,GAAG,cAAI,CAAC,IAAI,CAAC;AACxB,CAAC,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,MAAM,GAA8C,gBAAC,CAAC,IAAI,CAAC,gBAAC,CAAC,OAAO,EAAE,gBAAC,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,EAAE,CAC9F,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CACrD,CAAC;AAEF;;;;;;GAMG;AACI,KAAK,UAAU,UAAU,CAAC,OAAe,EAAE,IAA4B;IAC5E,eAAe,CAAC,OAAO,CAAC,CAAC;IACzB,GAAG,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAC;IAEnC,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;IAC1B,GAAG,CAAC,KAAK,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;IACjC,MAAM,GAAG,GAAG,IAAI,qBAAW,EAAE,CAAC;IAC9B,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,uBAAa,EAAE,CAAC,CAAC;IAC3C,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,yBAAe,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC;IACtD,GAAG,CAAC,SAAS,EAAE,CAAC;IAChB,GAAG,CAAC,KAAK,CAAC,2CAA2C,EAAE,GAAG,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC;IACnF,MAAM,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACxC,MAAM,OAAO,GAAG,GAAG,CAAC,OAAO,EAAE,CAAC;IAC9B,IAAI,OAAO,EAAE;QACX,OAAO,MAAM,GAAG,CAAC,YAAY,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;KAC7C;IAED,MAAM,IAAI,qBAAa,CAAC,2DAA2D,CAAC,CAAC;AACvF,CAAC;AAlBD,gCAkBC;AAuCD;;;;;GAKG;AACH,MAAM,kBAAkB,GAAiC;IACvD,KAAK,EAAE,SAAS;IAChB,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,MAAM;IACZ,KAAK,EAAE,OAAO;CACf,CAAC;AAEF;;;GAGG;AACI,KAAK,UAAU,cAAc,CAAC,EACnC,WAAW,EAAE,eAAe,EAC5B,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,EACnB,YAAY,EAAE,QAAQ,EACtB,QAAQ,GAAG,6BAAiB,EAC5B,KAAK,MACoB,EAAE;IAC3B,MAAM,IAAI,GAAG,IAAA,gBAAS,EAAC,gBAAgB,CAAC,CAAC;IACzC,eAAe,GAAG,eAAe,IAAI,CAAC,MAAM,IAAA,wBAAmB,EAAC,GAAG,CAAC,CAAC,CAAC;IACtE,IAAI,CAAC,eAAe,EAAE;QACpB,MAAM,IAAI,qBAAa,CACrB,kBAAkB,6BAAiB,SAAS,GAAG,UAAU,oBAAQ,gBAAgB,CAClF,CAAC;KACH;IACD,MAAM,OAAO,GAAG,YAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IACjC,MAAM,YAAY,GAAG,IAAA,eAAQ,EAAC,GAAG,CAAC,CAAC;IACnC,MAAM,uBAAuB,GAAG,YAAY,CAAC,eAAe,CAAC,CAAC;IAC9D,GAAG,CAAC,KAAK,CAAC,SAAS,uBAAuB,kBAAkB,CAAC,CAAC;IAE9D,IAAI,WAA8C,CAAC;IACnD,sEAAsE;IACtE,IAAI;QACF,WAAW,GAAG,IAAA,oBAAe,EAAC,eAAe,CAAC,CAAC;QAC/C,GAAG,CAAC,KAAK,CAAC,oBAAoB,EAAE,uBAAuB,EAAE,WAAW,CAAC,CAAC;KACvE;IAAC,OAAO,GAAG,EAAE;QACZ,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACf,MAAM,IAAI,qBAAa,CACrB,kBAAkB,uBAAuB,UAAU,oBAAQ,qBAAqB,CACjF,CAAC;KACH;IAED,oFAAoF;IACpF,kGAAkG;IAClG,gGAAgG;IAChG,IAAI,GAAW,CAAC;IAChB,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE;QACpB,GAAG,GAAG,mBAAI,CAAC,QAAQ,CACjB,mBAAI,CAAC,OAAO,CAAC,eAAe,CAAC,EAC7B,mBAAI,CAAC,IAAI,CAAC,OAAO,EAAE,wCAA4B,CAAC,CACjD,CAAC;QACF,GAAG,CAAC,KAAK,CAAC,iCAAiC,EAAE,GAAG,CAAC,CAAC;KACnD;SAAM;QACL,GAAG,GAAG,WAAW,CAAC,GAAG,CAAC;QACtB,GAAG,CAAC,KAAK,CAAC,yBAAyB,6BAAiB,KAAK,GAAG,EAAE,CAAC,CAAC;KACjE;IAED,MAAM,gBAAgB,GAAG,gBAAC,CAAC,MAAM,CAC/B,EAAC,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,QAAQ,EAAE,kBAAkB,CAAC,QAAQ,CAAC,EAAC,EACpE,OAAO,CACkB,CAAC;IAE5B,GAAG,CAAC,KAAK,CAAC,wBAAwB,EAAE,gBAAgB,CAAC,CAAC;IACtD,IAAI;QACF,MAAM,UAAU,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC;QAC5C,GAAG,CAAC,OAAO,CACT,mCAAmC,EACnC,mBAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,EAC9C,IAAI,EAAE,CACP,CAAC;KACH;IAAC,OAAO,GAAG,EAAE;QACZ,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;KAChB;AACH,CAAC;AA9DD,wCA8DC"}

package/build/lib/types.d.ts

@@ -1,52 +0,0 @@
-/**
- * Utility types
- * @module
- */
-import type { Jsonify, JsonValue, TsConfigJson as TsConfigJsonBase } from 'type-fest';
-import type { TypeDocOptions } from 'typedoc';
-/**
- * A `tsconfig.json` file w/ `$schema` prop
- */
-export declare type TsConfigJson = Jsonify<TsConfigJsonBase & {
-    $schema?: string;
-}>;
-/**
- * A `typedoc.json` file w/ `$schema` and `extends` props
- */
-export declare type TypeDocJson = Jsonify<Partial<TypeDocOptions> & {
-    $schema?: string;
-    extends?: string;
-}>;
-export declare type MkDocsYml = Jsonify<{
-    copyright?: string;
-    dev_addr?: string;
-    docs_dir?: string;
-    extra_css?: string[];
-    extra_javascript?: string[];
-    extra_templates?: string[];
-    extra?: Record<string, JsonValue>;
-    hooks?: string[];
-    INHERIT?: string;
-    markdown_extensions?: (string | Record<string, JsonValue>)[];
-    nav?: (string | Record<string, string>)[];
-    plugins?: (string | Record<string, JsonValue>)[];
-    repo_name?: string;
-    repo_url?: string;
-    site_dir?: string;
-    /**
-     * This is _actually_ required by mkdocs
-     */
-    site_name?: string;
-    site_description?: string;
-    strict?: boolean;
-    theme?: MkDocsYmlTheme;
-    use_directory_urls?: boolean;
-    watch?: string[];
-}>;
-export declare type MkDocsYmlTheme = string | ({
-    name: string;
-    locale?: string;
-    custom_dir?: string;
-    static_templates?: string[];
-} & Record<string, JsonValue>);
-//# sourceMappingURL=types.d.ts.map

package/build/lib/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../lib/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAC,OAAO,EAAE,SAAS,EAAe,YAAY,IAAI,gBAAgB,EAAC,MAAM,WAAW,CAAC;AACjG,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,SAAS,CAAC;AAE5C;;GAEG;AACH,oBAAY,YAAY,GAAG,OAAO,CAChC,gBAAgB,GAAG;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CACF,CAAC;AAEF;;GAEG;AACH,oBAAY,WAAW,GAAG,OAAO,CAC/B,OAAO,CAAC,cAAc,CAAC,GAAG;IACxB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CACF,CAAC;AAEF,oBAAY,SAAS,GAAG,OAAO,CAAC;IAC9B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC5B,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAC3B,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IAClC,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,mBAAmB,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC;IAC7D,GAAG,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC;IAC1C,OAAO,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC;IACjD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE,cAAc,CAAC;IACvB,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;CAClB,CAAC,CAAC;AAEH,oBAAY,cAAc,GACtB,MAAM,GACN,CAAC;IACC,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;CAC7B,GAAG,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC"}

package/build/lib/types.js

@@ -1,7 +0,0 @@
-"use strict";
-/**
- * Utility types
- * @module
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=types.js.map

package/build/lib/types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../lib/types.ts"],"names":[],"mappings":";AAAA;;;GAGG"}