create-blocklet 0.7.5 → 0.7.7

package/index.js

@@ -43,6 +43,11 @@ const templates = [
     display: '[dapp] react + express + typescript',
     color: yellow,
   },
+  {
+    name: 'todo-list-example',
+    display: '[dapp: todo-list] react + express + typescript + DID Spaces',
+    color: yellow,
+  },
   {
     name: 'solidjs-dapp',
     display: '[dapp] solid + express.js',

package/package.json

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

package/templates/react-dapp/package.json

@@ -69,7 +69,7 @@
     "npm-run-all": "^4.1.5",
     "prettier": "^3.1.1",
     "vite": "^5.0.10",
-    "vite-plugin-blocklet": "^0.7.5",
+    "vite-plugin-blocklet": "^0.7.7",
     "vite-plugin-svgr": "^4.2.0",
     "zx": "^7.2.3"
   }

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

@@ -79,7 +79,7 @@
     "ts-node": "^10.9.2",
     "typescript": "^5.3.3",
     "vite": "^5.0.10",
-    "vite-plugin-blocklet": "^0.7.5",
+    "vite-plugin-blocklet": "^0.7.7",
     "vite-plugin-svgr": "^4.2.0",
     "zx": "^7.2.3"
   },

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

@@ -70,7 +70,7 @@
     "prettier": "^3.1.1",
     "rimraf": "^3.0.2",
     "vite": "^5.0.10",
-    "vite-plugin-blocklet": "^0.7.5",
+    "vite-plugin-blocklet": "^0.7.7",
     "vite-plugin-svgr": "^4.2.0",
     "zx": "^7.2.3"
   }

package/templates/react-static/package.json

@@ -53,7 +53,7 @@
     "prettier": "^3.1.1",
     "rimraf": "^3.0.2",
     "vite": "^5.0.10",
-    "vite-plugin-blocklet": "^0.7.5",
+    "vite-plugin-blocklet": "^0.7.7",
     "vite-plugin-svgr": "^4.2.0",
     "zx": "^7.2.3"
   }

package/templates/solidjs-dapp/package.json

@@ -33,7 +33,7 @@
     "prettier": "^3.1.1",
     "rimraf": "^3.0.2",
     "vite": "^5.0.10",
-    "vite-plugin-blocklet": "^0.7.5",
+    "vite-plugin-blocklet": "^0.7.7",
     "vite-plugin-solid": "^2.8.0",
     "zx": "^7.2.3"
   },

package/templates/solidjs-static/package.json

@@ -29,7 +29,7 @@
     "prettier": "^3.1.1",
     "rimraf": "^3.0.2",
     "vite": "^5.0.10",
-    "vite-plugin-blocklet": "^0.7.5",
+    "vite-plugin-blocklet": "^0.7.7",
     "vite-plugin-solid": "^2.8.0",
     "zx": "^7.2.3"
   },

package/templates/svelte-dapp/package.json

@@ -45,7 +45,7 @@
     "rimraf": "^3.0.2",
     "svelte": "^4.2.8",
     "vite": "^5.0.10",
-    "vite-plugin-blocklet": "^0.7.5",
+    "vite-plugin-blocklet": "^0.7.7",
     "zx": "^7.2.3"
   },
   "lint-staged": {

package/templates/svelte-static/package.json

@@ -30,7 +30,7 @@
     "rimraf": "^3.0.2",
     "svelte": "^4.2.8",
     "vite": "^5.0.10",
-    "vite-plugin-blocklet": "^0.7.5",
+    "vite-plugin-blocklet": "^0.7.7",
     "zx": "^7.2.3"
   },
   "lint-staged": {

package/templates/todo-list-example/.editorconfig

@@ -0,0 +1,23 @@
+# For more information about the properties used in
+# this file, please see the EditorConfig documentation:
+# http://editorconfig.org/
+#
+# Sensible EditorConfig defaults
+# https://gist.github.com/matijs/662bf45dd4ec37b3a068
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+# Make sure package.json always uses 2 spaces to indent
+[{package.json}]
+indent_size = 2
+indent_style = space
+
+[{makefile, Makefile}]
+indent_style = tab

package/templates/todo-list-example/.eslintrc.js

@@ -0,0 +1,13 @@
+const { join } = require('path');
+
+module.exports = {
+  root: true,
+  extends: '@arcblock/eslint-config-ts',
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    project: [join(__dirname, 'tsconfig.eslint.json'), join(__dirname, 'tsconfig.json')],
+  },
+  rules: {
+    '@typescript-eslint/comma-dangle': 'off',
+  },
+};

