@helios-lang/contract-utils 0.2.54 → 0.2.55

package/package.json

@@ -1,45 +1,44 @@
 {
-    "name": "@helios-lang/contract-utils",
-    "version": "0.2.54",
-    "description": "Convenience and type-safety utilities for using Helios validators from within Typescript",
-    "main": "src/index.js",
-    "types": "types/index.d.ts",
-    "type": "module",
-    "bin": {
-        "hl2ts": "src/hl2ts.js"
-    },
-    "scripts": {
-        "build": "pnpm run prettify && pnpm run build:types && pnpm run test:suite",
-        "build:types": "tsc -p jsconfig.json --noEmit false --emitDeclarationOnly",
-        "prepack": "pnpm run build",
-        "prettify": "prettier . --write",
-        "test": "pnpm run test:pretty && pnpm run test:types && pnpm run test:suite",
-        "test:pretty": "prettier . --check",
-        "test:suite": "node --test",
-        "test:types": "pnpm run build:types"
-    },
-    "author": "Christian Schmitz",
-    "license": "BSD-3-Clause",
-    "devDependencies": {
-        "@types/node": "^20.11.24",
-        "prettier": "^3.1.0",
-        "typescript": "^5.3.2"
-    },
-    "prettier": {
-        "trailingComma": "none",
-        "tabWidth": 4,
-        "semi": false,
-        "singleQuote": false
-    },
-    "peerDependencies": {
-        "@helios-lang/compiler": "*"
-    },
-    "dependencies": {
-        "@helios-lang/cli-utils": "^0.1.6",
-        "@helios-lang/codec-utils": "^0.1.34",
-        "@helios-lang/compiler-utils": "^0.1.25",
-        "@helios-lang/ledger": "^0.4.10",
-        "@helios-lang/type-utils": "^0.1.21",
-        "@helios-lang/uplc": "^0.3.5"
-    }
-}
+  "name": "@helios-lang/contract-utils",
+  "version": "0.2.55",
+  "description": "Convenience and type-safety utilities for using Helios validators from within Typescript",
+  "main": "src/index.js",
+  "types": "types/index.d.ts",
+  "type": "module",
+  "bin": {
+    "hl2ts": "src/hl2ts.js"
+  },
+  "author": "Christian Schmitz",
+  "license": "BSD-3-Clause",
+  "devDependencies": {
+    "@types/node": "^20.11.24",
+    "prettier": "^3.1.0",
+    "typescript": "^5.3.2"
+  },
+  "prettier": {
+    "trailingComma": "none",
+    "tabWidth": 4,
+    "semi": false,
+    "singleQuote": false
+  },
+  "peerDependencies": {
+    "@helios-lang/compiler": "*"
+  },
+  "dependencies": {
+    "@helios-lang/cli-utils": "^0.1.6",
+    "@helios-lang/codec-utils": "^0.1.34",
+    "@helios-lang/compiler-utils": "^0.1.25",
+    "@helios-lang/ledger": "^0.4.10",
+    "@helios-lang/type-utils": "^0.1.21",
+    "@helios-lang/uplc": "^0.3.5"
+  },
+  "scripts": {
+    "build": "pnpm run prettify && pnpm run build:types && pnpm run test:suite",
+    "build:types": "tsc -p jsconfig.json --noEmit false --emitDeclarationOnly",
+    "prettify": "prettier . --write",
+    "test": "pnpm run test:pretty && pnpm run test:types && pnpm run test:suite",
+    "test:pretty": "prettier . --check",
+    "test:suite": "node --test",
+    "test:types": "pnpm run build:types"
+  }
+}

package/src/cast/UserFunc.js

@@ -13,6 +13,7 @@ import { Cast } from "./Cast.js"
  */
 
 /**
+ * `returns` is optional to accomodate main functions that return void
  * @typedef {{
  *   name: string
  *   requiresScriptContext: boolean
@@ -23,7 +24,7 @@ import { Cast } from "./Cast.js"
  *     isOptional: boolean
  *     isIgnored?: boolean
  *   }[]
- *   returns: TypeSchema
+ *   returns?: TypeSchema
  *   validatorIndices?: Record<string, number>
  *   castConfig: CastConfig
  * }} UserFuncProps
@@ -103,14 +104,19 @@ export class UserFunc {
             /** @type {UnsafeArgsT<ArgsT>} */ (unsafeNamedArgs)
         )
 
