@jupyterlab/extensionmanager 4.0.0-alpha.8 → 4.0.0-beta.0

package/lib/npm.d.ts

@@ -1,223 +0,0 @@
-import { IJupyterLabPackageData } from './companions';
-/**
- * Information about a person in search results.
- */
-export interface IPerson {
-    /**
-     * The username of the person.
-     */
-    username: string;
-    /**
-     * The email of the person.
-     */
-    email: string;
-}
-/**
- * NPM registry search result structure (subset).
- *
- * See https://github.com/npm/registry/blob/master/docs/REGISTRY-API.md
- * for full specification.
- */
-export interface ISearchResult {
-    /**
-     * A collection of search results.
-     */
-    objects: {
-        /**
-         * Metadata about the found package.
-         */
-        package: {
-            /**
-             * The package name.
-             */
-            name: string;
-            /**
-             * The scope of the package (e.g. jupyterlab for @jupyterlab/services).
-             */
-            scope: string;
-            /**
-             * Version number.
-             */
-            version: string;
-            /**
-             * Description as listed in package.json.
-             */
-            description: string;
-            /**
-             * Package keywords.
-             */
-            keywords: string[];
-            /**
-             * Timestamp of release(?).
-             */
-            date: string;
-            /**
-             * Various metadata links for the package.
-             */
-            links: {
-                [key: string]: string;
-            };
-            /**
-             * Metadata about user who published the release.
-             */
-            publisher: IPerson;
-            /**
-             * Maintainer list per package.json.
-             */
-            maintainers: IPerson[];
-        };
-        /**
-         * Flags about the package.
-         */
-        flags: {
-            /**
-             * Package is insecure or have vulnerable dependencies (based on the nsp registry).
-             */
-            insecure: number;
-            /**
-             * Package has a version < 1.0.0.
-             */
-            unstable: boolean;
-        };
-        /**
-         * Object detailing the normalized search score.
-         */
-        score: {
-            /**
-             * The final normalized search score.
-             */
-            final: number;
-            /**
-             * Break down of the search score.
-             */
-            detail: {
-                /**
-                 * The normalized quality score.
-                 */
-                quality: number;
-                /**
-                 * The normalized popularity score.
-                 */
-                popularity: number;
-                /**
-                 * The normalized maintenance score.
-                 */
-                maintenance: number;
-            };
-        };
-        /**
-         * The search score.
-         */
-        searchScore: number;
-    }[];
-    /**
-     * The total number of objects found by the search.
-     *
-     * This can be greater than the number of objects due
-     * to pagination of the search results.
-     */
-    total: number;
-    /**
-     * Timestamp of the search result creation.
-     */
-    time: string;
-}
-/**
- * An interface for a subset of the keys known to be included for package metadata.
- *
- * See https://github.com/npm/registry/blob/master/docs/responses/package-metadata.md
- * for full specification.
- */
-export interface IPackageMetadata {
-    /**
-     * The package name.
-     */
-    name: string;
-    /**
-     * ISO string of the last time this package was modified.
-     */
-    modified: string;
-    /**
-     * A mapping of dist tags to the versions they point to.
-     */
-    'dist-tags': {
-        /**
-         * The version tagged as 'latest'.
-         */
-        latest: string;
-        [key: string]: string;
-    };
-    /**
-     * A short description of the package.
-     */
-    description: string;
-    /**
-     * A mapping of semver-compliant version numbers to version data.
-     */
-    versions: {
-        [key: string]: {
-            /**
-             * The package name.
-             */
-            name: string;
-            /**
-             * The version string for this version.
-             */
-            version: string;
-            /**
-             * The deprecation warnings message of this version.
-             */
-            deprecated?: string;
-            /**
-             * A short description of the package.
-             */
-            description: string;
-        };
-    };
-}
-/**
- * An object for searching an NPM registry.
- *
- * Searches the NPM registry via web API:
- * https://github.com/npm/registry/blob/master/docs/REGISTRY-API.md
- */
-export declare class Searcher {
-    /**
-     * Create a Searcher object.
-     *
-     * @param repoUri The URI of the NPM registry to use.
-     * @param cdnUri The URI of the CDN to use for fetching full package data.
-     */
-    constructor(repoUri?: string, cdnUri?: string, enableCdn?: boolean);
-    /**
-     * Search for a jupyterlab extension.
-     *
-     * @param query The query to send. `keywords:"jupyterlab-extension"` will be appended to the query.
-     * @param page The page of results to fetch.
-     * @param pageination The pagination size to use. See registry API documentation for acceptable values.
-     */
-    searchExtensions(query: string, page?: number, pageination?: number): Promise<ISearchResult>;
-    /**
-     * Fetch package.json of a package
-     *
-     * @param name The package name.
-     * @param version The version of the package to fetch.
-     */
-    fetchPackageData(name: string, version: string): Promise<IJupyterLabPackageData | null>;
-    /**
-     * The URI of the NPM registry to use.
-     */
-    repoUri: string;
-    /**
-     * The URI of the CDN to use for fetching full package data.
-     */
-    cdnUri: string;
-    /**
-     * Whether to use the CDN for fetching full package data. Otherwise, the NPM registry is used.
-     */
-    enableCdn: boolean;
-}
-/**
- * Check whether the NPM org is a Jupyter one.
- */
-export declare function isJupyterOrg(name: string): boolean;

