@haneullabs/codegen 0.1.0 → 0.8.3

package/dist/render-types.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"render-types.mjs","names":["type"],"sources":["../src/render-types.ts"],"sourcesContent":["// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nimport { normalizeHaneulAddress } from '@haneullabs/haneul/utils';\n\nimport type {\n\tDatatype,\n\tDatatypeParameter,\n\tModuleSummary,\n\tType,\n\tTypeParameter,\n} from './types/summary.js';\n\nexport const MOVE_STDLIB_ADDRESS = normalizeHaneulAddress('0x1');\nexport const HANEUL_FRAMEWORK_ADDRESS = normalizeHaneulAddress('0x2');\nexport const HANEUL_SYSTEM_ADDRESS = normalizeHaneulAddress('0x3');\n\ntype TypeSignatureFormat = 'typescriptArg' | 'bcs' | 'typeTag';\ninterface RenderTypeSignatureOptions {\n\tformat: TypeSignatureFormat;\n\tsummary: ModuleSummary;\n\ttypeParameters?: TypeParameter[];\n\tonDependency?: (address: string, module: string, type: string) => string | undefined;\n\tbcsImport?: () => string;\n\tonTypeParameter?: (typeParameter: number | string) => void;\n\tresolveAddress: (address: string) => string;\n\tincludePhantomTypeParameters: boolean;\n}\n\nfunction getFilteredTypeParameterIndex(\n\toriginalIndex: number,\n\ttypeParameters: TypeParameter[] | undefined,\n\tincludePhantom: boolean,\n): number {\n\tif (includePhantom || !typeParameters) return originalIndex;\n\n\tlet filteredIndex = 0;\n\tfor (let i = 0; i < originalIndex; i++) {\n\t\tconst param = typeParameters[i] as DatatypeParameter | undefined;\n\t\tif (!param?.phantom) {\n\t\t\tfilteredIndex++;\n\t\t}\n\t}\n\treturn filteredIndex;\n}\n\nexport function renderTypeSignature(type: Type, options: RenderTypeSignatureOptions): string {\n\tlet bcs = 'bcs';\n\tif (options.bcsImport && usesBcs(type, options)) {\n\t\tbcs = options.bcsImport();\n\t}\n\n\tswitch (type) {\n\t\tcase 'address':\n\t\t\tswitch (options.format) {\n\t\t\t\tcase 'typescriptArg':\n\t\t\t\t\treturn 'string';\n\t\t\t\tcase 'typeTag':\n\t\t\t\t\treturn `address`;\n\t\t\t\tcase 'bcs':\n\t\t\t\t\treturn `${bcs}.Address`;\n\t\t\t\tdefault:\n\t\t\t\t\tthrow new Error(`Unknown format: ${options.format}`);\n\t\t\t}\n\t\tcase 'bool':\n\t\t\tswitch (options.format) {\n\t\t\t\tcase 'typescriptArg':\n\t\t\t\t\treturn 'boolean';\n\t\t\t\tcase 'typeTag':\n\t\t\t\t\treturn `bool`;\n\t\t\t\tcase 'bcs':\n\t\t\t\t\treturn `${bcs}.bool()`;\n\t\t\t\tdefault:\n\t\t\t\t\tthrow new Error(`Unknown format: ${options.format}`);\n\t\t\t}\n\t\tcase 'u8':\n\t\tcase 'u16':\n\t\tcase 'u32':\n\t\t\tswitch (options.format) {\n\t\t\t\tcase 'typescriptArg':\n\t\t\t\t\treturn 'number';\n\t\t\t\tcase 'typeTag':\n\t\t\t\t\treturn type.toLowerCase();\n\t\t\t\tcase 'bcs':\n\t\t\t\t\treturn `${bcs}.${type.toLowerCase()}()`;\n\t\t\t\tdefault:\n\t\t\t\t\tthrow new Error(`Unknown format: ${options.format}`);\n\t\t\t}\n\t\tcase 'u64':\n\t\tcase 'u128':\n\t\tcase 'u256':\n\t\t\tswitch (options.format) {\n\t\t\t\tcase 'typescriptArg':\n\t\t\t\t\treturn `number | bigint`;\n\t\t\t\tcase 'typeTag':\n\t\t\t\t\treturn type.toLowerCase();\n\t\t\t\tcase 'bcs':\n\t\t\t\t\treturn `${bcs}.${type.toLowerCase()}()`;\n\t\t\t\tdefault:\n\t\t\t\t\tthrow new Error(`Unknown format: ${options.format}`);\n\t\t\t}\n\t\tcase 'signer':\n\t\t\tthrow new Error('Signer is not supported');\n\t\tcase '_':\n\t\t\tthrow new Error('Macro placeholder is not supported');\n\t}\n\n\tif ('Datatype' in type) {\n\t\treturn renderDataType(type.Datatype, options);\n\t}\n\n\tif ('Reference' in type) {\n\t\treturn renderTypeSignature(type.Reference[1], options);\n\t}\n\n\tif ('vector' in type) {\n\t\tswitch (options.format) {\n\t\t\tcase 'typescriptArg':\n\t\t\t\treturn `${renderTypeSignature(type.vector, options)}[]`;\n\t\t\tcase 'typeTag':\n\t\t\t\treturn `vector<${renderTypeSignature(type.vector, options)}>`;\n\t\t\tcase 'bcs':\n\t\t\t\treturn `${bcs}.vector(${renderTypeSignature(type.vector, options)})`;\n\t\t\tdefault:\n\t\t\t\tthrow new Error(`Unknown format: ${options.format}`);\n\t\t}\n\t}\n\n\tif ('TypeParameter' in type) {\n\t\toptions.onTypeParameter?.(type.TypeParameter);\n\t\tconst originalIndex = type.TypeParameter;\n\t\tconst filteredIndex = getFilteredTypeParameterIndex(\n\t\t\toriginalIndex,\n\t\t\toptions.typeParameters,\n\t\t\toptions.includePhantomTypeParameters,\n\t\t);\n\t\tswitch (options.format) {\n\t\t\tcase 'typescriptArg':\n\t\t\t\treturn options.typeParameters?.[originalIndex]?.name ?? `T${originalIndex}`;\n\t\t\tcase 'typeTag':\n\t\t\t\treturn `\\${options.typeArguments[${originalIndex}]}`;\n\t\t\tcase 'bcs':\n\t\t\t\treturn `typeParameters[${filteredIndex}]`;\n\t\t\tdefault:\n\t\t\t\tthrow new Error(`Unknown format: ${options.format}`);\n\t\t}\n\t}\n\n\tif ('NamedTypeParameter' in type) {\n\t\toptions.onTypeParameter?.(type.NamedTypeParameter);\n\t\tconst originalIndex =\n\t\t\toptions.typeParameters?.findIndex((p) => p.name === type.NamedTypeParameter) ?? -1;\n\n\t\tif (originalIndex === -1) {\n\t\t\tthrow new Error(`Named type parameter ${type.NamedTypeParameter} not found`);\n\t\t}\n\n\t\tconst filteredIndex = getFilteredTypeParameterIndex(\n\t\t\toriginalIndex,\n\t\t\toptions.typeParameters,\n\t\t\toptions.includePhantomTypeParameters,\n\t\t);\n\n\t\tswitch (options.format) {\n\t\t\tcase 'typescriptArg':\n\t\t\t\treturn type.NamedTypeParameter;\n\t\t\tcase 'typeTag':\n\t\t\t\treturn `\\${options.typeArguments[${originalIndex}]}`;\n\t\t\tcase 'bcs':\n\t\t\t\treturn `typeParameters[${filteredIndex}]`;\n\t\t\tdefault:\n\t\t\t\tthrow new Error(`Unknown format: ${options.format}`);\n\t\t}\n\t}\n\n\tthrow new Error(`Unknown type signature: ${JSON.stringify(type, null, 2)}`);\n}\n\nexport function usesBcs(type: Type, options: RenderTypeSignatureOptions): boolean {\n\tif (typeof type === 'string') {\n\t\treturn true;\n\t}\n\n\tif ('Reference' in type) {\n\t\treturn usesBcs(type.Reference[1], options);\n\t}\n\n\tif ('Datatype' in type) {\n\t\treturn isPureDataType(type.Datatype, options);\n\t}\n\n\tif ('vector' in type) {\n\t\treturn true;\n\t}\n\n\treturn false;\n}\n\nexport function isPureSignature(type: Type, options: RenderTypeSignatureOptions): boolean {\n\tif (typeof type === 'string') {\n\t\treturn true;\n\t}\n\n\tif ('Reference' in type) {\n\t\treturn isPureSignature(type.Reference[1], options);\n\t}\n\n\tif ('Datatype' in type) {\n\t\treturn isPureDataType(type.Datatype, options);\n\t}\n\n\tif ('vector' in type) {\n\t\treturn isPureSignature(type.vector, options);\n\t}\n\n\tif ('TypeParameter' in type) {\n\t\treturn false;\n\t}\n\n\tif ('NamedTypeParameter' in type) {\n\t\treturn false;\n\t}\n\n\tthrow new Error(`Unknown type signature: ${JSON.stringify(type, null, 2)}`);\n}\n\nfunction isPureDataType(type: Datatype, options: RenderTypeSignatureOptions) {\n\tconst address = options.resolveAddress(type.module.address);\n\n\tif (address === MOVE_STDLIB_ADDRESS) {\n\t\tif ((type.module.name === 'ascii' || type.module.name === 'string') && type.name === 'String') {\n\t\t\treturn true;\n\t\t}\n\n\t\tif (type.module.name === 'option' && type.name === 'Option') {\n\t\t\treturn true;\n\t\t}\n\t}\n\n\tif (address === HANEUL_FRAMEWORK_ADDRESS) {\n\t\tif (type.module.name === 'object' && (type.name === 'ID' || type.name === 'UID')) {\n\t\t\treturn true;\n\t\t}\n\t}\n\n\treturn false;\n}\n\nfunction renderDataType(type: Datatype, options: RenderTypeSignatureOptions): string {\n\tconst address = options.resolveAddress(type.module.address);\n\n\tif (options.format === 'typeTag') {\n\t\tif (address === HANEUL_FRAMEWORK_ADDRESS) {\n\t\t\tif (type.module.name === 'clock' && type.name === 'Clock') return '0x2::clock::Clock';\n\t\t\tif (type.module.name === 'random' && type.name === 'Random') return '0x2::random::Random';\n\t\t\tif (type.module.name === 'deny_list' && type.name === 'DenyList')\n\t\t\t\treturn '0x2::deny_list::DenyList';\n\t\t\tif (type.module.name === 'object' && (type.name === 'ID' || type.name === 'UID'))\n\t\t\t\treturn '0x2::object::ID';\n\t\t}\n\t\tif (address === HANEUL_SYSTEM_ADDRESS) {\n\t\t\tif (type.module.name === 'haneul_system' && type.name === 'HaneulSystemState')\n\t\t\t\treturn '0x3::haneul_system::HaneulSystemState';\n\t\t}\n\n\t\tif (address === MOVE_STDLIB_ADDRESS) {\n\t\t\tif (\n\t\t\t\t(type.module.name === 'ascii' || type.module.name === 'string') &&\n\t\t\t\ttype.name === 'String'\n\t\t\t) {\n\t\t\t\treturn '0x1::string::String';\n\t\t\t}\n\t\t\tif (type.module.name === 'option' && type.name === 'Option') {\n\t\t\t\tconst innerType = renderTypeSignature(type.type_arguments[0].argument, options);\n\t\t\t\treturn `0x1::option::Option<${innerType}>`;\n\t\t\t}\n\t\t}\n\n\t\treturn 'null';\n\t}\n\n\tif (address === MOVE_STDLIB_ADDRESS) {\n\t\tif ((type.module.name === 'ascii' || type.module.name === 'string') && type.name === 'String') {\n\t\t\tswitch (options.format) {\n\t\t\t\tcase 'typescriptArg':\n\t\t\t\t\treturn 'string';\n\t\t\t\tcase 'bcs':\n\t\t\t\t\treturn `${options.bcsImport?.() ?? 'bcs'}.string()`;\n\t\t\t\tdefault:\n\t\t\t\t\tthrow new Error(`Unknown format: ${options.format}`);\n\t\t\t}\n\t\t}\n\n\t\tif (type.module.name === 'option' && type.name === 'Option') {\n\t\t\tswitch (options.format) {\n\t\t\t\tcase 'typescriptArg':\n\t\t\t\t\tif (isPureDataType(type, options)) {\n\t\t\t\t\t\treturn `${renderTypeSignature(type.type_arguments[0].argument, options)} | null`;\n\t\t\t\t\t}\n\t\t\t\t\tbreak;\n\t\t\t\tcase 'bcs':\n\t\t\t\t\treturn `${options.bcsImport?.() ?? 'bcs'}.option(${renderTypeSignature(type.type_arguments[0].argument, options)})`;\n\t\t\t\tdefault:\n\t\t\t\t\tthrow new Error(`Unknown format: ${options.format}`);\n\t\t\t}\n\t\t}\n\t}\n\n\tif (address === HANEUL_FRAMEWORK_ADDRESS) {\n\t\tif (type.module.name === 'object' && (type.name === 'ID' || type.name === 'UID')) {\n\t\t\tswitch (options.format) {\n\t\t\t\tcase 'typescriptArg':\n\t\t\t\t\treturn 'string';\n\t\t\t\tcase 'bcs':\n\t\t\t\t\treturn `${options.bcsImport?.() ?? 'bcs'}.Address`;\n\t\t\t\tdefault:\n\t\t\t\t\tthrow new Error(`Unknown format: ${options.format}`);\n\t\t\t}\n\t\t}\n\t}\n\n\tconst isCurrentModule =\n\t\taddress === options.resolveAddress(options.summary.id.address) &&\n\t\ttype.module.name === options.summary.id.name;\n\n\tconst importName = options.onDependency?.(type.module.address, type.module.name, type.name);\n\n\tconst typeNameRef = isCurrentModule\n\t\t? type.name\n\t\t: `${importName ?? getSafeName(type.module.name)}.${getSafeName(type.name)}`;\n\n\tconst filteredTypeArguments = type.type_arguments.filter((arg) => !arg.phantom);\n\n\tswitch (options.format) {\n\t\tcase 'typescriptArg':\n\t\t\treturn 'string';\n\t\tcase 'bcs':\n\t\t\tif (filteredTypeArguments.length === 0) {\n\t\t\t\treturn typeNameRef;\n\t\t\t}\n\n\t\t\treturn `${typeNameRef}(\n                ${filteredTypeArguments.map((type) => renderTypeSignature(type.argument, options)).join(', ')})`;\n\t\tdefault:\n\t\t\tthrow new Error(`Unknown format: ${options.format}`);\n\t}\n}\n\nconst JS_RESERVED_NAMES = [\n\t'new',\n\t'delete',\n\t'class',\n\t'function',\n\t'import',\n\t'export',\n\t'return',\n\t'this',\n\t'super',\n\t'arguments',\n\t'eval',\n\t'void',\n\t'typeof',\n\t'instanceof',\n\t'delete',\n\t'in',\n\t'from',\n\t'of',\n\t'as',\n\t'async',\n\t'await',\n\t'break',\n\t'case',\n\t'catch',\n\t'continue',\n\t'debugger',\n\t'default',\n\t'do',\n\t'else',\n\t'finally',\n\t'for',\n\t'function',\n\t'if',\n\t'import',\n\t'in',\n\t'instanceof',\n\t'new',\n\t'return',\n\t'switch',\n\t'throw',\n\t'try',\n\t'typeof',\n\t'var',\n\t'void',\n\t'while',\n\t'with',\n\t'yield',\n\t'package',\n];\n\nexport function getSafeName(name: string) {\n\treturn JS_RESERVED_NAMES.includes(name) ? `_${name}` : name;\n}\n"],"mappings":";;;AAaA,MAAa,sBAAsB,uBAAuB,MAAM;AAChE,MAAa,2BAA2B,uBAAuB,MAAM;AACrE,MAAa,wBAAwB,uBAAuB,MAAM;AAclE,SAAS,8BACR,eACA,gBACA,gBACS;AACT,KAAI,kBAAkB,CAAC,eAAgB,QAAO;CAE9C,IAAI,gBAAgB;AACpB,MAAK,IAAI,IAAI,GAAG,IAAI,eAAe,IAElC,KAAI,CADU,eAAe,IACjB,QACX;AAGF,QAAO;;AAGR,SAAgB,oBAAoB,MAAY,SAA6C;CAC5F,IAAI,MAAM;AACV,KAAI,QAAQ,aAAa,QAAQ,MAAM,QAAQ,CAC9C,OAAM,QAAQ,WAAW;AAG1B,SAAQ,MAAR;EACC,KAAK,UACJ,SAAQ,QAAQ,QAAhB;GACC,KAAK,gBACJ,QAAO;GACR,KAAK,UACJ,QAAO;GACR,KAAK,MACJ,QAAO,GAAG,IAAI;GACf,QACC,OAAM,IAAI,MAAM,mBAAmB,QAAQ,SAAS;;EAEvD,KAAK,OACJ,SAAQ,QAAQ,QAAhB;GACC,KAAK,gBACJ,QAAO;GACR,KAAK,UACJ,QAAO;GACR,KAAK,MACJ,QAAO,GAAG,IAAI;GACf,QACC,OAAM,IAAI,MAAM,mBAAmB,QAAQ,SAAS;;EAEvD,KAAK;EACL,KAAK;EACL,KAAK,MACJ,SAAQ,QAAQ,QAAhB;GACC,KAAK,gBACJ,QAAO;GACR,KAAK,UACJ,QAAO,KAAK,aAAa;GAC1B,KAAK,MACJ,QAAO,GAAG,IAAI,GAAG,KAAK,aAAa,CAAC;GACrC,QACC,OAAM,IAAI,MAAM,mBAAmB,QAAQ,SAAS;;EAEvD,KAAK;EACL,KAAK;EACL,KAAK,OACJ,SAAQ,QAAQ,QAAhB;GACC,KAAK,gBACJ,QAAO;GACR,KAAK,UACJ,QAAO,KAAK,aAAa;GAC1B,KAAK,MACJ,QAAO,GAAG,IAAI,GAAG,KAAK,aAAa,CAAC;GACrC,QACC,OAAM,IAAI,MAAM,mBAAmB,QAAQ,SAAS;;EAEvD,KAAK,SACJ,OAAM,IAAI,MAAM,0BAA0B;EAC3C,KAAK,IACJ,OAAM,IAAI,MAAM,qCAAqC;;AAGvD,KAAI,cAAc,KACjB,QAAO,eAAe,KAAK,UAAU,QAAQ;AAG9C,KAAI,eAAe,KAClB,QAAO,oBAAoB,KAAK,UAAU,IAAI,QAAQ;AAGvD,KAAI,YAAY,KACf,SAAQ,QAAQ,QAAhB;EACC,KAAK,gBACJ,QAAO,GAAG,oBAAoB,KAAK,QAAQ,QAAQ,CAAC;EACrD,KAAK,UACJ,QAAO,UAAU,oBAAoB,KAAK,QAAQ,QAAQ,CAAC;EAC5D,KAAK,MACJ,QAAO,GAAG,IAAI,UAAU,oBAAoB,KAAK,QAAQ,QAAQ,CAAC;EACnE,QACC,OAAM,IAAI,MAAM,mBAAmB,QAAQ,SAAS;;AAIvD,KAAI,mBAAmB,MAAM;AAC5B,UAAQ,kBAAkB,KAAK,cAAc;EAC7C,MAAM,gBAAgB,KAAK;EAC3B,MAAM,gBAAgB,8BACrB,eACA,QAAQ,gBACR,QAAQ,6BACR;AACD,UAAQ,QAAQ,QAAhB;GACC,KAAK,gBACJ,QAAO,QAAQ,iBAAiB,gBAAgB,QAAQ,IAAI;GAC7D,KAAK,UACJ,QAAO,4BAA4B,cAAc;GAClD,KAAK,MACJ,QAAO,kBAAkB,cAAc;GACxC,QACC,OAAM,IAAI,MAAM,mBAAmB,QAAQ,SAAS;;;AAIvD,KAAI,wBAAwB,MAAM;AACjC,UAAQ,kBAAkB,KAAK,mBAAmB;EAClD,MAAM,gBACL,QAAQ,gBAAgB,WAAW,MAAM,EAAE,SAAS,KAAK,mBAAmB,IAAI;AAEjF,MAAI,kBAAkB,GACrB,OAAM,IAAI,MAAM,wBAAwB,KAAK,mBAAmB,YAAY;EAG7E,MAAM,gBAAgB,8BACrB,eACA,QAAQ,gBACR,QAAQ,6BACR;AAED,UAAQ,QAAQ,QAAhB;GACC,KAAK,gBACJ,QAAO,KAAK;GACb,KAAK,UACJ,QAAO,4BAA4B,cAAc;GAClD,KAAK,MACJ,QAAO,kBAAkB,cAAc;GACxC,QACC,OAAM,IAAI,MAAM,mBAAmB,QAAQ,SAAS;;;AAIvD,OAAM,IAAI,MAAM,2BAA2B,KAAK,UAAU,MAAM,MAAM,EAAE,GAAG;;AAG5E,SAAgB,QAAQ,MAAY,SAA8C;AACjF,KAAI,OAAO,SAAS,SACnB,QAAO;AAGR,KAAI,eAAe,KAClB,QAAO,QAAQ,KAAK,UAAU,IAAI,QAAQ;AAG3C,KAAI,cAAc,KACjB,QAAO,eAAe,KAAK,UAAU,QAAQ;AAG9C,KAAI,YAAY,KACf,QAAO;AAGR,QAAO;;AA+BR,SAAS,eAAe,MAAgB,SAAqC;CAC5E,MAAM,UAAU,QAAQ,eAAe,KAAK,OAAO,QAAQ;AAE3D,KAAI,YAAY,qBAAqB;AACpC,OAAK,KAAK,OAAO,SAAS,WAAW,KAAK,OAAO,SAAS,aAAa,KAAK,SAAS,SACpF,QAAO;AAGR,MAAI,KAAK,OAAO,SAAS,YAAY,KAAK,SAAS,SAClD,QAAO;;AAIT,KAAI,YAAY,0BACf;MAAI,KAAK,OAAO,SAAS,aAAa,KAAK,SAAS,QAAQ,KAAK,SAAS,OACzE,QAAO;;AAIT,QAAO;;AAGR,SAAS,eAAe,MAAgB,SAA6C;CACpF,MAAM,UAAU,QAAQ,eAAe,KAAK,OAAO,QAAQ;AAE3D,KAAI,QAAQ,WAAW,WAAW;AACjC,MAAI,YAAY,0BAA0B;AACzC,OAAI,KAAK,OAAO,SAAS,WAAW,KAAK,SAAS,QAAS,QAAO;AAClE,OAAI,KAAK,OAAO,SAAS,YAAY,KAAK,SAAS,SAAU,QAAO;AACpE,OAAI,KAAK,OAAO,SAAS,eAAe,KAAK,SAAS,WACrD,QAAO;AACR,OAAI,KAAK,OAAO,SAAS,aAAa,KAAK,SAAS,QAAQ,KAAK,SAAS,OACzE,QAAO;;AAET,MAAI,YAAY,uBACf;OAAI,KAAK,OAAO,SAAS,mBAAmB,KAAK,SAAS,oBACzD,QAAO;;AAGT,MAAI,YAAY,qBAAqB;AACpC,QACE,KAAK,OAAO,SAAS,WAAW,KAAK,OAAO,SAAS,aACtD,KAAK,SAAS,SAEd,QAAO;AAER,OAAI,KAAK,OAAO,SAAS,YAAY,KAAK,SAAS,SAElD,QAAO,uBADW,oBAAoB,KAAK,eAAe,GAAG,UAAU,QAAQ,CACvC;;AAI1C,SAAO;;AAGR,KAAI,YAAY,qBAAqB;AACpC,OAAK,KAAK,OAAO,SAAS,WAAW,KAAK,OAAO,SAAS,aAAa,KAAK,SAAS,SACpF,SAAQ,QAAQ,QAAhB;GACC,KAAK,gBACJ,QAAO;GACR,KAAK,MACJ,QAAO,GAAG,QAAQ,aAAa,IAAI,MAAM;GAC1C,QACC,OAAM,IAAI,MAAM,mBAAmB,QAAQ,SAAS;;AAIvD,MAAI,KAAK,OAAO,SAAS,YAAY,KAAK,SAAS,SAClD,SAAQ,QAAQ,QAAhB;GACC,KAAK;AACJ,QAAI,eAAe,MAAM,QAAQ,CAChC,QAAO,GAAG,oBAAoB,KAAK,eAAe,GAAG,UAAU,QAAQ,CAAC;AAEzE;GACD,KAAK,MACJ,QAAO,GAAG,QAAQ,aAAa,IAAI,MAAM,UAAU,oBAAoB,KAAK,eAAe,GAAG,UAAU,QAAQ,CAAC;GAClH,QACC,OAAM,IAAI,MAAM,mBAAmB,QAAQ,SAAS;;;AAKxD,KAAI,YAAY,0BACf;MAAI,KAAK,OAAO,SAAS,aAAa,KAAK,SAAS,QAAQ,KAAK,SAAS,OACzE,SAAQ,QAAQ,QAAhB;GACC,KAAK,gBACJ,QAAO;GACR,KAAK,MACJ,QAAO,GAAG,QAAQ,aAAa,IAAI,MAAM;GAC1C,QACC,OAAM,IAAI,MAAM,mBAAmB,QAAQ,SAAS;;;CAKxD,MAAM,kBACL,YAAY,QAAQ,eAAe,QAAQ,QAAQ,GAAG,QAAQ,IAC9D,KAAK,OAAO,SAAS,QAAQ,QAAQ,GAAG;CAEzC,MAAM,aAAa,QAAQ,eAAe,KAAK,OAAO,SAAS,KAAK,OAAO,MAAM,KAAK,KAAK;CAE3F,MAAM,cAAc,kBACjB,KAAK,OACL,GAAG,cAAc,YAAY,KAAK,OAAO,KAAK,CAAC,GAAG,YAAY,KAAK,KAAK;CAE3E,MAAM,wBAAwB,KAAK,eAAe,QAAQ,QAAQ,CAAC,IAAI,QAAQ;AAE/E,SAAQ,QAAQ,QAAhB;EACC,KAAK,gBACJ,QAAO;EACR,KAAK;AACJ,OAAI,sBAAsB,WAAW,EACpC,QAAO;AAGR,UAAO,GAAG,YAAY;kBACP,sBAAsB,KAAK,WAAS,oBAAoBA,OAAK,UAAU,QAAQ,CAAC,CAAC,KAAK,KAAK,CAAC;EAC5G,QACC,OAAM,IAAI,MAAM,mBAAmB,QAAQ,SAAS;;;AAIvD,MAAM,oBAAoB;CACzB;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;AAED,SAAgB,YAAY,MAAc;AACzC,QAAO,kBAAkB,SAAS,KAAK,GAAG,IAAI,SAAS"}

