trm-core 7.5.4 → 8.0.0

package/dist/registry/FileSystem.js

@@ -78,47 +78,46 @@ class FileSystem {
         return __awaiter(this, void 0, void 0, function* () {
             if (this._filePath) {
                 return {
-                    authenticationType: trm_registry_types_1.AuthenticationType.NO_AUTH,
-                    wallMessage: {
-                        text: `File system: "${this.name}", "${this.endpoint}"`,
-                        type: trm_registry_types_1.MessageType.INFO
-                    }
+                    authentication_type: trm_registry_types_1.AuthenticationType.NO_AUTH,
+                    messages: [{
+                            text: `File system: "${this.name}", "${this.endpoint}"`,
+                            type: trm_registry_types_1.MessageType.INFO
+                        }]
                 };
             }
-            return null;
+            throw new Error(`Missing file path!`);
         });
     }
     whoAmI() {
         return __awaiter(this, void 0, void 0, function* () {
             if (this._filePath) {
                 return {
-                    username: (0, os_1.userInfo)().username
+                    user: (0, os_1.userInfo)().username
                 };
             }
-            return null;
+            throw new Error(`Missing file path!`);
         });
     }
-    packageExists(name, version) {
+    getPackage(fullName, version) {
         return __awaiter(this, void 0, void 0, function* () {
             if (this._filePath) {
-                return false;
+                return {
+                    name: fullName,
+                    latest: version,
+                    versions: [],
+                    yanked_versions: [],
+                    deprecated: false,
+                    manifest: null,
+                    checksum: null,
+                    download_link: this._filePath
+                };
             }
-            return null;
+            throw new Error(`File system can't view packages!`);
         });
     }
-    view(name_1) {
-        return __awaiter(this, arguments, void 0, function* (name, version = 'latest') {
-            if (this._filePath) {
-                const userAuthorizations = {
-                    canCreateReleases: true
-                };
-                var error = new Error(`File system can't view packages!`);
-                error.response = {
-                    userAuthorizations
-                };
-                throw error;
-            }
-            return null;
+    downloadArtifact(fullName, version) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return new trmPackage_1.TrmArtifact((0, fs_1.readFileSync)(this._filePath));
         });
     }
     getArtifact(name_1) {
@@ -135,30 +134,32 @@ class FileSystem {
                     throw new Error(`File system couldn't read package`);
                 }
             }
-            return null;
+            throw new Error(`Missing file path!`);
         });
     }
