fix: use common package convention

- change package.json and tsconfig.json files to follow common convention Closes: hyperledger#2216 Signed-off-by: Tomasz Awramski <tomasz.awramski@fujitsu.com>
rwat17 · Aug 11, 2023 · f15c8d2 · f15c8d2
1 parent ccdaa12
commit f15c8d2
Show file tree

Hide file tree

Showing 67 changed files with 605 additions and 447 deletions.
diff --git a/examples/cactus-check-connection-ethereum-validator/package.json b/examples/cactus-check-connection-ethereum-validator/package.json
@@ -3,15 +3,15 @@
   "version": "2.0.0-alpha.1",
   "private": true,
   "scripts": {
-    "start": "node ../../dist/packages/cactus-cmd-socketio-server/src/main/typescript/routing-interface/www.js",
-    "debug": "nodemon --inspect ../../dist/packages/cactus-cmd-socketio-server/src/main/typescript/routing-interface/www.js",
     "build": "npm run build-ts && npm run copy-static-assets && npm run copy-blp-config && npm run replace-blp-config-path",
     "build-ts": "tsc -p ./tsconfig.json",
-    "tslint": "tslint -c tslint.json -p tsconfig.json './*.ts'",
-    "copy-static-assets": "ts-node copyStaticAssets.ts",
     "copy-blp-config": "ts-node copyBLPConfig.ts",
+    "copy-static-assets": "ts-node copyStaticAssets.ts",
+    "debug": "nodemon --inspect ../../dist/packages/cactus-cmd-socketio-server/src/main/typescript/routing-interface/www.js",
+    "init-check-connection-ethereum-validator": "ln -s ../examples/cactus-check-connection-ethereum-validator/node_modules ../../dist/node_modules",
     "replace-blp-config-path": "ts-node replaceBLPConfigPath.ts",
-    "init-check-connection-ethereum-validator": "ln -s ../examples/cactus-check-connection-ethereum-validator/node_modules ../../dist/node_modules"
+    "start": "node ../../dist/packages/cactus-cmd-socketio-server/src/main/typescript/routing-interface/www.js",
+    "tslint": "tslint -c tslint.json -p tsconfig.json './*.ts'"
   },
   "dependencies": {
     "escape-html": "1.0.3",
@@ -21,4 +21,4 @@
     "@types/escape-html": "1.0.1",
     "@types/node": "15.14.7"
   }
-}
+}
diff --git a/examples/cactus-example-carbon-accounting-backend/package.json b/examples/cactus-example-carbon-accounting-backend/package.json
@@ -21,7 +21,7 @@
   "author": {
     "name": "Hyperledger Cactus Contributors",
     "email": "cactus@lists.hyperledger.org",
-    "url": "https://www.hyperledger.org/use/cactus"
+    "url": "https://www.hyperledger.org/use/cacti"
   },
   "contributors": [
     {
@@ -101,4 +101,4 @@
       "extensions": "sol"
     }
   }
-}
+}
diff --git a/examples/cactus-example-carbon-accounting-business-logic-plugin/package.json b/examples/cactus-example-carbon-accounting-business-logic-plugin/package.json
@@ -21,7 +21,7 @@
   "author": {
     "name": "Hyperledger Cactus Contributors",
     "email": "cactus@lists.hyperledger.org",
-    "url": "https://www.hyperledger.org/use/cactus"
+    "url": "https://www.hyperledger.org/use/cacti"
   },
   "contributors": [
     {
@@ -46,8 +46,8 @@
     "codegen": "run-p 'codegen:*'",
     "codegen:openapi": "npm run generate-sdk",
     "generate-sdk": "run-p 'generate-sdk:*'",
-    "generate-sdk:typescript-axios": "openapi-generator-cli generate -i ./src/main/json/openapi.json -g typescript-axios -o ./src/main/typescript/generated/openapi/typescript-axios --reserved-words-mappings protected=protected",
     "generate-sdk:kotlin": "openapi-generator-cli generate -i ./src/main/json/openapi.json -g kotlin -o ./src/main/kotlin/generated/openapi/kotlin-client/ --reserved-words-mappings protected=protected",
+    "generate-sdk:typescript-axios": "openapi-generator-cli generate -i ./src/main/json/openapi.json -g typescript-axios -o ./src/main/typescript/generated/openapi/typescript-axios --reserved-words-mappings protected=protected",
     "watch": "npm-watch",
     "webpack": "npm-run-all webpack:dev",
     "webpack:dev": "npm-run-all webpack:dev:node webpack:dev:web",
@@ -91,4 +91,4 @@
       ]
     }
   }
