@jupyterlab/extensionmanager 4.0.0-alpha.13 → 4.0.0-alpha.15

package/lib/index.d.ts

@@ -3,6 +3,4 @@
  * @module extensionmanager
  */
 export * from './model';
-export * from './npm';
-export * from './listings';
 export * from './widget';

package/lib/index.js

@@ -5,7 +5,5 @@
  * @module extensionmanager
  */
 export * from './model';
-export * from './npm';
-export * from './listings';
 export * from './widget';
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,0CAA0C;AAC1C,2DAA2D;AAC3D;;;GAGG;AAEH,cAAc,SAAS,CAAC;AACxB,cAAc,OAAO,CAAC;AACtB,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,0CAA0C;AAC1C,2DAA2D;AAC3D;;;GAGG;AAEH,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC"}

package/lib/model.d.ts

@@ -1,10 +1,6 @@
-import { JupyterFrontEnd } from '@jupyterlab/application';
-import { ServerConnection, ServiceManager } from '@jupyterlab/services';
-import { ISettingRegistry } from '@jupyterlab/settingregistry';
+import { ServiceManager } from '@jupyterlab/services';
 import { ITranslator } from '@jupyterlab/translation';
 import { VDomModel } from '@jupyterlab/ui-components';
-import { IListEntry, Lister } from './listings';
-import { ISearchResult, Searcher } from './npm';
 /**
  * Information about an extension.
  */
