create-blocklet 0.6.3 → 0.6.5

package/index.js

@@ -118,6 +118,11 @@ const templates = [
     display: '[api] express.js',
     color: yellow,
   },
+  {
+    name: 'nestjs-api',
+    display: '[api] nestjs',
+    color: yellow,
+  },
 ];
 
 //see: https://github.com/npm/npm/issues/3763

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-blocklet",
-  "version": "0.6.3",
+  "version": "0.6.5",
   "exports": "./index.js",
   "type": "module",
   "repository": "git@github.com:blocklet/create-blocklet.git",

package/templates/nestjs-api/.eslintrc.js

@@ -0,0 +1,24 @@
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    project: 'tsconfig.json',
+    tsconfigRootDir: __dirname,
+    sourceType: 'module',
+  },
+  plugins: ['@typescript-eslint/eslint-plugin'],
+  root: true,
+  extends: '@arcblock/eslint-config-base',
+  globals: {
+    logger: true,
+  },
+  rules: {
+    'no-console': 'off',
+    'no-restricted-syntax': [
+      'error',
+      {
+        selector: "CallExpression[callee.object.name='console'][callee.property.name!=/^(log|warn|error|info|trace)$/]",
+        message: 'Unexpected property on console object was called',
+      },
+    ],
+  },
+};

package/templates/nestjs-api/README.md

