@wujingze-self/arkwebrouter 1.0.0 → 1.0.1

package/README.md

@@ -0,0 +1,63 @@
+# 基于typescript项目开发Hvigor插件
+
+## 初始化typescript项目
+
+1. 创建一个空目录
+2. 安装typescript模块
+    ```shell
+    // 全局安装TypeScript
+    
+    npm install typescript -g
+    ```
+3. 初始化npm项目。执行如下命令，根据命令行指示配置项目。初始化完成后会生成package.json文件。
+    ```shell
+    // 初始化一个npm项目
+    npm init
+    ```
+4. 生成typescript配置文件。执行如下命令生成tsconfig.json文件。
+    ```shell
+    // 初始化typeScript配置文件
+    tsc --init
+    ```
+5. 删除verbatimModuleSyntax字段。检查tsconfig.json文件是否存在verbatimModuleSyntax字段，如果存在且配置为true，会导致无法使用ESM语法，编译时会报错，因此需要删除该字段。
+
+## 开发插件
+
+1. 配置npm镜像仓库地址，用于安装@ohos/hvigor插件。
+   在工程目录下创建.npmrc文件，配置如下信息：
+    ```
+    registry=https://repo.huaweicloud.com/repository/npm/
+    @ohos:registry=https://repo.harmonyos.com/npm/
+   ```
+2. 添加依赖声明。
+   打开package.json添加devDependencies配置。
+   ```json
+    "devDependencies": {
+      "@ohos/hvigor": "^5.8.9"
+    }
+    ```
+3. 安装依赖 `npm install`
+4. 编写插件代码。[custom-wjz-plugin.ts](src/plugin/custom-wjz-plugin.ts)
+5. 导出插件。[index.ts](index.ts)
+
+## 发布插件
+
+1. 配置registry。 打开工程目录下的[.npmrc](.npmrc)文件，配置您需要发布的镜像仓库。
+2. 去(https://www.npmjs.com/settings/wujingze/tokens)获取token信息
+   - 先创建组织 Organizations + (注意[package.json](package.json)的name前缀需要是@组织名称)
+   - 再创建 Access Tokens (需要点击 Bypass two-factor authentication (2FA) 跳过2FA验证)
+   - 将TOKEN放入[.npmrc](.npmrc) `//registry.npmjs.org/:_authToken=TOKEN`
+3. `npm login` 登录
+4. `tsc` 编译npm包
+5. 发布npm包，因为我们使用的是免费的，所以只能发布公共包 `npm publish --access public`
+
+## 使用插件
+
+1. 在鸿蒙工程下`hvigor/hvigor-config.json5`中添加自定义插件依赖，依赖项支持离线插件配置。Sync Now
+   ```json5
+    "dependencies": {
+      "@wujingze-self/arkwebrouter": "1.0.0" // 使用我们自定义的插件
+    }
+   ```
+2. 导入插件，在 hvigorfile 里导入插件并使用
+    

package/index.d.ts

@@ -1,3 +1,5 @@
 export { NativeMethodPlugin } from './src/plugin/native-method-plugin';
 export { customWjzPlugin } from './src/plugin/custom-wjz-plugin';
+export { WebApiController } from './src/annotation/WebApiController';
+export { WebApiMethod } from './src/annotation/WebApiMethod';
 //# sourceMappingURL=index.d.ts.map

package/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,kBAAkB,EAAC,MAAM,mCAAmC,CAAC;AACrE,OAAO,EAAC,eAAe,EAAC,MAAM,gCAAgC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,kBAAkB,EAAC,MAAM,mCAAmC,CAAC;AACrE,OAAO,EAAC,eAAe,EAAC,MAAM,gCAAgC,CAAC;AAC/D,OAAO,EAAC,gBAAgB,EAAC,MAAM,mCAAmC,CAAC;AACnE,OAAO,EAAC,YAAY,EAAC,MAAM,+BAA+B,CAAC"}

package/index.js

@@ -1,8 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.customWjzPlugin = exports.NativeMethodPlugin = void 0;
+exports.WebApiMethod = exports.WebApiController = exports.customWjzPlugin = exports.NativeMethodPlugin = void 0;
 var native_method_plugin_1 = require("./src/plugin/native-method-plugin");
 Object.defineProperty(exports, "NativeMethodPlugin", { enumerable: true, get: function () { return native_method_plugin_1.NativeMethodPlugin; } });
 var custom_wjz_plugin_1 = require("./src/plugin/custom-wjz-plugin");
 Object.defineProperty(exports, "customWjzPlugin", { enumerable: true, get: function () { return custom_wjz_plugin_1.customWjzPlugin; } });
+var WebApiController_1 = require("./src/annotation/WebApiController");
+Object.defineProperty(exports, "WebApiController", { enumerable: true, get: function () { return WebApiController_1.WebApiController; } });
+var WebApiMethod_1 = require("./src/annotation/WebApiMethod");
+Object.defineProperty(exports, "WebApiMethod", { enumerable: true, get: function () { return WebApiMethod_1.WebApiMethod; } });
 //# sourceMappingURL=index.js.map

package/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";;;AAAA,0EAAqE;AAA7D,0HAAA,kBAAkB,OAAA;AAC1B,oEAA+D;AAAvD,oHAAA,eAAe,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";;;AAAA,0EAAqE;AAA7D,0HAAA,kBAAkB,OAAA;AAC1B,oEAA+D;AAAvD,oHAAA,eAAe,OAAA;AACvB,sEAAmE;AAA3D,oHAAA,gBAAgB,OAAA;AACxB,8DAA2D;AAAnD,4GAAA,YAAY,OAAA"}

package/index.ts

@@ -1,2 +1,4 @@
 export {NativeMethodPlugin} from './src/plugin/native-method-plugin';
-export {customWjzPlugin} from './src/plugin/custom-wjz-plugin';
+export {customWjzPlugin} from './src/plugin/custom-wjz-plugin';
+export {WebApiController} from './src/annotation/WebApiController';
+export {WebApiMethod} from './src/annotation/WebApiMethod';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wujingze-self/arkwebrouter",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "arkweb request router",
   "main": "index.js",
   "scripts": {

package/src/annotation/WebApiController.d.ts

@@ -0,0 +1,5 @@
+export declare function WebApiController(parma: WebApiControllerParams): ObjectConstructor;
+export interface WebApiControllerParams {
+    path: string;
+}
+//# sourceMappingURL=WebApiController.d.ts.map

package/src/annotation/WebApiController.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"WebApiController.d.ts","sourceRoot":"","sources":["WebApiController.ts"],"names":[],"mappings":"AAAA,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,sBAAsB,qBAE7D;AAED,MAAM,WAAW,sBAAsB;IACnC,IAAI,EAAE,MAAM,CAAC;CAChB"}

package/src/annotation/WebApiController.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebApiController = WebApiController;
+function WebApiController(parma) {
+    return Object;
+}
+//# sourceMappingURL=WebApiController.js.map

package/src/annotation/WebApiController.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WebApiController.js","sourceRoot":"","sources":["WebApiController.ts"],"names":[],"mappings":";;AAAA,4CAEC;AAFD,SAAgB,gBAAgB,CAAC,KAA6B;IAC1D,OAAO,MAAM,CAAC;AAClB,CAAC"}

package/src/annotation/WebApiController.ts

@@ -0,0 +1,7 @@
+export function WebApiController(parma: WebApiControllerParams) {
+    return Object;
+}
+
+export interface WebApiControllerParams {
+    path: string;
+}

package/src/annotation/WebApiMethod.d.ts

@@ -0,0 +1,6 @@
+export declare function WebApiMethod(): ObjectConstructor;
+export interface WebApiMethodParams {
+    path: string;
+    method?: 'GET' | 'POST' | 'PUT' | 'DELETE';
+}
+//# sourceMappingURL=WebApiMethod.d.ts.map

package/src/annotation/WebApiMethod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"WebApiMethod.d.ts","sourceRoot":"","sources":["WebApiMethod.ts"],"names":[],"mappings":"AAAA,wBAAgB,YAAY,sBAE3B;AAED,MAAM,WAAW,kBAAkB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,CAAC;CAC9C"}

package/src/annotation/WebApiMethod.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebApiMethod = WebApiMethod;
+function WebApiMethod() {
+    return Object;
+}
+//# sourceMappingURL=WebApiMethod.js.map

package/src/annotation/WebApiMethod.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WebApiMethod.js","sourceRoot":"","sources":["WebApiMethod.ts"],"names":[],"mappings":";;AAAA,oCAEC;AAFD,SAAgB,YAAY;IACxB,OAAO,MAAM,CAAC;AAClB,CAAC"}

package/src/annotation/WebApiMethod.ts

@@ -0,0 +1,8 @@
+export function WebApiMethod() {
+    return Object;
+}
+
+export interface WebApiMethodParams {
+    path: string;
+    method?: 'GET' | 'POST' | 'PUT' | 'DELETE';
+}