package/dist/utils.mjs

@@ -0,0 +1,89 @@
+import { HANEUL_FRAMEWORK_ADDRESS, HANEUL_SYSTEM_ADDRESS } from "./render-types.mjs";
+import { format } from "prettier";
+import ts from "typescript";
+
+//#region src/utils.ts
+function printNodes(...nodes) {
+	const printer = ts.createPrinter({ removeComments: false });
+	return nodes.map((node) => printer.printNode(ts.EmitHint.Unspecified, node, node.getSourceFile())).join("\n");
+}
+function parseTS(strings, ...values) {
+	const lines = strings.reduce((acc, str, i) => {
+		if (typeof values[i] === "object") {
+			if (Array.isArray(values[i])) return `${acc}${str}${printNodes(...values[i])}`;
+			return `${acc}${str}${printNodes(values[i])}`;
+		}
+		return `${acc}${str}${values[i] ?? ""}`;
+	}, "").replace(/^\s/m, "").split("\n");
+	const indent = lines[0].match(/^\s*/)?.[0] ?? "";
+	const unIndented = lines.map((line) => line.replace(indent, "")).join("\n");
+	return [...ts.createSourceFile("file.ts", unIndented, ts.ScriptTarget.Latest, true).statements.values()];
+}
+async function mapToObject({ items, mapper, getComment }) {
+	const fieldProps = await Promise.all((await Promise.all([...items].map(async (item) => {
+		const mapped = await mapper(item);
+		if (!mapped) return null;
+		const [key, value] = mapped;
+		return [
+			item,
+			key,
+			value
+		];
+	}))).filter((value) => value !== null).map(([item, key, value]) => {
+		const [node] = parseTS`({${key}: ${value}})`;
+		if (!ts.isExpressionStatement(node)) throw new Error("Expected Expression statement");
+		if (!ts.isParenthesizedExpression(node.expression)) throw new Error("Expected Parenthesized Expression");
+		if (!ts.isObjectLiteralExpression(node.expression.expression)) throw new Error("Expected Object Literal Expression");
+		const comment = getComment?.(item);
+		return withComment({ comment }, node.expression.expression.properties[0]);
+	}));
+	return ts.factory.createObjectLiteralExpression(fieldProps, true);
+}
+async function withComment(options, nodes) {
+	const comment = options.comment ?? options.doc;
+	if (comment) {
+		const firstNode = Array.isArray(nodes) ? nodes[0] : nodes;
+		ts.addSyntheticLeadingComment(firstNode, ts.SyntaxKind.MultiLineCommentTrivia, await formatComment(comment), true);
+	}
+	return nodes;
+}
+async function formatComment(text) {
+	const lines = (await format(text, {
+		printWidth: 80,
+		semi: true,
+		singleQuote: true,
+		tabWidth: 2,
+		trailingComma: "all",
+		useTabs: true,
+		proseWrap: "always",
+		parser: "markdown"
+	})).trim().replaceAll("*/", "*\\/").split("\n");
+	if (lines.length === 1) return `* ${lines[0]} `;
+	return `*\n${lines.map((line) => ` * ${line}`).join("\n")}\n `;
+}
+function camelCase(str) {
+	return str.replaceAll(/(?:_)([a-z])/g, (_, letter) => letter.toUpperCase());
+}
+function capitalize(str) {
+	return str.charAt(0).toUpperCase() + str.slice(1);
+}
+function isWellKnownObjectParameter(type, resolveAddress) {
+	if (typeof type === "string") return false;
+	if ("Reference" in type) return isWellKnownObjectParameter(type.Reference[1], resolveAddress);
+	if (!("Datatype" in type)) return false;
+	const { Datatype } = type;
+	const address = resolveAddress(Datatype.module.address);
+	if (address === HANEUL_FRAMEWORK_ADDRESS) {
+		if (Datatype.module.name === "deny_list") return Datatype.name === "DenyList";
+		if (Datatype.module.name === "random") return Datatype.name === "Random";
+		if (Datatype.module.name === "clock") return Datatype.name === "Clock";
+	}
+	if (address === HANEUL_SYSTEM_ADDRESS) {
+		if (Datatype.module.name === "haneul_system") return Datatype.name === "HaneulSystemState";
+	}
+	return false;
+}
+
+//#endregion
+export { camelCase, capitalize, formatComment, isWellKnownObjectParameter, mapToObject, parseTS, printNodes, withComment };
+//# sourceMappingURL=utils.mjs.map

