feat(tac-operation-lifecycle): Setup types package 🦄 (#1352)

* feat(tac-operation-lifecycle): Setup types package

* fix package.json

* add types package to service-template

* add types package build check to CI workflow

Author: tom2drum

.github/workflows/_linting.yml

@@ -27,3 +27,41 @@ jobs:
       - name: cargo clippy
         run: cargo clippy --all --all-targets --all-features -- -D warnings
         working-directory: ${{ inputs.working-directory }}
+
+  check-types-build:
+    runs-on: ubuntu-latest
+    name: Check build of types package
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v4
+
+      - name: Check if types directory exists
+        id: check-directory
+        run: |
+          if [ -d "${{ inputs.working-directory }}/types" ]; then
+            echo "exists=true" >> $GITHUB_OUTPUT
+          else
+            echo "exists=false" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Setup Node.js
+        if: steps.check-directory.outputs.exists == 'true'
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+
+      - name: Install Protoc
+        if: steps.check-directory.outputs.exists == 'true'
+        uses: arduino/setup-protoc@v3
+
+      - name: Install dependencies
+        if: steps.check-directory.outputs.exists == 'true'
+        run: |
+          cd ${{ inputs.working-directory }}/types
+          npm ci || npm install
+
+      - name: Build types package
+        if: steps.check-directory.outputs.exists == 'true'
+        run: |
+          cd ${{ inputs.working-directory }}/types
+          npm run build

.github/workflows/npm-publisher.yml

@@ -9,11 +9,7 @@ on:
                 required: true
             project_name:
                 description: Project name
-                type: choice
-                options:
-                    - blockscout-ens
-                    - stats
-                    - visualizer
+                type: string
                 required: true
     workflow_call:
         inputs:
@@ -55,7 +51,7 @@ jobs:
         - name: Build the package
           run: |
             cd ./${{ inputs.project_name }}/types
-            npm install
+            npm ci || npm install
             npm run build
       
         - name: Publish to NPM registry

.github/workflows/tac-operation-lifecycle.yml

@@ -84,6 +84,16 @@ jobs:
       ARM_RUNNER_HOSTNAME: ${{ secrets.ARM_RUNNER_HOSTNAME }}
       ARM_RUNNER_KEY: ${{ secrets.ARM_RUNNER_KEY }}
 
+  publish_types_package:
+    name: Publish types package
+    uses: './.github/workflows/npm-publisher.yml'
+    needs: docker
+    if: needs.docker.outputs.tag-value != ''
+    secrets: inherit
+    with:
+      version: ${{ needs.docker.outputs.tag-value }}
+      project_name: tac-operation-lifecycle
+
   push-swagger:
     if: github.event_name == 'push' && (github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/tags'))
     uses: ./.github/workflows/_push_swagger.yml

service-template/.github/workflows/{{project-name}}.yml

@@ -84,3 +84,17 @@ jobs:
     uses: ./.github/workflows/_docker-build-push.yml
     with:
       service-name: {{project-name}}
+
+  {%- if types %}
+  publish_types_package:
+    name: Publish types package
+    uses: './.github/workflows/npm-publisher.yml'
+    needs: docker
+    if: needs.docker.outputs.tag-value != ''
+    secrets: inherit
+    with:
+      {% raw %}
+      version: ${{ needs.docker.outputs.tag-value }}
+      {% endraw %}
+      project_name: {{project-name}}
+  {%- endif %}

service-template/cargo-generate.toml

@@ -50,6 +50,14 @@ default = true
 # prompt = "Write example service name to generating proto examples"
 # default = "TestService"
 
+[placeholders.types]
+type = "bool"
+prompt = "Generate typescript definitions for resources"
+default = true
+
+[conditional.'!types']
+ignore = ["types"]
+
 [hooks]
 pre = [
     "pre-script.rhai"

service-template/types/.gitignore

@@ -0,0 +1 @@
+/dist

service-template/types/.npmignore

@@ -0,0 +1 @@
+/node_modules

service-template/types/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "@blockscout/{{project-name}}-types",
+  "version": "0.0.1",
+  "description": "TypeScript definitions for {{project-name-title}} microservice",
+  "main": "./dist/{{project-name}}-proto/proto/{{project-name}}.js",
+  "types": "./dist/{{project-name}}-proto/proto/{{project-name}}.d.ts",
+  "scripts": {
+    "build": "npm run compile:proto && npm run compile:ts",
+    "compile:proto": "mkdir -p ./dist && protoc --plugin=./node_modules/.bin/protoc-gen-ts_proto --ts_proto_opt=snakeToCamel=false --ts_proto_opt=stringEnums=true --ts_proto_opt=onlyTypes=true --ts_proto_opt=emitImportedFiles=false --proto_path=../ --proto_path=../../proto/ --ts_proto_out=./dist ../{{project-name}}-proto/proto/v1/{{project-name}}.proto",
+    "compile:ts": "tsc --declaration ./dist/{{project-name}}-proto/proto/v1/{{project-name}}.ts"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/blockscout/blockscout-rs.git",
+    "directory": "{{project-name}}/types"
+  },
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/blockscout/blockscout-rs/issues"
+  },
+  "homepage": "https://github.com/blockscout/blockscout-rs#readme",
+  "devDependencies": {
+    "ts-proto": "1.176.2",
+    "typescript": "5.4.5"
+  }
+}

tac-operation-lifecycle/types/.gitignore

@@ -0,0 +1 @@
+/dist

tac-operation-lifecycle/types/.npmignore

@@ -0,0 +1 @@
+/node_modules