@@ -0,0 +1,142 @@
+# Getting Started with Create Blocklet
+
+This project was bootstrapped with [Create Blocklet](https://github.com/blocklet/create-blocklet).
+
+This blocklet is a dapp project, which means this is a full-stack application. It's contained both `server` and `client` code.
+
+## File Structure
+
+- screenshots/ - Screenshots
+- api/ - Api side code
+  - hooks/ - blocklet lifecycle hooks
+  - libs/ - Api side libraries
+  - main.ts - Api side entry point
+- .prettierrc - Prettier configuration
+- blocklet.md - Blocklet README
+- blocklet.yml - Blocklet configuration
+- LICENSE - License file
+- logo.png - Blocklet logo file
+- Makefile - Makefile
+- 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://developer.blocklet.io/docs/en/quick-start/blocklet-server#use-the-binary-distribution](https://developer.blocklet.io/docs/en/quick-start/blocklet-server#use-the-binary-distribution)
+
+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://developer.blocklet.io/docs/en/quick-start/blocklet-server](https://developer.blocklet.io/docs/en/quick-start/blocklet-server)
+
+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://developer.blocklet.io/docs/en](https://developer.blocklet.io/docs/en)
+
+## License
+
+The code is licensed under the Apache 2.0 license found in the
+[LICENSE](LICENSE) file.

package/templates/nestjs-api/api/app.controller.ts

@@ -0,0 +1,12 @@
+import { Controller, Get } from '@nestjs/common';
+import { AppService } from './app.service';
+
+@Controller()
+export class AppController {
+  constructor(private readonly appService: AppService) {}
+
+  @Get()
+  getHello(): string {
+    return this.appService.getHello();
+  }
+}

package/templates/nestjs-api/api/app.module.ts

@@ -0,0 +1,10 @@
+import { Module } from '@nestjs/common';
+import { AppController } from './app.controller';
+import { AppService } from './app.service';
+
+@Module({
+  imports: [],
+  controllers: [AppController],
+  providers: [AppService],
+})
+export class AppModule {}

package/templates/nestjs-api/api/app.service.ts

@@ -0,0 +1,23 @@
+import { Injectable } from '@nestjs/common';
+const env = require('@blocklet/sdk/lib/env');
+const environment = {
+  ...env,
+  chainHost: process.env.CHAIN_HOST || '',
+};
+
+@Injectable()
+export class AppService {
+  getHello(): string {
+    return `
+    <div style="display:flex;flex-direction:column;align-items:center;padding:64px 0;">
+    <h1 style="margin:64px 0;">
+      <span style="display:inline-block;padding:8px 24px;background:#1dc1c7;color:#fff;">Blocklet</span>
+      <span style="color:#777;">+ NestJS</span>
+    </h1>
+    <pre>
+    ${JSON.stringify(environment, null, 2)}
+    </pre>
+    </div>
+      `;
+  }
+}

package/templates/nestjs-api/api/hooks/pre-start.js

@@ -0,0 +1,33 @@
+require('@blocklet/sdk/lib/error-handler');
+require('dotenv-flow').config();
+
+const Client = require('@ocap/client');
+
+const env = require('../libs/env');
+const logger = require('../libs/logger');
+const { wallet } = require('../libs/auth');
+const { name } = require('../../package.json');
+
+const ensureAccountDeclared = async () => {
+  if (env.isComponent) return;
+  if (!env.chainHost) return;
+
+  const client = new Client(env.chainHost);
+  const { state } = await client.getAccountState({ address: wallet.toAddress() }, { ignoreFields: ['context'] });
+  if (!state) {
+    const hash = await client.declare({ moniker: name, wallet });
+    logger.log(`app account declared on chain ${env.chainHost}`, hash);
+  } else {
+    logger.log(`app account already declared on chain ${env.chainHost}`);
+  }
+};
+
+(async () => {
+  try {
+    await ensureAccountDeclared();
+    process.exit(0);
+  } catch (err) {
+    logger.error(`${name} pre-start error`, err.message);
+    process.exit(1);
+  }
+})();

package/templates/nestjs-api/api/libs/auth.js

@@ -0,0 +1,22 @@
+const path = require('path');
+const AuthStorage = require('@arcblock/did-auth-storage-nedb');
+const getWallet = require('@blocklet/sdk/lib/wallet');
+const WalletAuthenticator = require('@blocklet/sdk/lib/wallet-authenticator');
+const WalletHandler = require('@blocklet/sdk/lib/wallet-handler');
+
+const env = require('./env');
+
+const wallet = getWallet();
+const authenticator = new WalletAuthenticator();
+const handlers = new WalletHandler({
+  authenticator,
+  tokenStorage: new AuthStorage({
+    dbPath: path.join(env.dataDir, 'auth.db'),
+  }),
+});
+
+module.exports = {
+  authenticator,
+  handlers,
+  wallet,
+};

package/templates/nestjs-api/api/libs/env.js

@@ -0,0 +1,6 @@
+const env = require('@blocklet/sdk/lib/env');
+
+module.exports = {
+  ...env,
+  chainHost: process.env.CHAIN_HOST || '',
+};

package/templates/nestjs-api/api/libs/logger.js

@@ -0,0 +1,3 @@
+const logger = console;
+
+module.exports = logger;

package/templates/nestjs-api/api/main.ts

@@ -0,0 +1,13 @@
+import { NestFactory } from '@nestjs/core';
+import { AppModule } from './app.module';
+
+const port = process.env.BLOCKLET_PORT || process.env.PORT || 3000;
+
+async function bootstrap() {
+  const app = await NestFactory.create(AppModule, {
+    logger: false,
+  });
+  await app.listen(port);
+  console.log(`Blocklet app listening on port ${port}`);
+}
+bootstrap();

package/templates/nestjs-api/blocklet.md

@@ -0,0 +1,3 @@
+# template-nestjs
+
+A NestJS template for creating a new blocklet project.

package/templates/nestjs-api/blocklet.yml

@@ -0,0 +1,54 @@
+name: template-nestjs
+title: Blocklet Template NestJS
+description: A Blocklet Api blocklet
+keywords:
+  - blocklet
+  - nestjs
+group: dapp
+did: ''
+main: dist/main.js
+author:
+  name: Blocklet
+  email: blocklet@arcblock.io
+repository:
+  type: git
+  url: 'git+https://github.com/blocklet/create-blocklet.git'
+specVersion: 1.1.1
+version: 0.1.0
+logo: logo.png
+files:
+  - logo.png
+  - screenshots
+  - dist
+interfaces:
+  - type: web
+    name: publicUrl
+    path: /
+    prefix: '*'
+    port: BLOCKLET_PORT
+    protocol: http
+community: ''
+documentation: ''
+homepage: ''
+license: ''
+payment:
+  price: []
+  share: []
+timeout:
+  start: 60
+requirements:
+  server: '>=1.6.29'
+  os: '*'
+  cpu: '*'
+scripts:
+  preStart: node api/hooks/pre-start.js
+  dev: npm run start
+environments:
+  - name: CHAIN_HOST
+    description: What's endpoint of the chain?
+    required: true
+    default: 'https://beta.abtnetwork.io/api/'
+    secure: false
+capabilities: {}
+screenshots: []
+components: []

package/templates/nestjs-api/nest-cli.json

@@ -0,0 +1,8 @@
+{
+  "$schema": "https://json.schemastore.org/nest-cli",
+  "collection": "@nestjs/schematics",
+  "sourceRoot": "api",
+  "compilerOptions": {
+    "deleteOutDir": true
+  }
+}

package/templates/nestjs-api/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "nestjs",
+  "version": "0.1.0",
+  "description": "",
+  "main": "api/main.ts",
+  "scripts": {
+    "lint": "eslint api --ext .mjs,.js,.jsx,.ts,.tsx",
+    "lint:fix": "npm run lint -- --fix",
+    "build": "nest build",
+    "dev": "blocklet dev",
+    "start": "NODE_ENV=development && nest start --watch",
+    "clean": "node scripts/build-clean.js",
+    "bundle": "npm run clean && blocklet bundle --zip --create-release",
+    "deploy": "npm run bundle && blocklet deploy .blocklet/bundle",
+    "upload": "npm run bundle && blocklet upload .blocklet/release/blocklet.json",
+    "deploy:child": "npm run bundle && blocklet deploy .blocklet/bundle --app-did=<%= did %>",
+    "dev:child": "blocklet dev --component --app-did=<%= did %>",
+    "prepare": "husky install",
+    "bump-version": "zx --quiet scripts/bump-version.mjs"
+  },
+  "lint-staged": {
+    "*.{mjs,js,ts}": [
+      "prettier --write",
+      "eslint"
+    ],
+    "*.{css,less,scss,json,graphql}": [
+      "prettier --write"
+    ]
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "@arcblock/did-auth-storage-nedb": "^1.7.1",
+    "@blocklet/sdk": "^1.16.7",
+    "@ocap/client": "^1.18.78",
+    "@nestjs/common": "^9.0.0",
+    "@nestjs/core": "^9.0.5",
+    "@nestjs/platform-express": "^9.0.0",
+    "dotenv-flow": "^3.2.0",
+    "express": "^4.18.2",
+    "reflect-metadata": "^0.1.13",
+    "rxjs": "^7.5.5"
+  },
+  "devDependencies": {
+    "@arcblock/eslint-config-base": "^0.2.3",
+    "@nestjs/cli": "^9.0.0",
+    "@nestjs/schematics": "^9.0.0",
+    "@types/express": "^4.17.13",
+    "@types/node": "^18.0.3",
+    "@typescript-eslint/eslint-plugin": "^5.30.5",
+    "@typescript-eslint/parser": "^5.30.5",
+    "bumpp": "^8.2.1",
+    "eslint": "^8.40.0",
+    "husky": "^8.0.3",
+    "lint-staged": "^12.5.0",
+    "nodemon": "^2.0.22",
+    "prettier": "^2.8.8",
+    "rimraf": "^3.0.2",
+    "source-map-support": "^0.5.21",
+    "ts-node": "^10.8.2",
+    "tsconfig-paths": "^4.0.0",
+    "typescript": "^4.7.4",
+    "zx": "^7.2.2"
+  }
+}