-}
+}
diff --git a/examples/cactus-example-carbon-accounting-frontend/package.json b/examples/cactus-example-carbon-accounting-frontend/package.json
@@ -94,4 +94,4 @@
   "publishConfig": {
     "access": "public"
   }
-}
+}
diff --git a/examples/cactus-example-discounted-asset-trade/package.json b/examples/cactus-example-discounted-asset-trade/package.json
@@ -1,18 +1,18 @@
 {
   "name": "@hyperledger/cactus-example-discounted-asset-trade",
   "version": "2.0.0-alpha.1",
+  "private": true,
   "license": "Apache-2.0",
   "main": "dist/www.js",
   "module": "dist/www.js",
   "types": "dist/www.d.ts",
-  "private": true,
   "scripts": {
-    "start": "npm run build_pip_indy_package && docker-compose build && docker-compose up",
-    "start-dockerless": "node ./dist/www.js",
     "build": "npm run build-ts && npm run build:dev:backend:postbuild",
     "build-ts": "tsc",
+    "build:dev:backend:postbuild": "cp -f ../../yarn.lock ./dist/",
     "build_pip_indy_package": "cd ../../packages-python/cactus_validator_socketio_indy && python3 setup.py bdist_wheel",
-    "build:dev:backend:postbuild": "cp -f ../../yarn.lock ./dist/"
+    "start": "npm run build_pip_indy_package && docker-compose build && docker-compose up",
+    "start-dockerless": "node ./dist/www.js"
   },
   "dependencies": {
     "@hyperledger/cactus-cmd-socketio-server": "2.0.0-alpha.1",
@@ -48,4 +48,4 @@
     "@types/express": "4.17.13",
     "@types/jsrsasign": "10.5.8"
   }
-}
+}
diff --git a/examples/cactus-example-electricity-trade/package.json b/examples/cactus-example-electricity-trade/package.json
@@ -1,17 +1,17 @@
 {
   "name": "@hyperledger/cactus-example-electricity-trade",
   "version": "2.0.0-alpha.1",
+  "private": true,
   "license": "Apache-2.0",
   "main": "dist/www.js",
   "module": "dist/www.js",
   "types": "dist/www.d.ts",
-  "private": true,
   "scripts": {
-    "start": "docker-compose build && docker-compose up",
-    "start-dockerless": "node ./dist/www.js",
     "build": "npm run build-ts && npm run build:dev:backend:postbuild",
     "build-ts": "tsc",
-    "build:dev:backend:postbuild": "cp -f ../../yarn.lock ./dist/"
+    "build:dev:backend:postbuild": "cp -f ../../yarn.lock ./dist/",
+    "start": "docker-compose build && docker-compose up",
+    "start-dockerless": "node ./dist/www.js"
   },
   "dependencies": {
     "@hyperledger/cactus-cmd-socketio-server": "2.0.0-alpha.1",
@@ -47,4 +47,4 @@
     "eslint-plugin-prettier": "4.0.0",
     "prettier": "2.5.1"
   }
-}
+}
diff --git a/examples/cactus-example-supply-chain-backend/package.json b/examples/cactus-example-supply-chain-backend/package.json
@@ -21,7 +21,7 @@
   "author": {
     "name": "Hyperledger Cactus Contributors",
     "email": "cactus@lists.hyperledger.org",
-    "url": "https://www.hyperledger.org/use/cactus"
+    "url": "https://www.hyperledger.org/use/cacti"
   },
   "contributors": [
     {
@@ -90,4 +90,4 @@
   "browserMinified": "dist/cactus-example-supply-chain-backend.web.umd.min.js",
   "mainMinified": "dist/cactus-example-supply-chain-backend.node.umd.min.js",
   "watch": {}
-}
+}
diff --git a/examples/cactus-example-supply-chain-business-logic-plugin/package.json b/examples/cactus-example-supply-chain-business-logic-plugin/package.json
@@ -21,7 +21,7 @@
   "author": {
     "name": "Hyperledger Cactus Contributors",
     "email": "cactus@lists.hyperledger.org",
-    "url": "https://www.hyperledger.org/use/cactus"
+    "url": "https://www.hyperledger.org/use/cacti"
   },
   "contributors": [
     {
@@ -46,8 +46,8 @@
     "codegen": "run-p 'codegen:*'",
     "codegen:openapi": "npm run generate-sdk",
     "generate-sdk": "run-p 'generate-sdk:*'",
-    "generate-sdk:typescript-axios": "openapi-generator-cli generate -i ./src/main/json/openapi.json -g typescript-axios -o ./src/main/typescript/generated/openapi/typescript-axios/",
     "generate-sdk:kotlin": "openapi-generator-cli generate -i ./src/main/json/openapi.json -g kotlin -o ./src/main/kotlin/generated/openapi/kotlin-client/ --reserved-words-mappings protected=protected",
+    "generate-sdk:typescript-axios": "openapi-generator-cli generate -i ./src/main/json/openapi.json -g typescript-axios -o ./src/main/typescript/generated/openapi/typescript-axios/",
     "watch": "npm-watch",
     "webpack": "npm-run-all webpack:dev",
     "webpack:dev": "npm-run-all webpack:dev:node webpack:dev:web",
@@ -92,4 +92,4 @@
       ]
     }
   }
