@thalalabs/surf 0.0.1 → 0.0.3

package/.changeset/README.md

@@ -0,0 +1,15 @@
+# How to upgrade the version
+
+- Run `yarn changesets`, and describe you change. 
+- Commit the `.md` file generated by `changeset` together with your code changes. And merge your change.
+- Github Workflow will create a PR to change the version in `package.json`.
+- Github Workflow will publish a new version to NPM after we merge the PR.
+
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

package/.changeset/config.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://unpkg.com/@changesets/config@2.3.0/schema.json",
+  "changelog": "@changesets/cli/changelog",
+  "commit": false,
+  "fixed": [],
+  "linked": [],
+  "access": "public",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": []
+}

package/.github/workflows/publish.yml

@@ -0,0 +1,31 @@
+name: Publish
+on:
+  workflow_run:
+    workflows: ["CI"]
+    types:
+      - completed
+  push:
+    branches:
+      - "main"
+
+concurrency: ${{ github.workflow }}-${{ github.ref }}
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+      - run: yarn install --frozen-lockfile
+      - run: yarn test
+      - name: Create Release Pull Request or Publish
+        id: changesets
+        uses: changesets/action@v1
+        with:
+          publish: yarn release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @thalalabs/surf
+
+## 0.0.3
+
+### Patch Changes
+
+- 5d3395d: Add changeset as devDependency and use it to manage the versioning and releasing.

package/README.md

@@ -9,29 +9,14 @@
 <p>
 
 <p align="center">
-  <a href="https://www.npmjs.com/package/viem">
-    <picture>
-      <source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/npm/v/viem?colorA=21262d&colorB=21262d&style=flat">
-      <img src="https://img.shields.io/npm/v/viem?colorA=f6f8fa&colorB=f6f8fa&style=flat" alt="Version">
-    </picture>
-  </a>
-  <a href="https://app.codecov.io/gh/wagmi-dev/viem">
-    <picture>
-      <source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/codecov/c/github/wagmi-dev/viem?colorA=21262d&colorB=21262d&style=flat">
-      <img src="https://img.shields.io/codecov/c/github/wagmi-dev/viem?colorA=f6f8fa&colorB=f6f8fa&style=flat" alt="Code coverage">
-    </picture>
+  <a href="https://www.npmjs.com/package/@thalalabs/surf">
+      <img src="https://img.shields.io/npm/v/@thalalabs/surf?colorA=2c8af7&colorB=2c8af7&style=flat" alt="Version">
   </a>
   <a href="https://github.com/ThalaLabs/surf/blob/main/LICENSE">
-    <picture>
-      <source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/npm/l/viem?colorA=21262d&colorB=21262d&style=flat">
-      <img src="https://img.shields.io/npm/l/viem?colorA=f6f8fa&colorB=f6f8fa&style=flat" alt="MIT License">
-    </picture>
+      <img src="https://img.shields.io/npm/l/@thalalabs/surf?colorA=2c8af7&colorB=2c8af7&style=flat" alt="MIT License">
   </a>
-  <a href="https://bestofjs.org/projects/viem">
-    <picture>
-      <source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/endpoint?colorA=21262d&colorB=21262d&style=flat&url=https://bestofjs-serverless.now.sh/api/project-badge?fullName=wagmi-dev%2Fviem%26since=daily">
-      <img src="https://img.shields.io/endpoint?colorA=f6f8fa&colorB=f6f8fa&style=flat&url=https://bestofjs-serverless.now.sh/api/project-badge?fullName=wagmi-dev%2Fviem%26since=daily" alt="Best of JS">
-    </picture>
+  <a href="https://bundlephobia.com/package/@thalalabs/surf">
+      <img src="https://img.shields.io/bundlephobia/minzip/@thalalabs/surf?colorA=2c8af7&colorB=2c8af7&style=flat" alt="MIT License">
   </a>
 </p>
 
@@ -39,11 +24,11 @@
 
 ## Features
 
-- **No code-generation**: Interact with smart contracts using fully typed APIs based on static type inference.
+- **No code-generation**: Interact with smart contracts using fully typed APIs based on static type inference. Inspired by [Viem](https://viem.sh/).
 - **Get rid of encoding/decoding**: Surf takes care of the complexities within the APIs, so you don't have to.
 - **Linting and Auto-Completion**: Enjoy a better development experience with type safety. No more guesswork for input and output.
 - **Both TypeScript Interfaces & React Hooks**: Easy to use, whether working with wallets or private keys.
-- **Low runtime cost & small bundle size**: Modular, tree-shakable, [100kb]().
+- **Low runtime cost & small bundle size**: [minzipped size: 1.77 kB](https://bundlephobia.com/package/@thalalabs/surf).
 
 ## Overview
 
@@ -179,9 +164,9 @@ const { hash } = await client.simulateTransaction(
 );
 ```
 
-### Hooks
+### React Hooks
 
-Surf currently offers two React Hooks: `useWalletClient` and `useSubmitTransaction`. Both require the `@aptos-labs/wallet-adapter-react`. Check out our [example NextJS package](https://github.com/ThalaLabs/surf/blob/main/example/app/page.tsx) for more information.
+Surf currently offers two React Hooks: `useWalletClient` and `useSubmitTransaction`. Both require the `@aptos-labs/wallet-adapter-react`. Check out the [example NextJS package](https://github.com/ThalaLabs/surf/blob/main/example/app/page.tsx) for more information.
 
 ## Motivation
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thalalabs/surf",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "TypeScript Interfaces & React Hooks for interacting with Aptos Smart Contracts with type safety.",
   "main": "./build/cjs/index.js",
   "module": "./build/esm/index.js",
@@ -25,11 +25,14 @@
   },
   "typesVersions": {
     "*": {
-      "hooks": ["./build/types/hooks/index.d.ts"]
+      "hooks": [
+        "./build/types/hooks/index.d.ts"
+      ]
     }
   },
   "devDependencies": {
     "@aptos-labs/wallet-adapter-react": "^1.1.0",
+    "@changesets/cli": "^2.26.1",
     "@types/jest": "~29.5",
     "@types/node": "~18",
     "@types/react": "^18.2.8",
@@ -49,10 +52,18 @@
     "typescript": "~5.0"
   },
   "peerDependencies": {
-    "@aptos-labs/wallet-adapter-react": "^1.1.0",
-    "aptos": "^1.9.0",
+    "@aptos-labs/wallet-adapter-react": "^1.0.0",
+    "aptos": "^1.6.0",
     "react": "^18.2.0"
   },
+  "peerDependenciesMeta": {
+    "@aptos-labs/wallet-adapter-react": {
+      "optional": true
+    },
+    "react": {
+      "optional": true
+    }
+  },
   "scripts": {
     "start": "node build/src/main.js",
     "clean": "rimraf coverage build tmp",
@@ -66,13 +77,17 @@
     "test": "jest --coverage",
     "prettier": "prettier --config .prettierrc --write .",
     "test:watch": "jest --watch",
-    "prepublishOnly": "yarn build"
+    "release": "yarn build && changeset publish"
   },
   "keywords": [
     "move",
     "blockchain",
     "aptos"
   ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ThalaLabs/surf"
+  },
   "license": "MIT",
   "dependencies": {}
-}
+}