@sap-ux/fiori-migration-writer 0.0.0-stage → 0.0.2

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,79 @@
-# Temporary Holding Version
+[![Changelog](https://img.shields.io/badge/changelog-8A2BE2)](https://github.com/SAP/open-ux-tools/blob/main/packages/fiori-migration-writer/CHANGELOG.md) [![Github repo](https://img.shields.io/badge/github-repo-blue)](https://github.com/SAP/open-ux-tools/tree/main/packages/fiori-migration-writer)
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+# [`@sap-ux/fiori-migration-writer`](https://github.com/SAP/open-ux-tools/tree/main/packages/fiori-migration-writer)
+
+Writer module for migrating Fiori applications from legacy WebIDE format to modern Fiori tools format.
+
+## Overview
+
+This package provides migration capabilities to convert legacy SAP WebIDE Fiori projects to the modern SAP Fiori tools format. It handles:
+
+- Project structure transformation
+- Configuration file updates (manifest.json, ui5.yaml, package.json)
+- Template file generation
+- TypeScript setup for migrated projects
+- Launch configuration generation
+
+## Installation
+
+```bash
+npm install @sap-ux/fiori-migration-writer
+```
+
+## Usage
+
+```typescript
+import { ProjectMigrator, createMemFsEditor } from '@sap-ux/fiori-migration-writer';
+
+// Create a mem-fs editor instance
+const fs = createMemFsEditor();
+
+// Migrate a project
+const { fs: updatedFs, result, messages } = await ProjectMigrator.migrate(
+    '/path/to/project',
+    'https://backend.example.com',
+    'https://ui5.sap.com',
+    undefined, // optional project info
+    undefined, // optional vscode context
+    false,     // internal toggle
+    fs         // optional fs editor
+);
+
+// Commit changes to disk
+await new Promise((resolve, reject) => {
+    updatedFs.commit((err) => {
+        if (err) reject(err);
+        else resolve();
+    });
+});
+
+// Check results
+if (result) {
+    console.log('Migration successful!');
+} else {
+    console.error('Migration failed:', messages);
+}
+```
+
+### Bulk Migration
+
+```typescript
+import { BulkProjectMigrator } from '@sap-ux/fiori-migration-writer';
+
+const migrator = new BulkProjectMigrator();
+const results = await migrator.migrate(
+    [
+        { rootPath: '/path/to/project1', hostname: 'https://backend.example.com' },
+        { rootPath: '/path/to/project2', hostname: 'https://backend.example.com' }
+    ],
+    'https://ui5.sap.com'
+);
+```
+
+## API
+
+See TypeScript definitions for full API documentation.
+
+## License
+
+Apache-2.0

package/dist/BulkProjectMigrator.d.ts

@@ -0,0 +1,56 @@
+import type { MigrationUIProjectInfo } from './types.js';
+export declare class BulkProjectMigrator {
+    /**
+     * Migrate projects
+     *
+     * @param projects
+     * @param ui5SnapshotUrl
+     * @param vscode
+     * @param internalToggle
+     */
+    migrate(projects: MigrationUIProjectInfo[], ui5SnapshotUrl: string, vscode?: any, internalToggle?: boolean): Promise<MigrationUIProjectInfo[]>;
+    /**
+     * Migrate a single project
+     *
+     * @param project
+     * @param index
+     * @param ui5SnapshotUrl
+     * @param vscode
+     * @param internalToggle
+     */
+    private migrateProject;
+    /**
+     * Add project folder to VS Code workspace if not already present
+     *
+     * @param rootPath
+     * @param vscode
+     */
+    private addProjectToWorkspace;
+    /**
+     * Build migration result with status and messages
+     *
+     * @param project
+     * @param result
+     * @param result.result
+     * @param result.messages
+     * @param markName
+     */
+    private buildMigrationResult;
+    /**
+     * Determine migration status based on result and messages.
+     *
+     * Note: A successful migration (result.result === true) may still return 'ERROR' status
+     * if the messages array contains ERROR-severity entries for non-fatal issues that were
+     * logged during migration but didn't prevent file generation. Callers should check both
+     * the result.result field (did migration complete?) and status (were there issues?).
+     *
+     * @param result - Migration result object
+     * @param result.result - Whether migration completed successfully
+     * @param result.messages - Array of messages generated during migration
+     * @returns 'ERROR' if result is false OR messages contain errors,
+     *          'WARNING' if result is true and messages contain warnings but no errors,
+     *          'SUCCESS' if result is true and no errors or warnings
+     */
+    private determineStatus;
+}
+//# sourceMappingURL=BulkProjectMigrator.d.ts.map

package/dist/BulkProjectMigrator.js

@@ -0,0 +1,162 @@
+import { ProjectMigrator } from './ProjectMigrator.js';
+import { URI } from 'vscode-uri';
+import { i18nText } from './i18n.js';
+import { createMemFsEditor } from './utils/fs-adapter.js';
+// Telemetry stub - @sap-ux/telemetry is an optional dependency for performance measurement
+// This provides a no-op implementation for open-source usage
+const uxTelemetryPerf = {
+    startMark: (name) => name,
+    endMark: (_name) => { },
+    measure: (_name) => { },
+    getMeasurementDuration: (_name) => 0
+};
+export class BulkProjectMigrator {
+    /**
+     * Migrate projects
+     *
+     * @param projects
+     * @param ui5SnapshotUrl
+     * @param vscode
+     * @param internalToggle
+     */
+    async migrate(projects, ui5SnapshotUrl, vscode, internalToggle = false) {
+        // Migrate projects sequentially to avoid mem-fs adapter races
+        // The shared module-global mem-fs adapter is enabled/disabled per migration
+        const results = [];
+        for (const [index, project] of (projects ?? []).entries()) {
+            try {
+                results.push(await this.migrateProject(project, index, ui5SnapshotUrl, vscode, internalToggle)); // NOSONAR: Sequential migration required to prevent mem-fs adapter race conditions
+            }
+            catch (error) {
+                // Catch per-project errors to allow remaining projects to be processed
+                results.push({
+                    ...project,
+                    status: 'ERROR',
+                    messages: [{ type: 'ERROR', description: error instanceof Error ? error.message : String(error) }]
+                });
+            }
+        }
+        return results;
+    }
+    /**
+     * Migrate a single project
+     *
+     * @param project
+     * @param index
+     * @param ui5SnapshotUrl
+     * @param vscode
+     * @param internalToggle
+     */
+    async migrateProject(project, index, ui5SnapshotUrl, vscode, internalToggle) {
+        const markName = uxTelemetryPerf.startMark('project' + index);
+        // Create editor here and pass explicitly so ownsEditor is false inside ProjectMigrator.migrate
+        // This prevents double-commit (migrate() won't auto-commit when editor is passed)
+        const editor = createMemFsEditor();
+        const { fs, result, messages } = await ProjectMigrator.migrate({
+            projectRoot: project.rootPath,
+            baseUri: project.hostname,
+            ui5SnapshotUrl,
+            importProjectInfo: project,
+            vscode,
+            internalToggle,
+            fs: editor
+        });
+        // Commit changes to disk for this project
+        if (result) {
+            try {
+                await new Promise((resolve, reject) => {
+                    fs.commit((err) => {
+                        if (err) {
+                            reject(err);
+                        }
+                        else {
+                            resolve();
+                        }
+                    });
+                });
+            }
+            catch (error) {
+                // Handle both callback errors and synchronous throws from fs.commit
+                throw new Error(`Failed to commit migration changes: ${error instanceof Error ? error.message : String(error)}`);
+            }
+        }
+        uxTelemetryPerf.endMark(markName);
+        uxTelemetryPerf.measure(markName);
+        this.addProjectToWorkspace(project.rootPath, vscode);
+        return this.buildMigrationResult(project, { result, messages }, markName);
+    }
+    /**
+     * Add project folder to VS Code workspace if not already present
+     *
+     * @param rootPath
+     * @param vscode
+     */
+    addProjectToWorkspace(rootPath, vscode) {
+        if (!vscode?.workspace?.workspaceFile) {
+            return;
+        }
+        const uri = URI.file(rootPath);
+        if (!vscode.workspace.getWorkspaceFolder(uri)) {
+            const folderCount = vscode.workspace.workspaceFolders?.length ?? 0;
+            vscode.workspace.updateWorkspaceFolders(folderCount, null, { uri });
+        }
+    }
+    /**
+     * Build migration result with status and messages
+     *
+     * @param project
+     * @param result
+     * @param result.result
+     * @param result.messages
+     * @param markName
+     */
+    buildMigrationResult(project, result, markName) {
+        const messages = [...result.messages];
+        const migrationResult = {
+            ...project,
+            migrationTime: uxTelemetryPerf.getMeasurementDuration(markName),
+            status: this.determineStatus(result),
+            messages
+        };
+        if (result.result === true) {
+            messages.unshift({
+                type: 'SUCCESS',
+                description: i18nText('SUCCESSFULLY_MIGRATED_MSG')
+            });
+        }
+        return migrationResult;
+    }
+    /**
+     * Determine migration status based on result and messages.
+     *
+     * Note: A successful migration (result.result === true) may still return 'ERROR' status
+     * if the messages array contains ERROR-severity entries for non-fatal issues that were
+     * logged during migration but didn't prevent file generation. Callers should check both
+     * the result.result field (did migration complete?) and status (were there issues?).
+     *
+     * @param result - Migration result object
+     * @param result.result - Whether migration completed successfully
+     * @param result.messages - Array of messages generated during migration
+     * @returns 'ERROR' if result is false OR messages contain errors,
+     *          'WARNING' if result is true and messages contain warnings but no errors,
+     *          'SUCCESS' if result is true and no errors or warnings
+     */
+    determineStatus(result) {
+        // If migration result is false, it's definitely an error
+        if (result.result === false) {
+            return 'ERROR';
+        }
+        // Migration succeeded (result.result === true), now check message severity
+        if (result.messages.some((message) => message.type === 'ERROR')) {
+            // Has ERROR messages even though migration succeeded - likely non-fatal errors
+            return 'ERROR';
+        }
+        else if (result.messages.some((message) => message.type === 'WARNING')) {
+            // Has warnings but no errors
+            return 'WARNING';
+        }
+        // No errors or warnings
+        return 'SUCCESS';
+    }
+}
+//# sourceMappingURL=BulkProjectMigrator.js.map

package/dist/ProjectMigrator.d.ts

@@ -0,0 +1,97 @@
+import type { ImportProjectInfo, Message } from './types.js';
+import type { Editor } from 'mem-fs-editor';
+/**
+ * Configuration options for the migrate method
+ */
+export interface MigrateOptions {
+    /** Root path of the project to migrate */
+    projectRoot: string;
+    /** Base URI for backend services */
+    baseUri: string;
+    /** URL for UI5 snapshot version */
+    ui5SnapshotUrl: string;
+    /** Optional partial project information */
+    importProjectInfo?: Partial<ImportProjectInfo>;
+    /** Optional VS Code context */
+    vscode?: any;
+    /** Enable internal features (default: false) */
+    internalToggle?: boolean;
+    /** Optional mem-fs editor instance. If not provided, a new one will be created */
+    fs?: Editor;
+    /** Enable strict validation mode - WARNINGs become ERRORs for critical issues (default: false) */
+    strict?: boolean;
+}
+export declare class ProjectMigrator {
+    /**
+     * migrate project
+     *
+     * @param options - Migration options object
+     * @returns Promise with fs editor, migration result, and messages
+     */
+    static migrate(// NOSONAR - Overload for backward compatibility; use options object signature instead
+    projectRoot: string, baseUri?: string, ui5SnapshotUrl?: string, importProjectInfo?: ImportProjectInfo, vscode?: any, internalToggle?: boolean, fs?: Editor, strict?: boolean): Promise<{
+        fs: Editor;
+        result: boolean;
+        messages: Message[];
+    }>;
+    static migrate(options: MigrateOptions): Promise<{
+        fs: Editor;
+        result: boolean;
+        messages: Message[];
+    }>;
+    /**
+     * Copy files from templates into the project
+     * Orchestrates the migration process through distinct phases
+     *
+     * @param projectInfo - Project information
+     * @param vscode - VS Code context
+     * @param ui5SnapshotUrl - UI5 snapshot URL
+     * @param internalToggle - Internal feature toggle
+     * @param strict - Enable strict validation mode (WARNINGs become ERRORs for critical issues)
+     * @returns Migration result with status and messages
+     */
+    private static copyCommonFiles;
+    /**
+     * Copy files from templates into the project
+     *
+     * @param projectInfo
+     * @param snapshotUrl
+     */
+    private static copyAdaptationFiles;
+    /**
+     * Copy files from templates into the project
+     *
+     * @param projectInfo
+     */
+    private static copyLibraryFiles;
+    /**
+     * Configures a downloaded TypeScript app for local development.
+     * Generates tsconfig.json and TypeScript devDependencies via {@link enableTypescript},
+     * then patches ui5-local.yaml and ui5-mock.yaml with the transpile middleware and task.
+     *
+     * @param rootPath - The project root path.
+     * @returns Messages to surface to the user after setup.
+     */
+    private static setupTypeScript;
+    /**
+     * Detects whether the project is a TypeScript application.
+     * First attempts detection via {@link getAppProgrammingLanguage}, which relies on tsconfig.json being present.
+     * Falls back to scanning the webapp folder for .ts files directly, since after a download from ABAP
+     * the project will not yet have a tsconfig.json — it is added as part of the migration itself.
+     *
+     * @param rootPath - The project root path.
+     * @param webappPath - The relative path to the webapp folder.
+     * @returns True if the project contains TypeScript source files.
+     */
+    private static detectTypeScriptApp;
+    /**
+     * Scans the webapp folder for a TypeScript source file (.ts, excluding .d.ts).
+     * During migration the downloaded files live in the uncommitted mem-fs editor, so when an
+     * editor with a store is in context the mem-fs store is scanned; otherwise the real disk is read.
+     *
+     * @param webappFullPath - Absolute path to the webapp folder.
+     * @returns True if a non-declaration .ts file is present under the webapp folder.
+     */
+    private static webappHasTypeScriptFile;
+}
+//# sourceMappingURL=ProjectMigrator.d.ts.map