@twin.org/move-to-json 0.0.1-next.12

package/docs/examples.md

@@ -0,0 +1,109 @@
+# @twin.org/move-to-json - Examples
+
+## Move to JSON CLI
+
+This CLI compiles one or more Move contracts (for either IOTA or SUI) into Base64-encoded modules, computes a package ID (SHA3-256), and merges the resulting data into a JSON file.
+
+First install the tool with the following script.
+
+```shell
+npm install @twin.org/move-to-json
+```
+
+## Requirements
+
+- IOTA Move CLI or SUI Move CLI installed in your PATH (for compilation). You can download the IOTA CLI by visiting the [IOTA CLI GitHub Releases](https://github.com/iotaledger/iota/releases) page and downloading the appropriate version for your operating system.
+
+You can then run the tool from the command line e.g.
+
+```shell
+move-to-json
+```
+
+You should see the following response:
+
+```shell
+Starting Move to JSON
+=====================
+
+Usage:
+        move-to-json <inputGlob> <outputJson> [--platform=<platform>]
+Error: You must specify both input glob and output JSON path
+```
+
+As you can see, you must provide both an input glob pattern that matches your Move source files and an output JSON file path.
+
+## Example Usage
+
+A typical command looks like this:
+
+```shell
+move-to-json "./src/contracts/**/*.move" ./src/contracts/compiled-modules.json --platform=iota
+```
+
+This will:
+
+- Find all .move files in src/contracts and its subdirectories
+- Compile each file using the IOTA Move compiler (or SUI if --platform=sui)
+- Create or update compiled-modules.json with the compiled bytecode
+
+## Expected Project Structure
+
+The tool expects a standard Move project structure:
+
+```markdown
+myProject/
+Move.toml
+sources/
+myContract.move
+myOtherContract.move
+```
+
+Where “myProject” is considered the “project root”:
+
+- The CLI runs “iota move build” or “sui move build” in the project root (the folder containing Move.toml).
+- The compiled .mv bytecode modules are placed under build/<snake_case_package_name>/bytecode_modules.
+- The CLI loads these .mv files, computes a package ID (SHA3-256), and Base64-encodes them.
+
+However, you can pass any glob pattern that matches one or more .move files. For each file, the CLI will move up one directory from wherever that file is located until it finds the Move.toml. As long as each .move file resides in a standard Move project folder (meaning you do have a Move.toml in its parent directory or above), this tool can find and build the contract.
+
+For example, if your source is:
+
+```markdown
+./somewhere/nested/sources/myContract.move
+./somewhere/nested/Move.toml
+```
+
+Then your glob might look like:
+
+```shell
+move-to-json "./somewhere/nested/sources/*.move" ./build/contracts.json
+```
+
+The CLI will automatically detect the project root as “./somewhere/nested” and run the Move compiler there.
+
+## Output JSON Format
+
+The resulting JSON file (e.g. ./src/contracts/contracts.json) will be updated with an entry for each contract file. The key is the kebab-cased file name (e.g. myContract.move → “my-contract”).
+
+Each entry has:
+
+- packageId – A 0x-prefix hex string (computed SHA3-256 of all compiled modules).
+- package – Either a single Base64-encoded string (if there is one compiled module) or an array of Base64 strings (if multiple modules).
+
+An example snippet of the final JSON might look like:
+
+```json
+{
+  "my-contract": {
+    "packageId": "0xabc123...4f9",
+    "package": "AAECAPN..."
+  },
+  "my-other-contract": {
+    "packageId": "0xdef456ff...b81",
+    "package": ["AAAEFW...", "AAABUK..."]
+  }
+}
+```
+
+If the JSON file already exists, the newly compiled contracts are merged in (existing entries are preserved unless they share the same key, in which case they are overwritten).

package/docs/reference/classes/CLI.md

@@ -0,0 +1,83 @@
+# Class: CLI
+
+The main entry point for the Move to JSON CLI.
+
+## Extends
+
+- `CLIBase`
+
+## Constructors
+
+### new CLI()
+
+> **new CLI**(): [`CLI`](CLI.md)
+
+#### Returns
+
+[`CLI`](CLI.md)
+
+#### Inherited from
+
+`CLIBase.constructor`
+
+## Methods
+
+### run()
+
+> **run**(`argv`, `localesDirectory`?, `options`?): `Promise`\<`number`\>
+
+Run the app.
+
+#### Parameters
+
+##### argv
+
+`string`[]
+
+The process arguments.
+
+##### localesDirectory?
+
+`string`
+
+The directory for the locales, default to relative to the script.
+
+##### options?
+
+Additional options.
+
+###### overrideOutputWidth
+
+`number`
+
+Override the output width.
+
+#### Returns
+
+`Promise`\<`number`\>
+
+The exit code.
+
+***
+
+### configureRoot()
+
+> `protected` **configureRoot**(`program`): `void`
+
+Configure any options or actions at the root program level.
+
+#### Parameters
+
+##### program
+
+`Command`
+
+The root program command.
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+`CLIBase.configureRoot`

package/docs/reference/functions/actionCommandMoveToJson.md

@@ -0,0 +1,33 @@
+# Function: actionCommandMoveToJson()
+
+> **actionCommandMoveToJson**(`inputGlob`, `outputJson`, `opts`): `Promise`\<`void`\>
+
+Action the root command.
+
+## Parameters
+
+### inputGlob
+
+`string`
+
+A glob pattern that matches one or more Move files
+
+### outputJson
+
+`string`
+
+Where we store the final compiled modules.
+
+### opts
+
+Additional options, e.g. platform.
+
+#### platform
+
+[`PlatformTypes`](../type-aliases/PlatformTypes.md)
+
+The platform type.
+
+## Returns
+
+`Promise`\<`void`\>

package/docs/reference/functions/buildCommandMoveToJson.md

@@ -0,0 +1,17 @@
+# Function: buildCommandMoveToJson()
+
+> **buildCommandMoveToJson**(`program`): `void`
+
+Build the root command to be consumed by the CLI.
+
+## Parameters
+
+### program
+
+`Command`
+
+The command to build on.
+
+## Returns
+
+`void`

package/docs/reference/index.md

@@ -0,0 +1,22 @@
+# @twin.org/move-to-json
+
+## Classes
+
+- [CLI](classes/CLI.md)
+
+## Interfaces
+
+- [ICompiledModules](interfaces/ICompiledModules.md)
+
+## Type Aliases
+
+- [PlatformTypes](type-aliases/PlatformTypes.md)
+
+## Variables
+
+- [PlatformTypes](variables/PlatformTypes.md)
+
+## Functions
+
+- [buildCommandMoveToJson](functions/buildCommandMoveToJson.md)
+- [actionCommandMoveToJson](functions/actionCommandMoveToJson.md)

package/docs/reference/interfaces/ICompiledModules.md

@@ -0,0 +1,7 @@
+# Interface: ICompiledModules
+
+Interface for compiled module items
+
+## Indexable
+
+\[`contractName`: `string`\]: `object`

package/docs/reference/type-aliases/PlatformTypes.md

@@ -0,0 +1,5 @@
+# Type Alias: PlatformTypes
+
+> **PlatformTypes**: *typeof* [`PlatformTypes`](../variables/PlatformTypes.md)\[keyof *typeof* [`PlatformTypes`](../variables/PlatformTypes.md)\]
+
+The platform types.

package/docs/reference/variables/PlatformTypes.md

@@ -0,0 +1,19 @@
+# Variable: PlatformTypes
+
+> `const` **PlatformTypes**: `object`
+
+The platform types.
+
+## Type declaration
+
+### Iota
+
+> `readonly` **Iota**: `"iota"` = `"iota"`
+
+IOTA.
+
+### Sui
+
+> `readonly` **Sui**: `"sui"` = `"sui"`
+
+SUI.

package/locales/en.json

@@ -0,0 +1,60 @@
+{
+	"error": {
+		"commands": {
+			"move-to-json": {
+				"failedReadingOutputJson": "Failed to read output JSON file: {file}",
+				"contractProcessingFailed": "Failed to process contract: {file}",
+				"mkdirFailed": "Failed to create output directory: {dir}",
+				"buildFailed": "Build failed on platform {platform} for file {file}",
+				"sdkNotInstalled": "The {platform} SDK is not installed. Please install it first."
+			}
+		}
+	},
+	"commands": {
+		"move-to-json": {
+			"options": {
+				"inputGlob": {
+					"param": "'<'inputGlob'>'",
+					"description": "The directory (or glob) containing Move contracts."
+				},
+				"outputJson": {
+					"param": "'<'outputJson'>'",
+					"description": "The JSON file that will contain compiled modules."
+				},
+				"platform": {
+					"param": "--platform '<'platform'>'",
+					"description": "Which toolchain to use"
+				}
+			},
+			"warnings": {
+				"noMoveFilesFound": "No .move files found for the provided path: {inputGlob}"
+			},
+			"progress": {
+				"searchingFiles": "Searching for .move files...",
+				"processingMoveFile": "Processing file.",
+				"writingJsonFile": "Writing compiled modules JSON..."
+			},
+			"section": {
+				"start": "Starting Move to JSON"
+			},
+			"labels": {
+				"inputGlob": "Input Glob",
+				"outputJson": "Output JSON",
+				"platform": "Platform",
+				"matchedFilesCount": "Matched Files Count",
+				"mergingWithExistingJson": "Merging with existing JSON",
+				"noMoveFilesFound": "No .move files found for the provided path: {inputGlob}",
+				"noExistingJsonFound": "No existing JSON found",
+				"creatingNewJson": "Creating new JSON",
+				"contractName": "Contract Name",
+				"compileCmd": "Compile Command",
+				"workingDir": "Working Directory",
+				"compileOutput": "Compile Output",
+				"compileResult": "Compile Result",
+				"noBytecodeModulesFolderFound": "No bytecode_modules folder found for input file: {contractName}",
+				"noMvFilesFound": "No .mv files found for contract: {contractName}",
+				"computedPackageId": "Computed Package ID"
+			}
+		}
+	}
+}

package/package.json

@@ -0,0 +1,46 @@
+{
+	"name": "@twin.org/move-to-json",
+	"version": "0.0.1-next.12",
+	"description": "Tool to convert Move source files to JSON schemas",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/twinfoundation/dlt.git",
+		"directory": "packages/move-to-json"
+	},
+	"author": "cornel.filip@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=20.0.0"
+	},
+	"dependencies": {
+		"@twin.org/cli-core": "next",
+		"@twin.org/core": "next",
+		"@twin.org/crypto": "next",
+		"@twin.org/nameof": "next",
+		"commander": "13.0.0",
+		"fast-glob": "3.3.3"
+	},
+	"main": "./dist/cjs/index.cjs",
+	"module": "./dist/esm/index.mjs",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"require": "./dist/cjs/index.cjs",
+			"import": "./dist/esm/index.mjs",
+			"types": "./dist/types/index.d.ts"
+		}
+	},
+	"files": [
+		"bin",
+		"dist/cjs",
+		"dist/esm",
+		"dist/locales",
+		"dist/types",
+		"locales",
+		"docs"
+	],
+	"bin": {
+		"move-to-json": "bin/index.js"
+	}
+}