-        return new Cast(this.props.returns, this.props.castConfig).fromUplcData(
-            result
-        )
+        if (this.props.returns) {
+            return new Cast(
+                this.props.returns,
+                this.props.castConfig
+            ).fromUplcData(expectSome(/** @type {any} */ (result)))
+        } else {
+            return /** @type {any} */ (undefined)
+        }
     }
 
     /**
      * @param {UnsafeArgsT<ArgsT>} namedArgs
-     * @returns {UplcData}
+     * @returns {RetT extends void ? void : UplcData}
      */
     evalUnsafe(namedArgs) {
         const result = this.profile(namedArgs).result
@@ -118,9 +124,11 @@ export class UserFunc {
         if (isLeft(result)) {
             throw new Error(result.left.error)
         } else if (!isString(result.right) && result.right.kind == "data") {
-            return result.right.value
-        } else {
+            return /** @type {any} */ (result.right.value)
+        } else if (this.props.returns) {
             throw new Error(`${result.right.toString()} isn't a UplcDataValue`)
+        } else {
+            return /** @type {any} */ (undefined)
         }
     }
 

package/src/codegen/LoadedScriptsWriter.js

@@ -412,7 +412,7 @@ function genFuncType(fn) {
     })
 
     const argsTypeStr = `{${fields.join(", ")}}`
-    const retTypeStr = genTypes(fn.returns)[0]
+    const retTypeStr = fn?.returns ? genTypes(fn.returns)[0] : "void"
 
     return [argsTypeStr, retTypeStr]
 }

package/src/codegen/TypeCheckedModule.js

@@ -5,6 +5,7 @@ export {}
  */
 
 /**
+ * `returns` is optional to accomodate main functions that return undefined
  * @typedef {{
  *   name: string
  *   requiresScriptContext: boolean
@@ -15,7 +16,7 @@ export {}
  *     isOptional: boolean
  *     isIgnored?: boolean
  *   }[]
- *   returns: TypeSchema
+ *   returns?: TypeSchema
  * }} TypeCheckedUserFunc
  */
 

package/types/cast/UserFunc.d.ts

@@ -7,6 +7,7 @@
  * @typedef {import("./Cast.js").CastConfig} CastConfig
  */
 /**
+ * `returns` is optional to accomodate main functions that return void
  * @typedef {{
  *   name: string
  *   requiresScriptContext: boolean
@@ -17,7 +18,7 @@
  *     isOptional: boolean
  *     isIgnored?: boolean
  *   }[]
- *   returns: TypeSchema
+ *   returns?: TypeSchema
  *   validatorIndices?: Record<string, number>
  *   castConfig: CastConfig
  * }} UserFuncProps
@@ -60,9 +61,9 @@ export class UserFunc<ArgsT extends {
     eval(namedArgs: ArgsT): RetT;
     /**
      * @param {UnsafeArgsT<ArgsT>} namedArgs
-     * @returns {UplcData}
+     * @returns {RetT extends void ? void : UplcData}
      */
-    evalUnsafe(namedArgs: UnsafeArgsT<ArgsT>): UplcData;
+    evalUnsafe(namedArgs: UnsafeArgsT<ArgsT>): RetT extends void ? void : UplcData;
     /**
      * @param {UnsafeArgsT<ArgsT>} namedArgs
      * @returns {CekResult}
@@ -75,6 +76,9 @@ export type UplcData = import("@helios-lang/uplc").UplcData;
 export type UplcProgram = import("@helios-lang/uplc").UplcProgram;
 export type UplcValue = import("@helios-lang/uplc").UplcValue;
 export type CastConfig = import("./Cast.js").CastConfig;
+/**
+ * `returns` is optional to accomodate main functions that return void
+ */
 export type UserFuncProps = {
     name: string;
     requiresScriptContext: boolean;
@@ -85,7 +89,7 @@ export type UserFuncProps = {
         isOptional: boolean;
         isIgnored?: boolean;
     }[];
-    returns: TypeSchema;
+    returns?: TypeSchema;
     validatorIndices?: Record<string, number>;
     castConfig: CastConfig;
 };