package/lib/npm.js

@@ -1,76 +0,0 @@
-// Copyright (c) Jupyter Development Team.
-// Distributed under the terms of the Modified BSD License.
-/**
- * An object for searching an NPM registry.
- *
- * Searches the NPM registry via web API:
- * https://github.com/npm/registry/blob/master/docs/REGISTRY-API.md
- */
-export class Searcher {
-    /**
-     * Create a Searcher object.
-     *
-     * @param repoUri The URI of the NPM registry to use.
-     * @param cdnUri The URI of the CDN to use for fetching full package data.
-     */
-    constructor(repoUri = 'https://registry.npmjs.org/-/v1/', cdnUri = 'https://unpkg.com', enableCdn = true) {
-        this.repoUri = repoUri;
-        this.cdnUri = cdnUri;
-        this.enableCdn = enableCdn;
-    }
-    /**
-     * Search for a jupyterlab extension.
-     *
-     * @param query The query to send. `keywords:"jupyterlab-extension"` will be appended to the query.
-     * @param page The page of results to fetch.
-     * @param pageination The pagination size to use. See registry API documentation for acceptable values.
-     */
-    searchExtensions(query, page = 0, pageination = 250) {
-        const uri = new URL('search', this.repoUri);
-        // Note: Spaces are encoded to '+' signs!
-        const text = `${query} keywords:"jupyterlab-extension"`;
-        uri.searchParams.append('text', text);
-        uri.searchParams.append('size', pageination.toString());
-        uri.searchParams.append('from', (pageination * page).toString());
-        return fetch(uri.toString()).then((response) => {
-            if (response.ok) {
-                return response.json();
-            }
-            return [];
-        });
-    }
-    /**
-     * Fetch package.json of a package
-     *
-     * @param name The package name.
-     * @param version The version of the package to fetch.
-     */
-    fetchPackageData(name, version) {
-        const uri = this.enableCdn
-            ? new URL(`/${name}@${version}/package.json`, this.cdnUri)
-            : new URL(`/${name}/${version}`, this.repoUri);
-        return fetch(uri.toString()).then((response) => {
-            if (response.ok) {
-                return response.json();
-            }
-            return null;
-        });
-    }
-}
-/**
- * Check whether the NPM org is a Jupyter one.
- */
-export function isJupyterOrg(name) {
-    /**
-     * A list of jupyterlab NPM orgs.
-     */
-    const jupyterOrg = ['jupyterlab', 'jupyter-widgets'];
-    const parts = name.split('/');
-    const first = parts[0];
-    return (parts.length > 1 && // Has a first part
-        !!first && // with a finite length
-        first[0] === '@' && // corresponding to an org name
-        jupyterOrg.indexOf(first.slice(1)) !== -1 // in the org allowedExtensions.
-    );
-}
-//# sourceMappingURL=npm.js.map

package/lib/npm.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"npm.js","sourceRoot":"","sources":["../src/npm.ts"],"names":[],"mappings":"AAAA,0CAA0C;AAC1C,2DAA2D;AA+M3D;;;;;GAKG;AACH,MAAM,OAAO,QAAQ;IACnB;;;;;OAKG;IACH,YACE,OAAO,GAAG,kCAAkC,EAC5C,MAAM,GAAG,mBAAmB,EAC5B,SAAS,GAAG,IAAI;QAEhB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;IAED;;;;;;OAMG;IACH,gBAAgB,CACd,KAAa,EACb,IAAI,GAAG,CAAC,EACR,WAAW,GAAG,GAAG;QAEjB,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAC5C,yCAAyC;QACzC,MAAM,IAAI,GAAG,GAAG,KAAK,kCAAkC,CAAC;QACxD,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QACtC,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,QAAQ,EAAE,CAAC,CAAC;QACxD,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,WAAW,GAAG,IAAI,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;QACjE,OAAO,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,QAAkB,EAAE,EAAE;YACvD,IAAI,QAAQ,CAAC,EAAE,EAAE;gBACf,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;aACxB;YACD,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,gBAAgB,CACd,IAAY,EACZ,OAAe;QAEf,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS;YACxB,CAAC,CAAC,IAAI,GAAG,CAAC,IAAI,IAAI,IAAI,OAAO,eAAe,EAAE,IAAI,CAAC,MAAM,CAAC;YAC1D,CAAC,CAAC,IAAI,GAAG,CAAC,IAAI,IAAI,IAAI,OAAO,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACjD,OAAO,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,QAAkB,EAAE,EAAE;YACvD,IAAI,QAAQ,CAAC,EAAE,EAAE;gBACf,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;aACxB;YACD,OAAO,IAAI,CAAC;QACd,CAAC,CAAC,CAAC;IACL,CAAC;CAgBF;AAED;;GAEG;AACH,MAAM,UAAU,YAAY,CAAC,IAAY;IACvC;;OAEG;IACH,MAAM,UAAU,GAAG,CAAC,YAAY,EAAE,iBAAiB,CAAC,CAAC;IACrD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC9B,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IACvB,OAAO,CACL,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,mBAAmB;QACvC,CAAC,CAAC,KAAK,IAAI,uBAAuB;QAClC,KAAK,CAAC,CAAC,CAAC,KAAK,GAAG,IAAI,+BAA+B;QACnD,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,gCAAgC;KAC3E,CAAC;AACJ,CAAC"}