package/dist/utils.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.mjs","names":[],"sources":["../src/utils.ts"],"sourcesContent":["// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\nimport { format } from 'prettier';\nimport ts from 'typescript';\nimport type { Type } from './types/summary.js';\nimport { HANEUL_FRAMEWORK_ADDRESS, HANEUL_SYSTEM_ADDRESS } from './render-types.js';\n\nexport function printNodes(...nodes: ts.Node[]) {\n\tconst printer = ts.createPrinter({\n\t\tremoveComments: false,\n\t});\n\n\treturn nodes\n\t\t.map((node) => printer.printNode(ts.EmitHint.Unspecified, node, node.getSourceFile()))\n\t\t.join('\\n');\n}\n\ntype TSTemplateValue = string | number | boolean | ts.Statement[] | ts.Expression;\n\nexport function parseTS(strings: TemplateStringsArray, ...values: TSTemplateValue[]) {\n\tconst source = strings.reduce((acc, str, i) => {\n\t\tif (typeof values[i] === 'object') {\n\t\t\tif (Array.isArray(values[i])) {\n\t\t\t\treturn `${acc}${str}${printNodes(...values[i])}`;\n\t\t\t}\n\n\t\t\treturn `${acc}${str}${printNodes(values[i])}`;\n\t\t}\n\n\t\treturn `${acc}${str}${values[i] ?? ''}`;\n\t}, '');\n\n\tconst lines = source.replace(/^\\s/m, '').split('\\n');\n\tconst firstLine = lines[0];\n\tconst indent = firstLine.match(/^\\s*/)?.[0] ?? '';\n\tconst unIndented = lines.map((line) => line.replace(indent, '')).join('\\n');\n\n\tconst sourceFile = ts.createSourceFile('file.ts', unIndented, ts.ScriptTarget.Latest, true);\n\treturn [...sourceFile.statements.values()];\n}\n\nexport async function mapToObject<T>({\n\titems,\n\tmapper,\n\tgetComment,\n}: {\n\titems: Iterable<T>;\n\tmapper: (item: T) => Promise<null | [string, TSTemplateValue]> | null | [string, TSTemplateValue];\n\tgetComment?: (item: T) => string | null | undefined;\n}) {\n\tconst fieldProps = await Promise.all(\n\t\t(\n\t\t\tawait Promise.all(\n\t\t\t\t[...items].map(async (item) => {\n\t\t\t\t\tconst mapped = await mapper(item);\n\t\t\t\t\tif (!mapped) {\n\t\t\t\t\t\treturn null;\n\t\t\t\t\t}\n\n\t\t\t\t\tconst [key, value] = mapped;\n\t\t\t\t\treturn [item, key, value] as const;\n\t\t\t\t}),\n\t\t\t)\n\t\t)\n\t\t\t.filter((value) => value !== null)\n\t\t\t.map(([item, key, value]) => {\n\t\t\t\tconst [node] = parseTS /* ts */ `({${key}: ${value}})`;\n\n\t\t\t\tif (!ts.isExpressionStatement(node)) {\n\t\t\t\t\tthrow new Error('Expected Expression statement');\n\t\t\t\t}\n\n\t\t\t\tif (!ts.isParenthesizedExpression(node.expression)) {\n\t\t\t\t\tthrow new Error('Expected Parenthesized Expression');\n\t\t\t\t}\n\n\t\t\t\tif (!ts.isObjectLiteralExpression(node.expression.expression)) {\n\t\t\t\t\tthrow new Error('Expected Object Literal Expression');\n\t\t\t\t}\n\n\t\t\t\tconst comment = getComment?.(item);\n\t\t\t\treturn withComment({ comment }, node.expression.expression.properties[0]);\n\t\t\t}),\n\t);\n\n\treturn ts.factory.createObjectLiteralExpression(fieldProps, true);\n}\n\nexport async function withComment<T extends ts.Node | ts.Node[]>(\n\toptions:\n\t\t| { comment?: string | null; doc?: never }\n\t\t| { doc?: string | null | undefined; comment?: never },\n\tnodes: T,\n): Promise<T> {\n\tconst comment = options.comment ?? options.doc;\n\n\tif (comment) {\n\t\tconst firstNode = Array.isArray(nodes) ? nodes[0] : (nodes as ts.Node);\n\t\tts.addSyntheticLeadingComment(\n\t\t\tfirstNode,\n\t\t\tts.SyntaxKind.MultiLineCommentTrivia,\n\t\t\tawait formatComment(comment),\n\t\t\ttrue,\n\t\t);\n\t}\n\n\treturn nodes;\n}\n\nexport async function formatComment(text: string) {\n\tconst lines = (\n\t\tawait format(text, {\n\t\t\tprintWidth: 80,\n\t\t\tsemi: true,\n\t\t\tsingleQuote: true,\n\t\t\ttabWidth: 2,\n\t\t\ttrailingComma: 'all',\n\t\t\tuseTabs: true,\n\t\t\tproseWrap: 'always',\n\t\t\tparser: 'markdown',\n\t\t})\n\t)\n\t\t.trim()\n\t\t.replaceAll('*/', '*\\\\/')\n\t\t.split('\\n');\n\n\tif (lines.length === 1) return `* ${lines[0]} `;\n\n\treturn `*\\n${lines.map((line) => ` * ${line}`).join('\\n')}\\n `;\n}\n\nexport function camelCase(str: string) {\n\treturn str.replaceAll(/(?:_)([a-z])/g, (_, letter) => letter.toUpperCase());\n}\n\nexport function capitalize(str: string) {\n\treturn str.charAt(0).toUpperCase() + str.slice(1);\n}\n\nexport function isWellKnownObjectParameter(\n\ttype: Type,\n\tresolveAddress: (address: string) => string,\n) {\n\tif (typeof type === 'string') {\n\t\treturn false;\n\t}\n\n\tif ('Reference' in type) {\n\t\treturn isWellKnownObjectParameter(type.Reference[1], resolveAddress);\n\t}\n\n\tif (!('Datatype' in type)) {\n\t\treturn false;\n\t}\n\n\tconst { Datatype } = type;\n\n\tconst address = resolveAddress(Datatype.module.address);\n\tif (address === HANEUL_FRAMEWORK_ADDRESS) {\n\t\tif (Datatype.module.name === 'deny_list') {\n\t\t\treturn Datatype.name === 'DenyList';\n\t\t}\n\n\t\tif (Datatype.module.name === 'random') {\n\t\t\treturn Datatype.name === 'Random';\n\t\t}\n\n\t\tif (Datatype.module.name === 'clock') {\n\t\t\treturn Datatype.name === 'Clock';\n\t\t}\n\t}\n\n\tif (address === HANEUL_SYSTEM_ADDRESS) {\n\t\tif (Datatype.module.name === 'haneul_system') {\n\t\t\treturn Datatype.name === 'HaneulSystemState';\n\t\t}\n\t}\n\n\treturn false;\n}\n"],"mappings":";;;;;AAOA,SAAgB,WAAW,GAAG,OAAkB;CAC/C,MAAM,UAAU,GAAG,cAAc,EAChC,gBAAgB,OAChB,CAAC;AAEF,QAAO,MACL,KAAK,SAAS,QAAQ,UAAU,GAAG,SAAS,aAAa,MAAM,KAAK,eAAe,CAAC,CAAC,CACrF,KAAK,KAAK;;AAKb,SAAgB,QAAQ,SAA+B,GAAG,QAA2B;CAapF,MAAM,QAZS,QAAQ,QAAQ,KAAK,KAAK,MAAM;AAC9C,MAAI,OAAO,OAAO,OAAO,UAAU;AAClC,OAAI,MAAM,QAAQ,OAAO,GAAG,CAC3B,QAAO,GAAG,MAAM,MAAM,WAAW,GAAG,OAAO,GAAG;AAG/C,UAAO,GAAG,MAAM,MAAM,WAAW,OAAO,GAAG;;AAG5C,SAAO,GAAG,MAAM,MAAM,OAAO,MAAM;IACjC,GAAG,CAEe,QAAQ,QAAQ,GAAG,CAAC,MAAM,KAAK;CAEpD,MAAM,SADY,MAAM,GACC,MAAM,OAAO,GAAG,MAAM;CAC/C,MAAM,aAAa,MAAM,KAAK,SAAS,KAAK,QAAQ,QAAQ,GAAG,CAAC,CAAC,KAAK,KAAK;AAG3E,QAAO,CAAC,GADW,GAAG,iBAAiB,WAAW,YAAY,GAAG,aAAa,QAAQ,KAAK,CACrE,WAAW,QAAQ,CAAC;;AAG3C,eAAsB,YAAe,EACpC,OACA,QACA,cAKE;CACF,MAAM,aAAa,MAAM,QAAQ,KAE/B,MAAM,QAAQ,IACb,CAAC,GAAG,MAAM,CAAC,IAAI,OAAO,SAAS;EAC9B,MAAM,SAAS,MAAM,OAAO,KAAK;AACjC,MAAI,CAAC,OACJ,QAAO;EAGR,MAAM,CAAC,KAAK,SAAS;AACrB,SAAO;GAAC;GAAM;GAAK;GAAM;GACxB,CACF,EAEA,QAAQ,UAAU,UAAU,KAAK,CACjC,KAAK,CAAC,MAAM,KAAK,WAAW;EAC5B,MAAM,CAAC,QAAQ,OAAiB,KAAK,IAAI,IAAI,MAAM;AAEnD,MAAI,CAAC,GAAG,sBAAsB,KAAK,CAClC,OAAM,IAAI,MAAM,gCAAgC;AAGjD,MAAI,CAAC,GAAG,0BAA0B,KAAK,WAAW,CACjD,OAAM,IAAI,MAAM,oCAAoC;AAGrD,MAAI,CAAC,GAAG,0BAA0B,KAAK,WAAW,WAAW,CAC5D,OAAM,IAAI,MAAM,qCAAqC;EAGtD,MAAM,UAAU,aAAa,KAAK;AAClC,SAAO,YAAY,EAAE,SAAS,EAAE,KAAK,WAAW,WAAW,WAAW,GAAG;GACxE,CACH;AAED,QAAO,GAAG,QAAQ,8BAA8B,YAAY,KAAK;;AAGlE,eAAsB,YACrB,SAGA,OACa;CACb,MAAM,UAAU,QAAQ,WAAW,QAAQ;AAE3C,KAAI,SAAS;EACZ,MAAM,YAAY,MAAM,QAAQ,MAAM,GAAG,MAAM,KAAM;AACrD,KAAG,2BACF,WACA,GAAG,WAAW,wBACd,MAAM,cAAc,QAAQ,EAC5B,KACA;;AAGF,QAAO;;AAGR,eAAsB,cAAc,MAAc;CACjD,MAAM,SACL,MAAM,OAAO,MAAM;EAClB,YAAY;EACZ,MAAM;EACN,aAAa;EACb,UAAU;EACV,eAAe;EACf,SAAS;EACT,WAAW;EACX,QAAQ;EACR,CAAC,EAED,MAAM,CACN,WAAW,MAAM,OAAO,CACxB,MAAM,KAAK;AAEb,KAAI,MAAM,WAAW,EAAG,QAAO,KAAK,MAAM,GAAG;AAE7C,QAAO,MAAM,MAAM,KAAK,SAAS,MAAM,OAAO,CAAC,KAAK,KAAK,CAAC;;AAG3D,SAAgB,UAAU,KAAa;AACtC,QAAO,IAAI,WAAW,kBAAkB,GAAG,WAAW,OAAO,aAAa,CAAC;;AAG5E,SAAgB,WAAW,KAAa;AACvC,QAAO,IAAI,OAAO,EAAE,CAAC,aAAa,GAAG,IAAI,MAAM,EAAE;;AAGlD,SAAgB,2BACf,MACA,gBACC;AACD,KAAI,OAAO,SAAS,SACnB,QAAO;AAGR,KAAI,eAAe,KAClB,QAAO,2BAA2B,KAAK,UAAU,IAAI,eAAe;AAGrE,KAAI,EAAE,cAAc,MACnB,QAAO;CAGR,MAAM,EAAE,aAAa;CAErB,MAAM,UAAU,eAAe,SAAS,OAAO,QAAQ;AACvD,KAAI,YAAY,0BAA0B;AACzC,MAAI,SAAS,OAAO,SAAS,YAC5B,QAAO,SAAS,SAAS;AAG1B,MAAI,SAAS,OAAO,SAAS,SAC5B,QAAO,SAAS,SAAS;AAG1B,MAAI,SAAS,OAAO,SAAS,QAC5B,QAAO,SAAS,SAAS;;AAI3B,KAAI,YAAY,uBACf;MAAI,SAAS,OAAO,SAAS,gBAC5B,QAAO,SAAS,SAAS;;AAI3B,QAAO"}