package/types/cast/UserFunc.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"UserFunc.d.ts","sourceRoot":"","sources":["../../src/cast/UserFunc.js"],"names":[],"mappings":"AAKA;;;;;;;GAOG;AAEH;;;;;;;;;;;;;;;GAeG;AAEH;;;GAGG;AAEH;;;GAGG;AACH,sBAHwC,KAAK,SAAhC;IAAE,CAAC,OAAO,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,EAC1B,IAAI;IAgBb;;;OAGG;IACH,kBAHW,WAAW,SACX,aAAa,EAKvB;IApBD;;;OAGG;IACH,eAFU,WAAW,CAEjB;IAEJ;;;;OAIG;IACH,uBAAK;IAWL;;OAEG;IACH,mBAEC;IAED;;;OAGG;IACH,gBAHW,KAAK,GACH,IAAI,CAoChB;IAED;;;OAGG;IACH,sBAHW,WAAW,CAAC,KAAK,CAAC,GAChB,QAAQ,CAYpB;IAED;;;OAGG;IACH,mBAHW,WAAW,CAAC,KAAK,CAAC,GAChB,SAAS,CAyGrB;CACJ;yBApOY,OAAO,yBAAyB,EAAE,UAAU;wBAC5C,OAAO,mBAAmB,EAAE,SAAS;uBACrC,OAAO,mBAAmB,EAAE,QAAQ;0BACpC,OAAO,mBAAmB,EAAE,WAAW;wBACvC,OAAO,mBAAmB,EAAE,SAAS;yBACrC,OAAO,WAAW,EAAE,UAAU;4BAI9B;IACZ,IAAQ,EAAE,MAAM,CAAA;IAChB,qBAAyB,EAAE,OAAO,CAAA;IAClC,qBAAyB,EAAE,OAAO,CAAA;IAClC,SAAa,EAAE;QACf,IAAU,EAAE,MAAM,CAAA;QAClB,IAAU,EAAE,UAAU,CAAA;QACtB,UAAgB,EAAE,OAAO,CAAA;QACzB,SAAe,CAAC,EAAE,OAAO,CAAA;KACpB,EAAE,CAAA;IACP,OAAW,EAAE,UAAU,CAAA;IACvB,gBAAoB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC7C,UAAc,EAAE,UAAU,CAAA;CACvB;wBAIS,KAAK,IACL,GAAE,CAAgB,IAAX,MAAM,KAAK,GAAG,CAAC,SAAS,gBAAgB,GAAG,MAAM,GAAG,QAAQ,GAAC"}
+{"version":3,"file":"UserFunc.d.ts","sourceRoot":"","sources":["../../src/cast/UserFunc.js"],"names":[],"mappings":"AAKA;;;;;;;GAOG;AAEH;;;;;;;;;;;;;;;;GAgBG;AAEH;;;GAGG;AAEH;;;GAGG;AACH,sBAHwC,KAAK,SAAhC;IAAE,CAAC,OAAO,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,EAC1B,IAAI;IAgBb;;;OAGG;IACH,kBAHW,WAAW,SACX,aAAa,EAKvB;IApBD;;;OAGG;IACH,eAFU,WAAW,CAEjB;IAEJ;;;;OAIG;IACH,uBAAK;IAWL;;OAEG;IACH,mBAEC;IAED;;;OAGG;IACH,gBAHW,KAAK,GACH,IAAI,CAyChB;IAED;;;OAGG;IACH,sBAHW,WAAW,CAAC,KAAK,CAAC,GAChB,IAAI,SAAS,IAAI,GAAG,IAAI,GAAG,QAAQ,CAc/C;IAED;;;OAGG;IACH,mBAHW,WAAW,CAAC,KAAK,CAAC,GAChB,SAAS,CAyGrB;CACJ;yBA5OY,OAAO,yBAAyB,EAAE,UAAU;wBAC5C,OAAO,mBAAmB,EAAE,SAAS;uBACrC,OAAO,mBAAmB,EAAE,QAAQ;0BACpC,OAAO,mBAAmB,EAAE,WAAW;wBACvC,OAAO,mBAAmB,EAAE,SAAS;yBACrC,OAAO,WAAW,EAAE,UAAU;;;;4BAK9B;IACZ,IAAQ,EAAE,MAAM,CAAA;IAChB,qBAAyB,EAAE,OAAO,CAAA;IAClC,qBAAyB,EAAE,OAAO,CAAA;IAClC,SAAa,EAAE;QACf,IAAU,EAAE,MAAM,CAAA;QAClB,IAAU,EAAE,UAAU,CAAA;QACtB,UAAgB,EAAE,OAAO,CAAA;QACzB,SAAe,CAAC,EAAE,OAAO,CAAA;KACpB,EAAE,CAAA;IACP,OAAW,CAAC,EAAE,UAAU,CAAA;IACxB,gBAAoB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC7C,UAAc,EAAE,UAAU,CAAA;CACvB;wBAIS,KAAK,IACL,GAAE,CAAgB,IAAX,MAAM,KAAK,GAAG,CAAC,SAAS,gBAAgB,GAAG,MAAM,GAAG,QAAQ,GAAC"}

