@burnt-labs/xion-types 19.0.2 → 21.0.0-alpha.0

package/README.md

@@ -0,0 +1,111 @@
+# @burnt-labs/xion-types
+
+TypeScript definitions for Xion Protobuf files. This package provides TypeScript type definitions generated from the Protobuf files used in the Xion project, enabling developers to work with Xion-related data structures in a type-safe way.
+
+## Table of Contents
+
+- [@burnt-labs/xion-types](#burnt-labsxion-types)
+  - [Table of Contents](#table-of-contents)
+  - [Installation](#installation)
+  - [Usage](#usage)
+  - [Example](#example)
+  - [Development](#development)
+  - [License](#license)
+
+---
+
+## Installation
+
+Install the **@burnt-labs/xion-types** package via npm or yarn:
+
+```bash
+# Using npm
+npm install @burnt-labs/xion-types
+
+# Using yarn
+yarn add @burnt-labs/xion-types
+```
+
+---
+
+## Usage
+
+Once installed, you can import the type definitions in your TypeScript project. The types are generated from the Protobuf files used in the Xion project.
+
+```typescript
+import { MyProtobufType } from '@burnt-labs/xion-types/types/filename';
+
+const myData: MyProtobufType = {
+  field1: 'value',
+  field2: 42
+};
+```
+
+> **Note:** Replace `filename` with the appropriate file name where the type is defined.
+
+---
+
+## Example
+
+Here is a full example of how you might use the **@burnt-labs/xion-types** package in a TypeScript project:
+
+```typescript
+import { MyProtobufType } from '@burnt-labs/xion-types/types/filename';
+
+function processData(data: MyProtobufType): void {
+  console.log(`Field 1: ${data.field1}`);
+  console.log(`Field 2: ${data.field2}`);
+}
+
+const sampleData: MyProtobufType = {
+  field1: 'Hello, Xion!',
+  field2: 100
+};
+
+processData(sampleData);
+```
+
+> This simple example illustrates how you can work with the types generated from Xion's Protobuf definitions.
+
+---
+
+## Development
+
+If you want to modify or regenerate the TypeScript definitions from Protobuf files, follow these steps:
+
+1. **Clone the Repository**
+   ```bash
+   git clone https://github.com/burnt-labs/xion.git
+   cd xion
+   ```
+
+2. **Install Dependencies**
+   ```bash
+   npm install
+   ```
+
+3. **Generate TypeScript Definitions**
+   ```bash
+   npx protoc --plugin=protoc-gen-ts=./node_modules/.bin/protoc-gen-ts \
+     --ts_out=./generated \
+     --proto_path=./proto \
+     $(find ./proto -name '*.proto')
+   ```
+
+4. **Compile TypeScript Files**
+   ```bash
+   tsc --noEmit
+   ```
+
+> These steps will generate the TypeScript definitions from the Protobuf files located in the `proto` directory.
+
+---
+
+## License
+
+This project is licensed under the MIT License. See the LICENSE file for details.
+
+---
+
+For more information, check out [Xion's GitHub repository](https://github.com/burnt-labs/xion).
+

package/index.d.ts

@@ -0,0 +1,3 @@
+export type { DeepPartial, Exact } from "./types/generated/cosmos/base/v1beta1/coin";
+export { protobufPackage } from "./types/generated/cosmos/base/v1beta1/coin";
+//# sourceMappingURL=index.d.ts.map

package/index.js

@@ -0,0 +1,12 @@
+"use strict";
+// Auto-generated index file
+// This file is automatically generated by generate-index.js
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.protobufPackage = void 0;
+// Export protobufPackage constant if needed
+var coin_1 = require("./types/generated/cosmos/base/v1beta1/coin");
+Object.defineProperty(exports, "protobufPackage", { enumerable: true, get: function () { return coin_1.protobufPackage; } });
+// Users should import specific types directly from their paths:
+// import { Coin } from "@burnt-labs/xion-types/cosmos/base/v1beta1/coin";
+// import { QueryWebAuthNVerifyRegisterRequest } from "@burnt-labs/xion-types/xion/v1/query";
+//# sourceMappingURL=index.js.map

package/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";AAAA,4BAA4B;AAC5B,4DAA4D;;;AAQ5D,4CAA4C;AAC5C,mEAA6E;AAApE,uGAAA,eAAe,OAAA;AAExB,gEAAgE;AAChE,0EAA0E;AAC1E,6FAA6F"}

package/index.ts

@@ -0,0 +1,15 @@
+// Auto-generated index file
+// This file is automatically generated by generate-index.js
+
+// Exports we want to provide at the root of the "@burnt-labs/xion-types" package
+// Following the cosmjs-types pattern - only export helpers, not all types
+
+// Export helper types from generated cosmos files
+export type { DeepPartial, Exact } from "./types/generated/cosmos/base/v1beta1/coin";
+
+// Export protobufPackage constant if needed
+export { protobufPackage } from "./types/generated/cosmos/base/v1beta1/coin";
+
+// Users should import specific types directly from their paths:
+// import { Coin } from "@burnt-labs/xion-types/cosmos/base/v1beta1/coin";
+// import { QueryWebAuthNVerifyRegisterRequest } from "@burnt-labs/xion-types/xion/v1/query";

package/package.json

@@ -1,13 +1,36 @@
 {
   "name": "@burnt-labs/xion-types",
-  "version": "v19.0.2",
-  "description": "TypeScript definitions for Xion",
+  "version": "21.0.0-alpha.0",
+  "description": "TypeScript definitions for Xion Protobuf files",
+  "main": "index.js",
   "types": "index.d.ts",
   "files": [
-    "**/*.d.ts",
-    "**/*.js"
+    "*/",
+    "!build/",
+    "!node_modules/",
+    "!types/",
+    "index.*",
+    "*.md"
   ],
-  "publishConfig": {
-    "access": "public"
+  "scripts": {
+    "codegen": "../../scripts/proto-gen.sh --ts && node generate-index.js",
+    "build": "rm -rf ./build && tsc && npm run prepare:dist",
+    "prepare:dist": "./prepare-dist.sh",
+    "prepack": "npm run codegen && npm run build",
+    "test": "jest"
+  },
+  "license": "MIT",
+  "dependencies": {
+    "@improbable-eng/grpc-web": "^0.14.1",
+    "browser-headers": "^0.4.1",
+    "google-protobuf": "^3.17.3",
+    "long": "^4.0.0",
+    "protobufjs": "~6.11.2"
+  },
+  "devDependencies": {
+    "@types/node": "^24.3.0",
+    "prettier": "^2.3.0",
+    "ts-proto": "^1.82.5",
+    "typescript": "^5.9.2"
   }
 }