Update buf.gen.yaml

.gitea/workflows/release.yaml

@@ -17,7 +17,10 @@ jobs:
       id: get_version
       run: echo "VERSION=${GITHUB_REF#refs/tags/v}" >> $GITHUB_OUTPUT
     
-    - uses: bufbuild/buf-setup-action@v1
+    - uses: bufbuild/buf-action@v1.3
+      with:
+        setup_only: true
+        version: '1.63.0'
     
     - uses: actions/setup-go@v5
       with:
@@ -36,39 +39,66 @@ jobs:
 
     - name: Install TS-Proto Plugin
       run: |
-        npm install ts-proto
+        npm install ts-proto typescript
         echo "$PATH:$(pwd)/ts-proto" >> $GITHUB_PATH
 
     - name: Generate Code
       run: buf generate
 
-    - name: Publish TS
+    - name: Build and Publish TS
       working-directory: gen/ts
       run: |
         npm init -y
+        
+        # 1. Create a dynamic index.ts using Namespace exports
+        # This converts 'rail_backend/v1/pis_mapping.ts' 
+        # into 'export * as PisMapping from "./rail_backend/v1/pis_mapping";'
+        # We use awk to handle the naming conversion (snake_case to PascalCase-ish)
+        find . -name "*.ts" -not -name "index.ts" | sed 's|^\./||; s|\.ts$||' | awk -F'/' '{ 
+          name=$NF; 
+          gsub(/_/, "", name); 
+          printf "export * as %s from \"./%s\";\n", toupper(substr(name,1,1)) substr(name,2), $0 
+        }' > index.ts
+
+        # 2. Update package.json
         jq '.name = "@owlboard/backend-data-contracts" | 
             .version = "${{ steps.get_version.outputs.VERSION }}" |