-}
+}
diff --git a/examples/cactus-example-supply-chain-frontend/package.json b/examples/cactus-example-supply-chain-frontend/package.json
@@ -94,4 +94,4 @@
   "publishConfig": {
     "access": "public"
   }
-}
+}
diff --git a/examples/cactus-example-tcs-huawei/package.json b/examples/cactus-example-tcs-huawei/package.json
@@ -6,10 +6,10 @@
   "module": "dist/www.js",
   "types": "dist/www.d.ts",
   "scripts": {
-    "start": "docker-compose build && docker-compose up",
     "build": "npm run build-ts && npm run build:dev:backend:postbuild",
     "build-ts": "tsc",
-    "build:dev:backend:postbuild": "cp -f ../../yarn.lock ./dist/"
+    "build:dev:backend:postbuild": "cp -f ../../yarn.lock ./dist/",
+    "start": "docker-compose build && docker-compose up"
   },
   "dependencies": {
     "@hyperledger/cactus-cmd-socketio-server": "2.0.0-alpha.1",
@@ -47,4 +47,4 @@
     "eslint-plugin-prettier": "4.0.0",
     "prettier": "2.5.1"
   }
-}
+}
diff --git a/examples/cactus-workshop-examples-2022-11-14/package.json b/examples/cactus-workshop-examples-2022-11-14/package.json
@@ -21,7 +21,7 @@
   "author": {
     "name": "Hyperledger Cactus Contributors",
     "email": "cactus@lists.hyperledger.org",
-    "url": "https://www.hyperledger.org/use/cactus"
+    "url": "https://www.hyperledger.org/use/cacti"
   },
   "contributors": [
     {
@@ -68,4 +68,4 @@
   "browserMinified": "dist/cactus-workshop-examples-2022-11-14.web.umd.min.js",
   "mainMinified": "dist/cactus-workshop-examples-2022-11-14.node.umd.min.js",
   "watch": {}
-}
+}
diff --git a/examples/supply-chain-app/package.json b/examples/supply-chain-app/package.json
@@ -27,7 +27,7 @@
   "author": {
     "name": "Hyperledger Cactus Contributors",
     "email": "cactus@lists.hyperledger.org",
-    "url": "https://www.hyperledger.org/use/cactus"
+    "url": "https://www.hyperledger.org/use/cacti"
   },
   "contributors": [
     {

diff --git a/extensions/cactus-plugin-htlc-coordinator-besu/package.json b/extensions/cactus-plugin-htlc-coordinator-besu/package.json
@@ -21,7 +21,7 @@
   "author": {
     "name": "Hyperledger Cactus Contributors",
     "email": "cactus@lists.hyperledger.org",
-    "url": "https://www.hyperledger.org/use/cactus"
+    "url": "https://www.hyperledger.org/use/cacti"
   },
   "contributors": [
     {
@@ -99,4 +99,4 @@
       ]
     }
   }
-}
+}
diff --git a/extensions/cactus-plugin-object-store-ipfs/package.json b/extensions/cactus-plugin-object-store-ipfs/package.json
@@ -21,7 +21,7 @@
   "author": {
     "name": "Hyperledger Cactus Contributors",
     "email": "cactus@lists.hyperledger.org",
-    "url": "https://www.hyperledger.org/use/cactus"
+    "url": "https://www.hyperledger.org/use/cacti"
   },
   "contributors": [
     {
@@ -46,8 +46,8 @@
     "codegen": "run-p 'codegen:*'",
     "codegen:openapi": "npm run generate-sdk",
     "generate-sdk": "run-p 'generate-sdk:*'",
-    "generate-sdk:typescript-axios": "openapi-generator-cli generate -i ./src/main/json/openapi.json -g typescript-axios -o ./src/main/typescript/generated/openapi/typescript-axios --reserved-words-mappings protected=protected",
     "generate-sdk:kotlin": "openapi-generator-cli generate -i ./src/main/json/openapi.json -g kotlin -o ./src/main/kotlin/generated/openapi/kotlin-client/ --reserved-words-mappings protected=protected",
+    "generate-sdk:typescript-axios": "openapi-generator-cli generate -i ./src/main/json/openapi.json -g typescript-axios -o ./src/main/typescript/generated/openapi/typescript-axios --reserved-words-mappings protected=protected",
     "watch": "npm-watch",
     "webpack": "npm-run-all webpack:dev",
     "webpack:dev": "npm-run-all webpack:dev:node webpack:dev:web",
@@ -87,4 +87,4 @@
       ]
     }
   }