package/templates/todo-list-example/.github/workflows/main.yml

@@ -0,0 +1,36 @@
+name: Deploy
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  Deploy:
+    runs-on: ubuntu-latest
+
+    if: "! contains(github.event.head_commit.message, '[skip ci]')"
+
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v2
+
+      - name: Set yarn cache
+        uses: c-hive/gha-yarn-cache@v2
+
+      - name: Install dependencies
+        run: yarn
+
+      - name: Blocklet workflow
+        uses: blocklet/action-workflow@v1
+        with:
+          skip-upload: false
+          skip-deploy: false
+          bundle-command: yarn bundle
+          store-endpoint: ${{ secrets.STORE_ENDPOINT }}
+          store-access-token: ${{ secrets.STORE_ACCESS_TOKEN }}
+          server-endpoint: ${{ secrets.SERVER_ENDPOINT }}
+          server-access-key: ${{ secrets.SERVER_ACCESS_KEY }}
+          server-access-secret: ${{ secrets.SERVER_ACCESS_SECRET }}
+          slack-webhook: ${{ secrets.SLACK_WEBHOOK }}
+          github-token: ${{ secrets.GITHUB_TOKEN }}

package/templates/todo-list-example/.github/workflows/pr-title.yml

@@ -0,0 +1,21 @@
+name: 'Lint PR Title'
+
+on:
+  pull_request:
+    types:
+      - opened
+      - reopened
+      - edited
+      - synchronize
+    branches:
+      - main
+      - dev
+      - master
+
+jobs:
+  lint-title:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: ArcBlock/action-lint-pull-request-title@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

package/templates/todo-list-example/.github/workflows/version-check.yml

@@ -0,0 +1,20 @@
+name: 'Version Check'
+
+on:
+  pull_request:
+    types:
+      - opened
+      - reopened
+      - edited
+      - synchronize
+    branches:
+      - main
+      - master
+jobs:
+  main:
+    runs-on: ubuntu-latest
+    steps:
+      - name: action-version-check
+        uses: arcblock/action-version-check@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

package/templates/todo-list-example/.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx lint-staged

package/templates/todo-list-example/.prettierrc

@@ -0,0 +1,9 @@
+{
+  "printWidth": 120,
+  "useTabs": false,
+  "tabWidth": 2,
+  "trailingComma": "es5",
+  "bracketSameLine": true,
+  "semi": true,
+  "singleQuote": true
+}

package/templates/todo-list-example/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2018-2020 ArcBlock
+
+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/templates/todo-list-example/README.md