@@ -20,19 +16,23 @@ export interface IEntry {
     /**
      * A representative link of the package.
      */
-    url: string;
+    homepage_url: string;
     /**
      * Whether the extension is currently installed.
      */
-    installed: boolean;
+    installed?: boolean | null;
     /**
-     * Whether the extension is currently enabled.
+     * Whether the extension is allowed or not.
      */
-    enabled: boolean;
+    allowed: boolean;
     /**
-     * A flag indicating the status of an installed extension.
+     * Whether the extension is approved by the system administrators.
      */
-    status: 'ok' | 'warning' | 'error' | 'deprecated' | null;
+    approved: boolean;
+    /**
+     * Whether the extension is currently enabled.
+     */
+    enabled: boolean;
     /**
      * The latest version of the extension.
      */
@@ -41,8 +41,10 @@ export interface IEntry {
      * The installed version of the extension.
      */
     installed_version: string;
-    blockedExtensionsEntry: IListEntry | undefined;
-    allowedExtensionsEntry: IListEntry | undefined;
+    /**
+     * A flag indicating the status of an installed extension.
+     */
+    status: 'ok' | 'warning' | 'error' | 'deprecated' | null;
     /**
      * The package type (prebuilt or source).
      */
@@ -50,75 +52,36 @@ export interface IEntry {
     /**
      * The information about extension installation.
      */
-    install: IInstall | undefined;
-}
-/**
- * Information about extension installation.
- */
-export interface IInstall {
-    /**
-     * The used package manager (e.g. pip, conda...)
-     */
-    packageManager: string | undefined;
-    /**
-     * The package name as known by the package manager.
-     */
-    packageName: string | undefined;
-    /**
-     * The uninstallation instructions as a comprehensive
-     * text for the end user.
-     */
-    uninstallInstructions: string | undefined;
-}
-/**
- * Wire format for installed extensions.
- */
-export interface IInstalledEntry {
-    /**
-     * The name of the extension.
-     */
-    name: string;
-    /**
-     * A short description of the extension.
-     */
-    description: string;
-    /**
-     * A representative link of the package.
-     */
-    url: string;
+    install?: IInstall | null;
     /**
-     * Whether the extension is currently installed.
+     * Package author.
      */
-    installed?: boolean;
-    /**
-     * Whether the extension is currently enabled.
-     */
-    enabled: boolean;
+    author?: string;
     /**
-     * The latest version of the extension.
+     * Package license.
      */
-    latest_version: string;
+    license?: string;
     /**
-     * The installed version of the extension.
+     * URL to the package bug tracker.
      */
-    installed_version: string;
+    bug_tracker_url?: string;
     /**
-     * A flag indicating the status of an installed extension.
+     * URL to the package documentation.
      */
-    status: 'ok' | 'warning' | 'error' | 'deprecated' | null;
+    documentation_url?: string;
     /**
-     * The package type (prebuilt or source).
+     * URL to the package URL in the packager website.
      */
-    pkg_type: 'prebuilt' | 'source';
+    package_manager_url?: string;
     /**
-     * The information about extension installation.
+     * URL to the package code source.
      */
-    install: IInstallEntry | undefined;
+    repository_url?: string;
 }
 /**
  * Information about extension installation.
  */
-export interface IInstallEntry {
+export interface IInstall {
     /**
      * The used package manager (e.g. pip, conda...)
      */
@@ -145,6 +108,10 @@ export interface IActionReply {
      * An optional message when the status is not 'ok'.
      */
     message?: string;
+    /**
+     * Follow-up restart needed by the action
+     */
+    needs_restart: ('frontend' | 'kernel' | 'server')[];
 }
 /**
  * Extension actions that the server API accepts
@@ -154,67 +121,66 @@ export declare type Action = 'install' | 'uninstall' | 'enable' | 'disable';
  * Model for an extension list.
  */
 export declare class ListModel extends VDomModel {
-    constructor(app: JupyterFrontEnd, serviceManager: ServiceManager.IManager, settings: ISettingRegistry.ISettings, translator?: ITranslator);
-    private _listingIsLoaded;
+    constructor(serviceManager: ServiceManager.IManager, translator?: ITranslator);
+    /**
+     * Extension manager name.
+     */
+    readonly name: string;
+    /**
+     * Whether the extension manager support installation methods or not.
+     */
+    readonly canInstall: boolean;
+    /**
+     * Extensions installation path.
+     */
+    installPath: string | null;
     /**
      * A readonly array of the installed extensions.
      */
     get installed(): ReadonlyArray<IEntry>;
+    /**
+     * Whether the warning is disclaimed or not.
+     */
+    get isDisclaimed(): boolean;
+    set isDisclaimed(v: boolean);
+    get isLoadingInstalledExtensions(): boolean;
+    get isSearching(): boolean;
     /**
      * A readonly array containing the latest search result
      */
     get searchResult(): ReadonlyArray<IEntry>;
     /**
-     * The current NPM repository search query.
+     * The search query.
      *
      * Setting its value triggers a new search.
      */
-    get query(): string | null;
-    set query(value: string | null);
+    get query(): string;
+    set query(value: string);
     /**
-     * The current NPM repository search page.
-     *
-     * The npm repository search is paginated by the `pagination` attribute.
-     * The `page` value selects which page is used.
+     * The current search page.
      *
      * Setting its value triggers a new search.
+     *
+     * ### Note
+     * First page is 1.
      */
     get page(): number;
     set page(value: number);
     /**
-     * The NPM repository search pagination.
-     *
-     * The npm repository search is paginated by the `pagination` attribute.
-     * The `page` value selects which page is used.
+     * The search pagination.
      *
      * Setting its value triggers a new search.
      */
     get pagination(): number;
     set pagination(value: number);
     /**
-     * The total number of results in the current search.
-     */
-    get totalEntries(): number;
-    /**
-     * The list mode.
-     */
-    get listMode(): 'block' | 'allow' | 'default' | 'invalid';
-    /**
-     * The total number of blockedExtensions results in the current search.
-     */
-    get totalblockedExtensionsFound(): number;
-    /**
-     * The total number of allowedExtensions results in the current search.
+     * The last page of results in the current search.
      */
-    get totalallowedExtensionsFound(): number;
+    get lastPage(): number;
     /**
      * Dispose the extensions list model.
      */
     dispose(): void;
-    /**
-     * Initialize the model.
-     */
-    initialize(): Promise<void>;
     /**
      * Whether there are currently any actions pending.
      */
@@ -244,90 +210,41 @@ export declare class ListModel extends VDomModel {
      */
     disable(entry: IEntry): Promise<void>;
     /**
-     * Check for companion packages in kernels or server.
-     *
-     * @param entry An entry indicating which extension to check.
-     */
-    checkCompanionPackages(entry: IEntry): Promise<boolean>;
-    /**
-     * Trigger a build check to incorporate actions taken.
-     */
-    triggerBuildCheck(): void;
-    /**
-     * Perform a build on the server
-     */
-    performBuild(): void;
-    /**
-     * Ignore a build recommendation
-     */
-    ignoreBuildRecommendation(): void;
-    /**
-     * Ignore a build recommendation
-     */
-    refreshInstalled(): void;
-    /**
-     * Translate search results from an npm repository query into entries
-     * and remove entries with 'deprecated' in the keyword list
+     * Refresh installed packages
      *
-     * @param res Promise to an npm query result.
+     * @param force Force refreshing the list of installed packages
      */
-    protected translateSearchResult(res: Promise<ISearchResult>): Promise<{
-        [key: string]: IEntry;
-    }>;
-    /**
-     * Translate installed extensions information from the server into entries.
-     *
-     * @param res Promise to the server reply data.
-     */
-    protected translateInstalled(res: Promise<IInstalledEntry[]>): Promise<{
-        [key: string]: IEntry;
-    }>;
-    private isListed;
-    /**
-     * Make a request to the server for info about its installed extensions.
-     */
-    protected fetchInstalled(refreshInstalled?: boolean): Promise<IInstalledEntry[]>;
+    refreshInstalled(force?: boolean): Promise<void>;
     /**
      * Search with current query.
      *
      * Sets searchError and totalEntries as appropriate.
      *
-     * @returns {Promise<{ [key: string]: IEntry; }>} The search result as a map of entries.
-     */
-    protected performSearch(): Promise<{
-        [key: string]: IEntry;
-    }>;
-    /**
-     * Query the installed extensions.
-     *
-     * Sets installedError as appropriate.
-     *
-     * @returns {Promise<{ [key: string]: IEntry; }>} A map of installed extensions.
+     * @returns The extensions matching the current query.
      */
-    protected queryInstalled(refreshInstalled: boolean): Promise<{
-        [key: string]: IEntry;
-    }>;
+    protected search(force?: boolean): Promise<void>;
     /**
      * Update the current model.
      *
-     * This will query the NPM repository, and the notebook server.
+     * This will query the packages repository, and the notebook server.
      *
      * Emits the `stateChanged` signal on successful completion.
      */
-    protected update(refreshInstalled?: boolean): Promise<void>;
+    protected update(force?: boolean): Promise<void>;
     /**
      * Send a request to the server to perform an action on an extension.
      *
      * @param action A valid action to perform.
      * @param entry The extension to perform the action on.
      */
-    protected _performAction(action: string, entry: IEntry): Promise<IActionReply>;
+    protected performAction(action: string, entry: IEntry): Promise<IActionReply>;
     /**
      * Add a pending action.
      *
      * @param pending A promise that resolves when the action is completed.
      */
-    protected _addPendingAction(pending: Promise<any>): void;
+    protected addPendingAction(pending: Promise<any>): void;
+    actionError: string | null;
     /**
      * Contains an error message if an error occurred when querying installed extensions.
      */
@@ -337,53 +254,25 @@ export declare class ListModel extends VDomModel {
      */
     searchError: string | null;
     /**
-     * Contains an error message if an error occurred when searching for lists.
-     */
-    blockedExtensionsError: string | null;
-    /**
-     * Contains an error message if an error occurred when querying the server extension.
-     */
-    serverConnectionError: string | null;
-    /**
-     * Contains an error message if the server has unfulfilled requirements.
-     */
-    serverRequirementsError: string | null;
-    /**
-     * Whether the model has finished async initialization.
-     */
-    initialized: boolean;
-    /**
-     * Whether a fresh build should be considered due to actions taken.
-     */
-    promptBuild: boolean;
-    /**
-     * Settings for connecting to the notebook server.
-     */
-    protected serverConnectionSettings: ServerConnection.ISettings;
-    /**
-     * A helper for performing searches of jupyterlab extensions on the NPM repository.
+     * Whether a reload should be considered due to actions taken.
      */
-    protected searcher: Searcher;
-    protected lister: Lister;
+    promptReload: boolean;
     /**
      * The service manager to use for building.
      */
     protected serviceManager: ServiceManager.IManager;
     protected translator: ITranslator;
-    private _app;
+    private _isDisclaimed;
+    private _isLoadingInstalledExtensions;
+    private _isSearching;
     private _query;
     private _page;
     private _pagination;
-    private _totalEntries;
+    private _lastPage;
     private _installed;
-    private _searchResult;
+    private _lastSearchResult;
     private _pendingActions;
-    private _debouncedUpdate;
-    private _listMode;
-    private _blockedExtensionsArray;
-    private _allowedExtensionsArray;
-    private _totalblockedExtensionsFound;
-    private _totalallowedExtensionsFound;
+    private _debouncedSearch;
 }
 /**
  * ListModel statics.
@@ -395,6 +284,4 @@ export declare namespace ListModel {
      * @param entry The entry to check.
      */
     function entryHasUpdate(entry: IEntry): boolean;
-    function isDisclaimed(): boolean;
-    function toogleDisclaimed(): void;
 }