package/types/codegen/TypeCheckedModule.d.ts

@@ -1,4 +1,7 @@
 export type TypeSchema = import("./TypeSchema.js").TypeSchema;
+/**
+ * `returns` is optional to accomodate main functions that return undefined
+ */
 export type TypeCheckedUserFunc = {
     name: string;
     requiresScriptContext: boolean;
@@ -9,7 +12,7 @@ export type TypeCheckedUserFunc = {
         isOptional: boolean;
         isIgnored?: boolean;
     }[];
-    returns: TypeSchema;
+    returns?: TypeSchema;
 };
 export type TypeCheckedModule = {
     name: string;

package/types/codegen/TypeCheckedModule.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TypeCheckedModule.d.ts","sourceRoot":"","sources":["../../src/codegen/TypeCheckedModule.js"],"names":[],"mappings":"yBAGa,OAAO,iBAAiB,EAAE,UAAU;kCAIpC;IACZ,IAAQ,EAAE,MAAM,CAAA;IAChB,qBAAyB,EAAE,OAAO,CAAA;IAClC,qBAAyB,EAAE,OAAO,CAAA;IAClC,SAAa,EAAE;QACf,IAAU,EAAE,MAAM,CAAA;QAClB,IAAU,EAAE,UAAU,CAAA;QACtB,UAAgB,EAAE,OAAO,CAAA;QACzB,SAAe,CAAC,EAAE,OAAO,CAAA;KACpB,EAAE,CAAA;IACP,OAAW,EAAE,UAAU,CAAA;CACpB;gCAIS;IACZ,IAAQ,EAAE,MAAM,CAAA;IAChB,OAAW,EAAE,MAAM,CAAA;IACnB,UAAc,EAAE,MAAM,CAAA;IACtB,iBAAqB,EAAE,MAAM,EAAE,CAAA;IAC/B,KAAS,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;IACrC,SAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAA;CAChD"}
+{"version":3,"file":"TypeCheckedModule.d.ts","sourceRoot":"","sources":["../../src/codegen/TypeCheckedModule.js"],"names":[],"mappings":"yBAGa,OAAO,iBAAiB,EAAE,UAAU;;;;kCAKpC;IACZ,IAAQ,EAAE,MAAM,CAAA;IAChB,qBAAyB,EAAE,OAAO,CAAA;IAClC,qBAAyB,EAAE,OAAO,CAAA;IAClC,SAAa,EAAE;QACf,IAAU,EAAE,MAAM,CAAA;QAClB,IAAU,EAAE,UAAU,CAAA;QACtB,UAAgB,EAAE,OAAO,CAAA;QACzB,SAAe,CAAC,EAAE,OAAO,CAAA;KACpB,EAAE,CAAA;IACP,OAAW,CAAC,EAAE,UAAU,CAAA;CACrB;gCAIS;IACZ,IAAQ,EAAE,MAAM,CAAA;IAChB,OAAW,EAAE,MAAM,CAAA;IACnB,UAAc,EAAE,MAAM,CAAA;IACtB,iBAAqB,EAAE,MAAM,EAAE,CAAA;IAC/B,KAAS,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;IACrC,SAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAA;CAChD"}