-            .description = "Generated Protobuf types for data ingress services" |
+            .type = "module" |
-            .repository = {
+            .main = "./dist/index.js" |
-              "type": "git",
+            .types = "./dist/index.d.ts" |
-              "url": "git+https://${{ github.server_url }}/${{ github.repository }}.git"
+            .publishConfig = { "registry": "https://git.fjla.uk/api/packages/owlboard/npm" }' \
-            } |
-            .bugs = {
-              "url": "https://${{ github.server_url }}/${{ github.repository }}/issues"
-            } |
-            .homepage = "https://${{ github.server_url }}/${{ github.repository }}#readme"' \
             package.json > temp.json && mv temp.json package.json
+        
+        # 3. Compile
+        npx tsc index.ts --declaration --module esnext --target es2022 --moduleResolution node --outDir dist/
+        
         npm publish
       env:
         NODE_AUTH_TOKEN: ${{ secrets.PACKAGE_PUSH }}
 
-    - name: Commit Generated Go
+    - name: Publish Go
       run: |
-        git config user.name "owlbot"
+        # 1. Setup variables
-        git config user.email "owlbot@owlboard.info"
+        VERSION="${{ steps.get_version.outputs.VERSION }}"
-        git add gen/go/*.go
+        MOD_NAME="git.fjla.uk/owlboard/backend-data-contracts"
-        git commit -m "OwlBot: Generated go types for ${{ steps.get_version.outputs.VERSION }}"
+        # Create a temporary directory structure that matches Go proxy requirements
-        git diff-index --quiet HEAD || git commit -m "OwlBot: Generated go types for ${{ steps.get_version.outputs.VERSION }}"
+        DEST_DIR="temp_zip/$MOD_NAME@$VERSION"
-        git push origin HEAD:refs/tags/${{ github.ref_name }} --force
+        
-      env:
+        # 2. Generate go.mod and tidy
-        GITHUB_TOKEN: ${{ secrets.REPO_PUSH }}
+        cd gen/go
+        go mod init $MOD_NAME
+        go mod tidy
+        
+        # 3. Move files into the required nested structure
+        mkdir -p "../../$DEST_DIR"
+        cp -r . "../../$DEST_DIR/"
+        
+        # 4. Zip from the temp root so the internal paths are correct
+        cd ../../temp_zip
+        zip -r ../module.zip .
+        
+        # 5. Upload with the explicit version
+        cd ..
+        curl -f -v --user "owlbot:${{ secrets.PACKAGE_PUSH }}" \
+          --upload-file module.zip \
+          "${{ github.server_url }}/api/packages/owlboard/go/upload?version=$VERSION"

README.md

@@ -1,34 +1,37 @@
-# data-contracts
+# backend-data-contracts
 
-This repository is the single source of truth for all Protocol Buffer (Protobuf) schema definitions used across the Rail Ingress and Processing microservices.
+This repository is the single source of truth for all Protocol Buffer (Protobuf) schema definitions used across the Owlboard Rail Ingress and Processing microservices. It follows a **Contract-First** approach, where language-specific code (Go, TypeScript) is generated and distributed via private registries.
 
 ## Purpose
 
 The Protobuf files defined here serve as the immutable data contract for:
-1.  **Message Queue Payloads:** Defining messages pushed to the Artemis queue (Go Process Service consumption).
+1.  **Ingress Logic:** Ensuring the Node.js and Go inregrate properly by sharing types.
-2.  **Database Schemas:** Defining the expected structure of documents in MongoDB (Go Process and TypeScript API service consumption).
+2.  **Message Payloads:** Defining messages for cross-service communication.
-3.  **Cross-Service Communication:** Ensuring type-safe data exchange between all polyglot services (Go, TypeScript).
+3.  **Persistence:** Defining the expected structure of documents in MongoDB for the Go processing services.
 
-## Directory Structure and Artifacts
+## Directory Structure
 
 | Path | Description | Contents |
 | :--- | :--- | :--- |
-| `protos/rail/v1/` | **Source Code.** Contains all source `.proto` files. **Only these files reside on the `main` branch.** | `.proto` files |
+| `proto/` | **Source of Truth.** Contains the Protobuf schema definitions. | `rail_backend/v1/*.proto` |
-| `ts/` | **Generated TypeScript/JavaScript code.** Used as the root for the NPM package publish. **Not committed to Git.** | `package.json`, generated `.js`, `.d.ts` |
+| `buf.yaml` | **Workspace Config.** Defines linting and breaking change rules (Buf v2). | Workspace settings |
-| `go.mod` | Defines the Go Module path: `git.fjla.uk/owlboard/backend-data-contracts`. | Go Module definition |
+| `buf.gen.yaml` | **Generation Config.** Defines how Go and TS code is built. | Plugin & Managed Mode settings |
+| `gen/` | **Transient Output.** Generated code resides here during CI/CD. | `.pb.go`, `.js`, `.d.ts` (**Git Ignored**) |
 
-## Code Generation and Publishing Workflow (Gitea Action)
+## Code Generation and Publishing Workflow
 
-The generation process is automated via a Gitea Action (`.gitea/workflows/generate_contracts.yml`), which runs when a change is pushed to a source `.proto` file.
+The generation and release process is automated via Gitea Actions. It is triggered whenever a new **SemVer tag** (e.g., `v1.0.0`) is pushed to this repository.
 
-The action performs the following steps:
+1.  **Validation:** `buf lint` ensures schemas follow best practices.
-1.  Generates all Go and TypeScript/JavaScript artifacts.
+2.  **Generation:** `buf generate` creates Go and TypeScript code using local plugins.
-2.  **Go Artifacts:** Commits the generated `*.pb.go` files to a **new Git tag** (e.g., `v1.0.1`), ensuring the `main` branch remains clean.
+3.  **TS Release:** Compiles `.ts` to `.js` and publishes to the Gitea NPM Registry as `@owlboard/backend-data-contracts`.
-3.  **TypeScript Artifacts:** Packages the generated files and publishes the corresponding version (e.g., `1.0.1`) to the internal NPM registry.
+4.  **Go Release:** Initializes a `go.mod`, zips the artifacts, and pushes them to the Gitea Go Package Registry.
 
-### To Consume the Contract:
+## To Consume the Contracts
 
-| Language | Artifact | Consumption Method |
+### 1. Go Services
-| :--- | :--- | :--- |
+Since the package is hosted in the Gitea Package Registry, you must configure your environment to use the Gitea instance as a proxy.
-| **Go** | Source Code (`*.pb.go`) | **Requires a Git Tag.** Update your service's `go.mod` file to reference the desired tag: `git.fjla.uk/owlboard/backend-data-contracts v1.0.1`. |
+
-| **TypeScript** | NPM Package | Update the version in your `package.json` file and install: `"@owlboard/contracts": "1.0.1"`. |
+**Setup:**
+```bash
+export GOPROXY=[https://git.fjla.uk/api/packages/owlboard/go,https://proxy.golang.org,direct](https://git.fjla.uk/api/packages/owlboard/go,https://proxy.golang.org,direct)

buf.gen.yaml

@@ -1,12 +1,18 @@
-version: v1
+version: v2
+managed:
+  enabled: true
+  override:
+    - file_option: go_package_prefix
+      value: github.com/owlboard/backend-data-contracts
 plugins:
-  - plugin: go
+  - local: protoc-gen-go
     out: gen/go
     opt: paths=source_relative
-  - plugin: ts-proto
+  - local: ./node_modules/ts-proto/protoc-gen-ts_proto
-    path: ./node_modules/ts-proto/protoc-gen-ts_proto
     out: gen/ts
     opt:
     - esModuleInterop=true
     - outputJsonMethods=true
-    - forceLong=string
+    - forceLong=string
+    - importSuffix=.js
+    - outputExtensions=true

buf.work.yaml

@@ -1,4 +0,0 @@
-# buf.work.yaml
-version: v1
-directories:
-  - protos

buf.yaml

@@ -0,0 +1,9 @@
+version: v2
+modules:
+  - path: protos
+lint:
+  use:
+    - DEFAULT
+breaking:
+  use:
+    - FILE

go.mod

@@ -1,3 +0,0 @@
-module git.fjla.uk/owlboard/backend-data-contracts
-
-go 1.24.10

protos/rail/v1/pis_schema.proto

@@ -1,15 +0,0 @@
-syntax = "proto3";
-
-package rail.v1;
-option go_package = "git.fjla.uk/owlboard/backend-data-contracts";
-
-message PisReferenceList {
-    repeated PisMapping entries = 1;
-}
-
-message PisMapping {
-    string code = 1;
-    string operator = 2;
-    repeated string stops = 3;
-    fixed64 stops_xxh4 = 4; // XXH4 Hash for fast lookup of exact match
-}

protos/rail_backend/v1/common.proto

@@ -1,7 +1,6 @@
 syntax = "proto3";
 
-package rail.v1;
+package rail_backend.v1;
-option go_package = "git.fjla.uk/owlboard/generated/go/rail/v1";
 
 message Metadata {
     int64 push_to_queue_time = 1;

protos/rail_backend/v1/pis_schema.proto

@@ -0,0 +1,16 @@
+syntax = "proto3";
+
+package rail_backend.v1;
+
+message PisReferenceList {
+    repeated PisMapping entries = 1;
+}
+
+message PisMapping {
+    string code = 1;
+    string toc = 2;
+    repeated string crsStops = 3;
+    fixed64 crsHash = 4; // XXH4 Hash for fast lookup of exact match
+    repeated string tiplocStops = 5;
+    fixed64 tiplocHash = 6;
+}

protos/rail_backend/v1/queue_message.proto

@@ -1,11 +1,9 @@
 syntax = "proto3";
 
-package rail.v1;
+package rail_backend.v1;
-option go_package = "git.fjla.uk/owlboard/generated/go/rail/v1";
 
-
+import "rail_backend/v1/common.proto";
-import "rail/v1/common.proto";
+import "rail_backend/v1/schedule_payload.proto";
-import "rail/v1/schedule_payload.proto";
 
 message IngressMessage {
     string correlation_id = 1;

protos/rail_backend/v1/schedule_payload.proto

@@ -1,7 +1,6 @@
 syntax = "proto3";
 
-package rail.v1;
+package rail_backend.v1;
-option go_package = "git.fjla.uk/owlboard/generated/go/rail/v1";
 
 enum SchedulePayloadType {
     VSTP_MESSAGE_TYPE_UNSPECIFIED = 0;