package/templates/nestjs-api/template-info.json

@@ -0,0 +1,11 @@
+{
+  "name": "nestjs-api",
+  "desc": { "en": "A server-side API application built on NestJS", "zh": "一个基于 NestJS 构建的服务端 API 应用" },
+  "displayName": "NestJS API",
+  "blockletType": "dapp",
+  "composable": true,
+  "framework": "NestJS",
+  "languages": "TypeScript",
+  "useCase": "Server Side Application",
+  "author": "Vincent Medina"
+}

package/templates/nestjs-api/tsconfig.build.json

@@ -0,0 +1,4 @@
+{
+  "extends": "./tsconfig.json",
+  "exclude": ["node_modules", "dist", "test", "**/*spec.ts"]
+}

package/templates/nestjs-api/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "declaration": true,
+    "removeComments": true,
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "allowSyntheticDefaultImports": true,
+    "target": "ES2019",
+    "sourceMap": true,
+    "outDir": "./dist",
+    "baseUrl": "./",
+    "incremental": true,
+    "skipLibCheck": true
+  }
+}

package/templates/react-dapp/package.json

@@ -71,7 +71,7 @@
     "npm-run-all": "^4.1.5",
     "prettier": "^2.8.8",
     "vite": "^4.3.5",
-    "vite-plugin-blocklet": "^0.6.3",
+    "vite-plugin-blocklet": "^0.6.5",
     "vite-plugin-node-polyfills": "^0.7.0",
     "vite-plugin-svgr": "^2.4.0",
     "zx": "^7.2.2"

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

@@ -82,7 +82,7 @@
     "ts-node": "^10.9.1",
     "typescript": "^4.9.5",
     "vite": "^4.3.5",
-    "vite-plugin-blocklet": "^0.6.3",
+    "vite-plugin-blocklet": "^0.6.5",
     "vite-plugin-node-polyfills": "^0.7.0",
     "vite-plugin-svgr": "^2.4.0",
     "zx": "^7.2.2"

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

