Production version

.github/workflows/release-dev.yml

@@ -0,0 +1,34 @@
+name: Build & Publish NPM Package - DEV
+description: This workflow builds and publishes the NPM package when a version tag is pushed.
+
+on:
+  push:
+    tags:
+      - 'v[0-9]+.[0-9]+.[0-9]+-dev.[0-9]+'
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js environment
+        uses: actions/setup-node@v4 # Latest version to set up Node.js
+        with:
+          node-version: 'lts/*' # Use the latest LTS version of Node.js
+          registry-url: 'https://registry.npmjs.org/' # Important: Specify the npm registry
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Build package
+        run: npm run build
+
+      - name: Publish to npm
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: |
+          # for public packages, include --access public
+          npm publish --access public --tag dev

.github/workflows/release.yml

@@ -0,0 +1,28 @@
+name: Build & Publish NPM Package
+description: This workflow builds and publishes the NPM package when a version tag is pushed.
+
+on:
+  push:
+    tags:
+      - 'v[0-9]+.[0-9]+.[0-9]+'
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Build package
+        run: npm run build
+
+      - name: Publish to npm
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: |
+          # for public packages, include --access public
+          npm publish --access public

.github/workflows/tests.yml

@@ -0,0 +1,36 @@
+name: tests
+
+on:
+  pull_request:
+    branches:
+    - main
+    - master
+    - dev
+    - rc
+
+jobs:
+  code:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Install dependencies
+      run: npm install
+
+    - name: Run tests
+      run: npm test
+
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Install dependencies
+      run: npm install
+
+    - name: Build project
+      run: npm run build

.github/workflows/version-bump.yml

@@ -0,0 +1,68 @@
+name: Version bump
+description: This workflow bumps the version in package.json and creates a new version tag.
+
+on:
+  push:
+    branches:
+      - master
+      - main
+      - rc
+      - dev
+
+jobs:
+  create-version-tag:
+    if: ${{ !contains(github.event.head_commit.message, '#skip_next_version') }}
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4.2.2
+        with:
+          token: ${{ secrets.GH_TOKEN }}
+          ref: ${{ github.head_ref }}
+          fetch-depth: 0
+
+      - name: Set ENVs
+        run: |
+          echo "PRERELEASE_SUFFIX=${{ github.head_ref || github.ref_name }}" >> "$GITHUB_ENV"
+          if [[ "${{ github.head_ref || github.ref_name }}" == "dev" ]]; then echo "PRERELEASE=true" >> "$GITHUB_ENV"; fi
+          if [[ "${{ github.head_ref || github.ref_name }}" == "rc" ]]; then echo "PRERELEASE=true" >> "$GITHUB_ENV"; fi
+          if [[ "${{ github.head_ref || github.ref_name }}" == "master" ]]; then echo "PRERELEASE=false" >> "$GITHUB_ENV"; fi
+          if [[ "${{ github.head_ref || github.ref_name }}" == "main" ]]; then echo "PRERELEASE=false" >> "$GITHUB_ENV"; fi
+
+      - name: Get next version
+        id: next-version
+        uses: anothrNick/github-tag-action@1.71.0
+        env:
+          GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
+          WITH_V: true
+          PRERELEASE: ${{ env.PRERELEASE }}
+          PRERELEASE_SUFFIX: ${{ env.PRERELEASE_SUFFIX }}
+          DEFAULT_BUMP: patch
+          DRY_RUN: true
+
+      - name: Update version in package.json
+        run: |
+          sudo chown -R "$(id -u):$(id -g)" .git
+          git config --local user.email "panterobot@gisat.cz"
+          git config --local user.name "github-actions[bot]"
+          npm version ${{ steps.next-version.outputs.new_tag }} -m "Set package.json version to ${{ steps.next-version.outputs.new_tag }} #skip_next_version"
+
+      - name: Push changes
+        uses: ad-m/github-push-action@v0.8.0
+        with:
+          github_token: ${{ secrets.GH_TOKEN }}
+          branch: ${{ github.ref }}
+
+      - name: Create version tag
+        uses: anothrNick/github-tag-action@1.71.0
+        env:
+          GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
+          WITH_V: true
+          PRERELEASE: ${{ env.PRERELEASE }}
+          PRERELEASE_SUFFIX: ${{ env.PRERELEASE_SUFFIX }}
+          DEFAULT_BUMP: patch
+          DRY_RUN: false

.gitignore

@@ -1,2 +1,3 @@
 node_modules
-dist
+dist
+.rollup.cache

Readme.md

@@ -1,26 +1,22 @@
-# Bepack NPM
-Shared backend functionality like logging, general database methods, parsing, code helpers etc.
-
-Main output is NPM package `bepack`, which can be imported into other backend projects.
-
-Rest of the project works as sandbox and backend demo field.
-
-## Structure of the NPM part
-
-Here is the main structure of the project:
-
-- src (code content)
-- `index.ts` (generated automaticly by `barrelsby`)
-- doc (NPM documentation)
-- config files
-
-
-## Build of the NPM
-- Open terminal in the `/bepack`
-- Run `npm run build`
-
-Check `package.json` for build steps.
-
-## Technologies
-- Typescript (https://www.typescriptlang.org/docs/)
-- Barrelsby for indexing (https://github.com/bencoveney/barrelsby)
+# Shared Library for Panther Backend
+This repository contains source of shared functionalities across Panther backend services.
+
+## Installation (DEV)
+- Install Node and NPM
+- Install YALC by `npm install -g yalc`
+- Clone the package repository.
+- Open terminal in package root.
+- Run `npm i` and `npm run build` to install dependencies and make a build of the NPM package.
+- Run `npm run yalc:publish` for local publishing the package into yalc repository. 
+- Now you can add this package for local development by opening the target application repository and run `yalc add @gisatcz/ptr-be-core`
+- Run `npm run dev` for development mode with Rollup build watcher and auto yalc publishing.
+
+## Usage in Applications
+- FE based apps should use imports from `@gisatcz/ptr-be-core/browser`
+- NodeJS based apps should use imports from `@gisatcz/ptr-be-core/node`
+
+## Resources
+- YALC (local NPM): https://github.com/wclr/yalc
+- Vitest (testing): https://vitest.dev
+- Barrelsby (TS Imports into one `index.ts`): https://github.com/bencoveney/barrelsby
+- Rollup (NPM package build): https://rollupjs.org

eslint.config.mjs

@@ -0,0 +1,25 @@
+import { defineConfig } from "eslint/config";
+import tseslint from "typescript-eslint";
+
+export default defineConfig([
+  {
+    files: ["**/*.ts"],
+    ignores: ["**/node_modules/**", "**/dist/**", "vitest.config.ts"],
+    languageOptions: {
+      parser: tseslint.parser,
+      parserOptions: {
+        project: "./tsconfig.json",
+        tsconfigRootDir: import.meta.dirname,
+      },
+    },
+    plugins: {
+      "@typescript-eslint": tseslint.plugin,
+    },
+    extends: [
+      "@typescript-eslint/recommended", 
+    ],
+    rules: {
+      "@typescript-eslint/no-explicit-any": "off",
+    },
+  },
+]);