appium 2.0.0-beta.46 → 2.0.0-beta.48

package/build/lib/extension/manifest.d.ts

@@ -20,48 +20,6 @@ export class Manifest {
      * @private
      */
     private constructor();
-    /**
-     * The entire contents of a parsed YAML extension config file.
-     *
-     * Contains proxies for automatic persistence on disk
-     * @type {ManifestData}
-     * @private
-     */
-    private _data;
-    /**
-     * Path to `APPIUM_HOME`.
-     * @private
-     * @type {Readonly<string>}
-     */
-    private _appiumHome;
-    /**
-     * Path to `extensions.yaml`
-     * @type {string}
-     * Not set until {@link Manifest.read} is called.
-     */
-    _manifestPath: string;
-    /**
-     * Helps avoid writing multiple times.
-     *
-     * If this is `undefined`, calling {@link Manifest.write} will cause it to be
-     * set to a `Promise`. When the call to `write()` is complete, the `Promise`
-     * will resolve and then this value will be set to `undefined`.  Concurrent calls
-     * made while this value is a `Promise` will return the `Promise` itself.
-     * @private
-     * @type {Promise<boolean>|undefined}
-     */
-    private _writing;
-    /**
-     * Helps avoid reading multiple times.
-     *
-     * If this is `undefined`, calling {@link Manifest.read} will cause it to be
-     * set to a `Promise`. When the call to `read()` is complete, the `Promise`
-     * will resolve and then this value will be set to `undefined`.  Concurrent calls
-     * made while this value is a `Promise` will return the `Promise` itself.
-     * @private
-     * @type {Promise<void>|undefined}
-     */
-    private _reading;
     /**
      * Searches `APPIUM_HOME` for installed extensions and adds them to the manifest.
      * @returns {Promise<boolean>} `true` if any extensions were added, `false` otherwise.
@@ -82,11 +40,10 @@ export class Manifest {
     /**
      * Given a path to a `package.json`, add it as either a driver or plugin to the manifest.
      *
-     * Will _not_ overwrite existing entries.
      * @template {ExtensionType} ExtType
      * @param {ExtPackageJson<ExtType>} pkgJson
      * @param {string} pkgPath
-     * @returns {boolean} - `true` upon success, `false` if the extension is already registered.
+     * @returns {boolean} - `true` if this method did anything.
      */
     addExtensionFromPackage<ExtType extends import("@appium/types").ExtensionType>(pkgJson: ExtPackageJson<ExtType>, pkgPath: string): boolean;
     /**
@@ -100,42 +57,56 @@ export class Manifest {
      * @param {ExtManifest<ExtType>} extData - Extension metadata
      * @returns {ExtManifest<ExtType>} A clone of `extData`, potentially with a mutated `appiumVersion` field
      */
-    addExtension<ExtType_1 extends import("@appium/types").ExtensionType>(extType: ExtType_1, extName: string, extData: ExtManifest<ExtType_1>): ExtManifest<ExtType_1>;
+    setExtension<ExtType_1 extends import("@appium/types").ExtensionType>(extType: ExtType_1, extName: string, extData: ExtManifest<ExtType_1>): ExtManifest<ExtType_1>;
+    /**
+     * Sets the schema revision
+     * @param {keyof import('./manifest-migrations').ManifestDataVersions} rev
+     */
+    setSchemaRev(rev: keyof import('./manifest-migrations').ManifestDataVersions): void;
+    /**
+     * Remove an extension from the manifest.
+     * @param {ExtensionType} extType
+     * @param {string} extName
+     */
+    deleteExtension(extType: ExtensionType, extName: string): void;
     /**
-     * Returns the APPIUM_HOME path
+     * Returns the `APPIUM_HOME` path
      */
     get appiumHome(): string;
     /**
-     * Returns the path to the manifest file
+     * Returns the path to the manifest file (`extensions.yaml`)
      */
     get manifestPath(): string;
+    /**
+     * Returns the schema rev of this manifest
+     */
+    get schemaRev(): number;
     /**
      * Returns extension data for a particular type.
      *
      * @template {ExtensionType} ExtType
      * @param {ExtType} extType
-     * @returns {ExtRecord<ExtType>}
+     * @returns {Readonly<ExtRecord<ExtType>>}
      */
-    getExtensionData<ExtType_2 extends import("@appium/types").ExtensionType>(extType: ExtType_2): ExtRecord<ExtType_2>;
+    getExtensionData<ExtType_2 extends import("@appium/types").ExtensionType>(extType: ExtType_2): Readonly<ExtRecord<ExtType_2>>;
     /**
      * Reads manifest from disk and _overwrites_ the internal data.
      *
-     * If the manifest does not exist on disk, an {@link INITIAL_MANIFEST_DATA "empty"} manifest file will be created.
+     * If the manifest does not exist on disk, an
+     * {@link INITIAL_MANIFEST_DATA "empty"} manifest file will be created, as
+     * well as its directory if needed.
      *
-     * If `APPIUM_HOME` contains a `package.json` with an `appium` dependency, then a hash of the `package.json` will be taken. If this hash differs from the last hash, the contents of `APPIUM_HOME/node_modules` will be scanned for extensions that may have been installed outside of the `appium` CLI.  Any found extensions will be added to the manifest file, and if so, the manifest file will be written to disk.
+     * This will also, if necessary:
+     * 1. perform a migration of the manifest data
+     * 2. sync the manifest with extensions on-disk (kind of like "auto
+     *    discovery")
+     * 3. write the manifest to disk.
+     *
+     * Only one read operation can happen at a time.
      *
-     * Only one read operation should happen at a time.  This is controlled via the {@link Manifest._reading} property.
      * @returns {Promise<ManifestData>} The data
      */
     read(): Promise<ManifestData>;
-    /**
-     * Ensures {@link Manifest._manifestPath} is set.
-     *
-     * Creates the directory if necessary.
-     * @private
-     * @returns {Promise<string>}
-     */
-    private _setManifestPath;
     /**
      * Writes the data if it need s writing.
      *
@@ -145,6 +116,7 @@ export class Manifest {
      * @returns {Promise<boolean>} Whether the data was written
      */
     write(): Promise<boolean>;
+    #private;
 }
 /**
  * Type of the string referring to a driver (typically as a key or type string)
@@ -162,9 +134,9 @@ export type SyncWithInstalledExtensionsOpts = {
 };
 export type ManifestData = import('appium/types').ManifestData;
 export type InternalMetadata = import('appium/types').InternalMetadata;
-export type ExtPackageJson<T> = import('appium/types').ExtPackageJson<T>;
-export type ExtManifest<T> = import('appium/types').ExtManifest<T>;
-export type ExtRecord<T> = import('appium/types').ExtRecord<T>;
+export type ExtPackageJson<ExtType extends import("@appium/types").ExtensionType> = import('appium/types').ExtPackageJson<ExtType>;
+export type ExtManifest<ExtType extends import("@appium/types").ExtensionType> = import('appium/types').ExtManifest<ExtType>;
+export type ExtRecord<ExtType extends import("@appium/types").ExtensionType> = import('appium/types').ExtRecord<ExtType>;
 /**
  * Either `driver` or `plugin` rn
  */

