@theia/scanoss 1.57.0

package/README.md

@@ -0,0 +1,33 @@
+<div align='center'>
+
+<br />
+
+<img src='https://raw.githubusercontent.com/eclipse-theia/theia/master/logo/theia.svg?sanitize=true' alt='theia-ext-logo' width='100px' />
+
+<h2>ECLIPSE THEIA - SCAN OSS EXTENSION</h2>
+
+<hr />
+
+</div>
+
+## Description
+
+Offers a `ScanOSSService` on the backend and frontend for scanning code snippets.
+
+If needed, an API key can be handed over via preference or environment variable (`SCANOSS_API_KEY`).
+
+## Additional Information
+
+- [Theia - GitHub](https://github.com/eclipse-theia/theia)
+- [Theia - Website](https://theia-ide.org/)
+- [SCAN OSS Website](https://www.scanoss.com/)
+
+## License
+
+- [Eclipse Public License 2.0](http://www.eclipse.org/legal/epl-2.0/)
+- [一 (Secondary) GNU General Public License, version 2 with the GNU Classpath Exception](https://projects.eclipse.org/license/secondary-gpl-2.0-cp)
+
+## Trademark
+
+"Theia" is a trademark of the Eclipse Foundation
+<https://www.eclipse.org/theia>

package/lib/browser/scanoss-frontend-module.d.ts

@@ -0,0 +1,4 @@
+import { ContainerModule } from '@theia/core/shared/inversify';
+declare const _default: ContainerModule;
+export default _default;
+//# sourceMappingURL=scanoss-frontend-module.d.ts.map

package/lib/browser/scanoss-frontend-module.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scanoss-frontend-module.d.ts","sourceRoot":"","sources":["../../src/browser/scanoss-frontend-module.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;;AAK/D,wBAMG"}

package/lib/browser/scanoss-frontend-module.js

@@ -0,0 +1,29 @@
+"use strict";
+// *****************************************************************************
+// Copyright (C) 2024 EclipseSource GmbH.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+Object.defineProperty(exports, "__esModule", { value: true });
+const inversify_1 = require("@theia/core/shared/inversify");
+const scanoss_preferences_1 = require("./scanoss-preferences");
+const browser_1 = require("@theia/core/lib/browser");
+const common_1 = require("../common");
+exports.default = new inversify_1.ContainerModule(bind => {
+    bind(browser_1.PreferenceContribution).toConstantValue({ schema: scanoss_preferences_1.ScanOSSPreferencesSchema });
+    bind(common_1.ScanOSSService).toDynamicValue(ctx => {
+        const provider = ctx.container.get(browser_1.RemoteConnectionProvider);
+        return provider.createProxy(common_1.SCANOSS_SERVICE_PATH);
+    }).inSingletonScope();
+});
+//# sourceMappingURL=scanoss-frontend-module.js.map

package/lib/browser/scanoss-frontend-module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scanoss-frontend-module.js","sourceRoot":"","sources":["../../src/browser/scanoss-frontend-module.ts"],"names":[],"mappings":";AAAA,gFAAgF;AAChF,yCAAyC;AACzC,EAAE;AACF,2EAA2E;AAC3E,mEAAmE;AACnE,wCAAwC;AACxC,EAAE;AACF,4EAA4E;AAC5E,8EAA8E;AAC9E,6EAA6E;AAC7E,yDAAyD;AACzD,uDAAuD;AACvD,EAAE;AACF,gFAAgF;AAChF,gFAAgF;;AAEhF,4DAA+D;AAC/D,+DAAiE;AACjE,qDAAsH;AACtH,sCAAiE;AAEjE,kBAAe,IAAI,2BAAe,CAAC,IAAI,CAAC,EAAE;IACtC,IAAI,CAAC,gCAAsB,CAAC,CAAC,eAAe,CAAC,EAAE,MAAM,EAAE,8CAAwB,EAAE,CAAC,CAAC;IACnF,IAAI,CAAC,uBAAc,CAAC,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE;QACtC,MAAM,QAAQ,GAAG,GAAG,CAAC,SAAS,CAAC,GAAG,CAA4B,kCAAwB,CAAC,CAAC;QACxF,OAAO,QAAQ,CAAC,WAAW,CAAiB,6BAAoB,CAAC,CAAC;IACtE,CAAC,CAAC,CAAC,gBAAgB,EAAE,CAAC;AAC1B,CAAC,CAAC,CAAC"}

package/lib/browser/scanoss-preferences.d.ts

@@ -0,0 +1,4 @@
+import { PreferenceSchema } from '@theia/core/lib/browser/preferences';
+export declare const SCAN_OSS_API_KEY_PREF = "SCANOSS.apiKey";
+export declare const ScanOSSPreferencesSchema: PreferenceSchema;
+//# sourceMappingURL=scanoss-preferences.d.ts.map

package/lib/browser/scanoss-preferences.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scanoss-preferences.d.ts","sourceRoot":"","sources":["../../src/browser/scanoss-preferences.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,gBAAgB,EAAE,MAAM,qCAAqC,CAAC;AAEvE,eAAO,MAAM,qBAAqB,mBAAmB,CAAC;AAEtD,eAAO,MAAM,wBAAwB,EAAE,gBAUtC,CAAC"}

package/lib/browser/scanoss-preferences.js

@@ -0,0 +1,31 @@
+"use strict";
+// *****************************************************************************
+// Copyright (C) 2024 EclipseSource GmbH.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ScanOSSPreferencesSchema = exports.SCAN_OSS_API_KEY_PREF = void 0;
+exports.SCAN_OSS_API_KEY_PREF = 'SCANOSS.apiKey';
+exports.ScanOSSPreferencesSchema = {
+    type: 'object',
+    properties: {
+        [exports.SCAN_OSS_API_KEY_PREF]: {
+            type: 'string',
+            markdownDescription: 'Enter an API Key of your SCANOSS  Account. **Please note:** By using this preference the key will be stored in clear text\
+            on the machine running Theia. Use the environment variable `SCANOSS_API_KEY` to set the key securely.',
+            title: 'SCANOSS API Key'
+        }
+    }
+};
+//# sourceMappingURL=scanoss-preferences.js.map

package/lib/browser/scanoss-preferences.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scanoss-preferences.js","sourceRoot":"","sources":["../../src/browser/scanoss-preferences.ts"],"names":[],"mappings":";AAAA,gFAAgF;AAChF,yCAAyC;AACzC,EAAE;AACF,2EAA2E;AAC3E,mEAAmE;AACnE,wCAAwC;AACxC,EAAE;AACF,4EAA4E;AAC5E,8EAA8E;AAC9E,6EAA6E;AAC7E,yDAAyD;AACzD,uDAAuD;AACvD,EAAE;AACF,gFAAgF;AAChF,gFAAgF;;;AAInE,QAAA,qBAAqB,GAAG,gBAAgB,CAAC;AAEzC,QAAA,wBAAwB,GAAqB;IACtD,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACR,CAAC,6BAAqB,CAAC,EAAE;YACrB,IAAI,EAAE,QAAQ;YACd,mBAAmB,EAAE;kHACiF;YACtG,KAAK,EAAE,iBAAiB;SAC3B;KACJ;CACJ,CAAC"}

package/lib/common/index.d.ts

@@ -0,0 +1,2 @@
+export * from './scanoss-service';
+//# sourceMappingURL=index.d.ts.map

package/lib/common/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/common/index.ts"],"names":[],"mappings":"AAeA,cAAc,mBAAmB,CAAC"}

package/lib/common/index.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+// *****************************************************************************
+// Copyright (C) 2024 EclipseSource GmbH.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+tslib_1.__exportStar(require("./scanoss-service"), exports);
+//# sourceMappingURL=index.js.map

package/lib/common/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/common/index.ts"],"names":[],"mappings":";;;AAAA,gFAAgF;AAChF,yCAAyC;AACzC,EAAE;AACF,2EAA2E;AAC3E,mEAAmE;AACnE,wCAAwC;AACxC,EAAE;AACF,4EAA4E;AAC5E,8EAA8E;AAC9E,6EAA6E;AAC7E,yDAAyD;AACzD,uDAAuD;AACvD,EAAE;AACF,gFAAgF;AAChF,gFAAgF;AAChF,4DAAkC"}

package/lib/common/scanoss-service.d.ts

@@ -0,0 +1,20 @@
+export declare const SCANOSS_SERVICE_PATH = "/services/scanoss/service";
+export declare const ScanOSSService: unique symbol;
+export interface ScanOSSResultClean {
+    type: 'clean';
+}
+export interface ScanOSSResultMatch {
+    type: 'match';
+    matched: string;
+    url: string;
+    raw: unknown;
+}
+export interface ScanOSSResultError {
+    type: 'error';
+    message: string;
+}
+export type ScanOSSResult = ScanOSSResultClean | ScanOSSResultMatch | ScanOSSResultError;
+export interface ScanOSSService {
+    scanContent(content: string, apiKey?: string): Promise<ScanOSSResult>;
+}
+//# sourceMappingURL=scanoss-service.d.ts.map

package/lib/common/scanoss-service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scanoss-service.d.ts","sourceRoot":"","sources":["../../src/common/scanoss-service.ts"],"names":[],"mappings":"AAeA,eAAO,MAAM,oBAAoB,8BAA8B,CAAC;AAChE,eAAO,MAAM,cAAc,eAA2B,CAAC;AACvD,MAAM,WAAW,kBAAkB;IAC/B,IAAI,EAAE,OAAO,CAAC;CACjB;AACD,MAAM,WAAW,kBAAkB;IAC/B,IAAI,EAAE,OAAO,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,OAAO,CAAC;CAChB;AACD,MAAM,WAAW,kBAAkB;IAC/B,IAAI,EAAE,OAAO,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;CACnB;AACD,MAAM,MAAM,aAAa,GAAG,kBAAkB,GAAG,kBAAkB,GAAG,kBAAkB,CAAC;AACzF,MAAM,WAAW,cAAc;IAC3B,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;CACzE"}

package/lib/common/scanoss-service.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ScanOSSService = exports.SCANOSS_SERVICE_PATH = void 0;
+// *****************************************************************************
+// Copyright (C) 2024 EclipseSource GmbH.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+exports.SCANOSS_SERVICE_PATH = '/services/scanoss/service';
+exports.ScanOSSService = Symbol('ScanOSSService');
+//# sourceMappingURL=scanoss-service.js.map

package/lib/common/scanoss-service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scanoss-service.js","sourceRoot":"","sources":["../../src/common/scanoss-service.ts"],"names":[],"mappings":";;;AAAA,gFAAgF;AAChF,yCAAyC;AACzC,EAAE;AACF,2EAA2E;AAC3E,mEAAmE;AACnE,wCAAwC;AACxC,EAAE;AACF,4EAA4E;AAC5E,8EAA8E;AAC9E,6EAA6E;AAC7E,yDAAyD;AACzD,uDAAuD;AACvD,EAAE;AACF,gFAAgF;AAChF,gFAAgF;AACnE,QAAA,oBAAoB,GAAG,2BAA2B,CAAC;AACnD,QAAA,cAAc,GAAG,MAAM,CAAC,gBAAgB,CAAC,CAAC"}

package/lib/node/scanoss-backend-module.d.ts

@@ -0,0 +1,4 @@
+import { ContainerModule } from '@theia/core/shared/inversify';
+declare const _default: ContainerModule;
+export default _default;
+//# sourceMappingURL=scanoss-backend-module.d.ts.map

package/lib/node/scanoss-backend-module.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scanoss-backend-module.d.ts","sourceRoot":"","sources":["../../src/node/scanoss-backend-module.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;;AAK/D,wBAMG"}

package/lib/node/scanoss-backend-module.js

@@ -0,0 +1,27 @@
+"use strict";
+// *****************************************************************************
+// Copyright (C) 2024 EclipseSource GmbH.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+Object.defineProperty(exports, "__esModule", { value: true });
+const inversify_1 = require("@theia/core/shared/inversify");
+const core_1 = require("@theia/core");
+const common_1 = require("../common");
+const scanoss_service_impl_1 = require("./scanoss-service-impl");
+exports.default = new inversify_1.ContainerModule(bind => {
+    bind(scanoss_service_impl_1.ScanOSSServiceImpl).toSelf().inSingletonScope();
+    bind(common_1.ScanOSSService).toService(scanoss_service_impl_1.ScanOSSServiceImpl);
+    bind(core_1.ConnectionHandler).toDynamicValue(ctx => new core_1.RpcConnectionHandler(common_1.SCANOSS_SERVICE_PATH, () => ctx.container.get(common_1.ScanOSSService))).inSingletonScope();
+});
+//# sourceMappingURL=scanoss-backend-module.js.map

package/lib/node/scanoss-backend-module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scanoss-backend-module.js","sourceRoot":"","sources":["../../src/node/scanoss-backend-module.ts"],"names":[],"mappings":";AAAA,gFAAgF;AAChF,yCAAyC;AACzC,EAAE;AACF,2EAA2E;AAC3E,mEAAmE;AACnE,wCAAwC;AACxC,EAAE;AACF,4EAA4E;AAC5E,8EAA8E;AAC9E,6EAA6E;AAC7E,yDAAyD;AACzD,uDAAuD;AACvD,EAAE;AACF,gFAAgF;AAChF,gFAAgF;;AAEhF,4DAA+D;AAC/D,sCAAsE;AACtE,sCAAiE;AACjE,iEAA4D;AAE5D,kBAAe,IAAI,2BAAe,CAAC,IAAI,CAAC,EAAE;IACtC,IAAI,CAAC,yCAAkB,CAAC,CAAC,MAAM,EAAE,CAAC,gBAAgB,EAAE,CAAC;IACrD,IAAI,CAAC,uBAAc,CAAC,CAAC,SAAS,CAAC,yCAAkB,CAAC,CAAC;IACnD,IAAI,CAAC,wBAAiB,CAAC,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,CACzC,IAAI,2BAAoB,CAAC,6BAAoB,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,uBAAc,CAAC,CAAC,CAC1F,CAAC,gBAAgB,EAAE,CAAC;AACzB,CAAC,CAAC,CAAC"}

package/lib/node/scanoss-service-impl.d.ts

@@ -0,0 +1,7 @@
+import { ScanOSSResult, ScanOSSService } from '../common';
+export declare class ScanOSSServiceImpl implements ScanOSSService {
+    private readonly processor;
+    scanContent(content: string, apiKey?: string): Promise<ScanOSSResult>;
+    doScanContent(content: string, apiKey?: string): Promise<ScanOSSResult>;
+}
+//# sourceMappingURL=scanoss-service-impl.d.ts.map

package/lib/node/scanoss-service-impl.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scanoss-service-impl.d.ts","sourceRoot":"","sources":["../../src/node/scanoss-service-impl.ts"],"names":[],"mappings":"AAiBA,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAkB1D,qBACa,kBAAmB,YAAW,cAAc;IAErD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAA4C;IAEhE,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAIrE,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;CAiEhF"}

package/lib/node/scanoss-service-impl.js

@@ -0,0 +1,107 @@
+"use strict";
+// *****************************************************************************
+// Copyright (C) 2024 EclipseSource GmbH.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ScanOSSServiceImpl = void 0;
+const tslib_1 = require("tslib");
+const inversify_1 = require("@theia/core/shared/inversify");
+const scanoss_1 = require("scanoss");
+// Helper class to perform scans sequentially
+class SequentialProcessor {
+    constructor() {
+        this.queue = Promise.resolve();
+    }
+    async processTask(task) {
+        this.queue = this.queue.then(() => task());
+        return this.queue;
+    }
+}
+let ScanOSSServiceImpl = class ScanOSSServiceImpl {
+    constructor() {
+        this.processor = new SequentialProcessor();
+    }
+    async scanContent(content, apiKey) {
+        return this.processor.processTask(async () => this.doScanContent(content, apiKey));
+    }
+    async doScanContent(content, apiKey) {
+        var _a, _b;
+        const config = new scanoss_1.ScannerCfg();
+        const apiKeyToUse = apiKey || process.env.SCANOSS_API_KEY || undefined;
+        if (apiKeyToUse) {
+            config.API_KEY = apiKeyToUse;
+        }
+        const scanner = new scanoss_1.Scanner(config);
+        let results = undefined;
+        try {
+            results = await scanner.scanContents({
+                content,
+                key: 'content_scanning',
+            });
+        }
+        catch (e) {
+            console.error('SCANOSS error', e);
+            // map known errors to a more user-friendly message
+            // Invalid API key message
+            if ((_a = e.message) === null || _a === void 0 ? void 0 : _a.includes('Forbidden')) {
+                return {
+                    type: 'error',
+                    message: 'Forbidden: Please check your API key'
+                };
+            }
+            // Rate limit message
+            // HTTP:
+            // HTTP Status code: 503
+            // Server Response:
+            // 503 Unavailable. Check https://osskb.org/limit
+            if ((_b = e.message) === null || _b === void 0 ? void 0 : _b.includes('https://osskb.org/limit')) {
+                return {
+                    type: 'error',
+                    message: 'You have reached the limit of the free data subscription, for a commercial subscription please contact support@scanoss.com'
+                };
+            }
+            return {
+                type: 'error',
+                message: e.message
+            };
+        }
+        if (!results) {
+            return {
+                type: 'error',
+                message: 'Scan request unsuccessful'
+            };
+        }
+        // eslint-disable-next-line no-null/no-null
+        console.log('SCANOSS results', JSON.stringify(results, null, 2));
+        // first result is the best result
+        const firstEntry = results['/content_scanning'][0];
+        if (firstEntry.id === 'none') {
+            return {
+                type: 'clean'
+            };
+        }
+        return {
+            type: 'match',
+            matched: firstEntry.matched,
+            url: firstEntry.url,
+            raw: firstEntry
+        };
+    }
+};
+exports.ScanOSSServiceImpl = ScanOSSServiceImpl;
+exports.ScanOSSServiceImpl = ScanOSSServiceImpl = tslib_1.__decorate([
+    (0, inversify_1.injectable)()
+], ScanOSSServiceImpl);
+//# sourceMappingURL=scanoss-service-impl.js.map

package/lib/node/scanoss-service-impl.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scanoss-service-impl.js","sourceRoot":"","sources":["../../src/node/scanoss-service-impl.ts"],"names":[],"mappings":";AAAA,gFAAgF;AAChF,yCAAyC;AACzC,EAAE;AACF,2EAA2E;AAC3E,mEAAmE;AACnE,wCAAwC;AACxC,EAAE;AACF,4EAA4E;AAC5E,8EAA8E;AAC9E,6EAA6E;AAC7E,yDAAyD;AACzD,uDAAuD;AACvD,EAAE;AACF,gFAAgF;AAChF,gFAAgF;;;;AAEhF,4DAA0D;AAG1D,qCAAgE;AAOhE,6CAA6C;AAC7C,MAAM,mBAAmB;IAAzB;QACY,UAAK,GAAe,OAAO,CAAC,OAAO,EAAgB,CAAC;IAKhE,CAAC;IAJU,KAAK,CAAC,WAAW,CAAC,IAAsB;QAC3C,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC;QAC3C,OAAO,IAAI,CAAC,KAAK,CAAC;IACtB,CAAC;CACJ;AAGM,IAAM,kBAAkB,GAAxB,MAAM,kBAAkB;IAAxB;QAEc,cAAS,GAAG,IAAI,mBAAmB,EAAiB,CAAC;IAuE1E,CAAC;IArEG,KAAK,CAAC,WAAW,CAAC,OAAe,EAAE,MAAe;QAC9C,OAAO,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;IACvF,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,OAAe,EAAE,MAAe;;QAChD,MAAM,MAAM,GAAG,IAAI,oBAAU,EAAE,CAAC;QAChC,MAAM,WAAW,GAAG,MAAM,IAAI,OAAO,CAAC,GAAG,CAAC,eAAe,IAAI,SAAS,CAAC;QACvE,IAAI,WAAW,EAAE,CAAC;YACd,MAAM,CAAC,OAAO,GAAG,WAAW,CAAC;QACjC,CAAC;QACD,MAAM,OAAO,GAAG,IAAI,iBAAO,CAAC,MAAM,CAAC,CAAC;QACpC,IAAI,OAAO,GAAG,SAAS,CAAC;QACxB,IAAI,CAAC;YACD,OAAO,GAAG,MAAO,OAAqC,CAAC,YAAY,CAAC;gBAChE,OAAO;gBACP,GAAG,EAAE,kBAAkB;aAC1B,CAAC,CAAC;QACP,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACT,OAAO,CAAC,KAAK,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC;YAElC,mDAAmD;YAEnD,0BAA0B;YAC1B,IAAI,MAAA,CAAC,CAAC,OAAO,0CAAE,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC;gBACnC,OAAO;oBACH,IAAI,EAAE,OAAO;oBACb,OAAO,EAAE,sCAAsC;iBAClD,CAAC;YACN,CAAC;YACD,qBAAqB;YACrB,QAAQ;YACR,wBAAwB;YACxB,mBAAmB;YACnB,iDAAiD;YACjD,IAAI,MAAA,CAAC,CAAC,OAAO,0CAAE,QAAQ,CAAC,yBAAyB,CAAC,EAAE,CAAC;gBACjD,OAAO;oBACH,IAAI,EAAE,OAAO;oBACb,OAAO,EAAE,4HAA4H;iBACxI,CAAC;YACN,CAAC;YACD,OAAO;gBACH,IAAI,EAAE,OAAO;gBACb,OAAO,EAAE,CAAC,CAAC,OAAO;aACrB,CAAC;QACN,CAAC;QACD,IAAI,CAAC,OAAO,EAAE,CAAC;YACX,OAAO;gBACH,IAAI,EAAE,OAAO;gBACb,OAAO,EAAE,2BAA2B;aACvC,CAAC;QACN,CAAC;QAED,2CAA2C;QAC3C,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;QAEjE,kCAAkC;QAClC,MAAM,UAAU,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAAC;QACnD,IAAI,UAAU,CAAC,EAAE,KAAK,MAAM,EAAE,CAAC;YAC3B,OAAO;gBACH,IAAI,EAAE,OAAO;aAChB,CAAC;QACN,CAAC;QACD,OAAO;YACH,IAAI,EAAE,OAAO;YACb,OAAO,EAAE,UAAU,CAAC,OAAO;YAC3B,GAAG,EAAE,UAAU,CAAC,GAAG;YACnB,GAAG,EAAE,UAAU;SAClB,CAAC;IACN,CAAC;CACJ,CAAA;AAzEY,gDAAkB;6BAAlB,kBAAkB;IAD9B,IAAA,sBAAU,GAAE;GACA,kBAAkB,CAyE9B"}

package/lib/package.spec.d.ts

@@ -0,0 +1 @@
+//# sourceMappingURL=package.spec.d.ts.map

package/lib/package.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"package.spec.d.ts","sourceRoot":"","sources":["../src/package.spec.ts"],"names":[],"mappings":""}

package/lib/package.spec.js

@@ -0,0 +1,26 @@
+// *****************************************************************************
+// Copyright (C) 2024 EclipseSource GmbH and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+/* note: this bogus test file is required so that
+   we are able to run mocha unit tests on this
+   package, without having any actual unit tests in it.
+   This way a coverage report will be generated,
+   showing 0% coverage, instead of no report.
+   This file can be removed once we have real unit
+   tests in place. */
+describe('ai-scanoss package', () => {
+    it('support code coverage statistics', () => true);
+});
+//# sourceMappingURL=package.spec.js.map

package/lib/package.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"package.spec.js","sourceRoot":"","sources":["../src/package.spec.ts"],"names":[],"mappings":"AAAA,gFAAgF;AAChF,oDAAoD;AACpD,EAAE;AACF,2EAA2E;AAC3E,mEAAmE;AACnE,wCAAwC;AACxC,EAAE;AACF,4EAA4E;AAC5E,8EAA8E;AAC9E,6EAA6E;AAC7E,yDAAyD;AACzD,uDAAuD;AACvD,EAAE;AACF,gFAAgF;AAChF,gFAAgF;AAEhF;;;;;;qBAMqB;AAErB,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;IAEhC,EAAE,CAAC,kCAAkC,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC;AACvD,CAAC,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@theia/scanoss",
+  "version": "1.57.0",
+  "description": "Theia - SCANOSS Integration",
+  "dependencies": {
+    "@theia/core": "1.57.0",
+    "scanoss": "^0.15.2"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "theiaExtensions": [
+    {
+      "frontend": "lib/browser/scanoss-frontend-module",
+      "backend": "lib/node/scanoss-backend-module"
+    }
+  ],
+  "keywords": [
+    "theia-extension"
+  ],
+  "license": "EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/eclipse-theia/theia.git"
+  },
+  "bugs": {
+    "url": "https://github.com/eclipse-theia/theia/issues"
+  },
+  "homepage": "https://github.com/eclipse-theia/theia",
+  "files": [
+    "lib",
+    "src"
+  ],
+  "main": "lib/common",
+  "scripts": {
+    "build": "theiaext build",
+    "clean": "theiaext clean",
+    "compile": "theiaext compile",
+    "lint": "theiaext lint",
+    "test": "theiaext test",
+    "watch": "theiaext watch"
+  },
+  "devDependencies": {
+    "@theia/ext-scripts": "1.57.0"
+  },
+  "nyc": {
+    "extends": "../../configs/nyc.json"
+  },
+  "gitHead": "ca1d948d897b9a774f8cd68bb76bd2f335609cd4"
+}

package/src/browser/scanoss-frontend-module.ts

@@ -0,0 +1,28 @@
+// *****************************************************************************
+// Copyright (C) 2024 EclipseSource GmbH.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { ContainerModule } from '@theia/core/shared/inversify';
+import { ScanOSSPreferencesSchema } from './scanoss-preferences';
+import { PreferenceContribution, RemoteConnectionProvider, ServiceConnectionProvider } from '@theia/core/lib/browser';
+import { SCANOSS_SERVICE_PATH, ScanOSSService } from '../common';
+
+export default new ContainerModule(bind => {
+    bind(PreferenceContribution).toConstantValue({ schema: ScanOSSPreferencesSchema });
+    bind(ScanOSSService).toDynamicValue(ctx => {
+        const provider = ctx.container.get<ServiceConnectionProvider>(RemoteConnectionProvider);
+        return provider.createProxy<ScanOSSService>(SCANOSS_SERVICE_PATH);
+    }).inSingletonScope();
+});

package/src/browser/scanoss-preferences.ts

@@ -0,0 +1,31 @@
+// *****************************************************************************
+// Copyright (C) 2024 EclipseSource GmbH.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { PreferenceSchema } from '@theia/core/lib/browser/preferences';
+
+export const SCAN_OSS_API_KEY_PREF = 'SCANOSS.apiKey';
+
+export const ScanOSSPreferencesSchema: PreferenceSchema = {
+    type: 'object',
+    properties: {
+        [SCAN_OSS_API_KEY_PREF]: {
+            type: 'string',
+            markdownDescription: 'Enter an API Key of your SCANOSS  Account. **Please note:** By using this preference the key will be stored in clear text\
+            on the machine running Theia. Use the environment variable `SCANOSS_API_KEY` to set the key securely.',
+            title: 'SCANOSS API Key'
+        }
+    }
+};

package/src/common/index.ts

@@ -0,0 +1,16 @@
+// *****************************************************************************
+// Copyright (C) 2024 EclipseSource GmbH.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+export * from './scanoss-service';

package/src/common/scanoss-service.ts

@@ -0,0 +1,34 @@
+// *****************************************************************************
+// Copyright (C) 2024 EclipseSource GmbH.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+export const SCANOSS_SERVICE_PATH = '/services/scanoss/service';
+export const ScanOSSService = Symbol('ScanOSSService');
+export interface ScanOSSResultClean {
+    type: 'clean';
+}
+export interface ScanOSSResultMatch {
+    type: 'match';
+    matched: string; // e.g. "75%"
+    url: string;
+    raw: unknown;
+}
+export interface ScanOSSResultError {
+    type: 'error';
+    message: string;
+}
+export type ScanOSSResult = ScanOSSResultClean | ScanOSSResultMatch | ScanOSSResultError;
+export interface ScanOSSService {
+    scanContent(content: string, apiKey?: string): Promise<ScanOSSResult>;
+}

package/src/node/scanoss-backend-module.ts

@@ -0,0 +1,28 @@
+// *****************************************************************************
+// Copyright (C) 2024 EclipseSource GmbH.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { ContainerModule } from '@theia/core/shared/inversify';
+import { ConnectionHandler, RpcConnectionHandler } from '@theia/core';
+import { ScanOSSService, SCANOSS_SERVICE_PATH } from '../common';
+import { ScanOSSServiceImpl } from './scanoss-service-impl';
+
+export default new ContainerModule(bind => {
+    bind(ScanOSSServiceImpl).toSelf().inSingletonScope();
+    bind(ScanOSSService).toService(ScanOSSServiceImpl);
+    bind(ConnectionHandler).toDynamicValue(ctx =>
+        new RpcConnectionHandler(SCANOSS_SERVICE_PATH, () => ctx.container.get(ScanOSSService))
+    ).inSingletonScope();
+});

package/src/node/scanoss-service-impl.ts

@@ -0,0 +1,110 @@
+// *****************************************************************************
+// Copyright (C) 2024 EclipseSource GmbH.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { injectable } from '@theia/core/shared/inversify';
+import { ScanOSSResult, ScanOSSService } from '../common';
+
+import { Scanner, ScannerCfg, ScannerComponent } from 'scanoss';
+
+// Define our own type of what is actually returned by the scanner
+interface ScanOSSScanner {
+    scanContents: <T extends string>(options: { content: string; key: T }) => Promise<{ [K in `/${T}`]: ScannerComponent[] } | null>;
+}
+
+// Helper class to perform scans sequentially
+class SequentialProcessor<T> {
+    private queue: Promise<T> = Promise.resolve() as Promise<T>;
+    public async processTask(task: () => Promise<T>): Promise<T> {
+        this.queue = this.queue.then(() => task());
+        return this.queue;
+    }
+}
+
+@injectable()
+export class ScanOSSServiceImpl implements ScanOSSService {
+
+    private readonly processor = new SequentialProcessor<ScanOSSResult>();
+
+    async scanContent(content: string, apiKey?: string): Promise<ScanOSSResult> {
+        return this.processor.processTask(async () => this.doScanContent(content, apiKey));
+    }
+
+    async doScanContent(content: string, apiKey?: string): Promise<ScanOSSResult> {
+        const config = new ScannerCfg();
+        const apiKeyToUse = apiKey || process.env.SCANOSS_API_KEY || undefined;
+        if (apiKeyToUse) {
+            config.API_KEY = apiKeyToUse;
+        }
+        const scanner = new Scanner(config);
+        let results = undefined;
+        try {
+            results = await (scanner as unknown as ScanOSSScanner).scanContents({
+                content,
+                key: 'content_scanning',
+            });
+        } catch (e) {
+            console.error('SCANOSS error', e);
+
+            // map known errors to a more user-friendly message
+
+            // Invalid API key message
+            if (e.message?.includes('Forbidden')) {
+                return {
+                    type: 'error',
+                    message: 'Forbidden: Please check your API key'
+                };
+            }
+            // Rate limit message
+            // HTTP:
+            // HTTP Status code: 503
+            // Server Response:
+            // 503 Unavailable. Check https://osskb.org/limit
+            if (e.message?.includes('https://osskb.org/limit')) {
+                return {
+                    type: 'error',
+                    message: 'You have reached the limit of the free data subscription, for a commercial subscription please contact support@scanoss.com'
+                };
+            }
+            return {
+                type: 'error',
+                message: e.message
+            };
+        }
+        if (!results) {
+            return {
+                type: 'error',
+                message: 'Scan request unsuccessful'
+            };
+        }
+
+        // eslint-disable-next-line no-null/no-null
+        console.log('SCANOSS results', JSON.stringify(results, null, 2));
+
+        // first result is the best result
+        const firstEntry = results['/content_scanning'][0];
+        if (firstEntry.id === 'none') {
+            return {
+                type: 'clean'
+            };
+        }
+        return {
+            type: 'match',
+            matched: firstEntry.matched,
+            url: firstEntry.url,
+            raw: firstEntry
+        };
+    }
+}

package/src/package.spec.ts

@@ -0,0 +1,28 @@
+// *****************************************************************************
+// Copyright (C) 2024 EclipseSource GmbH and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+/* note: this bogus test file is required so that
+   we are able to run mocha unit tests on this
+   package, without having any actual unit tests in it.
+   This way a coverage report will be generated,
+   showing 0% coverage, instead of no report.
+   This file can be removed once we have real unit
+   tests in place. */
+
+describe('ai-scanoss package', () => {
+
+    it('support code coverage statistics', () => true);
+});