@cosmwasm/ts-codegen 0.35.7 → 1.1.0

package/LICENSE-Apache

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright (c) 2024 Interweb, Inc. <developers@cosmology.zone>
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+	http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/LICENSE-MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Interweb, Inc. <developers@cosmology.zone>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -18,7 +18,7 @@ Generate TypeScript SDKs for your CosmWasm smart contracts
 
 
 ```
-npm install -g @cosmwasm/ts-codegen
+npm install @cosmwasm/ts-codegen
 ```
 
 The quickest and easiest way to interact with CosmWasm Contracts. `@cosmwasm/ts-codegen` converts your CosmWasm smart contracts into dev-friendly TypeScript classes so you can focus on shipping code.
@@ -28,7 +28,6 @@ The quickest and easiest way to interact with CosmWasm Contracts. `@cosmwasm/ts-
 
 - [@cosmwasm/ts-codegen](#cosmwasmts-codegen)
   - [Table of contents](#table-of-contents)
-- [QuickStart](#quickstart)
 - [Usage](#usage)
     - [Programmatic Usage](#programmatic-usage)
     - [Types](#types)
@@ -47,35 +46,9 @@ The quickest and easiest way to interact with CosmWasm Contracts. `@cosmwasm/ts-
     - [Exporting Schemas](#exporting-schemas)
 - [Developing](#developing)
 - [Related](#related)
-## Quickstart
-
-Clone your project and `cd` into your contracts folder
-
-```sh
-git clone https://github.com/public-awesome/launchpad.git
-cd launchpad/contracts/sg721-base/
-```
-
-Run `cosmwasm-ts-codegen` to generate your code.
-
-```sh
-cosmwasm-ts-codegen generate \
-          --plugin client \
-          --schema ./schema \
-          --out ./ts \
-          --name SG721 \
-          --no-bundle
-```
-
-The output will be in the folder specified by `--out`, enjoy!
 
 ## Usage
 
-You can get started quickly using our `cli` by globally installing via npm:
-
-```
-npm install -g @cosmwasm/ts-codegen
-```
 ### Programmatic Usage
 
 For production usage, we recommend setting up a build script that uses the main entry point:
@@ -137,7 +110,7 @@ codegen({
 
 Typescript types and interfaces are generated in separate files so they can be imported into various generated plugins.
 
-[see example output code](https://gist.github.com/pyramation/107d4e8e30dc5eb3ffc07bc3000f4dd0)
+[see example output code](https://github.com/CosmWasm/ts-codegen/blob/main/__output__/sg721/Sg721.types.ts)
 
 #### Types Options
 
@@ -151,7 +124,7 @@ Typescript types and interfaces are generated in separate files so they can be i
 
 The `client` plugin will generate TS client classes for your contracts. This option generates a `QueryClient` for queries as well as a `Client` for queries and mutations.
 
-[see example output code](https://gist.github.com/pyramation/30508678b7563e286f06ccc5ac384817)
+[see example output code](https://github.com/CosmWasm/ts-codegen/blob/main/__output__/sg721/Sg721.client.ts )
 
 #### Client Options
 
@@ -161,20 +134,12 @@ The `client` plugin will generate TS client classes for your contracts. This opt
 | `client.execExtendsQuery`               | execute should extend query message clients          |
 | `client.noImplicitOverride`             | should match your tsconfig noImplicitOverride option |
 
-#### Client via CLI
 
-```sh
-cosmwasm-ts-codegen generate \
-    --plugin client
-    --schema ./schema \
-    --out ./ts \
-    --name MyContractName
- ```
 ### React Query
 
 Generate [react-query v3](https://react-query-v3.tanstack.com/) or [react-query v4](https://tanstack.com/query/v4/) bindings for your contracts with the `react-query` command.
 
-[see example output code](https://gist.github.com/pyramation/70aef28fd3af0ee164f7711704d3dfc0)
+[see example output code](https://github.com/CosmWasm/ts-codegen/blob/main/__output__/sg721/Sg721.react-query.ts)
 
 #### React Query Options
 
@@ -189,50 +154,11 @@ Generate [react-query v3](https://react-query-v3.tanstack.com/) or [react-query
 | `reactQuery.camelize`       | use camelCase style for property names                                       |
 
 
-#### React Query via CLI
-
-Here is an example without optional client, using v3 for `react-query`, without mutations:
-
-```sh
-cosmwasm-ts-codegen generate \
-    --plugin client \
-    --plugin react-query \
-    --schema ./schema \
-    --out ./ts \
-    --name MyContractName \
-    --version v3 \
-    --no-optionalClient \
-    --no-mutations
-```
-
-Example with optional client, using v4, with mutations:
-
-```sh
-cosmwasm-ts-codegen generate \
-    --plugin react-query \
-    --schema ./schema \
-    --out ./ts \
-    --name MyContractName \
-    --optionalClient \
-    --version v4 \
-    --mutations
-```
-
 ### Recoil
 
 Generate [recoil](https://recoiljs.org/) bindings for your contracts with the `recoil` command.
 
-[see example output code](https://gist.github.com/pyramation/a9520ccf131177b1841e02a97d7d3731)
-
-#### Recoil via CLI
-
-```sh
-cosmwasm-ts-codegen generate \
-    --plugin recoil \
-    --schema ./schema \
-    --out ./ts \
-    --name MyContractName
-```
+[see example output code](https://github.com/CosmWasm/ts-codegen/blob/main/__output__/sg721/Sg721.recoil.ts)
 
 #### Recoil Options
 
@@ -244,17 +170,8 @@ cosmwasm-ts-codegen generate \
 
 Generate pure message objects with the proper `utf8` encoding and `typeUrl` configured that you can broadcast yourself via `cosmjs` with the `message-composer` command.
 
-[see example output code](https://gist.github.com/pyramation/43320e8b952751a0bd5a77dbc5b601f4)
+[see example output code](https://github.com/CosmWasm/ts-codegen/blob/main/__output__/sg721/Sg721.message-composer.ts)
 
-#### Message Composer via CLI
-
-```sh
-cosmwasm-ts-codegen generate \
-    --plugin message-composer \
-    --schema ./schema \
-    --out ./ts \
-    --name MyContractName
-```
 #### Message Composer Options
 
 | option                         | description                                                         |
@@ -265,17 +182,8 @@ cosmwasm-ts-codegen generate \
 
 Generate raw message jsons for use in your application with the `message-builder` command.
 
-[see example output code](https://gist.github.com/adairrr/b394e62beb9856b0351883f776650f26)
-
-#### Message Builder via CLI
+[see example output code](https://github.com/CosmWasm/ts-codegen/blob/main/__output__/sg721/Sg721.message-builder.ts)
 
-```sh
-cosmwasm-ts-codegen generate \
-    --plugin message-builder \
-    --schema ./schema \
-    --out ./ts \
-    --name MyContractName
-```
 #### Message Builder Options
 
 | option                   | description                        |
@@ -426,6 +334,32 @@ Without using shorthand constructor:
 
 ### CLI Usage and Examples
 
+You can get started quickly using our `cli` by globally installing via npm:
+
+```
+npm install @cosmwasm/ts-codegen
+```
+
+Clone your project and `cd` into your contracts folder
+
+```sh
+git clone https://github.com/public-awesome/launchpad.git
+cd launchpad/contracts/whitelists/
+```
+
+Run `cosmwasm-ts-codegen` to generate your code.
+
+```sh
+cosmwasm-ts-codegen generate \
+          --plugin client \
+          --schema ./schema \
+          --out ./ts \
+          --name Whitelist \
+          --no-bundle
+```
+
+The output will be in the folder specified by `--out`, enjoy!
+
 #### Interactive prompt
 
 The CLI is interactive, and if you don't specify an option, it will interactively prompt you.
@@ -506,6 +440,77 @@ cosmwasm-ts-codegen generate \
           --name SG721
 ```
 
+#### Client via CLI
+
+```sh
+cosmwasm-ts-codegen generate \
+    --plugin client
+    --schema ./schema \
+    --out ./ts \
+    --name MyContractName
+```
+
+
+#### React Query via CLI
+
+Here is an example without optional client, using v3 for `react-query`, without mutations:
+
+```sh
+cosmwasm-ts-codegen generate \
+    --plugin client \
+    --plugin react-query \
+    --schema ./schema \
+    --out ./ts \
+    --name MyContractName \
+    --version v3 \
+    --no-optionalClient \
+    --no-mutations
+```
+
+Example with optional client, using v4, with mutations:
+
+```sh
+cosmwasm-ts-codegen generate \
+    --plugin react-query \
+    --schema ./schema \
+    --out ./ts \
+    --name MyContractName \
+    --optionalClient \
+    --version v4 \
+    --mutations
+```
+
+#### Recoil via CLI
+
+```sh
+cosmwasm-ts-codegen generate \
+    --plugin recoil \
+    --schema ./schema \
+    --out ./ts \
+    --name MyContractName
+```
+
+#### Message Composer via CLI
+
+```sh
+cosmwasm-ts-codegen generate \
+    --plugin message-composer \
+    --schema ./schema \
+    --out ./ts \
+    --name MyContractName
+```
+
+#### Message Builder via CLI
+
+```sh
+cosmwasm-ts-codegen generate \
+    --plugin message-builder \
+    --schema ./schema \
+    --out ./ts \
+    --name MyContractName
+```
+
+
 ### Advanced Usage
 
 for lower-level access, you can import the various plugins directly:
@@ -623,13 +628,13 @@ yarn build
 Then `cd` into a package and run the tests
 
 ```
-cd ./packages/wasm-ast-types
+cd ./packages/ast
 yarn test:watch
 ```
 
 ### Working with ASTs
 
-See the [docs](https://github.com/CosmWasm/ts-codegen/blob/main/packages/wasm-ast-types/README.md) in the `wasm-ast-types` package.
+See the [docs](https://github.com/CosmWasm/ts-codegen/blob/main/packages/ast/README.md) in the `wasm-ast-types` package.
 
 ## Related
 

package/{types/src/builder → builder}/builder.d.ts

@@ -15,7 +15,7 @@ export interface BundleOptions {
 export interface UseContractsOptions {
     enabled?: boolean;
 }
-export declare type TSBuilderOptions = {
+export type TSBuilderOptions = {
     bundle?: BundleOptions;
     /**
      * Enable using shorthand constructor.
@@ -24,7 +24,7 @@ export declare type TSBuilderOptions = {
     useShorthandCtor?: boolean;
     useContractsHooks?: UseContractsOptions;
 } & RenderOptions;
-export declare type BuilderFileType = 'type' | 'client' | 'recoil' | 'react-query' | 'message-composer' | 'message-builder' | 'plugin';
+export type BuilderFileType = 'type' | 'client' | 'recoil' | 'react-query' | 'message-composer' | 'message-builder' | 'plugin';
 export interface BuilderFile {
     type: BuilderFileType;
     pluginType?: string;