package/docs/index.md

@@ -0,0 +1,436 @@
+# Haneul TypeScript Codegen
+
+> Generate type-safe TypeScript bindings from on-chain Haneul Move packages
+
+The `@haneullabs/codegen` package automatically generates type-safe TypeScript code from your Move
+packages, enabling seamless interaction with your smart contracts from TypeScript applications.
+
+> **Warning:** This package is currently in development and may have breaking changes.
+
+## Features
+
+- **Type-safe Move calls**: Generate TypeScript functions with full type safety for calling your
+  Move functions
+- **BCS type definitions**: Automatic BCS struct definitions for parsing on-chain data
+- **Auto-completion**: IDE support with intelligent code completion for Move function arguments
+- **Package resolution**: Support for both MVR-registered packages and local packages
+
+## Installation
+
+Install the codegen package as a dev dependency:
+
+```sh npm2yarn
+npm install -D @haneullabs/codegen
+```
+
+## Quick Start
+
+### 1. Create a configuration file
+
+Create a `haneul-codegen.config.ts` file in your project root:
+
+```typescript
+const config: HaneulCodegenConfig = {
+	output: './src/contracts',
+	packages: [
+		{
+			package: '@local-pkg/counter',
+			path: './move/counter',
+		},
+	],
+};
+```
+
+### 2. Generate TypeScript code
+
+Add a script to your `package.json`:
+
+```json
+{
+	"scripts": {
+		"codegen": "haneul-ts-codegen generate"
+	}
+}
+```
+
+Then run:
+
+```bash
+pnpm codegen
+```
+
+This generates TypeScript code in your configured output directory (e.g., `./src/contracts`).
+
+## Configuration Options
+
+The `HaneulCodegenConfig` type supports the following options:
+
+| Option                         | Type                   | Default | Description                                                                                                                                                           |
+| ------------------------------ | ---------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `output`                       | `string`               | —       | The directory where generated code will be written                                                                                                                    |
+| `packages`                     | `PackageConfig[]`      | —       | Array of Move packages to generate code for                                                                                                                           |
+| `prune`                        | `boolean`              | `true`  | When enabled, only generates code for the main package and omits dependency modules (dependency types referenced by included types are still generated under `deps/`) |
+| `generateSummaries`            | `boolean`              | `true`  | Automatically run `haneul move summary` before generating code. Creates a `package_summaries` directory in your Move package which can be added to `.gitignore`       |
+| `generate`                     | `GenerateOptions`      | —       | Default [generate options](#the-generate-option) (types, functions) for all packages                                                                                  |
+| `importExtension`              | `'.js' \| '.ts' \| ''` | `'.js'` | File extension used in generated import statements                                                                                                                    |
+| `includePhantomTypeParameters` | `boolean`              | `false` | Include [phantom type parameters](#phantom-types) as function arguments in generated BCS types                                                                        |
+
+### Package Configuration
+
+Each entry in the `packages` array configures a Move package to generate code from. Packages can be
+local (from source) or on-chain (fetched from a network).
+
+#### Local Packages
+
+| Option        | Type                     | Required | Description                                        |
+| ------------- | ------------------------ | -------- | -------------------------------------------------- |
+| `package`     | `string`                 | yes      | Package identifier (e.g., `@local-pkg/my-package`) |
+| `path`        | `string`                 | yes      | Path to the Move package directory                 |
+| `packageName` | `string`                 | no       | Custom name for generated code directory           |
+| `generate`    | `PackageGenerateOptions` | no       | Control what gets generated from this package      |
+
+```typescript
+{
+  package: '@local-pkg/my-package',
+  path: './move/my-package',
+}
+```
+
+#### On-Chain Packages
+
+For packages already deployed on-chain, generate code directly from a package ID or MVR name without
+needing local source code:
+
+| Option        | Type                     | Required | Description                                   |
+| ------------- | ------------------------ | -------- | --------------------------------------------- |
+| `package`     | `string`                 | yes      | Package ID or MVR name                        |
+| `packageName` | `string`                 | yes      | Name for the generated code directory         |
+| `network`     | `'mainnet' \| 'testnet'` | yes      | Network to fetch the package from             |
+| `generate`    | `PackageGenerateOptions` | no       | Control what gets generated from this package |
+
+```typescript
+{
+  package: '0xabf837e98c26087cba0883c0a7a28326b1fa3c5e1e2c5abdb486f9e8f594c837',
+  packageName: 'pyth',
+  network: 'testnet',
+}
+```
+
+## The `generate` option
+
+The `generate` option controls what code is produced. It can be set at the global level (as a
+default for all packages), at the per-package level, and at the per-module level. More specific
+settings override less specific ones.
+
+When no `generate` option is set, everything is generated (all types and functions). Package-level
+`types` and `functions` also default to `true`. In the record form of `modules`, per-module `types`
+and `functions` default to `false` — you opt in to exactly what you need from each module. Use
+`true` as a shorthand to include everything from a module with package-level defaults.
+
+At the **global** and **package** levels, `types` and `functions` only accept boolean values (or an
+object for `functions`). Name-based filtering with `string[]` is only available at the **module**
+level inside the record form of `modules`, where the filter applies unambiguously to a single
+module.
+
+```typescript
+// Global or package level
+generate: {
+  types: true | false,
+  functions: true | false | { private: boolean | 'entry' },
+  modules: string[] | Record<string, true | { types?, functions? }>,  // package-level only
+}
+
+// Module level (inside the record form of modules)
+modules: {
+  my_module: true,  // shorthand for "include everything"
+  other_module: {
+    types: true | false | string[],
+    functions: true | false | string[] | { private: boolean | 'entry' },
+  }
+}
+```
+
+### Types
+
+Controls which BCS type definitions (structs and enums) are generated:
+
+- `true` — generate all types
+- `false` — skip type generation
+- `string[]` — generate only the listed types by name _(module level only)_
+
+### Functions
+
+Controls which Move function wrappers are generated:
+
+- `true` — generate all public functions and private entry functions
+- `false` — skip function generation
+- `string[]` — generate only the listed functions by name; includes private functions _(module level
+  only)_
+- `{ private: 'entry' }` — generate public functions plus private entry functions
+- `{ private: true }` — generate all functions including private
+- `{ private: false }` — only generate public functions
+
+### Modules
+
+Controls which modules from the package are included. Only available at the package level, not at
+the global level.
+
+- Not set (default) — include all modules
+- `string[]` — only include the listed modules
+- `Record<string, true | { types?, functions? }>` — only include the listed modules, with per-module
+  overrides for `types` and `functions`. Use `true` as a shorthand to include everything from a
+  module with package-level defaults
+
+### Examples
+
+Only generate code from specific modules of the Haneul framework:
+
+```typescript
+{
+  package: '0x0000000000000000000000000000000000000000000000000000000000000002',
+  packageName: '0x2',
+  network: 'testnet',
+  generate: {
+    modules: ['kiosk', 'kiosk_extension', 'transfer_policy'],
+  },
+}
+```
+
+Only generate a single type from a dependency (functions are omitted automatically since `generate`
+is configured and `functions` is not specified):
+
+```typescript
+{
+  package: '0xabf837e98c26087cba0883c0a7a28326b1fa3c5e1e2c5abdb486f9e8f594c837',
+  packageName: 'pyth',
+  network: 'testnet',
+  generate: {
+    modules: {
+      state: { types: ['State'] },
+    },
+  },
+}
+```
+
+Generate specific types and functions from individual modules:
+
+```typescript
+{
+  package: '@local-pkg/my-package',
+  path: './move/my-package',
+  generate: {
+    modules: {
+      token: {
+        types: ['Token', 'TokenMetadata'],
+        functions: ['mint', 'burn', 'transfer'],
+      },
+      admin: {
+        types: true,
+        functions: ['initialize'],
+      },
+    },
+  },
+}
+```
+
+Generate all types but include all private functions for a local package:
+
+```typescript
+{
+  package: '@local-pkg/my-package',
+  path: './move/my-package',
+  generate: {
+    functions: { private: true },
+  },
+}
+```
+
+### Dependency pruning
+
+The global `prune` option (default: `true`) controls whether dependency packages are included in the
+output. Even when pruning is enabled, dependency types referenced by your included types are still
+generated under `deps/`:
+
+```
+src/contracts/
+├── mypackage/
+│   ├── module_a.ts
+│   ├── module_b.ts
+│   └── deps/
+│       └── 0x2/
+│           └── balance.ts     # Auto-included dependency type
+└── utils/
+    └── index.ts               # Shared utilities (always generated)
+```
+
+Set `prune: false` to generate all dependency modules with their full types and functions.
+
+## Phantom Types
+
+In Move, phantom type parameters are type parameters that only appear at the type level and don't
+affect the runtime data layout of a struct. For example, `Balance<T>` has a phantom type parameter
+`T` that indicates the coin type, but the actual serialized data only contains a `u64` value:
+
+```move
+public struct Balance<phantom T> has store {
+    value: u64,
+}
+```
+
+### Default Behavior
+
+By default, codegen excludes phantom type parameters from the generated BCS type functions since
+they don't affect serialization. The generated type is a constant rather than a function:
+
+```typescript
+
+	name: `${$moduleName}::Balance<phantom T>`,
+	fields: {
+		value: bcs.u64(),
+	},
+});
+```
+
+This works correctly for parsing on-chain data because phantom types don't change the binary layout.
+
+> **Note:** With the default behavior, phantom parameters appear as literals in the type name (e.g.,
+> `Balance<phantom T>`). These names are useful for debugging but are not valid on-chain type tags.
+> If you need valid type names with resolved phantom parameters, enable
+> `includePhantomTypeParameters`.
+
+### Including Phantom Type Parameters
+
+If you need the phantom type parameters as function arguments (for example, to preserve type
+information for other tooling), enable `includePhantomTypeParameters`:
+
+```typescript
+const config: HaneulCodegenConfig = {
+	output: './src/contracts',
+	includePhantomTypeParameters: true,
+	packages: [
+		// ...
+	],
+};
+```
+
+With this option enabled, phantom type parameters become function arguments:
+
+```typescript
+
+	return new MoveStruct({
+		name: `${$moduleName}::Balance<${T.name}>` as const,
+		fields: {
+			value: bcs.u64(),
+		},
+	});
+}
+```
+
+## Using Generated Code
+
+### Calling Move Functions
+
+The generated code provides type-safe functions for calling Move functions:
+
+```typescript
+// Increment a counter
+const tx = new Transaction();
+tx.add(
+	counter.increment({
+		arguments: {
+			counter: '0x123...', // Counter object ID
+		},
+	}),
+);
+```
+
+### Parsing BCS Data
+
+Use generated BCS types to parse on-chain object data. Fetch the object with
+`include: { content: true }` and pass `object.content` to the generated type's `.parse()` method:
+
+```typescript
+async function readCounter(client: ClientWithCoreApi, id: string) {
+	const { object } = await client.core.getObject({
+		objectId: id,
+		include: { content: true },
+	});
+
+	// Parse the Move struct fields from BCS content
+	const parsed = CounterStruct.parse(object.content);
+	console.log('Counter value:', parsed.value);
+	console.log('Counter owner:', parsed.owner);
+
+	return parsed;
+}
+```
+
+> **Warning:** Always use `content`, not `objectBcs`, when parsing with generated types. The
+> `objectBcs` field contains a full object envelope with additional metadata that will cause parsing
+> to fail. See the [Core API docs](/haneul/clients/core#objectbcs) for details.
+
+## Client Configuration
+
+### Using with MVR (Move Version Registry)
+
+If your package is registered on MVR, the generated code works without additional configuration.
+
+### Local Packages
+
+For local packages using `@local-pkg/*` identifiers, configure your client with package overrides:
+
+```typescript
+const client = new HaneulGrpcClient({
+	network: 'testnet',
+	baseUrl: 'https://fullnode.testnet.haneul.io:443',
+	mvr: {
+		overrides: {
+			packages: {
+				'@local-pkg/counter': '0xYOUR_PACKAGE_ID',
+			},
+		},
+	},
+});
+```
+
+### With dApp Kit
+
+Configure package overrides when creating your dApp Kit instance:
+
+```typescript
+const GRPC_URLS = {
+	testnet: 'https://fullnode.testnet.haneul.io:443',
+};
+
+const PACKAGE_IDS = {
+	testnet: {
+		counter: '0xYOUR_PACKAGE_ID',
+	},
+};
+
+const dAppKit = createDAppKit({
+	networks: ['testnet'],
+	createClient: (network) => {
+		return new HaneulGrpcClient({
+			network,
+			baseUrl: GRPC_URLS[network],
+			mvr: {
+				overrides: {
+					packages: {
+						'@local-pkg/counter': PACKAGE_IDS[network].counter,
+					},
+				},
+			},
+		});
+	},
+});
+```
+
+## Related Resources
+
+- [create-dapp](/dapp-kit/getting-started/create-dapp) - Bootstrap a working dApp with codegen
+  already configured
+- [Haneul Move documentation](https://docs.haneul.io/concepts/haneul-move-concepts)
+- [BCS documentation](/bcs)
+- [Transaction building](/haneul/transaction-building/basics)
+- [dApp Kit](/dapp-kit)

package/docs/llms-index.md

@@ -0,0 +1,6 @@
+# TypeScript Codegen
+
+> Generate type-safe TypeScript code from Haneul Move packages
+
+- [Haneul TypeScript Codegen](./index.md): Generate type-safe TypeScript bindings from on-chain
+  Haneul Move packages