@@ -72,7 +72,7 @@
     "prettier": "^2.8.8",
     "rimraf": "^3.0.2",
     "vite": "^4.3.5",
-    "vite-plugin-blocklet": "^0.6.3",
+    "vite-plugin-blocklet": "^0.6.5",
     "vite-plugin-node-polyfills": "^0.7.0",
     "vite-plugin-svgr": "^2.4.0",
     "zx": "^7.2.2"

package/templates/react-static/package.json

@@ -53,7 +53,7 @@
     "prettier": "^2.8.8",
     "rimraf": "^3.0.2",
     "vite": "^4.3.5",
-    "vite-plugin-blocklet": "^0.6.3",
+    "vite-plugin-blocklet": "^0.6.5",
     "vite-plugin-node-polyfills": "^0.7.0",
     "vite-plugin-svgr": "^2.4.0",
     "zx": "^7.2.2"

package/templates/solidjs-dapp/package.json

@@ -33,7 +33,7 @@
     "prettier": "^2.8.8",
     "rimraf": "^3.0.2",
     "vite": "^4.3.5",
-    "vite-plugin-blocklet": "^0.6.3",
+    "vite-plugin-blocklet": "^0.6.5",
     "vite-plugin-node-polyfills": "^0.7.0",
     "vite-plugin-solid": "^2.7.0",
     "zx": "^7.2.2"

package/templates/solidjs-static/package.json

@@ -29,7 +29,7 @@
     "prettier": "^2.8.8",
     "rimraf": "^3.0.2",
     "vite": "^4.3.5",
-    "vite-plugin-blocklet": "^0.6.3",
+    "vite-plugin-blocklet": "^0.6.5",
     "vite-plugin-node-polyfills": "^0.7.0",
     "vite-plugin-solid": "^2.7.0",
     "zx": "^7.2.2"

package/templates/svelte-dapp/package.json

@@ -47,7 +47,7 @@
     "rimraf": "^3.0.2",
     "svelte": "^3.59.1",
     "vite": "^4.3.5",
-    "vite-plugin-blocklet": "^0.6.3",
+    "vite-plugin-blocklet": "^0.6.5",
     "vite-plugin-html": "^3.2.0",
     "vite-plugin-node-polyfills": "^0.7.0",
     "zx": "^7.2.2"

package/templates/svelte-static/package.json

@@ -30,7 +30,7 @@
     "rimraf": "^3.0.2",
     "svelte": "^3.59.1",
     "vite": "^4.3.5",
-    "vite-plugin-blocklet": "^0.6.3",
+    "vite-plugin-blocklet": "^0.6.5",
     "vite-plugin-node-polyfills": "^0.7.0",
     "zx": "^7.2.2"
   },

package/templates/vue-dapp/package.json

@@ -49,7 +49,7 @@
     "prettier": "^2.8.8",
     "rimraf": "^3.0.2",
     "vite": "^4.3.5",
-    "vite-plugin-blocklet": "^0.6.3",
+    "vite-plugin-blocklet": "^0.6.5",
     "vite-plugin-node-polyfills": "^0.7.0",
     "zx": "^7.2.2"
   },

package/templates/vue-static/package.json

@@ -31,7 +31,7 @@
     "prettier": "^2.8.8",
     "rimraf": "^3.0.2",
     "vite": "^4.3.5",
-    "vite-plugin-blocklet": "^0.6.3",
+    "vite-plugin-blocklet": "^0.6.5",
     "vite-plugin-node-polyfills": "^0.7.0",
     "zx": "^7.2.2"
   },

package/templates/vue2-dapp/package.json

@@ -49,7 +49,7 @@
     "prettier": "^2.8.8",
     "rimraf": "^3.0.2",
     "vite": "^4.3.5",
-    "vite-plugin-blocklet": "^0.6.3",
+    "vite-plugin-blocklet": "^0.6.5",
     "vite-plugin-node-polyfills": "^0.7.0",
     "zx": "^7.2.2"
   },

package/templates/vue2-static/package.json

@@ -31,7 +31,7 @@
     "prettier": "^2.8.8",
     "rimraf": "^3.0.2",
     "vite": "^4.3.5",
-    "vite-plugin-blocklet": "^0.6.3",
+    "vite-plugin-blocklet": "^0.6.5",
     "vite-plugin-node-polyfills": "^0.7.0",
     "zx": "^7.2.2"
   },