-}
+}
diff --git a/packages/cactus-api-client/package.json b/packages/cactus-api-client/package.json
@@ -21,7 +21,7 @@
   "author": {
     "name": "Hyperledger Cactus Contributors",
     "email": "cactus@lists.hyperledger.org",
-    "url": "https://www.hyperledger.org/use/cactus"
+    "url": "https://www.hyperledger.org/use/cacti"
   },
   "contributors": [
     {
@@ -74,4 +74,4 @@
   "browserMinified": "dist/cactus-api-client.web.umd.min.js",
   "mainMinified": "dist/cactus-api-client.node.umd.min.js",
   "watch": {}
-}
+}
diff --git a/packages/cactus-cmd-api-server/package.json b/packages/cactus-cmd-api-server/package.json
@@ -21,7 +21,7 @@
   "author": {
     "name": "Hyperledger Cactus Contributors",
     "email": "cactus@lists.hyperledger.org",
-    "url": "https://www.hyperledger.org/use/cactus"
+    "url": "https://www.hyperledger.org/use/cacti"
   },
   "contributors": [
     {
@@ -47,8 +47,8 @@
     "codegen:openapi": "npm run generate-sdk",
     "codegen:proto": "run-s proto:openapi proto:protoc-gen-ts",
     "generate-sdk": "run-p 'generate-sdk:*'",
-    "generate-sdk:typescript-axios": "openapi-generator-cli generate -i ./src/main/json/openapi.json -g typescript-axios -o ./src/main/typescript/generated/openapi/typescript-axios --reserved-words-mappings protected=protected",
     "generate-sdk:kotlin": "openapi-generator-cli generate -i ./src/main/json/openapi.json -g kotlin -o ./src/main/kotlin/generated/openapi/kotlin-client/ --reserved-words-mappings protected=protected",
+    "generate-sdk:typescript-axios": "openapi-generator-cli generate -i ./src/main/json/openapi.json -g typescript-axios -o ./src/main/typescript/generated/openapi/typescript-axios --reserved-words-mappings protected=protected",
     "proto:openapi": "openapi-generator-cli generate -i ./src/main/json/openapi.json -g protobuf-schema --model-name-suffix=PB --additional-properties=packageName=org.hyperledger.cactus.cmd_api_server -o ./src/main/proto/generated/openapi/ -t=./src/main/openapi-generator/templates/protobuf-schema/",
     "proto:protoc-gen-ts": "yarn run grpc_tools_node_protoc --plugin=protoc-gen-ts=../../node_modules/.bin/protoc-gen-ts --ts_out=grpc_js:./src/main/typescript/generated/proto/protoc-gen-ts/ --proto_path ./src/main/proto/generated/openapi/ ./src/main/proto/generated/openapi/services/*.proto",
     "watch": "npm-watch",
@@ -135,4 +135,4 @@
       ]
     }
   }