-    publishArtifact(packageName, version, artifact, readme) {
+    validatePublish(fullName, version) {
+        return __awaiter(this, void 0, void 0, function* () {
+        });
+    }
+    publish(fullName, version, artifact, readme) {
         return __awaiter(this, void 0, void 0, function* () {
             if (this._filePath) {
-                return (0, promises_1.writeFile)(this._filePath, artifact.binary, {
+                yield (0, promises_1.writeFile)(this._filePath, artifact.binary, {
                     flag: 'w'
                 });
+                return this.getPackage(fullName, version);
             }
-            return null;
+            throw new Error(`Missing file path!`);
         });
     }
-    unpublish(packageName, version) {
+    unpublish(fullName, version) {
         return __awaiter(this, void 0, void 0, function* () {
             throw new Error(`File system can't delete packages!`);
         });
     }
-    getReleases(packageName, versionRange) {
+    deprecate(fullName, version, reason) {
         return __awaiter(this, void 0, void 0, function* () {
-            if (this._filePath) {
-                return [];
-            }
-            return null;
+            throw new Error(`File system can't deprecate packages!`);
         });
     }
 }

package/dist/registry/RegistryProvider.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RegistryProvider = void 0;
 const FileSystem_1 = require("./FileSystem");
-const Registry_1 = require("./Registry");
+const RegistryV2_1 = require("./RegistryV2");
 const RegistryType_1 = require("./RegistryType");
 var RegistryProvider;
 (function (RegistryProvider) {
@@ -12,10 +12,10 @@ var RegistryProvider;
         if (endpoint) {
             endpoint = endpoint.toLowerCase().trim();
         }
-        if (!endpoint || endpoint === Registry_1.PUBLIC_RESERVED_KEYWORD) {
+        if (!endpoint || endpoint === RegistryV2_1.PUBLIC_RESERVED_KEYWORD) {
             foundRegistry = RegistryProvider.registry.find(o => o.getRegistryType() === RegistryType_1.RegistryType.PUBLIC);
             if (!foundRegistry) {
-                foundRegistry = new Registry_1.Registry(Registry_1.PUBLIC_RESERVED_KEYWORD);
+                foundRegistry = new RegistryV2_1.RegistryV2(RegistryV2_1.PUBLIC_RESERVED_KEYWORD);
                 RegistryProvider.registry.push(foundRegistry);
             }
         }
@@ -25,7 +25,7 @@ var RegistryProvider;
         else {
             foundRegistry = RegistryProvider.registry.find(o => o.endpoint === endpoint);
             if (!foundRegistry) {
-                foundRegistry = new Registry_1.Registry(endpoint, endpoint);
+                foundRegistry = new RegistryV2_1.RegistryV2(endpoint, endpoint);
                 RegistryProvider.registry.push(foundRegistry);
             }
         }

package/dist/registry/{Registry.d.ts → RegistryV2.d.ts}

@@ -1,17 +1,18 @@
 import { RegistryType } from "./RegistryType";
-import { Ping, Release, View, WhoAmI } from "trm-registry-types";
+import { Package, Ping, WhoAmI } from "trm-registry-types";
 import { TrmArtifact } from "../trmPackage/TrmArtifact";
 import { AbstractRegistry } from "./AbstractRegistry";
 export declare const PUBLIC_RESERVED_KEYWORD = "public";
-export declare class Registry implements AbstractRegistry {
+export declare class RegistryV2 implements AbstractRegistry {
     endpoint: string;
     name: string;
+    private _cache;
     private _registryType;
     private _axiosInstance;
     private _authData;
-    private _ping;
-    private _whoami;
+    private _userAgent;
     constructor(endpoint: string, name?: string);
+    private getDefaultAxiosHeaders;
     compare(registry: AbstractRegistry): boolean;
     getRegistryType(): RegistryType;
     authenticate(defaultData?: any): Promise<AbstractRegistry>;
@@ -21,10 +22,10 @@ export declare class Registry implements AbstractRegistry {
     getAuthData(): any;
     ping(): Promise<Ping>;
     whoAmI(): Promise<WhoAmI>;
-    packageExists(name: string, version?: string): Promise<boolean>;
-    view(name: string, version?: string): Promise<View>;
-    getArtifact(name: string, version?: string): Promise<TrmArtifact>;
-    publishArtifact(packageName: string, version: string, artifact: TrmArtifact, readme?: string): Promise<void>;
-    unpublish(packageName: string, version: string): Promise<void>;
-    getReleases(packageName: string, versionRange: string): Promise<Release[]>;
+    getPackage(fullName: string, version?: string): Promise<Package>;
+    downloadArtifact(fullName: string, version?: string): Promise<TrmArtifact>;
+    validatePublish(fullName: string, version?: string): Promise<void>;
+    publish(fullName: string, version: string, artifact: TrmArtifact, readme?: string): Promise<Package>;
+    unpublish(fullName: string, version: string): Promise<void>;
+    deprecate(fullName: string, version: string, reason: string): Promise<void>;
 }

package/dist/registry/{Registry.js → RegistryV2.js}

@@ -45,7 +45,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Registry = exports.PUBLIC_RESERVED_KEYWORD = void 0;
+exports.RegistryV2 = exports.PUBLIC_RESERVED_KEYWORD = void 0;
 const RegistryType_1 = require("./RegistryType");
 const normalize_url_1 = __importDefault(require("@esm2cjs/normalize-url"));
 const axios_1 = require("axios");
@@ -57,12 +57,14 @@ const crypto_1 = require("crypto");
 const protocol_1 = require("../protocol");
 const opener_1 = __importDefault(require("opener"));
 const commons_1 = require("../commons");
-const AXIOS_CTX = "Registry";
+const node_cache_1 = __importDefault(require("node-cache"));
+const AXIOS_CTX = "RegistryV2";
 exports.PUBLIC_RESERVED_KEYWORD = 'public';
-class Registry {
+class RegistryV2 {
     constructor(endpoint, name = 'Unknown') {
         this.endpoint = endpoint;
         this.name = name;
+        this._cache = new node_cache_1.default({ stdTTL: 60, useClones: false });
         var envEndpoint = process.env.TRM_PUBLIC_REGISTRY_ENDPOINT;
         trm_commons_1.Logger.log(`TRM_PUBLIC_REGISTRY_ENDPOINT Environment variable: ${envEndpoint}`, true);
         if (!envEndpoint || envEndpoint.trim().toLowerCase() === exports.PUBLIC_RESERVED_KEYWORD) {
@@ -92,11 +94,23 @@ class Registry {
             throw new Error(`Registry address length is too long! Maximum allowed is 100.`);
         }
         this._axiosInstance = (0, commons_1.getAxiosInstance)({
-            baseURL: this.endpoint
+            baseURL: this.endpoint,
+            headers: this.getDefaultAxiosHeaders()
         }, AXIOS_CTX);
     }
+    getDefaultAxiosHeaders() {
+        var axiosHeaders = new axios_1.AxiosHeaders();
+        if (!this._userAgent) {
+            try {
+                this._userAgent = `trm-core v${(0, commons_1.getNodePackage)().version}`;
+            }
+            catch (_a) { }
+        }
+        axiosHeaders.setUserAgent(this._userAgent || `trm-core`);
+        return axiosHeaders;
+    }
     compare(registry) {
-        if (registry instanceof Registry) {
+        if (registry instanceof RegistryV2) {
             return this.endpoint === registry.endpoint;
         }
         else {
@@ -110,25 +124,25 @@ class Registry {
         return __awaiter(this, arguments, void 0, function* (defaultData = {}) {
             trm_commons_1.Logger.log(`Registry authentication request`, true);
             const ping = yield this.ping();
-            trm_commons_1.Logger.log(`Registry authentication type is: ${ping.authenticationType}`, true);
-            if (ping.authenticationType !== trm_registry_types_1.AuthenticationType.NO_AUTH) {
-                if (ping.authenticationType === trm_registry_types_1.AuthenticationType.BASIC) {
+            trm_commons_1.Logger.log(`Registry authentication type is: ${ping.authentication_type}`, true);
+            if (ping.authentication_type !== trm_registry_types_1.AuthenticationType.NO_AUTH) {
+                if (ping.authentication_type === trm_registry_types_1.AuthenticationType.BASIC) {
                     yield this._basicAuth(defaultData);
                 }
-                if (ping.authenticationType === trm_registry_types_1.AuthenticationType.OAUTH2) {
+                if (ping.authentication_type === trm_registry_types_1.AuthenticationType.OAUTH2) {
                     yield this._oauth2(defaultData);
                 }
-                if (ping.authenticationType === trm_registry_types_1.AuthenticationType.TOKEN) {
+                if (ping.authentication_type === trm_registry_types_1.AuthenticationType.TOKEN) {
                     yield this._tokenAuth(defaultData);
                 }
             }
-            this._whoami = null;
+            this._cache.flushAll();
             return this;
         });
     }
     _basicAuth() {
         return __awaiter(this, arguments, void 0, function* (defaultData = {}) {
-            var axiosHeaders = new axios_1.AxiosHeaders();
+            var axiosHeaders = this.getDefaultAxiosHeaders();
             var axiosDefaults = {
                 baseURL: this.endpoint,
                 headers: axiosHeaders
@@ -166,7 +180,7 @@ class Registry {
     }
     _tokenAuth() {
         return __awaiter(this, arguments, void 0, function* (defaultData = {}) {
-            var axiosHeaders = new axios_1.AxiosHeaders();
+            var axiosHeaders = this.getDefaultAxiosHeaders();
             var axiosDefaults = {
                 baseURL: this.endpoint,
                 headers: axiosHeaders
@@ -186,7 +200,7 @@ class Registry {
                     when: !token
                 }]);
             token = token || inq1.token;
-            axiosHeaders.setAuthorization(`token ${token}`);
+            axiosHeaders.setAuthorization(`Bearer ${token}`);
             this._axiosInstance = (0, commons_1.getAxiosInstance)(axiosDefaults, AXIOS_CTX);
             this._authData = {
                 token
@@ -248,13 +262,13 @@ class Registry {
                 runAuthFlow = true;
             }
             if (runAuthFlow) {
-                const oAuth2 = ping.authenticationData;
+                const oAuth2 = ping.authentication_data;
                 const oAuth2ProtocolPath = "//oauth2";
                 const sRedirectUri = `trm:${oAuth2ProtocolPath}`;
-                const oAuth2Url = new URL(oAuth2.authorizationUrl);
+                const oAuth2Url = new URL(oAuth2.authorization_url);
                 const oAuth2State = (0, crypto_1.randomUUID)();
-                oAuth2Url.searchParams.append("client_id", oAuth2.clientId);
-                oAuth2Url.searchParams.append("response_type", oAuth2.responseType);
+                oAuth2Url.searchParams.append("client_id", oAuth2.client_id);
+                oAuth2Url.searchParams.append("response_type", oAuth2.response_type);
                 oAuth2Url.searchParams.append("redirect_uri", sRedirectUri);
                 oAuth2Url.searchParams.append("state", oAuth2State);
                 var sAuth2Url = oAuth2Url.toString();
@@ -291,7 +305,7 @@ class Registry {
                 }
             }
             this._authData = authData;
-            var axiosHeaders = new axios_1.AxiosHeaders();
+            var axiosHeaders = this.getDefaultAxiosHeaders();
             var axiosDefaults = {
                 baseURL: this.endpoint,
                 headers: axiosHeaders
@@ -305,97 +319,155 @@ class Registry {
     }
     ping() {
         return __awaiter(this, void 0, void 0, function* () {
-            if (!this._ping) {
+            var data = this._cache.get('ping');
+            if (!data) {
                 try {
-                    this._ping = (yield this._axiosInstance.get('/')).data;
+                    data = (yield this._axiosInstance.get('/', {
+                        headers: {}
+                    })).data;
                 }
                 catch (e) {
-                    throw new Error('Registry cannot be reached.');
+                    if (e.errors) {
+                        e.errors.forEach(err => trm_commons_1.Logger.error(err.message));
+                    }
+                    data = new Error(`Registry "${this.name}" cannot be reached.`);
                 }
+                this._cache.set('ping', data);
+            }
+            if (data instanceof Error) {
+                throw data;
+            }
+            else {
+                return data;
             }
-            return this._ping;
         });
     }
     whoAmI() {
         return __awaiter(this, void 0, void 0, function* () {
-            if (!this._whoami) {
-                this._whoami = (yield this._axiosInstance.get('/whoami')).data;
+            var data = this._cache.get('whoami');
+            if (!data) {
+                try {
+                    data = (yield this._axiosInstance.get('/whoami')).data;
+                }
+                catch (e) {
+                    data = e;
+                }
+                this._cache.set('whoami', data);
+            }
+            if (data instanceof Error) {
+                throw data;
+            }
+            else {
+                return data;
             }
-            return this._whoami;
         });
     }
-    packageExists(name, version) {
-        return __awaiter(this, void 0, void 0, function* () {
-            var responseStatus;
-            try {
-                responseStatus = (yield this._axiosInstance.get('/view', {
-                    params: {
-                        name,
-                        version
+    getPackage(fullName_1) {
+        return __awaiter(this, arguments, void 0, function* (fullName, version = 'latest') {
+            var data = this._cache.get(`package-${fullName}-${version}`);
+            if (!data) {
+                var ttl;
+                try {
+                    data = (yield this._axiosInstance.get(`/package/${fullName}`, {
+                        params: {
+                            version
+                        }
+                    })).data;
+                    if (data.download_link_expiry) {
+                        try {
+                            ttl = Math.max(0, Math.floor((data.download_link_expiry - Date.now()) / 1000));
+                        }
+                        catch (_a) { }
                     }
-                })).status;
+                }
+                catch (e) {
+                    data = e;
+                }
+                this._cache.set(`package-${fullName}-${version}`, data, ttl);
+            }
+            if (data instanceof Error) {
+                throw data;
+            }
+            else {
+                return data;
+            }
+        });
+    }
+    downloadArtifact(fullName_1) {
+        return __awaiter(this, arguments, void 0, function* (fullName, version = 'latest') {
+            var buffer;
+            const packageData = yield this.getPackage(fullName, version);
+            try {
+                buffer = (yield this._axiosInstance.get(packageData.download_link, {
+                    headers: {
+                        'Accept': 'application/octet-stream',
+                    },
+                    maxRedirects: 10,
+                    responseType: 'arraybuffer',
+                    validateStatus: s => s >= 200 && s < 400,
+                })).data;
             }
             catch (e) {
-                responseStatus = 404;
+                trm_commons_1.Logger.error(e.toString(), true);
+                trm_commons_1.Logger.error(`Failed to fetch package at ${packageData.download_link}: ${e.message}`);
+                throw e;
             }
-            return responseStatus === 200;
+            return new TrmArtifact_1.TrmArtifact(buffer);
         });
     }
-    view(name_1) {
-        return __awaiter(this, arguments, void 0, function* (name, version = 'latest') {
-            const response = (yield this._axiosInstance.get('/view', {
+    validatePublish(fullName_1) {
+        return __awaiter(this, arguments, void 0, function* (fullName, version = 'latest') {
+            const status = (yield this._axiosInstance.get(`/publish/check/${fullName}`, {
                 params: {
-                    name,
                     version
                 }
-            })).data;
-            return response;
+            })).status;
+            if (status !== 204) {
+                throw new Error(`Package cannot be published`);
+            }
         });
     }
-    getArtifact(name_1) {
-        return __awaiter(this, arguments, void 0, function* (name, version = 'latest') {
-            const response = (yield this._axiosInstance.get('/install', {
+    publish(fullName, version, artifact, readme) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const fileName = `${fullName}_v${version}`.replace('.', '_') + '.trm';
+            const formData = new FormData.default();
+            formData.append('artifact', artifact.binary, {
+                filename: fileName,
+                contentType: 'application/octet-stream'
+            });
+            if (readme) {
+                formData.append('readme', Buffer.from(readme), {
+                    filename: 'readme.md',
+                    contentType: 'text/markdown'
+                });
+            }
+            return (yield this._axiosInstance.post(`/publish/${fullName}`, formData, {
                 params: {
-                    name,
                     version
                 },
-                headers: {
-                    'Accept': 'application/octet-stream'
-                },
-                responseType: 'arraybuffer'
-            })).data;
-            return new TrmArtifact_1.TrmArtifact(response);
-        });
-    }
-    publishArtifact(packageName, version, artifact, readme) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const fileName = `${packageName}@${version}`.replace('.', '_') + '.trm';
-            const formData = new FormData.default();
-            formData.append('artifact', artifact.binary, fileName);
-            formData.append('readme', readme);
-            yield this._axiosInstance.post('/publish', formData, {
                 headers: formData.getHeaders()
-            });
+            })).data;
         });
     }
-    unpublish(packageName, version) {
+    unpublish(fullName, version) {
         return __awaiter(this, void 0, void 0, function* () {
-            yield this._axiosInstance.post('/unpublish', {
-                package: packageName,
-                version
+            yield this._axiosInstance.post(`/unpublish/${fullName}`, null, {
+                params: {
+                    version
+                }
             });
         });
     }
-    getReleases(packageName, versionRange) {
+    deprecate(fullName, version, reason) {
         return __awaiter(this, void 0, void 0, function* () {
-            const response = (yield this._axiosInstance.get('/releases', {
+            yield this._axiosInstance.post(`/deprecate/${fullName}`, {
+                deprecate_note: reason
+            }, {
                 params: {
-                    name: packageName,
-                    version: versionRange
+                    version
                 }
-            })).data;
-            return response;
+            });
         });
     }
 }
-exports.Registry = Registry;
+exports.RegistryV2 = RegistryV2;

package/dist/registry/index.d.ts

@@ -1,4 +1,4 @@
-export * from "./Registry";
+export * from "./RegistryV2";
 export * from "./RegistryType";
 export * from "./AbstractRegistry";
 export * from "./FileSystem";

package/dist/registry/index.js

@@ -14,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./Registry"), exports);
+__exportStar(require("./RegistryV2"), exports);
 __exportStar(require("./RegistryType"), exports);
 __exportStar(require("./AbstractRegistry"), exports);
 __exportStar(require("./FileSystem"), exports);

package/dist/systemConnector/ISystemConnectorBase.d.ts

@@ -6,7 +6,7 @@ import { TrmPackage } from "../trmPackage";
 import { InstallPackage } from "./InstallPackage";
 export interface ISystemConnectorBase {
     getTransportStatus: (trkorr: components.TRKORR) => Promise<string>;
-    getPackageWorkbenchTransport: (oPackage: TrmPackage) => Promise<Transport>;
+    getWbTransports: (trmPackage?: string | TrmPackage) => Promise<Transport[]>;
     getSourceTrkorr: () => Promise<components.TRKORR[]>;
     getIgnoredTrkorr: () => Promise<components.TRKORR[]>;
     getObject: (pgmid: components.PGMID, object: components.TROBJTYPE, objName: components.SOBJ_NAME) => Promise<struct.TADIR>;

package/dist/systemConnector/SystemConnector.d.ts

@@ -19,7 +19,7 @@ export declare namespace SystemConnector {
     function closeConnection(): Promise<void>;
     function checkConnection(): Promise<boolean>;
     function getTransportStatus(trkorr: TRKORR): Promise<string>;
-    function getPackageWorkbenchTransport(oPackage: TrmPackage): Promise<Transport>;
+    function getWbTransports(trmPackage?: string | TrmPackage): Promise<Transport[]>;
     function getInstalledPackages(includeSources: boolean, refresh?: boolean, includeLocals?: boolean): Promise<TrmPackage[]>;
     function getDevclass(devclass: DEVCLASS): Promise<TDEVC>;
     function getTransportTargets(): Promise<TMSCSYS[]>;

package/dist/systemConnector/SystemConnector.js

@@ -79,13 +79,13 @@ var SystemConnector;
         });
     }
     SystemConnector.getTransportStatus = getTransportStatus;
-    function getPackageWorkbenchTransport(oPackage) {
+    function getWbTransports(trmPackage) {
         return __awaiter(this, void 0, void 0, function* () {
             yield checkSystemConnector();
-            return SystemConnector.systemConnector.getPackageWorkbenchTransport(oPackage);
+            return SystemConnector.systemConnector.getWbTransports(trmPackage);
         });
     }
-    SystemConnector.getPackageWorkbenchTransport = getPackageWorkbenchTransport;
+    SystemConnector.getWbTransports = getWbTransports;
     function getInstalledPackages(includeSources, refresh, includeLocals) {
         return __awaiter(this, void 0, void 0, function* () {
             yield checkSystemConnector();

package/dist/systemConnector/SystemConnectorBase.d.ts

@@ -29,7 +29,7 @@ export declare abstract class SystemConnectorBase implements ISystemConnectorBas
     protected abstract getInstalledPackagesBackend(): Promise<struct.ZTY_TRM_PACKAGE[]>;
     constructor();
     getTransportStatus(trkorr: TRKORR): Promise<string>;
-    getPackageWorkbenchTransport(oPackage: TrmPackage): Promise<Transport>;
+    getWbTransports(trmPackage?: string | TrmPackage): Promise<Transport[]>;
     getSourceTrkorr(refresh?: boolean): Promise<TRKORR[]>;
     getObject(pgmid: PGMID, object: TROBJTYPE, objName: SOBJ_NAME): Promise<TADIR>;
     getIgnoredTrkorr(refresh?: boolean): Promise<TRKORR[]>;