@cashscript/utils 0.10.2 → 0.10.4

package/dist/artifact.d.ts

@@ -6,7 +6,7 @@ export interface AbiInput {
 export interface AbiFunction {
     name: string;
     covenant?: boolean;
-    inputs: AbiInput[];
+    inputs: readonly AbiInput[];
 }
 export interface DebugInformation {
     bytecode: string;
@@ -32,8 +32,8 @@ export interface RequireStatement {
 }
 export interface Artifact {
     contractName: string;
-    constructorInputs: AbiInput[];
-    abi: AbiFunction[];
+    constructorInputs: readonly AbiInput[];
+    abi: readonly AbiFunction[];
     bytecode: string;
     source: string;
     debug?: DebugInformation;
@@ -44,4 +44,5 @@ export interface Artifact {
     updatedAt: string;
 }
 export declare function importArtifact(artifactFile: PathLike): Artifact;
-export declare function exportArtifact(artifact: Artifact, targetFile: string): void;
+export declare function exportArtifact(artifact: Artifact, targetFile: string, format: 'json' | 'ts'): void;
+export declare function formatArtifact(artifact: Artifact, format: 'json' | 'ts'): string;

package/dist/artifact.js

@@ -2,8 +2,43 @@ import fs from 'fs';
 export function importArtifact(artifactFile) {
     return JSON.parse(fs.readFileSync(artifactFile, { encoding: 'utf-8' }));
 }
-export function exportArtifact(artifact, targetFile) {
-    const jsonString = JSON.stringify(artifact, null, 2);
+export function exportArtifact(artifact, targetFile, format) {
+    const jsonString = formatArtifact(artifact, format);
     fs.writeFileSync(targetFile, jsonString);
 }
+export function formatArtifact(artifact, format) {
+    if (format === 'ts') {
+        // We remove any undefined values to make the artifact serializable using stringifyAsTs
+        const normalisedArtifact = JSON.parse(JSON.stringify(artifact));
+        return `export default ${stringifyAsTs(normalisedArtifact)} as const;\n`;
+    }
+    return JSON.stringify(artifact, null, 2);
+}
+const indent = (level) => '  '.repeat(level);
+function stringifyAsTs(obj, indentationLevel = 1) {
+    // For strings, we use JSON.stringify, but we convert double quotes to single quotes
+    if (typeof obj === 'string') {
+        return JSON.stringify(obj).replace(/'/g, "\\'").replace(/"/g, "'");
+    }
+    // Numbers and booleans are just converted to strings
+    if (typeof obj === 'number' || typeof obj === 'boolean') {
+        return JSON.stringify(obj);
+    }
+    // Arrays are recursively formatted with indentation
+    if (Array.isArray(obj)) {
+        if (obj.length === 0)
+            return '[]';
+        const formattedItems = obj.map((item) => `${indent(indentationLevel)}${stringifyAsTs(item, indentationLevel + 1)}`);
+        return `[\n${formattedItems.join(',\n')},\n${indent(indentationLevel - 1)}]`;
+    }
+    // Objects are recursively formatted with indentation
+    if (typeof obj === 'object') {
+        const entries = Object.entries(obj);
+        if (entries.length === 0)
+            return '{}';
+        const formattedEntries = entries.map(([key, value]) => (`${indent(indentationLevel)}${key}: ${stringifyAsTs(value, indentationLevel + 1)}`));
+        return `{\n${formattedEntries.join(',\n')},\n${indent(indentationLevel - 1)}}`;
+    }
+    throw new Error(`Unsupported type: ${typeof obj}`);
+}
 //# sourceMappingURL=artifact.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cashscript/utils",
-  "version": "0.10.2",
+  "version": "0.10.4",
   "description": "CashScript utilities and types",
   "keywords": [
     "bitcoin cash",
@@ -48,5 +48,5 @@
     "jest": "^29.4.1",
     "typescript": "^5.5.4"
   },
-  "gitHead": "a7c4f652462ddfccd54fc929f06cb16022769df9"
+  "gitHead": "d8993655ca9b0074d6d22c1680fcd01b23a62054"
 }