create-blocklet 0.9.5 → 0.9.7

package/templates/nextjs-dapp/README.md

@@ -1,10 +1,7 @@
-# Getting Started with Create Blocklet
-
-This project was bootstrapped with [Create Blocklet](https://github.com/blocklet/create-blocklet).
-
+## PROJECT_DESCRIPTION
 This blocklet is a dapp project, which means this is a full-stack application. It's contained both `api` and `client` code.
 
-## File Structure
+## FILE_STRUCTURE
 
 - public/ - static files
   - favicon.ico - favicon
@@ -31,123 +28,3 @@ This blocklet is a dapp project, which means this is a full-stack application. I
 - package.json - Npm package file
 - README.md - A guide for this blocklet
 - version - Version file
-
-## Development
-
-1. Make sure you have [@blocklet/cli](https://www.npmjs.com/package/@blocklet/cli) installed
-
-   Blocklet needs blocklet server as a dependency. So you need to install it first.
-   `npm install -g @blocklet/cli`
-   See details in [https://www.arcblock.io/docs/blocklet-developer/install-blocklet-cli](https://www.arcblock.io/docs/blocklet-developer/install-blocklet-cli)
-
-2. Init blocklet server & start blocklet server
-
-   Before starting an blocklet server, you need to init blocklet server.
-   `blocklet server init --mode=debug`
-   `blocklet server start`
-   See details in [https://www.arcblock.io/docs/blocklet-developer/getting-started](https://www.arcblock.io/docs/blocklet-developer/getting-started)
-
-3. Go to the project directory `cd [name]`
-4. Install dependencies: `npm install` or `yarn`
-5. Start development server: `blocklet dev`
-
-## Bundle
-
-After developing a blocklet, you may need to bundle it. Use `npm run bundle` command.
-
-## Deploy
-
-- If you want to deploy this blocklet to local blocklet server, you can use `blocklet deploy .blocklet/bundle` command(Make sure the blocklet is bundled before deployment).
-  > Or you can simply use `npm run deploy` command.
-- If you want to deploy this blocklet to remote blocklet server, you can use the command below.
-
-  ```shell
-  blocklet deploy .blocklet/bundle --endpoint {your blocklet server url} --access-key {blocklet server access key} --access-secret {blocklet server access secret}
-  ```
-
-  > Make sure the blocklet is bundled before deployment.
-
-## Upload to blocklet store
-
-- If you want to upload the blocklet to any store for other users to download and use, you can following the following instructions.
-
-  Bump version at first.
-
-  ```shell
-  make bump-version
-  ```
-
-  Then config blocklet store url.
-  You can use those store url in below.
-
-  1. [https://store.blocklet.dev/](https://store.blocklet.dev/)
-  2. [https://dev.store.blocklet.dev/](https://dev.store.blocklet.dev/)
-  3. A blocklet store started by yourself.
-     > Make sure you have installed a `blocklet store` on your own blocklet server. Check it on here: [https://store.blocklet.dev/blocklet/z8ia29UsENBg6tLZUKi2HABj38Cw1LmHZocbQ](https://store.blocklet.dev/blocklet/z8ia29UsENBg6tLZUKi2HABj38Cw1LmHZocbQ)
-
-  ```shell
-  blocklet config set store {store url}
-  ```
-
-  Get a `accessToken` by using this command.
-
-  > Why we need a `accessToken`?
-  > A `accessToken` is genrate by blocklet store, which help us upload our blocklet to any store.
-
-  Set `accessToken` to blocklet config
-
-  ```shell
-  blocklet config set accessToken {accessToken}
-  ```
-
-  Upload a new version to a store.
-
-  > Make sure the blocklet is bundled before upload.
-
-  ```shell
-  blocklet upload
-  ```
-
-  Or you can simply use `npm run upload` command.
-
-- You also can upload a new version to a store by Github CI.
-  Bump version at first.
-
-  ```shell
-  make bump-version
-  ```
-
-  Push your code to Github main/master branch, or make a pull request to the main/master branch.
-  The CI workflow will automatically upload a new version to a store.
-
-## Q & A
-
-1. Q: How to change a blocklet's name?
-
-   A: Change the `name` field in the `package.json` file, change the `name` field in the `blocklet.yml` file.
-
-   You can also change the `title` field and `description` field in the `blocklet.yml` file.
-
-   Run `blocklet meta` command, you will get a `did` config, copy the `did` value.
-
-   Replace this command `"bundle:client": "PUBLIC_URL='/.blocklet/proxy/{did}' npm run build",` in `package.json`
-
-   Replace `did` field in the `blocklet.yml`
-
-2. Q: How to change a blocklet's logo?
-
-   Change the `logo.png` file root folder.
-
-   Or you can change the `logo` field in the `blocklet.yml` file.
-
-   > Make sure you have added the logo path to the `blocklet.yml` file `files` field.
-
-## Learn More
-
-- Full specification of `blocklet.yml`: [https://github.com/blocklet/blocklet-specification/blob/main/docs/meta.md](https://github.com/blocklet/blocklet-specification/blob/main/docs/meta.md)
-- Full document of Blocklet Server & blocklet development: [https://www.arcblock.io/docs/blocklet-developer](https://www.arcblock.io/docs/blocklet-developer)
-
-## License
-
-The code is licensed under the Apache 2.0 license found in the
-[LICENSE](LICENSE) file.

package/templates/nextjs-dapp/blocklet.yml

@@ -1,4 +1,3 @@
-name: template-nextjs
 title: Blocklet Template Next.js
 description: A Blocklet DAPP blocklet
 keywords:

package/templates/nextjs-dapp/package.json

@@ -30,26 +30,26 @@
   "dependencies": {
     "@arcblock/did-auth": "^1.18.135",
     "@arcblock/did-auth-storage-nedb": "^1.7.1",
-    "@blocklet/sdk": "^1.16.30",
+    "@blocklet/sdk": "^1.16.31",
     "@ocap/client": "^1.18.135",
     "@ocap/mcrypto": "^1.18.135",
     "@ocap/wallet": "^1.18.135",
     "dotenv-flow": "^4.1.0",
-    "express": "^4.19.2",
+    "express": "^4.21.0",
     "next": "14.2.4",
     "react": "18.2.0",
     "react-dom": "18.2.0"
   },
   "devDependencies": {
-    "bumpp": "^9.4.1",
+    "bumpp": "^9.5.2",
     "eslint": "8.57.0",
     "eslint-config-next": "14.2.4",
-    "lint-staged": "^15.2.7",
-    "nodemon": "^3.1.4",
+    "lint-staged": "^15.2.10",
+    "nodemon": "^3.1.7",
     "npm-run-all": "^4.1.5",
-    "rimraf": "^5.0.7",
+    "rimraf": "^5.0.10",
     "simple-git-hooks": "^2.11.1",
-    "zx": "^8.1.4"
+    "zx": "^8.1.8"
   },
   "simple-git-hooks": {
     "pre-commit": "npx lint-staged"

package/templates/react-dapp/README.md

@@ -1,10 +1,8 @@
-# Getting Started with Create Blocklet
-
-This project was bootstrapped with [Create Blocklet](https://github.com/blocklet/create-blocklet).
+## PROJECT_DESCRIPTION
 
 This blocklet is a dapp project, which means this is a full-stack application. It's contained both `server` and `client` code.
 
-## File Structure
+## FILE_STRUCTURE
 
 - public/ - static files
   - favicon.ico - favicon
@@ -31,123 +29,3 @@ This blocklet is a dapp project, which means this is a full-stack application. I
 - package.json - Npm package file
 - README.md - A guide for this blocklet
 - version - Version file
-
-## Development
-
-1. Make sure you have [@blocklet/cli](https://www.npmjs.com/package/@blocklet/cli) installed
-
-   Blocklet needs blocklet server as a dependency. So you need to install it first.
-   `npm install -g @blocklet/cli`
-   See details in [https://www.arcblock.io/docs/blocklet-developer/install-blocklet-cli](https://www.arcblock.io/docs/blocklet-developer/install-blocklet-cli)
-
-2. Init blocklet server & start blocklet server
-
-   Before starting an blocklet server, you need to init blocklet server.
-   `blocklet server init --mode=debug`
-   `blocklet server start`
-   See details in [https://www.arcblock.io/docs/blocklet-developer/getting-started](https://www.arcblock.io/docs/blocklet-developer/getting-started)
-
-3. Go to the project directory `cd [name]`
-4. Install dependencies: `npm install` or `yarn`
-5. Start development server: `blocklet dev`
-
-## Bundle
-
-After developing a blocklet, you may need to bundle it. Use `npm run bundle` command.
-
-## Deploy
-
-- If you want to deploy this blocklet to local blocklet server, you can use `blocklet deploy .blocklet/bundle` command(Make sure the blocklet is bundled before deployment).
-  > Or you can simply use `npm run deploy` command.
-- If you want to deploy this blocklet to remote blocklet server, you can use the command below.
-
-  ```shell
-  blocklet deploy .blocklet/bundle --endpoint {your blocklet server url} --access-key {blocklet server access key} --access-secret {blocklet server access secret}
-  ```
-
-  > Make sure the blocklet is bundled before deployment.
-
-## Upload to blocklet store
-
-- If you want to upload the blocklet to any store for other users to download and use, you can following the following instructions.
-
-  Bump version at first.
-
-  ```shell
-  npm run bump-version
-  ```
-
-  Then config blocklet store url.
-  You can use those store url in below.
-
-  1. [https://store.blocklet.dev/](https://store.blocklet.dev/)
-  2. [https://dev.store.blocklet.dev/](https://dev.store.blocklet.dev/)
-  3. A blocklet store started by yourself.
-     > Make sure you have installed a `blocklet store` on your own blocklet server. Check it on here: [https://store.blocklet.dev/blocklet/z8ia29UsENBg6tLZUKi2HABj38Cw1LmHZocbQ](https://store.blocklet.dev/blocklet/z8ia29UsENBg6tLZUKi2HABj38Cw1LmHZocbQ)
-
-  ```shell
-  blocklet config set store {store url}
-  ```
-
-  Get a `accessToken` by using this command.
-
-  > Why we need a `accessToken`?
-  > A `accessToken` is genrate by blocklet store, which help us upload our blocklet to any store.
-
-  Set `accessToken` to blocklet config
-
-  ```shell
-  blocklet config set accessToken {accessToken}
-  ```
-
-  Upload a new version to a store.
-
-  > Make sure the blocklet is bundled before upload.
-
-  ```shell
-  blocklet upload
-  ```
-
-  Or you can simply use `npm run upload` command.
-
-- You also can upload a new version to a store by Github CI.
-  Bump version at first.
-
-  ```shell
-  npm run bump-version
-  ```
-
-  Push your code to Github main/master branch, or make a pull request to the main/master branch.
-  The CI workflow will automatically upload a new version to a store.
-
-## Q & A
-
-1. Q: How to change a blocklet's name?
-
-   A: Change the `name` field in the `package.json` file, change the `name` field in the `blocklet.yml` file.
-
-   You can also change the `title` field and `description` field in the `blocklet.yml` file.
-
-   Run `blocklet meta` command, you will get a `did` config, copy the `did` value.
-
-   Replace this command `"bundle:client": "PUBLIC_URL='/.blocklet/proxy/{did}' npm run build",` in `package.json`
-
-   Replace `did` field in the `blocklet.yml`
-
-2. Q: How to change a blocklet's logo?
-
-   Change the `logo.png` file root folder.
-
-   Or you can change the `logo` field in the `blocklet.yml` file.
-
-   > Make sure you have added the logo path to the `blocklet.yml` file `files` field.
-
-## Learn More
-
-- Full specification of `blocklet.yml`: [https://github.com/blocklet/blocklet-specification/blob/main/docs/meta.md](https://github.com/blocklet/blocklet-specification/blob/main/docs/meta.md)
-- Full document of Blocklet Server & blocklet development: [https://www.arcblock.io/docs/blocklet-developer](https://www.arcblock.io/docs/blocklet-developer)
-
-## License
-
-The code is licensed under the Apache 2.0 license found in the
-[LICENSE](LICENSE) file.

package/templates/react-dapp/blocklet.yml

@@ -1,4 +1,3 @@
-name: template-react-dapp
 title: Blocklet Template React
 description: A Blocklet DAPP blocklet
 keywords:

package/templates/react-dapp/package.json

@@ -42,37 +42,38 @@
   "dependencies": {
     "@arcblock/did-auth": "^1.18.135",
     "@arcblock/did-auth-storage-nedb": "^1.7.1",
-    "@blocklet/sdk": "^1.16.30",
+    "@blocklet/sdk": "^1.16.31",
     "@ocap/client": "^1.18.135",
     "@ocap/mcrypto": "^1.18.135",
     "@ocap/wallet": "^1.18.135",
-    "axios": "^1.7.2",
+    "axios": "^1.7.7",
     "cookie-parser": "^1.4.6",
     "cors": "^2.8.5",
     "dotenv-flow": "^4.1.0",
-    "express": "^4.19.2",
+    "express": "^4.21.0",
     "express-async-errors": "^3.1.1"
   },
   "devDependencies": {
     "@arcblock/eslint-config": "^0.3.2",
-    "@blocklet/js-sdk": "^1.16.30",
+    "@blocklet/js-sdk": "^1.16.31",
+    "@trivago/prettier-plugin-sort-imports": "^4.3.0",
     "@vitejs/plugin-react": "^4.3.1",
-    "bumpp": "^9.4.1",
+    "bumpp": "^9.5.2",
     "cross-env": "^7.0.3",
-    "eslint": "^8.57.0",
-    "lint-staged": "^15.2.7",
-    "nodemon": "^3.1.4",
+    "eslint": "^8.57.1",
+    "lint-staged": "^15.2.10",
+    "nodemon": "^3.1.7",
     "npm-run-all": "^4.1.5",
     "prettier": "^3.3.3",
-    "react": "^18.2.0",
-    "react-dom": "^18.2.0",
-    "react-router-dom": "^6.24.0",
-    "rimraf": "^5.0.7",
+    "react": "~18.2.0",
+    "react-dom": "~18.2.0",
+    "react-router-dom": "^6.26.2",
+    "rimraf": "^5.0.10",
     "simple-git-hooks": "^2.11.1",
-    "vite": "^5.3.5",
-    "vite-plugin-blocklet": "^0.9.5",
+    "vite": "^5.4.8",
+    "vite-plugin-blocklet": "^0.9.7",
     "vite-plugin-svgr": "^4.2.0",
-    "zx": "^8.1.4"
+    "zx": "^8.1.8"
   },
   "simple-git-hooks": {
     "pre-commit": "npx lint-staged"

package/templates/react-dapp-ts/README.md

@@ -1,14 +1,11 @@
-# Getting Started with Create Blocklet
-
-This project was bootstrapped with [Create Blocklet](https://github.com/blocklet/create-blocklet).
-
+## PROJECT_DESCRIPTION
 This blocklet is a dapp project, which means this is a full-stack application. It's contained both `server` and `client` code.
 
 ## Launch on Blocklet Server
 
 [![Launch on Blocklet Server](https://assets.arcblock.io/icons/launch_on_blocklet_server.svg)](https://install.arcblock.io/launch?action=blocklet-install&meta_url=https%3A%2F%2Fgithub.com%2Fblocklet%2Fpages-kit%2Freleases%2Fdownload%2Fv0.1.33%2Fblocklet.json)
 
-## File Structure
+## FILE_STRUCTURE
 
 - public/ - static files
   - favicon.ico - favicon
@@ -35,123 +32,3 @@ This blocklet is a dapp project, which means this is a full-stack application. I
 - package.json - Npm package file
 - README.md - A guide for this blocklet
 - version - Version file
-
-## Development
-
-1. Make sure you have [@blocklet/cli](https://www.npmjs.com/package/@blocklet/cli) installed
-
-   Blocklet needs blocklet server as a dependency. So you need to install it first.
-   `npm install -g @blocklet/cli`
-   See details in [https://www.arcblock.io/docs/blocklet-developer/install-blocklet-cli](https://www.arcblock.io/docs/blocklet-developer/install-blocklet-cli)
-
-2. Init blocklet server & start blocklet server
-
-   Before starting an blocklet server, you need to init blocklet server.
-   `blocklet server init --mode=debug`
-   `blocklet server start`
-   See details in [https://www.arcblock.io/docs/blocklet-developer/getting-started](https://www.arcblock.io/docs/blocklet-developer/getting-started)
-
-3. Go to the project directory `cd [name]`
-4. Install dependencies: `npm install` or `yarn`
-5. Start development server: `blocklet dev`
-
-## Bundle
-
-After developing a blocklet, you may need to bundle it. Use `npm run bundle` command.
-
-## Deploy
-
-- If you want to deploy this blocklet to local blocklet server, you can use `blocklet deploy .blocklet/bundle` command(Make sure the blocklet is bundled before deployment).
-  > Or you can simply use `npm run deploy` command.
-- If you want to deploy this blocklet to remote blocklet server, you can use the command below.
-
-  ```shell
-  blocklet deploy .blocklet/bundle --endpoint {your blocklet server url} --access-key {blocklet server access key} --access-secret {blocklet server access secret}
-  ```
-
-  > Make sure the blocklet is bundled before deployment.
-
-## Upload to blocklet store
-
-- If you want to upload the blocklet to any store for other users to download and use, you can following the following instructions.
-
-  Bump version at first.
-
-  ```shell
-  npm run bump-version
-  ```
-
-  Then config blocklet store url.
-  You can use those store url in below.
-
-  1. [https://store.blocklet.dev/](https://store.blocklet.dev/)
-  2. [https://dev.store.blocklet.dev/](https://dev.store.blocklet.dev/)
-  3. A blocklet store started by yourself.
-     > Make sure you have installed a `blocklet store` on your own blocklet server. Check it on here: [https://store.blocklet.dev/blocklet/z8ia29UsENBg6tLZUKi2HABj38Cw1LmHZocbQ](https://store.blocklet.dev/blocklet/z8ia29UsENBg6tLZUKi2HABj38Cw1LmHZocbQ)
-
-  ```shell
-  blocklet config set store {store url}
-  ```
-
-  Get a `accessToken` by using this command.
-
-  > Why we need a `accessToken`?
-  > A `accessToken` is genrate by blocklet store, which help us upload our blocklet to any store.
-
-  Set `accessToken` to blocklet config
-
-  ```shell
-  blocklet config set accessToken {accessToken}
-  ```
-
-  Upload a new version to a store.
-
-  > Make sure the blocklet is bundled before upload.
-
-  ```shell
-  blocklet upload
-  ```
-
-  Or you can simply use `npm run upload` command.
-
-- You also can upload a new version to a store by Github CI.
-  Bump version at first.
-
-  ```shell
-  npm run bump-version
-  ```
-
-  Push your code to Github main/master branch, or make a pull request to the main/master branch.
-  The CI workflow will automatically upload a new version to a store.
-
-## Q & A
-
-1. Q: How to change a blocklet's name?
-
-   A: Change the `name` field in the `package.json` file, change the `name` field in the `blocklet.yml` file.
-
-   You can also change the `title` field and `description` field in the `blocklet.yml` file.
-
-   Run `blocklet meta` command, you will get a `did` config, copy the `did` value.
-
-   Replace this command `"bundle:client": "PUBLIC_URL='/.blocklet/proxy/{did}' npm run build",` in `package.json`
-
-   Replace `did` field in the `blocklet.yml`
-
-2. Q: How to change a blocklet's logo?
-
-   Change the `logo.png` file root folder.
-
-   Or you can change the `logo` field in the `blocklet.yml` file.
-
-   > Make sure you have added the logo path to the `blocklet.yml` file `files` field.
-
-## Learn More
-
-- Full specification of `blocklet.yml`: [https://github.com/blocklet/blocklet-specification/blob/main/docs/meta.md](https://github.com/blocklet/blocklet-specification/blob/main/docs/meta.md)
-- Full document of Blocklet Server & blocklet development: [https://www.arcblock.io/docs/blocklet-developer](https://www.arcblock.io/docs/blocklet-developer)
-
-## License
-
-The code is licensed under the Apache 2.0 license found in the
-[LICENSE](LICENSE) file.

package/templates/react-dapp-ts/blocklet.yml

@@ -1,4 +1,3 @@
-name: template-react-dapp-ts
 title: Blocklet Template React
 description: A Blocklet DAPP blocklet
 keywords:

package/templates/react-dapp-ts/package.json

@@ -40,49 +40,50 @@
   "dependencies": {
     "@arcblock/did-auth": "^1.18.135",
     "@arcblock/did-auth-storage-nedb": "^1.7.1",
-    "@blocklet/sdk": "^1.16.30",
+    "@blocklet/sdk": "^1.16.31",
     "@ocap/client": "^1.18.135",
     "@ocap/mcrypto": "^1.18.135",
     "@ocap/wallet": "^1.18.135",
-    "axios": "^1.7.2",
+    "axios": "^1.7.7",
     "cookie-parser": "^1.4.6",
     "cors": "^2.8.5",
     "dotenv-flow": "^4.1.0",
-    "express": "^4.19.2",
+    "express": "^4.21.0",
     "express-async-errors": "^3.1.1"
   },
   "devDependencies": {
     "@arcblock/eslint-config": "^0.3.2",
     "@arcblock/eslint-config-ts": "^0.3.2",
-    "@blocklet/js-sdk": "^1.16.30",
+    "@blocklet/js-sdk": "^1.16.31",
+    "@trivago/prettier-plugin-sort-imports": "^4.3.0",
     "@types/cookie-parser": "^1.4.7",
     "@types/cors": "^2.8.17",
     "@types/dotenv-flow": "^3.3.3",
     "@types/express": "^4.17.21",
-    "@types/node": "^20.14.13",
-    "@types/react": "^18.3.3",
+    "@types/node": "^20.16.9",
+    "@types/react": "^18.3.9",
     "@types/react-dom": "^18.3.0",
     "@vitejs/plugin-react": "^4.3.1",
-    "bumpp": "^9.4.1",
+    "bumpp": "^9.5.2",
     "cross-env": "^7.0.3",
-    "eslint": "^8.57.0",
+    "eslint": "^8.57.1",
     "import-sort-style-module": "^6.0.0",
-    "lint-staged": "^15.2.7",
-    "nodemon": "^3.1.4",
+    "lint-staged": "^15.2.10",
+    "nodemon": "^3.1.7",
     "npm-run-all": "^4.1.5",
     "prettier": "^3.3.3",
     "prettier-plugin-import-sort": "^0.0.7",
-    "react": "^18.2.0",
-    "react-dom": "^18.2.0",
-    "react-router-dom": "^6.24.0",
-    "rimraf": "^5.0.7",
+    "react": "~18.2.0",
+    "react-dom": "~18.2.0",
+    "react-router-dom": "^6.26.2",
+    "rimraf": "^5.0.10",
     "simple-git-hooks": "^2.11.1",
     "ts-node": "^10.9.2",
-    "typescript": "^5.5.2",
-    "vite": "^5.3.5",
-    "vite-plugin-blocklet": "^0.9.5",
+    "typescript": "^5.6.2",
+    "vite": "^5.4.8",
+    "vite-plugin-blocklet": "^0.9.7",
     "vite-plugin-svgr": "^4.2.0",
-    "zx": "^8.1.4"
+    "zx": "^8.1.8"
   },
   "importSort": {
     ".js, .jsx, .mjs": {