Arrange contracts and docs

Author: tshemsedinov

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## [Unreleased][unreleased]
 
+- Add more CJS and ESM examples and tests
+- Move test examples to separate folders
+- Change test.fail to asserts
+- Refactor err to error
+- Optimize asserts and formatting
+
 ## [1.4.5][] - 2025-08-31
 
 - Update dependencies to latest versions

README.md

@@ -31,8 +31,7 @@ MetaScript {
 }
 ```
 
-Script contains function expression. You can use it for api endpoints, domain
-logic stored in files or database, etc.
+Script contains function expression. You can use it for api endpoints, domain logic stored in files or database, etc.
 
 ```js
 const metavm = require('metavm');
@@ -53,26 +52,40 @@ MetaScript {
 }
 ```
 
-## Read script from file
+CommonJS format
 
 ```js
-const metavm = require('.');
+const metavm = require('metavm');
 
-(async () => {
-  const ms = await metavm.readScript('./test/examples/simple.js');
-  console.log(ms);
-})();
+const src = `module.exports = { field: 'value' };`;
+const ms = metavm.createScript('Example', src, {
+  type: metavm.MODULE_TYPE.COMMONJS,
+});
+console.log(ms.exports); // { field: 'value' }
 ```
 
-Output:
+## Read script from file
+
+Metarhia format
 
+```js
+const metavm = require('metavm');
+
+const ms = await metavm.readScript('./examples/metarhia/simple.js');
+console.log(ms.exports);
+// { field: 'value', add: [Function: add], sub: [Function: sub] }
 ```
-MetaScript {
-  name: 'simple',
-  script: Script {},
-  context: {},
-  exports: { field: 'value', add: [Function: add], sub: [Function: sub] }
-}
+
+CommonJS format
+
+```js
+const metavm = require('metavm');
+
+const ms = await metavm.readScript('./examples/cjssimple.js', {
+  type: metavm.MODULE_TYPE.COMMONJS,
+});
+console.log(ms.exports);
+// { field: 'value', add: [Function: add], sub:[Function: sub] }
 ```
 
 ## License & Contributors

metavm.d.ts

@@ -1,4 +1,4 @@
-import { Context, Script, ScriptOptions, BaseOptions } from 'node:vm';
+import { Context, Script, ScriptOptions } from 'node:vm';
 
 export const EMPTY_CONTEXT: Context;
 export const COMMON_CONTEXT: Context;
@@ -11,22 +11,27 @@ export function createContext(
   preventEscape?: boolean,
 ): Context;
 
-declare enum ModuleType {
+export enum MODULE_TYPE {
   METARHIA = 1,
   COMMONJS = 2,
+  ECMA = 3,
 }
 
 export interface MetaScriptOptions extends ScriptOptions {
-  type?: ModuleType;
+  type?: MODULE_TYPE;
   dirname?: string;
   relative?: string;
   context?: Context;
-  access?: object;
+  access?: Record<string, boolean | object>;
 }
 
 export class MetaScript {
   constructor(name: string, src: string, options?: MetaScriptOptions);
   name: string;
+  dirname: string;
+  relative: string;
+  type: MODULE_TYPE;
+  access: Record<string, boolean | object>;
   script: Script;
   context: Context;
   exports: any;
@@ -40,5 +45,5 @@ export function createScript(
 
 export function readScript(
   filePath: string,
-  options?: BaseOptions,
+  options?: MetaScriptOptions,
 ): Promise<MetaScript>;

metavm.js

@@ -180,6 +180,7 @@ const readScript = async (filePath, options) => {
 module.exports = {
   createContext,
   MetaScript,
+  MetavmError,
   createScript,
   EMPTY_CONTEXT,
   COMMON_CONTEXT,