package/build/lib/extension/manifest.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"manifest.d.ts","sourceRoot":"","sources":["../../../lib/extension/manifest.js"],"names":[],"mappings":"AAoFA;;;;GAIG;AACH;IA4DE;;;;;;OAMG;IACH,yEAEG;IArBH;;;;;;OAMG;IACH,sBAGC;IAzDD;;;;;;OAMG;IACH,cAAM;IAEN;;;;OAIG;IACH,oBAAY;IAEZ;;;;OAIG;IACH,eAHU,MAAM,CAGF;IAEd;;;;;;;;;OASG;IACH,iBAAS;IAET;;;;;;;;;OASG;IACH,iBAAS;IAyBT;;;OAGG;IACH,+BAFa,QAAQ,OAAO,CAAC,CAqD5B;IAED;;;;OAIG;IACH,gBAHW,MAAM,GACJ,OAAO,CAInB;IAED;;;;OAIG;IACH,gBAHW,MAAM,GACJ,OAAO,CAInB;IAED;;;;;;;;OAQG;IACH,0HAHW,MAAM,GACJ,OAAO,CAuCnB;IAED;;;;;;;;;;OAUG;IACH,mGAJW,MAAM,2DAQhB;IAED;;OAEG;IACH,yBAEC;IAED;;OAEG;IACH,2BAEC;IAED;;;;;;OAMG;IACH,oHAEC;IAED;;;;;;;;;OASG;IACH,QAFa,QAAQ,YAAY,CAAC,CAuDjC;IAED;;;;;;OAMG;IACH,yBAaC;IAED;;;;;;;OAOG;IACH,SAFa,QAAQ,OAAO,CAAC,CAgC5B;CACF;;;;yBAIY,OAAO,eAAe,EAAE,UAAU;;;;yBAKlC,OAAO,eAAe,EAAE,UAAU;;;;;;;2BASlC,OAAO,cAAc,EAAE,YAAY;+BACnC,OAAO,cAAc,EAAE,gBAAgB;gCAKvC,OAAO,cAAc,EAAE,cAAc,CAAC,CAAC,CAAC;6BAKxC,OAAO,cAAc,EAAE,WAAW,CAAC,CAAC,CAAC;2BAKrC,OAAO,cAAc,EAAE,SAAS,CAAC,CAAC,CAAC;;;;4BAKnC,OAAO,eAAe,EAAE,aAAa"}
+{"version":3,"file":"manifest.d.ts","sourceRoot":"","sources":["../../../lib/extension/manifest.js"],"names":[],"mappings":"AAqFA;;;;GAIG;AACH;IAwDE;;;;;;OAMG;IACH,yEAEG;IArBH;;;;;;OAMG;IACH,sBAGC;IAaD;;;OAGG;IACH,+BAFa,QAAQ,OAAO,CAAC,CAqE5B;IAED;;;;OAIG;IACH,gBAHW,MAAM,GACJ,OAAO,CAInB;IAED;;;;OAIG;IACH,gBAHW,MAAM,GACJ,OAAO,CAInB;IAED;;;;;;;OAOG;IACH,0HAHW,MAAM,GACJ,OAAO,CA0CnB;IAED;;;;;;;;;;OAUG;IACH,mGAJW,MAAM,2DAQhB;IAED;;;OAGG;IACH,kBAFW,MAAM,OAAO,uBAAuB,EAAE,oBAAoB,QAIpE;IAED;;;;OAIG;IACH,yBAHW,aAAa,WACb,MAAM,QAIhB;IAED;;OAEG;IACH,yBAEC;IAED;;OAEG;IACH,2BAEC;IAED;;OAEG;IACH,wBAEC;IAED;;;;;;OAMG;IACH,8HAEC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,QAFa,QAAQ,YAAY,CAAC,CAwFjC;IAyBD;;;;;;;OAOG;IACH,SAFa,QAAQ,OAAO,CAAC,CAiC5B;;CACF;;;;yBAIY,OAAO,eAAe,EAAE,UAAU;;;;yBAKlC,OAAO,eAAe,EAAE,UAAU;;;;;;;2BASlC,OAAO,cAAc,EAAE,YAAY;+BACnC,OAAO,cAAc,EAAE,gBAAgB;oFAKvC,OAAO,cAAc,EAAE,cAAc,CAAC,OAAO,CAAC;iFAK9C,OAAO,cAAc,EAAE,WAAW,CAAC,OAAO,CAAC;+EAK3C,OAAO,cAAc,EAAE,SAAS,CAAC,OAAO,CAAC;;;;4BAKzC,OAAO,eAAe,EAAE,aAAa"}