@microtronics/studio-cli 0.30.0 → 0.31.0

package/CHANGELOG.md

@@ -1,18 +1,28 @@
 
 
-## 0.30.0 (2025-05-05)
+## 0.31.0 (2025-05-05)
 
 
 ### Features
 
-* **studio-cli:** add support for packaging app projects ([280115f](https://bitbucket.org/microtronics-core/vscode-studio/commits/280115fa77afb78754884a4eb83bd0365ff5b319))
-* **studio-cli:** add support for packaging library projects ([1888df1](https://bitbucket.org/microtronics-core/vscode-studio/commits/1888df1b5d8c2f53a9705756d28d42360109e3ba))
-
-
-### Bug Fixes
-
-* **studio-cli:** ensure dist/dlo directory is created on compile ([f110636](https://bitbucket.org/microtronics-core/vscode-studio/commits/f110636fc5042a5e25cc2d26fc98df4356d706bb))
-* **studio-cli:** rename method in CustomWasmFS ([c3e1a22](https://bitbucket.org/microtronics-core/vscode-studio/commits/c3e1a227d7e57e91f9ddea45f11412ed59f71614))
+* replace tarballjs with @gera2ld/tarjs ([b32454e](https://bitbucket.org/microtronics-core/vscode-studio/commits/b32454e04a5cd8f21ebb1e91f75fbe062fc593d8))
+* **studio-cli:** add package path autodetection with "*" ([868b035](https://bitbucket.org/microtronics-core/vscode-studio/commits/868b03564dc9e3b31eb279d72826b17f1333503b))
+* **studio-cli:** add support for publishing from archive ([79ef977](https://bitbucket.org/microtronics-core/vscode-studio/commits/79ef97783a56ce440e53e82dabd621db65c54637))
+* **studio-cli:** support library publishing from package ([c731637](https://bitbucket.org/microtronics-core/vscode-studio/commits/c731637960a4de698eec5447005287a16b4cf73a))
+
+## 0.30.0 (2025-05-05)
+
+
+### Features
+
+* **studio-cli:** add support for packaging app projects ([280115f](https://bitbucket.org/microtronics-core/vscode-studio/commits/280115fa77afb78754884a4eb83bd0365ff5b319))
+* **studio-cli:** add support for packaging library projects ([1888df1](https://bitbucket.org/microtronics-core/vscode-studio/commits/1888df1b5d8c2f53a9705756d28d42360109e3ba))
+
+
+### Bug Fixes
+
+* **studio-cli:** ensure dist/dlo directory is created on compile ([f110636](https://bitbucket.org/microtronics-core/vscode-studio/commits/f110636fc5042a5e25cc2d26fc98df4356d706bb))
+* **studio-cli:** rename method in CustomWasmFS ([c3e1a22](https://bitbucket.org/microtronics-core/vscode-studio/commits/c3e1a227d7e57e91f9ddea45f11412ed59f71614))
 * **studio-cli:** run dlo compiler relative to the cwd ([110b476](https://bitbucket.org/microtronics-core/vscode-studio/commits/110b4767bda8134aca2781c51f6e06bf800c4c67))
 
 ## 0.29.4 (2025-04-25)

package/dist/studio-cli.d.ts

@@ -2070,7 +2070,7 @@ export declare namespace Library {
      * @param archive
      * @param env
      */
-    export function publishPackage(cwd: URI, fs: LocalFS, token: Registry.AuthToken, archive: Uint8Array, env?: Globals.ENV): Promise<void>;
+    export function publishPackage(token: Registry.AuthToken, manifest: Manifest.Manifest, archive: Uint8Array, env?: Globals.ENV): Promise<void>;
 }
 
 declare interface LocalFS {
@@ -2359,6 +2359,21 @@ export declare namespace Package {
      * @param env
      */
     export function releaseLibrary(cwd: URI, fs: LocalFS, logger: Log.Logger, token: Registry.AuthToken, env: Globals.ENV): Promise<void>;
+    /**
+     * Publishes an archive package to the appropriate library or application registry.
+     *
+     * @param {URI} cwd - The current working directory where the package archive is located.
+     * @param {LocalFS} fs - The file system interface for reading and writing files.
+     * @param {Log.Logger} logger - The logger instance for logging messages during the operation.
+     * @param {Registry.AuthToken} token - The authorization token required for interacting with the registry.
+     * @param {Globals.ENV} env - The global environment settings.
+     * @param {string} packagePath - The relative path to the archive package to be published.
+     * @param {APM.TagPhase} [releasePhase] - An optional release phase for tagging the published version of the application.
+     * @param {Registry.ApiNewApplication['allowedBackends']} [allowedBackends] - An optional list of allowed backends for the published version.
+     *
+     * @return {Promise<void>} A promise that resolves when the publication process completes successfully.
+     */
+    export function publishArchive(cwd: URI, fs: LocalFS, logger: Log.Logger, token: Registry.AuthToken, env: Globals.ENV, packagePath: string, releasePhase?: APM.TagPhase, allowedBackends?: Registry.ApiNewApplication['allowedBackends']): Promise<void>;
     /**
      * Read the projects README.md file
      * validates if the file content is the initial content
@@ -2382,6 +2397,9 @@ export declare namespace Package {
      * @param env
      */
     export function validatePublishSettings(cwd: URI, fs: LocalFS, token: Registry.AuthToken, env: Globals.ENV): Promise<void>;
+    export function readFilesFromTarGz(gzipped: Uint8Array, fileNames: string[]): Promise<{
+        [key: string]: Blob;
+    }>;
 }
 
 declare function parseWarningsAndErrors(cwd: URI, stderr: string[], relatedFile?: URI): Diagnostics.File[];
@@ -4603,9 +4621,10 @@ declare interface paths {
  * @param {string | null} apiToken - The API token for authentication, or null if not applicable.
  * @param {string | undefined} optsAllowedBackends - A semicolon-separated list of allowed backends, or '*' to allow all, or undefined if not specified.
  * @param {APM.TagPhase} optsPhase - The release phase tag associated with the package publishing.
+ * @param {string }packagePath - The path to the package to be published. If not provided, the package will be published using the default settings.
  * @return {Promise<void>} A promise that resolves when the package has been successfully published or rejects with an error if the process fails.
  */
-export declare function publish(cwd: URI, fs: LocalFS, logger: Log.Logger, env: Globals.ENV, apiToken: string | null, optsAllowedBackends: string | undefined, optsPhase?: APM.TagPhase): Promise<void>;
+export declare function publish(cwd: URI, fs: LocalFS, logger: Log.Logger, env: Globals.ENV, apiToken: string | null, optsAllowedBackends: string | undefined, optsPhase?: APM.TagPhase, packagePath?: string): Promise<void>;
 
 export declare namespace Registry {
     export type AuthToken = string | null;

package/out/api.js

@@ -110,13 +110,19 @@ async function parseAllowedBackends(optsAllowedBackends) {
  * @param {string | null} apiToken - The API token for authentication, or null if not applicable.
  * @param {string | undefined} optsAllowedBackends - A semicolon-separated list of allowed backends, or '*' to allow all, or undefined if not specified.
  * @param {APM.TagPhase} optsPhase - The release phase tag associated with the package publishing.
+ * @param {string }packagePath - The path to the package to be published. If not provided, the package will be published using the default settings.
  * @return {Promise<void>} A promise that resolves when the package has been successfully published or rejects with an error if the process fails.
  */
-async function publish(cwd, fs, logger, env, apiToken, optsAllowedBackends, optsPhase) {
+async function publish(cwd, fs, logger, env, apiToken, optsAllowedBackends, optsPhase, packagePath) {
     logger.info('Publishing package...');
     const allowedBackends = await parseAllowedBackends(optsAllowedBackends);
-    await package_1.Package.validatePublishSettings(cwd, fs, apiToken, env);
-    return package_1.Package.release(cwd, fs, logger, env, apiToken, optsPhase, allowedBackends);
+    if (packagePath) {
+        await package_1.Package.publishArchive(cwd, fs, logger, apiToken, env, packagePath, optsPhase, allowedBackends);
+    }
+    else {
+        await package_1.Package.validatePublishSettings(cwd, fs, apiToken, env);
+        return package_1.Package.release(cwd, fs, logger, env, apiToken, optsPhase, allowedBackends);
+    }
 }
 /**
  * Packs the given directory into a deployable package using the specified configuration.

package/out/main.js

@@ -114,9 +114,10 @@ program
     .addOption(optionAllowedBackends)
     .addOption(optionStudioEnv)
     .addOption(optionStudioToken)
+    .option('-i, --packagePath <path>', 'Publish the provided library or app package. Use "*" for autodetection.')
     .action(async (opts) => {
     const { env, token } = getDefaultOptions(opts);
-    main((0, api_1.publish)(cwd, cliFS_1.cliFS, logger, env, token, opts.allowedBackends, opts.phase));
+    main((0, api_1.publish)(cwd, cliFS_1.cliFS, logger, env, token, opts.allowedBackends, opts.phase, opts.packagePath));
 });
 program
     .command('package')

package/out/package/library.js

@@ -6,11 +6,10 @@ const helper_1 = require("../helper");
 var convertBlobToString = helper_1.Helper.convertBlobToString;
 const minimatch_1 = require("minimatch");
 const registryAPI_1 = require("../registryAPI");
-const manifest_1 = require("../manifest");
 const package_1 = require("./package");
 const globals_1 = require("../globals");
+const tarjs_1 = require("@gera2ld/tarjs");
 const pako = require('pako');
-const tarball = require('tarballjs');
 const STUDIO_IGNORE_FILE = '.studioignore';
 //see original list: https://github.com/microsoft/vscode-vsce/blob/main/src/package.ts#L1603
 const defaultIgnore = [
@@ -57,13 +56,13 @@ var Library;
      * @param fs
      */
     async function createArchive(cwd, fs) {
-        const tar = new tarball.TarWriter();
+        const tar = new tarjs_1.TarWriter();
         const filesToPack = await getFilesForArchive(cwd, fs);
         filesToPack.forEach(file => {
-            tar.addFileArrayBuffer(file.name, file.data);
+            tar.addFile(file.name, file.data);
         });
         const tarBuffer = await tar.write();
-        return pako.gzip(tarBuffer);
+        return pako.gzip(await tarBuffer.arrayBuffer());
     }
     Library.createArchive = createArchive;
     /**
@@ -102,13 +101,14 @@ var Library;
      * @param archive
      * @param env
      */
-    async function publishPackage(cwd, fs, token, archive, env = globals_1.Globals.ENV.production) {
-        const { publisher, name, version } = await manifest_1.Manifest.read(cwd, fs);
+    async function publishPackage(token, manifest, archive, env = globals_1.Globals.ENV.production) {
+        const { publisher, name, version } = manifest;
+        const extractedFiles = await package_1.Package.readFilesFromTarGz(archive, ['CHANGELOG.md', 'README.md', 'studio.json']);
         const files = {
-            'CHANGELOG.md': await package_1.Package.getChangelogFile(cwd, fs),
-            'README.md': await package_1.Package.getReadmeFile(cwd, fs, name),
-            'library.tar.gz': archive,
-            'studio.json': await manifest_1.Manifest.readAsBlob(cwd, fs)
+            'CHANGELOG.md': await blobToUint8Array(extractedFiles['CHANGELOG.md']),
+            'README.md': await blobToUint8Array(extractedFiles['README.md']),
+            'studio.json': await blobToUint8Array(extractedFiles['studio.json']),
+            'library.tar.gz': archive
         };
         return await registryAPI_1.Registry.publishLibraryVersion(token, publisher, name, version, files, env);
     }
@@ -159,4 +159,7 @@ async function getIgnoreFile(cwd, fs) {
         return '';
     }
 }
+async function blobToUint8Array(blob) {
+    return new Uint8Array(await blob.arrayBuffer());
+}
 //# sourceMappingURL=library.js.map

package/out/package/package.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Package = void 0;
+exports.readManifestFromArchive = readManifestFromArchive;
 const vscode_uri_1 = require("vscode-uri");
 const helper_1 = require("../helper");
 const defaultFiles_1 = require("../defaultFiles");
@@ -14,8 +15,8 @@ const registryAPI_1 = require("../registryAPI");
 const manifest_1 = require("../manifest");
 const library_1 = require("./library");
 const dfiles_1 = require("../dfiles/dfiles");
+const tarjs_1 = require("@gera2ld/tarjs");
 const pako = require('pako');
-const tarball = require('tarballjs');
 var Package;
 (function (Package) {
     class BuildError extends Error {
@@ -180,10 +181,54 @@ var Package;
     async function releaseLibrary(cwd, fs, logger, token, env) {
         const manifest = await manifest_1.Manifest.read(cwd, fs);
         const archive = await createLibraryPackage(cwd, fs, logger, token, env);
-        await library_1.Library.publishPackage(cwd, fs, token, archive, env);
+        await library_1.Library.publishPackage(token, manifest, archive, env);
         logger.done(`Library "${manifest.publisher}/${manifest.name}" with version "${manifest.version}" published!`);
     }
     Package.releaseLibrary = releaseLibrary;
+    /**
+     * Publishes an archive package to the appropriate library or application registry.
+     *
+     * @param {URI} cwd - The current working directory where the package archive is located.
+     * @param {LocalFS} fs - The file system interface for reading and writing files.
+     * @param {Log.Logger} logger - The logger instance for logging messages during the operation.
+     * @param {Registry.AuthToken} token - The authorization token required for interacting with the registry.
+     * @param {Globals.ENV} env - The global environment settings.
+     * @param {string} packagePath - The relative path to the archive package to be published.
+     * @param {APM.TagPhase} [releasePhase] - An optional release phase for tagging the published version of the application.
+     * @param {Registry.ApiNewApplication['allowedBackends']} [allowedBackends] - An optional list of allowed backends for the published version.
+     *
+     * @return {Promise<void>} A promise that resolves when the publication process completes successfully.
+     */
+    async function publishArchive(cwd, fs, logger, token, env, packagePath, releasePhase, allowedBackends = null) {
+        if (packagePath === '*') {
+            const localManifest = await manifest_1.Manifest.read(cwd, fs);
+            packagePath = `${localManifest.name}-${localManifest.version}.tar.gz`;
+            logger.info(`Publishing detected archive package "${packagePath}"...`);
+        }
+        const archivePath = vscode_uri_1.Utils.joinPath(cwd, packagePath);
+        if (!(await fs.stat(archivePath))) {
+            throw new Error(`Archive package not found: ${archivePath.fsPath}`);
+        }
+        const archive = await fs.readFile(archivePath);
+        const manifest = await readManifestFromArchive(archive);
+        const { publisher, registry, version } = manifest;
+        // add library publishing.
+        if (manifest_1.Manifest.isLibrary(manifest)) {
+            await library_1.Library.publishPackage(token, manifest, archive, env);
+            logger.done(`Library "${publisher}/${manifest.name}" with version "${manifest.version}" published!`);
+        }
+        else {
+            await registryAPI_1.Registry.updateApplicationFile(token, publisher, registry.id, version, 'app.tar.gz', archive, env);
+            // update the version profile
+            await registryAPI_1.Registry.updateExistingApplicationVersion(token, publisher, registry?.id, version, {
+                allowedBackends: allowedBackends || undefined,
+                phase: releasePhase || undefined
+            }, env);
+            logger.info(`Tag "${version}" with phase "${releasePhase}" shared with ${[...(allowedBackends || '')].join(';')}!`);
+            logger.done(`Tag "${version}" with phase "${releasePhase}" published!`);
+        }
+    }
+    Package.publishArchive = publishArchive;
     /**
      * Read the projects README.md file
      * validates if the file content is the initial content
@@ -262,6 +307,22 @@ var Package;
         }
     }
     Package.validatePublishSettings = validatePublishSettings;
+    async function readFilesFromTarGz(gzipped, fileNames) {
+        // Decompress GZ
+        const tarData = pako.ungzip(gzipped);
+        // Parse TAR with tarballjs
+        const tarReader = await tarjs_1.TarReader.load(tarData);
+        const fileList = {};
+        for (const entry of tarReader.fileInfos) {
+            if (fileNames.includes(entry.name)) {
+                // Return file contents as a Buffer
+                fileList[entry.name] = tarReader.getFileBlob(entry.name);
+            }
+        }
+        // File not found
+        return fileList;
+    }
+    Package.readFilesFromTarGz = readFilesFromTarGz;
 })(Package || (exports.Package = Package = {}));
 /**
  * Normalize the selected parts parameter for building.
@@ -389,19 +450,40 @@ async function createAPMPackage(cwd, fs, logger, token, releasePhase, env) {
     return await apm_1.APM.createTag(cwd, fs, releasePhase);
 }
 async function createArchiveFromApmPackage(data) {
-    const tar = new tarball.TarWriter();
+    const tar = new tarjs_1.TarWriter();
     // @ts-ignore .entries is valid on FormData
     for (const [name, value] of data.entries()) {
         if (name === 'tag') {
             const fileNode = value;
-            tar.addTextFile(name, fileNode);
+            tar.addFile(name, fileNode);
         }
         else {
             const fileNode = value;
-            tar.addFileArrayBuffer(name, await fileNode.arrayBuffer());
+            tar.addFile(name, await fileNode.arrayBuffer());
         }
     }
     const tarBuffer = await tar.write();
-    return pako.gzip(tarBuffer);
+    return pako.gzip(await tarBuffer.arrayBuffer());
+}
+async function readManifestFromArchive(archive) {
+    const manifestData = await readFileFromTarGz(archive, ['studio.json', 'src/studio.json']);
+    if (!manifestData) {
+        throw new Error(`Could not find "studio.json" in archive`);
+    }
+    return JSON.parse(await manifestData.text());
+}
+async function readFileFromTarGz(gzipped, possibleFilenames) {
+    // Decompress GZ
+    const tarData = pako.ungzip(gzipped);
+    // Parse TAR with tarballjs
+    const tarReader = await tarjs_1.TarReader.load(tarData);
+    for (const entry of tarReader.fileInfos) {
+        if (possibleFilenames.includes(entry.name)) {
+            // Return file contents as a Buffer
+            return tarReader.getFileBlob(entry.name);
+        }
+    }
+    // File not found
+    return null;
 }
 //# sourceMappingURL=package.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@microtronics/studio-cli",
-	"version": "0.30.0",
+	"version": "0.31.0",
 	"description": "Microtronics Studio CLI Tool",
 	"main": "./out/api.js",
 	"typings": "./dist/studio-cli.d.ts",
@@ -41,7 +41,7 @@
 		"openapi-fetch": "^0.13.0",
 		"pako": "^2.1.0",
 		"semver": "^7.6.3",
-		"tarballjs": "github:ankitrohatgi/tarballjs",
+		"@gera2ld/tarjs": "^0.3.1",
 		"tinytar-fix": "^0.1.1",
 		"update-notifier": "^7.3.1",
 		"vscode-uri": "^3.0.8",