@@ -0,0 +1,28 @@
+# todo-list-example
+
+## How to start
+
+### Install dependencies
+
+```shell
+pnpm install
+# or npm install
+# or yarn install
+```
+
+### Start
+
+```shell
+yarn dev
+```
+
+## How to connect with DID Spaces
+
+- Step 1: Set the 'capabilities.didSpace' field in blocklet.yml to 'requiredOnConnect', see 'blocklet.yml#capabilities'
+- Step 2: To read and write the DID Space, see api/src/routes/todo-list/index.ts#9
+- Step 3: Get data from DID Spaces, see 'src/pages/todo-list.tsx#33'
+- Step 4: Write data to DID Spaces, see 'src/pages/todo-list.tsx#51'
+
+## Get help
+
+If you want to learn more about the development of DID Spaces, You can also refer to [DID Spaces development documentation] (https://www.arcblock.io/docs/did-spaces/en/did-spaces-how-to-guides). No matter what you encounter a problem, we welcome you in our official BBS (https://community.arcblock.io/) initiated discussions.

package/templates/todo-list-example/README.zh.md

@@ -0,0 +1,28 @@
+# todo-list-example
+
+## 如何启动
+
+### 安装依赖
+
+```shell
+pnpm install
+# or npm install
+# or yarn install
+```
+
+### 启动
+
+```shell
+yarn dev
+```
+
+## 如何与 DID Spaces 对接的
+
+- 步骤 1：将blocklet.yml 中的 `capabilities.didSpace` 字段设置为 `requiredOnConnect`，请参阅 `blocklet.yml#capabilities`
+- 步骤 2：实现读写 DID Space 的功能，请参阅 `api/src/routes/todo-list/index.ts#9`
+- 步骤 3：从 DID Spaces 获取数据，请参阅 `src/pages/todo-list.tsx#33`
+- 步骤 4：将数据写入 DID Spaces，请参阅 `src/pages/todo-list.tsx#51`
+
+## 获得帮助
+
+  如果你想了解更多有关 DID Spaces 的开发细节，你还可以参考[DID Spaces 的开发文档](https://www.arcblock.io/docs/did-spaces/en/did-spaces-how-to-guides)。不论你遇到什么问题，我们随时欢迎你在我们的[官方论坛](https://community.arcblock.io/)发起讨论。

package/templates/todo-list-example/api/dev.ts

@@ -0,0 +1,5 @@
+import { app } from './src';
+
+import('vite-plugin-blocklet').then(({ setupClient }) => {
+  setupClient(app);
+});

package/templates/todo-list-example/api/hooks/pre-start.js

@@ -0,0 +1,12 @@
+/* eslint-disable global-require */
+
+const isDevelopment = process.env.BLOCKLET_MODE === 'development';
+
+if (isDevelopment) {
+  // rename `require` to skip deps resolve when bundling
+  const r = require;
+  r('ts-node').register();
+  r('../src/hooks/pre-start');
+} else {
+  require('../dist/hooks/pre-start');
+}

package/templates/todo-list-example/api/src/hooks/pre-start.ts

@@ -0,0 +1,37 @@
+import '@blocklet/sdk/lib/error-handler';
+
+import Client from '@ocap/client';
+import dotenv from 'dotenv-flow';
+
+import { wallet } from '../libs/auth';
+import env from '../libs/env';
+import logger from '../libs/logger';
+
+dotenv.config();
+
+const { name } = require('../../../package.json');
+
+const ensureAccountDeclared = async () => {
+  if (env.isComponent) return;
+  if (!env.chainHost) return;
+
+  const client = new Client(env.chainHost);
+  // @ts-ignore
+  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/todo-list-example/api/src/index.ts

@@ -0,0 +1,49 @@
+import 'express-async-errors';
+
+import path from 'path';
+
+import cookieParser from 'cookie-parser';
+import cors from 'cors';
+import dotenv from 'dotenv-flow';
+import express, { ErrorRequestHandler } from 'express';
+import fallback from '@blocklet/sdk/lib/middlewares/fallback';
+
+import logger from './libs/logger';
+import routes from './routes';
+
+dotenv.config();
+
+const { name, version } = require('../../package.json');
+
+export const app = express();
+
+app.set('trust proxy', true);
+app.use(cookieParser());
+app.use(express.json({ limit: '1 mb' }));
+app.use(express.urlencoded({ extended: true, limit: '1 mb' }));
+app.use(cors());
+
+const router = express.Router();
+router.use('/api', routes);
+app.use(router);
+
+const isProduction = process.env.NODE_ENV === 'production' || process.env.ABT_NODE_SERVICE_ENV === 'production';
+
+if (isProduction) {
+  const staticDir = path.resolve(process.env.BLOCKLET_APP_DIR!, 'dist');
+  app.use(express.static(staticDir, { maxAge: '30d', index: false }));
+  app.use(fallback('index.html', { root: staticDir }));
+
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  app.use(<ErrorRequestHandler>((err, _req, res, _next) => {
+    logger.error(err.stack);
+    res.status(500).send('Something broke!');
+  }));
+}
+
+const port = parseInt(process.env.BLOCKLET_PORT!, 10);
+
+export const server = app.listen(port, (err?: any) => {
+  if (err) throw err;
+  logger.info(`> ${name} v${version} ready on ${port}`);
+});

package/templates/todo-list-example/api/src/libs/auth.ts

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

package/templates/todo-list-example/api/src/libs/env.ts

@@ -0,0 +1,6 @@
+import env from '@blocklet/sdk/lib/env';
+
+export default {
+  ...env,
+  chainHost: process.env.CHAIN_HOST || '',
+};

package/templates/todo-list-example/api/src/libs/logger.ts

@@ -0,0 +1,3 @@
+const logger = console;
+
+export default logger;

package/templates/todo-list-example/api/src/routes/index.ts

@@ -0,0 +1,10 @@
+import middleware from '@blocklet/sdk/lib/middlewares';
+import { Router } from 'express';
+import todoListRouter from './todo-list';
+
+const router = Router();
+
+router.use('/user', middleware.user(), (req, res) => res.json(req.user || {}));
+router.use('/todo-list', middleware.user(), todoListRouter);
+
+export default router;

package/templates/todo-list-example/api/src/routes/todo-list/$get.ts

@@ -0,0 +1,31 @@
+import type { Request, Response } from 'express';
+import { GetObjectCommand, SpaceClient } from '@did-space/client';
+import { streamToString } from '@did-space/core';
+import { authService, wallet } from '../../libs/auth';
+
+export default async function $get(req: Request, res: Response) {
+  const { user } = await authService.getUser(req.user?.did as string);
+  if (!user?.didSpace?.endpoint) {
+    return res.status(404).send('DID Spaces endpoint does not exist. Log in again to complete the authorization');
+  }
+
+  const spaceClient = new SpaceClient({
+    wallet,
+    // @ts-ignore
+    endpoint: user.didSpace.endpoint,
+  });
+  try {
+    const { data } = await spaceClient.send(
+      new GetObjectCommand({
+        key: 'todo-list.json',
+      })
+    );
+    return res.json({ todoList: JSON.parse(await streamToString(data)) });
+  } catch (error) {
+    if (error.message.includes('404')) {
+      return res.json({ todoList: [] });
+    }
+    console.error(error);
+    return res.status(400).send(error.message);
+  }
+}

package/templates/todo-list-example/api/src/routes/todo-list/$put.ts

@@ -0,0 +1,29 @@
+import { PutObjectCommand, SpaceClient } from '@did-space/client';
+import type { Request, Response } from 'express';
+import isArray from 'lodash/isArray';
+import { authService, wallet } from '../../libs/auth';
+
+export default async function $put(req: Request, res: Response) {
+  if (!isArray(req.body.todoList)) {
+    throw new Error('TodoList must be an array');
+  }
+
+  const { user } = await authService.getUser(req.user?.did as string);
+  if (!user?.didSpace?.endpoint) {
+    return res.status(404).send('DID Spaces endpoint does not exist. Log in again to complete the authorization');
+  }
+
+  const spaceClient = new SpaceClient({
+    wallet,
+    // @ts-ignore
+    endpoint: user.didSpace.endpoint,
+  });
+  await spaceClient.send(
+    new PutObjectCommand({
+      key: 'todo-list.json',
+      data: JSON.stringify(req.body.todoList),
+    })
+  );
+
+  return res.send();
+}

package/templates/todo-list-example/api/src/routes/todo-list/index.ts

@@ -0,0 +1,12 @@
+import middleware from '@blocklet/sdk/lib/middlewares';
+import { Router } from 'express';
+import $get from './$get';
+import $put from './$put';
+
+const todoListRouter = Router();
+
+// Step 2: the function of reading and writing DID Space is implemented
+todoListRouter.get('/', middleware.user(), $get);
+todoListRouter.put('/', middleware.user(), $put);
+
+export default todoListRouter;

package/templates/todo-list-example/api/third.d.ts

@@ -0,0 +1,17 @@
+declare module 'vite-plugin-blocklet';
+
+declare module 'express-history-api-fallback';
+
+declare module 'express-async-errors';
+
+namespace Express {
+  interface Request {
+    user?: {
+      did: string;
+      role: string;
+      fullName: string;
+      provider: string;
+      walletOS: string;
+    };
+  }
+}

package/templates/todo-list-example/blocklet.md

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

package/templates/todo-list-example/blocklet.yml

@@ -0,0 +1,51 @@
+name: template-todo-list
+title: Blocklet Template todo-list
+description: A Blocklet Server blocklet
+keywords:
+  - blocklet
+  - svelte
+group: static
+did: ''
+main: dist
+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
+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:
+  dev: npm run start
+environments: []
+capabilities: 
+  # Step 1: set capabilities.didSpace to requiredOnConnect
+  didSpace: requiredOnConnect
+screenshots: 
+  - 1-login.png
+  - 2-ui.png
+components: []

package/templates/todo-list-example/index.html

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" href="/favicon.ico?imageFilter=convert&f=png&w=32" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0" />
+    <meta name="theme-color" content="#4F6AF5" />
+  </head>
+  <body>
+    <noscript> You need to enable JavaScript to run this app. </noscript>
+    <div id="app"></div>
+    <script type="module" src="/src/index.tsx"></script>
+  </body>
+</html>