-}
+}
diff --git a/packages/cactus-cmd-socketio-server/package.json b/packages/cactus-cmd-socketio-server/package.json
@@ -1,10 +1,41 @@
 {
   "name": "@hyperledger/cactus-cmd-socketio-server",
   "version": "2.0.0-alpha.1",
+  "description": "Allows Cactus nodes to interact with HTLC ETH contracts",
+  "keywords": [
+    "Hyperledger",
+    "Cactus",
+    "Integration",
+    "Blockchain",
+    "Distributed Ledger Technology"
+  ],
+  "homepage": "https://github.com/hyperledger/cacti#readme",
+  "bugs": {
+    "url": "https://github.com/hyperledger/cacti/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/hyperledger/cacti.git"
+  },
   "license": "Apache-2.0",
-  "main": "dist/src/main/typescript/index.js",
-  "module": "dist/src/main/typescript/index.js",
-  "types": "dist/src/main/typescript/index.d.ts",
+  "author": {
+    "name": "Hyperledger Cactus Contributors",
+    "email": "cactus@lists.hyperledger.org",
+    "url": "https://www.hyperledger.org/use/cacti"
+  },
+  "contributors": [
+    {
+      "name": "Please add yourself to the list of contributors",
+      "email": "your.name@example.com",
+      "url": "https://example.com"
+    }
+  ],
+  "main": "dist/lib/main/typescript/index.js",
+  "module": "dist/lib/main/typescript/index.js",
+  "types": "dist/lib/main/typescript/index.d.ts",
+  "files": [
+    "dist/*"
+  ],
   "scripts": {
     "build": "npm run build-ts && npm run build:dev:backend:postbuild",
     "build-ts": "tsc",
@@ -55,4 +86,4 @@
   "publishConfig": {
     "access": "public"
   }
-}
+}
diff --git a/packages/cactus-cmd-socketio-server/tsconfig.json b/packages/cactus-cmd-socketio-server/tsconfig.json
@@ -2,8 +2,9 @@
   "extends": "../../tsconfig.base.json",
   "compilerOptions": {
     "composite": true,
-    "outDir": "./dist/",
-    "tsBuildInfoFile": "../../.build-cache/cactus-cmd-socketio-server.tsbuildinfo",
+    "outDir": "./dist/lib",
+    "rootDir": "./src",
+    "tsBuildInfoFile": "../../.build-cache/cactus-cmd-socketio-server.tsbuildinfo"
   },
   "include": [
     "./src/main/typescript/business-logic-plugin/*.ts",
@@ -13,9 +14,7 @@
     "./src/main/typescript/util/*.ts",
     "./src/main/typescript/routing-interface/**/*.ts"
   ],
-  "exclude": [
-    "copyStaticAssets.ts"
-  ],
+  "exclude": ["copyStaticAssets.ts"],
   "references": [
     {
       "path": "../cactus-common/tsconfig.json"